lsst.meas.base  14.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Macros Groups Pages
Classes | Functions | Variables
lsst.meas.base.pluginRegistry Namespace Reference

Classes

class  PluginRegistry
 Base class for plugin registries. More...
 
class  PluginMap
 Map of plugins (instances of subclasses of BasePlugin) to be run for a task. More...
 

Functions

def generateAlgorithmName
 
def register
 A Python decorator that registers a class, using the given name, in its base class's PluginRegistry. More...
 

Variables

tuple __all__ = ("generateAlgorithmName", "PluginRegistry", "register", "PluginMap")
 

Function Documentation

def lsst.meas.base.pluginRegistry.generateAlgorithmName (   AlgClass)
Generate a string name for an algorithm class that strips away terms that are generally redundant
while (hopefully) remaining easy to trace to the code.

The returned name will cobmine the package name, with any "lsst" and/or "meas" prefix removed,
with the class name, with any "Algorithm" suffix removed.  For instance,
lsst.meas.base.SdssShapeAlgorithm becomes "base_SdssShape".

Definition at line 36 of file pluginRegistry.py.

def lsst.meas.base.pluginRegistry.register (   name,
  shouldApCorr = False,
  apCorrList = () 
)

A Python decorator that registers a class, using the given name, in its base class's PluginRegistry.

For example,

1 @register("base_TransformedCentroid")
2 class ForcedTransformedCentroidPlugin(ForcedPlugin):
3  ...

is equivalent to:

1 class ForcedTransformedCentroidPlugin(ForcedPlugin):
2  ...
3 @ForcedPlugin.registry.register("base_TransformedCentroid", ForcedTransformedCentroidPlugin)

Definition at line 129 of file pluginRegistry.py.

Variable Documentation

tuple lsst.meas.base.pluginRegistry.__all__ = ("generateAlgorithmName", "PluginRegistry", "register", "PluginMap")

Definition at line 33 of file pluginRegistry.py.