lsst.meas.base.apCorrRegistry Namespace Reference

Functions
	addApCorrName (name)
	getApCorrNameSet ()

Variables
	_ApCorrNameSet = set()

Detailed Description

Registry of instrument flux fields that should be aperture corrected.

Function Documentation

addApCorrName()

lsst.meas.base.apCorrRegistry.addApCorrName

(

name

)

Register an instrumental flux field name prefix for aperture correction.

Parameters
----------
name : `str`
    Field name prefix for an instrumental flux that should be aperture
    corrected.

Notes
-----
The prefix ``name`` corresponds to the fields ``name_instFlux``,
``name_instFluxErr`` and ``name_flag``. For example, specifying
``base_PsfFlux`` will select the fields ``base_PsfFlux_instFlux``,
``base_PsfFlux_instFluxErr`` and ``base_PsfFlux_flag``.

Definition at line 31 of file apCorrRegistry.py.

def addApCorrName(name):
    """Register an instrumental flux field name prefix for aperture correction.
 
    Parameters
    ----------
    name : `str`
        Field name prefix for an instrumental flux that should be aperture
        corrected.
 
    Notes
    -----
    The prefix ``name`` corresponds to the fields ``name_instFlux``,
    ``name_instFluxErr`` and ``name_flag``. For example, specifying
    ``base_PsfFlux`` will select the fields ``base_PsfFlux_instFlux``,
    ``base_PsfFlux_instFluxErr`` and ``base_PsfFlux_flag``.
    """
    global _ApCorrNameSet
    _ApCorrNameSet.add(str(name))
 
 

getApCorrNameSet()

lsst.meas.base.apCorrRegistry.getApCorrNameSet

(

)

Get a copy of the field name prefixes which will be aperture corrected.

Returns
-------
apCorrNameSet : `set`
    Field prefixes which will be aperture corrected.

Notes
-----
For example, the returned set may include ``base_PsfFlux`` and
``base_GaussianFlux``.

Definition at line 51 of file apCorrRegistry.py.

def getApCorrNameSet():
    """Get a copy of the field name prefixes which will be aperture corrected.
 
    Returns
    -------
    apCorrNameSet : `set`
        Field prefixes which will be aperture corrected.
 
    Notes
    -----
    For example, the returned set may include ``base_PsfFlux`` and
    ``base_GaussianFlux``.
    """
    global _ApCorrNameSet
    return _ApCorrNameSet.copy()

Variable Documentation

_ApCorrNameSet

lsst.meas.base.apCorrRegistry._ApCorrNameSet = set()

protected

Definition at line 28 of file apCorrRegistry.py.