Inheritance diagram for lsst.meas.astrom.ref_match.RefMatchTask:

Public Member Functions
def	__init__ (self, refObjLoader, kwargs)

def	setRefObjLoader (self, refObjLoader)

def	loadAndMatch (self, exposure, sourceCat)

Public Attributes
	refObjLoader

Static Public Attributes
	ConfigClass = RefMatchConfig

Detailed Description

Match an input source catalog with objects from a reference catalog.

Parameters
----------
refObjLoader : `lsst.meas.algorithms.ReferenceLoader`
    A reference object loader object
**kwargs
    additional keyword arguments for pipe_base `lsst.pipe.base.Task`

Definition at line 76 of file ref_match.py.

Constructor & Destructor Documentation

◆ init()

def lsst.meas.astrom.ref_match.RefMatchTask.__init__	(	self,
		refObjLoader,
		kwargs
	)

Definition at line 89 of file ref_match.py.

Member Function Documentation

◆ loadAndMatch()

def lsst.meas.astrom.ref_match.RefMatchTask.loadAndMatch	(	self,
		exposure,
		sourceCat
	)

Load reference objects overlapping an exposure and match to sources
detected on that exposure.

Parameters
----------
exposure : `lsst.afw.image.Exposure`
    exposure that the sources overlap
sourceCat : `lsst.afw.table.SourceCatalog.`
    catalog of sources detected on the exposure

Returns
-------
result : `lsst.pipe.base.Struct`
    Result struct with Components:

    - ``refCat`` : reference object catalog of objects that overlap the
      exposure (`lsst.afw.table.SimpleCatalog`)
    - ``matches`` :  Matched sources and references
      (`list` of `lsst.afw.table.ReferenceMatch`)
    - ``matchMeta`` : metadata needed to unpersist matches
      (`lsst.daf.base.PropertyList`)

Notes
-----
ignores config.matchDistanceSigma

Definition at line 116 of file ref_match.py.

◆ setRefObjLoader()

def lsst.meas.astrom.ref_match.RefMatchTask.setRefObjLoader	(	self,
		refObjLoader
	)

Sets the reference object loader for the task

Parameters
----------
refObjLoader
    An instance of a reference object loader task or class

Definition at line 105 of file ref_match.py.

Member Data Documentation

◆ ConfigClass

lsst.meas.astrom.ref_match.RefMatchTask.ConfigClass = RefMatchConfig

static

Definition at line 86 of file ref_match.py.

◆ refObjLoader

lsst.meas.astrom.ref_match.RefMatchTask.refObjLoader

Definition at line 92 of file ref_match.py.

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

python/lsst/meas/astrom/ref_match.py

Public Member Functions

Public Attributes

Static Public Attributes