lsst.meas.algorithms gf82c78fb6f+5b4928dc2e
Loading...
Searching...
No Matches
Static Public Attributes | List of all members
lsst.meas.algorithms.subtractBackground.SubtractBackgroundConfig Class Reference
Inheritance diagram for lsst.meas.algorithms.subtractBackground.SubtractBackgroundConfig:

Static Public Attributes

pexConfig statisticsProperty
 
pexConfig undersampleStyle
 
pexConfig binSize
 
pexConfig binSizeX
 
pexConfig binSizeY
 
pexConfig algorithm
 
pexConfig ignoredPixelMask
 
pexConfig isNanSafe
 
pexConfig useApprox
 
pexConfig approxOrderX
 
pexConfig approxOrderY
 
pexConfig weighting
 

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 39 of file subtractBackground.py.

Member Data Documentation

◆ algorithm

pexConfig 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 77 of file subtractBackground.py.

◆ approxOrderX

pexConfig 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 102 of file subtractBackground.py.

◆ approxOrderY

pexConfig 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 109 of file subtractBackground.py.

◆ binSize

pexConfig 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 63 of file subtractBackground.py.

◆ binSizeX

pexConfig 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 67 of file subtractBackground.py.

◆ binSizeY

pexConfig 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 72 of file subtractBackground.py.

◆ ignoredPixelMask

pexConfig 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", ],
itemCheck=lambda x: x in afwImage.Mask().getMaskPlaneDict().keys(),
)

Definition at line 88 of file subtractBackground.py.

◆ isNanSafe

pexConfig 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 93 of file subtractBackground.py.

◆ statisticsProperty

pexConfig 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 45 of file subtractBackground.py.

◆ undersampleStyle

pexConfig 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 54 of file subtractBackground.py.

◆ useApprox

pexConfig 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 98 of file subtractBackground.py.

◆ weighting

pexConfig 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 113 of file subtractBackground.py.


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