MatchTractCatalogTask#

class lsst.pipe.tasks.match_tract_catalog.MatchTractCatalogTask(initInputs, **kwargs)#

Bases: PipelineTask

Match sources in a reference tract catalog with those in a target catalog.

Methods Summary

run(catalog_ref, catalog_target[, wcs])

Match sources in a reference tract catalog with a target catalog.

runQuantum(butlerQC, inputRefs, outputRefs)

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

Methods Documentation

run(catalog_ref: DataFrame | Table, catalog_target: DataFrame | Table, wcs: SkyWcs = None) Struct#

Match sources in a reference tract catalog with a target catalog.

Parameters#

catalog_refpandas.DataFrame | astropy.table.Table

A reference catalog to match objects/sources from.

catalog_targetpandas.DataFrame | astropy.table.Table

A target catalog to match reference objects/sources to.

wcslsst.afw.image.SkyWcs

A coordinate system to convert catalog positions to sky coordinates, if necessary.

Returns#

retStructlsst.pipe.base.Struct

A struct with output_ref and output_target attribute containing the output matched catalogs.

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.