lsst.meas.base  16.0-12-g5ad1ebf+2
Classes | Public Member Functions | List of all members
lsst.meas.base.pluginRegistry.PluginRegistry Class Reference

Base class for plugin registries. More...

Inheritance diagram for lsst.meas.base.pluginRegistry.PluginRegistry:

Classes

class  Configurable
 Class used as the actual element in the registry. More...
 

Public Member Functions

def register (self, name, PluginClass, shouldApCorr=False, apCorrList=())
 Register a Plugin class with the given name. More...
 
def makeField (self, doc, default=None, optional=False, multi=False)
 

Detailed Description

Base class for plugin registries.

The Plugin class allowed in the registry is defined in the ctor of the registry.

Single-frame and forced plugins have different registries.

Definition at line 60 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 123 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.

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.

Parameters
[in]namename of plugin class. 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 meas_base that measures Gaussian Flux and produces fields such as "base_GaussianFlux_flux", "base_GaussianFlux_fluxErr" and "base_GaussianFlux_flag".
[in]shouldApCorrif True then this algorithm measures a flux that should be aperture corrected. This is shorthand for apCorrList=[name] and is ignored if apCorrList is specified.
[in]apCorrListlist of field name prefixes for flux fields that should be aperture corrected. If an algorithm produces a single flux 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 3 such fields: apCorrList=("modelfit_CModel_exp", "modelfit_CModel_exp", "modelfit_CModel_def") If apCorrList is non-empty then shouldApCorr is ignored.

Definition at line 95 of file pluginRegistry.py.


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