lsst.meas.base  13.0-26-g0f127ff+5
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)
 
- Public Member Functions inherited from lsst.meas.base.sfm.SingleFramePlugin
def __init__ (self, config, name, schema, metadata, logName=None, kwds)
 Initialize the measurement object. More...
 
def measure (self, measRecord, exposure)
 Measure the properties of a source on a single image (single-epoch image or coadd). More...
 
def measureN (self, measCat, exposure)
 Measure the properties of a group of blended sources on a single image (single-epoch image or coadd). More...
 
- Public Member Functions inherited from lsst.meas.base.pluginsBase.BasePlugin
def getExecutionOrder (cls)
 
def __init__ (self, config, name, logName=None)
 Initialize the plugin object. More...
 
def getLogName (self)
 
def fail (self, measRecord, error=None)
 Record a failure of the measure or measureN() method. More...
 

Static Public Member Functions

def getTransformClass ()
 
- Static Public Member Functions inherited from lsst.meas.base.pluginsBase.BasePlugin
def getTransformClass ()
 Get the measurement transformation appropriate to this plugin. More...
 

Public Attributes

 keyX
 
 keyY
 
 flag
 
- Public Attributes inherited from lsst.meas.base.pluginsBase.BasePlugin
 config
 
 name
 
 logName
 

Static Public Attributes

 ConfigClass = SingleFramePeakCentroidConfig
 
- Static Public Attributes inherited from lsst.meas.base.sfm.SingleFramePlugin
 registry = PluginRegistry(SingleFramePluginConfig)
 
 ConfigClass = SingleFramePluginConfig
 
- Static Public Attributes inherited from lsst.meas.base.pluginsBase.BasePlugin
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

A centroid algorithm that simply uses the first (i.e. highest) Peak in the Source's
Footprint as the 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.

Definition at line 314 of file plugins.py.

Constructor & Destructor Documentation

◆ __init__()

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

Definition at line 327 of file plugins.py.

Member Function Documentation

◆ fail()

def lsst.meas.base.plugins.SingleFramePeakCentroidPlugin.fail (   self,
  measRecord,
  error = None 
)

Definition at line 338 of file plugins.py.

◆ getExecutionOrder()

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

Definition at line 324 of file plugins.py.

◆ getTransformClass()

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

Definition at line 342 of file plugins.py.

◆ measure()

def lsst.meas.base.plugins.SingleFramePeakCentroidPlugin.measure (   self,
  measRecord,
  exposure 
)

Definition at line 333 of file plugins.py.

Member Data Documentation

◆ ConfigClass

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

Definition at line 321 of file plugins.py.

◆ flag

lsst.meas.base.plugins.SingleFramePeakCentroidPlugin.flag

Definition at line 331 of file plugins.py.

◆ keyX

lsst.meas.base.plugins.SingleFramePeakCentroidPlugin.keyX

Definition at line 329 of file plugins.py.

◆ keyY

lsst.meas.base.plugins.SingleFramePeakCentroidPlugin.keyY

Definition at line 330 of file plugins.py.


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