Improve documentation
[u/mrichter/AliRoot.git] / PHOS / AliPHOSClusterizer.h
1 #ifndef ALIPHOSCLUSTERIZER_H
2 #define ALIPHOSCLUSTERIZER_H
3 /* Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
4  * See cxx source for full Copyright notice                               */
5                             
6 /* $Id$ */
7
8 //_________________________________________________________________________
9 //  Base class for the clusterization algorithm (pure abstract)
10 //*-- Author: Yves Schutz (SUBATECH)
11
12 // --- ROOT system ---
13
14 #include "TObject.h" 
15 #include "TClonesArray.h"
16
17 // --- Standard library ---
18
19 // --- AliRoot header files ---
20
21 #include "AliPHOSDigit.h"
22
23 typedef TClonesArray    RecPointsList ; 
24 typedef TClonesArray    DigitsList ;   
25
26 class AliPHOSClusterizer : public TObject {
27
28 public:
29
30   AliPHOSClusterizer() ;          // ctor            
31   virtual ~AliPHOSClusterizer() ; // dtor
32
33   virtual Float_t Calibrate(Int_t Amp) = 0 ; 
34   virtual Bool_t IsInEmc(AliPHOSDigit * digit)= 0 ;   
35   virtual void    GetNumberOfClustersFound(Int_t * numb) = 0 ; 
36   virtual void    GetCalibrationParameters(Float_t & A, Float_t &B) = 0 ; 
37   virtual Float_t GetEmcClusteringThreshold() = 0 ; 
38   virtual Float_t GetEmcEnergyThreshold() = 0 ;  
39   virtual Float_t GetLocalMaxCut() = 0 ; 
40   virtual Float_t GetLogWeightCut() = 0 ; 
41   virtual Float_t GetPpsdClusteringThreshold() = 0 ; 
42   virtual Float_t GetPpsdEnergyThreshold() = 0 ; 
43
44   virtual void  MakeClusters(const DigitsList * dl, RecPointsList * emccl, RecPointsList * ppsdl) = 0 ; 
45   virtual void PrintParameters() = 0 ;  
46   virtual void SetCalibrationParameters(Float_t A, Float_t B) = 0 ; 
47   virtual void SetEmcClusteringThreshold(Float_t cluth) = 0 ; 
48   virtual void SetEmcEnergyThreshold(Float_t enth) = 0 ;  
49   virtual void SetLocalMaxCut(Float_t cut) = 0 ; 
50   virtual void SetLogWeightCut(Float_t w) = 0 ; 
51   virtual void SetPpsdClusteringThreshold(Float_t cluth) = 0 ; 
52   virtual void SetPpsdEnergyThreshold(Float_t enth) = 0 ; 
53  
54   ClassDef(AliPHOSClusterizer,1)  // Clusterization algorithm class (abstract base class)
55
56 } ;
57
58 #endif // AliPHOSCLUSTERIZER_H