lsst.meas.base.plugins.EvaluateLocalPhotoCalibPlugin Class Reference

Inheritance diagram for lsst.meas.base.plugins.EvaluateLocalPhotoCalibPlugin:

Public Member Functions
	getExecutionOrder (cls)
	__init__ (self, config, name, schema, metadata)
	measure (self, measRecord, exposure, center)

Public Attributes
	photoKey
	photoErrKey

Static Public Attributes
	ConfigClass = EvaluateLocalPhotoCalibPluginConfig

Detailed Description

Evaluate the local value of the Photometric Calibration in the exposure.

The aim is to store the local calib value within the catalog for later
use in the Science Data Model functors.

Definition at line 416 of file plugins.py.

Constructor & Destructor Documentation

__init__()

lsst.meas.base.plugins.EvaluateLocalPhotoCalibPlugin.__init__	(		self,
			config,
			name,
			schema,
			metadata )

Reimplemented from lsst.meas.base.wrappers.GenericPlugin.

Definition at line 428 of file plugins.py.

    def __init__(self, config, name, schema, metadata):
        GenericPlugin.__init__(self, config, name, schema, metadata)
        self.photoKey = schema.addField(
            name,
            type="D",
            doc="Local approximation of the PhotoCalib calibration factor at "
                "the location of the src.")
        self.photoErrKey = schema.addField(
            "%sErr" % name,
            type="D",
            doc="Error on the local approximation of the PhotoCalib "
                "calibration factor at the location of the src.")
 

Member Function Documentation

getExecutionOrder()

lsst.meas.base.plugins.EvaluateLocalPhotoCalibPlugin.getExecutionOrder

(

cls

)

Get the relative execution order of this plugin.

Must be reimplemented as a class method by concrete derived classes.

Reimplemented from lsst.meas.base.wrappers.GenericPlugin.

Definition at line 425 of file plugins.py.

    def getExecutionOrder(cls):
        return BasePlugin.FLUX_ORDER
 

measure()

lsst.meas.base.plugins.EvaluateLocalPhotoCalibPlugin.measure	(		self,
			measRecord,
			exposure,
			center )

Measure a single source.

It is the responsibility of this method to perform the desired
measurement and record the result in the `measRecord`.

Parameters
----------
measRecord : `lsst.afw.table.SourceRecord`
    Catalog record for the source being measured.
exposure : `lsst.afw.image.Exposure`
    Exposure on which the source is being measured.
center : `lsst.geom.Point2D`
    Pixel coordinates of the object.

Raises
------
MeasurementError
    Raised if the measurement fails for a known/justifiable reason.

Reimplemented from lsst.meas.base.wrappers.GenericPlugin.

Definition at line 441 of file plugins.py.

    def measure(self, measRecord, exposure, center):
 
        photoCalib = exposure.getPhotoCalib()
        calib = photoCalib.getLocalCalibration(center)
        measRecord.set(self.photoKey, calib)
 
        calibErr = photoCalib.getCalibrationErr()
        measRecord.set(self.photoErrKey, calibErr)
 
 

Member Data Documentation

ConfigClass

lsst.meas.base.plugins.EvaluateLocalPhotoCalibPlugin.ConfigClass = EvaluateLocalPhotoCalibPluginConfig

static

Definition at line 422 of file plugins.py.

photoErrKey

lsst.meas.base.plugins.EvaluateLocalPhotoCalibPlugin.photoErrKey

Definition at line 435 of file plugins.py.

photoKey

lsst.meas.base.plugins.EvaluateLocalPhotoCalibPlugin.photoKey

Definition at line 430 of file plugins.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/g48712c4677+3bf1020dcb/python/lsst/meas/base/plugins.py