LSST Applications 27.0.0,g0265f82a02+469cd937ee,g02d81e74bb+21ad69e7e1,g1470d8bcf6+cbe83ee85a,g2079a07aa2+e67c6346a6,g212a7c68fe+04a9158687,g2305ad1205+94392ce272,g295015adf3+81dd352a9d,g2bbee38e9b+469cd937ee,g337abbeb29+469cd937ee,g3939d97d7f+72a9f7b576,g487adcacf7+71499e7cba,g50ff169b8f+5929b3527e,g52b1c1532d+a6fc98d2e7,g591dd9f2cf+df404f777f,g5a732f18d5+be83d3ecdb,g64a986408d+21ad69e7e1,g858d7b2824+21ad69e7e1,g8a8a8dda67+a6fc98d2e7,g99cad8db69+f62e5b0af5,g9ddcbc5298+d4bad12328,ga1e77700b3+9c366c4306,ga8c6da7877+71e4819109,gb0e22166c9+25ba2f69a1,gb6a65358fc+469cd937ee,gbb8dafda3b+69d3c0e320,gc07e1c2157+a98bf949bb,gc120e1dc64+615ec43309,gc28159a63d+469cd937ee,gcf0d15dbbd+72a9f7b576,gdaeeff99f8+a38ce5ea23,ge6526c86ff+3a7c1ac5f1,ge79ae78c31+469cd937ee,gee10cc3b42+a6fc98d2e7,gf1cff7945b+21ad69e7e1,gfbcc870c63+9a11dc8c8f
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.