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

def 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".
    """
    name = AlgClass.__name__
    pkg = AlgClass.__module__
    name = name.replace("Algorithm", "")
    terms = pkg.split(".")
    if terms[-1].endswith("Lib"):
        terms = terms[:-1]
    if terms[0] == "lsst":
        terms = terms[1:]
    if terms[0] == "meas":
        terms = terms[1:]
    if name.lower().startswith(terms[-1].lower()):
        terms = terms[:-1]
    return "%s_%s" % ("_".join(terms), name)