lsst.meas.base  14.0-18-g5442b95
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 flux. More...

Inheritance diagram for lsst.meas.base.applyApCorr.ApCorrInfo:

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
 
 fluxName
 
 fluxSigmaName
 
 fluxKey
 
 fluxSigmaKey
 
 fluxFlagKey
 
 doApCorrColumn
 
 apCorrKey
 
 apCorrSigmaKey
 
 apCorrFlagKey
 

Detailed Description

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

Definition at line 43 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}_flux
  • {name}_fluxSigma
  • {name}_flag three fields are added:
  • {name}_apCorr (only if not already added by proxy)
  • {name}_apCorrSigma (only if not already added by proxy)
  • {name}_flag_apCorr
[in]modelfield name prefix for flux with aperture correction model, e.g. "base_PsfFlux"
[in]namefield name prefix for flux 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 flux needing aperture correction
  • modelName: field name for aperture correction model for flux
  • modelSigmaName: field name for aperture correction model for fluxSigma
  • doApCorrColumn: should we write the aperture correction values? (not if they're already being written by a proxy)
  • fluxName: name of flux field
  • fluxSigmaName: name of flux sigma field
  • fluxKey: key to flux field
  • fluxSigmaKey: key to flux sigma field
  • fluxFlagKey: key to flux flag field
  • apCorrKey: key to new aperture correction field
  • apCorrSigmaKey: key to new aperture correction sigma field
  • apCorrFlagKey: key to new aperture correction flag field

Definition at line 47 of file applyApCorr.py.

Member Data Documentation

◆ apCorrFlagKey

lsst.meas.base.applyApCorr.ApCorrInfo.apCorrFlagKey

Definition at line 116 of file applyApCorr.py.

◆ apCorrKey

lsst.meas.base.applyApCorr.ApCorrInfo.apCorrKey

Definition at line 99 of file applyApCorr.py.

◆ apCorrSigmaKey

lsst.meas.base.applyApCorr.ApCorrInfo.apCorrSigmaKey

Definition at line 104 of file applyApCorr.py.

◆ doApCorrColumn

lsst.meas.base.applyApCorr.ApCorrInfo.doApCorrColumn

Definition at line 97 of file applyApCorr.py.

◆ fluxFlagKey

lsst.meas.base.applyApCorr.ApCorrInfo.fluxFlagKey

Definition at line 94 of file applyApCorr.py.

◆ fluxKey

lsst.meas.base.applyApCorr.ApCorrInfo.fluxKey

Definition at line 92 of file applyApCorr.py.

◆ fluxName

lsst.meas.base.applyApCorr.ApCorrInfo.fluxName

Definition at line 90 of file applyApCorr.py.

◆ fluxSigmaKey

lsst.meas.base.applyApCorr.ApCorrInfo.fluxSigmaKey

Definition at line 93 of file applyApCorr.py.

◆ fluxSigmaName

lsst.meas.base.applyApCorr.ApCorrInfo.fluxSigmaName

Definition at line 91 of file applyApCorr.py.

◆ modelName

lsst.meas.base.applyApCorr.ApCorrInfo.modelName

Definition at line 88 of file applyApCorr.py.

◆ modelSigmaName

lsst.meas.base.applyApCorr.ApCorrInfo.modelSigmaName

Definition at line 89 of file applyApCorr.py.

◆ name

lsst.meas.base.applyApCorr.ApCorrInfo.name

Definition at line 87 of file applyApCorr.py.


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