Cleanup and reordering of TPC classes
[u/mrichter/AliRoot.git] / TPC / Base / AliTPCcalibDB.h
1 #ifndef ALITPCCALIBDB_H
2 #define ALITPCCALIBDB_H
3 /* Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
4  * See cxx source for full Copyright notice                               */
5
6 ///////////////////////////////////////////////////////////////////////////////
7 //                                                                           //
8 // Class providing the calibration parameters by accessing the CDB           //
9 //                                                                           //
10 ///////////////////////////////////////////////////////////////////////////////
11
12
13 class AliTPCTransform;
14 class AliTPCExB;
15 #include "TObject.h"
16 #include "TObjArray.h"
17 #include "TArrayI.h"
18 #include "TVectorD.h"
19 #include "TGraph.h"
20 #include "AliTPCCalPad.h"
21 #include "TString.h"
22 #include "AliSplineFit.h"
23 #include "TMap.h"
24
25 class AliTPCSensorTempArray;
26 class AliDCSSensorArray;
27 class AliCDBEntry;
28 class AliTPCParam;
29 class AliTPCAltroMapping;
30 class AliTPCClusterParam;
31 class AliDCSSensor;
32 class AliDCSSensorArray;
33 class AliTPCCalibVdrift;
34 class AliGRPObject;
35 class AliTPCCalibRaw;
36 class AliTPCdataQA;
37 class AliMagF;
38 class AliTPCcalibDButil;
39 class AliCTPTimeParams;
40 class AliTPCCorrection;
41 //class AliCDBStorage;
42
43 class AliTPCcalibDB : public TObject
44 {
45  public: 
46   static AliTPCcalibDB* Instance();
47   AliTPCcalibDB();
48   virtual ~AliTPCcalibDB();
49   static void Terminate();
50   void   SetRun(Long64_t run);   
51   void   Update();  //update entries
52   void   UpdateRunInformations(Int_t run, Bool_t force=kFALSE);
53   void   UpdateNonRec();
54   //
55   Long64_t GetRun() const {return fRun;}
56   //
57   //
58   //
59   AliTPCTransform* GetTransform() const {return fTransform;}
60   AliTPCExB*    GetExB() const {return fExB;}
61   void          SetExBField(Float_t bz);
62   void          SetExBField( const AliMagF*   bmap);
63   static AliTPCExB*    GetExB(Float_t bz,Bool_t bdelete);
64   AliTPCCalPad* GetPadGainFactorOld() const {return fPadGainFactor;}
65   AliTPCCalPad* GetPadGainFactor() const {return fActiveChannelMap;}
66   AliTPCCalPad* GetActiveChannelMap() const { return fActiveChannelMap; }
67   AliTPCCalPad* GetDedxGainFactor() const {return fDedxGainFactor;}
68   AliTPCCalPad* GetPadTime0() const {return fPadTime0;}
69   AliTPCCalPad* GetDistortionMap(Int_t i) const;
70   AliTPCCorrection * GetTPCComposedCorrection() const { return fComposedCorrection;}
71   TObjArray * GetTPCComposedCorrectionArray() const { return fComposedCorrectionArray;}
72   void          SetTPCComposedCorrection(AliTPCCorrection *compCorr) { fComposedCorrection=compCorr;}
73   AliTPCCorrection * GetTPCComposedCorrection(Float_t field) const;
74   AliTPCCorrection * GetTPCComposedCorrectionDelta() const;
75   Bool_t      HasAlignmentOCDB() const { return fBHasAlignmentOCDB;}
76
77   AliTPCCalPad* GetPadNoise() const {return fPadNoise;}
78   AliTPCCalPad* GetPedestals() const{return fPedestals;}
79   //ALTRO config data
80   TObjArray* GetAltroConfigData()  const {return fALTROConfigData;}
81   AliTPCCalPad* GetALTROAcqStart() const {return fALTROConfigData?static_cast<AliTPCCalPad*>(fALTROConfigData->FindObject("AcqStart")):0;}
82   AliTPCCalPad* GetALTROZsThr()    const {return fALTROConfigData?static_cast<AliTPCCalPad*>(fALTROConfigData->FindObject("ZsThr")):0;}
83   AliTPCCalPad* GetALTROFPED()     const {return fALTROConfigData?static_cast<AliTPCCalPad*>(fALTROConfigData->FindObject("FPED")):0;}
84   AliTPCCalPad* GetALTROAcqStop()  const {return fALTROConfigData?static_cast<AliTPCCalPad*>(fALTROConfigData->FindObject("AcqStop")):0;}
85   AliTPCCalPad* GetALTROMasked()   const {return fALTROConfigData?static_cast<AliTPCCalPad*>(fALTROConfigData->FindObject("Masked")):0;}
86   TMap* GetDDLMap()   const {return fALTROConfigData?static_cast<TMap*>(fALTROConfigData->FindObject("DDLArray")):0;}
87   TMap* GetRCUconfig() const {return fALTROConfigData?(TMap*)(fALTROConfigData->FindObject("RCUconfig")):0;}
88   Int_t GetRCUTriggerConfig() const;
89   Bool_t IsTrgL0();
90   Bool_t IsTrgL1();
91     
92   TObjArray*    GetIonTailArray()  const {return fIonTailArray;}
93     
94   //Pulser data
95   TObjArray*    GetPulserData()  const {return fPulserData;}
96   AliTPCCalPad* GetPulserTmean() const {return fPulserData?static_cast<AliTPCCalPad*>(fPulserData->FindObject("PulserTmean")):0;}
97   AliTPCCalPad* GetPulserTrms()  const {return fPulserData?static_cast<AliTPCCalPad*>(fPulserData->FindObject("PulserTrms")):0;}
98   AliTPCCalPad* GetPulserQmean() const {return fPulserData?static_cast<AliTPCCalPad*>(fPulserData->FindObject("PulserQmean")):0;}
99   //CE data
100   TObjArray*    GetCEData()     const {return fCEData;}
101   AliTPCCalPad* GetCETmean()    const {return fCEData?static_cast<AliTPCCalPad*>(fCEData->FindObject("CETmean")):0;}
102   AliTPCCalPad* GetCETrms()     const {return fCEData?static_cast<AliTPCCalPad*>(fCEData->FindObject("CETrms")):0;}
103   AliTPCCalPad* GetCEQmean()    const {return fCEData?static_cast<AliTPCCalPad*>(fCEData->FindObject("CEQmean")):0;}
104   TObjArray*    GetCErocTtime() const {return fCEData?static_cast<TObjArray*>(fCEData->FindObject("rocTtime")):0;}
105   TObjArray*    GetCErocQtime() const {return fCEData?static_cast<TObjArray*>(fCEData->FindObject("rocQtime")):0;}
106   TObjArray*    GetCEfitsDrift()const {return fCEData?static_cast<TObjArray*>(fCEData->FindObject("ceFitsDrift")):0;}
107   TGraph*       GetCErocTgraph(const Int_t roc)const {return GetCErocTtime()?static_cast<TGraph*>(GetCErocTtime()->At(roc)):0;}
108   TGraph*       GetCErocQgraph(const Int_t roc)const {return GetCErocQtime()?static_cast<TGraph*>(GetCErocQtime()->At(roc)):0;}
109   static Float_t GetCEdriftTime(Int_t run, Int_t sector, Double_t timeStamp=-1., Int_t *entries=0);
110   static Float_t GetCEchargeTime(Int_t run, Int_t sector, Double_t timeStamp=-1., Int_t *entries=0);
111   //Raw calibration
112   AliTPCCalibRaw* GetCalibRaw() const {return fCalibRaw;}
113
114   //QA object
115   AliTPCdataQA*   GetDataQA() const {return fDataQA;}
116   //
117   AliTPCSensorTempArray* GetTemperature() const {return fTemperature;}
118   AliTPCParam*  GetParameters() const {return fParam;}
119   AliTPCAltroMapping ** GetMapping() const{ return fMapping;}
120   AliTPCClusterParam *GetClusterParam() const { return fClusterParam;}
121   TObjArray *GetTimeGainSplines() const { return fTimeGainSplines;}  
122   //
123   //GRP information
124   static AliGRPObject * GetGRP(Int_t run);
125   static TMap *  GetGRPMap(Int_t run);
126   static Float_t GetPressure(Int_t timeStamp, Int_t run, Int_t type=0);
127   static Float_t GetL3Current(Int_t run, Int_t statType=0);
128   static Float_t GetBz(Int_t run);
129   static Char_t  GetL3Polarity(Int_t run);
130   static TString GetRunType(Int_t run);
131   //
132   static Float_t GetDCSSensorValue(AliDCSSensorArray *arr, Int_t timeStamp, const char * sensorName, Int_t sigDigits=-1);
133   static Float_t GetDCSSensorMeanValue(AliDCSSensorArray *arr, const char * sensorName, Int_t sigDigits=-1);
134   //Voltage information
135   static Float_t GetChamberHighVoltage(Int_t run, Int_t sector, Int_t timeStamp=-1, Int_t sigDigits=0, Bool_t current=kFALSE);
136   static Float_t GetSkirtVoltage(Int_t run, Int_t sector, Int_t timeStamp=-1, Int_t sigDigits=0);
137   static Float_t GetCoverVoltage(Int_t run, Int_t sector, Int_t timeStamp=-1, Int_t sigDigits=0);
138   static Float_t GetGGoffsetVoltage(Int_t run, Int_t sector, Int_t timeStamp=-1, Int_t sigDigits=0);
139   static Float_t GetGGnegVoltage(Int_t run, Int_t sector, Int_t timeStamp=-1, Int_t sigDigits=0);
140   static Float_t GetGGposVoltage(Int_t run, Int_t sector, Int_t timeStamp=-1, Int_t sigDigits=0);
141   //
142   Bool_t  GetChamberHVStatus(UInt_t roc)                  const { return (roc<72)?fChamberHVStatus[roc]:kFALSE;   }
143   Float_t GetChamberHighVoltageMedian(UInt_t roc)         const { return (roc<72)?fChamberHVmedian[roc]:0.;       }
144   Float_t GetChamberCurrentNominalHighVoltage(UInt_t roc) const { return (roc<72)?fCurrentNominalVoltage[roc]:0.; }
145   Float_t GetChamberGoodHighVoltageFraction(UInt_t roc)   const { return (roc<72)?fChamberHVgoodFraction[roc]:0.; }
146   AliDCSSensor* GetChamberHVSensor(UInt_t roc)            const { return (roc<72)?fHVsensors[roc]:0x0;            }
147   Bool_t  IsDataTakingActive(time_t timeStamp);
148   //
149   //Goofie Values
150   //
151   static Float_t GetValueGoofie(Int_t timeStamp, Int_t run, Int_t type);
152   //
153   static Bool_t  GetTemperatureFit(Int_t timeStamp, Int_t run, Int_t side,TVectorD& fit);
154   static Float_t GetTemperature(Int_t timeStamp, Int_t run, Int_t side);
155   static Double_t GetPTRelative(UInt_t timeSec, Int_t run,  Int_t side);
156   AliDCSSensor * GetPressureSensor(Int_t run, Int_t type=0);
157   //AliDCSSensor * GetVoltageSensor(Int_t run, Int_t type=0);
158   AliTPCSensorTempArray * GetTemperatureSensor(Int_t run);
159   AliDCSSensorArray *     GetGoofieSensors(Int_t run);
160   AliDCSSensorArray *     GetVoltageSensors(Int_t run);
161   AliTPCCalibVdrift *     GetVdrift(Int_t run);
162   TObjArray *             GetTimeGainSplinesRun(Int_t run);
163   TObjArray*              GetTimeVdriftSplineRun(Int_t run);
164   static Float_t GetGain(Int_t sector, Int_t row, Int_t pad);
165   //
166   // Drift velocity information
167   //
168   Double_t      GetVDriftCorrectionTime(Int_t timeStamp, Int_t run, Int_t side, Int_t mode);
169   Double_t      GetTime0CorrectionTime(Int_t timeStamp, Int_t run, Int_t side, Int_t mode);
170   Double_t      GetVDriftCorrectionGy(Int_t timeStamp, Int_t run, Int_t side, Int_t mode);
171   //
172   AliSplineFit* GetVdriftSplineFit(const char* name, Int_t run);
173   AliSplineFit* CreateVdriftSplineFit(const char* graphName, Int_t run);
174   //
175   static void     CreateObjectList(const Char_t *filename, TObjArray *calibObjects);
176   static void MakeTree(const char * fileName, TObjArray * array, const char * mapFileName = 0, AliTPCCalPad* outlierPad = 0, Float_t ltmFraction = 0.9);
177   static void RegisterExB(Int_t index, Float_t bz, Bool_t bdelete);
178   //
179   //
180   //
181   AliTPCCalPad* MakeDeadMap(Double_t notInMap=1, const char *nameMappingFile="$ALICE_ROOT/TPC/Calib/tpcMapping.root" );
182   AliGRPObject * MakeGRPObjectFromMap(TMap *map);
183   AliCTPTimeParams* GetCTPTimeParams() const {return fCTPTimeParams;}
184   //Create a tree suited for diplaying with the AliTPCCalibViewerGUI
185   Bool_t CreateGUITree(const char* filename="");
186   static Bool_t CreateGUITree(Int_t run, const char* filename="");
187   static Bool_t CreateRefFile(Int_t run, const char* filename="");
188   //
189 protected:
190   
191   AliCDBEntry* GetCDBEntry(const char* cdbPath);   
192   void         UpdateChamberHighVoltageData();
193   Int_t        InitDeadMap();
194
195   Int_t        fRun;         // current run number
196   AliTPCTransform *fTransform;      // object responsible for spacial corrections
197   AliTPCExB *fExB;              // ExB correction factor
198 //  AliCDBStorage* fLocator;      // Storage locator retrieved from AliCDBManager
199   //
200   // calibration parameters per pad
201   //
202   AliTPCCalPad* fPadGainFactor;   // Gain calibration entry
203   AliTPCCalPad* fActiveChannelMap; // Map of active channels calculated on the fly
204   AliTPCCalPad* fDedxGainFactor;   // Gain calibration entry - for dEdx
205   AliTPCCalPad* fPadTime0;        // Time0 calibration entry
206   TObjArray   *fDistortionMap;    // distortion map
207   AliTPCCorrection *fComposedCorrection;  // general space point corrections
208   TObjArray *      fComposedCorrectionArray; //space point corrections for different field setting
209   AliTPCCalPad* fPadNoise;        // Noise calibration entry
210   AliTPCCalPad* fPedestals;       // Pedestal calibration entry
211   AliTPCCalibRaw *fCalibRaw;      // raw data calibration entry
212   AliTPCdataQA  *fDataQA;         // qa object
213   TObjArray *fALTROConfigData;    // ALTRO configuration data
214   TObjArray * fIonTailArray;      // array of graphs with the ion tail 
215   TObjArray *fPulserData;         // Calibration Pulser data
216   TObjArray *fCEData;             // CE data
217   //
218   // Chamber HV info
219   //
220   Bool_t  fChamberHVStatus[72];       // Status of the Chamber, HV wise (on/off)
221   Float_t fChamberHVmedian[72];       // median chamber high voltage
222   Float_t fCurrentNominalVoltage[72]; // current nominal voltages
223   Float_t fChamberHVgoodFraction[72]; // fraction of time the chamber has a good HV (wrt. robust median)
224   AliDCSSensor *fHVsensors[72];       // HV sensors
225   TGraph *fGrRunState;                // store information if run is active or paused
226   //
227   //
228   //
229   AliTPCSensorTempArray* fTemperature; // Temperature calibration entry
230   AliTPCAltroMapping **fMapping;   // Altro mapping   
231   //
232   //
233   AliTPCParam * fParam;           // TPC parameters
234   AliTPCClusterParam * fClusterParam;  // TPC cluster error, shape and Q parameterization
235   TObjArray * fTimeGainSplines; // Array of AliSplineFits: at 0 MIP position in time ; at 1 Fermi Plateau from cosmics
236   //
237   // Get the corssrun information
238   //
239   TMap      fTimeGainSplinesArray; //! array Array of AliSplineFits: at 0 MIP position in time ; at 1 Fermi Plateau from cosmics
240   TMap      fGRPArray;                                                  //! array of GRPs  -  per run
241   TMap      fGRPMaps;                                                   //! array of GRPs maps  -  per run - old data  
242   TMap      fGoofieArray;                                       //! array of GOOFIE values -per run
243   TMap      fVoltageArray;                                      //! array of Chamber HV values -per run
244   TMap      fTemperatureArray;                  //! array of temperature sensors - per run
245   TMap      fVdriftArray;                                       //! array of v drift interfaces
246   TMap      fDriftCorrectionArray;                //! array of drift correction
247
248   TArrayI        fRunList;                                                      //! run list - indicates try to get the run param
249   Bool_t         fBHasAlignmentOCDB;                // Flag - alignment from the Transformation class
250   //
251   static AliTPCcalibDB* fgInstance;  // singleton control
252   static Bool_t       fgTerminated;  // termination control 
253   static TObjArray    fgExBArray;    // array of ExB corrections
254   AliTPCcalibDButil   *fDButil;       // utility class
255   //ctp info
256   AliCTPTimeParams *fCTPTimeParams;   //CTP timing parameters
257   Int_t            fMode;             //RCU trigger config mode
258
259  private:
260    AliTPCcalibDB (const AliTPCcalibDB& );
261    AliTPCcalibDB& operator= (const AliTPCcalibDB& );
262   
263    ClassDef(AliTPCcalibDB, 0)
264 };
265
266 #endif