]>
Commit | Line | Data |
---|---|---|
1b41ab20 | 1 | //-*- Mode: C++ -*- |
2 | // $Id$ | |
3 | ||
e304ea31 | 4 | |
5 | /************************************************************************** | |
6 | * This file is property of and copyright by the ALICE HLT Project * | |
7 | * All rights reserved. * | |
8 | * * | |
9 | * Primary Authors: Per Thomas Hille, Oystein Djuvsland * | |
10 | * * | |
11 | * Permission to use, copy, modify and distribute this software and its * | |
12 | * documentation strictly for non-commercial purposes is hereby granted * | |
13 | * without fee, provided that the above copyright notice appears in all * | |
14 | * copies and that both the copyright notice and this permission notice * | |
15 | * appear in the supporting documentation. The authors make no claims * | |
16 | * about the suitability of this software for any purpose. It is * | |
17 | * provided "as is" without express or implied warranty. * | |
18 | **************************************************************************/ | |
19 | ||
20 | ||
615d9e77 | 21 | #ifndef ALIHLTPHOSRAWANALYZERCOMPONENTV2_H |
22 | #define ALIHLTPHOSRAWANALYZERCOMPONENTV2_H | |
23 | ||
e304ea31 | 24 | |
25 | /** | |
26 | * Raw data analyzer component base class for PHOS HLT | |
27 | * | |
28 | * @file AliHLTPHOSRawAnalyzerComponentv2.h | |
29 | * @author Oystein Djuvsland | |
30 | * @date | |
31 | * @brief A clusterizer component for PHOS HLT | |
32 | */ | |
33 | ||
34 | // see below for class documentation | |
35 | // or | |
36 | // refer to README to build package | |
37 | // or | |
38 | // visit http://web.ift.uib.no/~kjeks/doc/alice-hlt | |
39 | ||
615d9e77 | 40 | #include "AliHLTPHOSRcuProcessor.h" |
41 | ||
42 | ||
43 | class AliHLTPHOSRawAnalyzer; | |
44 | class AliHLTPHOSRcuCellEnergyDataStruct; | |
45 | class AliHLTPHOSMapper; | |
46 | class AliHLTPHOSSanityInspector; | |
e304ea31 | 47 | class AliAltroDecoder; |
48 | class AliAltroData; | |
49 | class AliAltroBunch; | |
615d9e77 | 50 | class AliHLTPHOSDigitMaker; |
51 | class AliHLTPHOSDigitContainerDataStruct; | |
52 | ||
e304ea31 | 53 | /** |
54 | * @class AliHLTPHOSRawAnalyzerComponentv2 | |
18af2efc | 55 | * This the new and fast version of the component taking care of the decoding and energy and timing |
56 | * extraction of the raw data from PHOS. | |
57 | * | |
58 | * <h2>General properties:</h2> | |
59 | * | |
60 | * Component ID: \b PhosRawAnalyzerv2 <br> | |
61 | * Library: \b libAliHLTPHOS.so <br> | |
62 | * Input Data Types: @ref <br> | |
63 | * Output Data Types: @ref AliHLTPHOSDefinitions::fgkChannelDataType<br> | |
64 | * | |
65 | * <h2>Mandatory arguments:</h2> | |
66 | * <!-- NOTE: ignore the \li. <i> and </i>: it's just doxygen formatting --> | |
67 | * \li No mandatory arguments for component <br> | |
68 | * | |
69 | * <h2>Optional arguments:</h2> | |
70 | * <!-- NOTE: ignore the \li. <i> and </i>: it's just doxygen formatting --> | |
71 | * \li -offset <i> value </i> <br> | |
72 | * gives the offset added to the data during zero suppression (default value: 0) | |
73 | * \li -bunchsizecut <i> value </i> <br> | |
74 | * minimum number of samples a bunch must contain to be considered (default value: 0) | |
75 | * \li -minpeakposition <i> value </i> <br> | |
76 | * cut on minimum postion of the peak in the bunch (defaul value: 0) | |
77 | * \li -maxpeakposition <i> value </i> <br> | |
78 | * cut on maximum postion of the peak in the bunch (defaul value: 100) | |
79 | * | |
80 | * <h2>Configuration:</h2> | |
81 | * <!-- NOTE: ignore the \li. <i> and </i>: it's just doxygen formatting --> | |
82 | * \li No configuration arguments | |
e304ea31 | 83 | * |
18af2efc | 84 | * <h2>Default CDB entries:</h2> |
85 | * \li No CDB entry yet, will come. | |
86 | * | |
87 | * <h2>Performance:</h2> | |
88 | * Pretty good (~ 3 kHz), depends on amount of data... | |
89 | * | |
90 | * <h2>Memory consumption:</h2> | |
91 | * Depends on the amount of data, but pretty godd | |
92 | * | |
93 | * <h2>Output size:</h2> | |
94 | * Depends on the amount of data... | |
95 | * | |
96 | * More detailed description. (Soon) | |
e304ea31 | 97 | * |
98 | * @ingroup alihlt_phos | |
18af2efc | 99 | */ |
100 | ||
615d9e77 | 101 | class AliHLTPHOSRawAnalyzerComponentv2 : public AliHLTPHOSRcuProcessor |
102 | { | |
103 | public: | |
e304ea31 | 104 | |
105 | /** Standard constructor */ | |
615d9e77 | 106 | AliHLTPHOSRawAnalyzerComponentv2(); |
e304ea31 | 107 | |
108 | /** Destructor */ | |
615d9e77 | 109 | virtual ~AliHLTPHOSRawAnalyzerComponentv2(); |
e304ea31 | 110 | |
111 | /** interface function, see @ref AliHLTComponent for description */ | |
615d9e77 | 112 | virtual int DoInit(int argc =0, const char** argv = 0); |
e304ea31 | 113 | |
114 | /** interface function, see @ref AliHLTComponent for description */ | |
615d9e77 | 115 | virtual int Deinit(); |
e304ea31 | 116 | |
117 | /** interface function, see @ref AliHLTComponent for description */ | |
615d9e77 | 118 | virtual const char* GetComponentID() = 0; |
e304ea31 | 119 | |
120 | /** interface function, see @ref AliHLTComponent for description */ | |
615d9e77 | 121 | virtual void GetInputDataTypes( vector <AliHLTComponentDataType>& list); |
e304ea31 | 122 | |
123 | /** interface function, see @ref AliHLTComponent for description */ | |
615d9e77 | 124 | virtual AliHLTComponentDataType GetOutputDataType(); |
e304ea31 | 125 | |
126 | /** interface function, see @ref AliHLTComponent for description */ | |
615d9e77 | 127 | virtual void GetOutputDataSize(unsigned long& constBase, double& inputMultiplier); |
e304ea31 | 128 | |
129 | /** interface function, see @ref AliHLTComponent for description */ | |
615d9e77 | 130 | virtual AliHLTComponent* Spawn() = 0; |
131 | ||
132 | protected: | |
615d9e77 | 133 | |
e304ea31 | 134 | /** interface function, see @ref AliHLTComponent for description */ |
615d9e77 | 135 | using AliHLTPHOSRcuProcessor::DoEvent; |
e304ea31 | 136 | |
137 | /** interface function, see @ref AliHLTComponent for description */ | |
615d9e77 | 138 | virtual int DoEvent( const AliHLTComponentEventData& evtData, const AliHLTComponentBlockData* blocks, |
139 | AliHLTComponentTriggerData& trigData, AliHLTUInt8_t* outputPtr, | |
e304ea31 | 140 | AliHLTUInt32_t& size, vector<AliHLTComponentBlockData>& outputBlocks ); |
615d9e77 | 141 | |
e304ea31 | 142 | /** |
143 | * Do the real processing in the component | |
144 | * @param iter is the pointer to the data blocks | |
145 | * @param outputPtr is the pointer to the output buffer | |
146 | * @param size is the available size for output | |
147 | * @param totSize is the total size used for output | |
148 | * @return the size output size used | |
149 | */ | |
150 | virtual Int_t DoIt(const AliHLTComponentBlockData* iter, AliHLTUInt8_t* outputPtr, const AliHLTUInt32_t size, UInt_t& totSize); | |
151 | ||
152 | ||
153 | /** Pointer to an analyzer object used for raw data anlysis */ | |
154 | AliHLTPHOSRawAnalyzer *fAnalyzerPtr; //COMMENT | |
615d9e77 | 155 | |
156 | private: | |
e304ea31 | 157 | |
158 | /** Keep the copy constructor private since it should not be used */ | |
615d9e77 | 159 | AliHLTPHOSRawAnalyzerComponentv2(const AliHLTPHOSRawAnalyzerComponentv2 & ); |
e304ea31 | 160 | |
161 | /** Keep the assignement operator private since it should not be used */ | |
615d9e77 | 162 | AliHLTPHOSRawAnalyzerComponentv2 & operator = (const AliHLTPHOSRawAnalyzerComponentv2 &); |
163 | ||
e304ea31 | 164 | /** Mapping from harware address to geometrical address */ |
165 | AliHLTPHOSMapper *fMapperPtr; //COMMENT | |
166 | ||
167 | /** Pointer to object which may check the integrity of the data */ | |
168 | AliHLTPHOSSanityInspector *fSanityInspectorPtr; //COMMENT | |
169 | ||
170 | /** Pointer to the decoder used to unpack the altro payload */ | |
171 | AliAltroDecoder *fDecoderPtr; //COMMENT | |
615d9e77 | 172 | |
e304ea31 | 173 | /** Pointer to struct containing all data from one altro channel */ |
174 | AliAltroData *fAltroDataPtr; //COMMENT | |
615d9e77 | 175 | |
e304ea31 | 176 | /** Pointer to struct containing information about single bunches in one altro channel */ |
177 | AliAltroBunch *fAltroBunchPtr; //COMMENT | |
615d9e77 | 178 | |
e304ea31 | 179 | /** Describing which algorithm we are using */ |
180 | Short_t fAlgorithm; //COMMENT | |
615d9e77 | 181 | |
e304ea31 | 182 | /** The offset applied before ZS */ |
183 | Int_t fOffset; //COMMENT | |
184 | ||
185 | /** The minimum length a bunch can have to be considered */ | |
186 | Int_t fBunchSizeCut; //COMMENT | |
187 | ||
188 | /** The lowest position a peak can have to be considered */ | |
189 | Int_t fMinPeakPosition; //COMMENT | |
190 | ||
191 | /** The maximum position a peak can have to be considered */ | |
192 | Int_t fMaxPeakPosition; //COMMENT | |
9bf87c6f | 193 | |
615d9e77 | 194 | }; |
e304ea31 | 195 | |
615d9e77 | 196 | #endif |
197 |