lsst.meas.astrom.matchPessimisticB.MatchPessimisticBConfig Class Reference

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

Public Member Functions
def	validate (self)

Static Public Attributes
	numBrightStars
	minMatchedPairs
	minFracMatchedPairs
	matcherIterations
	maxOffsetPix
	maxRotationDeg
	numPointsForShape
	numPointsForShapeAttempt
	minMatchDistPixels
	numPatternConsensus
	numRefRequireConsensus
	maxRefObjects

Detailed Description

Configuration for MatchPessimisticBTask

Definition at line 61 of file matchPessimisticB.py.

Member Function Documentation

validate()

def lsst.meas.astrom.matchPessimisticB.MatchPessimisticBConfig.validate

(

self

)

Definition at line 159 of file matchPessimisticB.py.

    def validate(self):
        pexConfig.Config.validate(self)
        if self.numPointsForShapeAttempt < self.numPointsForShape:
            raise ValueError("numPointsForShapeAttempt must be greater than "
                             "or equal to numPointsForShape.")
        if self.numPointsForShape > self.numBrightStars:
            raise ValueError("numBrightStars must be greater than "
                             "numPointsForShape.")
 
 
# The following block adds links to this task from the Task Documentation page.
# \addtogroup LSST_task_documentation
# \{
# \page measAstrom_MatchPessimisticBTask
# \ref MatchPessimisticBTask "MatchPessimisticBTask"
# Match sources to reference objects
# \}
 
 

Member Data Documentation

matcherIterations

lsst.meas.astrom.matchPessimisticB.MatchPessimisticBConfig.matcherIterations

static

Initial value:

=  pexConfig.RangeField(
        doc="Number of softening iterations in matcher.",
        dtype=int,
        default=5,
        min=1,
    )

Definition at line 87 of file matchPessimisticB.py.

maxOffsetPix

lsst.meas.astrom.matchPessimisticB.MatchPessimisticBConfig.maxOffsetPix

static

Initial value:

=  pexConfig.RangeField(
        doc="Maximum allowed shift of WCS, due to matching (pixel). "
            "When changing this value, the "
            "LoadReferenceObjectsConfig.pixelMargin should also be updated.",
        dtype=int,
        default=250,
        max=4000,
    )

Definition at line 93 of file matchPessimisticB.py.

maxRefObjects

lsst.meas.astrom.matchPessimisticB.MatchPessimisticBConfig.maxRefObjects

static

Initial value:

=  pexConfig.RangeField(
        doc="Maximum number of reference objects to use for the matcher. The "
            "absolute maximum allowed for is 2 ** 16 for memory reasons.",
        dtype=int,
        default=2**16,
        min=0,
        max=2**16 + 1,
    )

Definition at line 150 of file matchPessimisticB.py.

maxRotationDeg

lsst.meas.astrom.matchPessimisticB.MatchPessimisticBConfig.maxRotationDeg

static

Initial value:

=  pexConfig.RangeField(
        doc="Rotation angle allowed between sources and position reference "
            "objects (degrees).",
        dtype=float,
        default=1.0,
        max=6.0,
    )

Definition at line 101 of file matchPessimisticB.py.

minFracMatchedPairs

lsst.meas.astrom.matchPessimisticB.MatchPessimisticBConfig.minFracMatchedPairs

static

Initial value:

=  pexConfig.RangeField(
        doc="Minimum number of matched pairs as a fraction of the smaller of "
            "the number of reference stars or the number of good sources; "
            "the actual minimum is the smaller of this value or "
            "minMatchedPairs.",
        dtype=float,
        default=0.3,
        min=0,
        max=1,
    )

Definition at line 77 of file matchPessimisticB.py.

minMatchDistPixels

lsst.meas.astrom.matchPessimisticB.MatchPessimisticBConfig.minMatchDistPixels

static

Initial value:

=  pexConfig.RangeField(
        doc="Distance in units of pixels to always consider a source-"
            "reference pair a match. This prevents the astrometric fitter "
            "from over-fitting and removing stars that should be matched and "
            "allows for inclusion of new matches as the wcs improves.",
        dtype=float,
        default=1.0,
        min=0.0,
        max=6.0,
    )

Definition at line 121 of file matchPessimisticB.py.

minMatchedPairs

lsst.meas.astrom.matchPessimisticB.MatchPessimisticBConfig.minMatchedPairs

static

Initial value:

=  pexConfig.RangeField(
        doc="Minimum number of matched pairs; see also minFracMatchedPairs.",
        dtype=int,
        default=30,
        min=2,
    )

Definition at line 71 of file matchPessimisticB.py.

numBrightStars

lsst.meas.astrom.matchPessimisticB.MatchPessimisticBConfig.numBrightStars

static

Initial value:

=  pexConfig.RangeField(
        doc="Number of bright stars to use. Sets the max number of patterns "
            "that can be tested.",
        dtype=int,
        default=200,
        min=2,
    )

Definition at line 64 of file matchPessimisticB.py.

numPatternConsensus

lsst.meas.astrom.matchPessimisticB.MatchPessimisticBConfig.numPatternConsensus

static

Initial value:

=  pexConfig.Field(
        doc="Number of implied shift/rotations from patterns that must agree "
            "before it a given shift/rotation is accepted. This is only used "
            "after the first softening iteration fails and if both the "
            "number of reference and source objects is greater than "
            "numBrightStars.",
        dtype=int,
        default=3,
    )

Definition at line 131 of file matchPessimisticB.py.

numPointsForShape

lsst.meas.astrom.matchPessimisticB.MatchPessimisticBConfig.numPointsForShape

static

Initial value:

=  pexConfig.Field(
        doc="Number of points to define a shape for matching.",
        dtype=int,
        default=6,
    )

Definition at line 108 of file matchPessimisticB.py.

numPointsForShapeAttempt

lsst.meas.astrom.matchPessimisticB.MatchPessimisticBConfig.numPointsForShapeAttempt

static

Initial value:

=  pexConfig.Field(
        doc="Number of points to try for creating a shape. This value should "
            "be greater than or equal to numPointsForShape. Besides "
            "loosening the signal to noise cut in the 'matcher' SourceSelector, "
            "increasing this number will solve CCDs where no match was found.",
        dtype=int,
        default=6,
    )

Definition at line 113 of file matchPessimisticB.py.

numRefRequireConsensus

lsst.meas.astrom.matchPessimisticB.MatchPessimisticBConfig.numRefRequireConsensus

static

Initial value:

=  pexConfig.Field(
        doc="If the available reference objects exceeds this number, "
            "consensus/pessimistic mode will enforced regardless of the "
            "number of available sources. Below this optimistic mode ("
            "exit at first match rather than requiring numPatternConsensus to "
            "be matched) can be used. If more sources are required to match, "
            "decrease the signal to noise cut in the sourceSelector.",
        dtype=int,
        default=1000,
    )

Definition at line 140 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-12-g44dc1dc+2a20fdde0d/python/lsst/meas/astrom/matchPessimisticB.py