LSST Applications g0265f82a02+c6dfa2ddaf,g1162b98a3f+ffe7eabc7e,g2079a07aa2+1b2e822518,g2bbee38e9b+c6dfa2ddaf,g337abbeb29+c6dfa2ddaf,g36da64cc00+ea84795170,g3ddfee87b4+955a963fd8,g50ff169b8f+2eb0e556e8,g52b1c1532d+90ebb246c7,g555ede804d+955a963fd8,g591dd9f2cf+bac198a2cb,g5ec818987f+420292cfeb,g858d7b2824+d6c9a0a3b8,g876c692160+aabc49a3c3,g8a8a8dda67+90ebb246c7,g8cdfe0ae6a+4fd9e222a8,g99cad8db69+e6cd765486,g9ddcbc5298+a1346535a5,ga1e77700b3+df8f93165b,ga8c6da7877+acd47f83f4,gae46bcf261+c6dfa2ddaf,gb0e22166c9+8634eb87fb,gb3f2274832+12c8382528,gba4ed39666+1ac82b564f,gbb8dafda3b+0574160a1f,gbeb006f7da+dea2fbb49f,gc28159a63d+c6dfa2ddaf,gc86a011abf+d6c9a0a3b8,gcf0d15dbbd+955a963fd8,gdaeeff99f8+1cafcb7cd4,gdc0c513512+d6c9a0a3b8,ge79ae78c31+c6dfa2ddaf,geb67518f79+ba1859f325,gee10cc3b42+90ebb246c7,gf1cff7945b+d6c9a0a3b8,w.2024.13
LSST Data Management Base Package
Loading...
Searching...
No Matches
Functions | Variables
lsst.meas.base.apCorrRegistry Namespace Reference

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 global _ApCorrNameSet
48 _ApCorrNameSet.add(str(name))
49
50

◆ 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 51 of file apCorrRegistry.py.

51def 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()

Variable Documentation

◆ _ApCorrNameSet

lsst.meas.base.apCorrRegistry._ApCorrNameSet = set()
protected

Definition at line 28 of file apCorrRegistry.py.