CatalogMatchTask

class lsst.analysis.tools.tasks.CatalogMatchTask(*, config: PipelineTaskConfig | None = None, log: logging.Logger | LsstLogAdapter | None = None, initInputs: dict[str, Any] | None = None, **kwargs: Any)

Bases: PipelineTask

The base task for matching catalogs. Figures out which columns it needs to grab for the downstream tasks and then matches the two tables together and returns the matched and joined table including the extra columns.

Methods Summary

prepColumns(bands)	Get all the columns needed for downstream tasks.
run(*, targetCatalog, refCatalog, bands)	Takes the two catalogs and returns the matched one.
runQuantum(butlerQC, inputRefs, outputRefs)	Implemented in the inherited tasks

Methods Documentation

prepColumns(bands)

Get all the columns needed for downstream tasks. Both those from the selectors and those specified in the config options.

run(*, targetCatalog, refCatalog, bands)

Takes the two catalogs and returns the matched one.

Parameters

targetCatalogastropy.table.Table

The catalog to be matched

refCatalogastropy.table.Table

The catalog to be matched to

bandslist

A list of bands to apply the selectors in

Returns

matchedCatalog : astropy.table.Table

Notes

Performs an RA/Dec match that returns the closest match within the match radius which defaults to 1.0 arcsecond. Applies the suffix, _target, to the catalog being matched and _ref to the reference catalog being matched to.

runQuantum(butlerQC, inputRefs, outputRefs)

Implemented in the inherited tasks