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

Protected Member Functions
	_add_tract_column_to_catalogs (self, catalog_ref, catalog_target, skymap, bool add_patch=True)

Static Protected Attributes
str	_DefaultName = "MatchTractCatalog"
dict	_astropy_u_to_lsst_geom

Detailed Description

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

Definition at line 305 of file match_tract_catalog.py.

Constructor & Destructor Documentation

◆ init()

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

Definition at line 311 of file match_tract_catalog.py.

Member Function Documentation

◆ _add_tract_column_to_catalogs()

lsst.pipe.tasks.match_tract_catalog.MatchTractCatalogTask._add_tract_column_to_catalogs	(		self,
			catalog_ref,
			catalog_target,
			skymap,
		bool	add_patch = True )

protected

Add a tract column to catalogs that may be missing it.

Parameters
----------
catalog_ref
    A reference catalog.
catalog_target
    A target catalog.
skymap
    The skymap info to use.
add_patch
    Whether to add a patch column as well.

Definition at line 493 of file match_tract_catalog.py.

◆ 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. If self.config.output_matched_catalog is
    True, cat_output_matched is also returned, along with the names of
    the tract/patch columns, which may have been changed to avoid
    collisions.

Definition at line 419 of file match_tract_catalog.py.

◆ runQuantum()

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

Definition at line 322 of file match_tract_catalog.py.

Member Data Documentation

◆ _astropy_u_to_lsst_geom

dict lsst.pipe.tasks.match_tract_catalog.MatchTractCatalogTask._astropy_u_to_lsst_geom

staticprotected

Initial value:

=  {
        "arcmin": "arcminutes",
        "deg": "degrees",
        "rad": "radians",
    }

Definition at line 316 of file match_tract_catalog.py.

◆ _DefaultName

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

staticprotected

Definition at line 309 of file match_tract_catalog.py.

◆ ConfigClass

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

static

Definition at line 308 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

Public Member Functions

Static Public Attributes

Protected Member Functions

Static Protected Attributes