SpatiallySampledMetricsConfig#

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

Config for SpatiallySampledMetricsTask

Attributes Summary

`connections`	Field which refers to a dynamically added configuration class which is based on a PipelineTaskConnections class.
`image_type`	Type of the input images and PSF matching kernel.
`metricSources`	Generate QA metric sources (`ConfigurableInstance`, default `<class 'lsst.meas.algorithms.skyObjects.SkyObjectsConfig'>`)
`metricsMaskPlanes`	List of mask planes to include in metrics.
`saveLogOutput`	Flag to enable/disable saving of log output for a task, enabled by default.

Methods Summary

Subclass hook for computing defaults.

Attributes Documentation

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

image_type#

Type of the input images and PSF matching kernel. run() takes the legacy types either way. (str, default 'legacy')

Allowed values:

'legacy': Read lsst.afw.image.ExposureF and lsst.afw.math.Kernel.
'future': Read lsst.images.VisitImage for the science image, lsst.images.DifferenceImage for the template and difference image, and lsst.images.convolution_kernels.ConvolutionKernel.

metricSources#: Generate QA metric sources (ConfigurableInstance, default <class 'lsst.meas.algorithms.skyObjects.SkyObjectsConfig'>)

metricsMaskPlanes#: List of mask planes to include in metrics. A mask plane that is not registered reports 0 pixels set. (List, default ('BAD', 'CLIPPED', 'CR', 'DETECTED', 'DETECTED_NEGATIVE', 'EDGE', 'INEXACT_PSF', 'INJECTED', 'INJECTED_TEMPLATE', 'INTRP', 'NOT_DEBLENDED', 'NO_DATA', 'REJECTED', 'SAT', 'SAT_TEMPLATE', 'SENSOR_EDGE', 'STREAK', 'SUSPECT', 'UNMASKEDNAN'))

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

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.

Notes#