BaseMeasurementConfig#

class lsst.meas.base.BaseMeasurementConfig(*args, ignoreSlotPluginChecks=False, **kwargs)#

Bases: SimpleBaseMeasurementConfig

Base configuration for all measurement driver tasks except SimpleForcedMeasurementTask.

Parameters#

ignoreSlotPluginChecksbool, optional: Do not check that all slots have an associated plugin to run when validating this config. This is primarily for tests that were written before we made Tasks always call config.validate() on init. DEPRECATED DM-35949: this is a temporary workaround while we better define how config/schema validation works for measurement tasks.

Examples#

Subclasses should define the ‘plugins’ and ‘undeblended’ registries, e.g.

plugins = PluginBaseClass.registry.makeField(
    multi=True,
    default=[],
    doc="Plugins to be run and their configuration"
)
undeblended = PluginBaseClass.registry.makeField(
    multi=True,
    default=[],
    doc="Plugins to run on undeblended image"
)

where PluginBaseClass is the appropriate base class of the plugin (e.g., SingleFramePlugin or ForcedPlugin).

Attributes Summary

`doReplaceWithNoise`	When measuring, replace other detected footprints with noise? (`bool`, default `True`)
`noiseReplacer`	configuration that sets how to replace neighboring sources with noise (`NoiseReplacerConfig`, default `<class 'lsst.meas.base.noiseReplacer.NoiseReplacerConfig'>`)
`slots`	Mapping from algorithms to special column aliases.
`undeblendedPrefix`	Prefix to give undeblended plugins (`str`, default `'undeblended_'`)

Methods Summary

validate()

Validate the Config, raising an exception if invalid.

Attributes Documentation

doReplaceWithNoise#: When measuring, replace other detected footprints with noise? (bool, default True)

noiseReplacer#: configuration that sets how to replace neighboring sources with noise (NoiseReplacerConfig, default <class 'lsst.meas.base.noiseReplacer.NoiseReplacerConfig'>)

slots#: Mapping from algorithms to special column aliases. (SourceSlotConfig, default <class 'lsst.meas.base.baseMeasurement.SourceSlotConfig'>)

undeblendedPrefix#: Prefix to give undeblended plugins (str, default 'undeblended_')

Methods Documentation

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.