Apdb¶

class lsst.dax.apdb.Apdb¶

Bases: abc.ABC

Abstract interface for APDB.

Methods Summary

`countUnassociatedObjects`()	Return the number of DiaObjects that have only one DiaSource associated with them.
`dailyJob`()	Implement daily activities like cleanup/vacuum.
`deleteInsertIds`(ids)	Remove insert identifiers from the database.
`getDiaForcedSources`(region, object_ids, …)	Return catalog of DiaForcedSource instances from a given region.
`getDiaForcedSourcesHistory`(ids)	Returns catalog of DiaForcedSource instances from a given time period.
`getDiaObjects`(region)	Returns catalog of DiaObject instances from a given region.
`getDiaObjectsHistory`(ids)	Returns catalog of DiaObject instances from a given time period including the history of each DiaObject.
`getDiaSources`(region, object_ids, None], …)	Return catalog of DiaSource instances from a given region.
`getDiaSourcesHistory`(ids)	Returns catalog of DiaSource instances from a given time period.
`getInsertIds`()	Return collection of insert identifiers known to the database.
`getSSObjects`()	Returns catalog of SSObject instances.
`makeField`(doc)	Make a `ConfigurableField` for Apdb.
`makeSchema`(drop)	Create or re-create whole database schema.
`reassignDiaSources`(idMap, int])	Associate DiaSources with SSObjects, dis-associating them from DiaObjects.
`store`(visit_time, objects, sources, …)	Store all three types of catalogs in the database.
`storeSSObjects`(objects)	Store or update SSObject catalog.
`tableDef`(table)	Return table schema definition for a given table.

Methods Documentation

countUnassociatedObjects() → int¶

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.

dailyJob() → None¶

Implement daily activities like cleanup/vacuum.

What should be done during daily activities is determined by specific implementation.

deleteInsertIds(ids: collections.abc.Iterable[lsst.dax.apdb.apdb.ApdbInsertId]) → None¶

Remove insert identifiers from the database.

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.

getDiaForcedSources(region: lsst.sphgeom._sphgeom.Region, object_ids: Optional[collections.abc.Iterable[int], None], visit_time: lsst.daf.base.dateTime.dateTime.DateTime) → Optional[pandas.core.frame.DataFrame, None]¶

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.

getDiaForcedSourcesHistory(ids: collections.abc.Iterable[lsst.dax.apdb.apdb.ApdbInsertId]) → lsst.dax.apdb.apdb.ApdbTableData¶

Returns 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.

getDiaObjects(region: lsst.sphgeom._sphgeom.Region) → pandas.core.frame.DataFrame¶

Returns 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.

getDiaObjectsHistory(ids: collections.abc.Iterable[lsst.dax.apdb.apdb.ApdbInsertId]) → lsst.dax.apdb.apdb.ApdbTableData¶

Returns 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.

getDiaSources(region: lsst.sphgeom._sphgeom.Region, object_ids: Optional[collections.abc.Iterable[int], None], visit_time: lsst.daf.base.dateTime.dateTime.DateTime) → Optional[pandas.core.frame.DataFrame, None]¶

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.

getDiaSourcesHistory(ids: collections.abc.Iterable[lsst.dax.apdb.apdb.ApdbInsertId]) → lsst.dax.apdb.apdb.ApdbTableData¶

Returns 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.

getInsertIds() → list[lsst.dax.apdb.apdb.ApdbInsertId] | None[list, None]¶

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.

getSSObjects() → pandas.core.frame.DataFrame¶

Returns catalog of SSObject instances.

Returns:	catalog : `pandas.DataFrame` Catalog containing SSObject records, all existing records are returned.

classmethod makeField(doc: str) → lsst.pex.config.configurableField.ConfigurableField¶

Make a ConfigurableField for Apdb.

Parameters:	doc : `str` Help text for the field.
Returns:	configurableField : `lsst.pex.config.ConfigurableField` A `ConfigurableField` for Apdb.

makeSchema(drop: bool = False) → None¶

Create or re-create whole database schema.

Parameters:	drop : `bool` If True then drop all tables before creating new ones.

reassignDiaSources(idMap: collections.abc.Mapping[int, int]) → None¶

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.

store(visit_time: lsst.daf.base.dateTime.dateTime.DateTime, objects: pandas.core.frame.DataFrame, sources: Optional[pandas.core.frame.DataFrame, None] = None, forced_sources: Optional[pandas.core.frame.DataFrame, None] = None) → 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

storeSSObjects(objects: pandas.core.frame.DataFrame) → None¶

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.

tableDef(table: lsst.dax.apdb.apdbSchema.ApdbTables) → Optional[felis.simple.Table, None]¶

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.

Navigation

Apdb¶