LSSTApplications: lsst.meas.base.baseMeasurement.BasePlugin Class Reference

Base class for measurement plugins. More...

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

Public Member Functions
def	getExecutionOrder

def	__init__
	Initialize the measurement object. More...

def	fail
	Record a failure of the measure or measureN() method. More...

Static Public Member Functions
def	getTransformClass
	Get the measurement transformation appropriate to this plugin. More...

Public Attributes
	config

	name

Static Public Attributes
float	CENTROID_ORDER = 0.0

float	SHAPE_ORDER = 1.0

float	FLUX_ORDER = 2.0

float	APCORR_ORDER = 4.0

float	CLASSIFY_ORDER = 5.0

Detailed Description

Base class for measurement plugins.

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

Definition at line 58 of file baseMeasurement.py.

Constructor & Destructor Documentation

def lsst.meas.base.baseMeasurement.BasePlugin.__init__	(	self,
		config,
		name
	)

Initialize the measurement object.

Parameters

[in]	config	An instance of this class's ConfigClass.
[in]	name	The string the plugin was registered with.

Definition at line 96 of file baseMeasurement.py.

 
     def __init__(self, config, name):
         """!
         Initialize the measurement object.
 
         @param[in]  config       An instance of this class's ConfigClass.
         @param[in]  name         The string the plugin was registered with.
         """
         object.__init__(self)
         self.config = config
         self.name = name

lsst::meas::base.baseMeasurement.BasePlugin.name

name

Definition: baseMeasurement.py:105

lsst::meas::base.baseMeasurement.BasePlugin.__init__

def __init__

Initialize the measurement object.

Definition: baseMeasurement.py:96

lsst::meas::base.baseMeasurement.BasePlugin.config

config

Definition: baseMeasurement.py:104

Member Function Documentation

def lsst.meas.base.baseMeasurement.BasePlugin.fail	(	self,
		measRecord,
		error = `None`
	)

Record a failure of the measure or measureN() method.

When measure() raises an exception, the measurement framework will call fail() to allow the plugin to set its failure flag field(s). When measureN() raises an exception, fail() will be called repeatedly with all the records that were being measured.

If the exception is a 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 107 of file baseMeasurement.py.

 
     def fail(self, measRecord, error=None):
         """!
         Record a failure of the measure or measureN() method.
 
         When measure() raises an exception, the measurement framework
         will call fail() to allow the plugin to set its failure flag
         field(s).  When measureN() raises an exception, fail() will be
         called repeatedly with all the records that were being
         measured.
 
         If the exception is a 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)

lsst::meas::base.baseMeasurement.BasePlugin.fail

def fail

Record a failure of the measure or measureN() method.

Definition: baseMeasurement.py:107

def lsst.meas.base.baseMeasurement.BasePlugin.getExecutionOrder ( cls )

Sets the relative order of plugins (smaller numbers run first).

In general, the following class constants should be used (other values
are also allowed, but should be avoided unless they are needed):
CENTROID_ORDER  centroids and other algorithms that require only a Footprint and its Peaks as input
SHAPE_ORDER     shape measurements and other algorithms that require getCentroid() to return
        a good centroid (in addition to a Footprint and its Peaks).
FLUX_ORDER      flux algorithms that require both getShape() and getCentroid(),
        in addition to a Footprint and its Peaks
APCORR_ORDER    aperture corrections
CLASSIFY_ORDER  algorithms that operate on aperture-corrected fluxes

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

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 73 of file baseMeasurement.py.

 
     def getExecutionOrder(cls):
         """Sets the relative order of plugins (smaller numbers run first).
 
         In general, the following class constants should be used (other values
         are also allowed, but should be avoided unless they are needed):
         CENTROID_ORDER  centroids and other algorithms that require only a Footprint and its Peaks as input
         SHAPE_ORDER     shape measurements and other algorithms that require getCentroid() to return
                         a good centroid (in addition to a Footprint and its Peaks).
         FLUX_ORDER      flux algorithms that require both getShape() and getCentroid(),
                         in addition to a Footprint and its Peaks
         APCORR_ORDER    aperture corrections
         CLASSIFY_ORDER  algorithms that operate on aperture-corrected fluxes
 
         Must be reimplemented as a class method by concrete derived classes.
 
         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.
         """
         raise NotImplementedError("All plugins must implement getExecutionOrder()")

lsst::meas::base.baseMeasurement.BasePlugin.getExecutionOrder

def getExecutionOrder

Definition: baseMeasurement.py:73

def lsst.meas.base.baseMeasurement.BasePlugin.getTransformClass ( )

static

Get the measurement transformation appropriate to this plugin.

This returns a subclass of 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.

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

Definition at line 129 of file baseMeasurement.py.

 
     def getTransformClass():
         """!
         Get the measurement transformation appropriate to this plugin.
 
         This returns a subclass of 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.
 
         By default, we copy everything from the input to the output without
         transformation.
         """
         return PassThroughTransform
 

lsst::meas::base.baseMeasurement.BasePlugin.getTransformClass

def getTransformClass

Get the measurement transformation appropriate to this plugin.

Definition: baseMeasurement.py:129

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation