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

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

Constructor & Destructor Documentation

◆ init()

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

Definition at line 685 of file plugins.py.

     def __init__(self, config, name, schemaMapper, metadata):
         ForcedPlugin.__init__(self, config, name, schemaMapper, metadata)
         schema = schemaMapper.editOutputSchema()
         self.keyX = schema.addField(name + "_x", type="D", doc="peak centroid", units="pixel")
         self.keyY = schema.addField(name + "_y", type="D", doc="peak centroid", units="pixel")
  

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.

     def fail(self, measRecord, error=None):
         """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.
  
         """
         traceback.print_exc()
         message = ("The algorithm '%s' thinks it cannot fail, but it did; "
                    "please report this as a bug (the full traceback is above)."
                    % (self.__class__.__name__,))
         raise NotImplementedError(message)
  

◆ getExecutionOrder()

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

Get the relative execution order of this plugin.

Must be reimplemented as a class method by concrete derived classes.

Reimplemented from lsst.meas.base.pluginsBase.BasePlugin.

Definition at line 682 of file plugins.py.

     def getExecutionOrder(cls):
         return cls.CENTROID_ORDER
  

◆ getLogName()

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

inherited

Definition at line 134 of file pluginsBase.py.

     def getLogName(self):
         return self.logName
  

◆ getTransformClass()

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

static

Get the measurement transformation appropriate to this plugin.

This returns a subclass of `transforms.MeasurementTransform`, which
may be instantiated with details of the algorithm configuration and
then called with information about calibration and WCS to convert from
raw measurement quantities to calibrated units. Calibrated data is
then provided in a separate output table.

Notes
-----
By default, we copy everything from the input to the output without
transformation.

Reimplemented from lsst.meas.base.pluginsBase.BasePlugin.

Definition at line 700 of file plugins.py.

     def getTransformClass():
         return SimpleCentroidTransform

◆ measure()

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

Measure the properties of a source given an image and a reference.

Parameters
----------
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.
measRecord : `lsst.afw.table.SourceRecord`
    Record describing the object being measured. Previously-measured
    quantities will be retrieved from here, and it will be updated
    in-place with the outputs of this plugin.
refRecord : `lsst.afw.table.SimpleRecord`
    Additional parameters to define the fit, as measured elsewhere.
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 centroid 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.

Reimplemented from lsst.meas.base.forcedMeasurement.ForcedPlugin.

Definition at line 691 of file plugins.py.

     def measure(self, measRecord, exposure, refRecord, refWcs):
         targetWcs = exposure.getWcs()
         peak = refRecord.getFootprint().getPeaks()[0]
         result = lsst.geom.Point2D(peak.getFx(), peak.getFy())
         result = targetWcs.skyToPixel(refWcs.pixelToSky(result))
         measRecord.set(self.keyX, result.getX())
         measRecord.set(self.keyY, result.getY())
  

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

Reimplemented in lsst.meas.base.wrappers.WrappedForcedPlugin.

Definition at line 135 of file forcedMeasurement.py.

     def measureN(self, measCat, exposure, refCat, refWcs):
         """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.
         """
         raise NotImplementedError()
  
  

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

◆ keyY

lsst.meas.base.plugins.ForcedPeakCentroidPlugin.keyY

Definition at line 689 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 96 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:

/j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/meas_base/22.0.1-25-gb120d7b+8b5510f75f/python/lsst/meas/base/plugins.py

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ fail()

◆ getExecutionOrder()

◆ getLogName()

◆ getTransformClass()

◆ measure()

◆ measureN()

Member Data Documentation

◆ APCORR_ORDER

◆ CENTROID_ORDER

◆ config

◆ ConfigClass

◆ DEFAULT_CATALOGCALCULATION

◆ FLUX_ORDER

◆ keyX

◆ keyY

◆ logName

◆ name

◆ registry

◆ SHAPE_ORDER

◆ init()