Apdb

class lsst.dax.apdb.Apdb

Bases: 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.
getDiaForcedSources(region, object_ids, ...)	Return catalog of DiaForcedSource instances from a given region.
getDiaForcedSourcesHistory(start_time, end_time)	Returns catalog of DiaForcedSource instances from a given time period.
getDiaObjects(region)	Returns catalog of DiaObject instances from a given region.
getDiaObjectsHistory(start_time, end_time[, ...])	Returns catalog of DiaObject instances from a given time period including the history of each DiaObject.
getDiaSources(region, object_ids, visit_time)	Return catalog of DiaSource instances from a given region.
getDiaSourcesHistory(start_time, end_time[, ...])	Returns catalog of DiaSource instances from a given time period.
getSSObjects()	Returns catalog of SSObject instances.
makeField(doc)	Make a ConfigurableField for Apdb.
makeSchema([drop])	Create or re-create whole database schema.
reassignDiaSources(idMap)	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

abstract countUnassociatedObjects() → int

Return the number of DiaObjects that have only one DiaSource associated with them.

Used as part of ap_verify metrics.

Returns:

countint

Number of DiaObjects with exactly one associated DiaSource.

Notes

This method can be very inefficient or slow in some implementations.

abstract dailyJob() → None

Implement daily activities like cleanup/vacuum.

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

abstract getDiaForcedSources(region: Region, object_ids: Iterable[int] | None, visit_time: DateTime) → DataFrame | None

Return catalog of DiaForcedSource instances from a given region.

Parameters:

regionlsst.sphgeom.Region

Region to search for DIASources.

object_idsiterable [ 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_timelsst.daf.base.DateTime

Time of the current visit.

Returns:

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

abstract getDiaForcedSourcesHistory(start_time: DateTime, end_time: DateTime, region: Region | None = None) → DataFrame

Returns catalog of DiaForcedSource instances from a given time period.

Parameters:

start_timedafBase.DateTime

Starting time for DiaForcedSource history search. DiaForcedSource record is selected when its midPointTai falls into an interval between start_time (inclusive) and end_time (exclusive).

end_timedafBase.DateTime

Upper limit on time for DiaForcedSource history search.

regionlsst.sphgeom.Region, optional

Region to search for DiaForcedSources, if not specified then whole sky is searched. If region is specified then some returned records may fall outside of this region.

Returns:

catalogpandas.DataFrame

Catalog containing DiaObject records.

Notes

This part of API may not be very stable and can change before the implementation finalizes. Some implementations may not support region filtering, they will return records from the whole sky.

abstract getDiaObjects(region: Region) → 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:

regionlsst.sphgeom.Region

Region to search for DIAObjects.

Returns:

catalogpandas.DataFrame

Catalog containing DiaObject records for a region that may be a superset of the specified region.

abstract getDiaObjectsHistory(start_time: DateTime, end_time: DateTime, region: Region | None = None) → DataFrame

Returns catalog of DiaObject instances from a given time period including the history of each DiaObject.

Parameters:

start_timedafBase.DateTime

Starting time for DiaObject history search. DiaObject record is selected when its validityStart falls into an interval between start_time (inclusive) and end_time (exclusive).

end_timedafBase.DateTime

Upper limit on time for DiaObject history search.

regionlsst.sphgeom.Region, optional

Region to search for DiaObjects, if not specified then whole sky is searched. If region is specified then some returned records may fall outside of this region.

Returns:

catalogpandas.DataFrame

Catalog containing DiaObject records.

Notes

This part of API may not be very stable and can change before the implementation finalizes.

abstract getDiaSources(region: Region, object_ids: Iterable[int] | None, visit_time: DateTime) → DataFrame | None

Return catalog of DiaSource instances from a given region.

Parameters:

regionlsst.sphgeom.Region

Region to search for DIASources.

object_idsiterable [ 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_timelsst.daf.base.DateTime

Time of the current visit.

Returns:

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

abstract getDiaSourcesHistory(start_time: DateTime, end_time: DateTime, region: Region | None = None) → DataFrame

Returns catalog of DiaSource instances from a given time period.

Parameters:

start_timedafBase.DateTime

Starting time for DiaSource history search. DiaSource record is selected when its midPointTai falls into an interval between start_time (inclusive) and end_time (exclusive).

end_timedafBase.DateTime

Upper limit on time for DiaSource history search.

regionlsst.sphgeom.Region, optional

Region to search for DiaSources, if not specified then whole sky is searched. If region is specified then some returned records may fall outside of this region.

Returns:

catalogpandas.DataFrame

Catalog containing DiaObject records.

Notes

This part of API may not be very stable and can change before the implementation finalizes.

abstract getSSObjects() → DataFrame

Returns catalog of SSObject instances.

Returns:

catalogpandas.DataFrame

Catalog containing SSObject records, all existing records are returned.

classmethod makeField(doc: str) → ConfigurableField

Make a ConfigurableField for Apdb.

Parameters:

docstr

Help text for the field.

Returns:

configurableFieldlsst.pex.config.ConfigurableField

A ConfigurableField for Apdb.

abstract makeSchema(drop: bool = False) → None

Create or re-create whole database schema.

Parameters:

dropbool

If True then drop all tables before creating new ones.

abstract reassignDiaSources(idMap: Mapping[int, int]) → None

Associate DiaSources with SSObjects, dis-associating them from DiaObjects.

Parameters:

idMapMapping

Maps DiaSource IDs to their new SSObject IDs.

Raises:

ValueError

Raised if DiaSource ID does not exist in the database.

abstract store(visit_time: DateTime, objects: DataFrame, sources: DataFrame | None = None, forced_sources: DataFrame | None = None) → None

Store all three types of catalogs in the database.

Parameters:

visit_timelsst.daf.base.DateTime

Time of the visit.

objectspandas.DataFrame

Catalog with DiaObject records.

sourcespandas.DataFrame, optional

Catalog with DiaSource records.

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

abstract storeSSObjects(objects: DataFrame) → None

Store or update SSObject catalog.

Parameters:

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

abstract tableDef(table: ApdbTables) → Table | None

Return table schema definition for a given table.

Parameters:

tableApdbTables

One of the known APDB tables.

Returns:

tableSchemafelis.simple.Table or None

Table schema description, None is returned if table is not defined by this implementation.