lsst.meas.base.applyApCorr.ApCorrInfo Class Reference

Public Member Functions
	__init__ (self, model, schema=None, name=None)

Public Attributes
str	fluxFlagName = name + "_flag"
str	apCorrErrName = name + "_apCorrErr"
str	apCorrFlagName = name + "_flag_apCorr"

Static Public Attributes
	name = None
str	modelName = None
str	modelSigmaName = None
tuple	doApCorrColumn = None
str	instFluxName = None
str	instFluxErrName = None
str	apCorrName = 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.

Attributes
----------
name : str
    Field name prefix for flux needing aperture correction.
modelName : str
    Field name for aperture correction model for flux.
modelSigmaName : str
    Field name for aperture correction model for fluxErr.
doApCorrColumn : bool
    Should we write the aperture correction values?
    They should not be written if they're already being written by a proxy.
instFluxName : str
    Name of ``instFlux`` field.
instFluxErrName : str
    Name of ``instFlux`` sigma field.

Definition at line 41 of file applyApCorr.py.

Constructor & Destructor Documentation

__init__()

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

Definition at line 97 of file applyApCorr.py.

Member Data Documentation

apCorrErrName

str lsst.meas.base.applyApCorr.ApCorrInfo.apCorrErrName = name + "_apCorrErr"

Definition at line 107 of file applyApCorr.py.

apCorrFlagName

str lsst.meas.base.applyApCorr.ApCorrInfo.apCorrFlagName = name + "_flag_apCorr"

Definition at line 108 of file applyApCorr.py.

apCorrName

str lsst.meas.base.applyApCorr.ApCorrInfo.apCorrName = None

static

Definition at line 95 of file applyApCorr.py.

doApCorrColumn

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

static

Definition at line 92 of file applyApCorr.py.

fluxFlagName

str lsst.meas.base.applyApCorr.ApCorrInfo.fluxFlagName = name + "_flag"

Definition at line 105 of file applyApCorr.py.

instFluxErrName

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

static

Definition at line 94 of file applyApCorr.py.

instFluxName

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

static

Definition at line 93 of file applyApCorr.py.

modelName

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

static

Definition at line 90 of file applyApCorr.py.

modelSigmaName

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

static

Definition at line 91 of file applyApCorr.py.

name

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

static

Definition at line 89 of file applyApCorr.py.

---

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

• python/lsst/meas/base/applyApCorr.py