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.
31def 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 _ApCorrNameSet.add(str(name))
48
49
◆ 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 50 of file apCorrRegistry.py.
50def getApCorrNameSet():
51 """Get a copy of the field name prefixes which will be aperture corrected.
52
53 Returns
54 -------
55 apCorrNameSet : `set`
56 Field prefixes which will be aperture corrected.
57
58 Notes
59 -----
60 For example, the returned set may include ``base_PsfFlux`` and
61 ``base_GaussianFlux``.
62 """
63 return _ApCorrNameSet.copy()
Variable Documentation
◆ _ApCorrNameSet
|
protected |
Definition at line 28 of file apCorrRegistry.py.
Generated on Thu Nov 27 2025 09:15:18 for LSST Applications by
1.13.2