lsst.meas.base g96728d7751+a8df0f92ae
Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | List of all members
lsst.meas.base.plugins.ForcedPeakCentroidPlugin Class Reference
Inheritance diagram for lsst.meas.base.plugins.ForcedPeakCentroidPlugin:
lsst.meas.base.forcedMeasurement.ForcedPlugin lsst.meas.base.baseMeasurement.BaseMeasurementPlugin lsst.meas.base.pluginsBase.BasePlugin

Public Member Functions

def getExecutionOrder (cls)
 
def __init__ (self, config, name, schemaMapper, metadata)
 
def measure (self, measRecord, exposure, refRecord, refWcs)
 

Static Public Member Functions

def getTransformClass ()
 

Public Attributes

 keyX
 
 keyY
 

Static Public Attributes

 ConfigClass = ForcedPeakCentroidConfig
 

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.

This is similar to `SingleFramePeakCentroidPlugin`, except that transforms
the peak coordinate from the original (reference) coordinate system to the
coordinate system of the exposure being measured.

Parameters
----------
config : `ForcedPeakCentroidConfig`
    Plugin configuraion.
name : `str`
    Plugin name.
schemaMapper : `lsst.afw.table.SchemaMapper`
    A mapping from reference catalog fields to output
    catalog fields. Output fields are added to the output schema.
metadata : `lsst.daf.base.PropertySet`
    Plugin metadata that will be attached to the output catalog.

Definition at line 656 of file plugins.py.

Constructor & Destructor Documentation

◆ __init__()

def lsst.meas.base.plugins.ForcedPeakCentroidPlugin.__init__ (   self,
  config,
  name,
  schemaMapper,
  metadata 
)

Reimplemented from lsst.meas.base.forcedMeasurement.ForcedPlugin.

Definition at line 685 of file plugins.py.

Member Function Documentation

◆ getExecutionOrder()

def lsst.meas.base.plugins.ForcedPeakCentroidPlugin.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 682 of file plugins.py.

◆ getTransformClass()

def lsst.meas.base.plugins.ForcedPeakCentroidPlugin.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 700 of file plugins.py.

◆ measure()

def lsst.meas.base.plugins.ForcedPeakCentroidPlugin.measure (   self,
  measRecord,
  exposure,
  refRecord,
  refWcs 
)
Measure the properties of a source given an image and a reference.

Parameters
----------
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.
measRecord : `lsst.afw.table.SourceRecord`
    Record describing the object being measured. Previously-measured
    quantities will be retrieved from here, and it will be updated
    in-place with the outputs of this plugin.
refRecord : `lsst.afw.table.SimpleRecord`
    Additional parameters to define the fit, as measured elsewhere.
refWcs : `lsst.afw.geom.SkyWcs` or `lsst.afw.geom.Angle`
    The coordinate system for the reference catalog values. An
    `~lsst.geom.Angle` may be passed, indicating that a local tangent
    WCS should be created for each object using the given angle as a
    pixel scale.

Notes
-----
In the normal mode of operation, the source centroid will be set to
the WCS-transformed position of the reference object, so plugins that
only require a reference position should not have to access the
reference object at all.

Reimplemented from lsst.meas.base.forcedMeasurement.ForcedPlugin.

Definition at line 691 of file plugins.py.

Member Data Documentation

◆ ConfigClass

lsst.meas.base.plugins.ForcedPeakCentroidPlugin.ConfigClass = ForcedPeakCentroidConfig
static

Definition at line 679 of file plugins.py.

◆ keyX

lsst.meas.base.plugins.ForcedPeakCentroidPlugin.keyX

Definition at line 688 of file plugins.py.

◆ keyY

lsst.meas.base.plugins.ForcedPeakCentroidPlugin.keyY

Definition at line 689 of file plugins.py.


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