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

Match sources to reference objects. More...

Inheritance diagram for lsst.meas.astrom.matchPessimisticB.MatchPessimisticBTask:

Public Member Functions

def __init__ (self, kwargs)
 
def matchObjectsToSources (self, refCat, sourceCat, wcs, refFluxField, match_tolerance=None)
 Match sources to position reference stars. More...
 

Static Public Attributes

 ConfigClass = MatchPessimisticBConfig
 

Detailed Description

Match sources to reference objects.

Contents

Description

Match sources to reference objects. This is often done as a preliminary step to fitting an astrometric or photometric solution. For details about the matching algorithm see pessimistic_pattern_matcher_b_3D.py

Task initialization

Invoking the Task

Match sources to position reference stars.

Parameters
[in]refCatcatalog of reference objects that overlap the exposure; reads fields for:
  • coord
  • the specified flux field
[in]sourceCatcatalog of sources found on an exposure; Please check the required fields of your specified source selector that the correct flags are present.
[in]wcsestimated WCS
[in]refFluxFieldfield of refCat to use for flux
[in]match_toleranceis a MatchTolerance class object or None. This this class is used to communicate state between AstrometryTask and MatcherTask. AstrometryTask will also set the MatchTolerance class variable maxMatchDist based on the scatter AstrometryTask has found after fitting for the wcs.
Returns
an lsst.pipe.base.Struct with fields:
  • matches a list of matches, each instance of lsst.afw.table.ReferenceMatch
  • usableSourcCat a catalog of sources potentially usable for matching.
  • match_tolerance a MatchTolerance object containing the resulting state variables from the match.

Configuration

parameters

See MatchPessimisticBConfig

To modify the tests for good sources for matching, create a new sourceSelector class in meas_algorithms and use it in the config.

A complete example of

using MatchPessimisticBTask

MatchPessimisticBTask is a subtask of AstrometryTask, which is called by PhotoCalTask. See meas_photocal_photocal_Example.

Debug variables

The command line task interface supports a flag -d to import debug.py from your PYTHONPATH; see Using lsstDebug to control debugging output for more about debug.py files.

The available variables in MatchPessimisticBTask are:

verbose (bool)
If True then the matcher prints debug messages to stdout

To investigate the Debug variables, put something like

import lsstDebug
def DebugInfo(name):
# N.b. lsstDebug.Info(name) would call us recursively
debug = lsstDebug.getInfo(name)
if name == "lsst.pipe.tasks.astrometry":
debug.verbose = True
return debug
lsstDebug.Info = DebugInfo

into your debug.py file and run this task with the –debug flag.

Definition at line 176 of file matchPessimisticB.py.

Constructor & Destructor Documentation

◆ __init__()

def lsst.meas.astrom.matchPessimisticB.MatchPessimisticBTask.__init__ (   self,
  kwargs 
)

Definition at line 250 of file matchPessimisticB.py.

Member Function Documentation

◆ matchObjectsToSources()

def lsst.meas.astrom.matchPessimisticB.MatchPessimisticBTask.matchObjectsToSources (   self,
  refCat,
  sourceCat,
  wcs,
  refFluxField,
  match_tolerance = None 
)

Match sources to position reference stars.

Parameters
[in]refCatcatalog of reference objects that overlap the exposure; reads fields for:
  • coord
  • the specified flux field
[in]sourceCatcatalog of sources found on an exposure; Please check the required fields of your specified source selector that the correct flags are present.
[in]wcsestimated WCS
[in]refFluxFieldfield of refCat to use for flux
[in]match_toleranceis a MatchTolerance class object or None. This this class is used to communicate state between AstrometryTask and MatcherTask. AstrometryTask will also set the MatchTolerance class variable maxMatchDist based on the scatter AstrometryTask has found after fitting for the wcs.
Returns
an lsst.pipe.base.Struct with fields:
  • matches a list of matches, each instance of lsst.afw.table.ReferenceMatch
  • usableSourcCat a catalog of sources potentially usable for matching.
  • match_tolerance a MatchTolerance object containing the resulting state variables from the match.

Definition at line 256 of file matchPessimisticB.py.

Member Data Documentation

◆ ConfigClass

lsst.meas.astrom.matchPessimisticB.MatchPessimisticBTask.ConfigClass = MatchPessimisticBConfig
static

Definition at line 247 of file matchPessimisticB.py.


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