LSSTApplications  17.0+124,17.0+14,17.0+73,18.0.0+37,18.0.0+80,18.0.0-4-g68ffd23+4,18.1.0-1-g0001055+12,18.1.0-1-g03d53ef+5,18.1.0-1-g1349e88+55,18.1.0-1-g2505f39+44,18.1.0-1-g5315e5e+4,18.1.0-1-g5e4b7ea+14,18.1.0-1-g7e8fceb+4,18.1.0-1-g85f8cd4+48,18.1.0-1-g8ff0b9f+4,18.1.0-1-ga2c679d+1,18.1.0-1-gd55f500+35,18.1.0-10-gb58edde+2,18.1.0-11-g0997b02+4,18.1.0-13-gfe4edf0b+12,18.1.0-14-g259bd21+21,18.1.0-19-gdb69f3f+2,18.1.0-2-g5f9922c+24,18.1.0-2-gd3b74e5+11,18.1.0-2-gfbf3545+32,18.1.0-26-g728bddb4+5,18.1.0-27-g6ff7ca9+2,18.1.0-3-g52aa583+25,18.1.0-3-g8ea57af+9,18.1.0-3-gb69f684+42,18.1.0-3-gfcaddf3+6,18.1.0-32-gd8786685a,18.1.0-4-gf3f9b77+6,18.1.0-5-g1dd662b+2,18.1.0-5-g6dbcb01+41,18.1.0-6-gae77429+3,18.1.0-7-g9d75d83+9,18.1.0-7-gae09a6d+30,18.1.0-9-gc381ef5+4,w.2019.45
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 Nov 16 2019 09:15:43 for LSSTApplications by   doxygen 1.8.13