LSSTApplications  18.0.0+106,18.0.0+50,19.0.0,19.0.0+1,19.0.0+10,19.0.0+11,19.0.0+13,19.0.0+17,19.0.0+2,19.0.0-1-g20d9b18+6,19.0.0-1-g425ff20,19.0.0-1-g5549ca4,19.0.0-1-g580fafe+6,19.0.0-1-g6fe20d0+1,19.0.0-1-g7011481+9,19.0.0-1-g8c57eb9+6,19.0.0-1-gb5175dc+11,19.0.0-1-gdc0e4a7+9,19.0.0-1-ge272bc4+6,19.0.0-1-ge3aa853,19.0.0-10-g448f008b,19.0.0-12-g6990b2c,19.0.0-2-g0d9f9cd+11,19.0.0-2-g3d9e4fb2+11,19.0.0-2-g5037de4,19.0.0-2-gb96a1c4+3,19.0.0-2-gd955cfd+15,19.0.0-3-g2d13df8,19.0.0-3-g6f3c7dc,19.0.0-4-g725f80e+11,19.0.0-4-ga671dab3b+1,19.0.0-4-gad373c5+3,19.0.0-5-ga2acb9c+2,19.0.0-5-gfe96e6c+2,w.2020.01
LSSTDataManagementBasePackage
Functions
lsst.meas.base.apCorrRegistry Namespace Reference

Functions

def addApCorrName (name)
 
def getApCorrNameSet ()
 

Function Documentation

◆ addApCorrName()

def 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.

31 def addApCorrName(name):
32  """Register an instrumental flux field name prefix for aperture correction.
33 
34  Parameters
35  ----------
36  name : `str`
37  Field name prefix for an instrumental flux that should be aperture
38  corrected.
39 
40  Notes
41  -----
42  The prefix ``name`` corresponds to the fields ``name_instFlux``,
43  ``name_instFluxErr`` and ``name_flag``. For example, specifying
44  ``base_PsfFlux`` will select the fields ``base_PsfFlux_instFlux``,
45  ``base_PsfFlux_instFluxErr`` and ``base_PsfFlux_flag``.
46  """
47  global _ApCorrNameSet
48  _ApCorrNameSet.add(str(name))
49 
50 

◆ getApCorrNameSet()

def 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.

51 def getApCorrNameSet():
52  """Get a copy of the field name prefixes which will be aperture corrected.
53 
54  Returns
55  -------
56  apCorrNameSet : `set`
57  Field prefixes which will be aperture corrected.
58 
59  Notes
60  -----
61  For example, the returned set may include ``base_PsfFlux`` and
62  ``base_GaussianFlux``.
63  """
64  global _ApCorrNameSet
65  return _ApCorrNameSet.copy()
66 
Generated on Wed Jan 8 2020 09:12:33 for LSSTApplications by   doxygen 1.8.13