lsst.meas.base.baseMeasurement.BaseMeasurementConfig Class Reference

Inheritance diagram for lsst.meas.base.baseMeasurement.BaseMeasurementConfig:

Public Member Functions
	__new__ (cls, *args, ignoreSlotPluginChecks=False, **kwargs)
	validate (self)

Static Public Attributes
	slots
	doReplaceWithNoise
	noiseReplacer
	undeblendedPrefix

Detailed Description

Base configuration for all measurement driver tasks.

Parameters
----------
ignoreSlotPluginChecks : `bool`, 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.

.. code-block:: py

    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`).

Definition at line 140 of file baseMeasurement.py.

Member Function Documentation

__new__()

lsst.meas.base.baseMeasurement.BaseMeasurementConfig.__new__	(		cls,
		*	args,
			kw = False,
		**	kwargs )

Allocate a new `lsst.pex.config.Config` object.

In order to ensure that all Config object are always in a proper state
when handed to users or to derived `~lsst.pex.config.Config` classes,
some attributes are handled at allocation time rather than at
initialization.

This ensures that even if a derived `~lsst.pex.config.Config` class
implements ``__init__``, its author does not need to be concerned about
when or even the base ``Config.__init__`` should be called.

Reimplemented from lsst.pex.config.config.Config.

Definition at line 172 of file baseMeasurement.py.

    def __new__(cls, *args, ignoreSlotPluginChecks=False, **kwargs):
        instance = super().__new__(cls, *args, **kwargs)
        if ignoreSlotPluginChecks:
            msg = ("ignoreSlotPluginChecks is deprecated and should only be used in tests."
                   " No removal date has been set; see DM-35949.")
            warnings.warn(msg, category=FutureWarning, stacklevel=2)
        object.__setattr__(instance, "_ignoreSlotPluginChecks", ignoreSlotPluginChecks)
        return instance
 

validate()

lsst.meas.base.baseMeasurement.BaseMeasurementConfig.validate

(

self

)

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 `~lsst.pex.config.Field.validate` methods.

Complex single-field validation can be defined by deriving new Field
types. For convenience, some derived `lsst.pex.config.Field`-types
(`~lsst.pex.config.ConfigField` and
`~lsst.pex.config.ConfigChoiceField`) are defined in
``lsst.pex.config`` that handle recursing into subconfigs.

Inter-field relationships should only be checked in derived
`~lsst.pex.config.Config` classes after calling this method, and base
validation is complete.

Reimplemented from lsst.pex.config.config.Config.

Definition at line 199 of file baseMeasurement.py.

    def validate(self):
        super().validate()
        if self._ignoreSlotPluginChecks:
            return
        if self.slots.centroid is not None and self.slots.centroid not in self.plugins.names:
            raise lsst.pex.config.FieldValidationError(
                self.__class__.slots,
                self,
                "source centroid slot algorithm is not being run."
            )
        if self.slots.shape is not None and self.slots.shape not in self.plugins.names:
            raise lsst.pex.config.FieldValidationError(
                self.__class__.slots,
                self,
                "source shape slot algorithm '%s' is not being run." % self.slots.shape
            )
        for slot in (self.slots.psfFlux, self.slots.apFlux, self.slots.modelFlux,
                     self.slots.gaussianFlux, self.slots.calibFlux):
            if slot is not None:
                for name in self.plugins.names:
                    if len(name) <= len(slot) and name == slot[:len(name)]:
                        break
                else:
                    raise lsst.pex.config.FieldValidationError(
                        self.__class__.slots,
                        self,
                        f"Source instFlux algorithm '{slot}' is not being run, required from "
                        f"non-None slots in: {self.slots}."
                    )
 
 

Member Data Documentation

doReplaceWithNoise

lsst.meas.base.baseMeasurement.BaseMeasurementConfig.doReplaceWithNoise

static

Initial value:

=  lsst.pex.config.Field(
        dtype=bool, default=True, optional=False,
        doc='When measuring, replace other detected footprints with noise?')

Definition at line 186 of file baseMeasurement.py.

noiseReplacer

lsst.meas.base.baseMeasurement.BaseMeasurementConfig.noiseReplacer

static

Initial value:

=  lsst.pex.config.ConfigField(
        dtype=NoiseReplacerConfig,
        doc="configuration that sets how to replace neighboring sources with noise"
    )

Definition at line 190 of file baseMeasurement.py.

slots

lsst.meas.base.baseMeasurement.BaseMeasurementConfig.slots

static

Initial value:

=  lsst.pex.config.ConfigField(
        dtype=SourceSlotConfig,
        doc="Mapping from algorithms to special aliases in Source."
    )

Definition at line 181 of file baseMeasurement.py.

undeblendedPrefix

lsst.meas.base.baseMeasurement.BaseMeasurementConfig.undeblendedPrefix

static

Initial value:

=  lsst.pex.config.Field(
        dtype=str, default="undeblended_",
        doc="Prefix to give undeblended plugins"
    )

Definition at line 194 of file baseMeasurement.py.

---

The documentation for this class was generated from the following file:

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-9.0.0/Linux64/meas_base/g217e2c1bcf+12e87a5bd8/python/lsst/meas/base/baseMeasurement.py