Project

class mss_dataserver.core.project.Project(**kwargs)[source]

Bases: object

A project holds global configuration and settings.

Parameters

kwargs (dict) – The dictionary created from the configuration file.

Variables

  • logger (logging.Logger) – The logger instance.

  • project_config (dict) – The project configuration section.

  • author_uri (String) – The Uniform Resource Identifier of the author.

  • agency_uri (String) – The Uniform Resource Identifier of the author agency.

  • config (dict) – The complete configuration dictionary (kwargs).

  • process_config (dict) – The process configuration section.

  • db_host (String) – The URL or IP of the database host.

  • db_username (String) – The database user name.

  • db_pwd (String) – The database password.

  • db_dialect (String) – The dialect of the database.

  • db_driver (String) – The driver of the database.

  • db_database_name (String) – The name of the database.

  • db_tables (list) – The tables loaded from the database.

  • db_inventory (mss_dataserver.geometry.DbInventory) – The geometry inventory of the project.

  • inventory (mss_dataserer.geometry.DbInventory) – A dynamic property returning db_inventory.

  • event_library (mss_dataserver.event.core.Library) – The event library of the project.

  • detection_library (mss_dataserver.detection.Library) – The detection library of the project.

See also

mss_dataserver.core.util.load_configuration()

Properties

inventory

The geometry inventory.

Methods

__init__(**kwargs)

Initialize the instance.

connect_to_db()

Connect to the database.

create_database_tables()

Create the database tables needed for the project.

create_detection_catalog(name[, description])

Create an detection catalog in the database.

create_event_catalog(name[, description])

Create an event catalog in the database.

get_db_session()

Create a sqlAlchemy database session.

get_detection_catalog_names()

Get the detection catalog names available in the database.

get_event_catalog(name)

Get an event catalog.

get_event_catalog_names()

Get the event catalog names available in the database.

get_events([catalog_names, start_time, end_time])

Get events using search criteria passed as keywords.

load_database_table_structure()

Load the required database tables from the modules.

load_detection_catalog(name[, load_detections])

Load a detection catalog from the database.

load_event_by_id([ev_id, public_id])

Get an event by event id or public id.

load_event_catalog(name[, load_events])

Load an event catalog from the database.

load_inventory([update_from_xml])

Load the geometry inventory.

load_inventory_from_xml()

Load the inventory directly from the XML file ignoring the database.

Inheritence diagram

Inheritance diagram of mss_dataserver.core.project.Project