lsst.meas.astrom.ref_match.RefMatchTask Class Reference

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

Public Member Functions
	__init__ (self, refObjLoader=None, **kwargs)
	setRefObjLoader (self, refObjLoader)
	loadAndMatch (self, exposure, sourceCat)

Public Attributes
	refObjLoader = refObjLoader

Static Public Attributes
	ConfigClass = RefMatchConfig

Protected Member Functions
	_computeMatchStatsOnSky (self, matchList)

Static Protected Attributes
str	_DefaultName = "calibrationBaseClass"

Detailed Description

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

Parameters
----------
refObjLoader : `lsst.meas.algorithms.ReferenceLoader`
    A reference object loader object; gen3 pipeline tasks will pass `None`
    and call `setRefObjLoader` in `runQuantum`.
**kwargs
    Additional keyword arguments for pipe_base `lsst.pipe.base.Task`.

Definition at line 79 of file ref_match.py.

Constructor & Destructor Documentation

__init__()

lsst.meas.astrom.ref_match.RefMatchTask.__init__	(		self,
			refObjLoader = None,
		**	kwargs )

Definition at line 93 of file ref_match.py.

Member Function Documentation

_computeMatchStatsOnSky()

lsst.meas.astrom.ref_match.RefMatchTask._computeMatchStatsOnSky ( self, matchList )

protected

Compute on-sky radial distance statistics for a match list

Parameters
----------
matchList : `list` of `lsst.afw.table.ReferenceMatch`
    list of matches between reference object and sources;
    the distance field is the only field read and it must be set to distance in radians

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

    - ``distMean`` : clipped mean of on-sky radial separation (`float`)
    - ``distStdDev`` : clipped standard deviation of on-sky radial
      separation (`float`)
    - ``maxMatchDist`` : distMean + self.config.matchDistanceSigma *
      distStdDev (`float`)

Definition at line 210 of file ref_match.py.

loadAndMatch()

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 120 of file ref_match.py.

setRefObjLoader()

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 109 of file ref_match.py.

Member Data Documentation

_DefaultName

str lsst.meas.astrom.ref_match.RefMatchTask._DefaultName = "calibrationBaseClass"

staticprotected

Definition at line 91 of file ref_match.py.

ConfigClass

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

static

Definition at line 90 of file ref_match.py.

refObjLoader

lsst.meas.astrom.ref_match.RefMatchTask.refObjLoader = refObjLoader

Definition at line 96 of file ref_match.py.

---

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

• python/lsst/meas/astrom/ref_match.py