lsst.meas.base g4f88e20838+87b85358eb
Loading...
Searching...
No Matches
Public Member Functions | Static Public Attributes | List of all members
lsst.meas.base.applyApCorr.ApCorrInfo Class Reference

Public Member Functions

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

Static Public Attributes

 name = None
 
 modelName = None
 
 modelSigmaName = None
 
 doApCorrColumn = None
 
 instFluxName = None
 
 instFluxErrName = None
 
 instFluxKey = None
 
 instFluxErrKey = None
 
 fluxFlagKey = None
 
 apCorrKey = None
 
 apCorrErrKey = 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__()

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

Definition at line 123 of file applyApCorr.py.

Member Data Documentation

◆ apCorrErrKey

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

Definition at line 115 of file applyApCorr.py.

◆ apCorrFlagKey

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

Definition at line 119 of file applyApCorr.py.

◆ apCorrKey

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

Definition at line 111 of file applyApCorr.py.

◆ doApCorrColumn

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

Definition at line 85 of file applyApCorr.py.

◆ fluxFlagKey

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

Definition at line 107 of file applyApCorr.py.

◆ instFluxErrKey

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

Definition at line 103 of file applyApCorr.py.

◆ instFluxErrName

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

Definition at line 95 of file applyApCorr.py.

◆ instFluxKey

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

Definition at line 99 of file applyApCorr.py.

◆ instFluxName

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

Definition at line 91 of file applyApCorr.py.

◆ modelName

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

Definition at line 77 of file applyApCorr.py.

◆ modelSigmaName

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

Definition at line 81 of file applyApCorr.py.

◆ name

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

Definition at line 73 of file applyApCorr.py.


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