JCALIBRATE::JHVInterpolator Struct Reference

Auxiliary data structure to store high-voltage versus gain data and interpolate the nominal high-voltage. More...

#include <JHVInterpolator.hh>

Public Member Functions
	JHVInterpolator (TMultiGraph &object)
	Constructor. More...
void	AddPoint (Double_t HV, Double_t gain, Double_t gainError)
	Add point to diagram. More...
void	SetPoint (Int_t i, Double_t HV, Double_t gain, Double_t gainError)
	Set point with index i. More...
const bool	checkHV (const double HV) const
	Checks whether high-voltage is within range. More...
const bool	checkHV (const double HV1, const double HV2) const
	Checks whether two high-voltage values are different. More...
const bool	checkGain (const double gain) const
	Checks if gain is within range. More...
const bool	areIncreasing (const Int_t i, const Int_t j) const
	Checks whether the gains of two points are strictly increasing as function of their absolute high-voltage. More...
const bool	areValid (const Int_t i, const Int_t j) const
	Checks whether two points are valid for inter-/extrapolation. More...
bool	interpolateHV (const double gainTarget)
	Inter-/Extrapolate the high-voltage value corresponding to the target gain value. More...
double	getHV () const
	Get interpolated high-voltage. More...
double	getHVError () const
	Get error estimate on interpolated high-voltage. More...
TGraphErrors *	getData () const
	Get graph with the input data for the interpolation. More...
TGraphErrors *	getResult () const
	Get graph with the interpolation result. More...

Static Public Member Functions
static void	setMinHVDistance (const double minDist)
	Set minimal separation distance for high-voltage. More...
static void	setHVRange (const JRange< double > range)
	Set valid gain range. More...
static void	setGainRange (const JRange< double > range)
	Set valid gain range. More...

Private Attributes
TMultiGraph *	data
	HV-versus-gain data. More...

Static Private Attributes
static double	dHVmin = 2 * 3.14
	Minimal high-voltage difference between two points [V]. More...
static JRange< double >	hvRange = JRange<double>(-1500, -80)
	Allowed high-voltage range [V]. More...
static JRange< double >	gainRange
	Allowed gain range. More...

Detailed Description

Auxiliary data structure to store high-voltage versus gain data and interpolate the nominal high-voltage.

Definition at line 37 of file JHVInterpolator.hh.

Constructor & Destructor Documentation

JCALIBRATE::JHVInterpolator::JHVInterpolator ( TMultiGraph &  object )

inline

Constructor.

Parameters

object

TMultiGraph object

Definition at line 44 of file JHVInterpolator.hh.

                                         :
      data(&object)
    {
      TGraphErrors* g0 = new TGraphErrors();

      g0->SetName(HVINTERPOLATOR_RESULT);
      g0->SetLineColor  (kRed);
      g0->SetMarkerColor(kRed);
      g0->SetMarkerStyle(kFullDotSmall);
      g0->Set(0);

      data->Add(g0);
      
      TGraphErrors* g1 = new TGraphErrors();
      
      g1->SetName(HVINTERPOLATOR_DATA);
      g1->SetMarkerStyle(kFullDotSmall);
      g1->Set(0);
      
      data->Add(g1);
    }

Member Function Documentation

void JCALIBRATE::JHVInterpolator::AddPoint ( Double_t  HV, Double_t  gain, Double_t  gainError  )

inline

Add point to diagram.

Parameters

HV	high-voltage [V]
gain	gain value
gainError	error on gain value

Definition at line 74 of file JHVInterpolator.hh.

    {      
      TGraphErrors* g1 = getData();
      
      const Int_t   N  = g1->GetN();
      
      g1->SetPoint     (N, fabs(HV), gain);
      g1->SetPointError(N, 0.0, gainError);
    }

void JCALIBRATE::JHVInterpolator::SetPoint ( Int_t  i, Double_t  HV, Double_t  gain, Double_t  gainError  )

inline

Set point with index i.

Parameters

i	index of point
HV	high-voltage [V]
gain	gain value
gainError	error on gain value

Definition at line 93 of file JHVInterpolator.hh.

    {
      TGraphErrors* g1 = getData();

      g1->SetPoint     (i, fabs(HV), gain);
      g1->SetPointError(i, 0.0, gainError);
    }

const bool JCALIBRATE::JHVInterpolator::checkHV ( const double  HV ) const

inline

Checks whether high-voltage is within range.

Parameters

HV	high-voltage [V]

Returns

true if high-voltage is within range; else false

Definition at line 108 of file JHVInterpolator.hh.

    {
      return (HV > hvRange.getLowerLimit() &&
              HV < hvRange.getUpperLimit());
    }

const bool JCALIBRATE::JHVInterpolator::checkHV ( const double  HV1, const double  HV2  ) const

inline

Checks whether two high-voltage values are different.

Parameters

HV1	first high-voltage [V]
HV2	second high-voltage [V]

