lsst.pipe.tasks.matchBackgrounds.ChooseReferenceVisitConfig Class Reference

Inheritance diagram for lsst.pipe.tasks.matchBackgrounds.ChooseReferenceVisitConfig:

Static Public Attributes
	tractBgModel
	bestRefWeightChi2
	bestRefWeightVariance
	bestRefWeightGlobalCoverage
	gridStatistic
	undersampleStyle
	interpStyle
	numSigmaClip
	numIter

Detailed Description

Definition at line 55 of file matchBackgrounds.py.

Member Data Documentation

bestRefWeightChi2

lsst.pipe.tasks.matchBackgrounds.ChooseReferenceVisitConfig.bestRefWeightChi2

static

Initial value:

=  RangeField(
        dtype=float,
        doc="Mean background goodness of fit statistic weight when calculating the best reference exposure. "
        "Higher weights prefer exposures with flatter backgrounds. Ignored when ref visit supplied.",
        default=0.3,
        min=0.0,
        max=1.0,
    )

Definition at line 61 of file matchBackgrounds.py.

bestRefWeightGlobalCoverage

lsst.pipe.tasks.matchBackgrounds.ChooseReferenceVisitConfig.bestRefWeightGlobalCoverage

static

Initial value:

=  RangeField(
        dtype=float,
        doc="Global coverage weight (total number of valid pixels) when calculating the best reference "
        "exposure. Higher weights prefer exposures with high coverage. Ignored when ref visit supplied.",
        default=0.4,
        min=0.0,
        max=1.0,
    )

Definition at line 77 of file matchBackgrounds.py.

bestRefWeightVariance

lsst.pipe.tasks.matchBackgrounds.ChooseReferenceVisitConfig.bestRefWeightVariance

static

Initial value:

=  RangeField(
        dtype=float,
        doc="Image variance weight when calculating the best reference exposure. "
        "Higher weights prefers exposures with low image variances. Ignored when ref visit supplied.",
        default=0.3,
        min=0.0,
        max=1.0,
    )

Definition at line 69 of file matchBackgrounds.py.

gridStatistic

lsst.pipe.tasks.matchBackgrounds.ChooseReferenceVisitConfig.gridStatistic

static

Initial value:

=  ChoiceField(
        dtype=str,
        doc="Type of statistic to estimate pixel value for the grid points",
        default="MEANCLIP",
        allowed={"MEAN": "mean", "MEDIAN": "median", "MEANCLIP": "clipped mean"},
    )

Definition at line 85 of file matchBackgrounds.py.

interpStyle

lsst.pipe.tasks.matchBackgrounds.ChooseReferenceVisitConfig.interpStyle

static

Initial value:

=  ChoiceField(
        dtype=str,
        doc="Algorithm to interpolate the background values; ignored if ``usePolynomial=True``."
        "Maps to an enum; see afw.math.Background for more information.",
        default="AKIMA_SPLINE",
        allowed={
            "CONSTANT": "Use a single constant value.",
            "LINEAR": "Use linear interpolation.",
            "NATURAL_SPLINE": "A cubic spline with zero second derivative at endpoints.",
            "AKIMA_SPLINE": "A higher-level non-linear spline that is more robust to outliers.",
            "NONE": "No background estimation is to be attempted.",
        },
    )

Definition at line 100 of file matchBackgrounds.py.

numIter

lsst.pipe.tasks.matchBackgrounds.ChooseReferenceVisitConfig.numIter

static

Initial value:

=  Field[int](
        doc="Number of iterations of outlier rejection. Ignored if ``gridStatistic != 'MEANCLIP'``.",
        default=3,
    )

Definition at line 117 of file matchBackgrounds.py.

numSigmaClip

lsst.pipe.tasks.matchBackgrounds.ChooseReferenceVisitConfig.numSigmaClip

static

Initial value:

=  Field[int](
        doc="Sigma for outlier rejection. Ignored if ``gridStatistic != 'MEANCLIP'``.",
        default=3,
    )

Definition at line 113 of file matchBackgrounds.py.

tractBgModel

lsst.pipe.tasks.matchBackgrounds.ChooseReferenceVisitConfig.tractBgModel

static

Initial value:

=  ConfigField(
        dtype=TractBackgroundConfig,
        doc="Background model for the entire tract",
    )

Definition at line 57 of file matchBackgrounds.py.

undersampleStyle

lsst.pipe.tasks.matchBackgrounds.ChooseReferenceVisitConfig.undersampleStyle

static

Initial value:

=  ChoiceField(
        dtype=str,
        doc="Behavior if there are too few points in the grid for requested interpolation style",
        default="REDUCE_INTERP_ORDER",
        allowed={
            "THROW_EXCEPTION": "throw an exception if there are too few points.",
            "REDUCE_INTERP_ORDER": "use an interpolation style with a lower order.",
        },
    )

Definition at line 91 of file matchBackgrounds.py.

---

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

• python/lsst/pipe/tasks/matchBackgrounds.py