lsst.pipe.tasks.match_tract_catalog.MatchTractCatalogTask Class Reference

Inheritance diagram for lsst.pipe.tasks.match_tract_catalog.MatchTractCatalogTask:

Public Member Functions
	__init__ (self, initInputs, **kwargs)
	runQuantum (self, butlerQC, inputRefs, outputRefs)
pipeBase.Struct	run (self, pd.DataFrame|astropy.table.Table catalog_ref, pd.DataFrame|astropy.table.Table catalog_target, afwGeom.SkyWcs wcs=None)

Static Public Attributes
	ConfigClass = MatchTractCatalogConfig

Static Protected Attributes
str	_DefaultName = "MatchTractCatalog"

Detailed Description

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

Definition at line 208 of file match_tract_catalog.py.

Constructor & Destructor Documentation

__init__()

lsst.pipe.tasks.match_tract_catalog.MatchTractCatalogTask.__init__	(		self,
			initInputs,
		**	kwargs )

Definition at line 214 of file match_tract_catalog.py.

Member Function Documentation

run()

pipeBase.Struct lsst.pipe.tasks.match_tract_catalog.MatchTractCatalogTask.run	(		self,
		pd.DataFrame | astropy.table.Table	catalog_ref,
		pd.DataFrame | astropy.table.Table	catalog_target,
		afwGeom.SkyWcs	wcs = None )

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

Parameters
----------
catalog_ref : `pandas.DataFrame` | `astropy.table.Table`
    A reference catalog to match objects/sources from.
catalog_target : `pandas.DataFrame` | `astropy.table.Table`
    A target catalog to match reference objects/sources to.
wcs : `lsst.afw.image.SkyWcs`
    A coordinate system to convert catalog positions to sky coordinates,
    if necessary.

Returns
-------
retStruct : `lsst.pipe.base.Struct`
    A struct with output_ref and output_target attribute containing the
    output matched catalogs.

Definition at line 230 of file match_tract_catalog.py.

runQuantum()

lsst.pipe.tasks.match_tract_catalog.MatchTractCatalogTask.runQuantum	(		self,
			butlerQC,
			inputRefs,
			outputRefs )

Definition at line 218 of file match_tract_catalog.py.

Member Data Documentation

_DefaultName

str lsst.pipe.tasks.match_tract_catalog.MatchTractCatalogTask._DefaultName = "MatchTractCatalog"

staticprotected

Definition at line 212 of file match_tract_catalog.py.

ConfigClass

lsst.pipe.tasks.match_tract_catalog.MatchTractCatalogTask.ConfigClass = MatchTractCatalogConfig

static

Definition at line 211 of file match_tract_catalog.py.

---

The documentation for this class was generated from the following file:

• python/lsst/pipe/tasks/match_tract_catalog.py