LSST Applications
21.0.0-172-gfb10e10a+18fedfabac,22.0.0+297cba6710,22.0.0+80564b0ff1,22.0.0+8d77f4f51a,22.0.0+a28f4c53b1,22.0.0+dcf3732eb2,22.0.1-1-g7d6de66+2a20fdde0d,22.0.1-1-g8e32f31+297cba6710,22.0.1-1-geca5380+7fa3b7d9b6,22.0.1-12-g44dc1dc+2a20fdde0d,22.0.1-15-g6a90155+515f58c32b,22.0.1-16-g9282f48+790f5f2caa,22.0.1-2-g92698f7+dcf3732eb2,22.0.1-2-ga9b0f51+7fa3b7d9b6,22.0.1-2-gd1925c9+bf4f0e694f,22.0.1-24-g1ad7a390+a9625a72a8,22.0.1-25-g5bf6245+3ad8ecd50b,22.0.1-25-gb120d7b+8b5510f75f,22.0.1-27-g97737f7+2a20fdde0d,22.0.1-32-gf62ce7b1+aa4237961e,22.0.1-4-g0b3f228+2a20fdde0d,22.0.1-4-g243d05b+871c1b8305,22.0.1-4-g3a563be+32dcf1063f,22.0.1-4-g44f2e3d+9e4ab0f4fa,22.0.1-42-gca6935d93+ba5e5ca3eb,22.0.1-5-g15c806e+85460ae5f3,22.0.1-5-g58711c4+611d128589,22.0.1-5-g75bb458+99c117b92f,22.0.1-6-g1c63a23+7fa3b7d9b6,22.0.1-6-g50866e6+84ff5a128b,22.0.1-6-g8d3140d+720564cf76,22.0.1-6-gd805d02+cc5644f571,22.0.1-8-ge5750ce+85460ae5f3,master-g6e05de7fdc+babf819c66,master-g99da0e417a+8d77f4f51a,w.2021.48
LSST Data Management Base Package
|
Classes | |
class | Configurable |
Public Member Functions | |
def | register (self, name, PluginClass, shouldApCorr=False, apCorrList=()) |
def | makeField (self, doc, default=None, optional=False, multi=False) |
def | register (self, name, target, ConfigClass=None) |
def | __getitem__ (self, key) |
def | __len__ (self) |
def | __iter__ (self) |
def | __contains__ (self, key) |
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.
|
inherited |
Definition at line 172 of file registry.py.
|
inherited |
Definition at line 163 of file registry.py.
|
inherited |
Definition at line 169 of file registry.py.
|
inherited |
Definition at line 166 of file registry.py.
def 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`. 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.
def 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.
Definition at line 118 of file pluginRegistry.py.
|
inherited |
Add a new configurable target to the registry. Parameters ---------- name : `str` Name that the ``target`` is registered under. The target can be accessed later with `dict`-like patterns using ``name`` as the key. target : obj A configurable type, usually a subclass of `lsst.pipe.base.Task`. ConfigClass : `lsst.pex.config.Config`-type, optional A subclass of `lsst.pex.config.Config` used to configure the configurable. If `None` then the configurable's ``ConfigClass`` attribute is used. Raises ------ RuntimeError Raised if an item with ``name`` is already in the registry. AttributeError Raised if ``ConfigClass`` is `None` and ``target`` does not have a ``ConfigClass`` attribute. Notes ----- If ``ConfigClass`` is provided then the ``target`` configurable is wrapped in a new object that forwards function calls to it. Otherwise the original ``target`` is stored.
Definition at line 122 of file registry.py.