lsst.meas.base  14.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Macros Groups Pages
Public Member Functions | Static Public Attributes | List of all members
lsst.meas.base.baseMeasurement.BaseMeasurementConfig Class Reference

Base config class for all measurement driver tasks. More...

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

Public Member Functions

def validate
 

Static Public Attributes

tuple slots
 
tuple doReplaceWithNoise
 
tuple noiseReplacer
 
tuple undeblendedPrefix
 

Detailed Description

Base config class for all measurement driver tasks.

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

Definition at line 116 of file baseMeasurement.py.

Member Function Documentation

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

Definition at line 155 of file baseMeasurement.py.

Member Data Documentation

tuple lsst.meas.base.baseMeasurement.BaseMeasurementConfig.doReplaceWithNoise
static
Initial value:
1 = lsst.pex.config.Field(
2  dtype=bool, default=True, optional=False,
3  doc='When measuring, replace other detected footprints with noise?')

Definition at line 142 of file baseMeasurement.py.

tuple lsst.meas.base.baseMeasurement.BaseMeasurementConfig.noiseReplacer
static
Initial value:
1 = lsst.pex.config.ConfigField(
2  dtype=NoiseReplacerConfig,
3  doc="configuration that sets how to replace neighboring sources with noise"
4  )

Definition at line 146 of file baseMeasurement.py.

tuple lsst.meas.base.baseMeasurement.BaseMeasurementConfig.slots
static
Initial value:
1 = lsst.pex.config.ConfigField(
2  dtype=SourceSlotConfig,
3  doc="Mapping from algorithms to special aliases in Source."
4  )

Definition at line 137 of file baseMeasurement.py.

tuple lsst.meas.base.baseMeasurement.BaseMeasurementConfig.undeblendedPrefix
static
Initial value:
1 = lsst.pex.config.Field(
2  dtype=str, default="undeblended_",
3  doc="Prefix to give undeblended plugins"
4  )

Definition at line 150 of file baseMeasurement.py.


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