FocalPlaneBackgroundConfig

class lsst.pipe.tasks.background.FocalPlaneBackgroundConfig(*args, **kw)

Bases: Config

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.

Attributes Summary

binning	Binning to use for CCD background model (pixels) (int, default 64)
doSmooth	Do smoothing? (bool, default False)
interpolation	how to interpolate the background values.
mask	Mask planes to treat as bad (List, default ['BAD', 'SAT', 'INTRP', 'DETECTED', 'DETECTED_NEGATIVE', 'EDGE', 'NO_DATA'])
minFrac	Minimum fraction of bin size for good measurement (float, default 0.1)
pixelSize	Pixel size in same units as xSize/ySize (float, default 1.0)
smoothScale	Smoothing scale, as a multiple of the bin size (float, default 2.0)
xSize	Bin size in x (float)
ySize	Bin size in y (float)

Attributes Documentation

binning

Binning to use for CCD background model (pixels) (int, default 64)

doSmooth

Do smoothing? (bool, default False)

interpolation

how to interpolate the background values. This maps to an enum; see afw::math::Background (str, default 'AKIMA_SPLINE')

Allowed values:

'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

'None'

Field is optional

mask

Mask planes to treat as bad (List, default ['BAD', 'SAT', 'INTRP', 'DETECTED', 'DETECTED_NEGATIVE', 'EDGE', 'NO_DATA'])

minFrac

Minimum fraction of bin size for good measurement (float, default 0.1)

pixelSize

Pixel size in same units as xSize/ySize (float, default 1.0)

smoothScale

Smoothing scale, as a multiple of the bin size (float, default 2.0)

xSize

Bin size in x (float)

ySize

Bin size in y (float)