register

lsst.meas.base.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.