LoadDiaCatalogsTask#

class lsst.ap.association.LoadDiaCatalogsTask(**kwargs)#

Bases: PipelineTask

Retrieve DiaObjects and associated DiaSources from the Apdb given an input exposure.

Methods Summary

loadDiaForcedSources(diaObjects, region, ...)

Load DiaForcedSources from the Apdb based on their diaObjectId.

loadDiaObjects(region, schema)

Load DiaObjects from the Apdb based on their HTM location.

loadDiaSources(diaObjects, region, dateTime, ...)

Load DiaSources from the Apdb based on their diaObjectId or location.

run(regionTime)

Preload all DiaObjects and DiaSources from the Apdb given the current exposure.

Methods Documentation

loadDiaForcedSources(diaObjects, region, dateTime, schema)#

Load DiaForcedSources from the Apdb based on their diaObjectId.

Parameters#

diaObjectspandas.DataFrame

DiaObjects to load the history for, indexed by diaObjectId.

regionsphgeom.Region

Region of interest.

dateTimeastropy.time.Time

Time of the current visit

schema‘dict’ of lsst.dax.apdb.apdbSchema.ApdbSchema

A dict of the schemas in the apdb.

Returns#

diaForcedSourcespandas.DataFrame

DiaForcedSources loaded from the Apdb that are associated with diaObjects, indexed by diaObjectId and diaForcedSourceId.

loadDiaObjects(region, schema)#

Load DiaObjects from the Apdb based on their HTM location.

Parameters#

regionsphgeom.Region

Region of interest.

schema‘dict’ of lsst.dax.apdb.apdbSchema.ApdbSchema

A dict of the schemas in the apdb.

Returns#

diaObjectspandas.DataFrame

DiaObjects loaded from the Apdb that are within region, indexed by diaObjectId.

loadDiaSources(diaObjects, region, dateTime, schema)#

Load DiaSources from the Apdb based on their diaObjectId or location.

Parameters#

diaObjectspandas.DataFrame

DiaObjects to load the history for, indexed by diaObjectId.

regionsphgeom.Region

Region of interest.

dateTimeastropy.time.Time

Time of the current visit

schema‘dict’ of lsst.dax.apdb.apdbSchema.ApdbSchema

A dict of the schemas in the apdb.

Returns#

diaSourcespandas.DataFrame

DiaSources loaded from the Apdb that are within region and associated with diaObjects, indexed by diaObjectId, band, and diaSourceId.

run(regionTime)#

Preload all DiaObjects and DiaSources from the Apdb given the current exposure.

Parameters#

regionTimelsst.pipe.base.utils.RegionTimeInfo

A serializable container for a sky region and timespan.

Returns#

resultlsst.pipe.base.Struct

Results struct with components.

  • diaObjects : Complete set of DiaObjects covering the input exposure padded by angleMargin. DataFrame is indexed by the diaObjectId column. (pandas.DataFrame)

  • diaSources : Complete set of DiaSources covering the input exposure padded by angleMargin. DataFrame is indexed by diaObjectId, band, diaSourceId columns. (pandas.DataFrame)

  • diaForcedSources : Complete set of forced photometered fluxes on the past 12 months of difference images at DiaObject locations, indexed by diaObjectId and diaForcedSourceId. (pandas.DataFrame)

Raises#

RuntimeError

Raised if the Database query failed to load DiaObjects.