lsst.meas.base  16.0-13-gd9b1b71+11
Public Member Functions | Public Attributes | List of all members
lsst.meas.base.applyApCorr.ApCorrInfo Class Reference

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

Public Member Functions

def __init__ (self, schema, model, name=None)
 Construct an ApCorrInfo and add fields to the schema. More...
 

Public Attributes

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

Detailed Description

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

Definition at line 41 of file applyApCorr.py.

Constructor & Destructor Documentation

◆ __init__()

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

Construct an ApCorrInfo and add fields to the schema.

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.

Parameters
[in,out]schemasource 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
[in]modelfield name prefix for instFlux with aperture correction model, e.g. "base_PsfFlux"
[in]namefield name prefix for instFlux needing aperture correction; may be None if it's the same as for the 'model' parameter

ApCorrInfo has the following attributes:

  • name: field name prefix for instFlux needing aperture correction
  • modelName: field name for aperture correction model for instFlux
  • modelSigmaName: field name for aperture correction model for instFluxErr
  • doApCorrColumn: should we write the aperture correction values? (not if they're already being written by a proxy)
  • instFluxName: name of instFlux field
  • instFluxErrName: name of instFlux sigma field
  • instFluxKey: key to instFlux field
  • instFluxErrKey: key to instFlux sigma field
  • fluxFlagKey: key to flux flag field
  • apCorrKey: key to new aperture correction field
  • apCorrErrKey: key to new aperture correction sigma field
  • apCorrFlagKey: key to new aperture correction flag field

Definition at line 45 of file applyApCorr.py.

Member Data Documentation

◆ apCorrErrKey

lsst.meas.base.applyApCorr.ApCorrInfo.apCorrErrKey

Definition at line 102 of file applyApCorr.py.

◆ apCorrFlagKey

lsst.meas.base.applyApCorr.ApCorrInfo.apCorrFlagKey

Definition at line 114 of file applyApCorr.py.

◆ apCorrKey

lsst.meas.base.applyApCorr.ApCorrInfo.apCorrKey

Definition at line 97 of file applyApCorr.py.

◆ doApCorrColumn

lsst.meas.base.applyApCorr.ApCorrInfo.doApCorrColumn

Definition at line 95 of file applyApCorr.py.

◆ fluxFlagKey

lsst.meas.base.applyApCorr.ApCorrInfo.fluxFlagKey

Definition at line 92 of file applyApCorr.py.

◆ instFluxErrKey

lsst.meas.base.applyApCorr.ApCorrInfo.instFluxErrKey

Definition at line 91 of file applyApCorr.py.

◆ instFluxErrName

lsst.meas.base.applyApCorr.ApCorrInfo.instFluxErrName

Definition at line 89 of file applyApCorr.py.

◆ instFluxKey

lsst.meas.base.applyApCorr.ApCorrInfo.instFluxKey

Definition at line 90 of file applyApCorr.py.

◆ instFluxName

lsst.meas.base.applyApCorr.ApCorrInfo.instFluxName

Definition at line 88 of file applyApCorr.py.

◆ modelName

lsst.meas.base.applyApCorr.ApCorrInfo.modelName

Definition at line 86 of file applyApCorr.py.

◆ modelSigmaName

lsst.meas.base.applyApCorr.ApCorrInfo.modelSigmaName

Definition at line 87 of file applyApCorr.py.

◆ name

lsst.meas.base.applyApCorr.ApCorrInfo.name

Definition at line 85 of file applyApCorr.py.


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