FSUDAQ/ClassData.h

#ifndef DATA_H
#define DATA_H

#include <stdio.h>
#include <string>
#include <sstream>
#include <cmath>
#include <cstring>  ///memset
#include <iostream> ///cout
#include <bitset>
#include <vector>

#include "CAENDigitizerType.h"
#include "macro.h"

#define MaxNData 10000 /// for timestamp 8 byte = 80kB

class Data{

  public:
  
    int DPPType; 
    unsigned int nByte;               /// number of byte
    char *buffer;                     /// readout buffer
    uint32_t AllocatedSize;
    uint32_t BufferSize;
    
    unsigned short NumEvents[MaxNChannels];
    unsigned long TotNumEvents[MaxNChannels];
    unsigned long long Timestamp[MaxNChannels][MaxNData];
    unsigned short Energy[MaxNChannels][MaxNData];
    unsigned short Energy2[MaxNChannels][MaxNData];  /// in PSD, Energy = Qshort, Energy2 = Qlong
    
    std::vector<unsigned short> Waveform1[MaxNChannels][MaxNData];
    std::vector<unsigned short> Waveform2[MaxNChannels][MaxNData];
    std::vector<bool> DigiWaveform1[MaxNChannels][MaxNData];
    std::vector<bool> DigiWaveform2[MaxNChannels][MaxNData];
    
    ///CAEN_DGTZ_DPP_PHA_Event_t       *Events[MaxNChannels];   /// events buffer
    ///CAEN_DGTZ_DPP_PHA_Waveforms_t   *Waveform[MaxNChannels]; /// waveforms buffer
    
  public:
    Data();
    ~Data();
  
    void AllocateMemory();
    void FreeMemory();
    
    void SetSaveWaveformToMemory(bool OnOff) { this->SaveWaveformToMemory = OnOff; }
    
    void ClearData();
    
    void SaveBuffer(const char * fileName);
    
    void PrintBuffer(); //Incorrect
    void DecodeBuffer(int verbose = 0);
    void DecodeBuffer(char * buffer, int verbose = 0); // for outside data
    
    void PrintStat();
  
  protected:
    
    unsigned int nw;
    bool SaveWaveformToMemory;
    
    ///for temperary
    std::vector<unsigned short> tempWaveform1; 
    std::vector<unsigned short> tempWaveform2; 
    std::vector<bool> tempDigiWaveform1;
    std::vector<bool> tempDigiWaveform2;
  
    unsigned int ReadBuffer(unsigned int nWord, int verbose = 0);

    int DecodePHADualChannelBlock(unsigned int ChannelMask, int verbose);
    int DecodePSDDualChannelBlock(unsigned int ChannelMask, int verbose);
    
};

//==========================================

inline Data::Data(){
  
  buffer = NULL;
  for ( int i = 0; i < MaxNChannels; i++) TotNumEvents[i] = 0;
  ClearData();
  SaveWaveformToMemory = false;
  nw = 0;
}

inline Data::~Data(){
  FreeMemory();
  ///if( buffer != NULL ) delete buffer;
  ///for( int i = 0 ; i < MaxNChannels; i++){  
  ///  delete Events [i];
  ///  delete Waveform [i];
  ///}
}

inline void Data::AllocateMemory(){
  
  BufferSize = 1000000; /// 1M byte
  buffer = (char *) malloc( BufferSize); 
  printf("Allocated %d byte for buffer \n", BufferSize);
  ///for( int i = 0 ; i < MaxNChannels ; i++ ) Events[i] = (CAEN_DGTZ_DPP_PHA_Event_t *) malloc( BufferSize);
  ///printf("Allocated %d byte for Events for each channel \n", BufferSize);
}


inline void Data::FreeMemory(){
  printf("======= Free memory\n");
  //if( buffer != NULL ) delete buffer;
}

inline void Data::ClearData(){
  
  nByte = 0;
  AllocatedSize = 0;
  BufferSize = 0;
  
  for( int i = 0 ; i < MaxNChannels; i++){
    NumEvents[i] = 0;
    for( int j = 0; j < MaxNData; j++){
      Timestamp[i][j] = 0;
      Energy[i][j] = 0;
      Energy2[i][j] = 0;
      Waveform1[i][j].clear();
      Waveform2[i][j].clear();
      DigiWaveform1[i][j].clear();
      DigiWaveform2[i][j].clear();
    }
  }
  
  tempWaveform1.clear();
  tempWaveform2.clear();
  tempDigiWaveform1.clear();
  tempDigiWaveform2.clear();
}


