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 40 of file applyApCorr.py.

Constructor & Destructor Documentation

__init__()

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

Definition at line 122 of file applyApCorr.py.

    def __init__(self, schema, model, name=None):
        if name is None:
            name = model
        self.name = name
        self.modelName = model + "_instFlux"
        self.modelSigmaName = model + "_instFluxErr"
        self.instFluxName = name + "_instFlux"
        self.instFluxErrName = name + "_instFluxErr"
        self.instFluxKey = schema.find(self.instFluxName).key
        self.instFluxErrKey = schema.find(self.instFluxErrName).key
        self.fluxFlagKey = schema.find(name + "_flag").key
 
        # No need to write the same aperture corrections multiple times
        self.doApCorrColumn = (name == model or model + "_apCorr" not in schema)
        if self.doApCorrColumn:
            self.apCorrKey = schema.addField(
                name + "_apCorr",
                doc="aperture correction applied to %s" % (name,),
                type=np.float64,
            )
            self.apCorrErrKey = schema.addField(
                name + "_apCorrErr",
                doc="standard deviation of aperture correction applied to %s" % (name,),
                type=np.float64,
            )
        else:
            aliases = schema.getAliasMap()
            aliases.set(name + "_apCorr", model + "_apCorr")
            aliases.set(name + "_apCorrErr", model + "_apCorrErr")
            self.apCorrKey = schema.find(name + "_apCorr").key
            self.apCorrErrKey = schema.find(name + "_apCorrErr").key
 
        self.apCorrFlagKey = schema.addField(
            name + "_flag_apCorr",
            doc="set if unable to aperture correct %s" % (name,),
            type="Flag",
        )
 
 

Member Data Documentation

apCorrErrKey

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

static

Definition at line 114 of file applyApCorr.py.

apCorrFlagKey

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

static

Definition at line 118 of file applyApCorr.py.

apCorrKey

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

static

Definition at line 110 of file applyApCorr.py.

doApCorrColumn

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

static

Definition at line 84 of file applyApCorr.py.

fluxFlagKey

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

static

Definition at line 106 of file applyApCorr.py.

instFluxErrKey

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

static

Definition at line 102 of file applyApCorr.py.

instFluxErrName

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

static

Definition at line 94 of file applyApCorr.py.

instFluxKey

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

static

Definition at line 98 of file applyApCorr.py.

instFluxName

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

static

Definition at line 90 of file applyApCorr.py.

modelName

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

static

Definition at line 76 of file applyApCorr.py.

modelSigmaName

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

static

Definition at line 80 of file applyApCorr.py.

name

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

static

Definition at line 72 of file applyApCorr.py.

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/meas_base/g212a7c68fe+04a9158687/python/lsst/meas/base/applyApCorr.py