lsst.dax.apdb 23.0.0-5-gd4f24f6+d5c7895350
Public Member Functions | Static Public Attributes | List of all members
lsst.dax.apdb.apdb.Apdb Class Reference
Inheritance diagram for lsst.dax.apdb.apdb.Apdb:
lsst.dax.apdb.apdbCassandra.ApdbCassandra lsst.dax.apdb.apdbSql.ApdbSql

Public Member Functions

Optional[TableDeftableDef (self, ApdbTables table)
 
None makeSchema (self, bool drop=False)
 
pandas.DataFrame getDiaObjects (self, Region region)
 
Optional[pandas.DataFrame] getDiaSources (self, Region region, Optional[Iterable[int]] object_ids, dafBase.DateTime visit_time)
 
Optional[pandas.DataFrame] getDiaForcedSources (self, Region region, Optional[Iterable[int]] object_ids, dafBase.DateTime visit_time)
 
None store (self, dafBase.DateTime visit_time, pandas.DataFrame objects, Optional[pandas.DataFrame] sources=None, Optional[pandas.DataFrame] forced_sources=None)
 
None dailyJob (self)
 
int countUnassociatedObjects (self)
 
ConfigurableField makeField (cls, str doc)
 

Static Public Attributes

 ConfigClass = ApdbConfig
 

Detailed Description

Abstract interface for APDB.

Member Function Documentation

◆ countUnassociatedObjects()

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.

◆ dailyJob()

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.

◆ getDiaForcedSources()

Optional[pandas.DataFrame] lsst.dax.apdb.apdb.Apdb.getDiaForcedSources (   self,
Region  region,
Optional[Iterable[int]]  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.

◆ getDiaObjects()

pandas.DataFrame lsst.dax.apdb.apdb.Apdb.getDiaObjects (   self,
Region  region 
)
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.

Reimplemented in lsst.dax.apdb.apdbSql.ApdbSql, and lsst.dax.apdb.apdbCassandra.ApdbCassandra.

◆ getDiaSources()

Optional[pandas.DataFrame] lsst.dax.apdb.apdb.Apdb.getDiaSources (   self,
Region  region,
Optional[Iterable[int]]  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.

◆ makeField()

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.

◆ makeSchema()

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.

◆ store()

None lsst.dax.apdb.apdb.Apdb.store (   self,
dafBase.DateTime  visit_time,
pandas.DataFrame  objects,
Optional[pandas.DataFrame]   sources = None,
Optional[pandas.DataFrame]   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.

◆ tableDef()

Optional[TableDef] 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 : `TableDef` 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.


The documentation for this class was generated from the following file: