FMD/AliFMDPreprocessor.cxx

   1 /**************************************************************************
   2  * Copyright(c) 2004, 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 /* $Id$ */
  16 /** @file    AliFMDPreprocessor.cxx
  17     @author  Hans Hjersing Dalsgaard <canute@nbi.dk>
  18     @date    Mon Mar 27 12:39:09 2006
  19     @brief   Shuttle "preprocessor" for the FMD
  20 */
  21 //___________________________________________________________________
  22 //
  23 // The class processes data points from DCS (via Amanada), and DAQ DA
  24 // files (via FXS) to make calibration data for the FMD.
  25 //
  26 // Data points:
  27 //    *  Nothing yet.
  28 //
  29 // DAQ FXS file:
  30 //    * pedestals - a (ASCII) Comma Separated Values files with the
  31 //                  fields
  32 //                       rcu     DDL number
  33 //                       board   FEC board number
  34 //                       chip    ALTRO chip number on FEC
  35 //                       channel ALTRO channel number
  36 //                       strip   VA1 strip number
  37 //                       sample  Sample number
  38 //                       ped     Mean of ADC spectra
  39 //                       noise   Spread of ADC spectra
  40 //                       mu      Mean of Gaussian fit to ADC spectra
  41 //                       sigma   Variance of Gaussian fit to ADC spectra
  42 //                       chi2    Chi^2 per degrees of freedom of fit
  43 //    * Gains     - a (ASCII) Comma Separated Values files with the
  44 //                  fields
  45 //                       rcu     DDL number
  46 //                       board   FEC board number
  47 //                       chip    ALTRO chip number on FEC
  48 //                       channel ALTRO channel number
  49 //                       strip   VA1 strip number
  50 //                       gain    Slope of gain
  51 //                       error   Error on gain
  52 //                       chi2    Chi^2 per degrees of freedom of fit
  53 //
  54 // See also
  55 //
  56 //   http://aliceinfo.cern.ch/Offline/Activities/Shuttle.html
  57 //
  58 // Latest changes by Christian Holm Christensen
  59 //
  60
  61  #include <iostream>
  62
  63 #include <fstream>
  64 #include "AliFMDPreprocessor.h"
  65 #include "AliFMDCalibPedestal.h"
  66 #include "AliFMDCalibGain.h"
  67 #include "AliFMDCalibStripRange.h"
  68 #include "AliFMDCalibSampleRate.h"
  69 #include "AliFMDParameters.h"
  70 #include "AliCDBMetaData.h"
  71 #include "AliCDBManager.h"
  72 // #include "AliDCSValue.h"
  73 #include "AliLog.h"
  74 #include <TTimeStamp.h>
  75 // #include <TFile.h>
  76 #include <TObjString.h>
  77 #include <TString.h>
  78 #include <TNamed.h>
  79
  80
  81 ClassImp(AliFMDPreprocessor)
  82 #if 0 // Do not remove - here to make Emacs happy
  83 ;
  84 #endif
  85
  86
  87 //____________________________________________________
  88 AliFMDPreprocessor::AliFMDPreprocessor(AliShuttleInterface* shuttle)
  89   : AliPreprocessor("FMD", shuttle)
  90 {
  91   AddRunType("PHYSICS");
  92   AddRunType("STANDALONE");
  93   AddRunType("PEDESTAL");
  94   AddRunType("GAIN");
  95 }
  96
  97
  98 //____________________________________________________
  99 Bool_t AliFMDPreprocessor::GetAndCheckFileSources(TList*&     list,
 100                                                   Int_t       system,
 101                                                   const char* id)
 102 {
 103   // Convinience function
 104   // Parameters:
 105   //   list     On return, list of files.
 106   //   system   Alice system (DAQ, DCS, ...)
 107   //   id       File id
 108   // Return:
 109   //   kTRUE on success.
 110   list = GetFileSources(system, id);
 111   if (!list) {
 112     TString sys;
 113     switch (system) {
 114     case kDAQ: sys = "DAQ";     break;
 115     case kDCS: sys = "DCS";     break;
 116     default:   sys = "unknown"; break;
 117     }
 118     Log(Form("Failed to get file sources for %s/%s", sys.Data(), system));
 119     return kFALSE;
 120   }
 121   return kTRUE;
 122 }
 123
 124 //____________________________________________________
 125 AliCDBEntry*
 126 AliFMDPreprocessor::GetFromCDB(const char* second, const char* third)
 127 {
 128   return GetFromOCDB(second, third);
 129 }
 130
 131
 132 //____________________________________________________
 133 UInt_t AliFMDPreprocessor::Process(TMap* /* dcsAliasMap */)
 134 {
 135   // Main member function.
 136   // Parameters:
 137   //    dcsAliassMap   Map of DCS data point aliases.
 138   // Return
 139   //    0 on success, >0 otherwise
 140   Bool_t resultPed   = kTRUE;
 141   Bool_t resultGain  = kTRUE;
 142   Bool_t resultRange = kTRUE;
 143   Bool_t resultRate  = kTRUE;
 144   Bool_t resultZero  = kTRUE;
 145   Bool_t infoCalib   = kTRUE;
 146   Bool_t resultDead  = kTRUE;
 147   // Do we need this ?
 148   // if(!dcsAliasMap) return 1;
 149   //
 150   // Invoking the cdb manager and the FMD parameters class
 151   // AliCDBManager* cdb   = AliCDBManager::Instance();
 152   // cdb->SetDefaultStorage("local://$ALICE_ROOT/OCDB");
 153   // cdb->SetRun(0);
 154
 155   // Get the run type
 156   TString runType(GetRunType());
 157
 158   AliFMDParameters* pars = AliFMDParameters::Instance();
 159   if(runType.Contains("PEDESTAL", TString::kIgnoreCase))
 160     pars->Init(this, false, AliFMDParameters::kAltroMap|AliFMDParameters::kPulseGain);
 161   else if(runType.Contains("GAIN", TString::kIgnoreCase))
 162     pars->Init(this, false, AliFMDParameters::kAltroMap|AliFMDParameters::kPedestal);
 163   else
 164     pars->Init(this, false, AliFMDParameters::kAltroMap);
 165
 166   // This is if the SOR contains Fee parameters, and we run a DA to
 167   // extract these parameters.   The same code could work if we get
 168   // the information from DCS via the FXS
 169   TList* files = 0;
 170   AliFMDCalibSampleRate*      calibRate  = 0;
 171   AliFMDCalibStripRange*      calibRange = 0;
 172   AliFMDCalibZeroSuppression* calibZero  = 0;
 173
 174   if (GetAndCheckFileSources(files, kDAQ,pars->GetConditionsShuttleID()))
 175     infoCalib = GetInfoCalibration(files, calibRate, calibRange, calibZero);
 176
 177   resultRate  = (!calibRate  ? kFALSE : kTRUE);
 178   resultRange = (!calibRange ? kFALSE : kTRUE);
 179   resultZero  = (!calibZero  ? kFALSE : kTRUE);
 180
 181
 182
 183   //Creating calibration objects
 184   AliFMDCalibPedestal* calibPed  = 0;
 185   AliFMDCalibGain*     calibGain = 0;
 186   AliFMDCalibDeadMap*  calibDead = 0;
 187   if (runType.Contains("PEDESTAL", TString::kIgnoreCase)) {
 188     if (GetAndCheckFileSources(files, kDAQ, pars->GetPedestalShuttleID())) {
 189       if(files->GetSize())
 190         calibPed = GetPedestalCalibration(files);
 191     }
 192     resultPed = (calibPed ? kTRUE : kFALSE);
 193   }
 194   if (runType.Contains("GAIN", TString::kIgnoreCase)) {
 195     if (GetAndCheckFileSources(files, kDAQ, pars->GetGainShuttleID())) {
 196       if(files->GetSize())
 197         calibGain = GetGainCalibration(files);
 198     }
 199     resultGain = (calibGain ? kTRUE : kFALSE);
 200   }
 201   if(runType.Contains("PEDESTAL", TString::kIgnoreCase) || runType.Contains("GAIN", TString::kIgnoreCase))
 202     calibDead = GetDeadChannelMap(calibPed,calibGain);
 203
 204   //Storing Calibration objects
 205   AliCDBMetaData metaData;
 206   metaData.SetBeamPeriod(0);
 207   metaData.SetResponsible("Hans H. Dalsgaard");
 208   metaData.SetComment("Preprocessor stores pedestals and gains for the FMD.");
 209
 210   if(calibPed)  {
 211     resultPed  = Store("Calib","Pedestal", calibPed, &metaData, 0, kTRUE);
 212     delete calibPed;
 213   }
 214   if(calibGain) {
 215     resultGain = Store("Calib","PulseGain", calibGain, &metaData, 0, kTRUE);
 216     delete calibGain;
 217   }
 218   if(calibRange) {
 219     resultRange = Store("Calib","StripRange", calibRange, &metaData, 0, kTRUE);
 220     delete calibRange;
 221   }
 222   if(calibRate) {
 223     resultRate = Store("Calib","SampleRate", calibRate, &metaData, 0, kTRUE);
 224     delete calibRate;
 225   }
 226   if(calibZero) {
 227     resultZero = Store("Calib","ZeroSuppression", calibZero,&metaData,0,kTRUE);
 228     delete calibZero;
 229   }
 230   if(calibDead) {
 231     resultDead = Store("Calib","Dead", calibDead,&metaData,0,kTRUE);
 232     delete calibDead;
 233   }
 234
 235   Bool_t success = (resultPed && resultGain  && resultRange &&
 236                     resultRate  && resultZero && resultDead && infoCalib);
 237
 238   Log(Form("FMD preprocessor was %s", (success ? "successful" : "failed")));
 239   return (success ? 0 : 1);
 240 }
 241
 242 //____________________________________________________________________
 243 Bool_t
 244 AliFMDPreprocessor::GetInfoCalibration(TList* files,
 245                                        AliFMDCalibSampleRate*&      s,
 246                                        AliFMDCalibStripRange*&      r,
 247                                        AliFMDCalibZeroSuppression*& z)
 248 {
 249   // Get info calibrations.
 250   // Parameters:
 251   //     files List of files.
 252   //     s     On return, newly allocated object
 253   //     r     On return, newly allocated object
 254   //     z     On return, newly allocated object
 255   // Return:
 256   //     kTRUE on success
 257   if (!files) return kFALSE; // Should really be false
 258   if (files->GetEntries() <= 0) return kFALSE;
 259
 260   s = new AliFMDCalibSampleRate();
 261   r = new AliFMDCalibStripRange();
 262   z = new AliFMDCalibZeroSuppression();
 263
 264   AliFMDParameters*    pars     = AliFMDParameters::Instance();
 265   TIter                iter(files);
 266   TObjString*          fileSource;
 267
 268   while((fileSource = dynamic_cast<TObjString*>(iter.Next()))) {
 269     const Char_t* filename = GetFile(kDAQ, pars->GetConditionsShuttleID(), fileSource->GetName());
 270     std::ifstream in(filename);
 271     if(!in) {
 272       Log(Form("File %s not found!", filename));
 273       continue;
 274     }
 275     s->ReadFromFile(in);
 276     r->ReadFromFile(in);
 277   }
 278   return kTRUE;
 279 }
 280
 281
 282 //____________________________________________________________________
 283 AliFMDCalibPedestal*
 284 AliFMDPreprocessor::GetPedestalCalibration(TList* pedFiles)
 285 {
 286   // Read DAQ DA produced CSV files of pedestals, and return a
 287   // calibration object.
 288   // Parameters:
 289   //   pedFiles     List of pedestal files
 290   // Return
 291   //   A pointer to a newly allocated AliFMDCalibPedestal object, or
 292   //   null in case of errors.
 293   if(!pedFiles) return 0;
 294
 295   AliFMDCalibPedestal* calibPed = new AliFMDCalibPedestal();
 296   AliFMDParameters*    pars     = AliFMDParameters::Instance();
 297   TIter                iter(pedFiles);
 298   TObjString*          fileSource;
 299
 300   while((fileSource = dynamic_cast<TObjString*>(iter.Next()))) {
 301     const Char_t* filename = GetFile(kDAQ, pars->GetPedestalShuttleID(), fileSource->GetName());
 302     std::ifstream in(filename);
 303     if(!in) {
 304       Log(Form("File %s not found!", filename));
 305       continue;
 306     }
 307
 308     // Get header (how long is it ?)
 309     TString header;
 310     header.ReadLine(in);
 311     header.ToLower();
 312     if(!header.Contains(pars->GetPedestalShuttleID())) {
 313       Log("File header is not from pedestal!");
 314       continue;
 315     }
 316     Log("File contains data from pedestals");
 317
 318     // Read columns line
 319     int lineno = 2;
 320     header.ReadLine(in);
 321
 322     // Loop until EOF
 323     while(in.peek()!=EOF) {
 324       if(in.bad()) {
 325         Log(Form("Bad read at line %d in %s", lineno, filename));
 326         break;
 327       }
 328       UShort_t det, sec, strip;
 329       Char_t ring;
 330       Float_t ped, noise, mu, sigma, chi2ndf;
 331       Char_t c[8];
 332
 333       in >> det      >> c[0]
 334          >> ring     >> c[1]
 335          >> sec      >> c[2]
 336          >> strip    >> c[3]
 337          >> ped      >> c[4]
 338          >> noise    >> c[5]
 339          >> mu       >> c[6]
 340          >> sigma    >> c[7]
 341          >> chi2ndf;
 342       lineno++;
 343
 344       // Ignore trailing garbage
 345       // if (strip > 127) continue;
 346
 347       //Setting DDL to comply with the FMD in DAQ
 348       // UInt_t FmdDDLBase = 3072;
 349       // ddl = ddl - FmdDDLBase;
 350       //Setting the pedestals via the hardware address
 351
 352
 353       // pars->Hardware2Detector(ddl,board,chip,channel,det,ring,sec,str);
 354       // strip += str;
 355
 356       calibPed->Set(det,ring,sec,strip,ped,noise);
 357
 358     }
 359   }
 360   return calibPed;
 361 }
 362
 363 //____________________________________________________________________
 364 AliFMDCalibGain*
 365 AliFMDPreprocessor::GetGainCalibration(TList* gainFiles)
 366 {
 367   // Read DAQ DA produced CSV files of pedestals, and return a
 368   // calibration object.
 369   // Parameters:
 370   //   pedFiles     List of pedestal files
 371   // Return
 372   //   A pointer to a newly allocated AliFMDCalibPedestal object, or
 373   //   null in case of errors.
 374   if(!gainFiles) return 0;
 375
 376   AliFMDCalibGain*  calibGain  = new AliFMDCalibGain();
 377   AliFMDParameters* pars       = AliFMDParameters::Instance();
 378   TIter             iter(gainFiles);
 379   TObjString*       fileSource;
 380   while((fileSource = dynamic_cast<TObjString *>(iter.Next()))) {
 381     const Char_t* filename = GetFile(kDAQ, pars->GetGainShuttleID(), fileSource->GetName());
 382     std::ifstream in(filename);
 383     if(!in) {
 384       Log(Form("File %s not found!", filename));
 385       continue;
 386     }
 387
 388     //Get header (how long is it ?)
 389     TString header;
 390     header.ReadLine(in);
 391     header.ToLower();
 392     if(!header.Contains(pars->GetGainShuttleID())) {
 393       Log("File header is not from gain!");
 394       continue;
 395     }
 396     Log("File contains data from pulse gain");
 397
 398     // Read column headers
 399     header.ReadLine(in);
 400
 401     int lineno  = 2;
 402     // Read until EOF
 403     while(in.peek()!=EOF) {
 404       if(in.bad()) {
 405         Log(Form("Bad read at line %d in %s", lineno, filename));
 406         break;
 407       }
 408       UShort_t det, sec, strip;
 409       Char_t ring;
 410
 411       Float_t gain,error,  chi2ndf;
 412       Char_t c[6];
 413
 414       in >> det      >> c[0]
 415          >> ring     >> c[1]
 416          >> sec      >> c[2]
 417          >> strip    >> c[3]
 418          >> gain     >> c[4]
 419          >> error    >> c[5]
 420          >> chi2ndf;
 421       lineno++;
 422       // Ignore trailing garbage
 423       //if(strip > 127) continue;
 424
 425       //Setting DDL to comply with the FMD in DAQ
 426       // UInt_t FmdDDLBase = 3072;
 427       // ddl = ddl - FmdDDLBase;
 428       //Setting the pedestals via the hardware address
 429       //   pars->Hardware2Detector(ddl,board,chip,channel,det,ring,sec,str);
 430
 431       // strip += str;
 432       calibGain->Set(det,ring,sec,strip,gain);
 433     }
 434   }
 435   return calibGain;
 436 }
 437 //____________________________________________________________________
 438 AliFMDCalibDeadMap*
 439 AliFMDPreprocessor::GetDeadChannelMap(AliFMDCalibPedestal* pedcalib,
 440                                       AliFMDCalibGain*     gaincalib) {
 441   //creating dead channel map. '0' means 51200 entries
 442   AliFMDCalibDeadMap* deadmap = new AliFMDCalibDeadMap(0);
 443   //deadmap->Reset(kTRUE);
 444   Float_t noise = 0;
 445   Float_t gain  = 0;
 446
 447   AliFMDParameters* pars = AliFMDParameters::Instance();
 448   //Looping over the channels.
 449   for(UShort_t det=1;det<=3;det++) {
 450     Int_t nRings = (det==1 ? 1 : 2);
 451     for (UShort_t ir = 0; ir < nRings; ir++) {
 452       Char_t   ring = (ir == 0 ? 'I' : 'O');
 453       UShort_t nsec = (ir == 0 ? 20  : 40);
 454       UShort_t nstr = (ir == 0 ? 512 : 256);
 455
 456       for(UShort_t sec =0; sec < nsec;  sec++) {
 457
 458         for(UShort_t strip = 0; strip < nstr; strip++) {
 459
 460           Bool_t isDead = kFALSE;
 461           if(pedcalib)
 462             noise = pedcalib->Width(det, ring, sec, strip);
 463           else
 464             noise = pars->GetPedestalWidth(det, ring, sec, strip);
 465
 466           if(gaincalib)
 467             gain  = gaincalib->Value(det, ring, sec, strip);
 468           else
 469             gain  = pars->GetPulseGain(det, ring, sec, strip);
 470
 471           //marking these channels dead.
 472           if (gain < 0.5 || gain > 5 || noise > 10 || noise == 0) isDead = kTRUE;
 473
 474           deadmap->operator()(det, ring, sec, strip) = isDead;
 475         }
 476       }
 477     }
 478   }
 479
 480   return deadmap;
 481 }
 482 //____________________________________________________________________
 483 //
 484 // EOF
 485 //