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 https://github.com/lsst/ap_association.
You can find Jira issues for this module under the ap_association component.
Task reference¶
Pipeline Tasks¶
- DiaPipelineTask
- Task for loading, associating and storing Difference Image Analysis (DIA) Objects and Sources.
- FractionUpdatedDiaObjectsMetricTask
- Task that computes the fraction of previously created DIAObjects that have a new association in this image, visit, etc..
- NumberNewDiaObjectsMetricTask
- Task that computes the number of DIASources that create new DIAObjects in an image, visit, etc..
- NumberUnassociatedDiaObjectsMetricTask
- Task that computes the number of previously-known DIAObjects that do not have detected DIASources in an image, visit, etc..
- TotalUnassociatedDiaObjectsMetricTask
- Task that computes the number of DIAObjects with only one associated DIASource.
Tasks¶
No topics.
Python API reference¶
lsst.ap.association Package¶
Functions¶
getCcdVisitSchemaSql() |
Define the schema for the CcdVisit table. |
make_dia_forced_source_schema() |
Define and create the minimal schema required for a DiaForcedSource. |
make_dia_object_schema([filter_names]) |
Define and create the minimal schema required for a DIAObject. |
make_dia_source_schema() |
Define and create the schema required for a DIASource with additional needed columns for later calculation in DiaPipeTask. |
Classes¶
AssociationConfig |
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 |
Configuration for the generic DiaForcedSourcedTask class. |
DiaPipelineConfig |
Config for DiaPipelineTask. |
DiaPipelineConnections(*[, config]) |
Butler connections for DiaPipelineTask. |
DiaPipelineTask([initInputs]) |
Task for loading, associating and storing Difference Image Analysis (DIA) Objects and Sources. |
LoadDiaCatalogsConfig |
Config class for LoadDiaCatalogsConfig. |
LoadDiaCatalogsTask(**kwargs) |
Retrieve DiaObjects and associated DiaSources from the Apdb given an input exposure. |
PackageAlertsConfig |
Config class for AssociationTask. |
PackageAlertsTask(**kwargs) |
Tasks for packaging Dia and Pipelines data into Avro alert packages. |
TransformDiaSourceCatalogConfig |
|
TransformDiaSourceCatalogConnections(*, config) |
Butler connections for TransformDiaSourceCatalogTask. |
TransformDiaSourceCatalogTask(initInputs, …) |
Apply Science DataModel-ification on the DiaSource afw table. |
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.. |
TotalUnassociatedDiaObjectsMetricTask(**kwargs) |
Task that computes the number of DIAObjects with only one associated DIASource. |