LSSTApplications  17.0+11,17.0+34,17.0+56,17.0+57,17.0+59,17.0+7,17.0-1-g377950a+33,17.0.1-1-g114240f+2,17.0.1-1-g4d4fbc4+28,17.0.1-1-g55520dc+49,17.0.1-1-g5f4ed7e+52,17.0.1-1-g6dd7d69+17,17.0.1-1-g8de6c91+11,17.0.1-1-gb9095d2+7,17.0.1-1-ge9fec5e+5,17.0.1-1-gf4e0155+55,17.0.1-1-gfc65f5f+50,17.0.1-1-gfc6fb1f+20,17.0.1-10-g87f9f3f+1,17.0.1-11-ge9de802+16,17.0.1-16-ga14f7d5c+4,17.0.1-17-gc79d625+1,17.0.1-17-gdae4c4a+8,17.0.1-2-g26618f5+29,17.0.1-2-g54f2ebc+9,17.0.1-2-gf403422+1,17.0.1-20-g2ca2f74+6,17.0.1-23-gf3eadeb7+1,17.0.1-3-g7e86b59+39,17.0.1-3-gb5ca14a,17.0.1-3-gd08d533+40,17.0.1-30-g596af8797,17.0.1-4-g59d126d+4,17.0.1-4-gc69c472+5,17.0.1-6-g5afd9b9+4,17.0.1-7-g35889ee+1,17.0.1-7-gc7c8782+18,17.0.1-9-gc4bbfb2+3,w.2019.22
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 Sat Jun 8 2019 08:10:14 for LSSTApplications by   doxygen 1.8.13