BackgroundConfig

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

Bases: Config

Configuration for background measurement

Attributes Summary

algorithm	How to interpolate the background values.
mask	Names of mask planes to ignore while estimating the background (List, default ['SAT', 'BAD', 'EDGE', 'DETECTED', 'DETECTED_NEGATIVE', 'NO_DATA'])
statistic	type of statistic to use for grid points (str, default 'MEANCLIP')
xBinSize	Superpixel size in x (int, default 32)
yBinSize	Superpixel size in y (int, default 32)

Attributes Documentation

algorithm

How to interpolate the background values. This maps to an enum; see afw::math::Background (str, default 'NATURAL_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

Names of mask planes to ignore while estimating the background (List, default ['SAT', 'BAD', 'EDGE', 'DETECTED', 'DETECTED_NEGATIVE', 'NO_DATA'])

statistic

type of statistic to use for grid points (str, default 'MEANCLIP')

Allowed values:

'MEANCLIP'

clipped mean

'MEAN'

unclipped mean

'MEDIAN'

median

'None'

Field is optional

xBinSize

Superpixel size in x (int, default 32)

Valid Range = [1,inf)

yBinSize

Superpixel size in y (int, default 32)

Valid Range = [1,inf)