Factorization of the different raw fitting algorithms in EMCAL (Per Thomas)
[u/mrichter/AliRoot.git] / HLT / PHOS / AliHLTPHOSRawAnalyzerComponentv3.h
1
2 /**************************************************************************
3  * This file is property of and copyright by the ALICE HLT Project        * 
4  * All rights reserved.                                                   *
5  *                                                                        *
6  * Primary Authors: Per Thomas Hille, Oystein Djuvsland                   *
7  *                                                                        *
8  * Permission to use, copy, modify and distribute this software and its   *
9  * documentation strictly for non-commercial purposes is hereby granted   *
10  * without fee, provided that the above copyright notice appears in all   *
11  * copies and that both the copyright notice and this permission notice   *
12  * appear in the supporting documentation. The authors make no claims     *
13  * about the suitability of this software for any purpose. It is          * 
14  * provided "as is" without express or implied warranty.                  *
15  **************************************************************************/
16
17
18 #ifndef ALIHLTPHOSRAWANALYZERCOMPONENTV3_H
19 #define ALIHLTPHOSRAWANALYZERCOMPONENTV3_H
20
21
22 /**
23  * Raw data analyzer component base class for PHOS HLT
24  *
25  * @file   AliHLTPHOSRawAnalyzerComponentv3.h
26  * @author Oystein Djuvsland
27  * @date   
28  * @brief  A clusterizer component for PHOS HLT
29 */
30
31 // see below for class documentation
32 // or
33 // refer to README to build package
34 // or
35 // visit http://web.ift.uib.no/~kjeks/doc/alice-hlt
36
37 #include "AliHLTCaloRawAnalyzerComponentv3.h"
38
39 class AliHLTPHOSRawAnalyzer;
40
41 /**
42  * @class AliHLTPHOSRawAnalyzerComponentv3
43  * This the new and fast version of the component taking care of the decoding and energy and timing 
44  * extraction of the raw data from PHOS.
45  *
46  * <h2>General properties:</h2>
47  *
48  * Component ID: \b PhosRawAnalyzerv3 <br>
49  * Library: \b libAliHLTPHOS.so     <br>
50  * Input Data Types: @ref <br>
51  * Output Data Types: @ref AliHLTPHOSDefinitions::fgkChannelDataType<br>
52  *
53  * <h2>Mandatory arguments:</h2>
54  * <!-- NOTE: ignore the \li. <i> and </i>: it's just doxygen formatting -->
55  * \li No mandatory arguments for component                           <br>
56  *
57  * <h2>Optional arguments:</h2>
58  * <!-- NOTE: ignore the \li. <i> and </i>: it's just doxygen formatting -->
59  * \li -offset      <i> value </i> <br>
60  *      gives the offset added to the data during zero suppression (default value: 0)
61  * \li -bunchsizecut <i> value </i> <br>
62  *      minimum number of samples a bunch must contain to be considered  (default value: 0)
63  * \li -minpeakposition <i> value </i> <br>
64  *      cut on minimum postion of the peak in the bunch (defaul value: 0)
65  * \li -maxpeakposition <i> value </i> <br>
66  *      cut on maximum postion of the peak in the bunch (defaul value: 100)
67  *
68  * <h2>Configuration:</h2>
69  * <!-- NOTE: ignore the \li. <i> and </i>: it's just doxygen formatting -->
70  * \li No configuration arguments 
71  *
72  * <h2>Default CDB entries:</h2>
73  * \li No CDB entry yet, will come.
74  *
75  * <h2>Performance:</h2>
76  * Pretty good (~ 3 kHz), depends on amount of data...
77  *
78  * <h2>Memory consumption:</h2>
79  * Depends on the amount of data, but pretty godd
80  *
81  * <h2>Output size:</h2>
82  * Depends on the amount of data...
83  *
84  * More detailed description. (Soon)
85  *
86  * @ingroup alihlt_phos
87  */ 
88
89
90 //#include "AliCaloConstants.h"
91
92 //using namespace Algo;
93
94
95 class AliHLTPHOSRawAnalyzerComponentv3 : public AliHLTCaloRawAnalyzerComponentv3
96 {
97  public:
98   AliHLTPHOSRawAnalyzerComponentv3( fitAlgorithm algo ); /** Standard constructor */
99   virtual ~AliHLTPHOSRawAnalyzerComponentv3();
100   virtual void GetInputDataTypes( vector <AliHLTComponentDataType>& list);/** interface function, see @ref AliHLTComponent for description */
101   virtual AliHLTComponentDataType GetOutputDataType();/** interface function, see @ref AliHLTComponent for description */
102   virtual const char* GetComponentID() = 0; 
103   virtual AliHLTComponent* Spawn() = 0; /** interface function, see @ref AliHLTComponent for description */
104  
105  protected:
106     
107   /** interface function, see @ref AliHLTComponent for description */
108   virtual int DoInit(int argc, const char** argv);
109
110     
111   virtual void InitMapping(const int specification);
112   
113  private:
114   AliHLTPHOSRawAnalyzerComponentv3();
115   AliHLTPHOSRawAnalyzerComponentv3(const AliHLTPHOSRawAnalyzerComponentv3 & );
116   AliHLTPHOSRawAnalyzerComponentv3 & operator = (const AliHLTPHOSRawAnalyzerComponentv3 &);
117   
118 };
119
120 #endif
121