|
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) |
|
Abstract interface for APDB.
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.
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.
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.