lsst.meas.astrom gf1cff7945b+cac3717750
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.matchOptimisticBTask.MatchOptimisticBTask Class Reference
Inheritance diagram for lsst.meas.astrom.matchOptimisticBTask.MatchOptimisticBTask:

Public Member Functions

 __init__ (self, **kwargs)
 
 filterStars (self, refCat)
 
 matchObjectsToSources (self, refCat, sourceCat, wcs, sourceFluxField, refFluxField, match_tolerance=None)
 

Public Attributes

 edgeKey
 
 interpolatedCenterKey
 
 saturatedKey
 

Static Public Attributes

 ConfigClass = MatchOptimisticBConfig
 

Protected Member Functions

 _getIsGoodKeys (self, schema)
 
 _isGoodTest (self, source)
 
 _doMatch (self, refCat, sourceCat, wcs, refFluxField, numUsableSources, minMatchedPairs, maxMatchDist, sourceFluxField, verbose)
 

Static Protected Attributes

str _DefaultName = "matchObjectsToSources"
 

Detailed Description

Match sources to reference objects using the Optimistic Pattern Matcher
B algorithm of Tabur 2007.

Definition at line 124 of file matchOptimisticBTask.py.

Constructor & Destructor Documentation

◆ __init__()

lsst.meas.astrom.matchOptimisticBTask.MatchOptimisticBTask.__init__ (   self,
**  kwargs 
)

Definition at line 131 of file matchOptimisticBTask.py.

Member Function Documentation

◆ _doMatch()

lsst.meas.astrom.matchOptimisticBTask.MatchOptimisticBTask._doMatch (   self,
  refCat,
  sourceCat,
  wcs,
  refFluxField,
  numUsableSources,
  minMatchedPairs,
  maxMatchDist,
  sourceFluxField,
  verbose 
)
protected
Implementation of matching sources to position reference stars.

Unlike matchObjectsToSources, this method does not check if the sources
are suitable.

Parameters
----------
refCat : `lsst.afw.table.SimpleCatalog`
    Catalog of reference objects.
sourceCat : `lsst.afw.table.SourceCatalog`
    Catalog of detected sources.
wcs : `lsst.afw.geom.SkyWcs`
    Current best WCS of the image.
refFluxFioeld : `str`
    Name of flux field in refCat to use.
numUsableSources : `int`
    Total number of source usable for matching.
mintMatchPairs : `int`
    Minimum number of objects to match between the refCat and sourceCat
    to consider a valid match.
maxMatchDist : `lsst.geom.Angle`
    Maximum separation to considering a reference and a source a match.
sourceFluxField : `str`
    Name of source catalog flux field.
verbose : `bool`
    Print diagnostic information std::cout

Returns
-------
matches : `list` of `lsst.afw.table.ReferenceMatch`

Definition at line 282 of file matchOptimisticBTask.py.

◆ _getIsGoodKeys()

lsst.meas.astrom.matchOptimisticBTask.MatchOptimisticBTask._getIsGoodKeys (   self,
  schema 
)
protected
Retrieve the keys needed for the isGoodTest from the source catalog
schema.

Parameters
----------
schema : `lsst.afw.table.Schema`
    Source schema to retrieve `lsst.afw.table.Key` s from.

Definition at line 248 of file matchOptimisticBTask.py.

◆ _isGoodTest()

lsst.meas.astrom.matchOptimisticBTask.MatchOptimisticBTask._isGoodTest (   self,
  source 
)
protected
Test that an object is good for use in the WCS fitter.

This is a hard coded version of the isGood flag from the old SourceInfo
class that used to be part of this class.

Parameters
----------
source : `lsst.afw.table.SourceRecord`
    Source to test.

Returns
-------
isGood : `bool`
    Source passes CCD edge and saturated tests.

Definition at line 261 of file matchOptimisticBTask.py.

◆ filterStars()

lsst.meas.astrom.matchOptimisticBTask.MatchOptimisticBTask.filterStars (   self,
  refCat 
)
Extra filtering pass; subclass if desired.

Parameters
----------
refCat : `lsst.afw.table.SimpleCatalog`
    Catalog of reference objects.

Returns
-------
trimmedRefCat : `lsst.afw.table.SimpleCatalog`
    Reference catalog with some filtering applied. Currently no
    filtering is applied.

Definition at line 134 of file matchOptimisticBTask.py.

◆ matchObjectsToSources()

lsst.meas.astrom.matchOptimisticBTask.MatchOptimisticBTask.matchObjectsToSources (   self,
  refCat,
  sourceCat,
  wcs,
  sourceFluxField,
  refFluxField,
  match_tolerance = None 
)
Match sources to position reference stars.

Parameters
----------
refCat : `lsst.afw.table.SimpleCatalog`
    Reference catalog to match.
sourceCat : `lsst.afw.table.SourceCatalog`
    Catalog of sources found on an exposure.  This should already be
    down-selected to "good"/"usable" sources in the calling Task.
wcs : `lsst.afw.geom.SkyWcs`
    Current WCS of the  exposure containing the sources.
sourceFluxField : `str`
    Field of the sourceCat to use for flux
refFluxField : `str`
    Field of the refCat to use for flux
match_tolerance : `lsst.meas.astrom.MatchTolerance`
    Object containing information from previous
    `lsst.meas.astrom.AstrometryTask` match/fit cycles for use in
    matching. If `None` is config defaults.

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

    - ``matches`` : List of matches with distance below the maximum match
      distance (`list` of `lsst.afw.table.ReferenceMatch`).
    - ``useableSourceCat`` : Catalog of sources matched and suited for
      WCS fitting (`lsst.afw.table.SourceCatalog`).
    - ``match_tolerance`` : MatchTolerance object updated from this
      match iteration (`lsst.meas.astrom.MatchTolerance`).

Definition at line 151 of file matchOptimisticBTask.py.

Member Data Documentation

◆ _DefaultName

str lsst.meas.astrom.matchOptimisticBTask.MatchOptimisticBTask._DefaultName = "matchObjectsToSources"
staticprotected

Definition at line 129 of file matchOptimisticBTask.py.

◆ ConfigClass

lsst.meas.astrom.matchOptimisticBTask.MatchOptimisticBTask.ConfigClass = MatchOptimisticBConfig
static

Definition at line 128 of file matchOptimisticBTask.py.

◆ edgeKey

lsst.meas.astrom.matchOptimisticBTask.MatchOptimisticBTask.edgeKey

Definition at line 257 of file matchOptimisticBTask.py.

◆ interpolatedCenterKey

lsst.meas.astrom.matchOptimisticBTask.MatchOptimisticBTask.interpolatedCenterKey

Definition at line 258 of file matchOptimisticBTask.py.

◆ saturatedKey

lsst.meas.astrom.matchOptimisticBTask.MatchOptimisticBTask.saturatedKey

Definition at line 259 of file matchOptimisticBTask.py.


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