LSST Applications  21.0.0-172-gfb10e10a+18fedfabac,22.0.0+297cba6710,22.0.0+80564b0ff1,22.0.0+8d77f4f51a,22.0.0+a28f4c53b1,22.0.0+dcf3732eb2,22.0.1-1-g7d6de66+2a20fdde0d,22.0.1-1-g8e32f31+297cba6710,22.0.1-1-geca5380+7fa3b7d9b6,22.0.1-12-g44dc1dc+2a20fdde0d,22.0.1-15-g6a90155+515f58c32b,22.0.1-16-g9282f48+790f5f2caa,22.0.1-2-g92698f7+dcf3732eb2,22.0.1-2-ga9b0f51+7fa3b7d9b6,22.0.1-2-gd1925c9+bf4f0e694f,22.0.1-24-g1ad7a390+a9625a72a8,22.0.1-25-g5bf6245+3ad8ecd50b,22.0.1-25-gb120d7b+8b5510f75f,22.0.1-27-g97737f7+2a20fdde0d,22.0.1-32-gf62ce7b1+aa4237961e,22.0.1-4-g0b3f228+2a20fdde0d,22.0.1-4-g243d05b+871c1b8305,22.0.1-4-g3a563be+32dcf1063f,22.0.1-4-g44f2e3d+9e4ab0f4fa,22.0.1-42-gca6935d93+ba5e5ca3eb,22.0.1-5-g15c806e+85460ae5f3,22.0.1-5-g58711c4+611d128589,22.0.1-5-g75bb458+99c117b92f,22.0.1-6-g1c63a23+7fa3b7d9b6,22.0.1-6-g50866e6+84ff5a128b,22.0.1-6-g8d3140d+720564cf76,22.0.1-6-gd805d02+cc5644f571,22.0.1-8-ge5750ce+85460ae5f3,master-g6e05de7fdc+babf819c66,master-g99da0e417a+8d77f4f51a,w.2021.48
LSST Data Management Base Package
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[TableDef] tableDef (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.

Definition at line 70 of file apdb.py.

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.apdbSql.ApdbSql, and lsst.dax.apdb.apdbCassandra.ApdbCassandra.

Definition at line 250 of file apdb.py.

250  def countUnassociatedObjects(self) -> int:
251  """Return the number of DiaObjects that have only one DiaSource
252  associated with them.
253 
254  Used as part of ap_verify metrics.
255 
256  Returns
257  -------
258  count : `int`
259  Number of DiaObjects with exactly one associated DiaSource.
260 
261  Notes
262  -----
263  This method can be very inefficient or slow in some implementations.
264  """
265  raise NotImplementedError()
266 

◆ 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.apdbSql.ApdbSql, and lsst.dax.apdb.apdbCassandra.ApdbCassandra.

Definition at line 241 of file apdb.py.

241  def dailyJob(self) -> None:
242  """Implement daily activities like cleanup/vacuum.
243 
244  What should be done during daily activities is determined by
245  specific implementation.
246  """
247  raise NotImplementedError()
248 

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

Definition at line 163 of file apdb.py.

165  visit_time: dafBase.DateTime) -> Optional[pandas.DataFrame]:
166  """Return catalog of DiaForcedSource instances from a given region.
167 
168  Parameters
169  ----------
170  region : `lsst.sphgeom.Region`
171  Region to search for DIASources.
172  object_ids : iterable [ `int` ], optional
173  List of DiaObject IDs to further constrain the set of returned
174  sources. If list is empty then empty catalog is returned with a
175  correct schema. If `None` then returned sources are not
176  constrained. Some implementations may not support latter case.
177  visit_time : `lsst.daf.base.DateTime`
178  Time of the current visit.
179 
180  Returns
181  -------
182  catalog : `pandas.DataFrame`, or `None`
183  Catalog containing DiaSource records. `None` is returned if
184  ``read_forced_sources_months`` configuration parameter is set to 0.
185 
186  Raises
187  ------
188  NotImplementedError
189  May be raised by some implementations if ``object_ids`` is `None`.
190 
191  Notes
192  -----
193  This method returns DiaForcedSource catalog for a region with additional
194  filtering based on DiaObject IDs. Only a subset of DiaSource history
195  is returned limited by ``read_forced_sources_months`` config parameter,
196  w.r.t. ``visit_time``. If ``object_ids`` is empty then an empty catalog
197  is always returned with the correct schema (columns/types). If
198  ``object_ids`` is `None` then no filtering is performed and some of the
199  returned records may be outside the specified region.
200  """
201  raise NotImplementedError()
202 
lsst::daf::base::DateTime
Class for handling dates/times, including MJD, UTC, and TAI.
Definition: DateTime.h:64

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

Definition at line 105 of file apdb.py.

