update from Per Thomas: \
[u/mrichter/AliRoot.git] / EMCAL / AliCaloRawAnalyzer.h
1 // -*- mode: c++ -*-
2 #ifndef ALICALORAWANALYZER_H
3 #define ALICALORAWANALYZER_H
4 /**************************************************************************
5  * This file is property of and copyright by                              *
6  * the Relatvistic Heavy Ion Group (RHIG), Yale University, US, 2009      *
7  *                                                                        *
8  * Primary Author: Per Thomas Hille <p.t.hille@fys.uio.no>                *
9  *                                                                        *
10  * Contributors are mentioned in the code where appropriate.              *
11  * Please report bugs to p.t.hille@fys.uio.no                             *
12  *                                                                        *
13  * Permission to use, copy, modify and distribute this software and its   *
14  * documentation strictly for non-commercial purposes is hereby granted   *
15  * without fee, provided that the above copyright notice appears in all   *
16  * copies and that both the copyright notice and this permission notice   *
17  * appear in the supporting documentation. The authors make no claims     *
18  * about the suitability of this software for any purpose. It is          *
19  * provided "as is" without express or implied warranty.                  *
20  **************************************************************************/
21
22
23 //Base class for extraction 
24 //of signal amplitude and peak position
25 //From CALO Calorimeter RAW data
26
27 #include "Rtypes.h"
28 #include "TObject.h"
29 #define MAXSAMPLES 1008 //CRAP PTH
30 #include <vector>
31 #include "AliCaloConstants.h"
32
33 //using  namespace CaloConstants::FitAlgorithm;
34 //using  CaloConstants::ReturnCodes;
35
36 class AliCaloBunchInfo;
37 class AliCaloFitResults;
38
39 class  AliCaloRawAnalyzer : public TObject
40 {
41  public:
42   AliCaloRawAnalyzer(const char *name="AliCaloRawAnalyzer", const char *nameshort="RawAna");
43   virtual ~AliCaloRawAnalyzer();
44   virtual AliCaloFitResults Evaluate( const std::vector<AliCaloBunchInfo> &bunchvector, 
45                                       const UInt_t altrocfg1,  const UInt_t altrocfg2 ) = 0;
46   //enum fitAlgorithm {kCrude, kPeakFinder, kLMS, kFastFit, kNeuralNet, kNONE};
47   void PrintBunches( const std::vector<AliCaloBunchInfo> &bunchvector ) const;
48   void PrintBunch( const AliCaloBunchInfo &bunch ) const ;
49   
50   virtual int PreFitEvaluateSamples( const std::vector<AliCaloBunchInfo>  &bunchvector, 
51                                      const UInt_t altrocfg1,  const UInt_t altrocfg2, Int_t & index, 
52                                      Float_t & maxf, short & maxamp, short & maxampindex, Float_t & ped, int & first, int & last);
53   void SetTimeConstraint(const int min, const int max );
54   void SetVerbose(bool verbose = true){ fVerbose = verbose; };
55   void SetIsZeroSuppressed(const bool iszs = true) { fIsZerosupressed = iszs; } ;
56   void SetAmpCut(const Float_t cut) { fAmpCut = cut ; } ;
57   void SetFitArrayCut(const Int_t cut) { fFitArrayCut = cut ; } ;
58   void SetNsampleCut(const Int_t cut) { fNsampleCut = cut ; } ;
59   void SetOverflowCut(const Int_t cut) { fOverflowCut = cut ; } ;
60   void SetNsamplePed(const Int_t i) { fNsamplePed = i ; } ;
61
62   bool GetIsZeroSuppressed() const { return fIsZerosupressed;} ;
63   Float_t GetAmpCut() const { return fAmpCut; } ;
64   Int_t GetFitArrayCut() const { return fFitArrayCut; } ;
65   Int_t GetNsampleCut() const { return fNsampleCut; } ;
66   Int_t GetOverflowCut() const { return fOverflowCut; } ;
67   Int_t GetNsamplePed() const { return fNsamplePed; } ;
68
69   // access to array info
70   Double_t GetReversed(const int i) const { return fReversed[i]; }
71   const char * GetAlgoName() const { return fName;  };
72   const char * GetAlgoAbbr() const { return fNameShort;  };
73   Algo::fitAlgorithm GetAlgo() const { return fAlgo; };
74
75   Double_t CalculateChi2(const Double_t amp, const Double_t time,
76                          const Int_t first, const Int_t last,
77                          const Double_t adcErr=1, 
78                          const Double_t tau=2.35);
79
80   void CalculateMeanAndRMS(const Int_t first, const Int_t last,
81                            Double_t & mean, Double_t & rms);
82
83  protected:
84   short Max( const AliCaloBunchInfo *const bunch, int *const maxindex) const;
85   UShort_t Max(const UShort_t *data, const int length ) const;
86   bool CheckBunchEdgesForMax( const AliCaloBunchInfo *const bunch) const;
87   bool IsInTimeRange( const int maxindex ) const;
88   Float_t  ReverseAndSubtractPed( const AliCaloBunchInfo *bunch, const UInt_t altrocfg1,  const UInt_t altrocfg2, double *outarray ) const;
89   int  SelectBunch( const std::vector<AliCaloBunchInfo> &bunchvector, short *const maxampbin, short *const maxamplitude ) const;
90   virtual void SelectSubarray( const Double_t *fData, const int length, const short maxindex, int *const  first, int *const last ) const;
91   Float_t EvaluatePedestal(const UShort_t * const data, const int length ) const;
92   
93   Double_t fReversed[MAXSAMPLES]; //Reversed sequence of samples (pedestalsubtracted)
94
95   // private:
96   int fMinTimeIndex; //The timebin of the max signal value must be between fMinTimeIndex and fMaxTimeIndex
97   int fMaxTimeIndex; //The timebin of the max signal value must be between fMinTimeIndex and fMaxTimeIndex
98   int fFitArrayCut;  //Cut on ADC value (after ped. subtraction) for signals used for fit
99   Float_t fAmpCut;   //Max ADC - pedestal must be higher than this befor attemting to extract the amplitude 
100   int fNsampleCut;   //Minimum number of sample require before attemting to extract signal parameters 
101   int fOverflowCut; // value when ADC starts to saturate
102   int fNsamplePed;   //Number of samples used for pedestal calculation (first in bunch) 
103   bool fIsZerosupressed; //Wether or not the data is zeros supressed, by default its assumed that the baseline is also subtracted if set to true
104   bool fVerbose;     //Print debug information to std out if set to true
105
106   char fName[256]; // Name of the algorithm
107   char fNameShort[256]; // Abbrevation for the name
108  
109
110   //  CaloConstants  fAlgo;
111   Algo::fitAlgorithm fAlgo;
112   
113   ClassDef(AliCaloRawAnalyzer, 2)  
114
115 };
116
117 #endif