inline unsigned int Data::ReadBuffer(unsigned int nWord, int verbose){
  if( buffer == NULL ) return 0;
  
  unsigned int word = 0;
  for( int i = 0 ; i < 4 ; i++) word += ((buffer[i + 4 * nWord] & 0xFF) << 8*i);
  if( verbose >= 2) printf("%d | 0x%08x\n", nWord, word);
  return word;
}

inline void Data::SaveBuffer(const char * fileName){
  FILE * haha = fopen(fileName, "a+");
  fwrite(buffer, nByte, 1, haha);
  fclose(haha);
}

inline void Data::PrintStat(){
  
  for(int i = 0; i < MaxNChannels; i++){
    printf("%2d | %6d | %6lu\n", i, NumEvents[i], TotNumEvents[i]);
  }
  
}

inline void Data::PrintBuffer(){
  
  unsigned int length = sizeof(buffer);
  
  for( int i = 0; i < length; i++){
    printf("%3d | 0x%08x \n", i, buffer[i]);
  }
  
}

inline void Data::DecodeBuffer(char * buffer, int verbose){
  this->buffer = buffer;
  DecodeBuffer(verbose);
}

inline void Data::DecodeBuffer(int verbose){
  /// verbose : 0 = off, 1 = only energy + timestamp, 2 = show header, 3 = wave 
  
  if( buffer == NULL ) {
    if( verbose >= 1 ) printf(" buffer is empty \n");
    return;
  } 

  if( nByte == 0 ) {
    return;
  } 

  nw = 0;
  
  do{
    if( verbose >= 2 ) printf("######################################### Board Agg.\n");
    unsigned int word = ReadBuffer(nw, verbose);
    if( ( (word >> 28) & 0xF ) == 0xA ) { /// start of Board Agg
      unsigned int nWord = word & 0x0FFFFFFF ;
      if( verbose >= 2 ) printf(" number of words in this Agg : %d \n", nWord);
      
      nw = nw + 1; word = ReadBuffer(nw, verbose);
      unsigned int BoardID = ((word >> 27) & 0x1F);
      bool BoardFailFlag =  ((word >> 26) & 0x1 );
      unsigned int ChannelMask = ( word & 0xFF ) ;
      if( verbose >= 2 ) printf("Board ID : %d, FailFlag = %d, ChannelMask = 0x%x\n", BoardID, BoardFailFlag, ChannelMask);
      
      nw = nw + 2; 
      unsigned int AggCounter = ReadBuffer(nw, verbose);
      if( verbose >= 2 ) printf("Agg Counter : %d \n", AggCounter);
      
      for( int chMask = 0; chMask < MaxNChannels/2 ; chMask ++ ){
        if( ((ChannelMask >> chMask) & 0x1 ) == 0 ) continue;
        if( verbose >= 2 ) printf("---------------------- Dual Channel Block : %d, nw : %d\n", chMask *2, nw);

        if( DPPType == V1730_DPP_PHA_CODE ) {
          if ( DecodePHADualChannelBlock(chMask, verbose) < 0 ) break;
        }
        if( DPPType == V1730_DPP_PSD_CODE ) {
          if ( DecodePHADualChannelBlock(chMask, verbose) < 0 ) break;
        }
      }
    }else{
      if( verbose >= 2 ) printf("incorrect buffer header. \n");
      break;
    }
    nw++;
  }while(true);
}

