BaseMeasurementPlugin¶
-
class
lsst.meas.base.
BaseMeasurementPlugin
(config, name, logName=None)¶ Bases:
lsst.meas.base.BasePlugin
Base class for all measurement plugins.
Notes
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
Attributes Summary
APCORR_ORDER
CENTROID_ORDER
DEFAULT_CATALOGCALCULATION
FLUX_ORDER
SHAPE_ORDER
Methods Summary
fail
(measRecord[, error])Record a failure of the measure
ormeasureN
method.getExecutionOrder
()Get the relative execution order of this plugin. getLogName
()getTransformClass
()Get the measurement transformation appropriate to this plugin. Attributes Documentation
-
APCORR_ORDER
= 3.0¶
-
CENTROID_ORDER
= 0.0¶
-
DEFAULT_CATALOGCALCULATION
= 4.0¶
-
FLUX_ORDER
= 2.0¶
-
SHAPE_ORDER
= 1.0¶
Methods Documentation
-
fail
(measRecord, error=None)¶ Record a failure of the
measure
ormeasureN
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 beNone
.
Notes
When the plugin raises an exception, framework will call
BasePlugin.fail
to allow the plugin to set its failure flag field(s). WhenBasePlugin.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 beNone
, and the failure will be logged by the measurement framework as a warning.- measRecord :
-
classmethod
getExecutionOrder
()¶ Get the relative execution order of this plugin.
Must be reimplemented as a class method by concrete derived classes.
-
getLogName
()¶
-
static
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.
-