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__
	Construct an ApCorrInfo and add fields to the schema. More...

Public Attributes
	name
	fluxName
	fluxSigmaName
	fluxKey
	fluxSigmaKey
	fluxFlagKey
	apCorrKey
	apCorrSigmaKey
	apCorrFlagKey

Detailed Description

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

Definition at line 41 of file applyApCorr.py.

Constructor & Destructor Documentation

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

Construct an ApCorrInfo and add fields to the schema.

Parameters

[in,out]	schema	source catalog schema; three fields are used to generate keys: {name}_flux {name}_fluxSigma {name}_fluxFlag three fields are added: {name}_apCorr {name}_apCorrSigma {name}_flag_apCorr
[in]	name	field name prefix for flux needing aperture correction, e.g. "base_PsfFlux"

ApCorrInfo has the following attributes:

• name: field name prefix for flux needing aperture correction
• 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 44 of file applyApCorr.py.

    def __init__(self, schema, name):
        """!Construct an ApCorrInfo and add fields to the schema

        @param[in,out] schema  source catalog schema;
            three fields are used to generate keys:
            - {name}_flux
            - {name}_fluxSigma
            - {name}_fluxFlag
            three fields are added:
            - {name}_apCorr
            - {name}_apCorrSigma
            - {name}_flag_apCorr
        @param[in] name  field name prefix for flux needing aperture correction, e.g. "base_PsfFlux"

        ApCorrInfo has the following attributes:
        - name: field name prefix for flux needing aperture correction
        - 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
        """
        self.name = name
        self.fluxName = name + "_flux"
        self.fluxSigmaName = name + "_fluxSigma"
        self.fluxKey = schema.find(self.fluxName).key
        self.fluxSigmaKey = schema.find(self.fluxSigmaName).key
        self.fluxFlagKey = schema.find(name + "_flag").key
        self.apCorrKey = schema.addField(
            name + "_apCorr",
            doc = "aperture correction applied to %s" % (name,),
            type = float,
        )
        self.apCorrSigmaKey = schema.addField(
            name + "_apCorrSigma",
            doc = "aperture correction applied to %s" % (name,),
            type = float,
        )
        self.apCorrFlagKey = schema.addField(
            name + "_flag_apCorr",
            doc = "set if unable to aperture correct %s" % (name,),
            type = "Flag",
        )