inline int Data::DecodePHADualChannelBlock(unsigned int ChannelMask, int verbose){
  
  nw = nw + 1; 
  unsigned int word = ReadBuffer(nw, verbose);

  bool hasFormatInfo = ((word >> 31) & 0x1);
  unsigned int aggSize = ( word & 0x7FFFFFFF ) ;
  if( verbose >= 2 ) printf(" size : %d \n",  aggSize);
  unsigned int nSample = 0; /// wave form;
  unsigned int nEvents = 0;
  unsigned int extra2Option = 0;
  bool hasDualTrace = 0 ;
  if( hasFormatInfo ){
    nw = nw + 1; word = ReadBuffer(nw, verbose);
    
    nSample = ( word & 0xFFFF )  * 8;
    extra2Option = ( (word >> 24 ) & 0x7 );
    
    unsigned int digitalProbe = ( (word >> 16 ) & 0xF );
    unsigned int analogProbe2 = ( (word >> 20 ) & 0x3 );
    unsigned int analogProbe1 = ( (word >> 22 ) & 0x3 );
    bool hasWaveForm  = ( (word >> 27 ) & 0x1 );
    bool hasExtra2    = ( (word >> 28 ) & 0x1 );
    bool hasTimeStamp = ( (word >> 29 ) & 0x1 );
    bool hasEnergy    = ( (word >> 30 ) & 0x1 );
    hasDualTrace = ( (word >> 31 ) & 0x1 );
    
    if( verbose >= 2 ) {
      printf("dualTrace : %d, Energy : %d, Time: %d, Wave : %d, Extra2: %d \n", 
                              hasDualTrace, hasEnergy, hasTimeStamp, hasWaveForm, hasExtra2);
      if( hasExtra2 ){
        printf("...... extra 2 : ");
        switch (extra2Option){
          case 0: printf("[0:15] trapwzoid baseline * 4 [16:31] Extended timestamp (16-bit)\n"); break;
          case 1: printf("Reserved\n"); break;
          case 2: printf("[0:9] Fine time stamp [10:15] Reserved [16:31] Extended timestamp (16-bit)\n"); break;
          case 3: printf("Reserved\n"); break;
          case 4: printf("[0:15] Total trigger counter [16:31] Lost trigger counter\n"); break;
          case 5: printf("[0:15] Event after Zero crossing [16:31] Event before Zero crossing\n"); break;
          case 6: printf("Reserved\n"); break;
          case 7: printf("Reserved\n"); break;
        }
      }
      printf("...... Analog Probe 1 : ");
      switch (analogProbe1 ){
        case 0 : printf("Input \n"); break;
        case 1 : printf("RC-CR (1st derivative) \n"); break;
        case 2 : printf("RC-CR2 (2st derivative) \n"); break;
        case 3 : printf("trapazoid \n"); break;
      }
      printf("...... Analog Probe 2 : ");
      switch (analogProbe2 ){
        case 0 : printf("Input \n"); break;
        case 1 : printf("Theshold \n"); break;
        case 2 : printf("trapezoid - baseline \n"); break;
        case 3 : printf("baseline \n"); break;
      }
      printf("...... Digital Probe : ");
      switch (digitalProbe ){
        case  0 : printf("Peaking \n"); break;
        case  1 : printf("Armed (trigger) \n"); break;
        case  2 : printf("Peak Run \n"); break;
        case  3 : printf("Pile up \n"); break;
        case  4 : printf("Peaking \n"); break;
        case  5 : printf("Trigger Validation Window \n"); break;
        case  6 : printf("Baseline for energy calculation \n"); break;
        case  7 : printf("Trigger holdoff \n"); break;
        case  8 : printf("Trigger Validation \n"); break;
        case  9 : printf("ACQ Busy \n"); break;
        case 10 : printf("Trigger window \n"); break;
        case 11 : printf("Ext. Trigger \n"); break;
        case 12 : printf("Busy = memory is full \n"); break;
      }
    }
    nEvents = aggSize / (nSample/2 + 2 + hasExtra2 );
    if( verbose >= 2 ) printf("=========== nEvents : %d \n", nEvents);
  }else{
    if( verbose >= 2 ) printf("does not has format info. unable to read buffer.\n");
    return 0;
  }
  
  ///========== decode an event
  for( int ev = 0; ev < nEvents ; ev++){
    if( verbose >= 2 ) printf("=================================== event : %d\n", ev);
    nw = nw +1 ; word = ReadBuffer(nw, verbose);
    bool channelTag = ((word >> 31) & 0x1);
    unsigned int timeStamp0 = (word & 0x7FFFFFFF);
    int channel = ChannelMask*2 + channelTag;
    if( verbose >= 2 ) printf("ch : %d, timeStamp0 %u \n", channel, timeStamp0);
    
    //TODO Skip
    ///===== read waveform
    if( SaveWaveformToMemory ) {
      tempWaveform1.clear();
      tempWaveform2.clear();
      tempDigiWaveform1.clear();
    }
    
    unsigned int triggerAtSample = 0 ;
    for( int wi = 0; wi < nSample/2; wi++){
      nw = nw +1 ; word = ReadBuffer(nw, verbose - 2);
      bool isTrigger1 = (( word >> 31 ) & 0x1 );
      bool dp1 = (( word >> 30 ) & 0x1 );
      unsigned short wave1 = (( word >> 16) & 0x3FFF);
      
      bool isTrigger0 = (( word >> 15 ) & 0x1 );
      bool dp0 = (( word >> 14 ) & 0x1 );
      unsigned short wave0 = ( word & 0x3FFF);

      if( SaveWaveformToMemory){
        if( hasDualTrace ){
          tempWaveform1.push_back(wave0);
          tempWaveform2.push_back(wave1);
        }else{
          tempWaveform1.push_back(wave0);          
          tempWaveform1.push_back(wave1);          
        }
        tempDigiWaveform1.push_back(dp0);
        tempDigiWaveform1.push_back(dp1);
      }

      if( isTrigger0 == 1 ) triggerAtSample = 2*wi ;      
      if( isTrigger1 == 1 ) triggerAtSample = 2*wi + 1;
      
      if( verbose >= 3 && ev == 0 ){
        printf("%4d| %5d, %d, %d \n",   2*wi, wave0, dp0, isTrigger0);
        printf("%4d| %5d, %d, %d \n", 2*wi+1, wave1, dp1, isTrigger1);
      }
    }
    
    if( SaveWaveformToMemory ) {
      if( hasDualTrace ){
        Waveform1[channel][NumEvents[channel]] = tempWaveform1;
        Waveform2[channel][NumEvents[channel]] = tempWaveform2;
      }else{
        Waveform1[channel][NumEvents[channel]] = tempWaveform1;
      }
      DigiWaveform1[channel][NumEvents[channel]] = tempDigiWaveform1;
    }
    
    nw = nw +1 ; word = ReadBuffer(nw, verbose);
    unsigned int extra2 = word;
    unsigned long long extTimeStamp = 0;
    if( extra2Option == 0 || extra2Option == 2 ) extTimeStamp = (extra2 >> 15);
    
    unsigned long long timeStamp = (extTimeStamp << 30) ;
    timeStamp = timeStamp + timeStamp0;
    
    nw = nw +1 ; word = ReadBuffer(nw, verbose);
    unsigned int extra = (( word >> 16) & 0x3FF);
    unsigned int energy = (word & 0x7FFF);
    bool pileUpOrRollOver = ((word >> 15) & 0x1);
    bool pileUp   = (extra & 0x200);
    bool rollOver = (extra & 0x002);
    
    if( verbose >= 2 ) {
      printf("PileUp : %d , extra : 0x%03x, energy : %d \n", pileUp, extra, energy);
      
      printf("     lost event : %d \n", ((extra >>  0) & 0x1) );
      printf("      roll-over : %d (fake event)\n", ((extra >>  1) & 0x1) );
      printf("     fake-event : %d \n", ((extra >>  3) & 0x1) );
      printf("     input sat. : %d \n", ((extra >>  4) & 0x1) );
      printf("       lost trg : %d \n", ((extra >>  5) & 0x1) );
      printf("        tot trg : %d \n", ((extra >>  6) & 0x1) );
      printf("     coincident : %d \n", ((extra >>  7) & 0x1) );
      printf("      not coin. : %d \n", ((extra >>  8) & 0x1) );
      printf("        pile-up : %d \n", ((extra >>  9) & 0x1) );
      printf(" trapezoid sat. : %d \n", ((extra >> 10) & 0x1) );

    }
    
    if( rollOver == 0 ) {
      NumEvents[channel] ++; 
      TotNumEvents[channel] ++;
    }
    
    if( verbose >= 1 ) printf("%4d | ch : %2d, PileUp : %d , energy : %d, roll-Over: %d,  timestamp : %llu, triggerAt : %d, nSample : %d, %f\n", 
                                NumEvents[channel], channel, pileUp, energy, rollOver, timeStamp, triggerAtSample, nSample , timeStamp * 4. / 1e9);
    
    Energy[channel][NumEvents[channel]] = energy;
    Timestamp[channel][NumEvents[channel]] = timeStamp;
    
  }
  
  ///=========== Key information
  /// ch, energy, timestamp
  /// trace
  
  
  return nw;
}

