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
	doReplaceWithNoise
	noiseReplacer
	undeblendedPrefix
	slots

Protected Attributes
	_ignoreSlotPluginChecks

Detailed Description

Base configuration for all measurement driver tasks except
SimpleForcedMeasurementTask.

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 176 of file baseMeasurement.py.

Member Function Documentation

__new__()

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

Definition at line 209 of file baseMeasurement.py.

validate()

lsst.meas.base.baseMeasurement.BaseMeasurementConfig.validate

(

self

)

Reimplemented from lsst.meas.base.baseMeasurement.SimpleBaseMeasurementConfig.

Definition at line 231 of file baseMeasurement.py.

Member Data Documentation

_ignoreSlotPluginChecks

lsst.meas.base.baseMeasurement.BaseMeasurementConfig._ignoreSlotPluginChecks

protected

Definition at line 232 of file baseMeasurement.py.

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 218 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 222 of file baseMeasurement.py.

slots

lsst.meas.base.baseMeasurement.SimpleBaseMeasurementConfig.slots

staticinherited

Initial value:

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

Definition at line 142 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 226 of file baseMeasurement.py.

---

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

• python/lsst/meas/base/baseMeasurement.py