SingleFrameFPPositionPlugin

class lsst.meas.base.SingleFrameFPPositionPlugin(config, name, schema, metadata)

Bases: SingleFramePlugin

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

Parameters

configSingleFrameFPPositionConfig

Plugin configuraion.

namestr

Plugin name.

schemalsst.afw.table.Schema

The schema for the measurement output catalog. New fields will be added to hold measurements produced by this plugin.

metadatalsst.daf.base.PropertySet

Plugin metadata that will be attached to the output catalog

Methods Summary

fail(measRecord[, error])	Record a failure of the measure or measureN method.
getExecutionOrder()	Get the relative execution order of this plugin.
measure(measRecord, exposure)	Measure the properties of a source on a single image.

Methods Documentation

fail(measRecord, error=None)

Record a failure of the measure or measureN method.

Parameters

measRecordlsst.afw.table.SourceRecord

Table record describing the source being measured.

errorMeasurementError, 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.

classmethod getExecutionOrder()

Get the relative execution order of this plugin.

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

measure(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

measRecordlsst.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.

exposurelsst.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.