lsst.meas.base  16.0-6-g4a515f9+3
Classes | Functions
lsst.meas.base.pluginRegistry Namespace Reference

Classes

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

Functions

def generateAlgorithmName (AlgClass)
 
def register (name, shouldApCorr=False, apCorrList=())
 A Python decorator that registers a class, using the given name, in its base class's PluginRegistry. More...
 

Function Documentation

◆ generateAlgorithmName()

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 34 of file pluginRegistry.py.

◆ register()

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,

@register("base_TransformedCentroid")
class ForcedTransformedCentroidPlugin(ForcedPlugin):
...

is equivalent to:

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

Definition at line 127 of file pluginRegistry.py.