lsst.meas.algorithms.measureApCorr.MeasureApCorrConfig Class Reference

Inheritance diagram for lsst.meas.algorithms.measureApCorr.MeasureApCorrConfig:

Public Member Functions
	setDefaults (self)
	validate (self)

Static Public Attributes
	refFluxName
	sourceSelector
	minDegreesOfFreedom
	fitConfig
	numIter
	numSigmaClip
	allowFailure

Detailed Description

Configuration for MeasureApCorrTask.

Definition at line 109 of file measureApCorr.py.

Member Function Documentation

setDefaults()

lsst.meas.algorithms.measureApCorr.MeasureApCorrConfig.setDefaults

(

self

)

Subclass hook for computing defaults.

Notes
-----
Derived `~lsst.pex.config.Config` classes that must compute defaults
rather than using the `~lsst.pex.config.Field` instances's defaults
should do so here. To correctly use inherited defaults,
implementations of ``setDefaults`` must call their base class's
``setDefaults``.

Reimplemented from lsst.pex.config.config.Config.

Definition at line 149 of file measureApCorr.py.

    def setDefaults(self):
        selector = self.sourceSelector["science"]
 
        selector.doFlags = True
        selector.doUnresolved = True
        selector.doSignalToNoise = True
        selector.doIsolated = False
        selector.flags.good = []
        selector.flags.bad = [
            "base_PixelFlags_flag_edge",
            "base_PixelFlags_flag_interpolatedCenter",
            "base_PixelFlags_flag_saturatedCenter",
            "base_PixelFlags_flag_crCenter",
            "base_PixelFlags_flag_bad",
            "base_PixelFlags_flag_interpolated",
            "base_PixelFlags_flag_saturated",
        ]
        selector.signalToNoise.minimum = 200.0
        selector.signalToNoise.maximum = None
        selector.signalToNoise.fluxField = "base_PsfFlux_instFlux"
        selector.signalToNoise.errField = "base_PsfFlux_instFluxErr"
 

validate()

lsst.meas.algorithms.measureApCorr.MeasureApCorrConfig.validate

(

self

)

Validate the Config, raising an exception if invalid.

Raises
------
lsst.pex.config.FieldValidationError
    Raised if verification fails.

Notes
-----
The base class implementation performs type checks on all fields by
calling their `~lsst.pex.config.Field.validate` methods.

Complex single-field validation can be defined by deriving new Field
types. For convenience, some derived `lsst.pex.config.Field`-types
(`~lsst.pex.config.ConfigField` and
`~lsst.pex.config.ConfigChoiceField`) are defined in
``lsst.pex.config`` that handle recursing into subconfigs.

Inter-field relationships should only be checked in derived
`~lsst.pex.config.Config` classes after calling this method, and base
validation is complete.

Reimplemented from lsst.pex.config.config.Config.

Definition at line 171 of file measureApCorr.py.

    def validate(self):
        lsst.pex.config.Config.validate(self)
        if self.sourceSelector.target.usesMatches:
            raise lsst.pex.config.FieldValidationError(
                MeasureApCorrConfig.sourceSelector,
                self,
                "Star selectors that require matches are not permitted.")
 
 

Member Data Documentation

allowFailure

lsst.meas.algorithms.measureApCorr.MeasureApCorrConfig.allowFailure

static

Initial value:

=  lsst.pex.config.ListField(
        doc="Allow these measurement algorithms to fail without an exception.",
        dtype=str,
        default=[],
    )

Definition at line 143 of file measureApCorr.py.

fitConfig

lsst.meas.algorithms.measureApCorr.MeasureApCorrConfig.fitConfig

static

Initial value:

=  lsst.pex.config.ConfigField(
        doc="Configuration used in fitting the aperture correction fields.",
        dtype=ChebyshevBoundedFieldConfig,
    )

Definition at line 129 of file measureApCorr.py.

minDegreesOfFreedom

lsst.meas.algorithms.measureApCorr.MeasureApCorrConfig.minDegreesOfFreedom

static

Initial value:

=  lsst.pex.config.RangeField(
        doc="Minimum number of degrees of freedom (# of valid data points - # of parameters);"
        " if this is exceeded, the order of the fit is decreased (in both dimensions), and"
        " if we can't decrease it enough, we'll raise ValueError.",
        dtype=int,
        default=1,
        min=1,
    )

Definition at line 121 of file measureApCorr.py.

numIter

lsst.meas.algorithms.measureApCorr.MeasureApCorrConfig.numIter

static

Initial value:

=  lsst.pex.config.Field(
        doc="Number of iterations for robust MAD sigma clipping.",
        dtype=int,
        default=4,
    )

Definition at line 133 of file measureApCorr.py.

numSigmaClip

lsst.meas.algorithms.measureApCorr.MeasureApCorrConfig.numSigmaClip

static

Initial value:

=  lsst.pex.config.Field(
        doc="Number of robust MAD sigma to do clipping.",
        dtype=float,
        default=4.0,
    )

Definition at line 138 of file measureApCorr.py.

refFluxName

lsst.meas.algorithms.measureApCorr.MeasureApCorrConfig.refFluxName

static

Initial value:

=  lsst.pex.config.Field(
        doc="Field name prefix for the flux other measurements should be aperture corrected to match",
        dtype=str,
        default="slot_CalibFlux",
    )

Definition at line 112 of file measureApCorr.py.

sourceSelector

lsst.meas.algorithms.measureApCorr.MeasureApCorrConfig.sourceSelector

static

Initial value:

=  sourceSelectorRegistry.makeField(
        doc="Selector that sets the stars that aperture corrections will be measured from.",
        default="science",
    )

Definition at line 117 of file measureApCorr.py.

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/meas_algorithms/ge6526c86ff+0d71447b4b/python/lsst/meas/algorithms/measureApCorr.py