MatchBackgroundsConfig

class lsst.pipe.tasks.matchBackgrounds.MatchBackgroundsConfig(*args, **kw)

Bases: PipelineTaskConfig

Attributes Summary

connections	Field which refers to a dynamically added configuration class which is based on a PipelineTaskConnections class.
gridStatistic	Type of statistic to estimate pixel value for the grid points (str, default 'MEANCLIP')
interpStyle	Algorithm to interpolate the background values.
numIter	Number of iterations of outlier rejection.
numSigmaClip	Sigma for outlier rejection.
refWarpVisit	Reference visit ID.
reference	Choose reference visit to match backgrounds to (ConfigurableInstance, default <class 'lsst.pipe.tasks.matchBackgrounds.ChooseReferenceVisitConfig'>)
saveLogOutput	Flag to enable/disable saving of log output for a task, enabled by default.
tractBgModel	Background model for the entire tract (TractBackgroundConfig, default <class 'lsst.pipe.tasks.tractBackground.TractBackgroundConfig'>)
undersampleStyle	Behavior if there are too few points in the grid for requested interpolation style (str, default 'REDUCE_INTERP_ORDER')

Methods Summary

validate()

Validate the Config, raising an exception if invalid.

Attributes Documentation

connections: pexConfig.ConfigField

Field which refers to a dynamically added configuration class which is based on a PipelineTaskConnections class.

gridStatistic

Type of statistic to estimate pixel value for the grid points (str, default 'MEANCLIP')

Allowed values:

'MEAN'

mean

'MEDIAN'

median

'MEANCLIP'

clipped mean

'None'

Field is optional

interpStyle

Algorithm to interpolate the background values. Maps to an enum; see afw.math.Background for more information. (str, default 'AKIMA_SPLINE')

Allowed values:

'CONSTANT'

Use a single constant value.

'LINEAR'

Use linear interpolation.

'NATURAL_SPLINE'

A cubic spline with zero second derivative at endpoints.

'AKIMA_SPLINE'

A higher-level non-linear spline that is more robust to outliers.

'NONE'

No background estimation is to be attempted.

'None'

Field is optional

numIter

Number of iterations of outlier rejection. Ignored if gridStatistic != 'MEANCLIP'. (int, default 3)

numSigmaClip

Sigma for outlier rejection. Ignored if gridStatistic != 'MEANCLIP'. (int, default 3)

refWarpVisit

Reference visit ID. If None, the best visit is chosen using the list of visits. (int, default None)

reference

Choose reference visit to match backgrounds to (ConfigurableInstance, default <class 'lsst.pipe.tasks.matchBackgrounds.ChooseReferenceVisitConfig'>)

saveLogOutput

Flag to enable/disable saving of log output for a task, enabled by default. (bool, default True)

tractBgModel

Background model for the entire tract (TractBackgroundConfig, default <class 'lsst.pipe.tasks.tractBackground.TractBackgroundConfig'>)

undersampleStyle

Behavior if there are too few points in the grid for requested interpolation style (str, default 'REDUCE_INTERP_ORDER')

Allowed values:

'THROW_EXCEPTION'

throw an exception if there are too few points.

'REDUCE_INTERP_ORDER'

use an interpolation style with a lower order.

'None'

Field is optional

Methods Documentation

validate()

Validate the Config, raising an exception if invalid.

Raises

lsst.pex.config.FieldValidationError

Raised if verification fails.

Notes

The base class implementation performs type checks on all fields by calling their validate methods.

Complex single-field validation can be defined by deriving new Field types. For convenience, some derived lsst.pex.config.Field-types (ConfigField and ConfigChoiceField) are defined in lsst.pex.config that handle recursing into subconfigs.

Inter-field relationships should only be checked in derived Config classes after calling this method, and base validation is complete.