TRD/AliTRDRawStream.h

   1 #ifndef ALITRDRAWSTREAM_H
   2 #define ALITRDRAWSTREAM_H
   3 /* Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
   4  * See cxx source for full Copyright notice                               */
   5
   6 /* $Id$ */
   7
   8 ////////////////////////////////////////////////////////////////////////////
   9 //                                                                        //
  10 // This class provides access to TRD digits in raw data.                  //
  11 //                                                                        //
  12 ////////////////////////////////////////////////////////////////////////////
  13
  14 #include <TObject.h>
  15
  16 class AliRawReader;
  17
  18 class AliTRDgeometry;
  19 class AliTRDdigitsManager;
  20
  21 // Some constants:
  22 const UInt_t kEndoftrackletmarker = 0xAAAAAAAA; /*This marks the end of tracklet data words*/
  23 const UInt_t kEndofrawdatamarker  = 0x00000000; /*This marks the end of half-chamber-data*/
  24 const UInt_t kSizeWord            = sizeof(UInt_t);
  25
  26 class AliTRDRawStream: public TObject {
  27
  28   public :
  29
  30     AliTRDRawStream();
  31     AliTRDRawStream(AliRawReader *rawReader);
  32     virtual ~AliTRDRawStream();
  33
  34     virtual Bool_t       Next();                                // Read the next data
  35     virtual Int_t        NextChamber(AliTRDdigitsManager *man); // Read next chamber data
  36     virtual Int_t        Init();                                // Init for the fRawVersion > 1
  37
  38     enum { kDDLOffset = 0x400 };                                // Offset for DDL numbers
  39
  40     Bool_t               SetRawVersion(Int_t rv);
  41     Int_t                GetRawVersion() const                      { return fRawVersion;     };
  42     void                 SetRawReader(AliRawReader *rawReader);
  43
  44     // Get Filter settings (does not make a lot of sense):
  45     Int_t                TRAPfilterTCon() const                     { return fTCon;           };
  46     Int_t                TRAPfilterPEDon() const                    { return fPEDon;          };
  47     Int_t                TRAPfilterGAINon() const                   { return fGAINon;         };
  48     Int_t                TRAPsendsUnfilteredData() const            { return fBypass;         };
  49
  50     // Get Tracklet parameters (does not make a lot of sense):
  51     Float_t              GetTrackletPID() const                     { return fTracklPID;      };
  52     Float_t              GetTrackletDeflLength() const              { return fTracklDefL;     };
  53     Float_t              GetTrackletPadPos() const                  { return fTracklPadPos;   };
  54     Int_t                GetTrackletPadRow() const                  { return fTracklPadRow;   };
  55
  56     // Check if the link has optical power (HC sends data)
  57     Bool_t               IsGTULinkActive(Int_t sm, Int_t la, Int_t sta, Int_t side)
  58       { return ( ((fGTUlinkMask[sm][sta]) >> (2*la+side)) & 0x1 ); };
  59
  60     Int_t *GetSignals()                { return fSig;     } // Signals in the three time bins from Data Word
  61     Int_t  GetADC() const              { return fADC;     } // MCM ADC channel and Time Bin of word 1
  62     Int_t  GetTimeBin() const          { return fTB - 3;  } // MCM ADC channel and Time Bin of word 1
  63     Int_t  GetEventNumber() const      { return fEv;      } // MCM Event number and position of current MCM
  64     Int_t  GetROB() const              { return fROB;     } // MCM Event number and position of current MCM
  65     Int_t  GetMCM() const              { return fMCM;     } // MCM Event number and position of current MCM
  66     Int_t  GetSM() const               { return fSM;      } // Position of CURRENT half chamber in full TRD
  67     Int_t  GetLayer() const            { return fLAYER;   } // PLANE = Position of CURRENT half chamber in full TRD
  68     Int_t  GetStack() const            { return fSTACK;   } // CHAMBER = Position of CURRENT half chamber in full TRD
  69     Int_t  GetROC() const              { return fROC;     } // Position of CURRENT half chamber in full TRD
  70     Int_t  GetSide() const             { return fSIDE;    } // Position of CURRENT half chamber in full TRD
  71     Int_t  GetDCS() const              { return fDCS;     } // DCS board number read from data (HC header)
  72     Int_t  GetRow() const              { return fROW;     }
  73     Int_t  GetCol() const              { return fCOL;     } // Detector Pad coordinates
  74     Int_t  GetDet() const              { return fDET;     } // Helper
  75     Int_t  GetLastDet() const          { return fLastDET; } // Helper
  76     Int_t  GetMaxRow() const           { return fRowMax;  }
  77     Int_t  GetMaxCol() const           { return fColMax;  }
  78     Int_t  GetNumberOfTimeBins() const { return fTBins;   }
  79
  80  protected:
  81
  82     AliTRDgeometry *fGeo;                                   // TRD geometry
  83
  84     void   DecodeHCheader(Int_t timeBins);
  85     void   DecodeMCMheader();
  86     void   DecodeTracklet();
  87     void   DecodeGTUlinkMask();
  88     Int_t  DecodeDataWord();
  89     Int_t  DecodeDataWordV1V2();                            // Valid for fRawversion = 1, 2, ...
  90     Int_t  DecodeDataWordV3();                              // Valid for fRawversion = 3, ...
  91
  92     Int_t  NextData();                                      // Get the next piece of memory
  93
  94     enum { kStart
  95          , kStop
  96          , kWordOK
  97          , kNoMoreData
  98          , kNextSM
  99          , kNextHC
 100          , kSeekNonEoTracklet
 101          , kDecodeHC
 102          , kNextMCM
 103          , kNextData
 104          , kReading };
 105
 106   private :
 107
 108     Int_t    fSig[3];                         //  Signals in the three time bins from Data Word
 109     Int_t    fADC;                            //  MCM ADC channel and Time Bin of word 1
 110     Int_t    fTB;                             //  MCM ADC channel and Time Bin of word 1
 111     Int_t    fEv;                             //  MCM Event number and position of current MCM on TRD chamber
 112     Int_t    fROB;                            //  MCM Event number and position of current MCM on TRD chamber
 113     Int_t    fMCM;                            //  MCM Event number and position of current MCM on TRD chamber
 114     Int_t    fSM;                             //  Position of CURRENT half chamber in full TRD
 115     Int_t    fLAYER;                          //  Position of CURRENT half chamber in full TRD
 116     Int_t    fSTACK;                          //  Position of CURRENT half chamber in full TRD
 117     Int_t    fROC;                            //  Position of CURRENT half chamber in full TRD
 118     Int_t    fSIDE;                           //  Position of CURRENT half chamber in full TRD
 119     Int_t    fDCS;                            //  DCS board number read from data (HC header)
 120     Int_t    fROW;                            //  Detector Row coordinates
 121     Int_t    fCOL;                            //  Detector Pad coordinates
 122     Int_t    fDET;                            //  Current detector - version > 1
 123     Int_t    fLastDET;                        //  Previous detector - version > 1
 124
 125     Int_t    fBCctr;                          //  Counters from HC header (>=V2)
 126     Int_t    fPTctr;                          //  Counters from HC header (>=V2)
 127     Int_t    fPTphase;                        //  Counters from HC header (>=V2)
 128     Int_t    fRVmajor;                        //  Raw version numbers and number of additional HC headerwords (>=V2)
 129     Int_t    fRVminor;                        //  Raw version numbers and number of additional HC headerwords (>=V2)
 130     Int_t    fHCHWords;                       //  Raw version numbers and number of additional HC headerwords (>=V2)
 131     Int_t    fTBins;                          //  Number of time bins read from HC header (>=V2)
 132     Bool_t   fTCon;                           //  Filter settings read from HC header (>=V2)
 133     Bool_t   fPEDon;                          //  Filter settings read from HC header (>=V2)
 134     Bool_t   fGAINon;                         //  Filter settings read from HC header (>=V2)
 135     Bool_t   fXTon;                           //  Filter settings read from HC header (>=V2)
 136     Bool_t   fNonLinOn;                       //  Filter settings read from HC header (>=V2)
 137     Bool_t   fBypass;                         //  Filter settings read from HC header (>=V2)
 138     Int_t    fCommonAdditive;                 //  Common baseline additive read from HC header (>=V2)
 139
 140     Bool_t   fZeroSuppressed;                 // Data is zero suppressed
 141
 142     Int_t    fHCHctr1;                        //  HC and MCM Header counter
 143     Int_t    fHCHctr2;                        //  HC and MCM Header counter
 144     Int_t    fMCMHctr1;                       //  HC and MCM Header counter
 145     Int_t    fMCMHctr2;                       //  HC and MCM Header counter
 146     Int_t    fGTUctr1;                        //  GTU LinkMask Counter
 147     Int_t    fGTUctr2;                        //  GTU LinkMask Counter
 148     Int_t    fHCdataCtr;                      //  Data Counter for half chamber
 149
 150     Float_t  fTracklPID;                      //  Tracklet parameters
 151     Float_t  fTracklDefL;                     //  Tracklet parameters
 152     Float_t  fTracklPadPos;                   //  Tracklet parameters
 153     Int_t    fTracklPadRow;                   //  Tracklet parameters
 154
 155     UShort_t fGTUlinkMask[18][5];             //  Mask with active links
 156
 157     AliTRDRawStream(const AliTRDRawStream &stream);
 158     AliTRDRawStream &operator=(const AliTRDRawStream &stream);
 159
 160     AliRawReader *fRawReader;              //  Object for reading the raw data
 161
 162     Int_t    fRawVersion;                  //  Which version of raw data decoding is used
 163
 164     Int_t    fNextStatus;                  //  Navigation in raw versions > 1
 165     UInt_t   fTbSwitch;                    //  Time Bin Switch for internal use
 166     UInt_t   fTbSwitchCtr;                 //  Counter for internal use
 167     UInt_t   fTimeWords;                   //  Number of Words needed to store the data of 1 ADC ch.
 168     UInt_t   fWordCtr;                     //  Word Counter
 169
 170     Int_t    fRowMax;                      //  Maximum number of pad rows and columns
 171     Int_t    fColMax;                      //  Maximum number of pad rows and columns
 172
 173     Bool_t   fADCmask[21];                 //  Mask of active ADCs for zero suppression
 174     UShort_t fChamberDone[540];            //  Chamber was processed already (1=1HC, 2=full chamber)
 175
 176     Int_t    fRetVal;                      //  Datadecode return
 177     Int_t    fEqID;                        //  Equipment id
 178     UInt_t   fDataSize;                    //  Size of the data available in the current buffer
 179     Bool_t   fSizeOK;                      //  Did we read anything
 180     UInt_t   fCountBytes;                  //  Bytes traversed in the buffer
 181     UInt_t   fBufSize;                     //  Size of the current RawReader buffer
 182     Bool_t   fBufferSet;                   //  Is the RawReader buffer available
 183     UChar_t *fPos;                         //  Position in the buffer of the RawReader
 184     UInt_t  *fDataWord;                    //  The pointer to the current 32 bit data word
 185     UInt_t   fTimeBinsCalib;               //  N of time bins retrieved from calibration
 186
 187     enum ETRDzRawStreamError {
 188        kHCWordMissing = 1                  //
 189       ,kMCMADCMaskMissing = 2              //
 190       ,kWrongMCMorROB = 3                  //
 191       ,kGTULinkMaskMissing = 4             //
 192       ,kHCHeaderCorrupt = 5                //
 193       ,kHCHeaderMissing = 6                //
 194       ,kROBSideMismatch = 7                //
 195       ,kWrongPadrow = 8                    //
 196       ,kWrongPadcolumn = 9                 //
 197       ,kTrackletRowMismatch = 10           //
 198       ,kDataMaskError = 11                 //
 199       ,kADCNumberOverflow = 12             //
 200       ,kADCChannelOverflow = 13            //
 201     };
 202
 203     ClassDef(AliTRDRawStream, 6)           // Class for reading TRD raw digits
 204
 205 };
 206 #endif