lsst.meas.base.plugins.SingleFramePeakCentroidPlugin Class Reference

Inheritance diagram for lsst.meas.base.plugins.SingleFramePeakCentroidPlugin:

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)
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

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

Constructor & Destructor Documentation

__init__()

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

Definition at line 435 of file plugins.py.

Member Function Documentation

fail()

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

Definition at line 446 of file plugins.py.

getExecutionOrder()

def lsst.meas.base.plugins.SingleFramePeakCentroidPlugin.getExecutionOrder

(

cls

)

Definition at line 432 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.SingleFramePeakCentroidPlugin.getTransformClass ( )

static

Definition at line 450 of file plugins.py.

measure()

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

Definition at line 441 of file plugins.py.

measureN()

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

inherited

Measure the properties of blended sources on a single image.

This operates on all members of a blend family at once. The image may
be from a single epoch, or it may be a coadd.

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

Notes
-----
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 103 of file sfm.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.SingleFramePeakCentroidPlugin.ConfigClass = SingleFramePeakCentroidConfig

static

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

flag

lsst.meas.base.plugins.SingleFramePeakCentroidPlugin.flag

Definition at line 439 of file plugins.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.SingleFramePeakCentroidPlugin.keyX

Definition at line 437 of file plugins.py.

keyY

lsst.meas.base.plugins.SingleFramePeakCentroidPlugin.keyY

Definition at line 438 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.sfm.SingleFramePlugin.registry = PluginRegistry(SingleFramePluginConfig)

staticinherited

Definition at line 76 of file sfm.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:

• python/lsst/meas/base/plugins.py