lsst.meas.base.pluginRegistry.PluginMap Class Reference

Inheritance diagram for lsst.meas.base.pluginRegistry.PluginMap:

Public Member Functions
def	iter (self)
def	iterN (self)

Detailed Description

Map of plugins to be run for a given task.

Notes
-----
Plugins are classes derived from `BasePlugin`.

We assume plugins are added to the plugin map according to their
"Execution Order", so this class doesn't actually do any of the sorting
(though it does have to maintain that order, which it does by inheriting
from `collections.OrderedDict`).

Definition at line 190 of file pluginRegistry.py.

Member Function Documentation

iter()

def lsst.meas.base.pluginRegistry.PluginMap.iter

(

self

)

Return an iterator over plugins for use in single-object mode.

Notes
-----
Plugins which should be used in single-object mode are identified by
having the `doMeasure` config attribute evaluate to `True`. This is
usually a simple boolean class attribute.

Definition at line 203 of file pluginRegistry.py.

    def iter(self):
        """Return an iterator over plugins for use in single-object mode.
 
        Notes
        -----
        Plugins which should be used in single-object mode are identified by
        having the `doMeasure` config attribute evaluate to `True`. This is
        usually a simple boolean class attribute.
        """
        for plugin in self.values():
            if plugin.config.doMeasure:
                yield plugin
 

iterN()

def lsst.meas.base.pluginRegistry.PluginMap.iterN

(

self

)

Return an iterator over plugins for use in multi-object mode.

Notes
-----
Plugins which should be used in multi-object mode are identified by
having the `doMeasureN` config attribute evaluate to `True`.
This is usually a simple boolean class attribute.

Definition at line 216 of file pluginRegistry.py.

    def iterN(self):
        """Return an iterator over plugins for use in multi-object mode.
 
        Notes
        -----
        Plugins which should be used in multi-object mode are identified by
        having the `doMeasureN` config attribute evaluate to `True`.
        This is usually a simple boolean class attribute.
        """
        for plugin in self.values():
            if plugin.config.doMeasureN:
                yield plugin

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/meas_base/22.0.1-25-gb120d7b+8b5510f75f/python/lsst/meas/base/pluginRegistry.py