DrpAssociationPipeTask¶

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

Bases: PipelineTask

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

Attributes Summary

canMultiprocess

Methods Summary

`dropDiaSourceByDiaObjectId`(...)	Drop diaSources with diaObject IDs in the supplied list.
`emptyMetadata`()	Empty (clear) the metadata for this Task and all sub-Tasks.
`getFullMetadata`()	Get metadata for all tasks.
`getFullName`()	Get the task name as a hierarchical name including parent task names.
`getName`()	Get the name of the task.
`getTaskDict`()	Get a dictionary of all tasks as a shallow copy.
`makeField`(doc)	Make a `lsst.pex.config.ConfigurableField` for this task.
`makeSubtask`(name, **keyArgs)	Create a subtask as a new instance as the `name` attribute of this task.
`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.
`timer`(name[, logLevel])	Context manager to log performance data for an arbitrary block of code.

Attributes Documentation

canMultiprocess: ClassVar[bool] = True¶

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.

emptyMetadata() → None¶: Empty (clear) the metadata for this Task and all sub-Tasks.

getFullMetadata() → TaskMetadata¶

Get metadata for all tasks.

Returns:

metadataTaskMetadata: The keys are the full task name. Values are metadata for the top-level task and all subtasks, sub-subtasks, etc.

Notes

The returned metadata includes timing information (if @timer.timeMethod is used) and any metadata set by the task. The name of each item consists of the full task name with . replaced by :, followed by . and the name of the item, e.g.:

topLevelTaskName:subtaskName:subsubtaskName.itemName

using : in the full task name disambiguates the rare situation that a task has a subtask and a metadata item with the same name.

getFullName() → str¶

Get the task name as a hierarchical name including parent task names.

Returns:

fullNamestr

The full name consists of the name of the parent task and each subtask separated by periods. For example:

The full name of top-level task “top” is simply “top”.
The full name of subtask “sub” of top-level task “top” is “top.sub”.
The full name of subtask “sub2” of subtask “sub” of top-level task “top” is “top.sub.sub2”.

getName() → str¶

Get the name of the task.

Returns:

taskNamestr: Name of the task.

See also

getFullName: Get the full name of the task.

getTaskDict() → dict[str, weakref.ReferenceType[lsst.pipe.base.task.Task]]¶

Get a dictionary of all tasks as a shallow copy.

Returns:

taskDictdict: Dictionary containing full task name: task object for the top-level task and all subtasks, sub-subtasks, etc.

classmethod makeField(doc: str) → ConfigurableField¶

Make a lsst.pex.config.ConfigurableField for this task.

Parameters:

docstr: Help text for the field.

Returns:

configurableFieldlsst.pex.config.ConfigurableField: A ConfigurableField for this task.

Examples

Provides a convenient way to specify this task is a subtask of another task.

Here is an example of use:

class OtherTaskConfig(lsst.pex.config.Config):
    aSubtask = ATaskClass.makeField("brief description of task")

makeSubtask(name: str, **keyArgs: Any) → None¶

Create a subtask as a new instance as the name attribute of this task.

Parameters:

namestr

Brief name of the subtask.

**keyArgs

Extra keyword arguments used to construct the task. The following arguments are automatically provided and cannot be overridden:

config.
parentTask.

Notes

The subtask must be defined by Task.config.name, an instance of ConfigurableField or RegistryField.

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).

timer(name: str, logLevel: int = 10) → Iterator[None]¶

Context manager to log performance data for an arbitrary block of code.

Parameters:

namestr: Name of code being timed; data will be logged using item name: Start and End.
logLevelint: A logging level constant.

Navigation

DrpAssociationPipeTask¶