lsst.pipe.tasks.background.FocalPlaneBackgroundConfig Class Reference

Inheritance diagram for lsst.pipe.tasks.background.FocalPlaneBackgroundConfig:

Static Public Attributes
	xSize = Field(dtype=float, doc="Bin size in x")
	ySize = Field(dtype=float, doc="Bin size in y")
	pixelSize = Field(dtype=float, default=1.0, doc="Pixel size in same units as xSize/ySize")
	minFrac = Field(dtype=float, default=0.1, doc="Minimum fraction of bin size for good measurement")
	mask
	interpolation
	doSmooth = Field(dtype=bool, default=False, doc="Do smoothing?")
	smoothScale = Field(dtype=float, default=2.0, doc="Smoothing scale, as a multiple of the bin size")
	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 467 of file background.py.

Member Data Documentation

binning

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

static

Definition at line 495 of file background.py.

doSmooth

lsst.pipe.tasks.background.FocalPlaneBackgroundConfig.doSmooth = Field(dtype=bool, default=False, doc="Do smoothing?")

static

Definition at line 493 of file background.py.

interpolation

lsst.pipe.tasks.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 482 of file background.py.

mask

lsst.pipe.tasks.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 480 of file background.py.

minFrac

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

static

Definition at line 479 of file background.py.

pixelSize

lsst.pipe.tasks.background.FocalPlaneBackgroundConfig.pixelSize = Field(dtype=float, default=1.0, doc="Pixel size in same units as xSize/ySize")

static

Definition at line 478 of file background.py.

smoothScale

lsst.pipe.tasks.background.FocalPlaneBackgroundConfig.smoothScale = Field(dtype=float, default=2.0, doc="Smoothing scale, as a multiple of the bin size")

static

Definition at line 494 of file background.py.

xSize

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

static

Definition at line 476 of file background.py.

ySize

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

static

Definition at line 477 of file background.py.

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/pipe_tasks/g2a9a014e59+6f9be1b9cd/python/lsst/pipe/tasks/background.py