lsst.dax.apdb.apdb.Apdb Class Reference
Inheritance diagram for lsst.dax.apdb.apdb.Apdb:
Public Member Functions | |
| Apdb | from_config (cls, ApdbConfig config) |
| Apdb | from_uri (cls, ResourcePathExpression uri) |
| ApdbConfig | getConfig (self) |
| Table|None | tableDef (self, ApdbTables table) |
| pandas.DataFrame | getDiaObjects (self, Region region) |
| pandas.DataFrame|None | getDiaSources (self, Region region, Iterable[int]|None object_ids, astropy.time.Time visit_time, astropy.time.Time|None start_time=None) |
| pandas.DataFrame|None | getDiaForcedSources (self, Region region, Iterable[int]|None object_ids, astropy.time.Time visit_time, astropy.time.Time|None start_time=None) |
| bool | containsVisitDetector (self, int visit, int detector, Region region, astropy.time.Time visit_time) |
| pandas.DataFrame | getSSObjects (self) |
| None | store (self, astropy.time.Time visit_time, pandas.DataFrame objects, pandas.DataFrame|None sources=None, pandas.DataFrame|None forced_sources=None) |
| None | storeSSObjects (self, pandas.DataFrame objects) |
| None | reassignDiaSources (self, Mapping[int, int] idMap) |
| None | dailyJob (self) |
| int | countUnassociatedObjects (self) |
| ApdbMetadata | metadata (self) |
| ApdbAdmin | admin (self) |
Detailed Description
Member Function Documentation
◆ admin()
| ApdbAdmin lsst.dax.apdb.apdb.Apdb.admin | ( | self | ) |
Object providing adminitrative interface for APDB (`ApdbAdmin`).
Reimplemented in lsst.dax.apdb.cassandra.apdbCassandra.ApdbCassandra, and lsst.dax.apdb.sql.apdbSql.ApdbSql.
Definition at line 391 of file apdb.py.
391 def admin(self) -> ApdbAdmin:
392 """Object providing adminitrative interface for APDB (`ApdbAdmin`)."""
393 raise NotImplementedError()
◆ containsVisitDetector()
| bool lsst.dax.apdb.apdb.Apdb.containsVisitDetector | ( | self, | |
| int | visit, | ||
| int | detector, | ||
| Region | region, | ||
| astropy.time.Time | visit_time ) |
Test whether any sources for a given visit-detector are present in
the APDB.
Parameters
----------
visit, detector : `int`
The ID of the visit-detector to search for.
region : `lsst.sphgeom.Region`
Region corresponding to the visit/detector combination.
visit_time : `astropy.time.Time`
Visit time (as opposed to visit processing time). This can be any
timestamp in the visit timespan, e.g. its begin or end time.
Returns
-------
present : `bool`
`True` if at least one DiaSource or DiaForcedSource record
may exist for the specified observation, `False` otherwise.
Reimplemented in lsst.dax.apdb.cassandra.apdbCassandra.ApdbCassandra, and lsst.dax.apdb.sql.apdbSql.ApdbSql.
Definition at line 241 of file apdb.py.
247 ) -> bool:
248 """Test whether any sources for a given visit-detector are present in
249 the APDB.
250
251 Parameters
252 ----------
253 visit, detector : `int`
254 The ID of the visit-detector to search for.
255 region : `lsst.sphgeom.Region`
256 Region corresponding to the visit/detector combination.
257 visit_time : `astropy.time.Time`
258 Visit time (as opposed to visit processing time). This can be any
259 timestamp in the visit timespan, e.g. its begin or end time.
260
261 Returns
262 -------
263 present : `bool`
264 `True` if at least one DiaSource or DiaForcedSource record
265 may exist for the specified observation, `False` otherwise.
266 """
267 raise NotImplementedError()
268
◆ 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.cassandra.apdbCassandra.ApdbCassandra, and lsst.dax.apdb.sql.apdbSql.ApdbSql.
Definition at line 366 of file apdb.py.
366 def countUnassociatedObjects(self) -> int:
367 """Return the number of DiaObjects that have only one DiaSource
368 associated with them.
369
370 Used as part of ap_verify metrics.
371
372 Returns
373 -------
374 count : `int`
375 Number of DiaObjects with exactly one associated DiaSource.
376
377 Notes
378 -----
379 This method can be very inefficient or slow in some implementations.
380 """
381 raise NotImplementedError()
382
◆ 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.cassandra.apdbCassandra.ApdbCassandra, and lsst.dax.apdb.sql.apdbSql.ApdbSql.
Definition at line 357 of file apdb.py.
357 def dailyJob(self) -> None:
358 """Implement daily activities like cleanup/vacuum.
359
360 What should be done during daily activities is determined by
361 specific implementation.
362 """
363 raise NotImplementedError()
364
◆ from_config()
| Apdb lsst.dax.apdb.apdb.Apdb.from_config | ( | cls, | |
| ApdbConfig | config ) |
Create Ppdb instance from configuration object.
Parameters
----------
config : `ApdbConfig`
Configuration object, type of this object determines type of the
Apdb implementation.
Returns
-------
apdb : `apdb`
Instance of `Apdb` class.
Definition at line 50 of file apdb.py.
50 def from_config(cls, config: ApdbConfig) -> Apdb:
51 """Create Ppdb instance from configuration object.
52
53 Parameters
54 ----------
55 config : `ApdbConfig`
56 Configuration object, type of this object determines type of the
57 Apdb implementation.
58
59 Returns
60 -------
61 apdb : `apdb`
62 Instance of `Apdb` class.
63 """
64 return make_apdb(config)
65
◆ from_uri()
| Apdb lsst.dax.apdb.apdb.Apdb.from_uri | ( | cls, | |
| ResourcePathExpression | uri ) |
Make Apdb instance from a serialized configuration.
Parameters
----------
uri : `~lsst.resources.ResourcePathExpression`
URI or local file path pointing to a file with serialized
configuration, or a string with a "label:" prefix. In the latter
case, the configuration will be looked up from an APDB index file
using the label name that follows the prefix. The APDB index file's
location is determined by the ``DAX_APDB_INDEX_URI`` environment
variable.
Returns
-------
apdb : `apdb`
Instance of `Apdb` class, the type of the returned instance is
determined by configuration.
Definition at line 67 of file apdb.py.
67 def from_uri(cls, uri: ResourcePathExpression) -> Apdb:
68 """Make Apdb instance from a serialized configuration.
69
70 Parameters
71 ----------
72 uri : `~lsst.resources.ResourcePathExpression`
73 URI or local file path pointing to a file with serialized
74 configuration, or a string with a "label:" prefix. In the latter
75 case, the configuration will be looked up from an APDB index file
76 using the label name that follows the prefix. The APDB index file's
77 location is determined by the ``DAX_APDB_INDEX_URI`` environment
78 variable.
79
80 Returns
81 -------
82 apdb : `apdb`
83 Instance of `Apdb` class, the type of the returned instance is
84 determined by configuration.
85 """
86 config = ApdbConfig.from_uri(uri)
87 return make_apdb(config)
88
◆ getConfig()
| ApdbConfig lsst.dax.apdb.apdb.Apdb.getConfig | ( | self | ) |
Return APDB configuration for this instance, including any updates
that may be read from database.
Returns
-------
config : `ApdbConfig`
APDB configuration.
Reimplemented in lsst.dax.apdb.cassandra.apdbCassandra.ApdbCassandra, and lsst.dax.apdb.sql.apdbSql.ApdbSql.
Definition at line 90 of file apdb.py.
90 def getConfig(self) -> ApdbConfig:
91 """Return APDB configuration for this instance, including any updates
92 that may be read from database.
93
94 Returns
95 -------
96 config : `ApdbConfig`
97 APDB configuration.
98 """
99 raise NotImplementedError()
100
◆ getDiaForcedSources()
| pandas.DataFrame | None lsst.dax.apdb.apdb.Apdb.getDiaForcedSources | ( | self, | |
| Region | region, | ||
| Iterable[int] | None | object_ids, | ||
| astropy.time.Time | visit_time, | ||
| astropy.time.Time | None | start_time = None ) |
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.
visit_time : `astropy.time.Time`
Time of the current visit. If APDB contains records later than this
time they may also be returned.
start_time : `astropy.time.Time`, optional
Lower bound of time window for the query. If not specified then
it is calculated using ``visit_time`` and
``read_forced_sources_months`` configuration parameter.
Returns
-------
catalog : `pandas.DataFrame`, or `None`
Catalog containing DiaForcedSource records. `None` is returned if
``start_time`` is not specified and ``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.cassandra.apdbCassandra.ApdbCassandra, and lsst.dax.apdb.sql.apdbSql.ApdbSql.
Definition at line 189 of file apdb.py.
195 ) -> pandas.DataFrame | None:
196 """Return catalog of DiaForcedSource instances from a given region.
197
198 Parameters
199 ----------
200 region : `lsst.sphgeom.Region`
201 Region to search for DIASources.
202 object_ids : iterable [ `int` ], optional
203 List of DiaObject IDs to further constrain the set of returned
204 sources. If list is empty then empty catalog is returned with a
205 correct schema. If `None` then returned sources are not
206 constrained.
207 visit_time : `astropy.time.Time`
208 Time of the current visit. If APDB contains records later than this
209 time they may also be returned.
210 start_time : `astropy.time.Time`, optional
211 Lower bound of time window for the query. If not specified then
212 it is calculated using ``visit_time`` and
213 ``read_forced_sources_months`` configuration parameter.
214
215 Returns
216 -------
217 catalog : `pandas.DataFrame`, or `None`
218 Catalog containing DiaForcedSource records. `None` is returned if
219 ``start_time`` is not specified and ``read_forced_sources_months``
220 configuration parameter is set to 0.
221
222 Raises
223 ------
224 NotImplementedError
225 May be raised by some implementations if ``object_ids`` is `None`.
226
227 Notes
228 -----
229 This method returns DiaForcedSource catalog for a region with
230 additional filtering based on DiaObject IDs. Only a subset of DiaSource
231 history is returned limited by ``read_forced_sources_months`` config
232 parameter, w.r.t. ``visit_time``. If ``object_ids`` is empty then an
233 empty catalog is always returned with the correct schema
234 (columns/types). If ``object_ids`` is `None` then no filtering is
235 performed and some of the returned records may be outside the specified
236 region.
237 """
238 raise NotImplementedError()
239
◆ getDiaObjects()
| pandas.DataFrame lsst.dax.apdb.apdb.Apdb.getDiaObjects | ( | self, | |
| Region | region ) |
Return catalog of DiaObject instances from a given region.
This method returns only the last version of each DiaObject,
and may return only the subset of the DiaObject columns needed
for AP association. 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.cassandra.apdbCassandra.ApdbCassandra, and lsst.dax.apdb.sql.apdbSql.ApdbSql.
Definition at line 119 of file apdb.py.
119 def getDiaObjects(self, region: Region) -> pandas.DataFrame:
120 """Return catalog of DiaObject instances from a given region.
121
122 This method returns only the last version of each DiaObject,
123 and may return only the subset of the DiaObject columns needed
124 for AP association. Some
125 records in a returned catalog may be outside the specified region, it
126 is up to a client to ignore those records or cleanup the catalog before
127 futher use.
128
129 Parameters
130 ----------
131 region : `lsst.sphgeom.Region`
132 Region to search for DIAObjects.
133
134 Returns
135 -------
136 catalog : `pandas.DataFrame`
137 Catalog containing DiaObject records for a region that may be a
138 superset of the specified region.
139 """
140 raise NotImplementedError()
141
◆ getDiaSources()
| pandas.DataFrame | None lsst.dax.apdb.apdb.Apdb.getDiaSources | ( | self, | |
| Region | region, | ||
| Iterable[int] | None | object_ids, | ||
| astropy.time.Time | visit_time, | ||
| astropy.time.Time | None | start_time = None ) |
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 : `astropy.time.Time`
Time of the current visit. If APDB contains records later than this
time they may also be returned.
start_time : `astropy.time.Time`, optional
Lower bound of time window for the query. If not specified then
it is calculated using ``visit_time`` and
``read_forced_sources_months`` configuration parameter.
Returns
-------
catalog : `pandas.DataFrame`, or `None`
Catalog containing DiaSource records. `None` is returned if
``start_time`` is not specified and ``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.cassandra.apdbCassandra.ApdbCassandra, and lsst.dax.apdb.sql.apdbSql.ApdbSql.
Definition at line 143 of file apdb.py.
149 ) -> pandas.DataFrame | None:
150 """Return catalog of DiaSource instances from a given region.
151
152 Parameters
153 ----------
154 region : `lsst.sphgeom.Region`
155 Region to search for DIASources.
156 object_ids : iterable [ `int` ], optional
157 List of DiaObject IDs to further constrain the set of returned
158 sources. If `None` then returned sources are not constrained. If
159 list is empty then empty catalog is returned with a correct
160 schema.
161 visit_time : `astropy.time.Time`
162 Time of the current visit. If APDB contains records later than this
163 time they may also be returned.
164 start_time : `astropy.time.Time`, optional
165 Lower bound of time window for the query. If not specified then
166 it is calculated using ``visit_time`` and
167 ``read_forced_sources_months`` configuration parameter.
168
169 Returns
170 -------
171 catalog : `pandas.DataFrame`, or `None`
172 Catalog containing DiaSource records. `None` is returned if
173 ``start_time`` is not specified and ``read_sources_months``
174 configuration parameter is set to 0.
175
176 Notes
177 -----
178 This method returns DiaSource catalog for a region with additional
179 filtering based on DiaObject IDs. Only a subset of DiaSource history
180 is returned limited by ``read_sources_months`` config parameter, w.r.t.
181 ``visit_time``. If ``object_ids`` is empty then an empty catalog is
182 always returned with the correct schema (columns/types). If
183 ``object_ids`` is `None` then no filtering is performed and some of the
184 returned records may be outside the specified region.
185 """
186 raise NotImplementedError()
187
◆ getSSObjects()
| pandas.DataFrame lsst.dax.apdb.apdb.Apdb.getSSObjects | ( | self | ) |
Return catalog of SSObject instances.
Returns
-------
catalog : `pandas.DataFrame`
Catalog containing SSObject records, all existing records are
returned.
Reimplemented in lsst.dax.apdb.cassandra.apdbCassandra.ApdbCassandra, and lsst.dax.apdb.sql.apdbSql.ApdbSql.
Definition at line 270 of file apdb.py.
270 def getSSObjects(self) -> pandas.DataFrame:
271 """Return catalog of SSObject instances.
272
273 Returns
274 -------
275 catalog : `pandas.DataFrame`
276 Catalog containing SSObject records, all existing records are
277 returned.
278 """
279 raise NotImplementedError()
280
◆ metadata()
| ApdbMetadata lsst.dax.apdb.apdb.Apdb.metadata | ( | self | ) |
Object controlling access to APDB metadata (`ApdbMetadata`).
Reimplemented in lsst.dax.apdb.cassandra.apdbCassandra.ApdbCassandra, and lsst.dax.apdb.sql.apdbSql.ApdbSql.
Definition at line 385 of file apdb.py.
385 def metadata(self) -> ApdbMetadata:
386 """Object controlling access to APDB metadata (`ApdbMetadata`)."""
387 raise NotImplementedError()
388
◆ reassignDiaSources()
| None lsst.dax.apdb.apdb.Apdb.reassignDiaSources | ( | self, | |
| Mapping[int, int] | idMap ) |
Associate DiaSources with SSObjects, dis-associating them
from DiaObjects.
Parameters
----------
idMap : `Mapping`
Maps DiaSource IDs to their new SSObject IDs.
Raises
------
ValueError
Raised if DiaSource ID does not exist in the database.
Reimplemented in lsst.dax.apdb.cassandra.apdbCassandra.ApdbCassandra, and lsst.dax.apdb.sql.apdbSql.ApdbSql.
Definition at line 340 of file apdb.py.
340 def reassignDiaSources(self, idMap: Mapping[int, int]) -> None:
341 """Associate DiaSources with SSObjects, dis-associating them
342 from DiaObjects.
343
344 Parameters
345 ----------
346 idMap : `Mapping`
347 Maps DiaSource IDs to their new SSObject IDs.
348
349 Raises
350 ------
351 ValueError
352 Raised if DiaSource ID does not exist in the database.
353 """
354 raise NotImplementedError()
355
◆ store()
| None lsst.dax.apdb.apdb.Apdb.store | ( | self, | |
| astropy.time.Time | visit_time, | ||
| pandas.DataFrame | objects, | ||
| pandas.DataFrame | None | sources = None, | ||
| pandas.DataFrame | None | forced_sources = None ) |
Store all three types of catalogs in the database.
Parameters
----------
visit_time : `astropy.time.Time`
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
This operation need not be atomic, but DiaSources and DiaForcedSources
will not be stored until all DiaObjects are stored.
Reimplemented in lsst.dax.apdb.cassandra.apdbCassandra.ApdbCassandra, and lsst.dax.apdb.sql.apdbSql.ApdbSql.
Definition at line 282 of file apdb.py.
288 ) -> None:
289 """Store all three types of catalogs in the database.
290
291 Parameters
292 ----------
293 visit_time : `astropy.time.Time`
294 Time of the visit.
295 objects : `pandas.DataFrame`
296 Catalog with DiaObject records.
297 sources : `pandas.DataFrame`, optional
298 Catalog with DiaSource records.
299 forced_sources : `pandas.DataFrame`, optional
300 Catalog with DiaForcedSource records.
301
302 Notes
303 -----
304 This methods takes DataFrame catalogs, their schema must be
305 compatible with the schema of APDB table:
306
307 - column names must correspond to database table columns
308 - types and units of the columns must match database definitions,
309 no unit conversion is performed presently
310 - columns that have default values in database schema can be
311 omitted from catalog
312 - this method knows how to fill interval-related columns of DiaObject
313 (validityStart, validityEnd) they do not need to appear in a
314 catalog
315 - source catalogs have ``diaObjectId`` column associating sources
316 with objects
317
318 This operation need not be atomic, but DiaSources and DiaForcedSources
319 will not be stored until all DiaObjects are stored.
320 """
321 raise NotImplementedError()
322
◆ storeSSObjects()
| None lsst.dax.apdb.apdb.Apdb.storeSSObjects | ( | self, | |
| pandas.DataFrame | objects ) |
Store or update SSObject catalog.
Parameters
----------
objects : `pandas.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.
Reimplemented in lsst.dax.apdb.cassandra.apdbCassandra.ApdbCassandra, and lsst.dax.apdb.sql.apdbSql.ApdbSql.
Definition at line 324 of file apdb.py.
324 def storeSSObjects(self, objects: pandas.DataFrame) -> None:
325 """Store or update SSObject catalog.
326
327 Parameters
328 ----------
329 objects : `pandas.DataFrame`
330 Catalog with SSObject records.
331
332 Notes
333 -----
334 If SSObjects with matching IDs already exist in the database, their
335 records will be updated with the information from provided records.
336 """
337 raise NotImplementedError()
338
◆ tableDef()
| Table | None 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 : `.schema_model.Table` or `None`
Table schema description, `None` is returned if table is not
defined by this implementation.
Reimplemented in lsst.dax.apdb.cassandra.apdbCassandra.ApdbCassandra, and lsst.dax.apdb.sql.apdbSql.ApdbSql.
Definition at line 102 of file apdb.py.
102 def tableDef(self, table: ApdbTables) -> Table | None:
103 """Return table schema definition for a given table.
104
105 Parameters
106 ----------
107 table : `ApdbTables`
108 One of the known APDB tables.
109
110 Returns
111 -------
112 tableSchema : `.schema_model.Table` or `None`
113 Table schema description, `None` is returned if table is not
114 defined by this implementation.
115 """
116 raise NotImplementedError()
117
The documentation for this class was generated from the following file:
- /j/snowflake/release/lsstsw/stack/lsst-scipipe-12.0.0/Linux/dax_apdb/g7382096ae9+36d16ea71a/python/lsst/dax/apdb/apdb.py
Generated on Mon Oct 27 2025 07:01:39 for LSST Applications by
1.13.2