LSSTApplications
17.0+11,17.0+34,17.0+56,17.0+57,17.0+59,17.0+7,17.0-1-g377950a+33,17.0.1-1-g114240f+2,17.0.1-1-g4d4fbc4+28,17.0.1-1-g55520dc+49,17.0.1-1-g5f4ed7e+52,17.0.1-1-g6dd7d69+17,17.0.1-1-g8de6c91+11,17.0.1-1-gb9095d2+7,17.0.1-1-ge9fec5e+5,17.0.1-1-gf4e0155+55,17.0.1-1-gfc65f5f+50,17.0.1-1-gfc6fb1f+20,17.0.1-10-g87f9f3f+1,17.0.1-11-ge9de802+16,17.0.1-16-ga14f7d5c+4,17.0.1-17-gc79d625+1,17.0.1-17-gdae4c4a+8,17.0.1-2-g26618f5+29,17.0.1-2-g54f2ebc+9,17.0.1-2-gf403422+1,17.0.1-20-g2ca2f74+6,17.0.1-23-gf3eadeb7+1,17.0.1-3-g7e86b59+39,17.0.1-3-gb5ca14a,17.0.1-3-gd08d533+40,17.0.1-30-g596af8797,17.0.1-4-g59d126d+4,17.0.1-4-gc69c472+5,17.0.1-6-g5afd9b9+4,17.0.1-7-g35889ee+1,17.0.1-7-gc7c8782+18,17.0.1-9-gc4bbfb2+3,w.2019.22
LSSTDataManagementBasePackage
|
Classes | |
class | PluginMap |
class | PluginRegistry |
Functions | |
def | generateAlgorithmName (AlgClass) |
def | register (name, shouldApCorr=False, apCorrList=()) |
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 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.