GetTemplateConfig#

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

Bases: PipelineTaskConfig

Attributes Summary

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.

doCorrectVariancePlateScale

Correct the template variance for the total change in pixel area between the images the coadds were built from and the science image? This matters when the two have different plate scales, such as DECam templates used for Rubin science images.

doScaleVariance

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

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.

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

setDefaults()

Subclass hook for computing defaults.

Attributes Documentation

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.

doCorrectVariancePlateScale#

Correct the template variance for the total change in pixel area between the images the coadds were built from and the science image? This matters when the two have different plate scales, such as DECam templates used for Rubin science images. The coadd pixel grid cancels out of the total, so the skymap does not enter. It is a single scalar factor, applied to the final template variance plane. (bool, default False)

doScaleVariance#

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

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)

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

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.