LSST Applications g042eb84c57+730a74494b,g04e9c324dd+8c5ae1fdc5,g134cb467dc+1f1e3e7524,g199a45376c+0ba108daf9,g1fd858c14a+fa7d31856b,g210f2d0738+f66ac109ec,g262e1987ae+83a3acc0e5,g29ae962dfc+d856a2cb1f,g2cef7863aa+aef1011c0b,g35bb328faa+8c5ae1fdc5,g3fd5ace14f+a1e0c9f713,g47891489e3+0d594cb711,g4d44eb3520+c57ec8f3ed,g4d7b6aa1c5+f66ac109ec,g53246c7159+8c5ae1fdc5,g56a1a4eaf3+fd7ad03fde,g64539dfbff+f66ac109ec,g67b6fd64d1+0d594cb711,g67fd3c3899+f66ac109ec,g6985122a63+0d594cb711,g74acd417e5+3098891321,g786e29fd12+668abc6043,g81db2e9a8d+98e2ab9f28,g87389fa792+8856018cbb,g89139ef638+0d594cb711,g8d7436a09f+80fda9ce03,g8ea07a8fe4+760ca7c3fc,g90f42f885a+033b1d468d,g97be763408+a8a29bda4b,g99822b682c+e3ec3c61f9,g9d5c6a246b+0d5dac0c3d,ga41d0fce20+9243b26dd2,gbf99507273+8c5ae1fdc5,gd7ef33dd92+0d594cb711,gdab6d2f7ff+3098891321,ge410e46f29+0d594cb711,geaed405ab2+c4bbc419c6,gf9a733ac38+8c5ae1fdc5,w.2025.38
LSST Data Management Base Package
|
Classes | |
class | PluginMap |
class | PluginRegistry |
Functions | |
generateAlgorithmName (AlgClass) | |
register (name, shouldApCorr=False, apCorrList=()) | |
Registry for measurement plugins and utilities for plugin management.
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.
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.