DetectCoaddSourcesConfig#

class lsst.pipe.tasks.multiBand.DetectCoaddSourcesConfig(*args, **kw)#

Bases: PipelineTaskConfig

Configuration parameters for the DetectCoaddSourcesTask

Attributes Summary

`backgroundDescription`	Description of the subtracted background, to be stored with the image when the input and output images are lsst.images.cells.CellCoadd.
`backgroundName`	Name of the subtracted background, to be stored with the image when the input and output images are lsst.images.cells.CellCoadd.
`coaddName`	Name of coadd (`str`, default `'deep'`)
`connections`	Field which refers to a dynamically added configuration class which is based on a PipelineTaskConnections class.
`detection`	Source detection (`ConfigurableInstance`, default `<class 'lsst.meas.algorithms.dynamicDetection.DynamicDetectionConfig'>`)
`doScaleVariance`	Scale variance plane using empirical noise? (`bool`, default `True`)
`forceExactBinning`	Check that the background bin size evenly divides the patch inner region, and crop the outer region to an integer number of bins.
`hasFakes`	Should be set to True if fake sources have been inserted into the input data.
`idGenerator`	Configuration for how to generate catalog IDs from data IDs.
`imageType`	Which image type to use for the input and output coadd.
`saveLogOutput`	Flag to enable/disable saving of log output for a task, enabled by default.
`scaleVariance`	Variance rescaling (`ConfigurableInstance`, default `<class 'lsst.meas.algorithms.scaleVariance.ScaleVarianceConfig'>`)
`useCellCoadds`	Whether to use cell coadds? (`bool`, default `False`)
`writeEmptyBackgrounds`	If true, save a placeholder background with NaNs in all bins (but the right geometry) when there are no pixels to compute a background from.
`writeOnlyBackgrounds`	If true, only save the background models.

Methods Summary

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

Attributes Documentation

backgroundDescription#: Description of the subtracted background, to be stored with the image when the input and output images are lsst.images.cells.CellCoadd. (str, default 'Background subtracted from the image when generating the Object catalog. This intentionally oversubtracts the background to reduce blending and ensure scattered light is subtracted. Restoring this background does not restore all original backgrounds, as the coadd was built from background-subtracted visit images; in most cases this background term is actually quite small ')

backgroundName#: Name of the subtracted background, to be stored with the image when the input and output images are lsst.images.cells.CellCoadd. (str, default 'object')

coaddName#: Name of coadd (str, default 'deep')

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

detection#: Source detection (ConfigurableInstance, default <class 'lsst.meas.algorithms.dynamicDetection.DynamicDetectionConfig'>)

doScaleVariance#: Scale variance plane using empirical noise? (bool, default True)

forceExactBinning#: Check that the background bin size evenly divides the patch inner region, and crop the outer region to an integer number of bins. (bool, default False)

hasFakes#: Should be set to True if fake sources have been inserted into the input data. (bool, default False)

idGenerator#: Configuration for how to generate catalog IDs from data IDs. (SkyMapIdGeneratorConfig, default <class 'lsst.meas.base._id_generator.SkyMapIdGeneratorConfig'>)

imageType#

Which image type to use for the input and output coadd. This option only directly affects connection storage classes and hence ‘runQuantum’; the ‘run’ method behavior is determined by which type is actually passed in. (str, default 'legacy')

Allowed values:

'legacy': Read a lsst.cell_coadds.MultipleCellCoadd (if useCellCoadd) or lsst.afw.image.Exposure (if not useCellCoadd) and write an lsst.afw.image.Exposure.
'future': Read and write lsst.images.cells.CellCoadd (useCellCoadd just sets which of ‘exposure’ or ‘exposure_cells’ will be used for inputs). The ‘outputBackground’ is deleted, writeEmptyBackgrounds is ignored, and writeOnlyBackgrounds=True is invalid.

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

scaleVariance#: Variance rescaling (ConfigurableInstance, default <class 'lsst.meas.algorithms.scaleVariance.ScaleVarianceConfig'>)

useCellCoadds#: Whether to use cell coadds? (bool, default False)

writeEmptyBackgrounds#: If true, save a placeholder background with NaNs in all bins (but the right geometry) when there are no pixels to compute a background from. This can be useful if a later task combines backgrounds from multiple patches as input. (bool, default True)

writeOnlyBackgrounds#: If true, only save the background models. (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.