LSST Applications g044012fb7c+304891ab8a,g04a91732dc+4e1b87f259,g07dc498a13+f701f15b83,g114c6a66ad+c7887c1284,g1409bbee79+f701f15b83,g1a7e361dbc+f701f15b83,g1fd858c14a+6ebd102b59,g35bb328faa+0eb18584fe,g3bd4b5ce2c+e83bf4edc8,g4e0f332c67+976ceb6bc8,g53246c7159+0eb18584fe,g5477a8d5ce+51234355ef,g60b5630c4e+c7887c1284,g623d845a50+c7887c1284,g6f0c2978f1+98123c34b6,g71fabbc107+c7887c1284,g75b6c65c88+ce466f4385,g78460c75b0+85633614c8,g786e29fd12+02b9b86fc9,g8852436030+cfe5cf5b7b,g89139ef638+f701f15b83,g9125e01d80+0eb18584fe,g95236ca021+d4f98599f0,g974caa22f6+0eb18584fe,g989de1cb63+f701f15b83,g9f33ca652e+b4908f5dcd,gaaedd4e678+f701f15b83,gabe3b4be73+543c3c03c9,gace736f484+07e57cea59,gb1101e3267+487fd1b06d,gb58c049af0+492386d360,gc99c83e5f0+a513197d39,gcf25f946ba+cfe5cf5b7b,gd0fa69b896+babbe6e5fe,gd6cbbdb0b4+3fef02d88a,gde0f65d7ad+e8379653a2,ge278dab8ac+ae64226a64,gfba249425e+0eb18584fe,w.2025.07
LSST Data Management Base Package
|
Classes | |
class | Configurable |
Public Member Functions | |
register (self, name, PluginClass, shouldApCorr=False, apCorrList=()) | |
makeField (self, doc, default=None, optional=False, multi=False) | |
Base class for plugin registries. Notes ----- The class of plugins allowed in the registry is defined in the constructor of the registry. Single-frame and forced plugins have different registries.
Definition at line 76 of file pluginRegistry.py.
lsst.meas.base.pluginRegistry.PluginRegistry.makeField | ( | self, | |
doc, | |||
default = None, | |||
optional = False, | |||
multi = False ) |
Create a `RegistryField` configuration field from this registry. Parameters ---------- doc : `str` A description of the field. default : object, optional The default target for the field. optional : `bool`, optional When `False`, `lsst.pex.config.Config.validate` fails if the field's value is `None`. multi : `bool`, optional A flag to allow multiple selections in the `RegistryField` if `True`. on_none : `Callable`, optional A callable that should be invoked when ``apply`` is called but the selected name or names is `None`. Will be passed the field attribute proxy (`RegistryInstanceDict`) and then all positional and keyword arguments passed to ``apply``. Returns ------- field : `lsst.pex.config.RegistryField` `~lsst.pex.config.RegistryField` Configuration field.
Reimplemented from lsst.pex.config.registry.Registry.
Definition at line 159 of file pluginRegistry.py.
lsst.meas.base.pluginRegistry.PluginRegistry.register | ( | self, | |
name, | |||
PluginClass, | |||
shouldApCorr = False, | |||
apCorrList = () ) |
Register a plugin class with the given name. Parameters ---------- name : `str` The name of the plugin. This is used as a prefix for all fields produced by the plugin, and it should generally contain the name of the plugin or algorithm class itself as well as enough of the namespace to make it clear where to find the code. For example ``base_GaussianFlux`` indicates an algorithm in `lsst.meas.base` that measures Gaussian Flux and produces fields such as ``base_GaussianFlux_instFlux``, ``base_GaussianFlux_instFluxErr`` and ``base_GaussianFlux_flag``. 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. Notes ----- The same plugin may be registered multiple times with different names; this can be useful if we often want to run it multiple times with different configuration.
Reimplemented from lsst.pex.config.registry.Registry.
Definition at line 118 of file pluginRegistry.py.