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.

     def __init__(self, **kwargs):
         pipeBase.Task.__init__(self, **kwargs)
  

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.

                               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`).
         """
         import lsstDebug
         debug = lsstDebug.Info(__name__)
  
         # If we get an empty tolerance struct create the variables we need for
         # this matcher.
         if match_tolerance is None:
             match_tolerance = MatchTolerancePessimistic()
  
         # Make a name alias here for consistency with older code, and to make
         # it clear that this is a good/usable (cleaned) source catalog.
         goodSourceCat = sourceCat
  
         numUsableSources = len(goodSourceCat)
  
         if len(goodSourceCat) == 0:
             raise pipeBase.TaskError("No sources are good")
  
         minMatchedPairs = min(self.config.minMatchedPairs,
                               int(self.config.minFracMatchedPairs
                                   * min([len(refCat), len(goodSourceCat)])))
  
         if len(refCat) > self.config.maxRefObjects:
             self.log.warn(
                 "WARNING: Reference catalog larger that maximum allowed. "
                 "Trimming to %i" % self.config.maxRefObjects)
             trimmedRefCat = self._filterRefCat(refCat, refFluxField)
         else:
             trimmedRefCat = refCat
  
         doMatchReturn = self._doMatch(
             refCat=trimmedRefCat,
             sourceCat=goodSourceCat,
             wcs=wcs,
             refFluxField=refFluxField,
             numUsableSources=numUsableSources,
             minMatchedPairs=minMatchedPairs,
             match_tolerance=match_tolerance,
             sourceFluxField=sourceFluxField,
             verbose=debug.verbose,
         )
         matches = doMatchReturn.matches
         match_tolerance = doMatchReturn.match_tolerance
  
         if len(matches) == 0:
             raise RuntimeError("Unable to match sources")
  
         self.log.info("Matched %d sources" % len(matches))
         if len(matches) < minMatchedPairs:
             self.log.warn("Number of matches is smaller than request")
  
         return pipeBase.Struct(
             matches=matches,
             usableSourceCat=goodSourceCat,
             match_tolerance=match_tolerance,
         )
  

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:

/j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/meas_astrom/22.0.1-4-g8623105+b8044ec9de/python/lsst/meas/astrom/matchPessimisticB.py

Public Member Functions

Static Public Attributes