#ifndef ALICALOCALIBPEDESTAL_H
#define ALICALOCALIBPEDESTAL_H
-/* \file AliCaloCalibPedestal.h
- \brief Description:
- A help class for monitoring and calibration tools: MOOD, AMORE etc.,
- that can process events from a standard AliCaloRawStream,
- 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).
- Comparisons (ratios and differences) can be done with references.
-
- \author: Timo Alho (Jyvaskyla), original version.
- [Consultant: D. Silvermyr (ORNL)]
- Partly based on AliTPCCalibPedestal.
-
- \version $Revision$
- \date $Date$
-*/
+/* Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
+ * See cxx source for full Copyright notice */
+/* $Id$ */
+
+
+// \file AliCaloCalibPedestal.h
+// \brief Description:
+// A help class for monitoring and calibration tools: MOOD, AMORE etc.,
+// 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).
+// Comparisons (ratios and differences) can be done with references.
+
+// \author: Timo Alho (Jyvaskyla), original version.
+// [Consultant: D. Silvermyr (ORNL)]
+// Partly based on AliTPCCalibPedestal.
+//
+// \version $Revision$
+// \date $Date$
+
+#include "TProfile.h"
#include "TProfile2D.h"
#include "TH2.h"
#include "TObjArray.h"
-#include "AliCaloRawStream.h"
+#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();
// copy ctor, and '=' operator, are not fully tested/debugged yet
// at least for now; the reference info is not copied from one to the other
- AliCaloCalibPedestal(const AliCaloCalibPedestal &ped);
- AliCaloCalibPedestal& operator = (const AliCaloCalibPedestal &source);
+ AliCaloCalibPedestal(AliCaloCalibPedestal &ped);
+ AliCaloCalibPedestal& operator = (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
+ TProfile2D * GetPedProfileLowGain(int i) {ValidateProfiles(); return (TProfile2D*)fPedestalLowGain[i];}; // Return a pointer to the low-gain pedestal profile
+ TProfile2D * GetPedProfileHighGain(int i) {ValidateProfiles(); return (TProfile2D*)fPedestalHighGain[i];}; // Return a pointer to the high-gain pedestal profile
+ TProfile * GetPedLEDRefProfileLowGain(int i) {ValidateProfiles(); return (TProfile*)fPedestalLEDRefLowGain[i];}; // Return a pointer to the low-gain LEDRef profile
+ TProfile * GetPedLEDRefProfileHighGain(int i) {ValidateProfiles(); return (TProfile*)fPedestalLEDRefHighGain[i];}; // Return a pointer to the high-gain LEDRef profile
+ TProfile2D * GetPeakProfileLowGain(int i) {ValidateProfiles(); return (TProfile2D*)fPeakMinusPedLowGain[i];}; // Return a pointer to the low-gain peak-pedestal profile
+ TProfile2D * GetPeakProfileHighGain(int i) {ValidateProfiles(); 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) {ValidateProfiles(); return (TH2F*)fPeakMinusPedHighGainHisto[i];}; // Return a pointer to the high-gain peak-pedestal histo
+
+ TH2D * GetDeadMap(int i) {ValidateProfiles(); 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);
+ Int_t GetChannelStatus(int imod, int icol, int irow) const { return (Int_t)((TH2D*)fDeadMap[imod])->GetBinContent(icol, irow); }
+
+ TObjArray GetDeadMap() {ValidateProfiles(); 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(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
-
+
+ void Init() { ValidateProfiles(); } // do basic setup
+
private:
+ void ValidateProfiles(); //Makes sure that basic histos/profiles exist
+ void CompressAndSetOwner(); //Makes sure that basic histos/profiles exist
void ValidateComparisonProfiles(); //Makes sure that fPe..Diff and fPe..Ratio profiles exist
//The histograms. We use a TObjArray instead of a simple array,because this gives automatic streaming properties for the
//class. A TClonesArray would be more efficient, but it's a bit more difficult to use and it doesn't matter too much
- //since we have only around 12 objects (maximum) in the array anyway.
- TObjArray fPedestalLowGain;
- TObjArray fPedestalHighGain;
- TObjArray fPeakMinusPedLowGain;
- TObjArray fPeakMinusPedHighGain;
+ //since we have only one object per module 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
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;
- static const int fgkSampleMin = 0;
-
- static const int fgkPhosRows = 64;
- static const int fgkPhosCols = 56;
- static const int fgkPhosModules = 5;
-
- static const int fgkEmCalRows = 24;
- static const int fgkEmCalCols = 48;
- static const int fgkEmCalModules = 12;
-
-
- public:
-
- ClassDef(AliCaloCalibPedestal,1)
+ 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
+
+ ClassDef(AliCaloCalibPedestal, 8)
};