]> git.uio.no Git - u/mrichter/AliRoot.git/blobdiff - TRD/AliTRDRawStream.h
BlockFilter component added; minor corrections
[u/mrichter/AliRoot.git] / TRD / AliTRDRawStream.h
index 2d43235118924a1cd47d8f513c8d99b9ea8df734..ed254f4238225cd86368307843f8a21ff0abd2fe 100644 (file)
 /* $Id$ */
 
 ///////////////////////////////////////////////////////////////////////////////
-///
-/// This class provides access to TRD digits in raw data.
-///
+//                                                                           //
+// This class provides access to TRD digits in raw data.                     //
+//                                                                           //
 ///////////////////////////////////////////////////////////////////////////////
 
 #include <TObject.h>
 
+class AliTRDgeometry;
 class AliRawReader;
-class AliTRDparameter;
+class AliTRDdigitsManager;
+
+// Some constants:
+const UInt_t kEndoftrackletmarker = 0xAAAAAAAA; /*This marks the end of tracklet data words*/
+const UInt_t kEndofrawdatamarker  = 0x00000000; /*This marks the end of half-chamber-data*/
+const UInt_t kSizeWord = sizeof(UInt_t);
 
 class AliTRDRawStream: public TObject {
+
   public :
-    AliTRDRawStream(AliRawReader* rawReader);
+
+    AliTRDRawStream();
+    AliTRDRawStream(AliRawReader *rawReader);
     virtual ~AliTRDRawStream();
 
-    virtual Bool_t   Next();
+    virtual Bool_t       Next();              // Read the next data
+    virtual Int_t NextChamber(AliTRDdigitsManager *man); // read next chamber data
+    virtual Int_t        Init();              // Init for the fRawVersion > 1
+
+    enum { kDDLOffset = 0x400 };              // Offset for DDL numbers
+
+    Bool_t               SetRawVersion(Int_t rv);
+    Int_t                GetRawVersion() const                      { return fRawVersion;     };
+    void                 SetRawReader(AliRawReader *rawReader);
+
+    // Get Filter settings (does not make a lot of sense):
+    Int_t                TRAPfilterTCon() const                     { return fTCon;           };
+    Int_t                TRAPfilterPEDon() const                    { return fPEDon;          };
+    Int_t                TRAPfilterGAINon() const                   { return fGAINon;         };
+    Int_t                TRAPsendsUnfilteredData() const            { return fBypass;         };
 
-    Int_t            GetDetector() const {return fDetector;};
-    Int_t            GetPrevDetector() const {return fPrevDetector;};
-    Bool_t           IsNewDetector() const {return fDetector != fPrevDetector;};
-    Int_t            GetNPads() const {return fNPads;};
-    Int_t            GetRow() const {return fRow;};
-    Int_t            GetPrevRow() const {return fPrevRow;};
-    Bool_t           IsNewRow() const {return (fRow != fPrevRow) || IsNewDetector();};
-    Int_t            GetColumn() const {return fColumn;};
-    Int_t            GetPrevColumn() const {return fPrevColumn;};
-    Bool_t           IsNewColumn() const {return (fColumn != fPrevColumn) || IsNewRow();};
-    Int_t            GetTime() const {return fTime-1;};
-    Int_t            GetSignal() const {return fSignal;};
+    // Get Tracklet parameters (does not make a lot of sense):
+    Float_t              GetTrackletPID() const                     { return fTracklPID;      };
+    Float_t              GetTrackletDeflLength() const              { return fTracklDefL;     };
+    Float_t              GetTrackletPadPos() const                  { return fTracklPadPos;   };
+    Int_t                GetTrackletPadRow() const                  { return fTracklPadRow;   };
 
-    enum {kDDLOffset = 0x400};    // offset for DDL numbers
+    // Check if the link has optical power (HC sends data)
+    Bool_t               IsGTULinkActive(Int_t sm, Int_t la, Int_t sta, Int_t side)
+      { return ( ((fGTUlinkMask[sm][sta]) >> (2*la+side)) & 0x1 ); };
+
+    Int_t *GetSignals() { return fSig;}                         //  Signals in the three time bins from Data Word
+    Int_t GetADC() const { return fADC;}                            //  MCM ADC channel and Time Bin of word 1
+    Int_t GetTimeBin() const { return fTB - 3;}                             //  MCM ADC channel and Time Bin of word 1
+    Int_t GetEventNumber() const { return fEv;}                             //  MCM Event number and position of current MCM on TRD chamber
+    Int_t GetROB() const { return fROB;}                            //  MCM Event number and position of current MCM on TRD chamber
+    Int_t GetMCM() const { return fMCM;}                           //  MCM Event number and position of current MCM on TRD chamber
+    Int_t GetSM() const { return fSM;}                             //  Position of CURRENT half chamber in full TRD
+    Int_t GetLayer() const { return fLAYER;}                          //  PLANE = Position of CURRENT half chamber in full TRD
+    Int_t GetStack() const { return fSTACK;}                          //  CHAMBER = Position of CURRENT half chamber in full TRD
+    Int_t GetROC() const { return fROC;}                            //  Position of CURRENT half chamber in full TRD
+    Int_t GetSide() const { return fSIDE;}                           //  Position of CURRENT half chamber in full TRD
+    Int_t GetDCS() const { return fDCS;}                            //  DCS board number read from data (HC header)
+    Int_t GetRow() const { return fROW;}
+    Int_t GetCol() const { return fCOL;}                            //  Detector Pad coordinates
+    Int_t GetDet() const { return fDET;} // helper
+    Int_t GetLastDet() const { return fLastDET;} // helper
+    Int_t GetMaxRow() const { return fRowMax;}
+    Int_t GetMaxCol() const { return fColMax;}
+    Int_t GetNumberOfTimeBins() const {return fTBins;}
 
   private :
-    AliTRDRawStream(const AliTRDRawStream& stream);
-    AliTRDRawStream& operator = (const AliTRDRawStream& stream);
 
-    AliRawReader*    fRawReader;    // object for reading the raw data
+    Int_t    fSig[3];                         //  Signals in the three time bins from Data Word
+    Int_t    fADC;                            //  MCM ADC channel and Time Bin of word 1
+    Int_t    fTB;                             //  MCM ADC channel and Time Bin of word 1
+    Int_t    fEv;                             //  MCM Event number and position of current MCM on TRD chamber
+    Int_t    fROB;                            //  MCM Event number and position of current MCM on TRD chamber
+    Int_t    fMCM;                            //  MCM Event number and position of current MCM on TRD chamber
+    Int_t    fSM;                             //  Position of CURRENT half chamber in full TRD
+    Int_t    fLAYER;                          //  Position of CURRENT half chamber in full TRD
+    Int_t    fSTACK;                          //  Position of CURRENT half chamber in full TRD
+    Int_t    fROC;                            //  Position of CURRENT half chamber in full TRD
+    Int_t    fSIDE;                           //  Position of CURRENT half chamber in full TRD
+    Int_t    fDCS;                            //  DCS board number read from data (HC header)
+    Int_t    fROW;                            //  Detector Row coordinates
+    Int_t    fCOL;                            //  Detector Pad coordinates
+    Int_t    fDET;                            //  Current detector - version > 1
+    Int_t    fLastDET;                        //  Previous detector - version > 1
 
-    Int_t            fCount;        // counter of bytes to be read for current detector
+    Int_t    fBCctr;                          //  Counters from HC header (>=V2)
+    Int_t    fPTctr;                          //  Counters from HC header (>=V2)
+    Int_t    fPTphase;                        //  Counters from HC header (>=V2)
+    Int_t    fRVmajor;                        //  Raw version numbers and number of additional HC headerwords (>=V2)
+    Int_t    fRVminor;                        //  Raw version numbers and number of additional HC headerwords (>=V2)
+    Int_t    fHCHWords;                       //  Raw version numbers and number of additional HC headerwords (>=V2)
+    Int_t    fTBins;                          //  Number of time bins read from HC header (>=V2)
+    Bool_t   fTCon;                           //  Filter settings read from HC header (>=V2)
+    Bool_t   fPEDon;                          //  Filter settings read from HC header (>=V2)
+    Bool_t   fGAINon;                         //  Filter settings read from HC header (>=V2)
+    Bool_t   fXTon;                           //  Filter settings read from HC header (>=V2)
+    Bool_t   fNonLinOn;                       //  Filter settings read from HC header (>=V2)
+    Bool_t   fBypass;                         //  Filter settings read from HC header (>=V2)
+    Int_t    fCommonAdditive;                 //  Common baseline additive read from HC header (>=V2)
 
-    Int_t            fDetector;     // index of current detector
-    Int_t            fPrevDetector; // index of previous detector
-    Int_t            fNPads;        // number of active pads
-    Int_t            fRow;          // index of current pad row
-    Int_t            fPrevRow;      // index of previous pad row
-    Int_t            fColumn;       // index of current pad column
-    Int_t            fPrevColumn;   // index of previous pad column
-    Int_t            fTime;         // index of current time bin
-    Int_t            fSignal;       // signal in ADC counts
+    Bool_t   fZeroSuppressed;                 // Data is zero suppressed
 
-    ClassDef(AliTRDRawStream, 1)    // class for reading TRD raw digits
-};
+    Int_t    fHCHctr1;                        //  HC and MCM Header counter
+    Int_t    fHCHctr2;                        //  HC and MCM Header counter
+    Int_t    fMCMHctr1;                       //  HC and MCM Header counter
+    Int_t    fMCMHctr2;                       //  HC and MCM Header counter
+    Int_t    fGTUctr1;                        //  GTU LinkMask Counter
+    Int_t    fGTUctr2;                        //  GTU LinkMask Counter
+    Int_t    fHCdataCtr;                      //  Data Counter for half chamber
+
+    Float_t  fTracklPID;                      //  Tracklet parameters
+    Float_t  fTracklDefL;                     //  Tracklet parameters
+    Float_t  fTracklPadPos;                   //  Tracklet parameters
+    Int_t    fTracklPadRow;                   //  Tracklet parameters
+
+    UShort_t fGTUlinkMask[18][5];             //  Mask with active links
+
+    AliTRDRawStream(const AliTRDRawStream &stream);
+    AliTRDRawStream &operator=(const AliTRDRawStream &stream);
+
+    AliRawReader *fRawReader;              //  Object for reading the raw data
 
