Config for SubtractBackgroundTask.
More...
Config for SubtractBackgroundTask.
- Note
- Many of these fields match fields in lsst.afw.math.BackgroundControl, the control class for lsst.afw.math.makeBackground
Definition at line 39 of file subtractBackground.py.
tuple lsst.meas.algorithms.subtractBackground.SubtractBackgroundConfig.algorithm |
|
static |
Initial value: 1 = pexConfig.ChoiceField(
2 doc=
"how to interpolate the background values. This maps to an enum; see afw::math::Background",
3 dtype=str, default=
"AKIMA_SPLINE", optional=
True,
5 "CONSTANT":
"Use a single constant value",
6 "LINEAR":
"Use linear interpolation",
7 "NATURAL_SPLINE":
"cubic spline with zero second derivative at endpoints",
8 "AKIMA_SPLINE":
"higher-level nonlinear spline that is more robust to outliers",
9 "NONE":
"No background estimation is to be attempted",
Definition at line 77 of file subtractBackground.py.
tuple lsst.meas.algorithms.subtractBackground.SubtractBackgroundConfig.approxOrderX |
|
static |
Initial value:
2 doc=
"Approximation order in X for background Chebyshev (valid only with useApprox=True)",
Definition at line 102 of file subtractBackground.py.
tuple lsst.meas.algorithms.subtractBackground.SubtractBackgroundConfig.approxOrderY |
|
static |
Initial value:
2 doc=
"Approximation order in Y for background Chebyshev (valid only with useApprox=True)",
Definition at line 109 of file subtractBackground.py.
tuple lsst.meas.algorithms.subtractBackground.SubtractBackgroundConfig.binSize |
|
static |
Initial value: 1 = pexConfig.RangeField(
2 doc=
"how large a region of the sky should be used for each background point",
3 dtype=int, default=128, min=1,
Definition at line 63 of file subtractBackground.py.
tuple lsst.meas.algorithms.subtractBackground.SubtractBackgroundConfig.binSizeX |
|
static |
Initial value: 1 = pexConfig.RangeField(
2 doc=(
"Sky region size to be used for each background point in X direction. "
3 "If 0, the binSize config is used."),
4 dtype=int, default=0, min=0,
Definition at line 67 of file subtractBackground.py.
tuple lsst.meas.algorithms.subtractBackground.SubtractBackgroundConfig.binSizeY |
|
static |
Initial value: 1 = pexConfig.RangeField(
2 doc=(
"Sky region size to be used for each background point in Y direction. "
3 "If 0, the binSize config is used."),
4 dtype=int, default=0, min=0,
Definition at line 72 of file subtractBackground.py.
tuple lsst.meas.algorithms.subtractBackground.SubtractBackgroundConfig.ignoredPixelMask |
|
static |
Initial value:
2 doc=
"Names of mask planes to ignore while estimating the background",
3 dtype=str, default=[
"BAD",
"EDGE",
"DETECTED",
"DETECTED_NEGATIVE",
"NO_DATA", ],
4 itemCheck=
lambda x: x
in afwImage.MaskU().getMaskPlaneDict().keys(),
Definition at line 88 of file subtractBackground.py.
tuple lsst.meas.algorithms.subtractBackground.SubtractBackgroundConfig.isNanSafe |
|
static |
Initial value:
2 doc=
"Ignore NaNs when estimating the background",
3 dtype=bool, default=
False,
Definition at line 93 of file subtractBackground.py.
tuple lsst.meas.algorithms.subtractBackground.SubtractBackgroundConfig.statisticsProperty |
|
static |
Initial value: 1 = pexConfig.ChoiceField(
2 doc=
"type of statistic to use for grid points",
3 dtype=str, default=
"MEANCLIP",
5 "MEANCLIP":
"clipped mean",
6 "MEAN":
"unclipped mean",
Definition at line 45 of file subtractBackground.py.
tuple lsst.meas.algorithms.subtractBackground.SubtractBackgroundConfig.undersampleStyle |
|
static |
Initial value: 1 = pexConfig.ChoiceField(
2 doc=
"behaviour if there are too few points in grid for requested interpolation style",
3 dtype=str, default=
"REDUCE_INTERP_ORDER",
5 "THROW_EXCEPTION":
"throw an exception if there are too few points",
6 "REDUCE_INTERP_ORDER":
"use an interpolation style with a lower order.",
7 "INCREASE_NXNYSAMPLE":
"Increase the number of samples used to make the interpolation grid.",
Definition at line 54 of file subtractBackground.py.
tuple lsst.meas.algorithms.subtractBackground.SubtractBackgroundConfig.useApprox |
|
static |
Initial value:
2 doc=
"Use Approximate (Chebyshev) to model background.",
3 dtype=bool, default=
True,
Definition at line 98 of file subtractBackground.py.
tuple lsst.meas.algorithms.subtractBackground.SubtractBackgroundConfig.weighting |
|
static |
Initial value:
2 doc=
"Use inverse variance weighting in calculation (valid only with useApprox=True)",
3 dtype=bool, default=
True,
Definition at line 113 of file subtractBackground.py.
The documentation for this class was generated from the following file: