e4349a3fbcabaff4a40a98a1f45a5c72ae290649
[u/mrichter/AliRoot.git] / HLT / CALO / AliHLTCaloRawAnalyzerComponentv3.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 ALIHLTCALORAWANALYZERCOMPONENTV3_H
19 #define ALIHLTCALORAWANALYZERCOMPONENTV3_H
20
21
22 /**
23  * Raw data analyzer component base class for PHOS HLT
24  *
25  * @file   AliHLTCaloRawAnalyzerComponentv3.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 "AliHLTCaloRcuProcessor.h"
38
39
40 class AliHLTCaloRawAnalyzer;
41 class AliHLTCaloRcuCellEnergyDataStruct;
42 class AliHLTCaloMapper;
43 class AliHLTCaloSanityInspector;
44 class AliHLTCaloDigitMaker;
45 class AliHLTCaloDigitContainerDataStruct;
46 class AliRawReaderMemory;
47 class AliAltroRawStreamV3;
48
49 /**
50  * @class AliHLTCaloRawAnalyzerComponentv3
51  * This the new and fast version of the component taking care of the decoding and energy and timing 
52  * extraction of the raw data from PHOS.
53  *
54  * <h2>General properties:</h2>
55  *
56  * Component ID: \b PhosRawAnalyzerv3 <br>
57  * Library: \b libAliHLTCalo.so     <br>
58  * Input Data Types: @ref <br>
59  * Output Data Types: @ref AliHLTCaloDefinitions::fgkChannelDataType<br>
60  *
61  * <h2>Mandatory arguments:</h2>
62  * <!-- NOTE: ignore the \li. <i> and </i>: it's just doxygen formatting -->
63  * \li No mandatory arguments for component                           <br>
64  *
65  * <h2>Optional arguments:</h2>
66  * <!-- NOTE: ignore the \li. <i> and </i>: it's just doxygen formatting -->
67  * \li -offset      <i> value </i> <br>
68  *      gives the offset added to the data during zero suppression (default value: 0)
69  * \li -bunchsizecut <i> value </i> <br>
70  *      minimum number of samples a bunch must contain to be considered  (default value: 0)
71  * \li -minpeakposition <i> value </i> <br>
72  *      cut on minimum postion of the peak in the bunch (defaul value: 0)
73  * \li -maxpeakposition <i> value </i> <br>
74  *      cut on maximum postion of the peak in the bunch (defaul value: 100)
75  *
76  * <h2>Configuration:</h2>
77  * <!-- NOTE: ignore the \li. <i> and </i>: it's just doxygen formatting -->
78  * \li No configuration arguments 
79  *
80  * <h2>Default CDB entries:</h2>
81  * \li No CDB entry yet, will come.
82  *
83  * <h2>Performance:</h2>
84  * Pretty good (~ 3 kHz), depends on amount of data...
85  *
86  * <h2>Memory consumption:</h2>
87  * Depends on the amount of data, but pretty godd
88  *
89  * <h2>Output size:</h2>
90  * Depends on the amount of data...
91  *
92  * More detailed description. (Soon)
93  *
94  * @ingroup alihlt_phos
95  */ 
96
97
98 #include "AliHLTProcessor.h"
99 #include "AliHLTCaloDefinitions.h"
100
101 class AliHLTCaloMapper;
102
103
104 //class AliHLTCaloRawAnalyzerComponentv3 : public AliHLTCaloRcuProcessor
105 class AliHLTCaloRawAnalyzerComponentv3 : public AliHLTProcessor
106 {
107  public:
108
109   /** Standard constructor */
110   AliHLTCaloRawAnalyzerComponentv3();
111
112   /** Destructor */
113   virtual ~AliHLTCaloRawAnalyzerComponentv3();
114
115   // virtual bool CheckInputDataType(const AliHLTComponentDataType &datatype) = 0;
116
117   /** interface function, see @ref AliHLTComponent for description */
118   virtual int DoInit(int argc =0, const char** argv  = 0);
119
120   /** interface function, see @ref AliHLTComponent for description */
121   virtual int Deinit();
122
123   /** interface function, see @ref AliHLTComponent for description */
124   virtual const char* GetComponentID() = 0;
125
126   /** interface function, see @ref AliHLTComponent for description */
127   virtual void GetInputDataTypes( vector <AliHLTComponentDataType>& list) = 0;
128
129   /** interface function, see @ref AliHLTComponent for description */
130   virtual AliHLTComponentDataType GetOutputDataType();
131
132   /** interface function, see @ref AliHLTComponent for description */
133   virtual void GetOutputDataSize(unsigned long& constBase, double& inputMultiplier);
134
135   /** interface function, see @ref AliHLTComponent for description */
136   virtual AliHLTComponent* Spawn() = 0; 
137
138  protected:
139 virtual bool CheckInputDataType(const AliHLTComponentDataType &datatype) = 0;
140   /** interface function, see @ref AliHLTComponent for description */
141
142 //  using AliHLTCaloRcuProcessor::DoEvent;
143
144   /** interface function, see @ref AliHLTComponent for description */
145   virtual int DoEvent( const AliHLTComponentEventData& evtData, const AliHLTComponentBlockData* blocks, 
146                      AliHLTComponentTriggerData& trigData, AliHLTUInt8_t* outputPtr, 
147                        AliHLTUInt32_t& size, vector<AliHLTComponentBlockData>& outputBlocks );  
148
149   /** 
150    * Do the real processing in the component 
151    * @param iter is the pointer to the data blocks
152    * @param outputPtr is the pointer to the output buffer
153    * @param size is the available size for output
154    * @param totSize is the total size used for output
155    * @return the size output size used
156    */
157   virtual Int_t DoIt(const AliHLTComponentBlockData* iter, AliHLTUInt8_t* outputPtr, const AliHLTUInt32_t size, UInt_t& totSize); 
158
159
160   /** Pointer to an analyzer object used for raw data anlysis */ 
161   AliHLTCaloRawAnalyzer *fAnalyzerPtr;   //COMMENT
162   AliHLTCaloMapper *fMapperPtr;     
163  private:
164
165   /** Keep the copy constructor private since it should not be used */
166   AliHLTCaloRawAnalyzerComponentv3(const AliHLTCaloRawAnalyzerComponentv3 & );
167
168   /** Keep the assignement operator private since it should not be used */
169   AliHLTCaloRawAnalyzerComponentv3 & operator = (const AliHLTCaloRawAnalyzerComponentv3 &);
170
171   virtual void InitMapping(const int specification ) = 0;
172   const bool fkDoPushRawData;
173   /** Mapping from harware address to geometrical address */
174   //  AliHLTCaloMapper *fMapperPtr;                       //!transient 
175
176   unsigned long fPhosEventCount;
177
178   /** Pointer to object which may check the integrity of the data */
179   AliHLTCaloSanityInspector *fSanityInspectorPtr;     //!transient
180
181   /** Pointer to the raw data reader which reads from memory */
182   AliRawReaderMemory* fRawReaderMemoryPtr;            //!transient
183   
184   /** Pointer to the raw stream */
185   AliAltroRawStreamV3* fAltroRawStreamPtr;              //!transient
186
187   /** Describing which algorithm we are using */
188   Short_t fAlgorithm;                                 //COMMENT
189
190   /** The offset applied before ZS */
191   Int_t fOffset;                                      //COMMENT
192
193   /** The minimum length a bunch can have to be considered */
194   Int_t fBunchSizeCut;                                //COMMENT
195
196   /** The lowest position a peak can have to be considered */
197   Int_t fMinPeakPosition;                             //COMMENT
198   
199   /** The maximum position a peak can have to be considered */
200   Int_t fMaxPeakPosition;                             //COMMENT
201   
202   // AliHLTCaloMapper *fMapperPtr;
203
204   class RawDataWriter 
205   {
206   public:
207     RawDataWriter();
208     ~RawDataWriter();
209     //   void WriteChannelId(const UShort_t channeldid );
210     void NewChannel( );
211     void WriteBunchData(const UShort_t *bunchdata,  const int length,   const UInt_t starttimebin );
212     void ResetBuffer();
213     void SetChannelId( const UShort_t channeldid );
214     //void CopyBufferToSharedMemory(UShort_t *memPtr, const int sizetotal, const int sizeused );
215     int CopyBufferToSharedMemory(UShort_t *memPtr, const int sizetotal, const int sizeused );
216     void NewEvent();
217    
218   private:
219     RawDataWriter (const RawDataWriter  & );
220     RawDataWriter & operator = (const RawDataWriter &);
221     void Init();
222     //    bool fIsFirstChannel;
223     UShort_t* fRawDataBuffer;
224     int fCurrentChannelSize;
225     int fBufferIndex;
226     int fBufferSize;
227     UShort_t *fCurrentChannelIdPtr;
228     UShort_t *fCurrentChannelSizePtr; 
229     UShort_t *fCurrentChannelDataPtr; 
230     int fTotalSize;
231   };
232
233   RawDataWriter *fRawDataWriter; 
234
235 };
236
237 #endif
238