lsst.pipe.tasks g8b9e2231ea+fa07cb600e
Loading...
Searching...
No Matches
Static Public Attributes | List of all members
lsst.pipe.tasks.matchBackgrounds.MatchBackgroundsConfig Class Reference
Inheritance diagram for lsst.pipe.tasks.matchBackgrounds.MatchBackgroundsConfig:

Static Public Attributes

pexConfig usePolynomial
 
pexConfig order
 
pexConfig badMaskPlanes
 
pexConfig gridStatistic
 
pexConfig undersampleStyle
 
pexConfig binSize
 
pexConfig interpStyle
 
pexConfig numSigmaClip
 
pexConfig numIter
 
pexConfig bestRefWeightCoverage
 
pexConfig bestRefWeightVariance
 
pexConfig bestRefWeightLevel
 
pexConfig approxWeighting
 
pexConfig gridStdevEpsilon
 

Detailed Description

Definition at line 31 of file matchBackgrounds.py.

Member Data Documentation

◆ approxWeighting

pexConfig lsst.pipe.tasks.matchBackgrounds.MatchBackgroundsConfig.approxWeighting
static
Initial value:
= pexConfig.Field(
dtype=bool,
doc=("Use inverse-variance weighting when approximating background offset model? "
"This will fail when the background offset is constant "
"(this is usually only the case in testing with artificial images)."
"(usePolynomial=True)"),
default=True,
)

Definition at line 121 of file matchBackgrounds.py.

◆ badMaskPlanes

pexConfig lsst.pipe.tasks.matchBackgrounds.MatchBackgroundsConfig.badMaskPlanes
static
Initial value:
= pexConfig.ListField(
doc="Names of mask planes to ignore while estimating the background",
dtype=str, default=["NO_DATA", "DETECTED", "DETECTED_NEGATIVE", "SAT", "BAD", "INTRP", "CR"],
itemCheck=lambda x: x in afwImage.Mask().getMaskPlaneDict(),
)

Definition at line 44 of file matchBackgrounds.py.

◆ bestRefWeightCoverage

pexConfig lsst.pipe.tasks.matchBackgrounds.MatchBackgroundsConfig.bestRefWeightCoverage
static
Initial value:
= pexConfig.RangeField(
dtype=float,
doc="Weight given to coverage (number of pixels that overlap with patch), "
"when calculating best reference exposure. Higher weight prefers exposures with high coverage."
"Ignored when reference visit is supplied",
default=0.4,
min=0., max=1.
)

Definition at line 98 of file matchBackgrounds.py.

◆ bestRefWeightLevel

pexConfig lsst.pipe.tasks.matchBackgrounds.MatchBackgroundsConfig.bestRefWeightLevel
static
Initial value:
= pexConfig.RangeField(
dtype=float,
doc="Weight given to mean background level when calculating best reference exposure. "
"Higher weight prefers exposures with low mean background level. "
"Ignored when reference visit is supplied.",
default=0.2,
min=0., max=1.
)

Definition at line 113 of file matchBackgrounds.py.

◆ bestRefWeightVariance

pexConfig lsst.pipe.tasks.matchBackgrounds.MatchBackgroundsConfig.bestRefWeightVariance
static
Initial value:
= pexConfig.RangeField(
dtype=float,
doc="Weight given to image variance when calculating best reference exposure. "
"Higher weight prefers exposures with low image variance. Ignored when reference visit is supplied",
default=0.4,
min=0., max=1.
)

Definition at line 106 of file matchBackgrounds.py.

◆ binSize

pexConfig lsst.pipe.tasks.matchBackgrounds.MatchBackgroundsConfig.binSize
static
Initial value:
= pexConfig.Field(
doc="Bin size for gridding the difference image and fitting a spatial model",
dtype=int,
default=256
)

Definition at line 70 of file matchBackgrounds.py.

◆ gridStatistic

pexConfig lsst.pipe.tasks.matchBackgrounds.MatchBackgroundsConfig.gridStatistic
static
Initial value:
= pexConfig.ChoiceField(
dtype=str,
doc="Type of statistic to estimate pixel value for the grid points",
default="MEAN",
allowed={
"MEAN": "mean",
"MEDIAN": "median",
"MEANCLIP": "clipped mean"
}
)

Definition at line 49 of file matchBackgrounds.py.

◆ gridStdevEpsilon

pexConfig lsst.pipe.tasks.matchBackgrounds.MatchBackgroundsConfig.gridStdevEpsilon
static
Initial value:
= pexConfig.RangeField(
dtype=float,
doc="Tolerance on almost zero standard deviation in a background-offset grid bin. "
"If all bins have a standard deviation below this value, the background offset model "
"is approximated without inverse-variance weighting. (usePolynomial=True)",
default=1e-8,
min=0.
)

Definition at line 129 of file matchBackgrounds.py.

◆ interpStyle

pexConfig lsst.pipe.tasks.matchBackgrounds.MatchBackgroundsConfig.interpStyle
static
Initial value:
= pexConfig.ChoiceField(
dtype=str,
doc="Algorithm to interpolate the background values; ignored if usePolynomial is True"
"Maps to an enum; see afw.math.Background",
default="AKIMA_SPLINE",
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 75 of file matchBackgrounds.py.

◆ numIter

pexConfig lsst.pipe.tasks.matchBackgrounds.MatchBackgroundsConfig.numIter
static
Initial value:
= pexConfig.Field(
dtype=int,
doc="Number of iterations of outlier rejection; ignored if gridStatistic != 'MEANCLIP'.",
default=2
)

Definition at line 93 of file matchBackgrounds.py.

◆ numSigmaClip

pexConfig lsst.pipe.tasks.matchBackgrounds.MatchBackgroundsConfig.numSigmaClip
static
Initial value:
= pexConfig.Field(
dtype=int,
doc="Sigma for outlier rejection; ignored if gridStatistic != 'MEANCLIP'.",
default=3
)

Definition at line 88 of file matchBackgrounds.py.

◆ order

pexConfig lsst.pipe.tasks.matchBackgrounds.MatchBackgroundsConfig.order
static
Initial value:
= pexConfig.Field(
dtype=int,
doc="Order of Chebyshev polynomial background model. Ignored if usePolynomial False",
default=8
)

Definition at line 39 of file matchBackgrounds.py.

◆ undersampleStyle

pexConfig lsst.pipe.tasks.matchBackgrounds.MatchBackgroundsConfig.undersampleStyle
static
Initial value:
= pexConfig.ChoiceField(
doc="Behaviour if there are too few points in grid for requested interpolation style. "
"Note: INCREASE_NXNYSAMPLE only allowed for usePolynomial=True.",
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 59 of file matchBackgrounds.py.

◆ usePolynomial

pexConfig lsst.pipe.tasks.matchBackgrounds.MatchBackgroundsConfig.usePolynomial
static
Initial value:
= pexConfig.Field(
dtype=bool,
doc="Fit background difference with Chebychev polynomial interpolation "
"(using afw.math.Approximate)? If False, fit with spline interpolation using afw.math.Background",
default=False
)

Definition at line 33 of file matchBackgrounds.py.


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