InterpImageConfig#

class lsst.pipe.tasks.interpImage.InterpImageConfig(*args, **kw)#

Bases: Config

Config for InterpImageTask

Attributes Summary

`fallbackUserValue`	If fallbackValueType is 'USER' then use this as the fallbackValue; ignored otherwise (`float`, default `0.0`)
`fallbackValueType`	Type of statistic to calculate edge fallbackValue for interpolation (`str`, default `'MEDIAN'`)
`modelPsf`	Model Psf factory (`ConfigurableInstance`, default `<class 'lsst.meas.algorithms.gaussianPsfFactory.GaussianPsfFactory'>`)
`negativeFallbackAllowed`	Allow negative values for egde interpolation fallbackValue? If False, set fallbackValue to max(fallbackValue, 0.0) (`bool`, default `False`)
`transpose`	Transpose image before interpolating? This allows the interpolation to act over columns instead of rows.
`useFallbackValueAtEdge`	Smoothly taper to the fallback value at the edge of the image? (`bool`, default `True`)

Methods Summary

validate()

Validate the Config, raising an exception if invalid.

Attributes Documentation

fallbackUserValue#: If fallbackValueType is ‘USER’ then use this as the fallbackValue; ignored otherwise (float, default 0.0)

fallbackValueType#

Type of statistic to calculate edge fallbackValue for interpolation (str, default 'MEDIAN')

Allowed values:

'MEAN': mean
'MEDIAN': median
'MEANCLIP': clipped mean
'USER': user value set in fallbackUserValue config
'None': Field is optional

modelPsf#: Model Psf factory (ConfigurableInstance, default <class 'lsst.meas.algorithms.gaussianPsfFactory.GaussianPsfFactory'>)

negativeFallbackAllowed#: Allow negative values for egde interpolation fallbackValue? If False, set fallbackValue to max(fallbackValue, 0.0) (bool, default False)

transpose#: Transpose image before interpolating? This allows the interpolation to act over columns instead of rows. (int, default False)

useFallbackValueAtEdge#: Smoothly taper to the fallback value at the edge of the image? (bool, default True)

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.