CalibrationStats Class Reference

#include "CalibrationStats.hpp"

+ Inheritance diagram for CalibrationStats:

Public Types

typedef opals::Vector< CalibrationEntryEntryVector

Public Member Functions

 CalibrationStats (double singleCalValue)
 create an object based on a single calibration constant
void reset ()
 reset object (removes all entries)
bool isSetEntries () const
EntryVector getEntries () const
void setEntries (const EntryVector &entries)
int getDefaultCalibrationConstIndex () const
 get index of default calibration constant (-1 if no default calibration constant is set)
double computeDefaultCalibrationConst () const
 compute a default calibration constant (point count weighted average of all calibration constants)
String logCalibrationStats () const
 for xml output

Static Public Member Functions

static bool exportsPythonType ()
static const char * help (bool)
static const char * syntax ()
- Static Public Member Functions inherited from CustomOptionType< CalibrationStats >
static const char * _help (bool forDoxygen)
 get general help on this type
static const char * _syntax ()
 get the syntax used for parsing this type
static bool _exportsPythonType ()
 returns true if this type is exposed to Python as a custom type, false otherwise (if it is represented as Python-string)

Protected Attributes

EntryVector _entries

Additional Inherited Members

- Protected Member Functions inherited from CustomOptionType< CalibrationStats >
 ~CustomOptionType ()
 protected, must be derived from

Detailed Description

The object basically stores a vector of calibrations entries. Each entry corresponds to calibration constant estimation. In case only one calibration constant was estimated (standard), the vector has only one element. If ModuleRadioCal was run with splitByAttribute parameter, an element for each unique attribute value is added to the entry vector. It is possible to store one default entry (CalibrationEntry::isSetAttribute() == false) which is used for calibrating points that do not have an attribute matching element in the entry vector

The class provides three different string to object parser:

  • a simple single real value parser -> creates default entry with the given calibration constant
  • attribute-calibr.constant-matrix parser: "[[attr1 cal.const1] [attr2 cal.const2] ... ]" or "[[] [attr1 cal.const1] [attr2 cal.const2] ... ]"
  • full syntax parser -> parses object to string representation. example: "CalibrationEntry[Attribute[-15] PtsCalibrated[108] CalibrationConst[764.450] Regions[ CalibrationRegion[ Id[600001] Area[0.275] ...] ] ]"

A CalibrationStats object stores full calibration results and statistics.