Inheritance diagram for lsst.meas.base.sfm.SingleFramePlugin:

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

	measure (self, measRecord, exposure)

	measureN (self, measCat, exposure)

	getExecutionOrder (cls)

	getLogName (self)

	fail (self, measRecord, error=None)

Static Public Member Functions
	getTransformClass ()

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

Base class for single-frame measurement plugin.

Parameters
----------
config : `SingleFramePlugin.ConfigClass`
    Configuration for this plugin.
name : `str`
    The string with which the plugin was registered.
schema : `lsst.afw.table.Schema`
    The schema for the source table . New fields are added here to
    hold measurements produced by this plugin.
metadata : `lsst.daf.base.PropertySet`
    Plugin metadata that will be attached to the output catalog
logName : `str`, optional
    Name to use when logging errors.

Notes
-----
New plugins can be created in Python by inheriting directly from this
class and implementing the `measure`, `fail` (from `BasePlugin`), and
optionally `__init__` and `measureN` methods.  Plugins can also be defined
in C++ via the `WrappedSingleFramePlugin` class.

Definition at line 52 of file sfm.py.

Constructor & Destructor Documentation

◆ init()

lsst.meas.base.sfm.SingleFramePlugin.__init__	(		self,
			config,
			name,
			schema,
			metadata,
			logName = None,
		**	kwds )

Definition at line 83 of file sfm.py.

    def __init__(self, config, name, schema, metadata, logName=None, **kwds):
        BaseMeasurementPlugin.__init__(self, config, name, logName=logName)
 

Member Function Documentation

◆ fail()

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

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.sfm.SingleFramePlugin.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.

Definition at line 86 of file sfm.py.

    def 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.
        """
        raise NotImplementedError()
 

◆ measureN()

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

Definition at line 104 of file sfm.py.

    def 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.
        """
        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 = 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.

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

static

Definition at line 77 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-10.0.0/Linux64/meas_base/g56a49b3a55+369644a549/python/lsst/meas/base/sfm.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

◆ logName

◆ name

◆ registry

◆ SHAPE_ORDER

◆ init()