lsst.pipe.drivers  6.0b0-hsc-20-g3029749+8
Static Public Attributes | List of all members
lsst.pipe.drivers.background.FocalPlaneBackgroundConfig Class Reference
Inheritance diagram for lsst.pipe.drivers.background.FocalPlaneBackgroundConfig:

Static Public Attributes

 xSize = Field(dtype=float, doc="Bin size in x")
 
 ySize = Field(dtype=float, doc="Bin size in y")
 
 minFrac = Field(dtype=float, default=0.1, doc="Minimum fraction of bin size for good measurement")
 
 mask
 
 interpolation
 
 binning = Field(dtype=int, default=64, doc="Binning to use for CCD background model (pixels)")
 

Detailed Description

Configuration for FocalPlaneBackground

Note that `xSize` and `ySize` are floating-point values, as
the focal plane frame is usually defined in units of microns
or millimetres rather than pixels. As such, their values will
need to be revised according to each particular camera. For
this reason, no defaults are set for those.

Definition at line 442 of file background.py.

Member Data Documentation

◆ binning

lsst.pipe.drivers.background.FocalPlaneBackgroundConfig.binning = Field(dtype=int, default=64, doc="Binning to use for CCD background model (pixels)")
static

Definition at line 467 of file background.py.

◆ interpolation

lsst.pipe.drivers.background.FocalPlaneBackgroundConfig.interpolation
static
Initial value:
= 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 456 of file background.py.

◆ mask

lsst.pipe.drivers.background.FocalPlaneBackgroundConfig.mask
static
Initial value:
= ListField(dtype=str, doc="Mask planes to treat as bad",
default=["BAD", "SAT", "INTRP", "DETECTED", "DETECTED_NEGATIVE", "EDGE", "NO_DATA"])

Definition at line 454 of file background.py.

◆ minFrac

lsst.pipe.drivers.background.FocalPlaneBackgroundConfig.minFrac = Field(dtype=float, default=0.1, doc="Minimum fraction of bin size for good measurement")
static

Definition at line 453 of file background.py.

◆ xSize

lsst.pipe.drivers.background.FocalPlaneBackgroundConfig.xSize = Field(dtype=float, doc="Bin size in x")
static

Definition at line 451 of file background.py.

◆ ySize

lsst.pipe.drivers.background.FocalPlaneBackgroundConfig.ySize = Field(dtype=float, doc="Bin size in y")
static

Definition at line 452 of file background.py.


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