105  def getDiaObjects(self, region: Region) -> pandas.DataFrame:
106  """Returns catalog of DiaObject instances from a given region.
107 
108  This method returns only the last version of each DiaObject. Some
109  records in a returned catalog may be outside the specified region, it
110  is up to a client to ignore those records or cleanup the catalog before
111  futher use.
112 
113  Parameters
114  ----------
115  region : `lsst.sphgeom.Region`
116  Region to search for DIAObjects.
117 
118  Returns
119  -------
120  catalog : `pandas.DataFrame`
121  Catalog containing DiaObject records for a region that may be a
122  superset of the specified region.
123  """
124  raise NotImplementedError()
125 

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

Definition at line 127 of file apdb.py.

129  visit_time: dafBase.DateTime) -> Optional[pandas.DataFrame]:
130  """Return catalog of DiaSource instances from a given region.
131 
132  Parameters
133  ----------
134  region : `lsst.sphgeom.Region`
135  Region to search for DIASources.
136  object_ids : iterable [ `int` ], optional
137  List of DiaObject IDs to further constrain the set of returned
138  sources. If `None` then returned sources are not constrained. If
139  list is empty then empty catalog is returned with a correct
140  schema.
141  visit_time : `lsst.daf.base.DateTime`
142  Time of the current visit.
143 
144  Returns
145  -------
146  catalog : `pandas.DataFrame`, or `None`
147  Catalog containing DiaSource records. `None` is returned if
148  ``read_sources_months`` configuration parameter is set to 0.
149 
150  Notes
151  -----
152  This method returns DiaSource catalog for a region with additional
153  filtering based on DiaObject IDs. Only a subset of DiaSource history
154  is returned limited by ``read_sources_months`` config parameter, w.r.t.
155  ``visit_time``. If ``object_ids`` is empty then an empty catalog is
156  always returned with the correct schema (columns/types). If
157  ``object_ids`` is `None` then no filtering is performed and some of the
158  returned records may be outside the specified region.
159  """
160  raise NotImplementedError()
161 

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

Definition at line 268 of file apdb.py.

268  def makeField(cls, doc: str) -> ConfigurableField:
269  """Make a `~lsst.pex.config.ConfigurableField` for Apdb.
270 
271  Parameters
272  ----------
273  doc : `str`
274  Help text for the field.
275 
276  Returns
277  -------
278  configurableField : `lsst.pex.config.ConfigurableField`
279  A `~lsst.pex.config.ConfigurableField` for Apdb.
280  """
281  return ConfigurableField(doc=doc, target=cls)

◆ 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.apdbSql.ApdbSql, and lsst.dax.apdb.apdbCassandra.ApdbCassandra.

Definition at line 94 of file apdb.py.

94  def makeSchema(self, drop: bool = False) -> None:
95  """Create or re-create whole database schema.
96 
97  Parameters
98  ----------
99  drop : `bool`
100  If True then drop all tables before creating new ones.
101  """
102  raise NotImplementedError()
103 

◆ 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.apdbSql.ApdbSql, and lsst.dax.apdb.apdbCassandra.ApdbCassandra.

Definition at line 204 of file apdb.py.

208  forced_sources: Optional[pandas.DataFrame] = None) -> None:
209  """Store all three types of catalogs in the database.
210 
211  Parameters
212  ----------
213  visit_time : `lsst.daf.base.DateTime`
214  Time of the visit.
215  objects : `pandas.DataFrame`
216  Catalog with DiaObject records.
217  sources : `pandas.DataFrame`, optional
218  Catalog with DiaSource records.
219  forced_sources : `pandas.DataFrame`, optional
220  Catalog with DiaForcedSource records.
221 
222  Notes
223  -----
224  This methods takes DataFrame catalogs, their schema must be
225  compatible with the schema of APDB table:
226 
227  - column names must correspond to database table columns
228  - types and units of the columns must match database definitions,
229  no unit conversion is performed presently
230  - columns that have default values in database schema can be
231  omitted from catalog
232  - this method knows how to fill interval-related columns of DiaObject
233  (validityStart, validityEnd) they do not need to appear in a
234  catalog
235  - source catalogs have ``diaObjectId`` column associating sources
236  with objects
237  """
238  raise NotImplementedError()
239 

◆ 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.apdbSql.ApdbSql, and lsst.dax.apdb.apdbCassandra.ApdbCassandra.

Definition at line 77 of file apdb.py.

77  def tableDef(self, table: ApdbTables) -> Optional[TableDef]:
78  """Return table schema definition for a given table.
79 
80  Parameters
81  ----------
82  table : `ApdbTables`
83  One of the known APDB tables.
84 
85  Returns
86  -------
87  tableSchema : `TableDef` or `None`
88  Table schema description, `None` is returned if table is not
89  defined by this implementation.
90  """
91  raise NotImplementedError()
92 

Member Data Documentation

◆ ConfigClass

lsst.dax.apdb.apdb.Apdb.ConfigClass = ApdbConfig
static

Definition at line 74 of file apdb.py.

The documentation for this class was generated from the following file:
Generated on Fri Nov 26 2021 10:16:18 for LSST Applications by doxygen 1.9.1