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 catalog_ref, pd.DataFrame 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 171 of file match_tract_catalog.py.

Constructor & Destructor Documentation

__init__()

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

Definition at line 177 of file match_tract_catalog.py.

    def __init__(self, initInputs, **kwargs):
        super().__init__(initInputs=initInputs, **kwargs)
        self.makeSubtask("match_tract_catalog")
 

Member Function Documentation

run()

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

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

Parameters
----------
catalog_ref : `pandas.DataFrame`
    A reference catalog to match objects/sources from.
catalog_target : `pandas.DataFrame`
    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 193 of file match_tract_catalog.py.

    ) -> pipeBase.Struct:
        """Match sources in a reference tract catalog with a target catalog.
 
        Parameters
        ----------
        catalog_ref : `pandas.DataFrame`
            A reference catalog to match objects/sources from.
        catalog_target : `pandas.DataFrame`
            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.
        """
        output = self.match_tract_catalog.run(catalog_ref, catalog_target, wcs=wcs)
        if output.exceptions:
            self.log.warn('Exceptions: %s', output.exceptions)
        retStruct = pipeBase.Struct(cat_output_ref=output.cat_output_ref,
                                    cat_output_target=output.cat_output_target)
        return retStruct

runQuantum()

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

Definition at line 181 of file match_tract_catalog.py.

    def runQuantum(self, butlerQC, inputRefs, outputRefs):
        inputs = butlerQC.get(inputRefs)
        columns_ref, columns_target = self.config.get_columns_in()
        skymap = inputs.pop("skymap")
 
        outputs = self.run(
            catalog_ref=inputs['cat_ref'].get(parameters={'columns': columns_ref}),
            catalog_target=inputs['cat_target'].get(parameters={'columns': columns_target}),
            wcs=skymap[butlerQC.quantum.dataId["tract"]].wcs,
        )
        butlerQC.put(outputs, outputRefs)
 

Member Data Documentation

_DefaultName

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

staticprotected

Definition at line 175 of file match_tract_catalog.py.

ConfigClass

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

static

Definition at line 174 of file match_tract_catalog.py.

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/pipe_tasks/gc07e1c2157+a98bf949bb/python/lsst/pipe/tasks/match_tract_catalog.py