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

Public Member Functions
def	getExecutionOrder (cls)

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

def	measure (self, measRecord, exposure)

def	fail (self, measRecord, error=None)

def	measureN (self, measCat, exposure)

def	getLogName (self)

Static Public Member Functions
def	getTransformClass ()

Public Attributes
	keyX

	keyY

	flag

	config

	name

	logName

Static Public Attributes
	ConfigClass = SingleFramePeakCentroidConfig

	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

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 557 of file plugins.py.

Constructor & Destructor Documentation

◆ init()

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

Definition at line 582 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()

def 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 593 of file plugins.py.

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

◆ getExecutionOrder()

def 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 579 of file plugins.py.

     def getExecutionOrder(cls):
         return cls.CENTROID_ORDER
  

◆ getLogName()

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

inherited

Definition at line 134 of file pluginsBase.py.

     def getLogName(self):
         return self.logName
  

◆ getTransformClass()

def 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 597 of file plugins.py.

     def getTransformClass():
         return SimpleCentroidTransform

◆ measure()

def 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 588 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())
  

◆ measureN()

def lsst.meas.base.sfm.SingleFramePlugin.measureN	(	self,
		measCat,
		exposure
	)

inherited

Measure the properties of blended sources on a single image.

This operates on all members of a blend family at once. The image may
be from a single epoch, or it may be a coadd.

Parameters
----------
measCat : `lsst.afw.table.SourceCatalog`
    Catalog describing the objects (and only those objects) being
    measured. Previously-measured quantities will be retrieved from
    here, and it will be updated in-place with 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.

Notes
-----
Derived classes that do not implement ``measureN`` should just inherit
this disabled version.  Derived classes that do implement ``measureN``
should additionally add a bool doMeasureN config field to their config
class to signal that measureN-mode is available.

Reimplemented in lsst.meas.base.wrappers.WrappedSingleFramePlugin.

Definition at line 105 of file sfm.py.

     def measureN(self, measCat, exposure):
         """Measure the properties of blended sources on a single image.
  
         This operates on all members of a blend family at once. The image may
         be from a single epoch, or it may be a coadd.
  
         Parameters
         ----------
         measCat : `lsst.afw.table.SourceCatalog`
             Catalog describing the objects (and only those objects) being
             measured. Previously-measured quantities will be retrieved from
             here, and it will be updated in-place with 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.
  
         Notes
         -----
         Derived classes that do not implement ``measureN`` should just inherit
         this disabled version.  Derived classes that do implement ``measureN``
         should additionally add a bool doMeasureN config field to their config
         class to signal that measureN-mode is available.
         """
         raise NotImplementedError()
  
  

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

inherited

Definition at line 130 of file pluginsBase.py.

◆ ConfigClass

lsst.meas.base.plugins.SingleFramePeakCentroidPlugin.ConfigClass = SingleFramePeakCentroidConfig

static

Definition at line 576 of file plugins.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

Definition at line 586 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

Definition at line 584 of file plugins.py.

◆ keyY

lsst.meas.base.plugins.SingleFramePeakCentroidPlugin.keyY

Definition at line 585 of file plugins.py.

◆ logName

lsst.meas.base.pluginsBase.BasePlugin.logName

inherited

Definition at line 132 of file pluginsBase.py.

◆ name

lsst.meas.base.pluginsBase.BasePlugin.name

inherited

Definition at line 131 of file pluginsBase.py.

◆ registry

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

staticinherited

Definition at line 78 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-0.7.0/Linux64/meas_base/22.0.1-25-gb120d7b+8b5510f75f/python/lsst/meas/base/plugins.py

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ fail()

◆ getExecutionOrder()

◆ getLogName()

◆ getTransformClass()

◆ measure()

◆ measureN()

Member Data Documentation

◆ APCORR_ORDER

◆ CENTROID_ORDER

◆ config

◆ ConfigClass

◆ DEFAULT_CATALOGCALCULATION

◆ flag

◆ FLUX_ORDER

◆ keyX

◆ keyY

◆ logName

◆ name

◆ registry

◆ SHAPE_ORDER

◆ init()