inline int Data::DecodePSDDualChannelBlock(unsigned int ChannelMask, int verbose){
  
  nw = nw + 1; 
  unsigned int word = ReadBuffer(nw, verbose);
  
  if( (word >> 31) != 1 ) return 0;
  
  unsigned int aggSize = ( word & 0x3FFFFF ) ;
  if( verbose >= 2 ) printf(" size : %d \n",  aggSize);

  unsigned int nEvents = 0;
  nw = nw + 1; word = ReadBuffer(nw, verbose);
  unsigned int nSample = ( word & 0xFFFF )  * 8;
  unsigned int digitalProbe1 = ( (word >> 16 ) & 0x7 );
  unsigned int digitalProbe2 = ( (word >> 19 ) & 0x7 );
  unsigned int analogProbe = ( (word >> 22 ) & 0x3 );
  unsigned int extraOption = ( (word >> 24 ) & 0x7 );
  bool hasWaveForm  = ( (word >> 27 ) & 0x1 );
  bool hasExtra     = ( (word >> 28 ) & 0x1 );
  bool hasTimeStamp = ( (word >> 29 ) & 0x1 );
  bool hasCharge    = ( (word >> 30 ) & 0x1 );
  bool hasDualTrace = ( (word >> 31 ) & 0x1 );
  
  if( verbose >= 2 ) {
    printf("dualTrace : %d, Charge : %d, Time: %d, Wave : %d, Extra: %d\n", 
                            hasDualTrace, hasCharge, hasTimeStamp, hasWaveForm, hasExtra);
    if( hasExtra ){
      printf(".... extra : ");
      switch(extraOption){
        case 0: printf("[0:15] trapwzoid baseline * 4 [16:31] Extended timestamp (16-bit)\n"); break;
        case 1: printf("[0:11] reserved [12] lost trigger counted [13] 1024 trigger counted [14] Over-range\n");
                printf("[15] trigger lost [16:31] Extended timestamp (16-bit)\n"); break;
        case 2: printf("[0:9] Fine time stamp [10:15] flag [10:15] Reserved [16:31] Extended timestamp (16-bit)\n"); break;
        case 3: printf("Reserved\n"); break;
        case 4: printf("[0:15] Total trigger counter [16:31] Lost trigger counter\n"); break;
        case 5: printf("[0:15] Event after Zero crossing [16:31] Event before Zero crossing\n"); break;
        case 6: printf("Reserved\n"); break;
        case 7: printf("debug, must be 0x12345678\n"); break;
      }
    }
    printf(".... digital Probe 1 : ");
    switch(digitalProbe1){
      case 0 : printf("Long gate \n"); break;
      case 1 : printf("Over threshold \n"); break;
      case 2 : printf("Shaped TRG \n"); break;
      case 3 : printf("TRG Val. Acceptance \n"); break;
      case 4 : printf("Pile-Up \n"); break;
      case 5 : printf("Coincidence \n"); break;
      case 6 : printf("Reserved \n"); break;
      case 7 : printf("Trigger \n"); break;
    }
    printf(".... digital Probe 2 : ");
    switch(digitalProbe2){
      case 0 : printf("Short gate \n"); break;
      case 1 : printf("Over threshold \n"); break;
      case 2 : printf("TRG Validation \n"); break;
      case 3 : printf("TRG HoldOff \n"); break;
      case 4 : printf("Pile-Up \n"); break;
      case 5 : printf("Coincidence \n"); break;
      case 6 : printf("Reserved \n"); break;
      case 7 : printf("Trigger \n"); break;
    }
    printf(".... analog Probe (dual trace : %d): ", hasDualTrace);
    if( hasDualTrace ) {
      switch(analogProbe){
        case 0 : printf("Input and baseline \n"); break;
        case 1 : printf("CFD and baseline \n"); break;
        case 2 : printf("Input and CFD \n"); break;
      }
    }else{
      switch(analogProbe){
        case 0 : printf("Input \n"); break;
        case 1 : printf("CFD \n"); break;
      }
    }
  }
  
  nEvents = aggSize / (nSample/2 + 2 + hasExtra );
  if( verbose >= 2 ) printf("=========== nEvents : %d \n", nEvents);

  ///========= Decode an event
  for( int ev = 0; ev < nEvents ; ev++){
    if( verbose >= 2 ) printf("=================================== event : %d\n", ev);
    nw = nw +1 ; word = ReadBuffer(nw, verbose);
    bool channelTag = ((word >> 31) & 0x1);
    unsigned int timeStamp0 = (word & 0x7FFFFFFF);
    int channel = ChannelMask*2 + channelTag;
    if( verbose >= 2 ) printf("ch : %d, timeStamp %u \n", channel, timeStamp0);
    
    ///===== read waveform
    if( SaveWaveformToMemory ) {
      tempWaveform1.clear();
      tempWaveform2.clear();
      tempDigiWaveform1.clear();
      tempDigiWaveform2.clear();
    }
    
    for( int wi = 0; wi < nSample/2; wi++){
      nw = nw +1 ; word = ReadBuffer(nw, verbose - 2);
      bool dp2b = (( word >> 31 ) & 0x1 );
      bool dp1b = (( word >> 30 ) & 0x1 );
      unsigned short waveb = (( word >> 16) & 0x3FFF);
      
      bool dp2a = (( word >> 15 ) & 0x1 );
      bool dp1a = (( word >> 14 ) & 0x1 );
      unsigned short wavea = ( word & 0x3FFF);
      
      if( SaveWaveformToMemory){
        if( hasDualTrace ){
          tempWaveform1.push_back(wavea);
          tempWaveform2.push_back(waveb);
        }else{
          tempWaveform1.push_back(wavea);          
          tempWaveform1.push_back(waveb);          
        }
        tempDigiWaveform1.push_back(dp1a);
        tempDigiWaveform1.push_back(dp1b);
        tempDigiWaveform2.push_back(dp2a);
        tempDigiWaveform2.push_back(dp2b);
      }
      
      if( verbose >= 3 && ev == 0 ){
        printf("%4d| %5d, %d, %d \n",   2*wi, wavea, dp1a, dp2a);
        printf("%4d| %5d, %d, %d \n", 2*wi+1, waveb, dp1b, dp2b);
      }
    }
    
    if( SaveWaveformToMemory ) {
      if( hasDualTrace ){
        Waveform1[channel][NumEvents[channel]] = tempWaveform1;
        Waveform2[channel][NumEvents[channel]] = tempWaveform2;
      }else{
        Waveform1[channel][NumEvents[channel]] = tempWaveform1;
      }
      DigiWaveform1[channel][NumEvents[channel]] = tempDigiWaveform1;
      DigiWaveform2[channel][NumEvents[channel]] = tempDigiWaveform2;
    }
    
    nw = nw +1 ; word = ReadBuffer(nw, verbose);
    unsigned int extra = word;
    unsigned long long extTimeStamp = 0;
    if( extraOption == 0 || extraOption == 2 ) extTimeStamp = (extra >> 15);
    
    unsigned long long timeStamp = (extTimeStamp << 30) ;
    timeStamp = timeStamp + timeStamp0;
    
    nw = nw +1 ; word = ReadBuffer(nw, verbose);
    unsigned int Qlong  = (( word >> 16) & 0xFFFF);
    unsigned int Qshort = (word & 0x7FFF);
    bool isEnergyCorrect = ((word >> 15) & 0x1);
    
    if( isEnergyCorrect == 1 ) {
      NumEvents[channel] ++; 
      TotNumEvents[channel] ++;
    }
    
    if( verbose >= 2 ) printf("extra : 0x%08x, Qshort : %d, Qlong : %d \n", extra, Qshort, Qlong);
    
    if( verbose >= 1 ) printf("ch : %2d, Qshort : %d, Qlong : %d, timestamp : %llu\n", 
                                channel, Qshort, Qlong, timeStamp);
    
    Timestamp[channel][NumEvents[channel]] = timeStamp;
    
  }
  
  ///=========== Key information
  /// ch, Qshort, Qlong , timestamp
  /// trace

  return nw;
}

#endif