lsst.pipe.tasks geee7ff78d7+efe5fb867a
Loading...
Searching...
No Matches
Public Member Functions | Static Public Attributes | List of all members
lsst.pipe.tasks.match_tract_catalog.MatchTractCatalogSubTask Class Reference
Inheritance diagram for lsst.pipe.tasks.match_tract_catalog.MatchTractCatalogSubTask:
lsst.pipe.tasks.match_tract_catalog_probabilistic.MatchTractCatalogProbabilisticTask

Public Member Functions

def __init__ (self, **kwargs)
 
pipeBase.Struct run (self, pd.DataFrame catalog_ref, pd.DataFrame catalog_target, afwGeom.SkyWcs wcs=None)
 

Static Public Attributes

 ConfigClass = MatchTractCatalogSubConfig
 

Detailed Description

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.

Definition at line 99 of file match_tract_catalog.py.

Constructor & Destructor Documentation

◆ __init__()

def lsst.pipe.tasks.match_tract_catalog.MatchTractCatalogSubTask.__init__ (   self,
**  kwargs 
)

Member Function Documentation

◆ run()

pipeBase.Struct lsst.pipe.tasks.match_tract_catalog.MatchTractCatalogSubTask.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.

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

Reimplemented in lsst.pipe.tasks.match_tract_catalog_probabilistic.MatchTractCatalogProbabilisticTask.

Definition at line 115 of file match_tract_catalog.py.

Member Data Documentation

◆ ConfigClass

lsst.pipe.tasks.match_tract_catalog.MatchTractCatalogSubTask.ConfigClass = MatchTractCatalogSubConfig
static

Definition at line 109 of file match_tract_catalog.py.


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