lsst.meas.astrom gfb315b4925+1dc474ab42
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Static Protected Attributes | List of all members
lsst.meas.astrom.ref_match.RefMatchTask Class Reference
Inheritance diagram for lsst.meas.astrom.ref_match.RefMatchTask:
lsst.meas.astrom.astrometry.AstrometryTask

Public Member Functions

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

Public Attributes

 refObjLoader
 

Static Public Attributes

 ConfigClass = RefMatchConfig
 

Protected Member Functions

 _computeMatchStatsOnSky (self, matchList)
 
 _getExposureMetadata (self, exposure)
 

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

Constructor & Destructor Documentation

◆ __init__()

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

Reimplemented in lsst.meas.astrom.astrometry.AstrometryTask.

Definition at line 90 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 206 of file ref_match.py.

◆ _getExposureMetadata()

lsst.meas.astrom.ref_match.RefMatchTask._getExposureMetadata (   self,
  exposure 
)
protected
Extract metadata from an exposure.

Parameters
----------
exposure : `lsst.afw.image.Exposure`

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

    - ``bbox`` : parent bounding box (`lsst.geom.Box2I`)
    - ``wcs`` : exposure WCS (`lsst.afw.geom.SkyWcs`)
    - ``photoCalib`` : photometric calibration (`lsst.afw.image.PhotoCalib`)
    - ``filterName`` : name of filter band (`str`)
    - ``epoch`` : date of exposure (`astropy.time.Time`)

Definition at line 235 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 117 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 106 of file ref_match.py.

Member Data Documentation

◆ _DefaultName

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

Definition at line 88 of file ref_match.py.

◆ ConfigClass

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

Definition at line 87 of file ref_match.py.

◆ refObjLoader

lsst.meas.astrom.ref_match.RefMatchTask.refObjLoader

Definition at line 93 of file ref_match.py.


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