+    Int_t    fRawVersion;                  //  Which version of raw data decoding is used
+
+    Int_t    fNextStatus;                  //  Navigation in raw versions > 1
+    UInt_t   fTbSwitch;                    //  Time Bin Switch for internal use
+    UInt_t   fTbSwitchCtr;                 //  Counter for internal use
+    UInt_t   fTimeWords;                   //  Number of Words needed to store the data of 1 ADC ch.
+    UInt_t   fWordCtr;                     //  Word Counter
+
+    Int_t    fRowMax;                      //  Maximum number of pad rows and columns
+    Int_t    fColMax;                      //  Maximum number of pad rows and columns
+
+    Bool_t   fADCmask[21];                 //  Mask of active ADCs for zero suppression
+    UShort_t fChamberDone[540];            //  Chamber was processed already (1=1HC, 2=full chamber)
+
+    Int_t    fRetVal;                      //  Datadecode return
+    Int_t    fEqID;                        //  Equipment id
+    UInt_t   fDataSize;                    //  Size of the data available in the current buffer
+    Bool_t   fSizeOK;                      //  Did we read anything
+    UInt_t   fCountBytes;                  //  Bytes traversed in the buffer
+    UInt_t   fBufSize;                     //  Size of the current RawReader buffer
+    Bool_t   fkBufferSet;                  //  Is the RawReader buffer available
+    UChar_t *fPos;                         //  Position in the buffer of the RawReader
+    UInt_t  *fDataWord;                    //  The pointer to the current 32 bit data word
+    UInt_t   fTimeBinsCalib;               //  N of time bins retrieved from calibration
+
+    enum ETRDzRawStreamError {
+       kHCWordMissing = 1                  //
+      ,kMCMADCMaskMissing = 2              //
+      ,kWrongMCMorROB = 3                  //
+      ,kGTULinkMaskMissing = 4             //
+      ,kHCHeaderCorrupt = 5                //
+      ,kHCHeaderMissing = 6                //
+      ,kROBSideMismatch = 7                //
+      ,kWrongPadrow = 8                    //
+      ,kWrongPadcolumn = 9                 //
+      ,kTrackletRowMismatch = 10           //
+      ,kDataMaskError = 11                 //
+      ,kADCNumberOverflow = 12             //
+      ,kADCChannelOverflow = 13            //
+    };
+
+ protected:
+
+    AliTRDgeometry *fGeo;                  //  TRD geometry
+
+    void  DecodeHCheader(Int_t timeBins);
+    void  DecodeMCMheader();
+    void  DecodeTracklet();
+    void  DecodeGTUlinkMask();
+    Int_t DecodeDataWord();
+    Int_t DecodeDataWordV1V2();                // Valid for fRawversion = 1, 2, ... 
+    Int_t DecodeDataWordV3();                  // Valid for fRawversion = 3, ... 
+
+    Int_t NextData(); // get the next piece of memory
+
+    enum { fkStart, fkStop, fkWordOK, fkNoMoreData, fkNextSM, fkNextHC, fkSeekNonEoTracklet, fkDecodeHC, fkNextMCM, fkNextData, fkReading};
+    
+    ClassDef(AliTRDRawStream, 5)               // Class for reading TRD raw digits
+
+};
 #endif