ZDC/AliZDCRawStream.h

   1 #ifndef ALIZDCRAWSTREAM_H
   2 #define ALIZDCRAWSTREAM_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 //  Class to provide access to ZDC raw data     //
  11 //  Author: Chiara Oppedisano                   //
  12 //                                              //
  13 //////////////////////////////////////////////////
  14
  15 #include <TObject.h>
  16 #include "AliCDBManager.h"
  17 #include "AliCDBStorage.h"
  18 #include "AliZDCChMap.h"
  19
  20 class AliRawReader;
  21 class AliRawDataHeader;
  22
  23
  24 class AliZDCRawStream: public TObject {
  25   public :
  26
  27     // Module type codes
  28     enum{kV965=1, kV830=2, kTRG=3, kTRGI=4, kPU=5};
  29
  30     // Signal codes for ZDC
  31     // Same codes used in DAQ configuration file
  32     // To be changed ONLY IF this file is changed!!!
  33     // **** DO NOT CHANGE THE FOLLOWING LINES!!! ****
  34     enum ZDCSignal{kNotConnected=0, kVoid=1,
  35          kZNAC=2, kZNA1=3, kZNA2=4, kZNA3=5, kZNA4=6,
  36          kZPAC=7, kZPA1=8, kZPA2=9, kZPA3=10, kZPA4=11,
  37          kZNCC=12, kZNC1=13, kZNC2=14, kZNC3=15, kZNC4=16,
  38          kZPCC=17, kZPC1=18, kZPC2=19, kZPC3=20, kZPC4=21,
  39          kZEM1=22, kZEM2=23,
  40          kZDCAMon=24, kZDCCMon=25,
  41          kZNACoot=26, kZNA1oot=27, kZNA2oot=28, kZNA3oot=29, kZNA4oot=30,
  42          kZPACoot=31, kZPA1oot=32, kZPA2oot=33, kZPA3oot=34, kZPA4oot=35,
  43          kZNCCoot=36, kZNC1oot=37, kZNC2oot=38, kZNC3oot=39, kZNC4oot=40,
  44          kZPCCoot=41, kZPC1oot=42, kZPC2oot=43, kZPC3oot=44, kZPC4oot=45,
  45          kZEM1oot=46, kZEM2oot=47,
  46          kZDCAMonoot=48, kZDCCMonoot=49,
  47          kL1MBI=50, kL1CNI=51, kL1SCI=52, kL1EMDI=53, kL0I=54,
  48          kL1MBO=55, kL1CNO=56, kL1SCO=57, kL1EMDO=58,
  49          kHMBCN=59, kHSCEMD=60,
  50          kZNACD=61, kZNA1CD=62, kZNA2D=63, kZNA3D=64, kZNA4D=65,
  51          kZPACD=66, kZPA1CD=67, kZPA2D=68, kZPA3D=69, kZPA4D=70,
  52          kZNCCD=71, kZNC1CD=72, kZNC2D=73, kZNC3D=74, kZNC4D=75,
  53          kZPCCD=76, kZPC1CD=77, kZPC2D=78, kZPC3D=79, kZPC4D=80,
  54          kZEM1D=81, kZEM2D=82,
  55          kZDCAMonD=83, kZDCCMonD=84,
  56          kZNAD=85, kZPAD=86, kZNCD=87, kZPCD=88, kZEMD=89,
  57          kLogical00=90, kLogical01=91, kLogical02=92, kLogical03=93, kLogical04=94,
  58          kLogical05=95, kLogical06=96, kLogical07=97, kLogical08=98, kLogical09=99,
  59          kLogical10=100, kLogical11=101, kLogical12=102, kLogical13=103, kLogical14=104,
  60          kLogical15=105, kLogical16=106, kLogical17=107, kLogical18=108, kLogical19=109,
  61          kLogical20=110, kLogical21=111, kLogical22=112, kLogical23=113, kLogical24=114,
  62          kLogical25=115, kLogical26=116, kLogical27=117, kLogical28=118, kLogical29=119,
  63          kLogical30=120, kLogical31=121};
  64
  65     // Error codes in raw data streaming
  66     enum EZDCRawStreamError{
  67        kCDHError = 1,
  68        kDARCError = 2,
  69        kZDCDataError = 3,
  70        kInvalidADCModule = 4,
  71        kInvalidSector = 5};
  72
  73     AliZDCRawStream(AliRawReader* rawReader);
  74     virtual ~AliZDCRawStream();
  75     virtual Bool_t   Next();
  76
  77     virtual void ReadChMap();
  78
  79     virtual void ReadCDHHeader();
  80
  81     Bool_t IsAddChannel() const {return fIsADDChannel;}
  82
  83     UInt_t GetRawBuffer()      const {return fBuffer;}
  84     Int_t  GetReadOutCard()    const {return fReadOutCard;}
  85
  86     Int_t  GetDeadfaceOffset() const {return fDeadfaceOffset;}
  87     Int_t  GetDeadbeefOffset() const {return fDeadbeefOffset;}
  88     Int_t  GetDataOffset()     const {return fDataOffset;}
  89
  90     Int_t  GetSector(Int_t i) const {return fSector[i];}
  91     Int_t  GetModType()       const {return fModType;}
  92     Int_t  GetADCModule()     const {return fADCModule;}
  93     Int_t  GetADCNChannels()  const {return fADCNChannels;}
  94     Int_t  GetADCChannel()    const {return fADCChannel;}
  95     Int_t  GetADCValue()      const {return fADCValue;}
  96     Int_t  GetADCGain()       const {return fADCGain;}
  97
  98     AliCDBStorage *SetStorage(const char* uri);
  99
 100     // Map from OCDB
 101     AliZDCChMap   *GetChMap() const;
 102     //  ADC map
 103     Int_t  GetNChannelsOn()            const {return fNChannelsOn;}
 104     Int_t  GetCabledSignal()           const {return fCabledSignal;}
 105     Int_t  GetADCModFromMap(Int_t i)   const {return fMapADC[i][0];}
 106     Int_t  GetADCChFromMap(Int_t i)    const {return fMapADC[i][1];}
 107     Int_t  GetADCSignFromMap(Int_t i)  const {return fMapADC[i][2];}
 108     Int_t  GetDetectorFromMap(Int_t i) const {return fMapADC[i][3];}
 109     Int_t  GetTowerFromMap(Int_t i)    const {return fMapADC[i][4];}
 110     //  Scaler map
 111     Int_t  GetScalerModFromMap(Int_t i)  const {return fScalerMap[i][0];}
 112     Int_t  GetScalerChFromMap(Int_t i)   const {return fScalerMap[i][1];}
 113     Int_t  GetScalerSignFromMap(Int_t i) const {return fScalerMap[i][2];}
 114     Int_t  GetScDetectorFromMap(Int_t i) const {return fScalerMap[i][3];}
 115     Int_t  GetScTowerFromMap(Int_t i)    const {return fScalerMap[i][4];}
 116
 117     Bool_t IsCalibration()   const {return fIsCalib;}
 118     Bool_t IsDARCHeader()    const {return fIsDARCHeader;}
 119     Bool_t IsHeaderMapping() const {return fIsHeaderMapping;}
 120     Bool_t IsChMapping()     const {return fIsChMapping;}
 121     Bool_t IsADCDataWord()   const {return fIsADCDataWord;}
 122     Bool_t IsADCHeader()     const {return fIsADCHeader;}
 123     Bool_t IsADCEOB()        const {return fIsADCEOB;}
 124     Bool_t IsUnderflow()     const {return fIsUnderflow;}
 125     Bool_t IsOverflow()      const {return fIsOverflow;}
 126
 127     UInt_t GetScGeo()           const {return fScGeo;}
 128     UInt_t GetScNWords()        const {return fScNWords;}
 129     UInt_t GetScTriggerSource() const {return fScTriggerSource;}
 130     UInt_t GetTriggerNumber()   const {return fScTriggerNumber;}
 131     UInt_t GetTriggerCount()    const {return fScEvCounter;}
 132     Bool_t IsScHeaderRead()     const {return fIsScHeaderRead;}
 133     Bool_t IsScEventGood()      const {return fIsScEventGood;}
 134     Bool_t IsScalerWord()       const {return fIsScalerWord;}
 135
 136     UInt_t GetDetectorPattern() const {return fDetPattern;}
 137
 138     Bool_t IstriggerHistoryWord() const {return fIsTriggerHistory;}
 139     Int_t  GetTriggerInput2CTP() const {return *fCPTInput;}
 140     Bool_t IsCPTInputMBTrigger()
 141         {if(fCPTInput[0]==1) return kTRUE; else return kFALSE;}
 142     Bool_t IsCPTInputCentralTrigger()
 143         {if(fCPTInput[1]==1) return kTRUE; else return kFALSE;}
 144     Bool_t IsCPTInputSemiCentralTrigger()
 145         {if(fCPTInput[2]==1) return kTRUE; else return kFALSE;}
 146     Bool_t IsCPTInputEMDTrigger()
 147         {if(fCPTInput[3]==1) return kTRUE; else return kFALSE;}
 148
 149     Bool_t IsADCEventGood() const {return fIsADCEventGood;}
 150     Bool_t IsL0BitSet()     const {return fIsL0BitSet;}
 151     Bool_t IsPileUpEvent()  const {return fIsPileUpEvent;}
 152
 153     void SetNChannelsOn(Int_t val) {fNChannelsOn = val;}
 154     void SetSector(Int_t i, Int_t val) {fSector[i] = val;}
 155     void SetMapADCMod(Int_t iraw, Int_t imod) {fMapADC[iraw][0]=imod;}
 156     void SetMapADCCh(Int_t iraw, Int_t ich)   {fMapADC[iraw][1]=ich;}
 157     void SetMapADCSig(Int_t iraw, Int_t isig) {fMapADC[iraw][2]=isig;}
 158     void SetMapDet(Int_t iraw, Int_t idet)    {fMapADC[iraw][3]=idet;}
 159     void SetMapTow(Int_t iraw, Int_t itow)    {fMapADC[iraw][4]=itow;}
 160
 161     void SetSODReading(Bool_t iset) {fSODReading = iset;}
 162
 163   private :
 164     AliZDCRawStream(const AliZDCRawStream& stream);
 165     AliZDCRawStream& operator = (const AliZDCRawStream& stream);
 166
 167     AliRawReader* fRawReader;    // object for reading the raw data
 168
 169     // Data for buffer decoding
 170     UInt_t fBuffer;           // [DARC header +] ADC buffer
 171     Int_t  fReadOutCard;      // 0 for DARC, 1 for ZRC
 172     UInt_t fEvType;           // Event type
 173     Int_t  fPosition;         // bit position in buffer data word
 174
 175     // Boolean variables indicating data type
 176     Bool_t fIsCalib;          // True when calibration run
 177     Bool_t fIsDARCHeader;     // True when DARC header
 178     Bool_t fIsHeaderMapping;  // True when reading header mapping
 179     Bool_t fIsChMapping;      // True when reading ch. mapping
 180     Bool_t fIsADCDataWord;    // True when data word
 181     Bool_t fIsADCHeader;      // True when ADC header
 182     Bool_t fIsADCEOB;         // True when EOB
 183     Bool_t fSODReading;       // True when reading SOD (DA)
 184     Bool_t fIsMapRead;        // True if map is already read
 185
 186     Int_t  fDeadfaceOffset;   // deadface offset
 187     Int_t  fDeadbeefOffset;   // deadbeef offset
 188     Int_t  fDataOffset;       // data offset
 189
 190     // ADC signal
 191     Int_t  fSector[2];    // [detector, sector]
 192     Int_t  fModType;      // Module type
 193     Int_t  fADCModule;    // ADC module = GEO address for scaler, trigger card, P.U.
 194     Int_t  fADCNChannels; // number of ADC ch.
 195     Int_t  fADCChannel;   // ADC channel = ch. for scaler, trigger card, P.U.
 196     Int_t  fADCValue;     // ADC channel
 197     Int_t  fADCGain;      // ADC gain (0=high range; 1=low range)
 198     Bool_t fIsUnderflow;  // ADC underflow
 199     Bool_t fIsOverflow;   // ADC overflow
 200
 201     // Scaler
 202     UInt_t fScGeo;           // scaler GEO address
 203     UInt_t fScNWords;        // no. of words in scaler event
 204     UInt_t fScTriggerSource; // Trigger source
 205     UInt_t fScTriggerNumber; // no. of triggers
 206     Bool_t fIsScEventGood;   // true if scaler event is good
 207     Bool_t fIsScHeaderRead;  // true if scaler header is read
 208     Int_t  fScStartCounter;  // position in the buffer where scaler data begins
 209     UInt_t fScEvCounter;     // event counter
 210     Bool_t fIsScalerWord;    // is scaler word (not header)
 211
 212     // Pattern Unit
 213     UInt_t fDetPattern;  // word from the pattern unit
 214
 215     // Trigger card
 216     // (1) trigger counts
 217     Int_t  fTrigCountNWords;  // no. of words to read from trigger card scalers
 218     Bool_t fIsTriggerScaler;  // Trigger card scalers - 1st word read
 219     Int_t  fTrigCountStart;   // Trigger card scalers - counter
 220     Int_t  fMBTrigInput;      // MB          trigger input to trigger card
 221     Int_t  fCentralTrigInput; // CENTRAL     trigger input to trigger card
 222     Int_t  fSCentralTrigInput;// SEMICENTRAL trigger input to trigger card
 223     Int_t  fEMDTrigInput;     // EMD         trigger input to trigger card
 224     Int_t  fL0Received;       // L0 received by the trigger card
 225     Int_t  fMBtrig2CTP;       // trigger input to the CTP for MB
 226     Int_t  fCentralTrig2CTP;  // trigger input to the CTP for CENTRAL
 227     Int_t  fSCentralTrig2CTP; // trigger input to the CTP for SEMICENTRAL
 228     Int_t  fEMDTrig2CTP;      // trigger input to the CTP for EMD
 229     // (2) trigger history
 230     Int_t  fTrigHistNWords;   // no. of words to read from trigger history data
 231     Bool_t fIsTriggerHistory; // Trigger history - 1st word read
 232     Int_t  fTrigHistStart;    // Trigger card history - counter
 233     Int_t  fPileUpBit1stWord; // Pile up bit from 1st word
 234     Int_t  fL0Bit1stWord;     // L0 bit from 1st word
 235     UInt_t fCentralTrigHist;  // history for CENTRAL trigger
 236     UInt_t fMBTrigHist;       // history for CENTRAL trigger
 237     Int_t  fPileUpBit2ndWord; // Pile up bit from 2nd word
 238     Int_t  fL0Bit2ndWord;     // L0 bit from 2nd word
 239     UInt_t fSCentralTrigHist; // history for SEMICENTRAL trigger
 240     UInt_t fEMDTrigHist;      // history for EMD trigger
 241     Int_t  fCPTInput[4];      // Trigger sent to the CTP
 242
 243     // Channel mapping
 244     Int_t fNChannelsOn;      // No. of signals/ADC ch. used
 245     Int_t fCurrentCh;        // current mapped ADC ch.
 246     Int_t fCabledSignal;     // physics signal (from enum)
 247     Int_t fMapADC[48][5];    // ADC map {ADC mod., ch., signal, det., sec.}
 248     Int_t fCurrScCh;         // current mapped scaler ch.
 249     Int_t fScalerMap[32][5]; // Scaler map {Scaler mod., ch., signal, det., sec.}
 250
 251     // Checks over raw data event quality
 252     Bool_t fIsADCEventGood; // true if not valid datum not corrupted
 253     Bool_t fIsL0BitSet;     // true if L0 bit in history words = 1
 254     Bool_t fIsPileUpEvent;  // true if pile up bits in history words = 0
 255
 256     // ADD part
 257     Bool_t fIsADDChannel;   // true if datum is an ADD ADC channel
 258
 259     ClassDef(AliZDCRawStream, 17)    // class for reading ZDC raw data
 260 };
 261
 262 #endif