lsst.meas.base.apCorrRegistry Namespace Reference

Functions
def	addApCorrName
	Add to the set of field name prefixes for fluxes that should be aperture corrected. More...
def	getApCorrNameSet
	Return a copy of the set of field name prefixes for fluxes that should be aperture corrected. More...

Variables
tuple	__all__ = ("addApCorrName", "getApCorrNameSet")
tuple	_ApCorrNameSet = set()

Function Documentation

def lsst.meas.base.apCorrRegistry.addApCorrName

(

name

)

Add to the set of field name prefixes for fluxes that should be aperture corrected.

Parameters

[in]

name

field name prefix for a flux that should be aperture corrected. The corresponding field names are {name}_flux, {name}_fluxSigma and {name}_flag. For example name "base_PsfFlux" corresponds to fields base_PsfFlux_flux, base_PsfFlux_fluxSigma and base_PsfFlux_flag.

Definition at line 31 of file apCorrRegistry.py.

def addApCorrName(name):
    """!Add to the set of field name prefixes for fluxes that should be aperture corrected

    @param[in] name  field name prefix for a flux that should be aperture corrected.
        The corresponding field names are {name}_flux, {name}_fluxSigma and {name}_flag.
        For example name "base_PsfFlux" corresponds to fields base_PsfFlux_flux,
        base_PsfFlux_fluxSigma and base_PsfFlux_flag.
    """
    global _ApCorrNameSet
    _ApCorrNameSet.add(str(name))