Inheritance diagram for lsst.meas.base.wrappers.WrappedSingleFramePlugin:

Public Member Functions
	__init__ (self, config, name, schema, metadata, logName=None)

	measure (self, measRecord, exposure)

	measureN (self, measCat, exposure)

	fail (self, measRecord, error=None)

	getExecutionOrder (cls)

	getLogName (self)

Static Public Member Functions
	getTransformClass ()

Public Attributes
	cpp = self.factory(config, name, schema, metadata, logName=logName)

	config = config

	name = name

	logName = logName

Static Public Attributes
	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

	ConfigClass = BasePluginConfig

Detailed Description

Definition at line 35 of file wrappers.py.

Constructor & Destructor Documentation

◆ init()

lsst.meas.base.wrappers.WrappedSingleFramePlugin.__init__	(	self,
		config,
		name,
		schema,
		metadata,
		logName = None )

Definition at line 37 of file wrappers.py.

    def __init__(self, config, name, schema, metadata, logName=None):
        SingleFramePlugin.__init__(self, config, name, schema, metadata, logName=logName)
        if hasattr(self, "hasLogName") and self.hasLogName and logName is not None:
            self.cpp = self.factory(config, name, schema, metadata, logName=logName)
        else:
            self.cpp = self.factory(config, name, schema, metadata)
 

Member Function Documentation

◆ fail()

lsst.meas.base.wrappers.WrappedSingleFramePlugin.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.

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

Definition at line 50 of file wrappers.py.

    def fail(self, measRecord, error=None):
        self.cpp.fail(measRecord, error.cpp if error is not None else None)

◆ getExecutionOrder()

lsst.meas.base.pluginsBase.BasePlugin.getExecutionOrder ( cls )

inherited

Get the relative execution order of this plugin.

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

Definition at line 121 of file pluginsBase.py.

    def getExecutionOrder(cls):
        """Get the relative execution order of this plugin.
 
        Must be reimplemented as a class method by concrete derived classes.
        """
        raise NotImplementedError("All plugins must implement getExecutionOrder()")
 

◆ getLogName()

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

inherited

Definition at line 134 of file pluginsBase.py.

    def getLogName(self):
        return self.logName
 

◆ getTransformClass()

lsst.meas.base.pluginsBase.BasePlugin.getTransformClass ( )

staticinherited

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 in lsst.meas.base.plugins.ForcedPeakCentroidPlugin, and lsst.meas.base.plugins.SingleFramePeakCentroidPlugin.

Definition at line 169 of file pluginsBase.py.

    def getTransformClass():
        """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.
        """
        return PassThroughTransform

◆ measure()

lsst.meas.base.wrappers.WrappedSingleFramePlugin.measure	(	self,
		measRecord,
		exposure )

Measure the properties of a source on a single image.

The image may be from a single epoch, or it may be a coadd.

Parameters
----------
measRecord : `lsst.afw.table.SourceRecord`
    Record describing the object being measured. Previously-measured
    quantities may be retrieved from here, and it will be updated
    in-place tih 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.

Reimplemented from lsst.meas.base.sfm.SingleFramePlugin.

Definition at line 44 of file wrappers.py.

    def measure(self, measRecord, exposure):
        self.cpp.measure(measRecord, exposure)
 

◆ measureN()

lsst.meas.base.wrappers.WrappedSingleFramePlugin.measureN	(	self,
		measCat,
		exposure )

Definition at line 47 of file wrappers.py.

    def measureN(self, measCat, exposure):
        self.cpp.measureN(measCat, exposure)
 

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 = config

inherited

Definition at line 130 of file pluginsBase.py.

◆ ConfigClass

lsst.meas.base.pluginsBase.BasePlugin.ConfigClass = BasePluginConfig

staticinherited

Definition at line 116 of file pluginsBase.py.

◆ cpp

lsst.meas.base.wrappers.WrappedSingleFramePlugin.cpp = self.factory(config, name, schema, metadata, logName=logName)

Definition at line 40 of file wrappers.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.

◆ logName

lsst.meas.base.pluginsBase.BasePlugin.logName = logName

inherited

Definition at line 132 of file pluginsBase.py.

◆ name

lsst.meas.base.pluginsBase.BasePlugin.name = 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:

/j/snowflake/release/lsstsw/stack/lsst-scipipe-12.1.0/Linux/meas_base/g3e17d7035e+5b3adc59f5/python/lsst/meas/base/wrappers.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

◆ cpp

◆ DEFAULT_CATALOGCALCULATION

◆ FLUX_ORDER

◆ logName

◆ name

◆ registry

◆ SHAPE_ORDER

◆ init()