lsst.meas.astrom  21.0.0-4-g591bb35+5e1057a006
Public Member Functions | Static Public Attributes | List of all members
lsst.meas.astrom.matchPessimisticB.MatchPessimisticBTask Class Reference
Inheritance diagram for lsst.meas.astrom.matchPessimisticB.MatchPessimisticBTask:

Public Member Functions

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

Static Public Attributes

 ConfigClass = MatchPessimisticBConfig
 

Detailed Description

Match sources to reference objects.

Definition at line 177 of file matchPessimisticB.py.

Constructor & Destructor Documentation

◆ __init__()

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

Definition at line 184 of file matchPessimisticB.py.

Member Function Documentation

◆ matchObjectsToSources()

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

refCat : `lsst.afw.table.SimpleCatalog`
    catalog of reference objects that overlap the exposure; reads
    fields for:

    - coord
    - the specified flux field

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`
    estimated WCS
sourceFluxField: `str`
    field of sourceCat to use for flux
refFluxField : `str`
    field of refCat to use for flux
match_tolerance : `lsst.meas.astrom.MatchTolerancePessimistic`
    is 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
-------
result : `lsst.pipe.base.Struct`
    Result struct with components:

    - ``matches`` : source to reference matches found (`list` of
      `lsst.afw.table.ReferenceMatch`)
    - ``usableSourceCat`` : a catalog of sources potentially usable for
      matching and WCS fitting (`lsst.afw.table.SourceCatalog`).
    - ``match_tolerance`` : a MatchTolerance object containing the
      resulting state variables from the match
      (`lsst.meas.astrom.MatchTolerancePessimistic`).

Definition at line 188 of file matchPessimisticB.py.

Member Data Documentation

◆ ConfigClass

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

Definition at line 181 of file matchPessimisticB.py.


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