EMCAL_FIRSTYEARV1 - geometry for December 2009 to December 2010 run period;

[u/mrichter/AliRoot.git] / EMCAL / AliEMCALCalibTimeDep.h

#ifndef ALIEMCALCALIBTIMEDEP_H
#define ALIEMCALCALIBTIMEDEP_H

/* Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
 * See cxx source for full Copyright notice                               */

/* $Id: AliEMCALCalibTimeDep.h $ */

/////////////////////////////////////////////////
// class for EMCAL time-dependence calibration //
/////////////////////////////////////////////////

#include "TObject.h"

class AliEMCALSensorTempArray;
class AliCaloCalibSignal;
class AliEMCALBiasAPD;
class AliEMCALCalibMapAPD;
class AliEMCALCalibReference; 
class AliEMCALCalibTimeDepCorrection; 

class AliEMCALCalibTimeDep : public TObject {

 public:
  AliEMCALCalibTimeDep(); //! ctor
  AliEMCALCalibTimeDep(const AliEMCALCalibTimeDep &calibt); //! copy ctor
  AliEMCALCalibTimeDep& operator= (const AliEMCALCalibTimeDep &calibt); //! 
  virtual ~AliEMCALCalibTimeDep(); //! dtor
  virtual void PrintInfo() const; 

  void Initialize(Int_t run, UInt_t startTime, UInt_t endTime);//!

  // simple getters
  Int_t GetRunNumber() const { return fRun; } // 
  UInt_t GetStartTime() const { return fStartTime; } // 
  UInt_t GetEndTime() const { return fEndTime; } //  
  Double_t GetLengthOfRunInHours() const; // 
  Double_t GetLengthOfRunInBins() const; // 

  // Temperature Section
  // access pointer to the basic temperature object: AliEMCALSensorTempArray 
  AliEMCALSensorTempArray  * GetTempArray() const { return fTempArray; } // temperature array

  // range of temperature readings/values during the run 
  Int_t ScanTemperatureInfo(); // go through the temperature info
  Double_t GetMinTemp() const { return fMinTemp; } //  
  Double_t GetMaxTemp() const { return fMaxTemp; } // 
  Double_t GetMinTempVariation() const { return fMinTempVariation; } //  
  Double_t GetMaxTempVariation() const { return fMaxTempVariation; } // 
  UInt_t GetMinTime() const { return fMinTime; } // 
  UInt_t GetMaxTime() const { return fMaxTime; } // 
  Double_t GetRangeOfTempMeasureInHours() const; //! 
  Double_t GetRangeOfTempMeasureInDegrees() const; //! 

  // basic calibration info
  Double_t GetTemperature(UInt_t timeStamp) const; // for all sensors, all SuperModules
  Double_t GetTemperatureSM(int imod, UInt_t timeStamp) const; // for all sensors, in a SuperModule
  Double_t GetTemperatureSMSensor(int imod, int isens, UInt_t timeStamp) const; // for a sensor, in a SuperModule
  // End of Temperature Section

  // control parameters
  void SetTemperatureResolution(Double_t d) { fTemperatureResolution = d; } // value for checking at which level we care about temperature differences
  void SetTimeBinsPerHour(Int_t i) { fTimeBinsPerHour = i; } // size of the time-bins we use for corrections
  Double_t GetTemperatureResolution() const { return fTemperatureResolution; } // value for checking at which level we care about temperature differences
  Int_t GetTimeBinsPerHour() const { return fTimeBinsPerHour; } // size of the time-bins we use foc corrections

  void SetHighLowGainFactor(Double_t value) {fHighLowGainFactor = value;}
  Double_t GetHighLowGainFactor() const {return fHighLowGainFactor;}

  // access to other pointers
  AliCaloCalibSignal  * GetCalibSignal() const { return fCalibSignal; } //
  AliEMCALBiasAPD  * GetBiasAPD() const { return fBiasAPD; } //
  AliEMCALCalibMapAPD  * GetCalibMapAPD() const { return fCalibMapAPD; } //
  AliEMCALCalibReference  * GetCalibReference() const { return fCalibReference; } //

  // storage and access of the correction info
  Int_t CalcCorrection(); //
  AliEMCALCalibTimeDepCorrection  * GetCalibTimeDepCorrection() 
    const { return fCalibTimeDepCorrection; } //

  Double_t GetTempCoeff(Double_t IDark, Double_t M) const; //

  // for local debugging: setters of the main input pointers that are normally from OCDB
  void SetTempArray(AliEMCALSensorTempArray  *arr) { fTempArray = arr; } // 
  void SetCalibSignal(AliCaloCalibSignal  *obj) { fCalibSignal = obj; } // 
  void SetBiasAPD(AliEMCALBiasAPD  *obj) { fBiasAPD = obj; } // 
  void SetCalibMapAPD(AliEMCALCalibMapAPD  *obj) { fCalibMapAPD = obj; } //
  void SetCalibReference(AliEMCALCalibReference  *obj) { fCalibReference = obj; } //
  // basic setters, also for local debugging
  void SetRunNumber(Int_t i) { fRun= i; } // 
  void SetStartTime(UInt_t ui) { fStartTime = ui; } // 
  void SetEndTime(UInt_t ui) { fEndTime = ui; } //  

  Int_t GetVerbosity() const { return fVerbosity; } // debug flag 
  void SetVerbosity(Int_t i) { fVerbosity= i; } // debug flag 

 private:

  void Reset(); //

  void GetTemperatureInfo(); // pick up Preprocessor output
  void GetCalibSignalInfo(); // pick up Preprocessor output
  void GetBiasAPDInfo(); // pick up OCDB info
  void GetCalibMapAPDInfo(); // pick up OCDB info
  void GetCalibReferenceInfo(); // pick up OCDB info

  Int_t CalcLEDCorrection(Int_t nSM, Int_t nBins); // based on LED signals, and reference photodiodes
  Int_t CalcLEDCorrectionStripBasis(Int_t nSM, Int_t nBins); // based on LED signals, and reference photodiodes
  Int_t CalcTemperatureCorrection(Int_t nSM, Int_t nBins, Int_t binSize); // based on temperature info

  //
  Int_t fRun; // run number
  UInt_t fStartTime; // start timestamp
  UInt_t fEndTime; // end timestamp
  // temperature stuff
  Double_t fMinTemp; // min temp
  Double_t fMaxTemp; // max temp
  Double_t fMinTempVariation; // min temp variation, within a sensor
  Double_t fMaxTempVariation; // max temp variation, within a sensor
  UInt_t fMinTime; // min time
  UInt_t fMaxTime; // max time
  //
  Double_t fTemperatureResolution; // value for checking at which level we care about temperature differences
  Int_t fTimeBinsPerHour; // size of the time-bins we use for corrections

  Double_t fHighLowGainFactor;     //gain factor to convert between high and low gain
  
  // pointers to the different used classes
  AliEMCALSensorTempArray  *fTempArray;     // CDB class for temperature sensors
  AliCaloCalibSignal *fCalibSignal; // LED signal info
  AliEMCALBiasAPD *fBiasAPD; // bias APD info
  AliEMCALCalibMapAPD *fCalibMapAPD; // calib & map APD info
  AliEMCALCalibReference *fCalibReference; // reference info
  AliEMCALCalibTimeDepCorrection *fCalibTimeDepCorrection; // correction values

  Int_t fVerbosity; // debug flag

  //
  ClassDef(AliEMCALCalibTimeDep,3)    // EMCAL time-dep Calibration data
};

#endif