Base class for all measurement plugins
This is class is a placeholder for future behavior which will be shared only between
measurement plugins and is implemented for symmetry with the measurement base plugin
configuration class
Definition at line 58 of file baseMeasurement.py.
def lsst.meas.base.pluginsBase.BasePlugin.fail |
( |
|
self, |
|
|
|
measRecord, |
|
|
|
error = None |
|
) |
| |
|
inherited |
Record a failure of the measure or measureN() method.
When the plugin raises an exception, 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 95 of file pluginsBase.py.
def lsst.meas.base.pluginsBase.BasePlugin.getExecutionOrder |
( |
|
cls | ) |
|
|
inherited |
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
DEFAULT_CATALOGCALCULATION plugins that only operate on the catalog
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 57 of file pluginsBase.py.
def lsst.meas.base.pluginsBase.BasePlugin.getTransformClass |
( |
| ) |
|
|
staticinherited |
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 117 of file pluginsBase.py.