lsst.pipe.tasks gcb6d5b21a0+3d108a17e1
Loading...
Searching...
No Matches
Static Public Attributes | List of all members
lsst.pipe.tasks.background.BackgroundConfig Class Reference
Inheritance diagram for lsst.pipe.tasks.background.BackgroundConfig:

Static Public Attributes

 statistic
 
 xBinSize = RangeField(dtype=int, default=32, min=1, doc="Superpixel size in x")
 
 yBinSize = RangeField(dtype=int, default=32, min=1, doc="Superpixel size in y")
 
 algorithm
 
 mask
 

Detailed Description

Configuration for background measurement

Definition at line 71 of file background.py.

Member Data Documentation

◆ algorithm

lsst.pipe.tasks.background.BackgroundConfig.algorithm
static
Initial value:
= ChoiceField(dtype=str, default="NATURAL_SPLINE", optional=True,
doc="How to interpolate the background values. "
"This maps to an enum; see afw::math::Background",
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 79 of file background.py.

◆ mask

lsst.pipe.tasks.background.BackgroundConfig.mask
static
Initial value:
= ListField(dtype=str, default=["SAT", "BAD", "EDGE", "DETECTED", "DETECTED_NEGATIVE", "NO_DATA"],
doc="Names of mask planes to ignore while estimating the background")

Definition at line 90 of file background.py.

◆ statistic

lsst.pipe.tasks.background.BackgroundConfig.statistic
static
Initial value:
= ChoiceField(dtype=str, default="MEANCLIP", doc="type of statistic to use for grid points",
allowed={"MEANCLIP": "clipped mean",
"MEAN": "unclipped mean",
"MEDIAN": "median"})

Definition at line 73 of file background.py.

◆ xBinSize

lsst.pipe.tasks.background.BackgroundConfig.xBinSize = RangeField(dtype=int, default=32, min=1, doc="Superpixel size in x")
static

Definition at line 77 of file background.py.

◆ yBinSize

lsst.pipe.tasks.background.BackgroundConfig.yBinSize = RangeField(dtype=int, default=32, min=1, doc="Superpixel size in y")
static

Definition at line 78 of file background.py.


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