Returns

true if absolute difference is greater than minimal required difference; else false

Definition at line 122 of file JHVInterpolator.hh.

    {
      return (fabs(HV1 - HV2) > dHVmin);
    }

const bool JCALIBRATE::JHVInterpolator::checkGain ( const double  gain ) const

inline

Checks if gain is within range.

Parameters

gain	gain value

Returns

true if gain within allowed range; else false

Definition at line 134 of file JHVInterpolator.hh.

    {
      return (gain > gainRange.getLowerLimit() &&
              gain < gainRange.getUpperLimit());
    }

const bool JCALIBRATE::JHVInterpolator::areIncreasing ( const Int_t  i, const Int_t  j  ) const

inline

Checks whether the gains of two points are strictly increasing as function of their absolute high-voltage.

Parameters

i	index of first point
j	index of second point

Returns

true if gains of given points are strictly increasing
as function of the absolute high-voltage; else false

Definition at line 149 of file JHVInterpolator.hh.

    {
      TGraphErrors* g1 = getData();
      
      if ((i >= 0 && i < g1->GetN()) &&
          (j >= 0 && i < g1->GetN())) {
          
        return ((g1->GetPointX(i) > g1->GetPointX(j) && g1->GetPointY(i) > g1->GetPointY(j)) ||
                (g1->GetPointX(i) < g1->GetPointX(j) && g1->GetPointY(i) < g1->GetPointY(j)));
        
      } else {

        return false;
      }
    }

const bool JCALIBRATE::JHVInterpolator::areValid ( const Int_t  i, const Int_t  j  ) const

inline

Checks whether two points are valid for inter-/extrapolation.

Parameters

i	index of first point
j	index of second point

Returns

true if valid for inter-/extrapolation; else false

Definition at line 173 of file JHVInterpolator.hh.

    {
      TGraphErrors* g1 = getData();
      
      if ((i >= 0 && i < g1->GetN()) &&
          (j >= 0 && j < g1->GetN())) {

        const double HV_i   = -fabs(g1->GetPointX(i));
        const double HV_j   = -fabs(g1->GetPointX(j));
        const double gain_i =       g1->GetPointY(i);
        const double gain_j =       g1->GetPointY(j);
        
        return (areIncreasing(   i,    j) && checkHV(HV_i) && checkGain(gain_i) &&
                checkHV      (HV_i, HV_j) && checkHV(HV_j) && checkGain(gain_j));
        
      } else {
        
        return false;
      }
    }

bool JCALIBRATE::JHVInterpolator::interpolateHV ( const double  gainTarget )

inline

Inter-/Extrapolate the high-voltage value corresponding to the target gain value.

Parameters

gainTarget

target gain value for inter-/extrapolation

Returns

true if inter-/extrapolation successful; else false

Definition at line 201 of file JHVInterpolator.hh.

    {
      TGraphErrors* g1 = getData();
      
      if (g1->GetN() < 2 || !checkGain(gainTarget)) {
        return false;
      }
      
      // Search for valid inter-/extrapolation points
      
      Int_t i = 0;
      Int_t j = 1;
      
      for (Int_t k = 2; k < g1->GetN(); ++k) {

        const double dGain_i = fabs(g1->GetPointY(i) - gainTarget);     
        const double dGain_j = fabs(g1->GetPointY(j) - gainTarget);
        const double dGain_k = fabs(g1->GetPointY(k) - gainTarget);

        if         (dGain_k < dGain_j) {
          i = (areValid(j,k) ? j : i);
          j = k;
        } else if ((dGain_k < dGain_i || !areValid(i,j)) && areValid(j,k)) {
          i = j;
          j = k;
        }
      }

      // Inter-/Extrapolate high-voltage corresponding to given gain
      
      if (areValid(i, j)) {
        
        const double logHV0 = log(fabs(g1->GetPointX(i)));
        const double logHV1 = log(fabs(g1->GetPointX(j)));
        
        const double logG0  = log(g1->GetPointY(i));
        const double logG1  = log(g1->GetPointY(j));
        const double elogG0 = g1->GetErrorY(i) / g1->GetPointY(i);
        const double elogG1 = g1->GetErrorY(j) / g1->GetPointY(j);
        
        const double dlogG0 = log(gainTarget) - logG0;
        const double dlogG1 = log(gainTarget) - logG1;
        
        const double slope  = (logG1 - logG0) / (logHV1 - logHV0);
        
        const double HVnom  = exp(dlogG0 / slope + logHV0);
        const double eHVnom = HVnom * sqrt(dlogG1 * dlogG1 * elogG0 * elogG0 +
                                           dlogG0 * dlogG0 * elogG1 * elogG1) / fabs(slope * (logG1 - logG0));
        
        const        double distance = fabs((log(HVnom) - logHV0) / (logHV0 - logHV1));
        static const double maxDist  = 2.0;
        
        if (checkHV(-HVnom) && distance < maxDist) {
          
          TGraphErrors* g0 = getResult();
          
          g0->SetPoint     (0,  HVnom, gainTarget);
          g0->SetPointError(0, eHVnom,        0.0);
          
          return true;
        }
      }
      
      return false;
    }

