|
def | __init__ (self, ApdbCassandraConfig config) |
|
Optional[TableDef] | tableDef (self, ApdbTables table) |
|
None | makeSchema (self, bool drop=False) |
|
pandas.DataFrame | getDiaObjects (self, sphgeom.Region region) |
|
Optional[pandas.DataFrame] | getDiaSources (self, sphgeom.Region region, Optional[Iterable[int]] object_ids, dafBase.DateTime visit_time) |
|
Optional[pandas.DataFrame] | getDiaForcedSources (self, sphgeom.Region region, Optional[Iterable[int]] object_ids, dafBase.DateTime visit_time) |
|
pandas.DataFrame | getDiaObjectsHistory (self, dafBase.DateTime start_time, dafBase.DateTime end_time, Optional[sphgeom.Region] region=None) |
|
pandas.DataFrame | getDiaSourcesHistory (self, dafBase.DateTime start_time, dafBase.DateTime end_time, Optional[sphgeom.Region] region=None) |
|
pandas.DataFrame | getDiaForcedSourcesHistory (self, dafBase.DateTime start_time, dafBase.DateTime end_time, Optional[sphgeom.Region] region=None) |
|
pandas.DataFrame | getSSObjects (self) |
|
None | store (self, dafBase.DateTime visit_time, pandas.DataFrame objects, Optional[pandas.DataFrame] sources=None, Optional[pandas.DataFrame] forced_sources=None) |
|
None | storeSSObjects (self, pandas.DataFrame objects) |
|
None | reassignDiaSources (self, Mapping[int, int] idMap) |
|
None | dailyJob (self) |
|
int | countUnassociatedObjects (self) |
|
ConfigurableField | makeField (cls, str doc) |
|
Implementation of APDB database on to of Apache Cassandra.
The implementation is configured via standard ``pex_config`` mechanism
using `ApdbCassandraConfig` configuration class. For an example of
different configurations check config/ folder.
Parameters
----------
config : `ApdbCassandraConfig`
Configuration object.
Optional[pandas.DataFrame] lsst.dax.apdb.apdbCassandra.ApdbCassandra.getDiaForcedSources |
( |
|
self, |
|
|
sphgeom.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 from lsst.dax.apdb.apdb.Apdb.
pandas.DataFrame lsst.dax.apdb.apdbCassandra.ApdbCassandra.getDiaForcedSourcesHistory |
( |
|
self, |
|
|
dafBase.DateTime |
start_time, |
|
|
dafBase.DateTime |
end_time, |
|
|
Optional[sphgeom.Region] |
region = None |
|
) |
| |
Returns catalog of DiaForcedSource instances from a given time
period.
Parameters
----------
start_time : `dafBase.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_time : `dafBase.DateTime`
Upper limit on time for DiaForcedSource history search.
region : `lsst.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
-------
catalog : `pandas.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.
Reimplemented from lsst.dax.apdb.apdb.Apdb.
Optional[pandas.DataFrame] lsst.dax.apdb.apdbCassandra.ApdbCassandra.getDiaSources |
( |
|
self, |
|
|
sphgeom.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 from lsst.dax.apdb.apdb.Apdb.
None lsst.dax.apdb.apdbCassandra.ApdbCassandra.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 from lsst.dax.apdb.apdb.Apdb.