SkyCorrectionConfig

class lsst.pipe.tasks.skyCorrection.SkyCorrectionConfig(*args, **kw)

Bases: PipelineTaskConfig

Attributes Summary

bgModel1	Initial background model, prior to sky frame subtraction (FocalPlaneBackgroundConfig, default <class 'lsst.pipe.tasks.background.FocalPlaneBackgroundConfig'>)
bgModel2	Final (cleanup) background model, after sky frame subtraction (FocalPlaneBackgroundConfig, default <class 'lsst.pipe.tasks.background.FocalPlaneBackgroundConfig'>)
binning	Binning factor for constructing full focal plane '*_camera' output datasets (int, default 8)
connections	Field which refers to a dynamically added configuration class which is based on a PipelineTaskConnections class.
doApplyFlatBackgroundRatio	This should be True if the input image was processed with an illumination correction.
doBgModel2	Do final (cleanup) background model subtraction, after sky frame subtraction? (bool, default True)
doMaskObjects	Iteratively mask objects to find good sky? (bool, default True)
doSky	Do sky frame subtraction? (bool, default True)
maskObjects	Mask Objects (ConfigurableInstance, default <class 'lsst.pipe.tasks.background.MaskObjectsConfig'>)
saveLogOutput	Flag to enable/disable saving of log output for a task, enabled by default.
sky	Sky measurement (ConfigurableInstance, default <class 'lsst.pipe.tasks.background.SkyMeasurementConfig'>)
undoBgModel1	If True, adds back initial background model after sky and removes bgModel1 from the list (bool, default False)

Methods Summary

setDefaults()	Subclass hook for computing defaults.
validate()	Validate the Config, raising an exception if invalid.

Attributes Documentation

bgModel1

Initial background model, prior to sky frame subtraction (FocalPlaneBackgroundConfig, default <class 'lsst.pipe.tasks.background.FocalPlaneBackgroundConfig'>)

bgModel2

Final (cleanup) background model, after sky frame subtraction (FocalPlaneBackgroundConfig, default <class 'lsst.pipe.tasks.background.FocalPlaneBackgroundConfig'>)

binning

Binning factor for constructing full focal plane ‘*_camera’ output datasets (int, default 8)

connections: pexConfig.ConfigField

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

doApplyFlatBackgroundRatio

This should be True if the input image was processed with an illumination correction. (bool, default False)

doBgModel2

Do final (cleanup) background model subtraction, after sky frame subtraction? (bool, default True)

doMaskObjects

Iteratively mask objects to find good sky? (bool, default True)

doSky

Do sky frame subtraction? (bool, default True)

maskObjects

Mask Objects (ConfigurableInstance, default <class 'lsst.pipe.tasks.background.MaskObjectsConfig'>)

saveLogOutput

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

sky

Sky measurement (ConfigurableInstance, default <class 'lsst.pipe.tasks.background.SkyMeasurementConfig'>)

undoBgModel1

If True, adds back initial background model after sky and removes bgModel1 from the list (bool, default False)

Methods Documentation

setDefaults()

Subclass hook for computing defaults.

Notes

Derived Config classes that must compute defaults rather than using the Field instances’s defaults should do so here. To correctly use inherited defaults, implementations of setDefaults must call their base class’s setDefaults.

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.