e3e32b5cbb78f0c9aa61d37fe0d6effc12d0c95d
[u/mrichter/AliRoot.git] / TPC / Base / AliTPCTempMap.cxx
1 /**************************************************************************
2  * Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
3  *                                                                        *
4  * Author: The ALICE Off-line Project.                                    *
5  * Contributors are mentioned in the code where appropriate.              *
6  *                                                                        *
7  * Permission to use, copy, modify and distribute this software and its   *
8  * documentation strictly for non-commercial purposes is hereby granted   *
9  * without fee, provided that the above copyright notice appears in all   *
10  * copies and that both the copyright notice and this permission notice   *
11  * appear in the supporting documentation. The authors make no claims     *
12  * about the suitability of this software for any purpose. It is          *
13  * provided "as is" without express or implied warranty.                  *
14  **************************************************************************/
15
16
17 ///////////////////////////////////////////////////////////////////////////////
18 //                                                                           //
19 //  TPC calibration class for temperature maps and tendencies                //
20 //  (based on TPC Temperature Sensors and FiniteElement Simulation)          //
21 //                                                                           //
22 //  Authors: Stefan Rossegger, Haavard Helstrup                              //
23 //                                                                           //
24 //  Note: Obvioulsy some changes by Marian, but when ???                     //
25 //                                                                           //
26 ///////////////////////////////////////////////////////////////////////////////
27
28 #include "AliTPCSensorTempArray.h"
29 #include "TLinearFitter.h"
30 #include "TString.h"
31 #include "TGraph2D.h"
32 #include "TTimeStamp.h"
33
34 #include "AliTPCTempMap.h"
35
36
37 ClassImp(AliTPCTempMap)
38   
39   const char kStringFEsimulation[] = "FEsimulation.txt";
40
41 //_____________________________________________________________________________
42 AliTPCTempMap::AliTPCTempMap(AliTPCSensorTempArray *sensorDCS):
43   TNamed(),
44   fTempArray(0),
45   fStringFEsimulation(kStringFEsimulation)
46 {
47   //
48   // AliTPCTempMap default constructor
49   //
50
51   fTempArray = sensorDCS;
52
53 }
54
55 //_____________________________________________________________________________
56 AliTPCTempMap::AliTPCTempMap(const AliTPCTempMap &c):
57   TNamed(c),
58   fTempArray(c.fTempArray),
59   fStringFEsimulation(c.fStringFEsimulation)
60 {
61   //
62   // AliTPCTempMap copy constructor
63   //
64
65 }
66
67 //_____________________________________________________________________________
68 AliTPCTempMap::~AliTPCTempMap()
69 {
70   //
71   // AliTPCTempMap destructor
72   //
73   
74 }
75
76 //_____________________________________________________________________________
77 AliTPCTempMap &AliTPCTempMap::operator=(const AliTPCTempMap &c)
78 {
79   //
80   // Assignment operator
81   //
82
83   if (this != &c) ((AliTPCTempMap &) c).Copy(*this);
84   return *this;
85
86 }
87
88 //_____________________________________________________________________________
89 void AliTPCTempMap::Copy(TObject &c) const
90 {
91   //
92   // Copy function
93   //
94   
95   TObject::Copy(c);
96   
97 }
98
99 //_____________________________________________________________________________
100
101 Double_t AliTPCTempMap::GetTempGradientY(UInt_t timeSec, Int_t side){
102  //
103  // Extract Linear Vertical Temperature Gradient [K/cm] within the TPC on 
104  // Shaft Side(A): 0
105  // Muon  Side(C): 1
106  // Values based on TemperatureSensors within the TPC ( type: 3 (TPC) )
107  //
108  // FIXME: Also return residual-distribution, covariance Matrix
109  //        or simply chi2 for validity check? 
110  //        -> better use GetLinearFitter - function in this case!
111   
112  TLinearFitter *fitter = new TLinearFitter(3,"x0++x1++x2");
113  TVectorD param(3);
114  Int_t i = 0;
115
116  Int_t nsensors = fTempArray->NumSensors();
117  for (Int_t isensor=0; isensor<nsensors; isensor++) { // loop over all sensors
118    AliTPCSensorTemp *entry = (AliTPCSensorTemp*)fTempArray->GetSensorNum(isensor);
119    
120    if (entry->GetType()==3 && entry->GetSide()==side) { // take SensorType:TPC 
121      Double_t x[3];
122      x[0]=1;
123      x[1]=entry->GetX();
124      x[2]=entry->GetY();    
125      Double_t y = fTempArray->GetValue(timeSec,isensor); // get temperature value
126      if (IsOK(y)) fitter->AddPoint(x,y,1); // add values to LinearFitter
127      i++;
128    }
129
130  }  
131  fitter->Eval();
132  fitter->GetParameters(param);
133
134  fitter->~TLinearFitter();
135
136  return param[2]; // return vertical (Y) tempGradient in [K/cm]
137   
138 }
139
140 //_____________________________________________________________________________
141 TLinearFitter *AliTPCTempMap::GetLinearFitter(Int_t type, Int_t side, TTimeStamp &stamp)
142 {
143   //
144   // absolute time stamp used
145   // see AliTPCTempMap::GetLinearFitter(Int_t type, Int_t side, UInt_t timeSec) for details
146   //
147   Int_t timeSec = stamp.GetSec()-fTempArray->GetStartTime().GetSec();
148   return GetLinearFitter(type,side,timeSec);
149 }
150
151 //_____________________________________________________________________________
152 TLinearFitter *AliTPCTempMap::GetLinearFitter(Int_t type, Int_t side, UInt_t timeSec)
153 {
154   // 
155   // Creates a TlinearFitter object for the desired region of the TPC 
156   // (via choosen type and side of TPC temperature sensors) at a given 
157   // timeSec (in secounds) after start time
158   // type: 0 ... ReadOutChambers (ROC)
159   //       1 ... OuterContainmentVessel (OFC)
160   //       2 ... InnerContainmentVessel (IFC) + ThermalScreener (TS)
161   //       3 ... Within the TPC (DriftVolume) (TPC)
162   //       4 ... Only InnerContainmentVessel (IFC) 
163   // side: Can be choosen for type 0 and 3 (otherwise it will be ignored in 
164   //       in order to get all temperature sensors of interest)
165   //       0 ... Shaft Side (A)
166   //       1 ... Muon Side (C)
167   // 
168
169   TLinearFitter *fitter = new TLinearFitter(3);
170   Double_t x[3]={0};
171   Double_t y = 0;
172   const Float_t kMaxDelta=0.5;
173   
174   if (type == 1 || type == 2 || type == 4) {
175     fitter->SetFormula("x0++x1++TMath::Sin(x2)"); // returns Z,Y gradient
176   } else {
177     fitter->SetFormula("x0++x1++x2"); // returns X,Y gradient
178   }
179
180   Int_t i = 0;
181   Int_t nsensors = fTempArray->NumSensors();
182
183   Float_t temps[1000];
184   for (Int_t isensor=0; isensor<nsensors; isensor++) { // loop over all sensors
185     AliTPCSensorTemp *entry = (AliTPCSensorTemp*)fTempArray->GetSensorNum(isensor);
186     if (entry->GetType()==type && entry->GetSide()==side){
187       Float_t temperature= fTempArray->GetValue(timeSec,isensor); // get temperature value
188       if (IsOK(temperature)) {temps[i]=temperature; i++;}
189     }
190   }
191   Float_t medianTemp = TMath::Median(i, temps);
192   if (i<3) return 0;
193   Float_t rmsTemp = TMath::RMS(i, temps);
194   
195   i=0;
196   
197   for (Int_t isensor=0; isensor<nsensors; isensor++) { // loop over all sensors
198     AliTPCSensorTemp *entry = (AliTPCSensorTemp*)fTempArray->GetSensorNum(isensor);
199     
200     if (type==0 || type==3) { // 'side' information used
201       if (entry->GetType()==type && entry->GetSide()==side) {
202         x[0]=1;
203         x[1]=entry->GetX();
204         x[2]=entry->GetY();    
205         y = fTempArray->GetValue(timeSec,isensor); // get temperature value
206         if (TMath::Abs(y-medianTemp)>kMaxDelta+4.*rmsTemp) continue;
207         if (IsOK(y)) fitter->AddPoint(x,y,1); // add values to LinearFitter
208         i++;
209       }
210     } else if (type==2) { // in case of IFC also usage of TS values
211       if ((entry->GetType()==2) || (entry->GetType()==5)) {
212         x[0]=1;
213         x[1]=entry->GetZ();
214         x[2]=entry->GetPhi();    
215         y = fTempArray->GetValue(timeSec,isensor);
216         if (TMath::Abs(y-medianTemp)>kMaxDelta+4.*rmsTemp) continue;
217         if (IsOK(y)) fitter->AddPoint(x,y,1); 
218         i++;
219       }
220     } else if (type==1){
221       if (entry->GetType()==type) {
222         x[0]=1;
223         x[1]=entry->GetZ();
224         x[2]=entry->GetPhi();    
225         y = fTempArray->GetValue(timeSec,isensor);
226         if (TMath::Abs(y-medianTemp)>kMaxDelta+4.*rmsTemp) continue;
227         if (IsOK(y)) fitter->AddPoint(x,y,1);
228         i++;    
229       }
230     } else if (type==4) { // ONLY IFC
231       if (entry->GetType()==2) {
232         x[0]=1;
233         x[1]=entry->GetZ();
234         x[2]=entry->GetPhi();    
235         y = fTempArray->GetValue(timeSec,isensor);
236         if (TMath::Abs(y-medianTemp)>kMaxDelta+4.*rmsTemp) continue;
237         if (IsOK(y)) fitter->AddPoint(x,y,1); 
238         i++;
239       }
240     }
241   }  
242   fitter->Eval();
243   //fitter->EvalRobust(0.9); // Evaluates fitter
244   
245
246   return fitter; 
247
248   // returns TLinearFitter object where Chi2, Fitparameters and residuals can 
249   // be extracted via usual memberfunctions
250   // example: fitter->GetParameters(param)
251   // In case of type IFC or OFC, the parameters are the gradients in 
252   // Z and Y direction (see fitformula)
253   // Caution: Parameters are [K/cm] except Y at IFC,OFC ([K/radius]) 
254 }
255
256 //_____________________________________________________________________________
257
258 TGraph2D *AliTPCTempMap::GetTempMapsViaSensors(Int_t type, Int_t side, UInt_t timeSec)
259 {
260   // 
261   // Creates a TGraph2D object for the desired region of the TPC 
262   // (via choosen type and side of TPC temperature sensors) at a given 
263   // timeSec (in secounds) after start time
264   // type: 0 ... ReadOutChambers (ROC)
265   //       1 ... OuterContainmentVessel (OFC)
266   //       2 ... InnerContainmentVessel (IFC) + ThermalScreener (TS)
267   //       3 ... Within the TPC (DriftVolume) (TPC)
268   // side: Can be choosen for type 0 and 3 (otherwise it will be ignored in 
269   //       in order to get all temperature sensors of interest)
270   //       0 ... A - side
271   //       1 ... C - side
272   // 
273
274   TGraph2D *graph2D = new TGraph2D();
275
276   Int_t i = 0;
277   
278   Int_t nsensors = fTempArray->NumSensors();
279   for (Int_t isensor=0; isensor<nsensors; isensor++) { // loop over all sensors
280     AliTPCSensorTemp *entry = (AliTPCSensorTemp*)fTempArray->GetSensorNum(isensor);
281
282     Double_t x, y, z, r, phi, tempValue;
283     x = entry->GetX();
284     y = entry->GetY();
285     z = entry->GetZ();
286     r = entry->GetR();
287     phi = entry->GetPhi();
288     tempValue = fTempArray->GetValue(timeSec,isensor);
289     //    printf("%d type %d: x=%lf y=%lf temp=%lf\n",isensor,entry->GetType(),x,y, tempValue);
290     if (type==0 || type==3) { // 'side' information used
291       if (entry->GetType()==type && entry->GetSide()==side) {
292         graph2D->SetPoint(i,x,y,tempValue);
293         i++;
294       }
295     } else if (type==2) { // in case of IFC also usage of TS values
296       if (entry->GetType()==2 || entry->GetType()==5) {
297         graph2D->SetPoint(i,z,phi,tempValue);
298         i++;
299       }
300     } else if (type==1){
301       if (entry->GetType()==type) {
302         graph2D->SetPoint(i,z,phi,tempValue);
303         i++;
304       }
305     }
306   }  
307   
308   if (type==0 || type==3) {
309     graph2D->GetXaxis()->SetTitle("X[cm]");
310     graph2D->GetYaxis()->SetTitle("Y[cm]");
311     if (type==0 && side==0) {
312       graph2D->SetTitle("ROC A side");
313     } else if (type==0 && side==1) {
314       graph2D->SetTitle("ROC C side");
315     } else if (type==3 && side==0) {
316       graph2D->SetTitle("TPC A side (Inside the TPC)");
317     } else if (type==3 && side==1) {
318       graph2D->SetTitle("TPC C side (Inside the TPC)");
319     }
320   } else if (type==1 || type==2) {
321     graph2D->GetXaxis()->SetTitle("Z[cm]");
322     graph2D->GetYaxis()->SetTitle("Phi[RAD]");
323     if (type==1) {
324       graph2D->SetTitle("Outer Containment Vessel");
325     } else if (type==2) {
326       graph2D->SetTitle("Inner Containment Vessel");
327     }
328   }
329
330   if (!graph2D->GetN()) {
331     printf("Returned TGraph2D is empty: check type and side values\n");
332   }
333
334   graph2D->GetXaxis()->SetLabelOffset(0.0);
335   graph2D->GetYaxis()->SetLabelOffset(0.005);
336   graph2D->GetZaxis()->SetLabelOffset(-0.04);
337   
338
339   return graph2D; // returns TGgraph2D object
340   
341 }
342
343
344 //_____________________________________________________________________________
345
346 TGraph *AliTPCTempMap::MakeGraphGradient(Int_t axis, Int_t side, Int_t nPoints)
347 {  
348   //
349   // Make graph from start time to end time of TempGradient in axis direction
350   // axis: 0 ... horizontal Temperature Gradient (X)
351   //       1 ... vertical Temperature Gradient (Y)
352   //       2 ... longitudenal Temperature Gradient (Z) (side is ignored) 
353   //             z gradient value based on OFC temperature sensors
354   //             Caution!: better z gradient values through difference between 
355   //             param[0] A- and param[0] C-side !
356   // side for X and Y gradient: 
357   //       0 ... Shaft Side (A)
358   //       1 ... Muon Side (C)
359   //
360   
361   TVectorD param(3);
362   TLinearFitter *fitter = new TLinearFitter(3);
363
364   UInt_t fStartTime = fTempArray->AliTPCSensorTempArray::GetStartTime();
365   UInt_t fEndTime = fTempArray->AliTPCSensorTempArray::GetEndTime();
366   
367   UInt_t stepTime = (fEndTime-fStartTime)/nPoints;
368
369   Double_t *x = new Double_t[nPoints];
370   Double_t *y = new Double_t[nPoints];
371   for (Int_t ip=0; ip<nPoints; ip++) {
372     x[ip] = fStartTime+ip*stepTime;
373     if (axis==2) {// Gradient in Z direction (based on OFC tempSensors)
374       fitter = GetLinearFitter(1, side, ip*stepTime);
375     } else {// Gradient in X or Y direction (based on TPC tempSensors)
376       fitter = GetLinearFitter(3, side, ip*stepTime);
377     }
378     fitter->GetParameters(param);
379     // multiplied by 500 since TempGradient is in [K/cm] 
380     // (TPC diameter and length ~500cm)
381     if (axis==1) { // Y axis
382       y[ip] = param[2]*500;
383     } else { // X axis
384       y[ip] = param[1]*500;
385     }
386   }
387
388   TGraph *graph = new TGraph(nPoints,x,y);
389
390   fitter->~TLinearFitter(); 
391   delete [] x;
392   delete [] y;
393
394   graph->GetXaxis()->SetTimeDisplay(1);
395   graph->GetXaxis()->SetLabelOffset(0.02);
396   graph->GetXaxis()->SetTimeFormat("#splitline{%d/%m}{%H:%M}");
397
398   return graph;
399 }
400
401
402 //_____________________________________________________________________________
403 Double_t AliTPCTempMap::GetTemperature(Double_t x, Double_t y, Double_t z, TTimeStamp &stamp)
404 {
405   //
406   // absolute time stamp used
407   // see also Double_t AliTPCTempMap::GetTemperature(Double_t x, Double_t y, Double_t z, UInt_t timeSec) for details
408   //
409
410   Int_t timeSec = stamp.GetSec()-fTempArray->GetStartTime().GetSec();
411   return GetTemperature(x, y, z, timeSec);
412 }
413
414 //_____________________________________________________________________________
415
416 Double_t AliTPCTempMap::GetTemperature(Double_t x, Double_t y, Double_t z, UInt_t timeSec)
417 {  
418   //
419   // Returns estimated Temperature at given position (x,y,z[cm]) at given time 
420   // (timeSec) after starttime
421   // Method: so far just a linear interpolation between Linar fits of 
422   //         the TPC temperature sensors
423   //         FIXME: 'Educated Fit' through FiniteElement Simulation results!
424   // FIXXME: Return 0? if x,y,z out of range
425   //
426   
427   TVectorD paramA(3), paramC(3);
428   TLinearFitter *fitterA = 0;
429   TLinearFitter *fitterC = 0;
430
431   fitterA = GetLinearFitter(3, 0, timeSec);
432   fitterA->GetParameters(paramA);
433   fitterC = GetLinearFitter(3, 1, timeSec);
434   fitterC->GetParameters(paramC);
435
436   Double_t fvalA = paramA[0]+paramA[1]*x+paramA[2]*y;
437   Double_t fvalC = paramC[0]+paramC[1]*x+paramC[2]*y;
438
439   Double_t k = (fvalA-fvalC)/(2*247);
440   Double_t tempValue = fvalC+(fvalA-fvalC)/2+k*z;
441
442   delete fitterA;
443   delete fitterC;
444
445   return tempValue;
446
447 }
448
449
450 Bool_t  AliTPCTempMap::IsOK(Float_t value){
451   //
452   // checks if value is within a certain range
453   //
454   const Float_t kMinT=15;
455   const Float_t kMaxT=25;
456   return (value>kMinT && value<kMaxT);
457 }