lsst.meas.algorithms.subtractBackground.SubtractBackgroundConfig Class Reference

Inheritance diagram for lsst.meas.algorithms.subtractBackground.SubtractBackgroundConfig:

Static Public Attributes
	statisticsProperty
	undersampleStyle
	binSize
	binSizeX
	binSizeY
	algorithm
	ignoredPixelMask
	isNanSafe
	useApprox
	approxOrderX
	approxOrderY
	weighting
	doApplyFlatBackgroundRatio
	doFilterSuperPixels
	superPixelFilterSize

Detailed Description

Config for SubtractBackgroundTask

Many of these fields match fields in `lsst.afw.math.BackgroundControl`,
the control class for `lsst.afw.math.makeBackground`

Definition at line 100 of file subtractBackground.py.

Member Data Documentation

algorithm

lsst.meas.algorithms.subtractBackground.SubtractBackgroundConfig.algorithm

static

Initial value:

=  pexConfig.ChoiceField(
        doc="how to interpolate the background values. This maps to an enum; see afw::math::Background",
        dtype=str, default="AKIMA_SPLINE", optional=True,
        allowed={
            "CONSTANT": "Use a single constant value",
            "LINEAR": "Use linear interpolation",
            "NATURAL_SPLINE": "cubic spline with zero second derivative at endpoints",
            "AKIMA_SPLINE": "higher-level nonlinear spline that is more robust to outliers",
            "NONE": "No background estimation is to be attempted",
        },
    )

Definition at line 138 of file subtractBackground.py.

approxOrderX

lsst.meas.algorithms.subtractBackground.SubtractBackgroundConfig.approxOrderX

static

Initial value:

=  pexConfig.Field(
        doc="Approximation order in X for background Chebyshev (valid only with useApprox=True)",
        dtype=int, default=6,
    )

Definition at line 162 of file subtractBackground.py.

approxOrderY

lsst.meas.algorithms.subtractBackground.SubtractBackgroundConfig.approxOrderY

static

Initial value:

=  pexConfig.Field(
        doc="Approximation order in Y for background Chebyshev (valid only with useApprox=True)",
        dtype=int, default=-1,
    )

Definition at line 169 of file subtractBackground.py.

binSize

lsst.meas.algorithms.subtractBackground.SubtractBackgroundConfig.binSize

static

Initial value:

=  pexConfig.RangeField(
        doc="how large a region of the sky should be used for each background point",
        dtype=int, default=128, min=1,
    )

Definition at line 124 of file subtractBackground.py.

binSizeX

lsst.meas.algorithms.subtractBackground.SubtractBackgroundConfig.binSizeX

static

Initial value:

=  pexConfig.RangeField(
        doc=("Sky region size to be used for each background point in X direction. "
             "If 0, the binSize config is used."),
        dtype=int, default=0, min=0,
    )

Definition at line 128 of file subtractBackground.py.

binSizeY

lsst.meas.algorithms.subtractBackground.SubtractBackgroundConfig.binSizeY

static

Initial value:

=  pexConfig.RangeField(
        doc=("Sky region size to be used for each background point in Y direction. "
             "If 0, the binSize config is used."),
        dtype=int, default=0, min=0,
    )

Definition at line 133 of file subtractBackground.py.

doApplyFlatBackgroundRatio

lsst.meas.algorithms.subtractBackground.SubtractBackgroundConfig.doApplyFlatBackgroundRatio

static

Initial value:

=  pexConfig.Field(
        doc="Convert from a photometrically flat image to one suitable to background subtraction? "
            "If True, then a backgroundToPhotometricRatio must be supplied to the task run method.",
        dtype=bool,
        default=False,
    )

Definition at line 177 of file subtractBackground.py.

doFilterSuperPixels

lsst.meas.algorithms.subtractBackground.SubtractBackgroundConfig.doFilterSuperPixels

static

Initial value:

=  pexConfig.Field(
        doc="Remove outliers from the binned image.",
        dtype=bool,
        default=False,
    )

Definition at line 183 of file subtractBackground.py.

ignoredPixelMask

lsst.meas.algorithms.subtractBackground.SubtractBackgroundConfig.ignoredPixelMask

static

Initial value:

=  pexConfig.ListField(
        doc="Names of mask planes to ignore while estimating the background",
        dtype=str, default=["BAD", "EDGE", "DETECTED", "DETECTED_NEGATIVE", "NO_DATA", ],
    )

Definition at line 149 of file subtractBackground.py.

isNanSafe

lsst.meas.algorithms.subtractBackground.SubtractBackgroundConfig.isNanSafe

static

Initial value:

=  pexConfig.Field(
        doc="Ignore NaNs when estimating the background",
        dtype=bool, default=False,
    )

Definition at line 153 of file subtractBackground.py.

statisticsProperty

lsst.meas.algorithms.subtractBackground.SubtractBackgroundConfig.statisticsProperty

static

Initial value:

=  pexConfig.ChoiceField(
        doc="type of statistic to use for grid points",
        dtype=str, default="MEANCLIP",
        allowed={
            "MEANCLIP": "clipped mean",
            "MEAN": "unclipped mean",
            "MEDIAN": "median",
        }
    )

Definition at line 106 of file subtractBackground.py.

superPixelFilterSize

lsst.meas.algorithms.subtractBackground.SubtractBackgroundConfig.superPixelFilterSize

static

Initial value:

=  pexConfig.Field(
        doc="Size of the median filter to use to remove outliers from the binned image.",
        dtype=int,
        default=3,
    )

Definition at line 188 of file subtractBackground.py.

undersampleStyle

lsst.meas.algorithms.subtractBackground.SubtractBackgroundConfig.undersampleStyle

static

Initial value:

=  pexConfig.ChoiceField(
        doc="behaviour if there are too few points in grid for requested interpolation style",
        dtype=str, 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.",
            "INCREASE_NXNYSAMPLE": "Increase the number of samples used to make the interpolation grid.",
        },
    )

Definition at line 115 of file subtractBackground.py.

useApprox

lsst.meas.algorithms.subtractBackground.SubtractBackgroundConfig.useApprox

static

Initial value:

=  pexConfig.Field(
        doc="Use Approximate (Chebyshev) to model background.",
        dtype=bool, default=True,
    )

Definition at line 158 of file subtractBackground.py.

weighting

lsst.meas.algorithms.subtractBackground.SubtractBackgroundConfig.weighting

static

Initial value:

=  pexConfig.Field(
        doc="Use inverse variance weighting in calculation (valid only with useApprox=True)",
        dtype=bool, default=True,
    )

Definition at line 173 of file subtractBackground.py.

---

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

• python/lsst/meas/algorithms/subtractBackground.py