MergeDetectionsConfig#

class lsst.pipe.tasks.mergeDetections.MergeDetectionsConfig(*args, **kw)#

Bases: PipelineTaskConfig

Configuration parameters for the MergeDetectionsTask.

Attributes Summary

`coaddName`	Name of coadd (`str`, default `'deep'`)
`connections`	Field which refers to a dynamically added configuration class which is based on a PipelineTaskConnections class.
`cullPeaks`	Configuration for how to cull peaks.
`idGenerator`	Configuration for how to generate catalog IDs from data IDs.
`maxSamePeak`	When adding new catalogs to the merge, all peaks less than this distance (in arcsec) to an existing peak will be flagged as detected in that catalog.
`minNewPeak`	Minimum distance from closest peak to create a new one (in arcsec).
`priorityList`	Priority-ordered list of filter bands for the merge.
`saveLogOutput`	Flag to enable/disable saving of log output for a task, enabled by default.
`skyFilterName`	Name of `filter' used to label sky objects (e.g. flag merge_peak_sky is set) (N.b.
`skyObjects`	Generate sky objects (`ConfigurableInstance`, default `<class 'lsst.meas.algorithms.skyObjects.SkyObjectsConfig'>`)

Methods Summary

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

Attributes Documentation

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.

cullPeaks#: Configuration for how to cull peaks. (CullPeaksConfig, default <class 'lsst.pipe.tasks.multiBandUtils.CullPeaksConfig'>)

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

maxSamePeak#: When adding new catalogs to the merge, all peaks less than this distance (in arcsec) to an existing peak will be flagged as detected in that catalog. (float, default 0.3)

minNewPeak#: Minimum distance from closest peak to create a new one (in arcsec). (float, default 1)

priorityList#: Priority-ordered list of filter bands for the merge. (List, default [])

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

skyFilterName#: Name of filter' used to label sky objects (e.g. flag merge_peak_sky is set) (N.b. should be in MergeMeasurementsConfig.pseudoFilterList) (`str, default 'sky')

skyObjects#: Generate sky objects (ConfigurableInstance, default <class 'lsst.meas.algorithms.skyObjects.SkyObjectsConfig'>)

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.