EMCAL/AliCaloRawAnalyzerPeakFinder.cxx

   1 /**************************************************************************
   2  * This file is property of and copyright by                              *
   3  * the Relativistic Heavy Ion Group (RHIG), Yale University, US, 2009     *
   4  *                                                                        *
   5  * Primary Author: Per Thomas Hille  <perthomas.hille@yale.edu>           *
   6  *                                                                        *
   7  * Contributors are mentioned in the code where appropriate.              *
   8  * Please report bugs to   perthomas.hille@yale.edu                       *
   9  *                                                                        *
  10  * Permission to use, copy, modify and distribute this software and its   *
  11  * documentation strictly for non-commercial purposes is hereby granted   *
  12  * without fee, provided that the above copyright notice appears in all   *
  13  * copies and that both the copyright notice and this permission notice   *
  14  * appear in the supporting documentation. The authors make no claims     *
  15  * about the suitability of this software for any purpose. It is          *
  16  * provided "as is" without express or implied warranty.                  *
  17  **************************************************************************/
  18
  19
  20 // The Peak-Finder algorithm
  21 // The amplitude is extracted  as a
  22 // weighted sum of the samples using the
  23 // best possible weights.
  24 // The wights is calculated only once and the
  25 // Actual extraction of amplitude and peak position
  26 // Is done with a simple vector multiplication, allowing for
  27 // Extreemely fast computations.
  28
  29 #include "AliCaloRawAnalyzerPeakFinder.h"
  30 #include "AliCaloBunchInfo.h"
  31 #include "AliCaloFitResults.h"
  32 #include "TMath.h"
  33 #include "AliLog.h"
  34 #include "AliCDBEntry.h"
  35 #include "AliCDBManager.h"
  36 #include "TFile.h"
  37 #include "AliCaloPeakFinderVectors.h"
  38
  39 using namespace std;
  40
  41
  42 ClassImp( AliCaloRawAnalyzerPeakFinder )
  43
  44
  45 AliCaloRawAnalyzerPeakFinder::AliCaloRawAnalyzerPeakFinder() :AliCaloRawAnalyzer("Peak-Finder", "PF"),
  46                                                               fAmp(0),
  47                                                               fPeakFinderVectors(0),
  48                                                               fRunOnAlien(false)
  49 {
  50   //Comment
  51   InitOCDB(fRunOnAlien);
  52   fPeakFinderVectors = new AliCaloPeakFinderVectors() ;
  53   ResetVectors();
  54   LoadVectorsOCDB();
  55 }
  56
  57
  58 void
  59 AliCaloRawAnalyzerPeakFinder::InitOCDB(bool alien) const
  60 {
  61   // Setting the default OCDB pathe depending on wether we work locally or on the GRID.
  62   AliCDBManager::Instance()->SetDefaultStorage(  alien == true ? "alien://$ALICE_ROOT/OCDB" : "local://$ALICE_ROOT/OCDB");
  63   AliCDBManager::Instance()->SetRun(100);
  64 }
  65
  66
  67 void
  68 AliCaloRawAnalyzerPeakFinder::ResetVectors()
  69 {
  70   //As name implies
  71   for(int i=0; i < MAXSTART; i++)
  72     {
  73       for(int j=0; j < SAMPLERANGE; j++ )
  74         {
  75           for(int k=0; k < 100; k++ )
  76             {
  77               fPFAmpVectors[i][j][k] = 0;
  78               fPFTofVectors[i][j][k] = 0;
  79               fPFAmpVectorsCoarse[i][j][k] = 0;
  80               fPFTofVectorsCoarse[i][j][k] = 0;
  81             }
  82         }
  83     }
  84 }
  85
  86
  87 AliCaloRawAnalyzerPeakFinder::~AliCaloRawAnalyzerPeakFinder()
  88 {
  89   //comment
  90 }
  91
  92
  93
  94 Double_t
  95 AliCaloRawAnalyzerPeakFinder::ScanCoarse(const Double_t *const array, const int length ) const
  96 {
  97   // Fisrt (coarce) estimate of Amplitude using the Peak-Finder.
  98   // The output of the first iteration is sued to select vectors
  99   // for the second iteration.
 100
 101   Double_t tmpTof = 0;
 102   Double_t tmpAmp= 0;
 103
 104   for(int i=0; i < length; i++)
 105     {
 106       tmpTof += fPFTofVectorsCoarse[0][length][i]*array[i];
 107       tmpAmp += fPFAmpVectorsCoarse[0][length][i]*array[i];
 108     }
 109
 110   tmpTof = tmpTof / tmpAmp ;
 111   return tmpTof;
 112 }
 113
 114
 115 AliCaloFitResults
 116 AliCaloRawAnalyzerPeakFinder::Evaluate( const vector<AliCaloBunchInfo> &bunchvector, const UInt_t altrocfg1,  const UInt_t altrocfg2 )
 117 {
 118   // Extracting the amplitude using the Peak-Finder algorithm
 119   // The amplitude is a weighted sum of the samples using
 120   // optimum weights.
 121
 122   short maxampindex; //index of maximum amplitude
 123   short maxamp; //Maximum amplitude
 124   fAmp = 0;
 125   int index = SelectBunch( bunchvector,  &maxampindex,  &maxamp );
 126
 127   if( index >= 0)
 128     {
 129       Float_t ped = ReverseAndSubtractPed( &(bunchvector.at(index))  ,  altrocfg1, altrocfg2, fReversed  );
 130       Float_t maxf = TMath::MaxElement(   bunchvector.at(index).GetLength(),  fReversed );
 131       short timebinOffset = maxampindex - (bunchvector.at( index ).GetLength()-1);
 132
 133       if(  maxf < fAmpCut  ||  ( maxamp - ped) > fOverflowCut  ) // (maxamp - ped) > fOverflowCut = Close to saturation (use low gain then)
 134         {
 135           return  AliCaloFitResults( maxamp, ped, AliCaloFitResults::kCrude, maxf, timebinOffset);
 136         }
 137       else if ( maxf >= fAmpCut )
 138         {
 139           int first = 0;
 140           int last = 0;
 141           short maxrev = maxampindex  -  bunchvector.at(index).GetStartBin();
 142           SelectSubarray( fReversed,  bunchvector.at(index).GetLength(), maxrev, &first, &last);
 143           int nsamples =  last - first;
 144
 145           if( ( nsamples  )  >= fNsampleCut ) // no if statement needed really; keep for readability
 146             {
 147               int startbin = bunchvector.at(index).GetStartBin();
 148               int n = last - first;
 149               int pfindex = n - fNsampleCut;
 150               pfindex = pfindex > SAMPLERANGE ? SAMPLERANGE : pfindex;
 151
 152               int dt =  maxampindex - startbin -2;
 153               int tmpindex = 0;
 154
 155               Float_t tmptof = ScanCoarse( &fReversed[dt] , n );
 156
 157               if( tmptof < -1 )
 158                 {
 159                   tmpindex = 0;
 160                 }
 161               else
 162                 if( tmptof  > -1 && tmptof < 100 )
 163                   {
 164                     tmpindex = 1;
 165                   }
 166                 else
 167                   {
 168                     tmpindex = 2;
 169                   }
 170
 171               double tof = 0;
 172
 173               for(int k=0; k < SAMPLERANGE; k++   )
 174                 {
 175                   tof +=  fPFTofVectors[0][pfindex][k]*fReversed[ dt  +k + tmpindex -1 ];
 176                 }
 177
 178               for( int i=0; i < SAMPLERANGE; i++ )
 179                 {
 180                   {
 181                     fAmp += fPFAmpVectors[0][pfindex][i]*fReversed[ dt  +i  +tmpindex -1 ];
 182                   }
 183                 }
 184               if( TMath::Abs(  (maxf - fAmp  )/maxf )  >   0.1 )
 185                 {
 186                   fAmp = maxf;
 187                 }
 188
 189               tof = timebinOffset - 0.01*tof/fAmp; // clock ticks
 190
 191               // use local-array time for chi2 estimate
 192               Float_t chi2 = CalculateChi2(fAmp, tof-timebinOffset+maxrev, first, last);
 193               Int_t ndf = last - first - 1; // nsamples - 2
 194               return AliCaloFitResults( maxamp, ped , AliCaloFitResults::kFitPar, fAmp, tof,
 195                                         timebinOffset, chi2, ndf,
 196                                         AliCaloFitResults::kDummy, AliCaloFitSubarray(index, maxrev, first, last) );
 197             }
 198           else
 199             {
 200               Float_t chi2 = CalculateChi2(maxf, maxrev, first, last);
 201               Int_t ndf = last - first - 1; // nsamples - 2
 202               return AliCaloFitResults( maxamp, ped , AliCaloFitResults::kCrude, maxf, timebinOffset,
 203                                         timebinOffset, chi2, ndf, AliCaloFitResults::kDummy, AliCaloFitSubarray(index, maxrev, first, last) );
 204             }
 205         } // ampcut
 206     }
 207   return  AliCaloFitResults(AliCaloFitResults::kInvalid, AliCaloFitResults::kInvalid);
 208 }
 209
 210
 211 void
 212 AliCaloRawAnalyzerPeakFinder::CopyVectors(const AliCaloPeakFinderVectors *const pfv )
 213 {
 214   // As name implies
 215
 216   if ( pfv != 0)
 217     {
 218       for(int i = 0;  i < MAXSTART ; i++)
 219         {
 220           for( int j=0; j < SAMPLERANGE; j++)
 221             {
 222               pfv->GetVector( i, j, fPFAmpVectors[i][j] ,  fPFTofVectors[i][j],
 223                               fPFAmpVectorsCoarse[i][j] , fPFTofVectorsCoarse[i][j]  );
 224               fPeakFinderVectors->SetVector( i, j, fPFAmpVectors[i][j], fPFTofVectors[i][j],
 225                                              fPFAmpVectorsCoarse[i][j], fPFTofVectorsCoarse[i][j] );
 226             }
 227         }
 228     }
 229   else
 230     {
 231       AliFatal( "pfv = ZERO !!!!!!!");
 232     }
 233 }
 234
 235
 236
 237 void
 238 AliCaloRawAnalyzerPeakFinder::LoadVectorsOCDB()
 239 {
 240   //Loading of Peak-Finder  vectors from the
 241   //Offline Condition Database  (OCDB)
 242   AliCDBEntry* entry = AliCDBManager::Instance()->Get("EMCAL/Calib/PeakFinder/");
 243
 244   if( entry != 0 )
 245     {
 246       AliCaloPeakFinderVectors  *pfv = (AliCaloPeakFinderVectors *)entry->GetObject();
 247       CopyVectors( pfv );
 248      }
 249 }
 250
 251
 252 void
 253 AliCaloRawAnalyzerPeakFinder::LoadVectorsASCII()
 254 {
 255   //Read in the Peak finder vecors from ASCI files
 256   for(int i = 0;  i < MAXSTART ; i++)
 257     {
 258       for( int j=0; j < SAMPLERANGE; j++)
 259         {
 260           char filenameCoarse[256];
 261           char filename[256];
 262           int n = j+fNsampleCut;
 263           double start = (double)i+0;
 264
 265           sprintf(filename,        "%s/EMCAL/vectors-emcal/start%.1fN%dtau0.235fs10dt1.0.txt", getenv("ALICE_ROOT"), start, n);
 266           sprintf(filenameCoarse,  "%s/EMCAL/vectors-emcal/start%.1fN%dtau0.235fs10dt3.0.txt", getenv("ALICE_ROOT"), start, n);
 267
 268           FILE *fp  =  fopen(filename, "r");
 269           FILE *fpc =  fopen(filenameCoarse, "r");
 270
 271           if( fp == 0 )
 272             {
 273               AliFatal( Form( "could not open file: %s", filename ) );
 274             }
 275
 276           if(fpc == 0)
 277             {
 278               AliFatal( Form( "could not open file: %s", filenameCoarse ) );
 279             }
 280           else
 281             {
 282               for(int m = 0; m < n ; m++ )
 283                 {
 284                   fscanf(fp, "%lf\t", &fPFAmpVectors[i][j][m] );
 285                   fscanf(fpc, "%lf\t", &fPFAmpVectorsCoarse[i][j][m] );
 286                 }
 287               fscanf(fp,   "\n" );
 288               fscanf(fpc,  "\n" );
 289               for(int m = 0; m < n ; m++ )
 290                 {
 291                   fscanf(fp, "%lf\t",   &fPFTofVectors[i][j][m]  );
 292                   fscanf(fpc, "%lf\t",  &fPFTofVectorsCoarse[i][j][m]  );
 293                 }
 294
 295               fPeakFinderVectors->SetVector( i, j, fPFAmpVectors[i][j], fPFTofVectors[i][j],
 296                                              fPFAmpVectorsCoarse[i][j], fPFTofVectorsCoarse[i][j] );
 297
 298               fclose (fp);
 299               fclose (fpc);
 300             }
 301         }
 302     }
 303 }
 304
 305
 306 void
 307 AliCaloRawAnalyzerPeakFinder::WriteRootFile() const
 308 {
 309   // Utility function to write Peak-Finder vectors to an root file
 310   // The output is used to create an OCDB entry.
 311   fPeakFinderVectors->PrintVectors();
 312   TFile *f = new TFile("peakfindervectors2.root",  "recreate" );
 313   fPeakFinderVectors->Write();
 314   f->Close();
 315   delete f;
 316 }