MatchTractCatalogProbabilisticTask

class lsst.pipe.tasks.match_tract_catalog_probabilistic.MatchTractCatalogProbabilisticTask(**kwargs)

Bases: MatchProbabilisticTask, MatchTractCatalogSubTask

An abstract interface for subtasks of MatchTractCatalogTask to match two tract object catalogs.

Parameters

**kwargs

Additional arguments to be passed to the lsst.pipe.base.Task constructor.

Methods Summary

run(catalog_ref, catalog_target[, wcs])

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

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. Only needed if config.coords_ref_to_convert is used to convert reference catalog sky coordinates to pixel positions.

Returns

retStructlsst.pipe.base.Struct

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