lsst.meas.base  17.0.1-7-g35889ee+1
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)
 
def measureN (self, measCat, exposure, refCat, refWcs)
 
def getLogName (self)
 
def fail (self, measRecord, error=None)
 

Static Public Member Functions

def getTransformClass ()
 

Public Attributes

 keyX
 
 keyY
 
 config
 
 name
 
 logName
 

Static Public Attributes

 ConfigClass = ForcedPeakCentroidConfig
 
 registry = PluginRegistry(ForcedPluginConfig)
 
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.

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

Constructor & Destructor Documentation

◆ __init__()

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

Definition at line 538 of file plugins.py.

Member Function Documentation

◆ fail()

def lsst.meas.base.pluginsBase.BasePlugin.fail (   self,
  measRecord,
  error = None 
)
inherited
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.

Definition at line 137 of file pluginsBase.py.

◆ getExecutionOrder()

def lsst.meas.base.plugins.ForcedPeakCentroidPlugin.getExecutionOrder (   cls)

Definition at line 535 of file plugins.py.

◆ getLogName()

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

Definition at line 134 of file pluginsBase.py.

◆ getTransformClass()

def lsst.meas.base.plugins.ForcedPeakCentroidPlugin.getTransformClass ( )
static

Definition at line 553 of file plugins.py.

◆ measure()

def lsst.meas.base.plugins.ForcedPeakCentroidPlugin.measure (   self,
  measRecord,
  exposure,
  refRecord,
  refWcs 
)

Definition at line 544 of file plugins.py.

◆ measureN()

def lsst.meas.base.forcedMeasurement.ForcedPlugin.measureN (   self,
  measCat,
  exposure,
  refCat,
  refWcs 
)
inherited
Measure the properties of blended sources from image & reference.

This operates on all members of a blend family at once.

Parameters
----------
exposure : `lsst.afw.image.ExposureF`
    The pixel data to be measured, together with the associated PSF,
    WCS, etc. Sources not in the blended hierarchy to be measured
    should have been replaced with noise using deblender outputs.
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.
refCat : `lsst.afw.table.SimpleCatalog`
    Additional parameters to define the fit, as measured elsewhere.
    Ordered such that ``zip(measCat, refcat)`` may be used.
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 centroids 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.

Definition at line 134 of file forcedMeasurement.py.

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.ForcedPeakCentroidPlugin.ConfigClass = ForcedPeakCentroidConfig
static

Definition at line 532 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.

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

Definition at line 541 of file plugins.py.

◆ keyY

lsst.meas.base.plugins.ForcedPeakCentroidPlugin.keyY

Definition at line 542 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.forcedMeasurement.ForcedPlugin.registry = PluginRegistry(ForcedPluginConfig)
staticinherited

Definition at line 95 of file forcedMeasurement.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: