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 #include "AliHLTCaloConstantsHandler.h"
 101
 102 class AliHLTCaloConstants;
 103 class AliHLTCaloMapper;
 104
 105
 106 //class AliHLTCaloRawAnalyzerComponentv3 : public AliHLTCaloRcuProcessor
 107 class AliHLTCaloRawAnalyzerComponentv3 : public AliHLTCaloConstantsHandler, public AliHLTProcessor
 108 {
 109  public:
 110
 111   /** Constructor must be initialized to specific calorimeter */
 112   AliHLTCaloRawAnalyzerComponentv3(TString det);
 113
 114
 115
 116   /** Destructor */
 117   virtual ~AliHLTCaloRawAnalyzerComponentv3();
 118
 119   // virtual bool CheckInputDataType(const AliHLTComponentDataType &datatype) = 0;
 120
 121   /** interface function, see @ref AliHLTComponent for description */
 122   virtual int DoInit(int argc =0, const char** argv  = 0);
 123
 124   /** interface function, see @ref AliHLTComponent for description */
 125   virtual int Deinit();
 126
 127   /** interface function, see @ref AliHLTComponent for description */
 128   virtual const char* GetComponentID() = 0;
 129
 130   /** interface function, see @ref AliHLTComponent for description */
 131   virtual void GetInputDataTypes( vector <AliHLTComponentDataType>& list) = 0;
 132
 133   /** interface function, see @ref AliHLTComponent for description */
 134   virtual AliHLTComponentDataType GetOutputDataType();
 135
 136   /** interface function, see @ref AliHLTComponent for description */
 137   virtual void GetOutputDataSize(unsigned long& constBase, double& inputMultiplier);
 138
 139   /** interface function, see @ref AliHLTComponent for description */
 140   virtual AliHLTComponent* Spawn() = 0;
 141
 142  protected:
 143 virtual bool CheckInputDataType(const AliHLTComponentDataType &datatype) = 0;
 144   /** interface function, see @ref AliHLTComponent for description */
 145
 146 //  using AliHLTCaloRcuProcessor::DoEvent;
 147
 148   /** interface function, see @ref AliHLTComponent for description */
 149   virtual int DoEvent( const AliHLTComponentEventData& evtData, const AliHLTComponentBlockData* blocks,
 150                      AliHLTComponentTriggerData& trigData, AliHLTUInt8_t* outputPtr,
 151                        AliHLTUInt32_t& size, vector<AliHLTComponentBlockData>& outputBlocks );
 152
 153   /**
 154    * Do the real processing in the component
 155    * @param iter is the pointer to the data blocks
 156    * @param outputPtr is the pointer to the output buffer
 157    * @param size is the available size for output
 158    * @param totSize is the total size used for output
 159    * @return the size output size used
 160    */
 161   virtual Int_t DoIt(const AliHLTComponentBlockData* iter, AliHLTUInt8_t* outputPtr, const AliHLTUInt32_t size, UInt_t& totSize);
 162
 163
 164   /** Pointer to an analyzer object used for raw data anlysis */
 165   AliHLTCaloRawAnalyzer *fAnalyzerPtr;   //COMMENT
 166   AliHLTCaloMapper *fMapperPtr;
 167  private:
 168
 169 /** Keep default constructor private since it should not be used */
 170   AliHLTCaloRawAnalyzerComponentv3();
 171
 172   /** Keep the copy constructor private since it should not be used */
 173   AliHLTCaloRawAnalyzerComponentv3(const AliHLTCaloRawAnalyzerComponentv3 & );
 174
 175   /** Keep the assignement operator private since it should not be used */
 176   AliHLTCaloRawAnalyzerComponentv3 & operator = (const AliHLTCaloRawAnalyzerComponentv3 &);
 177
 178   virtual void InitMapping(const int specification ) = 0;
 179   const bool fkDoPushRawData;
 180   /** Mapping from harware address to geometrical address */
 181   //  AliHLTCaloMapper *fMapperPtr;                       //!transient
 182
 183   unsigned long fPhosEventCount;
 184
 185   /** Pointer to object which may check the integrity of the data */
 186   AliHLTCaloSanityInspector *fSanityInspectorPtr;     //!transient
 187
 188   /** Pointer to the raw data reader which reads from memory */
 189   AliRawReaderMemory* fRawReaderMemoryPtr;            //!transient
 190
 191   /** Pointer to the raw stream */
 192   AliAltroRawStreamV3* fAltroRawStreamPtr;              //!transient
 193
 194   /** Describing which algorithm we are using */
 195   Short_t fAlgorithm;                                 //COMMENT
 196
 197   /** The offset applied before ZS */
 198   Int_t fOffset;                                      //COMMENT
 199
 200   /** The minimum length a bunch can have to be considered */
 201   Int_t fBunchSizeCut;                                //COMMENT
 202
 203   /** The lowest position a peak can have to be considered */
 204   Int_t fMinPeakPosition;                             //COMMENT
 205
 206   /** The maximum position a peak can have to be considered */
 207   Int_t fMaxPeakPosition;                             //COMMENT
 208
 209   // AliHLTCaloMapper *fMapperPtr;
 210
 211   class RawDataWriter
 212   {
 213   public:
 214     RawDataWriter(AliHLTCaloConstants* cConst);
 215     ~RawDataWriter();
 216     //   void WriteChannelId(const UShort_t channeldid );
 217     void NewChannel( );
 218     void WriteBunchData(const UShort_t *bunchdata,  const int length,   const UInt_t starttimebin );
 219     void ResetBuffer();
 220     void SetChannelId( const UShort_t channeldid );
 221     //void CopyBufferToSharedMemory(UShort_t *memPtr, const int sizetotal, const int sizeused );
 222     int CopyBufferToSharedMemory(UShort_t *memPtr, const int sizetotal, const int sizeused );
 223     void NewEvent();
 224
 225   private:
 226
 227     //Default constructor, should not be used.
 228     RawDataWriter();
 229     RawDataWriter (const RawDataWriter  & );
 230     RawDataWriter & operator = (const RawDataWriter &);
 231     void Init();
 232     //    bool fIsFirstChannel;
 233     UShort_t* fRawDataBuffer;
 234     int fCurrentChannelSize;
 235     int fBufferIndex;
 236     int fBufferSize;
 237     UShort_t *fCurrentChannelIdPtr;
 238     UShort_t *fCurrentChannelSizePtr;
 239     UShort_t *fCurrentChannelDataPtr;
 240     int fTotalSize;
 241   };
 242
 243   RawDataWriter *fRawDataWriter;
 244
 245 };
 246
 247 #endif
 248