lsst.meas.base  21.0.0-10-g6ebdb75+acb2817567
Public Member Functions | Static Public Attributes | List of all members
lsst.meas.base.baseMeasurement.BaseMeasurementConfig Class Reference
Inheritance diagram for lsst.meas.base.baseMeasurement.BaseMeasurementConfig:
lsst.meas.base.forcedMeasurement.ForcedMeasurementConfig lsst.meas.base.sfm.SingleFrameMeasurementConfig

Public Member Functions

def validate (self)
 

Static Public Attributes

 slots
 
 doReplaceWithNoise
 
 noiseReplacer
 
 undeblendedPrefix
 

Detailed Description

Base configuration for all measurement driver 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 137 of file baseMeasurement.py.

Member Function Documentation

◆ validate()

def lsst.meas.base.baseMeasurement.BaseMeasurementConfig.validate (   self)

Definition at line 179 of file baseMeasurement.py.

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 166 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 170 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 161 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 174 of file baseMeasurement.py.


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