lsst.meas.base.pluginRegistry Namespace Reference

Classes
class	PluginMap
class	PluginRegistry

Functions
def	generateAlgorithmName (AlgClass)
def	register (name, shouldApCorr=False, apCorrList=())

Function Documentation

generateAlgorithmName()

def lsst.meas.base.pluginRegistry.generateAlgorithmName

(

AlgClass

)

Generate a name for an algorithm.

This generates a short name for an algorithmic class that strips away
terms that are generally redundant while remaining easy to trace to the
code.

Parameters
----------
AlgClass : subclass of `BaseAlgorithm`
    The class to generate a name for.

Returns
-------
name : `str`
    A short name for the algorithm.

Notes
-----
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 name for an algorithm.

    This generates a short name for an algorithmic class that strips away
    terms that are generally redundant while remaining easy to trace to the
    code.

    Parameters
    ----------
    AlgClass : subclass of `BaseAlgorithm`
        The class to generate a name for.

    Returns
    -------
    name : `str`
        A short name for the algorithm.

    Notes
    -----
    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(".")
    # Hide private module name only if it's part of a public package
    if len(terms) > 1 and terms[-1].startswith("_"):
        terms = terms[:-1]
    if len(terms) > 1 and 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)

register()

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

A decorator to register a plugin class in its base class's registry.

Parameters
----------
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.

Definition at line 163 of file pluginRegistry.py.

def register(name, shouldApCorr=False, apCorrList=()):
    """A decorator to register a plugin class in its base class's registry.

    Parameters
    ----------
    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.

    """

    def decorate(PluginClass):
        PluginClass.registry.register(name, PluginClass, shouldApCorr=shouldApCorr, apCorrList=apCorrList)
        return PluginClass
    return decorate