MeasureMergedCoaddSourcesConfig#

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

Bases: PipelineTaskConfig

Configuration parameters for the MeasureMergedCoaddSourcesTask

Attributes Summary

`applyApCorr`	Subtask to apply aperture corrections (`ConfigurableInstance`, default `<class 'lsst.meas.base.applyApCorr.ApplyApCorrConfig'>`)
`catalogCalculation`	Subtask to run catalogCalculation plugins on catalog (`ConfigurableInstance`, default `<class 'lsst.meas.base.catalogCalculation.CatalogCalculationConfig'>`)
`checkUnitsParseStrict`	Strictness of Astropy unit compatibility check, can be 'raise', 'warn' or 'silent' (`str`, default `'raise'`)
`coaddName`	Name of coadd (`str`, default `'deep'`)
`connections`	Field which refers to a dynamically added configuration class which is based on a PipelineTaskConnections class.
`doAddFootprints`	Whether or not to add footprints to the input catalog from scarlet models.
`doApCorr`	Apply aperture corrections (`bool`, default `True`)
`doConserveFlux`	Whether to use the deblender models as templates to re-distribute the flux from the 'exposure' (True), or to perform measurements on the deblender model footprints.
`doMatchSources`	Match sources to reference catalog? Deprecated: Reference matching in measureCoaddSources will be removed after v29.
`doPropagateFlags`	Whether to match sources to CCD catalogs to propagate flags (to e.g. identify PSF stars) (`bool`, default `True`).
`doRunCatalogCalculation`	Run catalogCalculation task (`bool`, default `True`)
`doStripFootprints`	Whether to strip footprints from the output catalog before saving to disk.
`doWriteMatchesDenormalized`	Write reference matches in denormalized format? This format uses more disk space, but is more convenient to read.
`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.
`inputCatalog`	The name of the input catalog.
`match`	Matching to reference catalog Deprecated: Reference matching in measureCoaddSources will be removed after v29.
`measurement`	Source measurement (`ConfigurableInstance`, default `<class 'lsst.meas.base.sfm.SingleFrameMeasurementConfig'>`)
`propagateFlags`	Propagate source flags to coadd (`ConfigurableInstance`, default `<class 'lsst.pipe.tasks.propagateSourceFlags.PropagateSourceFlagsConfig'>`)
`psfCache`	Size of psfCache (`int`, default `100`)
`refObjLoader`
`saveLogOutput`	Flag to enable/disable saving of log output for a task, enabled by default.
`setPrimaryFlags`	Set flags for primary tract/patch (`ConfigurableInstance`, default `<class 'lsst.meas.algorithms.setPrimaryFlags.SetPrimaryFlagsConfig'>`)
`useCellCoadds`	Whether to use cell coadds? (`bool`, default `False`)

Methods Summary

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

Attributes Documentation

applyApCorr#: Subtask to apply aperture corrections (ConfigurableInstance, default <class 'lsst.meas.base.applyApCorr.ApplyApCorrConfig'>)

catalogCalculation#: Subtask to run catalogCalculation plugins on catalog (ConfigurableInstance, default <class 'lsst.meas.base.catalogCalculation.CatalogCalculationConfig'>)

checkUnitsParseStrict#: Strictness of Astropy unit compatibility check, can be ‘raise’, ‘warn’ or ‘silent’ (str, default 'raise')

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.

doAddFootprints#: Whether or not to add footprints to the input catalog from scarlet models. This should be true whenever using the multi-band deblender, otherwise this should be False. (bool, default True)

doApCorr#: Apply aperture corrections (bool, default True)

doConserveFlux#: Whether to use the deblender models as templates to re-distribute the flux from the ‘exposure’ (True), or to perform measurements on the deblender model footprints. (bool, default True)

doMatchSources#: Match sources to reference catalog? Deprecated: Reference matching in measureCoaddSources will be removed after v29. (bool, default False)

doPropagateFlags#: Whether to match sources to CCD catalogs to propagate flags (to e.g. identify PSF stars) (bool, default True)

doRunCatalogCalculation#: Run catalogCalculation task (bool, default True)

doStripFootprints#: Whether to strip footprints from the output catalog before saving to disk. This is usually done when using scarlet models to save disk space. (bool, default True)

doWriteMatchesDenormalized#: Write reference matches in denormalized format? This format uses more disk space, but is more convenient to read. Deprecated: Reference matching in measureCoaddSources will be removed after v29. (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'>)

inputCatalog#

The name of the input catalog. Deprecated: Support for old deblender outputs will be removed after v29. (str, default 'deblendedCatalog')

Allowed values:

'deblendedCatalog': Output catalog from ScarletDeblendTask
'deblendedFlux': Output catalog from SourceDeblendTask
'mergeDet': The merged detections before deblending.
'None': Field is optional

match#: Matching to reference catalog Deprecated: Reference matching in measureCoaddSources will be removed after v29. (ConfigurableInstance, default <class 'lsst.meas.astrom.directMatch.DirectMatchConfig'>)

measurement#: Source measurement (ConfigurableInstance, default <class 'lsst.meas.base.sfm.SingleFrameMeasurementConfig'>)

propagateFlags#: Propagate source flags to coadd (ConfigurableInstance, default <class 'lsst.pipe.tasks.propagateSourceFlags.PropagateSourceFlagsConfig'>)

psfCache#: Size of psfCache (int, default 100)

refObjLoader#

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

setPrimaryFlags#: Set flags for primary tract/patch (ConfigurableInstance, default <class 'lsst.meas.algorithms.setPrimaryFlags.SetPrimaryFlagsConfig'>)

useCellCoadds#: Whether to use cell coadds? (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.