lsst.meas.base
16.0-17-g7e0e4ff+3
|
Base class for measurement plugins. More...
Public Member Functions | |
def | getExecutionOrder (cls) |
def | __init__ (self, config, name, logName=None) |
Initialize the plugin object. More... | |
def | getLogName (self) |
def | fail (self, measRecord, error=None) |
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 | |
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 |
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 40 of file pluginsBase.py.
def lsst.meas.base.pluginsBase.BasePlugin.__init__ | ( | self, | |
config, | |||
name, | |||
logName = None |
|||
) |
Initialize the plugin object.
[in] | config | An instance of this class's ConfigClass. |
[in] | name | The string the plugin was registered with. |
Definition at line 78 of file pluginsBase.py.
def lsst.meas.base.pluginsBase.BasePlugin.fail | ( | self, | |
measRecord, | |||
error = None |
|||
) |
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 93 of file pluginsBase.py.
def lsst.meas.base.pluginsBase.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 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 55 of file pluginsBase.py.
def lsst.meas.base.pluginsBase.BasePlugin.getLogName | ( | self | ) |
Definition at line 90 of file pluginsBase.py.
|
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 115 of file pluginsBase.py.
|
static |
Definition at line 51 of file pluginsBase.py.
|
static |
Definition at line 48 of file pluginsBase.py.
lsst.meas.base.pluginsBase.BasePlugin.config |
Definition at line 86 of file pluginsBase.py.
|
static |
Definition at line 52 of file pluginsBase.py.
|
static |
Definition at line 50 of file pluginsBase.py.
lsst.meas.base.pluginsBase.BasePlugin.logName |
Definition at line 88 of file pluginsBase.py.
lsst.meas.base.pluginsBase.BasePlugin.name |
Definition at line 87 of file pluginsBase.py.
|
static |
Definition at line 49 of file pluginsBase.py.