double JCALIBRATE::JHVInterpolator::getHV ( ) const

inline

Get interpolated high-voltage.

Returns

inter-/extrapolated high-voltage
corresponding to target gain value [V]

Definition at line 274 of file JHVInterpolator.hh.

    {
      TGraphErrors* g0 = getResult();
      
      if (g0->GetN() > 0) {
        
        return g0->GetPointX(0);
        
      } else {

        THROW(JNoValue, "JHVInterpolator::getHV(): Missing HV inter-/extrapolation point. Please call JHVInterpolator::interpolateHV() first.");
      }
    }

double JCALIBRATE::JHVInterpolator::getHVError ( ) const

inline

Get error estimate on interpolated high-voltage.

Returns

error on inter-/extrapolated high-voltage
corresponding to the target gain value [V]

Definition at line 295 of file JHVInterpolator.hh.

    {
      TGraphErrors* g0 = getResult();
      
      if (g0->GetN() > 0) {

        return g0->GetErrorX(0);
        
      } else {

        THROW(JNoValue, "JHVInterpolator::getHVError(): Missing HV inter-/extrpolation point. Please call JHVInterpolator::interpolateHV() first.");    
      }
    }

TGraphErrors* JCALIBRATE::JHVInterpolator::getData ( ) const

inline

Get graph with the input data for the interpolation.

Returns

pointer to graph with input data

Definition at line 315 of file JHVInterpolator.hh.

    {
      TList* list = data->GetListOfGraphs();

      if (list != NULL && list->FindObject(HVINTERPOLATOR_DATA) != NULL) {
        
        return (TGraphErrors*)list->FindObject(HVINTERPOLATOR_DATA);
        
      } else if (list == NULL) {

        THROW(JNullPointerException, "JHVInterpolator()::getData(): Emtpy list of graphs.");

      } else {

        THROW(JNullPointerException, "JHVInterpolator()::getData(): No " << HVINTERPOLATOR_DATA << " graph.");
      }
    }

TGraphErrors* JCALIBRATE::JHVInterpolator::getResult ( ) const

inline

Get graph with the interpolation result.

Returns

pointer to graph with the interpolation result

Definition at line 339 of file JHVInterpolator.hh.

    {
      TList* list = data->GetListOfGraphs();

      if (list != NULL && list->FindObject(HVINTERPOLATOR_RESULT) != NULL) {
        
        return (TGraphErrors*)list->FindObject(HVINTERPOLATOR_RESULT);
        
      } else if (list == NULL) {

        THROW(JNullPointerException, "JHVInterpolator::getResult(): Empty list of graphs.");

      } else {
        
        THROW(JNullPointerException, "JHVInterpolator::getResult(): No " << HVINTERPOLATOR_RESULT << " graph.");
      }
    }

static void JCALIBRATE::JHVInterpolator::setMinHVDistance ( const double  minDist )

inlinestatic

Set minimal separation distance for high-voltage.

Parameters

minDist

minimal separation distance for high-voltage

Definition at line 363 of file JHVInterpolator.hh.

    {
      dHVmin = minDist;
    }

static void JCALIBRATE::JHVInterpolator::setHVRange ( const JRange< double >  range )

inlinestatic

Set valid gain range.

Parameters

range

valid high-voltage range [V]

Definition at line 374 of file JHVInterpolator.hh.

    {
      hvRange = range;
    }

static void JCALIBRATE::JHVInterpolator::setGainRange ( const JRange< double >  range )

inlinestatic

Set valid gain range.

Parameters

range

valid gain range

Definition at line 385 of file JHVInterpolator.hh.

    {
      gainRange = range;
    }

Member Data Documentation

TMultiGraph* JCALIBRATE::JHVInterpolator::data

private

HV-versus-gain data.

Definition at line 393 of file JHVInterpolator.hh.

double JCALIBRATE::JHVInterpolator::dHVmin = 2 * 3.14

staticprivate

Minimal high-voltage difference between two points [V].

Default values.

Definition at line 395 of file JHVInterpolator.hh.

JRange< double > JCALIBRATE::JHVInterpolator::hvRange = JRange<double>(-1500, -80)

staticprivate

Allowed high-voltage range [V].

Definition at line 396 of file JHVInterpolator.hh.

JRange< double > JCALIBRATE::JHVInterpolator::gainRange

staticprivate

Initial value:

= JRange<double>(FITTOT_GAIN_MIN,
                                                             FITTOT_GAIN_MAX)

Allowed gain range.

Definition at line 397 of file JHVInterpolator.hh.

---

The documentation for this struct was generated from the following file:

• JHVInterpolator.hh