22"""Registry of instrument flux fields that should be aperture corrected.
25__all__ = (
"addApCorrName",
"getApCorrNameSet")
31def addApCorrName(name):
32 """Register an instrumental flux field name prefix for aperture correction.
37 Field name prefix for an instrumental flux that should be aperture
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``.
48 _ApCorrNameSet.add(
str(name))
52 """Get a copy of the field name prefixes which will be aperture corrected.
57 Field prefixes which will be aperture corrected.
61 For example, the returned set may include ``base_PsfFlux`` and
62 ``base_GaussianFlux``.
65 return _ApCorrNameSet.copy()