Updated version.
[u/mrichter/AliRoot.git] / EMCAL / AliCaloCalibPedestal.h
index f146b07..7472763 100644 (file)
@@ -10,7 +10,7 @@
 // \file AliCaloCalibPedestal.h
 //   \brief Description:
 //   A help class for monitoring and calibration tools: MOOD, AMORE etc.,
-//   that can process events from a standard AliCaloRawStream,
+//   that can process events from a standard AliCaloRawStreamV3,
 //   most usually from LED/pulser runs. It stores signal info as
 //   typical (highest) amplitude, and pedestal info in geometrically-binned
 //   2D profiles of the detectors (EMCAL and PHOS).
 //   \version $Revision$
 //   \date $Date$
 
+#include "TProfile.h"
 #include "TProfile2D.h"
 #include "TH2.h"
 #include "TObjArray.h"
-class AliCaloRawStream;
+#include "AliEMCALGeoParams.h"
+class AliCaloRawStreamV3;
+class AliCaloAltroMapping;
+class AliRawReader;
 
 class AliCaloCalibPedestal : public TObject {
   
  public:
 
   enum kDetType {kPhos, kEmCal, kNone};//The detector types
-  enum kDeadMapEntry{kAlive = 0, kDead, kResurrected, kRecentlyDeceased, kNumDeadMapStates};//The entries being put to the deadmap
+  enum kDeadMapEntry{kAlive = 0, kDead, kHot, kWarning, kResurrected, kRecentlyDeceased, kNumDeadMapStates};//The entries being put to the deadmap
   
   AliCaloCalibPedestal(kDetType detectorType = kPhos);
   virtual ~AliCaloCalibPedestal();
@@ -43,62 +47,116 @@ class AliCaloCalibPedestal : public TObject {
   AliCaloCalibPedestal(const AliCaloCalibPedestal &ped); 
   AliCaloCalibPedestal& operator = (const  AliCaloCalibPedestal &source);
   
-  //Functions to ask for the constants (in case a GUI needs them, for an example
-  static const int GetSampleMax() {return fgkSampleMax;};
-  static const int GetSampleMin() {return fgkSampleMin;};
-  
-  Bool_t ProcessEvent(AliCaloRawStream    *in);
+  // Event processing methods:  
+  Bool_t ProcessEvent(AliRawReader *rawReader);
+  Bool_t ProcessEvent(AliCaloRawStreamV3    *in);
   
+  // Mapping handling
+  AliCaloAltroMapping **GetAltroMapping() const { return fMapping; };
+  void  SetAltroMapping(AliCaloAltroMapping **mapp) { fMapping = mapp; };
+
+  // Parameter/cut handling
+  void SetParametersFromFile(const char *parameterFile);
+  void WriteParametersToFile(const char *parameterFile);
+
   ////////////////////////////
   //Simple getters
   // Main profiles:
   TProfile2D * GetPedProfileLowGain(int i) const {return (TProfile2D*)fPedestalLowGain[i];};   // Return a pointer to the low-gain pedestal profile
   TProfile2D * GetPedProfileHighGain(int i) const {return (TProfile2D*)fPedestalHighGain[i];}; // Return a pointer to the high-gain pedestal profile
-  TProfile2D * GetPeakProfileLowGain(int i) const {return (TProfile2D*)fPeakMinusPedLowGain[i];};      // Return a pointer to the low-gain pedestal profile
-  TProfile2D * GetPeakProfileHighGain(int i) const {return (TProfile2D*)fPeakMinusPedHighGain[i];};    // Return a pointer to the high-gain pedestal profile
+  TProfile * GetPedLEDRefProfileLowGain(int i) const {return (TProfile*)fPedestalLEDRefLowGain[i];};   // Return a pointer to the low-gain LEDRef profile 
+  TProfile * GetPedLEDRefProfileHighGain(int i) const {return (TProfile*)fPedestalLEDRefHighGain[i];}; // Return a pointer to the high-gain LEDRef profile 
+  TProfile2D * GetPeakProfileLowGain(int i) const {return (TProfile2D*)fPeakMinusPedLowGain[i];};      // Return a pointer to the low-gain peak-pedestal profile
+  TProfile2D * GetPeakProfileHighGain(int i) const {return (TProfile2D*)fPeakMinusPedHighGain[i];};    // Return a pointer to the high-gain peak-pedestal profile
   
   // Differences to references:
   TProfile2D * GetPedProfileLowGainDiff(int i){ValidateComparisonProfiles(); return (TProfile2D*)fPedestalLowGainDiff[i];};    // Return a pointer to the low-gain pedestal profile difference
   TProfile2D * GetPedProfileHighGainDiff(int i){ValidateComparisonProfiles(); return (TProfile2D*)fPedestalHighGainDiff[i];};  // Return a pointer to the high-gain pedestal profile difference
-  TProfile2D * GetPeakProfileLowGainDiff(int i){ValidateComparisonProfiles(); return (TProfile2D*)fPeakMinusPedLowGainDiff[i];};       // Return a pointer to the low-gain pedestal profile difference
-  TProfile2D * GetPeakProfileHighGainDiff(int i){ValidateComparisonProfiles(); return (TProfile2D*)fPeakMinusPedHighGainDiff[i];};     // Return a pointer to the high-gain pedestal profile difference
+  TProfile * GetPedLEDRefProfileLowGainDiff(int i) {ValidateComparisonProfiles(); return (TProfile*)fPedestalLEDRefLowGainDiff[i];};   // Return a pointer to the low-gain LEDRef profile difference
+  TProfile * GetPedLEDRefProfileHighGainDiff(int i) {ValidateComparisonProfiles(); return (TProfile*)fPedestalLEDRefHighGainDiff[i];}; // Return a pointer to the high-gain LEDRef profile difference 
+  TProfile2D * GetPeakProfileLowGainDiff(int i){ValidateComparisonProfiles(); return (TProfile2D*)fPeakMinusPedLowGainDiff[i];};       // Return a pointer to the low-gain peak-pedestal profile difference
+  TProfile2D * GetPeakProfileHighGainDiff(int i){ValidateComparisonProfiles(); return (TProfile2D*)fPeakMinusPedHighGainDiff[i];};     // Return a pointer to the high-gain peak-pedestal profile difference
   
   // Ratio to references:
   TProfile2D * GetPedProfileLowGainRatio(int i){ValidateComparisonProfiles(); return (TProfile2D*)fPedestalLowGainRatio[i];};  // Return a pointer to the low-gain pedestal profile ratio
   TProfile2D * GetPedProfileHighGainRatio(int i){ValidateComparisonProfiles(); return (TProfile2D*)fPedestalHighGainRatio[i];};        // Return a pointer to the high-gain pedestal profile ratio
-  TProfile2D * GetPeakProfileLowGainRatio(int i){ValidateComparisonProfiles(); return (TProfile2D*)fPeakMinusPedLowGainRatio[i];};     // Return a pointer to the low-gain pedestal profile ratio
-  TProfile2D * GetPeakProfileHighGainRatio(int i){ValidateComparisonProfiles(); return (TProfile2D*)fPeakMinusPedHighGainRatio[i];};   // Return a pointer to the high-gain pedestal profile ratio
+  TProfile * GetPedLEDRefProfileLowGainRatio(int i) {ValidateComparisonProfiles(); return (TProfile*)fPedestalLEDRefLowGainRatio[i];}; // Return a pointer to the low-gain LEDRef profile ratio
+  TProfile * GetPedLEDRefProfileHighGainRatio(int i) {ValidateComparisonProfiles(); return (TProfile*)fPedestalLEDRefHighGainRatio[i];};       // Return a pointer to the high-gain LEDRef profile ratio 
+  TProfile2D * GetPeakProfileLowGainRatio(int i){ValidateComparisonProfiles(); return (TProfile2D*)fPeakMinusPedLowGainRatio[i];};     // Return a pointer to the low-gain peak-pedestal profile ratio
+  TProfile2D * GetPeakProfileHighGainRatio(int i){ValidateComparisonProfiles(); return (TProfile2D*)fPeakMinusPedHighGainRatio[i];};   // Return a pointer to the high-gain peak-pedestal profile ratio
   
-  TH2D * GetDeadMap(int i) const {return (TH2D*)fDeadMap[i];};
+  TH2F * GetPeakHighGainHisto(int i) const {return (TH2F*)fPeakMinusPedHighGainHisto[i];};     // Return a pointer to the high-gain peak-pedestal histo
 
+
+  TH2D * GetDeadMap(int i) const {return (TH2D*)fDeadMap[i];}
+  //void SetDeadMap(int i, TH2D *h) const {((TH2D*)fDeadMap[i])=h;}
+       
+  Bool_t IsBadChannel(int imod, int icol, int irow) const; 
+  void SetChannelStatus(int imod, int icol, int irow, int status); 
+       
+  TObjArray GetDeadMap()  const {return fDeadMap;}
+  void SetDeadMap(TObjArray map) {fDeadMap = map;}
+       
   // Basic info: getters  
   kDetType GetDetectorType() const {return fDetType;};//Returns if this is a PHOS or EMCAL object
+  TString GetCaloString() const {return fCaloString;}; //Returns if this is a PHOS or EMCAL object
   
   int GetColumns() const {return fColumns;}; //The number of columns per module
   int GetRows() const {return fRows;}; //The number of rows per module
+  int GetLEDRefs() const {return fLEDRefs;}; //The number of LED references/monitors per module
   int GetModules() const {return fModules;}; //The number of modules
+  int GetRowMin() const {return fRowMin;}; //for histo def.
+  int GetRowMax() const {return fRowMax;}; //for histo def.
+  int GetRowMultiplier() const {return fRowMultiplier;}; //for histo filling
 
   // RunNumbers : setters and getters
   void SetRunNumber(int runNo) {fRunNumber = runNo;};
   int GetRunNumber() const {return fRunNumber;};
   int GetRefRunNumber() const {if (fReference) return fReference->GetRunNumber(); else return -1;};
+
+  // Possibility to select only some samples for the pedestal calculation
+  void SetSelectPedestalSamples(Bool_t flag = kFALSE) {fSelectPedestalSamples = flag;} // select to to use only some range of samples for pedestal calc.
+  Bool_t GetSelectPedestalSamples() const {return fSelectPedestalSamples;} // select to to use only some range of samples for pedestal calc.
+  void SetFirstPedestalSample(int i) {fFirstPedestalSample = i;} // first sample to use
+  void SetLastPedestalSample(int i) {fLastPedestalSample = i;} // last sample to use
+  int GetFirstPedestalSample() const {return fFirstPedestalSample;}; // first sample to use
+  int GetLastPedestalSample() const {return fLastPedestalSample;}; // last sample to use
+
+  //Set threshold/event fraction for tower warnings
+  void SetDeadThreshold(int i) {fDeadThreshold = i;} // peak - pedestal dead threshold
+  void SetWarningThreshold(int i) {fWarningThreshold = i;} // peak - pedestal warning threshold
+  void SetWarningFraction(double d) {fWarningFraction = d;} // event fraction for warnings
+  int GetDeadThreshold() const {return fDeadThreshold;}; // peak - pedestal dead threshold
+  int GetWarningThreshold() const {return fWarningThreshold;}; // peak - pedestal warning threshold
+  double GetWarningFraction() const {return fWarningFraction;}; // event fraction for warnings
+  // hot towers
+  void SetHotSigma(double d) {fHotSigma = d;} // rms away from normal
+  double GetHotSigma() const {return fHotSigma;}; // rms away from normal
+
+  // Basic counters
+  int GetNEvents() const {return fNEvents;};
+  int GetNChanFills() const {return fNChanFills;};
   
   /////////////////////////////
   //Analysis functions
+  void SetDeadTowerCount(Int_t dead)  {fDeadTowers = dead;};//Returns the number of dead towers, by counting the bins in peak-pedestal smaller than threshold
   int GetDeadTowerCount() const {return fDeadTowers;};//Returns the number of dead towers, by counting the bins in peak-pedestal smaller than threshold
   double GetDeadTowerRatio() const {return fDeadTowers/(double)(fRows*fColumns);}; //returns the percentage of dead towers, relative to a full module
   int GetDeadTowerNew() const {return fNewDeadTowers;}; //return the new dead towers compared to the reference
   int GetDeadTowerResurrected() const {return fResurrectedTowers;}; //The the towers resurrected since the reference run
+
   void Reset();//Resets the whole class.
+  Bool_t AddInfo(const AliCaloCalibPedestal *ped);//picks up new info from supplied argument
   
   //////////////////////////////////////////////////////
   //Functions related to comparing this with another (reference) run.
   Bool_t LoadReferenceCalib(TString fileName, TString objectName); //Loads another AliCaloCalibPedestal by name "objectName" from the file "fileName", for reference
   void ComputeDiffAndRatio();//Actually computes the difference and ratio into the histo's in memory
   AliCaloCalibPedestal * GetReference() const {return fReference;}; //Get the reference object. Needed for debug, will probably be removed later
-  void ComputeDeadTowers(int threshold = 5, const char * deadMapFile = 0);//Computes the dead tower values
-  
-  
+  Bool_t SetReference(AliCaloCalibPedestal *ref);
+  void ComputeDeadTowers(const char * deadMapFile = 0);//Computes the dead tower values
+  void ComputeHotAndWarningTowers(const char * hotMapFile = 0);//Computes the hot tower values
+
   //Saving functions
   Bool_t SaveHistograms(TString fileName, Bool_t saveEmptyHistos = kFALSE); //Saves the histograms to a .root file
   
@@ -111,25 +169,37 @@ class AliCaloCalibPedestal : public TObject {
   //since we have only around 12 objects (maximum) in the array anyway.
   TObjArray fPedestalLowGain; // pedestal info for low gain
   TObjArray fPedestalHighGain; // pedestal info for high gain
+  TObjArray fPedestalLEDRefLowGain; // pedestal LEDRef info for low gain
+  TObjArray fPedestalLEDRefHighGain; // pedestal LEDRef info for high gain
   TObjArray fPeakMinusPedLowGain; // (peak-pedestal) info for low gain
   TObjArray fPeakMinusPedHighGain; // (peak-pedestal) info for high gain
+
+  TObjArray fPeakMinusPedHighGainHisto; // (peak-pedestal TH2F) info for high gain, used for hot towers eveluation
   
   //The difference of profiles between this and the reference object
   TObjArray fPedestalLowGainDiff; //!
   TObjArray fPedestalHighGainDiff; //!
+  TObjArray fPedestalLEDRefLowGainDiff; //!
+  TObjArray fPedestalLEDRefHighGainDiff; //! 
   TObjArray fPeakMinusPedLowGainDiff; //!
   TObjArray fPeakMinusPedHighGainDiff; //!
   
   //The ratio of profiles between this and the reference object
   TObjArray fPedestalLowGainRatio; //!
   TObjArray fPedestalHighGainRatio; //!
+  TObjArray fPedestalLEDRefLowGainRatio; //!
+  TObjArray fPedestalLEDRefHighGainRatio; //! 
   TObjArray fPeakMinusPedLowGainRatio; //!
   TObjArray fPeakMinusPedHighGainRatio; //!
   
   TObjArray fDeadMap;//The deadmap
-  
+
+  // status counters
+  int fNEvents; //# total events processed, 
+  int fNChanFills; //# total channel fills (NChan * NEvents if not zero-suppressed)
+
   //The dead tower counts
-  int fDeadTowers; //!
+  int fDeadTowers; // Number of towers found dead.
   int fNewDeadTowers; //! Towers that have died since the reference run
   int fResurrectedTowers; //! Towers that have been resurrected from the dead, compared to the reference
   
@@ -138,22 +208,30 @@ class AliCaloCalibPedestal : public TObject {
   kDetType fDetType; //The detector type for this object
   int fColumns;        //The number of columns per module
   int fRows;   //The number of rows per module
+  int fLEDRefs;        //The number of LED references/monitors per module
   int fModules;        //The number of modules
+  int fRowMin; // Minimum Row number
+  int fRowMax; // Maximum now number
+  int fRowMultiplier; // Multiplication factor to get proper row range between PHOS and EMCAL
+  TString fCaloString; // id for which detector type we have 
+  AliCaloAltroMapping **fMapping;    //! Altro Mapping object
   int fRunNumber; //The run number. Needs to be set by the user.
-  
-  //Constants needed by the class
-  static const int fgkSampleMax = 1023; // highest possible sample value (10-bit = 0x3ff)
-  static const int fgkSampleMin = 0; // lowest possible sample value 
-  
+  Bool_t fSelectPedestalSamples; // select to to use only some range of samples for pedestal calc.
+  int fFirstPedestalSample; // first sample to use
+  int fLastPedestalSample; // last sample to use
+
+  int fDeadThreshold; // Peak - ped threshold used for dead towers evaluation
+  int fWarningThreshold; // Peak - ped threshold used for warm/warning towers evaluation
+  double fWarningFraction; //if(Peak - ped) > threshold in more than this fraction of event -> tower is assigned kWarning
+  double fHotSigma; // if pedestal rms more than fHotSigma away from normal -> tower is assigned kHot
+
+  //Constants needed by the class: EMCAL ones are kept in AliEMCALGeoParams.h
   static const int fgkPhosRows = 64; // number of rows per module for PHOS
   static const int fgkPhosCols = 56; // number of columns per module for PHOS
+  static const int fgkPhosLEDRefs = 1; // no LED monitor channels for PHOS, set to 1 just to keep code simpler (also create LEDRef histos for PHOS)
   static const int fgkPhosModules = 5; // number of modules for PHOS
-  
-  static const int fgkEmCalRows = 24; // number of rows per module for EMCAL
-  static const int fgkEmCalCols = 48; // number of columns per module for EMCAL
-  static const int fgkEmCalModules = 12; // number of modules for EMCAL
-  
-  ClassDef(AliCaloCalibPedestal,1)
+
+  ClassDef(AliCaloCalibPedestal, 8)
 
 };