lsst.meas.base g467e8eeb70+e16b79cb66
Loading...
Searching...
No Matches
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 __new__ (cls, *args, ignoreSlotPluginChecks=False, **kwargs)
 
def 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 139 of file baseMeasurement.py.

Member Function Documentation

◆ __new__()

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

Definition at line 171 of file baseMeasurement.py.

◆ validate()

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

Definition at line 198 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 185 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 189 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 180 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 193 of file baseMeasurement.py.


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