LSST Applications  21.0.0-172-gfb10e10a+18fedfabac,22.0.0+297cba6710,22.0.0+80564b0ff1,22.0.0+8d77f4f51a,22.0.0+a28f4c53b1,22.0.0+dcf3732eb2,22.0.1-1-g7d6de66+2a20fdde0d,22.0.1-1-g8e32f31+297cba6710,22.0.1-1-geca5380+7fa3b7d9b6,22.0.1-12-g44dc1dc+2a20fdde0d,22.0.1-15-g6a90155+515f58c32b,22.0.1-16-g9282f48+790f5f2caa,22.0.1-2-g92698f7+dcf3732eb2,22.0.1-2-ga9b0f51+7fa3b7d9b6,22.0.1-2-gd1925c9+bf4f0e694f,22.0.1-24-g1ad7a390+a9625a72a8,22.0.1-25-g5bf6245+3ad8ecd50b,22.0.1-25-gb120d7b+8b5510f75f,22.0.1-27-g97737f7+2a20fdde0d,22.0.1-32-gf62ce7b1+aa4237961e,22.0.1-4-g0b3f228+2a20fdde0d,22.0.1-4-g243d05b+871c1b8305,22.0.1-4-g3a563be+32dcf1063f,22.0.1-4-g44f2e3d+9e4ab0f4fa,22.0.1-42-gca6935d93+ba5e5ca3eb,22.0.1-5-g15c806e+85460ae5f3,22.0.1-5-g58711c4+611d128589,22.0.1-5-g75bb458+99c117b92f,22.0.1-6-g1c63a23+7fa3b7d9b6,22.0.1-6-g50866e6+84ff5a128b,22.0.1-6-g8d3140d+720564cf76,22.0.1-6-gd805d02+cc5644f571,22.0.1-8-ge5750ce+85460ae5f3,master-g6e05de7fdc+babf819c66,master-g99da0e417a+8d77f4f51a,w.2021.48
LSST Data Management Base Package
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()