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

Public Member Functions
	getExecutionOrder (cls)

	__init__ (self, config, name, schema, metadata)

	measure (self, measRecord, exposure)

	fail (self, measRecord, error=None)

Public Attributes
	jacValue

	jacFlag

	scale

Static Public Attributes
	ConfigClass = SingleFrameJacobianConfig

Detailed Description

Compute the Jacobian and its ratio with a nominal pixel area.

This enables one to compare relative, rather than absolute, pixel areas.

Parameters
----------
config : `SingleFrameJacobianConfig`
    Plugin configuraion.
name : `str`
    Plugin name.
schema : `lsst.afw.table.Schema`
    The schema for the measurement output catalog. New fields will be
    added to hold measurements produced by this plugin.
metadata : `lsst.daf.base.PropertySet`
    Plugin metadata that will be attached to the output catalog

Definition at line 181 of file plugins.py.

Constructor & Destructor Documentation

◆ init()

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

Reimplemented from lsst.meas.base.sfm.SingleFramePlugin.

Definition at line 205 of file plugins.py.

    def __init__(self, config, name, schema, metadata):
        SingleFramePlugin.__init__(self, config, name, schema, metadata)
        self.jacValue = schema.addField(name + '_value', type="D", doc="Jacobian correction")
        self.jacFlag = schema.addField(name + '_flag', type="Flag", doc="Set to 1 for any fatal failure")
        # Calculate one over the area of a nominal reference pixel, where area is in arcsec^2
        self.scale = pow(self.config.pixelScale, -2)
 

Member Function Documentation

◆ fail()

lsst.meas.base.plugins.SingleFrameJacobianPlugin.fail	(	self,
		measRecord,
		error = None )

Record a failure of the `measure` or `measureN` method.

Parameters
----------
measRecord : `lsst.afw.table.SourceRecord`
    Table record describing the source being measured.
error : `MeasurementError`, optional
    Only provided if the measurement failed due to a
    `MeasurementError` being raised; otherwise, will be `None`.

Notes
-----
When the plugin raises an exception, framework will call
`BasePlugin.fail` to allow the plugin to set its failure flag
field(s).  When `BasePlugin.measureN` raises an exception,
`BasePlugin.fail` will be called repeatedly with all the records that
were being measured.

If the exception is an `MeasurementError`, it will be passed as the
error argument; in all other cases the error argument will be `None`,
and the failure will be logged by the measurement framework as a
warning.

Reimplemented from lsst.meas.base.pluginsBase.BasePlugin.

Definition at line 221 of file plugins.py.

    def fail(self, measRecord, error=None):
        measRecord.set(self.jacFlag, True)

◆ getExecutionOrder()

lsst.meas.base.plugins.SingleFrameJacobianPlugin.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.pluginsBase.BasePlugin.

Definition at line 202 of file plugins.py.

    def getExecutionOrder(cls):
        return cls.SHAPE_ORDER
 

◆ measure()

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

Measure the properties of a source on a single image.

The image may be from a single epoch, or it may be a coadd.

Parameters
----------
measRecord : `lsst.afw.table.SourceRecord`
    Record describing the object being measured. Previously-measured
    quantities may be retrieved from here, and it will be updated
    in-place tih the outputs of this plugin.
exposure : `lsst.afw.image.ExposureF`
    The pixel data to be measured, together with the associated PSF,
    WCS, etc. All other sources in the image should have been replaced
    by noise according to deblender outputs.

Reimplemented from lsst.meas.base.sfm.SingleFramePlugin.

Definition at line 212 of file plugins.py.

    def measure(self, measRecord, exposure):
        center = measRecord.getCentroid()
        # Compute the area of a pixel at a source record's centroid, and take
        # the ratio of that with the defined reference pixel area.
        result = np.abs(self.scale*exposure.getWcs().linearizePixelToSky(
            center,
            lsst.geom.arcseconds).getLinear().computeDeterminant())
        measRecord.set(self.jacValue, result)
 

Member Data Documentation

◆ ConfigClass

lsst.meas.base.plugins.SingleFrameJacobianPlugin.ConfigClass = SingleFrameJacobianConfig

static

Definition at line 199 of file plugins.py.

◆ jacFlag

lsst.meas.base.plugins.SingleFrameJacobianPlugin.jacFlag

Definition at line 208 of file plugins.py.

◆ jacValue

lsst.meas.base.plugins.SingleFrameJacobianPlugin.jacValue

Definition at line 207 of file plugins.py.

◆ scale

lsst.meas.base.plugins.SingleFrameJacobianPlugin.scale

Definition at line 210 of file plugins.py.

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

/j/snowflake/release/lsstsw/stack/lsst-scipipe-9.0.0/Linux64/meas_base/g5a97de2502+520531a62c/python/lsst/meas/base/plugins.py

Public Member Functions

Public Attributes

Static Public Attributes