lsst.meas.base.wrappers.WrappedSingleFramePlugin Class Reference

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)

Public Attributes
	cpp

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 )

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

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)
 
 

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 )

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.

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

Definition at line 47 of file wrappers.py.

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

Member Data Documentation

cpp

lsst.meas.base.wrappers.WrappedSingleFramePlugin.cpp

Definition at line 40 of file wrappers.py.

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/meas_base/gf18bd8381d+8d59551888/python/lsst/meas/base/wrappers.py