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