GetDcrTemplateConfig#

class lsst.ip.diffim.GetDcrTemplateConfig(*args, **kw)#

Bases: GetTemplateConfig

Config for GetDcrTemplateTask.

Only output_image_type="legacy" is supported: the task always writes an lsst.afw.image.ExposureF.

Attributes Summary

`bandwidth`	Bandwidth of the physical filter.
`coaddPsf`	Configuration for CoaddPsf (`CoaddPsfConfig`, default `<class 'lsst.meas.algorithms.CoaddPsfConfig'>`)
`connections`	Field which refers to a dynamically added configuration class which is based on a PipelineTaskConnections class.
`doScaleVariance`	Scale variance of the template image? (`bool`, default `True`)
`effectiveWavelength`	Effective wavelength of the filter in nm.
`fwhmExposureBuffer`	Fractional buffer margin to be left out of all sides of the image during construction of grid to compute average PSF FWHM in an exposure (`float`, default `0.05`)
`fwhmExposureGrid`	Grid size to compute the average PSF FWHM in an exposure (pixels) (`int`, default `10`)
`highVarianceMaskFraction`	Minimum fraction of unmasked pixels needed to set the HIGH_VARIANCE mask plane.
`highVarianceThreshold`	Set the HIGH_VARIANCE mask plane for regions with variance greater than the median by this factor.
`numSubfilters`	Number of subfilters in the DcrCoadd.
`output_image_type`	Which image type to use for the output template.
`raiseOnUndefinedMaskMap`	Raise if the template has pixels set in a mask plane that `lsst.images` does not map? If False, log a warning and drop that plane from the output instead.
`requireCoaddAtGraphBuild`	If True, include the coadd dataset existence in the initial butler query during QuantumGraph generation.
`saveLogOutput`	Flag to enable/disable saving of log output for a task, enabled by default.
`scaleVariance`	Subtask to rescale the variance of the template to the statistically expected level.
`templateBorderSize`	Number of pixels to grow the requested template image to account for warping (`int`, default `20`)
`varianceBackground`	Task to estimate the background variance.
`warp`	warper configuration (`WarperConfig`, default `<class 'lsst.afw.math._warper.WarperConfig'>`)

Methods Summary

validate()

Validate the Config, raising an exception if invalid.

Attributes Documentation

bandwidth#: Bandwidth of the physical filter. (float)

coaddPsf#: Configuration for CoaddPsf (CoaddPsfConfig, default <class 'lsst.meas.algorithms.CoaddPsfConfig'>)

connections: pexConfig.ConfigField#: Field which refers to a dynamically added configuration class which is based on a PipelineTaskConnections class.

doScaleVariance#: Scale variance of the template image? (bool, default True)

effectiveWavelength#: Effective wavelength of the filter in nm. (float)

fwhmExposureBuffer#: Fractional buffer margin to be left out of all sides of the image during construction of grid to compute average PSF FWHM in an exposure (float, default 0.05)

fwhmExposureGrid#: Grid size to compute the average PSF FWHM in an exposure (pixels) (int, default 10)

highVarianceMaskFraction#: Minimum fraction of unmasked pixels needed to set the HIGH_VARIANCE mask plane. (float, default 0.1)

highVarianceThreshold#

Set the HIGH_VARIANCE mask plane for regions with variance greater than the median by this factor. (float, default 4)

Valid Range = [1,inf)

numSubfilters#: Number of subfilters in the DcrCoadd. (int, default 3)

output_image_type#

Which image type to use for the output template. (str, default 'legacy')

Allowed values:

'legacy': Write as a lsst.afw.image.ExposureF.
'future': Write as a lsst.images.DifferenceImage.

raiseOnUndefinedMaskMap#: Raise if the template has pixels set in a mask plane that lsst.images does not map? If False, log a warning and drop that plane from the output instead. Only used with output_image_type=’future’. (bool, default False)

requireCoaddAtGraphBuild#: If True, include the coadd dataset existence in the initial butler query during QuantumGraph generation. (bool, default False)

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

scaleVariance#: Subtask to rescale the variance of the template to the statistically expected level. (ConfigurableInstance, default <class 'lsst.meas.algorithms.scaleVariance.ScaleVarianceConfig'>)

templateBorderSize#: Number of pixels to grow the requested template image to account for warping (int, default 20)

varianceBackground#: Task to estimate the background variance. (ConfigurableInstance, default <class 'lsst.meas.algorithms.subtractBackground.SubtractBackgroundConfig'>)

warp#: warper configuration (WarperConfig, default <class 'lsst.afw.math._warper.WarperConfig'>)

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.