apCorrRegistry.py
Go to the documentation of this file.
1 # This file is part of meas_base.
2 #
3 # Developed for the LSST Data Management System.
4 # This product includes software developed by the LSST Project
5 # (https://www.lsst.org).
6 # See the COPYRIGHT file at the top-level directory of this distribution
7 # for details of code ownership.
8 #
9 # This program is free software: you can redistribute it and/or modify
11 # the Free Software Foundation, either version 3 of the License, or
12 # (at your option) any later version.
13 #
14 # This program is distributed in the hope that it will be useful,
15 # but WITHOUT ANY WARRANTY; without even the implied warranty of
16 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 # GNU General Public License for more details.
18 #
19 # You should have received a copy of the GNU General Public License
20 # along with this program. If not, see <https://www.gnu.org/licenses/>.
21
22 """Registry of instrument flux fields that should be aperture corrected.
23 """
24
26
27 # Set of names of algorithms that measure instrument flux that can be aperture corrected
28 _ApCorrNameSet = set()
29
30
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
49
50
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()
daf::base::PropertySet * set
Definition: fits.cc:912