lsst.meas.base  16.0-17-g7e0e4ff+11
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)
 Record a failure of the measure or measureN() method. More...
 

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

The forced peak centroid is like the SFM peak centroid plugin, except that it must transform
the peak coordinate from the original (reference) coordinate system to the coordinate system
of the exposure being measured.

Definition at line 390 of file plugins.py.

Constructor & Destructor Documentation

◆ __init__()

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

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

When the plugin raises an exception, framework will call fail() to allow the plugin to set its failure flag field(s). When measureN() raises an exception, fail() will be called repeatedly with all the records that were being measured.

If the exception is a 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 93 of file pluginsBase.py.

◆ getExecutionOrder()

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

Definition at line 400 of file plugins.py.

◆ getLogName()

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

Definition at line 90 of file pluginsBase.py.

◆ getTransformClass()

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

Definition at line 418 of file plugins.py.

◆ measure()

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

Definition at line 409 of file plugins.py.

◆ measureN()

def lsst.meas.base.forcedMeasurement.ForcedPlugin.measureN (   self,
  measCat,
  exposure,
  refCat,
  refWcs 
)
inherited
Measure the properties of a group of blended sources on a single image,
given data from a reference record.

@param[in] exposure      lsst.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.
@param[in,out] measCat   lsst.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.
@param[in] refCat        lsst.afw.table.SimpleCatalog that contains additional
                 parameters to define the fit, as measured elsewhere.
                 Ordered such that zip(sources, references) may be used.
@param[in] refWcs        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 afw.image.makeLocalWcs and the given Angle as
                 a pixel scale.

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 114 of file forcedMeasurement.py.

Member Data Documentation

◆ APCORR_ORDER

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

Definition at line 51 of file pluginsBase.py.

◆ CENTROID_ORDER

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

Definition at line 48 of file pluginsBase.py.

◆ config

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

Definition at line 86 of file pluginsBase.py.

◆ ConfigClass

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

Definition at line 397 of file plugins.py.

◆ DEFAULT_CATALOGCALCULATION

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

Definition at line 52 of file pluginsBase.py.

◆ FLUX_ORDER

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

Definition at line 50 of file pluginsBase.py.

◆ keyX

lsst.meas.base.plugins.ForcedPeakCentroidPlugin.keyX

Definition at line 406 of file plugins.py.

◆ keyY

lsst.meas.base.plugins.ForcedPeakCentroidPlugin.keyY

Definition at line 407 of file plugins.py.

◆ logName

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

Definition at line 88 of file pluginsBase.py.

◆ name

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

Definition at line 87 of file pluginsBase.py.

◆ registry

lsst.meas.base.forcedMeasurement.ForcedPlugin.registry = PluginRegistry(ForcedPluginConfig)
staticinherited

Definition at line 70 of file forcedMeasurement.py.

◆ SHAPE_ORDER

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

Definition at line 49 of file pluginsBase.py.


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