lsst.meas.base gc76e4e2a6e+28356f993d
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
lsst.meas.base.applyApCorr.ApCorrInfo Class Reference

Public Member Functions

def __init__ (self, schema, model, name=None)
 

Public Attributes

 name
 
 modelName
 
 modelSigmaName
 
 instFluxName
 
 instFluxErrName
 
 instFluxKey
 
 instFluxErrKey
 
 fluxFlagKey
 
 doApCorrColumn
 
 apCorrKey
 
 apCorrErrKey
 
 apCorrFlagKey
 

Static Public Attributes

None name = None
 
None modelName = None
 
None modelSigmaName = None
 
None doApCorrColumn = None
 
None instFluxName = None
 
None instFluxErrName = None
 
None instFluxKey = None
 
None instFluxErrKey = None
 
None fluxFlagKey = None
 
None apCorrKey = None
 
None apCorrErrKey = None
 
None apCorrFlagKey = None
 

Detailed Description

Catalog field names and keys needed to aperture correct a particular
instrument flux.

Parameters
----------
schema : `lsst.afw.table`
    Source catalog schema. Three fields are used to generate keys:
    - ``{name}_instFlux``
    - ``{name}_instFluxErr``
    - ``{name}_flag``
    Three fields are added:
    - ``{name}_apCorr`` (only if not already added by proxy)
    - ``{name}_apCorrErr`` (only if not already added by proxy)
    - ``{name}_flag_apCorr``
model : `str`
    Field name prefix for instFlux with aperture correction model, e.g.
    "base_PsfFlux"
name : `str`
    Field name prefix for instFlux needing aperture correction; may be
    `None` if it is the same as ``model``

Notes
-----
The aperture correction can be derived from the meaasurements in the
column being aperture-corrected or from measurements in a different
column (a "proxy"). In the first case, we will add columns to contain
the aperture correction values; in the second case (using a proxy),
we will add an alias to the proxy's aperture correction values. In
all cases, we add a flag.

Definition at line 41 of file applyApCorr.py.

Constructor & Destructor Documentation

◆ __init__()

def lsst.meas.base.applyApCorr.ApCorrInfo.__init__ (   self,
  schema,
  model,
  name = None 
)

Definition at line 123 of file applyApCorr.py.

Member Data Documentation

◆ apCorrErrKey [1/2]

None lsst.meas.base.applyApCorr.ApCorrInfo.apCorrErrKey = None
static

Definition at line 115 of file applyApCorr.py.

◆ apCorrErrKey [2/2]

lsst.meas.base.applyApCorr.ApCorrInfo.apCorrErrKey

Definition at line 143 of file applyApCorr.py.

◆ apCorrFlagKey [1/2]

None lsst.meas.base.applyApCorr.ApCorrInfo.apCorrFlagKey = None
static

Definition at line 119 of file applyApCorr.py.

◆ apCorrFlagKey [2/2]

lsst.meas.base.applyApCorr.ApCorrInfo.apCorrFlagKey

Definition at line 155 of file applyApCorr.py.

◆ apCorrKey [1/2]

None lsst.meas.base.applyApCorr.ApCorrInfo.apCorrKey = None
static

Definition at line 111 of file applyApCorr.py.

◆ apCorrKey [2/2]

lsst.meas.base.applyApCorr.ApCorrInfo.apCorrKey

Definition at line 138 of file applyApCorr.py.

◆ doApCorrColumn [1/2]

None lsst.meas.base.applyApCorr.ApCorrInfo.doApCorrColumn = None
static

Definition at line 85 of file applyApCorr.py.

◆ doApCorrColumn [2/2]

lsst.meas.base.applyApCorr.ApCorrInfo.doApCorrColumn

Definition at line 136 of file applyApCorr.py.

◆ fluxFlagKey [1/2]

None lsst.meas.base.applyApCorr.ApCorrInfo.fluxFlagKey = None
static

Definition at line 107 of file applyApCorr.py.

◆ fluxFlagKey [2/2]

lsst.meas.base.applyApCorr.ApCorrInfo.fluxFlagKey

Definition at line 133 of file applyApCorr.py.

◆ instFluxErrKey [1/2]

None lsst.meas.base.applyApCorr.ApCorrInfo.instFluxErrKey = None
static

Definition at line 103 of file applyApCorr.py.

◆ instFluxErrKey [2/2]

lsst.meas.base.applyApCorr.ApCorrInfo.instFluxErrKey

Definition at line 132 of file applyApCorr.py.

◆ instFluxErrName [1/2]

None lsst.meas.base.applyApCorr.ApCorrInfo.instFluxErrName = None
static

Definition at line 95 of file applyApCorr.py.

◆ instFluxErrName [2/2]

lsst.meas.base.applyApCorr.ApCorrInfo.instFluxErrName

Definition at line 130 of file applyApCorr.py.

◆ instFluxKey [1/2]

None lsst.meas.base.applyApCorr.ApCorrInfo.instFluxKey = None
static

Definition at line 99 of file applyApCorr.py.

◆ instFluxKey [2/2]

lsst.meas.base.applyApCorr.ApCorrInfo.instFluxKey

Definition at line 131 of file applyApCorr.py.

◆ instFluxName [1/2]

None lsst.meas.base.applyApCorr.ApCorrInfo.instFluxName = None
static

Definition at line 91 of file applyApCorr.py.

◆ instFluxName [2/2]

lsst.meas.base.applyApCorr.ApCorrInfo.instFluxName

Definition at line 129 of file applyApCorr.py.

◆ modelName [1/2]

None lsst.meas.base.applyApCorr.ApCorrInfo.modelName = None
static

Definition at line 77 of file applyApCorr.py.

◆ modelName [2/2]

lsst.meas.base.applyApCorr.ApCorrInfo.modelName

Definition at line 127 of file applyApCorr.py.

◆ modelSigmaName [1/2]

None lsst.meas.base.applyApCorr.ApCorrInfo.modelSigmaName = None
static

Definition at line 81 of file applyApCorr.py.

◆ modelSigmaName [2/2]

lsst.meas.base.applyApCorr.ApCorrInfo.modelSigmaName

Definition at line 128 of file applyApCorr.py.

◆ name [1/2]

None lsst.meas.base.applyApCorr.ApCorrInfo.name = None
static

Definition at line 73 of file applyApCorr.py.

◆ name [2/2]

lsst.meas.base.applyApCorr.ApCorrInfo.name

Definition at line 126 of file applyApCorr.py.


The documentation for this class was generated from the following file: