lsst.meas.base.pluginRegistry.PluginRegistry Class Reference

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

Classes
class	Configurable

Public Member Functions
	register (self, name, PluginClass, shouldApCorr=False, apCorrList=())
	makeField (self, doc, default=None, optional=False, multi=False)
	__getitem__ (self, key)
	__len__ (self)
	__iter__ (self)
	__contains__ (self, key)

Protected Attributes
	_configBaseType = configBaseType
dict	_dict = {}

Detailed Description

Base class for plugin registries.

Notes
-----
The class of plugins allowed in the registry is defined in the constructor
of the registry.

Single-frame and forced plugins have different registries.

Definition at line 76 of file pluginRegistry.py.

Member Function Documentation

__contains__()

lsst.pex.config.registry.Registry.__contains__ ( self, key )

inherited

Definition at line 181 of file registry.py.

    def __contains__(self, key):
        return key in self._dict
 

__getitem__()

lsst.pex.config.registry.Registry.__getitem__ ( self, key )

inherited

Definition at line 172 of file registry.py.

    def __getitem__(self, key):
        return self._dict[key]
 

__iter__()

lsst.pex.config.registry.Registry.__iter__ ( self )

inherited

Definition at line 178 of file registry.py.

    def __iter__(self):
        return iter(self._dict)
 

__len__()

lsst.pex.config.registry.Registry.__len__ ( self )

inherited

Definition at line 175 of file registry.py.

    def __len__(self):
        return len(self._dict)
 

makeField()

lsst.meas.base.pluginRegistry.PluginRegistry.makeField	(		self,
			doc,
			default = None,
			optional = False,
			multi = False )

Create a `RegistryField` configuration field from this registry.

Parameters
----------
doc : `str`
    A description of the field.
default : object, optional
    The default target for the field.
optional : `bool`, optional
    When `False`, `lsst.pex.config.Config.validate` fails if the
    field's value is `None`.
multi : `bool`, optional
    A flag to allow multiple selections in the `RegistryField` if
    `True`.
on_none : `Callable`, optional
    A callable that should be invoked when ``apply`` is called but the
    selected name or names is `None`.  Will be passed the field
    attribute proxy (`RegistryInstanceDict`) and then all positional
    and keyword arguments passed to ``apply``.

Returns
-------
field : `lsst.pex.config.RegistryField`
    `~lsst.pex.config.RegistryField` Configuration field.

Reimplemented from lsst.pex.config.registry.Registry.

Definition at line 159 of file pluginRegistry.py.

    def makeField(self, doc, default=None, optional=False, multi=False):
        return lsst.pex.config.RegistryField(doc, self, default, optional, multi)
 
 

register()

lsst.meas.base.pluginRegistry.PluginRegistry.register	(		self,
			name,
			PluginClass,
			shouldApCorr = False,
			apCorrList = () )

Register a plugin class with the given name.

Parameters
----------
name : `str`
    The name of the plugin. This is used as a prefix for all fields
    produced by the plugin, and it should generally contain the name
    of the plugin or algorithm class itself as well as enough of the
    namespace to make it clear where to find the code.  For example
    ``base_GaussianFlux`` indicates an algorithm in `lsst.meas.base`
    that measures Gaussian Flux and produces fields such as
    ``base_GaussianFlux_instFlux``, ``base_GaussianFlux_instFluxErr``
    and ``base_GaussianFlux_flag``.
shouldApCorr : `bool`
    If `True`, then this algorithm measures an instFlux that should
    be aperture corrected. This is shorthand for ``apCorrList=[name]``
    and is ignored if ``apCorrList`` is specified.
apCorrList : `list` of `str`
    List of field name prefixes for instFlux fields to be aperture
    corrected.  If an algorithm produces a single instFlux that should
    be aperture corrected then it is simpler to set
    ``shouldApCorr=True``. But if an algorithm produces multiple such
    fields then it must specify ``apCorrList`` instead. For example,
    ``modelfit_CModel`` produces three such fields:
    ``apCorrList=("modelfit_CModel_exp", "modelfit_CModel_exp",
    "modelfit_CModel_def")``. If ``apCorrList`` is not empty then
    shouldApCorr is ignored.

Notes
-----
The same plugin may be registered multiple times with different names;
this can be useful if we often want to run it multiple times with
different configuration.

Reimplemented from lsst.pex.config.registry.Registry.

Definition at line 118 of file pluginRegistry.py.

    def register(self, name, PluginClass, shouldApCorr=False, apCorrList=()):
        """Register a plugin class with the given name.
 
        Parameters
        ----------
        name : `str`
            The name of the plugin. This is used as a prefix for all fields
            produced by the plugin, and it should generally contain the name
            of the plugin or algorithm class itself as well as enough of the
            namespace to make it clear where to find the code.  For example
            ``base_GaussianFlux`` indicates an algorithm in `lsst.meas.base`
            that measures Gaussian Flux and produces fields such as
            ``base_GaussianFlux_instFlux``, ``base_GaussianFlux_instFluxErr``
            and ``base_GaussianFlux_flag``.
        shouldApCorr : `bool`
            If `True`, then this algorithm measures an instFlux that should
            be aperture corrected. This is shorthand for ``apCorrList=[name]``
            and is ignored if ``apCorrList`` is specified.
        apCorrList : `list` of `str`
            List of field name prefixes for instFlux fields to be aperture
            corrected.  If an algorithm produces a single instFlux that should
            be aperture corrected then it is simpler to set
            ``shouldApCorr=True``. But if an algorithm produces multiple such
            fields then it must specify ``apCorrList`` instead. For example,
            ``modelfit_CModel`` produces three such fields:
            ``apCorrList=("modelfit_CModel_exp", "modelfit_CModel_exp",
            "modelfit_CModel_def")``. If ``apCorrList`` is not empty then
            shouldApCorr is ignored.
 
        Notes
        -----
        The same plugin may be registered multiple times with different names;
        this can be useful if we often want to run it multiple times with
        different configuration.
        """
        lsst.pex.config.Registry.register(self, name, self.Configurable(name, PluginClass))
        if shouldApCorr and not apCorrList:
            apCorrList = [name]
        for prefix in apCorrList:
            addApCorrName(prefix)
 

Member Data Documentation

_configBaseType

lsst.pex.config.registry.Registry._configBaseType = configBaseType

protectedinherited

Definition at line 126 of file registry.py.

_dict

lsst.pex.config.registry.Registry._dict = {}

protectedinherited

Definition at line 127 of file registry.py.

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-12.1.0/Linux/meas_base/g3e17d7035e+5b3adc59f5/python/lsst/meas/base/pluginRegistry.py