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

Public Member Functions
	getExecutionOrder (cls)

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

	measure (self, measRecord, exposure)

	fail (self, measRecord, error=None)

Public Attributes
	focalValue

	focalFlag

	detectorFlag

Static Public Attributes
	ConfigClass = SingleFrameFPPositionConfig

Detailed Description

Algorithm to calculate the position of a centroid on the focal plane.

Parameters
----------
config : `SingleFrameFPPositionConfig`
    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 129 of file plugins.py.

Constructor & Destructor Documentation

◆ init()

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

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

Definition at line 151 of file plugins.py.

    def __init__(self, config, name, schema, metadata):
        SingleFramePlugin.__init__(self, config, name, schema, metadata)
        self.focalValue = lsst.afw.table.Point2DKey.addFields(schema, name, "Position on the focal plane",
                                                              "mm")
        self.focalFlag = schema.addField(name + "_flag", type="Flag", doc="Set to True for any fatal failure")
        self.detectorFlag = schema.addField(name + "_missingDetector_flag", type="Flag",
                                            doc="Set to True if detector object is missing")
 

Member Function Documentation

◆ fail()

lsst.meas.base.plugins.SingleFrameFPPositionPlugin.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 169 of file plugins.py.

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

◆ getExecutionOrder()

lsst.meas.base.plugins.SingleFrameFPPositionPlugin.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 148 of file plugins.py.

    def getExecutionOrder(cls):
        return cls.SHAPE_ORDER
 

◆ measure()

lsst.meas.base.plugins.SingleFrameFPPositionPlugin.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 159 of file plugins.py.

    def measure(self, measRecord, exposure):
        det = exposure.getDetector()
        if not det:
            measRecord.set(self.detectorFlag, True)
            fp = lsst.geom.Point2D(np.nan, np.nan)
        else:
            center = measRecord.getCentroid()
            fp = det.transform(center, lsst.afw.cameraGeom.PIXELS, lsst.afw.cameraGeom.FOCAL_PLANE)
        measRecord.set(self.focalValue, fp)
 

Member Data Documentation

◆ ConfigClass

lsst.meas.base.plugins.SingleFrameFPPositionPlugin.ConfigClass = SingleFrameFPPositionConfig

static

Definition at line 145 of file plugins.py.

◆ detectorFlag

lsst.meas.base.plugins.SingleFrameFPPositionPlugin.detectorFlag

Definition at line 156 of file plugins.py.

◆ focalFlag

lsst.meas.base.plugins.SingleFrameFPPositionPlugin.focalFlag

Definition at line 155 of file plugins.py.

◆ focalValue

lsst.meas.base.plugins.SingleFrameFPPositionPlugin.focalValue

Definition at line 153 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/gf18bd8381d+7268b93478/python/lsst/meas/base/plugins.py

Public Member Functions

Public Attributes

Static Public Attributes