lsst.dax.apdb gcb20ee0ffd+ca32603c0c
|
Public Member Functions | |
Table|None | tableDef (self, ApdbTables table) |
None | makeSchema (self, bool drop=False) |
pandas.DataFrame | getDiaObjects (self, Region region) |
pandas.DataFrame|None | getDiaSources (self, Region region, Iterable[int]|None object_ids, dafBase.DateTime visit_time) |
pandas.DataFrame|None | getDiaForcedSources (self, Region region, Iterable[int]|None object_ids, dafBase.DateTime visit_time) |
bool | containsVisitDetector (self, int visit, int detector) |
list[ApdbInsertId]|None | getInsertIds (self) |
None | deleteInsertIds (self, Iterable[ApdbInsertId] ids) |
ApdbTableData | getDiaObjectsHistory (self, Iterable[ApdbInsertId] ids) |
ApdbTableData | getDiaSourcesHistory (self, Iterable[ApdbInsertId] ids) |
ApdbTableData | getDiaForcedSourcesHistory (self, Iterable[ApdbInsertId] ids) |
pandas.DataFrame | getSSObjects (self) |
None | store (self, dafBase.DateTime visit_time, pandas.DataFrame objects, pandas.DataFrame|None sources=None, pandas.DataFrame|None forced_sources=None) |
None | storeSSObjects (self, pandas.DataFrame objects) |
None | reassignDiaSources (self, Mapping[int, int] idMap) |
None | dailyJob (self) |
int | countUnassociatedObjects (self) |
ConfigurableField | makeField (cls, str doc) |
Static Public Attributes | |
ConfigClass = ApdbConfig | |
Abstract interface for APDB.
bool lsst.dax.apdb.apdb.Apdb.containsVisitDetector | ( | self, | |
int | visit, | ||
int | detector | ||
) |
Test whether data for a given visit-detector is present in the APDB. Parameters ---------- visit, detector : `int` The ID of the visit-detector to search for. Returns ------- present : `bool` `True` if some DiaObject, DiaSource, or DiaForcedSource records exist for the specified observation, `False` otherwise.
Reimplemented in lsst.dax.apdb.apdbCassandra.ApdbCassandra, and lsst.dax.apdb.apdbSql.ApdbSql.
int lsst.dax.apdb.apdb.Apdb.countUnassociatedObjects | ( | self | ) |
Return the number of DiaObjects that have only one DiaSource associated with them. Used as part of ap_verify metrics. Returns ------- count : `int` Number of DiaObjects with exactly one associated DiaSource. Notes ----- This method can be very inefficient or slow in some implementations.
Reimplemented in lsst.dax.apdb.apdbCassandra.ApdbCassandra, and lsst.dax.apdb.apdbSql.ApdbSql.
None lsst.dax.apdb.apdb.Apdb.dailyJob | ( | self | ) |
Implement daily activities like cleanup/vacuum. What should be done during daily activities is determined by specific implementation.
Reimplemented in lsst.dax.apdb.apdbCassandra.ApdbCassandra, and lsst.dax.apdb.apdbSql.ApdbSql.
None lsst.dax.apdb.apdb.Apdb.deleteInsertIds | ( | self, | |
Iterable[ApdbInsertId] | ids | ||
) |
Remove insert identifiers from the database. Parameters ---------- ids : `iterable` [`ApdbInsertId`] Insert identifiers, can include items returned from `getInsertIds`. Notes ----- This method causes Apdb to forget about specified identifiers. If there are any auxiliary data associated with the identifiers, it is also removed from database (but data in regular tables is not removed). This method should be called after successful transfer of data from APDB to PPDB to free space used by history.
Reimplemented in lsst.dax.apdb.apdbCassandra.ApdbCassandra, and lsst.dax.apdb.apdbSql.ApdbSql.
pandas.DataFrame | None lsst.dax.apdb.apdb.Apdb.getDiaForcedSources | ( | self, | |
Region | region, | ||
Iterable[int] | None | object_ids, | ||
dafBase.DateTime | visit_time | ||
) |
Return catalog of DiaForcedSource instances from a given region. Parameters ---------- region : `lsst.sphgeom.Region` Region to search for DIASources. object_ids : iterable [ `int` ], optional List of DiaObject IDs to further constrain the set of returned sources. If list is empty then empty catalog is returned with a correct schema. If `None` then returned sources are not constrained. Some implementations may not support latter case. visit_time : `lsst.daf.base.DateTime` Time of the current visit. Returns ------- catalog : `pandas.DataFrame`, or `None` Catalog containing DiaSource records. `None` is returned if ``read_forced_sources_months`` configuration parameter is set to 0. Raises ------ NotImplementedError May be raised by some implementations if ``object_ids`` is `None`. Notes ----- This method returns DiaForcedSource catalog for a region with additional filtering based on DiaObject IDs. Only a subset of DiaSource history is returned limited by ``read_forced_sources_months`` config parameter, w.r.t. ``visit_time``. If ``object_ids`` is empty then an empty catalog is always returned with the correct schema (columns/types). If ``object_ids`` is `None` then no filtering is performed and some of the returned records may be outside the specified region.
Reimplemented in lsst.dax.apdb.apdbSql.ApdbSql, and lsst.dax.apdb.apdbCassandra.ApdbCassandra.
ApdbTableData lsst.dax.apdb.apdb.Apdb.getDiaForcedSourcesHistory | ( | self, | |
Iterable[ApdbInsertId] | ids | ||
) |
Return catalog of DiaForcedSource instances from a given time period. Parameters ---------- ids : `iterable` [`ApdbInsertId`] Insert identifiers, can include items returned from `getInsertIds`. Returns ------- data : `ApdbTableData` Catalog containing DiaForcedSource records. In addition to all regular columns it will contain ``insert_id`` column. Notes ----- This part of API may not be very stable and can change before the implementation finalizes.
Reimplemented in lsst.dax.apdb.apdbCassandra.ApdbCassandra, and lsst.dax.apdb.apdbSql.ApdbSql.
pandas.DataFrame lsst.dax.apdb.apdb.Apdb.getDiaObjects | ( | self, | |
Region | region | ||
) |
Return catalog of DiaObject instances from a given region. This method returns only the last version of each DiaObject. Some records in a returned catalog may be outside the specified region, it is up to a client to ignore those records or cleanup the catalog before futher use. Parameters ---------- region : `lsst.sphgeom.Region` Region to search for DIAObjects. Returns ------- catalog : `pandas.DataFrame` Catalog containing DiaObject records for a region that may be a superset of the specified region.
Reimplemented in lsst.dax.apdb.apdbSql.ApdbSql, and lsst.dax.apdb.apdbCassandra.ApdbCassandra.
ApdbTableData lsst.dax.apdb.apdb.Apdb.getDiaObjectsHistory | ( | self, | |
Iterable[ApdbInsertId] | ids | ||
) |
Return catalog of DiaObject instances from a given time period including the history of each DiaObject. Parameters ---------- ids : `iterable` [`ApdbInsertId`] Insert identifiers, can include items returned from `getInsertIds`. Returns ------- data : `ApdbTableData` Catalog containing DiaObject records. In addition to all regular columns it will contain ``insert_id`` column. Notes ----- This part of API may not be very stable and can change before the implementation finalizes.
Reimplemented in lsst.dax.apdb.apdbCassandra.ApdbCassandra, and lsst.dax.apdb.apdbSql.ApdbSql.
pandas.DataFrame | None lsst.dax.apdb.apdb.Apdb.getDiaSources | ( | self, | |
Region | region, | ||
Iterable[int] | None | object_ids, | ||
dafBase.DateTime | visit_time | ||
) |
Return catalog of DiaSource instances from a given region. Parameters ---------- region : `lsst.sphgeom.Region` Region to search for DIASources. object_ids : iterable [ `int` ], optional List of DiaObject IDs to further constrain the set of returned sources. If `None` then returned sources are not constrained. If list is empty then empty catalog is returned with a correct schema. visit_time : `lsst.daf.base.DateTime` Time of the current visit. Returns ------- catalog : `pandas.DataFrame`, or `None` Catalog containing DiaSource records. `None` is returned if ``read_sources_months`` configuration parameter is set to 0. Notes ----- This method returns DiaSource catalog for a region with additional filtering based on DiaObject IDs. Only a subset of DiaSource history is returned limited by ``read_sources_months`` config parameter, w.r.t. ``visit_time``. If ``object_ids`` is empty then an empty catalog is always returned with the correct schema (columns/types). If ``object_ids`` is `None` then no filtering is performed and some of the returned records may be outside the specified region.
Reimplemented in lsst.dax.apdb.apdbSql.ApdbSql, and lsst.dax.apdb.apdbCassandra.ApdbCassandra.
ApdbTableData lsst.dax.apdb.apdb.Apdb.getDiaSourcesHistory | ( | self, | |
Iterable[ApdbInsertId] | ids | ||
) |
Return catalog of DiaSource instances from a given time period. Parameters ---------- ids : `iterable` [`ApdbInsertId`] Insert identifiers, can include items returned from `getInsertIds`. Returns ------- data : `ApdbTableData` Catalog containing DiaSource records. In addition to all regular columns it will contain ``insert_id`` column. Notes ----- This part of API may not be very stable and can change before the implementation finalizes.
Reimplemented in lsst.dax.apdb.apdbCassandra.ApdbCassandra, and lsst.dax.apdb.apdbSql.ApdbSql.
list[ApdbInsertId] | None lsst.dax.apdb.apdb.Apdb.getInsertIds | ( | self | ) |
Return collection of insert identifiers known to the database. Returns ------- ids : `list` [`ApdbInsertId`] or `None` List of identifiers, they may be time-ordered if database supports ordering. `None` is returned if database is not configured to store insert identifiers.
Reimplemented in lsst.dax.apdb.apdbCassandra.ApdbCassandra, and lsst.dax.apdb.apdbSql.ApdbSql.
pandas.DataFrame lsst.dax.apdb.apdb.Apdb.getSSObjects | ( | self | ) |
Return catalog of SSObject instances. Returns ------- catalog : `pandas.DataFrame` Catalog containing SSObject records, all existing records are returned.
Reimplemented in lsst.dax.apdb.apdbCassandra.ApdbCassandra, and lsst.dax.apdb.apdbSql.ApdbSql.
ConfigurableField lsst.dax.apdb.apdb.Apdb.makeField | ( | cls, | |
str | doc | ||
) |
Make a `~lsst.pex.config.ConfigurableField` for Apdb. Parameters ---------- doc : `str` Help text for the field. Returns ------- configurableField : `lsst.pex.config.ConfigurableField` A `~lsst.pex.config.ConfigurableField` for Apdb.
None lsst.dax.apdb.apdb.Apdb.makeSchema | ( | self, | |
bool | drop = False |
||
) |
Create or re-create whole database schema. Parameters ---------- drop : `bool` If True then drop all tables before creating new ones.
Reimplemented in lsst.dax.apdb.apdbCassandra.ApdbCassandra, and lsst.dax.apdb.apdbSql.ApdbSql.
None lsst.dax.apdb.apdb.Apdb.reassignDiaSources | ( | self, | |
Mapping[int, int] | idMap | ||
) |
Associate DiaSources with SSObjects, dis-associating them from DiaObjects. Parameters ---------- idMap : `Mapping` Maps DiaSource IDs to their new SSObject IDs. Raises ------ ValueError Raised if DiaSource ID does not exist in the database.
Reimplemented in lsst.dax.apdb.apdbCassandra.ApdbCassandra, and lsst.dax.apdb.apdbSql.ApdbSql.
None lsst.dax.apdb.apdb.Apdb.store | ( | self, | |
dafBase.DateTime | visit_time, | ||
pandas.DataFrame | objects, | ||
pandas.DataFrame | None | sources = None , |
||
pandas.DataFrame | None | forced_sources = None |
||
) |
Store all three types of catalogs in the database. Parameters ---------- visit_time : `lsst.daf.base.DateTime` Time of the visit. objects : `pandas.DataFrame` Catalog with DiaObject records. sources : `pandas.DataFrame`, optional Catalog with DiaSource records. forced_sources : `pandas.DataFrame`, optional Catalog with DiaForcedSource records. Notes ----- This methods takes DataFrame catalogs, their schema must be compatible with the schema of APDB table: - column names must correspond to database table columns - types and units of the columns must match database definitions, no unit conversion is performed presently - columns that have default values in database schema can be omitted from catalog - this method knows how to fill interval-related columns of DiaObject (validityStart, validityEnd) they do not need to appear in a catalog - source catalogs have ``diaObjectId`` column associating sources with objects
Reimplemented in lsst.dax.apdb.apdbCassandra.ApdbCassandra, and lsst.dax.apdb.apdbSql.ApdbSql.
None lsst.dax.apdb.apdb.Apdb.storeSSObjects | ( | self, | |
pandas.DataFrame | objects | ||
) |
Store or update SSObject catalog. Parameters ---------- objects : `pandas.DataFrame` Catalog with SSObject records. Notes ----- If SSObjects with matching IDs already exist in the database, their records will be updated with the information from provided records.
Reimplemented in lsst.dax.apdb.apdbCassandra.ApdbCassandra, and lsst.dax.apdb.apdbSql.ApdbSql.
Table | None lsst.dax.apdb.apdb.Apdb.tableDef | ( | self, | |
ApdbTables | table | ||
) |
Return table schema definition for a given table. Parameters ---------- table : `ApdbTables` One of the known APDB tables. Returns ------- tableSchema : `felis.simple.Table` or `None` Table schema description, `None` is returned if table is not defined by this implementation.
Reimplemented in lsst.dax.apdb.apdbCassandra.ApdbCassandra, and lsst.dax.apdb.apdbSql.ApdbSql.