lsst.pipe.tasks.tractBackground.TractBackgroundConfig Class Reference

Inheritance diagram for lsst.pipe.tasks.tractBackground.TractBackgroundConfig:

Static Public Attributes
	xBin = Field(dtype=float, default=128, doc="Bin size in x")
	yBin = Field(dtype=float, default=128, doc="Bin size in y")
	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 warp background model (pixels)")

Detailed Description

Configuration for TractBackground

Parameters `xBin` and `yBin` are in pixels, as translation from warps to
tract and back only requires geometric transformations in the warped pixel
plane.

Definition at line 39 of file tractBackground.py.

Member Data Documentation

binning

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

static

Definition at line 72 of file tractBackground.py.

doSmooth

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

static

Definition at line 70 of file tractBackground.py.

interpolation

lsst.pipe.tasks.tractBackground.TractBackgroundConfig.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 57 of file tractBackground.py.

mask

lsst.pipe.tasks.tractBackground.TractBackgroundConfig.mask

static

Initial value:

=  ListField(
        dtype=str,
        doc="Mask planes to treat as bad",
        default=["BAD", "SAT", "EDGE", "NO_DATA"],
    )

Definition at line 52 of file tractBackground.py.

minFrac

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

static

Definition at line 49 of file tractBackground.py.

smoothScale

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

static

Definition at line 71 of file tractBackground.py.

xBin

lsst.pipe.tasks.tractBackground.TractBackgroundConfig.xBin = Field(dtype=float, default=128, doc="Bin size in x")

static

Definition at line 47 of file tractBackground.py.

yBin

lsst.pipe.tasks.tractBackground.TractBackgroundConfig.yBin = Field(dtype=float, default=128, doc="Bin size in y")

static

Definition at line 48 of file tractBackground.py.

---

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

• python/lsst/pipe/tasks/tractBackground.py