lsst.meas.base gd28f579bee+91170589b1
Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | List of all members
lsst.meas.base.plugins.SingleFramePeakCentroidPlugin Class Reference
Inheritance diagram for lsst.meas.base.plugins.SingleFramePeakCentroidPlugin:
lsst.meas.base.sfm.SingleFramePlugin lsst.meas.base.baseMeasurement.BaseMeasurementPlugin lsst.meas.base.pluginsBase.BasePlugin

Public Member Functions

def getExecutionOrder (cls)
 
def __init__ (self, config, name, schema, metadata)
 
def measure (self, measRecord, exposure)
 
def fail (self, measRecord, error=None)
 

Static Public Member Functions

def getTransformClass ()
 

Public Attributes

 keyX
 
 keyY
 
 flag
 

Static Public Attributes

 ConfigClass = SingleFramePeakCentroidConfig
 

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 
)

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

Definition at line 582 of file plugins.py.

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.

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

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

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

Member Data Documentation

◆ ConfigClass

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

Definition at line 576 of file plugins.py.

◆ flag

lsst.meas.base.plugins.SingleFramePeakCentroidPlugin.flag

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


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