lsst.ap.association

The ap_association package provides tools for associating DIAObjects to DIASources, persisting this association, and computing DIAObject summary statistics.

Contributing

lsst.ap.association is developed at lsst/ap_association. You can find Jira issues for this module under the ap_association component.

Task reference

Pipeline Tasks

Tasks

Python API reference

lsst.ap.association Package

Functions

getMidpointFromTimespan(timespan[, ...])	Safely retrieve the midpoint in TAI from a Timespan.
getRegion(exposure)	Calculate an enveloping region for an exposure.
makeEmptyForcedSourceTable(schema)	Return a dataframe with the correct columns for diaForcedSources table.
paddedRegion(region, margin)	Return a region that has been expanded by a buffer.
readSchemaFromApdb(apdb)	Extract the schema from an APDB instance.

Classes

AssociationConfig(*args, **kw)	Config class for AssociationTask.
AssociationTask([config, name, parentTask, log])	Associate DIAOSources into existing DIAObjects.
DiaForcedSourceTask(**kwargs)	Task for measuring and storing forced sources at DiaObject locations in both difference and direct images.
DiaForcedSourcedConfig(*args, **kw)	Configuration for the generic DiaForcedSourcedTask class.
DiaPipelineConfig(*args, **kw)	Config for DiaPipelineTask.
DiaPipelineConnections(*[, config])	Butler connections for DiaPipelineTask.
DiaPipelineTask([initInputs])	Task for loading, associating and storing Difference Image Analysis (DIA) Objects and Sources.
ExportDiaCatalogsConfig(*args, **kw)	Config class for ExportDiaCatalogsConfig.
ExportDiaCatalogsTask(**kwargs)	Retrieve DiaObjects and associated DiaSources from the Apdb given an input exposure.
FilterDiaSourceCatalogConfig(*args, **kw)	Config class for FilterDiaSourceCatalogTask.
FilterDiaSourceCatalogTask(*[, config, log, ...])	Filter sources from a DiaSource catalog.
FilterDiaSourceReliabilityConfig(*args, **kw)	Configuration for the FilterDiaSourceReliabilityTask.
FilterDiaSourceReliabilityTask(*[, config, ...])	Filter DiaSource catalog by reliability score.
LoadDiaCatalogsConfig(*args, **kw)	Config class for LoadDiaCatalogsConfig.
LoadDiaCatalogsTask(**kwargs)	Retrieve DiaObjects and associated DiaSources from the Apdb given an input exposure.
MPSkyEphemerisQueryConfig(*args, **kw)
MPSkyEphemerisQueryTask(*[, config, log, ...])	Task to query the MPSky service and retrieve the solar system objects that are observable within the input visit.
PackageAlertsConfig(*args, **kw)	Config class for AssociationTask.
PackageAlertsTask(**kwargs)	Tasks for packaging Dia and Pipelines data into Avro alert packages.
SsSingleFrameAssociationConfig(*args, **kw)	Config for DiaPipelineTask.
SsSingleFrameAssociationConnections(*[, config])	Butler connections for SsSingleFrameAssociationTask.
SsSingleFrameAssociationTask([initInputs])	Task for loading, associating and storing Difference Image Analysis (DIA) Objects and Sources.
TransformDiaSourceCatalogConfig(*args, **kw)
TransformDiaSourceCatalogConnections(*[, config])
TransformDiaSourceCatalogTask(initInputs, ...)	Transform a DiaSource catalog by calibrating and renaming columns to produce a table ready to insert into the Apdb.
UnpackApdbFlags(flag_map_file, table_name)	Class for unpacking bits from integer flag fields stored in the Apdb.

lsst.ap.association.metrics Module

Classes

NumberNewDiaObjectsMetricTask(**kwargs)	Task that computes the number of DIASources that create new DIAObjects in an image, visit, etc..
NumberUnassociatedDiaObjectsMetricTask(**kwargs)	Task that computes the number of previously-known DIAObjects that do not have detected DIASources in an image, visit, etc..
FractionUpdatedDiaObjectsMetricTask(**kwargs)	Task that computes the fraction of previously created DIAObjects that have a new association in this image, visit, etc..
NumberSolarSystemObjectsMetricTask(**kwargs)	Task that computes the number of SolarSystemObjects that are observable within this detectorVisit.
NumberAssociatedSolarSystemObjectsMetricTask(...)	Number of SolarSystemObjects that were associated with new DiaSources for this detectorVisit.
TotalUnassociatedDiaObjectsMetricTask(**kwargs)	Task that computes the number of DIAObjects with only one associated DIASource.