lsst.meas.astrom.matchOptimisticB.SourceInfo Class Reference

Inheritance diagram for lsst.meas.astrom.matchOptimisticB.SourceInfo:

Public Member Functions
def	__init__
def	hasCentroid
def	isUsable
def	isGood

Public Attributes
	centroidKey
	centroidFlagKey
	edgeKey
	saturatedKey
	fluxField
	interpolatedCenterKey
	parentKey

Private Member Functions
def	_isMultiple

Detailed Description

Provide usability tests and catalog keys for sources in a source catalog

Fields set include:
- centroidKey  key for centroid
- centroidFlagKey  key for flag that is True if centroid is valid
- edgeKey  key for field that is True if source is near an edge
- saturatedKey  key for field that is True if source has any saturated pixels
- interpolatedCenterKey  key for field that is True if center pixels have interpolated values;
    interpolation is triggered by saturation, cosmic rays and bad pixels, and possibly other reasons
- fluxField  name of flux field

@throw RuntimeError if schema version unsupported or a needed field is not found

Definition at line 79 of file matchOptimisticB.py.

Constructor & Destructor Documentation

def lsst.meas.astrom.matchOptimisticB.SourceInfo.__init__	(		self,
			schema,
			fluxType = "Ap"
	)

Construct a SourceInfo

@param[in] schema  source catalog schema
@param[in] fluxType  flux type: typically one of "Ap" or "Psf"

@throw RuntimeError if the flux field is not found

Definition at line 93 of file matchOptimisticB.py.

    def __init__(self, schema, fluxType="Ap"):
        """Construct a SourceInfo

        @param[in] schema  source catalog schema
        @param[in] fluxType  flux type: typically one of "Ap" or "Psf"

        @throw RuntimeError if the flux field is not found
        """
        self.centroidKey = afwTable.Point2DKey(schema["slot_Centroid"])
        self.centroidFlagKey = schema["slot_Centroid_flag"].asKey()
        self.edgeKey = schema["base_PixelFlags_flag_edge"].asKey()
        self.saturatedKey = schema["base_PixelFlags_flag_saturated"].asKey()
        self.fluxField = "slot_%sFlux_flux" % (fluxType,)
        self.interpolatedCenterKey = schema["base_PixelFlags_flag_interpolatedCenter"].asKey()
        # extra keys that might be useful
        self.parentKey = schema["parent"].asKey()

        if self.fluxField not in schema:
            raise RuntimeError("Could not find flux field %s in source schema" % (self.fluxField,))