LSST Applications g0265f82a02+0e5473021a,g02d81e74bb+f5613e8b4f,g1470d8bcf6+190ad2ba91,g14a832a312+311607e4ab,g2079a07aa2+86d27d4dc4,g2305ad1205+a8e3196225,g295015adf3+b67ee847e5,g2bbee38e9b+0e5473021a,g337abbeb29+0e5473021a,g3ddfee87b4+a761f810f3,g487adcacf7+17c8fdbcbd,g50ff169b8f+96c6868917,g52b1c1532d+585e252eca,g591dd9f2cf+65b5bd823e,g5a732f18d5+53520f316c,g64a986408d+f5613e8b4f,g6c1bc301e9+51106c2951,g858d7b2824+f5613e8b4f,g8a8a8dda67+585e252eca,g99cad8db69+6729933424,g9ddcbc5298+9a081db1e4,ga1e77700b3+15fc3df1f7,ga8c6da7877+ef4e3a5875,gb0e22166c9+60f28cb32d,gb6a65358fc+0e5473021a,gba4ed39666+c2a2e4ac27,gbb8dafda3b+e9bba80f27,gc120e1dc64+eee469a5e5,gc28159a63d+0e5473021a,gcf0d15dbbd+a761f810f3,gdaeeff99f8+f9a426f77a,ge6526c86ff+d4c1d4bfef,ge79ae78c31+0e5473021a,gee10cc3b42+585e252eca,gf1cff7945b+f5613e8b4f,w.2024.16
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.