DrpAssociationPipeTask

class lsst.pipe.tasks.drpAssociationPipe.DrpAssociationPipeTask(**kwargs)

Bases: PipelineTask

Driver pipeline for loading DiaSource catalogs in a patch/tract region and associating them.

Methods Summary

dropDiaSourceByDiaObjectId(...)	Drop diaSources with diaObject IDs in the supplied list.
run(diaSourceTables, ssObjectTableRefs, ...)	Trim DiaSources to the current Patch and run association.
runQuantum(butlerQC, inputRefs, outputRefs)	Do butler IO and transform to provide in memory objects for tasks run method.
runSolarSystemAssociation(diaCat, ssCat, ...)	Run Solar System object association and filter the results.

Methods Documentation

dropDiaSourceByDiaObjectId(droppedDiaObjectIds, diaSources)

Drop diaSources with diaObject IDs in the supplied list.

Parameters

droppedDiaObjectIdspandas.DataFrame

DiaObjectIds to match and drop from the list of diaSources.

diaSourcespandas.DataFrame

Catalog of diaSources to check and filter.

Returns

filteredDiaSourcespandas.DataFrame

The input diaSources with any rows matching the listed diaObjectIds removed.

run(diaSourceTables, ssObjectTableRefs, skyMap, finalVisitSummaryRefs, tractId, patchId, idGenerator=None)

Trim DiaSources to the current Patch and run association.

Takes in the set of DiaSource catalogs that covers the current patch, trims them to the dimensions of the patch, and [TODO: eventually] runs association on the concatenated DiaSource Catalog.

Parameters

diaSourceTableslist of lsst.daf.butler.DeferredDatasetHandle

Set of DiaSource catalogs potentially covering this patch/tract.

ssObjectTableRefslist of lsst.daf.butler.DeferredDatasetHandle

Set of known SSO ephemerides potentially covering this patch/tract.

skyMaplsst.skymap.BaseSkyMap

SkyMap defining the patch/tract

finalVisitSummaryRefslist of lsst.daf.butler.DeferredDatasetHandle

Reference to finalVisitSummary of each exposure potentially covering this patch/tract, which contain visitInfo, bbox, and wcs

tractIdint

Id of current tract being processed.

patchIdint

Id of current patch being processed.

idGeneratorlsst.meas.base.IdGenerator, optional

Object that generates Object IDs and random number generator seeds.

Returns

outputlsst.pipe.base.Struct

Results struct with attributes:

assocDiaSourceTable

Table of DiaSources with updated value for diaObjectId. (pandas.DataFrame)

diaObjectTable

Table of DiaObjects from matching DiaSources (pandas.DataFrame).

runQuantum(butlerQC, inputRefs, outputRefs)

Do butler IO and transform to provide in memory objects for tasks run method.

Parameters

butlerQCQuantumContext

A butler which is specialized to operate in the context of a lsst.daf.butler.Quantum.

inputRefsInputQuantizedConnection

Datastructure whose attribute names are the names that identify connections defined in corresponding PipelineTaskConnections class. The values of these attributes are the lsst.daf.butler.DatasetRef objects associated with the defined input/prerequisite connections.

outputRefsOutputQuantizedConnection

Datastructure whose attribute names are the names that identify connections defined in corresponding PipelineTaskConnections class. The values of these attributes are the lsst.daf.butler.DatasetRef objects associated with the defined output connections.

runSolarSystemAssociation(diaCat, ssCat, visitSummary, patchBbox, patchWcs, innerTractSkyRegion, detector, visit)

Run Solar System object association and filter the results.

Parameters

diaCatpandas.DataFrame

Catalog of detected diaSources on the image difference.

ssCatastropy.table.Table

Catalog of predicted coordinates of known Solar System objects.

visitSummarylsst.afw.table.ExposureCatalog

Table of calibration and metadata for all detectors in a visit.

patchBboxlsst.geom.Box2D

Bounding box of the patch.

patchWcslsst.geom.SkyWcs

Wcs of the tract containing the patch.

innerTractSkyRegionlsst.sphgeom.Box

Region defining the inner non-overlapping part of a tract.

detectorint

Detector number of the science exposure.

visitint

Visit number of the science exposure.

Returns

ssoAssocResultlsst.pipe.base.Struct

Results struct with attributes:

associatedSsSources

Table of DiaSources associated with Solar System objects. (astropy.table.Table)

associatedSsDiaSources

Table of Solar System objects associated with DiaSources. (astropy.table.Table).

unassociatedSsObjects

Table of Solar System objects in the patch not associated with any DiaSource (astropy.table.Table).

unassociatedDiaSources

Table of DiaSources not associated with any Solar System object (astropy.table.Table).