lsst.meas.astrom  14.0-7-g0d69b06+3
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
lsst.meas.astrom.directMatch.DirectMatchTask Class Reference

Simple matching of a source catalog to a reference catalog. More...

Inheritance diagram for lsst.meas.astrom.directMatch.DirectMatchTask:

Public Member Functions

def __init__ (self, butler=None, refObjLoader=None, kwargs)
 Ctor. More...
 
def run (self, catalog, filterName=None)
 Load reference objects and match to them. More...
 
def calculateCircle (self, catalog)
 Calculate a circle enclosing the catalog. More...
 

Public Attributes

 refObjLoader
 

Static Public Attributes

 ConfigClass = DirectMatchConfig
 

Detailed Description

Simple matching of a source catalog to a reference catalog.

Contents

Description

Match sources to reference objects. The matching permits no rotation or scaling, but uses the existing sky positions in the source catalog. This is often useful for QA, as it allows validating the pipeline astrometry and photometry against the reference catalog.

Note that this DirectMatchTask is not currently suitable for use within the AstrometryTask, as it has a different interface and serves a different purpose.

Task initialisation

Ctor. Either a 'butler' or 'refObjLoader' is required.

Parameters
butlerData butler, or None
refObjLoaderFor loading reference objects (lsst.meas.algorithms.LoadReferenceObjectsTask), or None
kwargsOther keyword arguments required for instantiating a Task (e.g., 'config')

Invoking the Task

Load reference objects and match to them.

Parameters
[in]catalogCatalog to match to (lsst.afw.table.SourceCatalog)
[in]filterNameName of filter, for loading fluxes (str)
Returns
Struct with matches (lsst.afw.table.SourceMatchVector) and matchMeta (lsst.meas.astrom.MatchMetadata)

Configuration parameters

See DirectMatchConfig

A complete example of using DirectMatchTask

config = DirectMatchConfig() task = DirectMatchTask(butler=butler, config=config) matchResults = task.run(catalog)

Definition at line 29 of file directMatch.py.

Constructor & Destructor Documentation

◆ __init__()

def lsst.meas.astrom.directMatch.DirectMatchTask.__init__ (   self,
  butler = None,
  refObjLoader = None,
  kwargs 
)

Ctor.

Either a 'butler' or 'refObjLoader' is required.

Parameters
butlerData butler, or None
refObjLoaderFor loading reference objects (lsst.meas.algorithms.LoadReferenceObjectsTask), or None
kwargsOther keyword arguments required for instantiating a Task (e.g., 'config')

Definition at line 75 of file directMatch.py.

Member Function Documentation

◆ calculateCircle()

def lsst.meas.astrom.directMatch.DirectMatchTask.calculateCircle (   self,
  catalog 
)

Calculate a circle enclosing the catalog.

Parameters
[in]catalogCatalog we will encircle (lsst.afw.table.SourceCatalog)
Returns
Struct with center (lsst.afw.coord.Coord) and radius (lsst.afw.geom.Angle)

Definition at line 125 of file directMatch.py.

◆ run()

def lsst.meas.astrom.directMatch.DirectMatchTask.run (   self,
  catalog,
  filterName = None 
)

Load reference objects and match to them.

Parameters
[in]catalogCatalog to match to (lsst.afw.table.SourceCatalog)
[in]filterNameName of filter, for loading fluxes (str)
Returns
Struct with matches (lsst.afw.table.SourceMatchVector) and matchMeta (lsst.meas.astrom.MatchMetadata)

Definition at line 96 of file directMatch.py.

Member Data Documentation

◆ ConfigClass

lsst.meas.astrom.directMatch.DirectMatchTask.ConfigClass = DirectMatchConfig
static

Definition at line 72 of file directMatch.py.

◆ refObjLoader

lsst.meas.astrom.directMatch.DirectMatchTask.refObjLoader

Definition at line 92 of file directMatch.py.


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