lsst.meas.base.plugins.SingleFramePeakCentroidPlugin Class Reference

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

Public Member Functions
	getExecutionOrder (cls)
	__init__ (self, config, name, schema, metadata)
	measure (self, measRecord, exposure)
	fail (self, measRecord, error=None)
	getLogName (self)

Static Public Member Functions
	getTransformClass ()

Public Attributes
	keyX = schema.addField(name + "_x", type="D", doc="peak centroid", units="pixel")
	keyY = schema.addField(name + "_y", type="D", doc="peak centroid", units="pixel")
	flag = schema.addField(name + "_flag", type="Flag", doc="Centroiding failed")
	config = config
	name = name
	logName = logName

Static Public Attributes
	registry = PluginRegistry(SingleFramePluginConfig)
float	CENTROID_ORDER = 0.0
float	SHAPE_ORDER = 1.0
float	FLUX_ORDER = 2.0
float	APCORR_ORDER = 3.0
float	DEFAULT_CATALOGCALCULATION = 4.0
	ConfigClass = BasePluginConfig

Detailed Description

Record the highest peak in a source footprint as its centroid.

This is of course a relatively poor measure of the true centroid of the
object; this algorithm is provided mostly for testing and debugging.

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

Constructor & Destructor Documentation

__init__()

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

Definition at line 600 of file plugins.py.

    def __init__(self, config, name, schema, metadata):
        SingleFramePlugin.__init__(self, config, name, schema, metadata)
        self.keyX = schema.addField(name + "_x", type="D", doc="peak centroid", units="pixel")
        self.keyY = schema.addField(name + "_y", type="D", doc="peak centroid", units="pixel")
        self.flag = schema.addField(name + "_flag", type="Flag", doc="Centroiding failed")
 

Member Function Documentation

fail()

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

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

getExecutionOrder()

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

    def getExecutionOrder(cls):
        return cls.CENTROID_ORDER
 

getLogName()

lsst.meas.base.pluginsBase.BasePlugin.getLogName ( self )

inherited

Definition at line 134 of file pluginsBase.py.

    def getLogName(self):
        return self.logName
 

getTransformClass()

lsst.meas.base.plugins.SingleFramePeakCentroidPlugin.getTransformClass ( )

static

Get the measurement transformation appropriate to this plugin.

This returns a subclass of `transforms.MeasurementTransform`, which
may be instantiated with details of the algorithm configuration and
then called with information about calibration and WCS to convert from
raw measurement quantities to calibrated units. Calibrated data is
then provided in a separate output table.

Notes
-----
By default, we copy everything from the input to the output without
transformation.

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

Definition at line 615 of file plugins.py.

    def getTransformClass():
        return SimpleCentroidTransform
 
 

measure()

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

    def measure(self, measRecord, exposure):
        peak = measRecord.getFootprint().getPeaks()[0]
        measRecord.set(self.keyX, peak.getFx())
        measRecord.set(self.keyY, peak.getFy())
 

Member Data Documentation

APCORR_ORDER

float lsst.meas.base.pluginsBase.BasePlugin.APCORR_ORDER = 3.0

staticinherited

Definition at line 98 of file pluginsBase.py.

CENTROID_ORDER

float lsst.meas.base.pluginsBase.BasePlugin.CENTROID_ORDER = 0.0

staticinherited

Definition at line 72 of file pluginsBase.py.

config

lsst.meas.base.pluginsBase.BasePlugin.config = config

inherited

Definition at line 130 of file pluginsBase.py.

ConfigClass

lsst.meas.base.pluginsBase.BasePlugin.ConfigClass = BasePluginConfig

staticinherited

Definition at line 116 of file pluginsBase.py.

DEFAULT_CATALOGCALCULATION

float lsst.meas.base.pluginsBase.BasePlugin.DEFAULT_CATALOGCALCULATION = 4.0

staticinherited

Definition at line 108 of file pluginsBase.py.

flag

lsst.meas.base.plugins.SingleFramePeakCentroidPlugin.flag = schema.addField(name + "_flag", type="Flag", doc="Centroiding failed")

Definition at line 604 of file plugins.py.

FLUX_ORDER

float lsst.meas.base.pluginsBase.BasePlugin.FLUX_ORDER = 2.0

staticinherited

Definition at line 89 of file pluginsBase.py.

keyX

lsst.meas.base.plugins.SingleFramePeakCentroidPlugin.keyX = schema.addField(name + "_x", type="D", doc="peak centroid", units="pixel")

Definition at line 602 of file plugins.py.

keyY

lsst.meas.base.plugins.SingleFramePeakCentroidPlugin.keyY = schema.addField(name + "_y", type="D", doc="peak centroid", units="pixel")

Definition at line 603 of file plugins.py.

logName

lsst.meas.base.pluginsBase.BasePlugin.logName = logName

inherited

Definition at line 132 of file pluginsBase.py.

name

lsst.meas.base.pluginsBase.BasePlugin.name = name

inherited

Definition at line 131 of file pluginsBase.py.

registry

lsst.meas.base.sfm.SingleFramePlugin.registry = PluginRegistry(SingleFramePluginConfig)

staticinherited

Definition at line 76 of file sfm.py.

SHAPE_ORDER

float lsst.meas.base.pluginsBase.BasePlugin.SHAPE_ORDER = 1.0

staticinherited

Definition at line 80 of file pluginsBase.py.

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-12.1.0/Linux/meas_base/g3e17d7035e+5b3adc59f5/python/lsst/meas/base/plugins.py