CalibrationEntry Class Reference

A CalibrationEntry object stores statistics and results of one calibration constant estimation. More...

#include "CalibrationStats.hpp"

Public Types

typedef opals::Vector< CalibrationRegionRegionVector
 

Public Member Functions

void reset ()
 
bool isSetAttribute () const
 
bool isSetPtsCalibrated () const
 
bool isSetCalibrationConst () const
 
bool isSetRegions () const
 
int64_t getAttribute () const
 
int64_t getPtsCalibrated () const
 sum of calibrated points in all regions
 
double getCalibrationConst () const
 
RegionVector getRegions () const
 
void setAttribute (const int64_t &attribute)
 
void setPtsCalibrated (const int64_t &pts)
 
void setCalibrationConst (const double &cal)
 
void setRegions (const RegionVector &regions)
 
double computeWeightedMeanOfMedians () const
 computes the point weighted average of the median of all regions
 
String logCalibrationEntry () const
 for xml output
 

Protected Attributes

int64_t _attribute
 
int64_t _ptsCalibrated
 
double _calibrationConst
 
RegionVector _regions
 

Detailed Description

A CalibrationEntry object stores statistics and results of one calibration constant estimation.

ModuleRadioCal estimates the calibration constant based on (multiple) defined regions with known reflectivity. For each region a CalibrationRegion object is added to the region vector. The accumulated results of the regions are then stored within the object itself. In case the splitByAttribute parameter was set for ModuleRadioCal run, the corresponding attribute value is also stored. If the attribute is empty (isSetAttribute() == false) the object is considered as the default entry object.