lsst.meas.base  14.0-13-gd9a51ef+4
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)
 
def measureN (self, measCat, exposure)
 Measure the properties of a group of blended sources on a single image (single-epoch image or coadd). More...
 
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

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

Constructor & Destructor Documentation

◆ __init__()

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

Definition at line 333 of file plugins.py.

Member Function Documentation

◆ fail()

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

Definition at line 344 of file plugins.py.

◆ getExecutionOrder()

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

Definition at line 330 of file plugins.py.

◆ getLogName()

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

Definition at line 92 of file pluginsBase.py.

◆ getTransformClass()

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

Definition at line 348 of file plugins.py.

◆ measure()

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

Definition at line 339 of file plugins.py.

◆ measureN()

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

Measure the properties of a group of blended sources on a single image (single-epoch image or coadd).

Parameters
[in,out]measCatlsst.afw.table.SourceCatalog to be filled with outputs, and from which previously-measured quantities can be retrieved, containing only the sources that should be measured together in this call.
[in]exposurelsst.afw.image.ExposureF, containing the pixel data to be measured and the associated Psf, Wcs, etc. Sources not in the blended hierarchy to be measured will have been replaced with noise using deblender outputs.

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.

Definition at line 93 of file sfm.py.

Member Data Documentation

◆ APCORR_ORDER

float lsst.meas.base.pluginsBase.BasePlugin.APCORR_ORDER = 3.0
staticinherited

Definition at line 53 of file pluginsBase.py.

◆ CENTROID_ORDER

float lsst.meas.base.pluginsBase.BasePlugin.CENTROID_ORDER = 0.0
staticinherited

Definition at line 50 of file pluginsBase.py.

◆ config

lsst.meas.base.pluginsBase.BasePlugin.config
inherited

Definition at line 88 of file pluginsBase.py.

◆ ConfigClass

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

Definition at line 327 of file plugins.py.

◆ DEFAULT_CATALOGCALCULATION

float lsst.meas.base.pluginsBase.BasePlugin.DEFAULT_CATALOGCALCULATION = 4.0
staticinherited

Definition at line 54 of file pluginsBase.py.

◆ flag

lsst.meas.base.plugins.SingleFramePeakCentroidPlugin.flag

Definition at line 337 of file plugins.py.

◆ FLUX_ORDER

float lsst.meas.base.pluginsBase.BasePlugin.FLUX_ORDER = 2.0
staticinherited

Definition at line 52 of file pluginsBase.py.

◆ keyX

lsst.meas.base.plugins.SingleFramePeakCentroidPlugin.keyX

Definition at line 335 of file plugins.py.

◆ keyY

lsst.meas.base.plugins.SingleFramePeakCentroidPlugin.keyY

Definition at line 336 of file plugins.py.

◆ logName

lsst.meas.base.pluginsBase.BasePlugin.logName
inherited

Definition at line 90 of file pluginsBase.py.

◆ name

lsst.meas.base.pluginsBase.BasePlugin.name
inherited

Definition at line 89 of file pluginsBase.py.

◆ registry

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

Definition at line 61 of file sfm.py.

◆ SHAPE_ORDER

float lsst.meas.base.pluginsBase.BasePlugin.SHAPE_ORDER = 1.0
staticinherited

Definition at line 51 of file pluginsBase.py.


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