lsst.pipe.tasks g2e17d592ec+c990792287
Loading...
Searching...
No Matches
Public Member Functions | Static Public Attributes | Static Protected Attributes | List of all members
lsst.pipe.tasks.diff_matched_tract_catalog.DiffMatchedTractCatalogTask Class Reference
Inheritance diagram for lsst.pipe.tasks.diff_matched_tract_catalog.DiffMatchedTractCatalogTask:

Public Member Functions

 runQuantum (self, butlerQC, inputRefs, outputRefs)
 
pipeBase.Struct run (self, pd.DataFrame catalog_ref, pd.DataFrame catalog_target, pd.DataFrame catalog_match_ref, pd.DataFrame catalog_match_target, afwGeom.SkyWcs wcs=None)
 

Static Public Attributes

 ConfigClass = DiffMatchedTractCatalogConfig
 

Static Protected Attributes

str _DefaultName = "DiffMatchedTractCatalog"
 

Detailed Description

Load subsets of matched catalogs and output a merged catalog of matched sources.

Definition at line 557 of file diff_matched_tract_catalog.py.

Member Function Documentation

◆ run()

pipeBase.Struct lsst.pipe.tasks.diff_matched_tract_catalog.DiffMatchedTractCatalogTask.run ( self,
pd.DataFrame catalog_ref,
pd.DataFrame catalog_target,
pd.DataFrame catalog_match_ref,
pd.DataFrame catalog_match_target,
afwGeom.SkyWcs wcs = None )
Load matched reference and target (measured) catalogs, measure summary statistics, and output
a combined matched catalog with columns from both inputs.

Parameters
----------
catalog_ref : `pandas.DataFrame`
    A reference catalog to diff objects/sources from.
catalog_target : `pandas.DataFrame`
    A target catalog to diff reference objects/sources to.
catalog_match_ref : `pandas.DataFrame`
    A catalog with match indices of target sources and selection flags
    for each reference source.
catalog_match_target : `pandas.DataFrame`
    A catalog with selection flags for each target source.
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 584 of file diff_matched_tract_catalog.py.

◆ runQuantum()

lsst.pipe.tasks.diff_matched_tract_catalog.DiffMatchedTractCatalogTask.runQuantum ( self,
butlerQC,
inputRefs,
outputRefs )

Definition at line 563 of file diff_matched_tract_catalog.py.

Member Data Documentation

◆ _DefaultName

str lsst.pipe.tasks.diff_matched_tract_catalog.DiffMatchedTractCatalogTask._DefaultName = "DiffMatchedTractCatalog"
staticprotected

Definition at line 561 of file diff_matched_tract_catalog.py.

◆ ConfigClass

lsst.pipe.tasks.diff_matched_tract_catalog.DiffMatchedTractCatalogTask.ConfigClass = DiffMatchedTractCatalogConfig
static

Definition at line 560 of file diff_matched_tract_catalog.py.


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