lsst.meas.base g96728d7751+1961b9b6ff
Classes | Public Member Functions | List of all members
lsst.meas.base.pluginRegistry.PluginRegistry Class Reference
Inheritance diagram for lsst.meas.base.pluginRegistry.PluginRegistry:

Classes

class  Configurable
 

Public Member Functions

def register (self, name, PluginClass, shouldApCorr=False, apCorrList=())
 
def makeField (self, doc, default=None, optional=False, multi=False)
 

Detailed Description

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.

Member Function Documentation

◆ makeField()

def lsst.meas.base.pluginRegistry.PluginRegistry.makeField (   self,
  doc,
  default = None,
  optional = False,
  multi = False 
)

Definition at line 159 of file pluginRegistry.py.

◆ register()

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.


The documentation for this class was generated from the following file: