Inheritance diagram for lsst.meas.base.pluginsBase.BasePlugin:

Public Member Functions
	getExecutionOrder (cls)

	__init__ (self, config, name, logName=None)

	getLogName (self)

	fail (self, measRecord, error=None)

Static Public Member Functions
	getTransformClass ()

Public Attributes
	config

	name

	logName

Static Public Attributes
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 measurement plugins.

This is the base class for `SingleFramePlugin` and `ForcedPlugin`; derived
classes should inherit from one of those.

Parameters
----------
config : `BasePluginConfig`
    Plugin configuration.
name : `str`
    Plugin name.
logName : `str`
    Logger name.

Notes
-----
Relative execution orders are defined by a series of named constants
defined in this class: plugins with a lower execution number are run
first.

This approach was chosen instead of a full graph-based analysis of
dependencies because algorithm dependencies are usually both quite simple
and entirely substitutable: an algorithm that requires a centroid can
typically make use of any centroid algorithms outputs.  That makes it
relatively easy to figure out the correct value to use for any particular
algorithm.

Definition at line 42 of file pluginsBase.py.

Constructor & Destructor Documentation

◆ init()

lsst.meas.base.pluginsBase.BasePlugin.__init__	(	self,
		config,
		name,
		logName = None )

Definition at line 128 of file pluginsBase.py.

    def __init__(self, config, name, logName=None):
        object.__init__(self)
        self.config = config
        self.name = name
        self.logName = logName
 

Member Function Documentation

◆ fail()

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

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 )

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 )

Definition at line 134 of file pluginsBase.py.

    def getLogName(self):
        return self.logName
 

◆ getTransformClass()

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

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

Member Data Documentation

◆ APCORR_ORDER

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

static

Definition at line 98 of file pluginsBase.py.

◆ CENTROID_ORDER

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

static

Definition at line 72 of file pluginsBase.py.

◆ config

lsst.meas.base.pluginsBase.BasePlugin.config

Definition at line 130 of file pluginsBase.py.

◆ ConfigClass

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

static

Definition at line 116 of file pluginsBase.py.

◆ DEFAULT_CATALOGCALCULATION

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

static

Definition at line 108 of file pluginsBase.py.

◆ FLUX_ORDER

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

static

Definition at line 89 of file pluginsBase.py.

◆ logName

lsst.meas.base.pluginsBase.BasePlugin.logName

Definition at line 132 of file pluginsBase.py.

◆ name

lsst.meas.base.pluginsBase.BasePlugin.name

Definition at line 131 of file pluginsBase.py.

◆ SHAPE_ORDER

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

static

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-8.0.0/Linux64/meas_base/g6c1bc301e9+51106c2951/python/lsst/meas/base/pluginsBase.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()

Member Data Documentation

◆ APCORR_ORDER

◆ CENTROID_ORDER

◆ config

◆ ConfigClass

◆ DEFAULT_CATALOGCALCULATION

◆ FLUX_ORDER

◆ logName

◆ name

◆ SHAPE_ORDER

◆ init()