UCTCTP7RawData5BX.h

Go to the documentation of this file.

#ifndef UCTCTP7RawData5BX_hh
#define UCTCTP7RawData5BX_hh

#include "FWCore/MessageLogger/interface/MessageLogger.h"
#include "FWCore/MessageLogger/interface/MessageDrop.h"

class UCTCTP7RawData5BX {
public:
  enum CaloType { EBEE = 0, HBHE, HF };

  // read-only constructor
  UCTCTP7RawData5BX(const uint32_t* d) : myDataPtr(d) {
    if (myDataPtr == nullptr) {
      edm::LogError("UCTCTP7RawData5BX") << "You gave me a nullptr :<";
    }
  }
  // read-write constructor, caller must allocate 192*5*sizeof(uint32_t) bytes
  UCTCTP7RawData5BX(uint32_t* d) : myDataPtr(d), myDataWritePtr(d) {
    if (myDataPtr == nullptr) {
      edm::LogError("UCTCTP7RawData5BX") << "You gave me a nullptr :<";
    }
  }

  // No copy constructor and equality operator are needed
  UCTCTP7RawData5BX(const UCTCTP7RawData5BX&) = delete;
  const UCTCTP7RawData5BX& operator=(const UCTCTP7RawData5BX& i) = delete;

  virtual ~UCTCTP7RawData5BX() { ; }

  // Access functions for convenience

  const uint32_t* dataPtr() const { return myDataPtr; }

  uint32_t sof() { return myDataPtr[0]; }

  size_t getIndex(CaloType cType, bool negativeEta, uint32_t cEta, uint32_t iPhi, uint32_t BX_n) {
    size_t index = 0;
    if (cType == EBEE || cType == HBHE) {
      if (iPhi > 3) {
        edm::LogError("UCTCTP7RawData5BX") << "Incorrect iPhi; iPhi = " << iPhi << "; should be in [0,3]";
        return index;
      }
      if (cEta < 1 || cEta > 28) {
        edm::LogError("UCTCTP7RawData5BX") << "Incorrect caloEta; cEta = " << cEta << "; should be in [1-28]";
        return index;
      }
      // ECAL/HB+HE fragment size is 3 32-bit words
      // Each fragment covers 2 eta and 4 phi towers
      // All four phi towers are in one 32-bit word
      // Even and odd eta are in neighboring 32-bit words
      // Now each fragment contains 5 BX instead of just 1
      // Here BX_n = 0, 1, 2, 3, 4, where 2 is nominal
      index = (((cEta - 1) / 2) * (3 + 3) * 5 + ((cEta - 1) % 2)) + 3 * BX_n;
      // But, towers are arranged in a peculiar order for firmware
      // convenience - the index needs to be computing with these
      // if statements.  This is brittle code that one should be
      // very careful with.
      if (negativeEta) {
        // Add offset for 6 ECAL and 6 HCAL fragments
        index += (6 * (3 + 3)) * 5;
      } else {
        if (cEta > 12) {
          // Add offset for 14 ECAL, 14 HB+HE and 2 HF fragments
          // Note that first six are included in the definition of
          // the variable - index
          // Note also that HF fragments are larger at 4 32-bit words
          index += ((14 * (3 + 3) + (2 * 4))) * 5;
        }
      }
      // Data starts with ECAL towers so offset by 3 additional 32-bit words
      if (cType == HBHE)
        index += 3 * 5;
    } else if (cType == HF) {
      if (iPhi > 1) {
        edm::LogError("UCTCTP7RawData5BX") << "HF iPhi should be 0 or 1 (for a , b) - invalid iPhi  = " << iPhi;
        return index;
      }
      if (cEta < 30 || cEta > 41) {
        edm::LogError("UCTCTP7RawData5BX") << "HF cEta should be between 30 and 41 - invalid cEta = " << cEta;
        return index;
      }
      if (negativeEta) {
        if (iPhi == 0) {
          // Offset by 6 positive eta and 14 negative eta EBEE/HBHE fragments (each 3 32-bit words)
          // There are four HF cEta towers packed in each 32-bit word
          // Add additional offset of 1 for (34-37) and 2 for (38-41)
          index = 20 * (3 + 3) * 5 + ((cEta - 30) / 4) + 4 * BX_n;
        } else {
          // Additional HF a fragment offset for HF b channel
          index = 20 * (3 + 3) * 5 + 1 * 4 * 5 + ((cEta - 30) / 4) + 4 * BX_n;
        }
      } else {
        if (iPhi == 0) {
          // Offset by all EBEE/HBHE and two HF fragments (4 32-bit words)
          index = 2 * 14 * (3 + 3) * 5 + 2 * 4 * 5 + ((cEta - 30) / 4) + 4 * BX_n;
        } else {
          // Additional HF a fragment offset for HF b channel
          index = 2 * 14 * (3 + 3) * 5 + 3 * 4 * 5 + ((cEta - 30) / 4) + 4 * BX_n;
        }
      }
    } else {
      edm::LogError("UCTCTP7RawData5BX") << "Unknown CaloType " << cType;
      return index;
    }
    if (index >= 192 * 5) {
      edm::LogError("UCTCTP7RawData5BX") << "Managed to calculate an out-of-bounds index, buyer beware";
    }
    return index;
  }

  size_t getFeatureIndex(CaloType cType, bool negativeEta, uint32_t cEta, uint32_t iPhi, uint32_t BX_n) {
    // Get index into the data words for the tower
    size_t index = getIndex(cType, negativeEta, cEta, iPhi, BX_n);
    if (cType == EBEE || cType == HBHE) {
      // Two 32-bit words contain ET, so we should offset the index to
      // to the feature and link status bits
      if (((cEta - 1) % 2) == 0) {
        // [index] is offset to ET of first four towers (0 - 3)
        // [index + 2] is where the feature and link status bits are
        index += 2;
      } else {
        // In this case [index] is offset to ET of second four towers (4 - 7)
        // [index + 1] is where the feature and link status bits are
        index += 1;
      }
    } else if (cType == HF) {
      // HF Fragment has different structure than EBEE and HBHE fragments
      // First three 32-bit words have ETs for 11 objects (yes, 11 not 12)
      // cEta = 40 / 41 are double in eta and flop bettween a and b HF fragments
      // Further the remaining upper byte of the third word actually has feature
      // bits.  This feature index will point to the 4th 32-bit word.  It is
      // expected that the top byte from 3rd 32-bit word will be patched in within
      // the feature bit access function.
      // Since there are three instead of if block as above for EBEE, HBHE
      // I wrote here a more compact implementation of index computation.
      index += (3 - ((cEta - 30) / 4));
      if (index == 0) {
        // Since we sticth index-1, zero is also illegal
        edm::LogError("UCTCTP7RawData5BX") << "Managed to calculate an out-of-bounds index, buyer beware";
      }
    } else {
      // Unknown calotype error already generated in getIndex()
      return 0;
    }
    if (index >= 192 * 5) {
      edm::LogError("UCTCTP7RawData5BX") << "Managed to calculate an out-of-bounds index, buyer beware";
    }
    return index;
  }

  void setET(CaloType cType, bool negativeEta, uint32_t cEta, uint32_t iPhi, uint32_t et, uint32_t BX_n) {
    if (myDataWritePtr == nullptr) {
      edm::LogError("UCTCTP7RawData5BX") << "I was made in read-only mode";
      return;
    }
    size_t index = getIndex(cType, negativeEta, cEta, iPhi, BX_n);
    uint32_t& data = myDataWritePtr[index];
    if (cType == HF) {
      // Pick out the correct 8-bits for the iEta chosen
      // Note that cEta = 41 is special, it only occurs for iPhi == 1 and shares cEta = 40 position
      if (cEta == 41) {
        data |= (et & 0xFF) << 16;
      } else {
        data |= (et & 0xFF) << (((cEta - 30) % 4) * 8);
      }
    } else {
      // Pick out the correct 8-bits for the iPhi chosen
      data |= (et & 0xFF) << (iPhi * 8);
    }
  }

  uint32_t getET(CaloType cType, bool negativeEta, uint32_t cEta, uint32_t iPhi, uint32_t BX_n) {
    size_t index = getIndex(cType, negativeEta, cEta, iPhi, BX_n);
    const uint32_t data = myDataPtr[index];
    uint32_t et = 0xDEADBEEF;
    if (cType == HF) {
      // Pick out the correct 8-bits for the iEta chosen
      // Note that cEta = 41 is special, it only occurs for iPhi == 1 and shares cEta = 40 position
      if (cEta == 41)
        et = ((data >> 16) & 0xFF);
      else
        et = ((data >> ((cEta - 30) % 4) * 8) & 0xFF);
    } else {
      // Pick out the correct 8-bits for the iPhi chosen
      et = ((data >> (iPhi * 8)) & 0xFF);
    }
    return et;
  }

  void setFB(CaloType cType, bool negativeEta, uint32_t cEta, uint32_t iPhi, uint32_t fb, uint32_t BX_n) {
    if (myDataWritePtr == nullptr) {
      edm::LogError("UCTCTP7RawData5BX") << "I was made in read-only mode";
      return;
    }
    if (cType == HF) {
      setHFFeatureBits(negativeEta, cEta, iPhi, fb, BX_n);
    } else {
      size_t index = getFeatureIndex(cType, negativeEta, cEta, iPhi, BX_n);
      uint32_t& data = myDataWritePtr[index];

      uint32_t tower = iPhi;
      if (((cEta - 1) % 2) == 1) {
        tower += 4;
      }
      data |= (fb & 0x1) << tower;
    }
  }

  uint32_t getFB(CaloType cType, bool negativeEta, uint32_t cEta, uint32_t iPhi, uint32_t BX_n) {
    size_t index = getFeatureIndex(cType, negativeEta, cEta, iPhi, BX_n);
    const uint32_t data = myDataPtr[index];
    uint32_t fb = 0;
    if (cType == HF) {
      fb = getHFFeatureBits(negativeEta, cEta, iPhi, BX_n);
    } else {
      // Pick out the correct bit for the tower chosen
      uint32_t tower = iPhi;
      if (((cEta - 1) % 2) == 1) {
        tower += 4;
      }
      fb = ((data & (0x1 << tower)) != 0) ? 1 : 0;
    }
    return fb;
  }

  void setHFFeatureBits(bool negativeEta, uint32_t cEta, uint32_t iPhi, uint32_t fb, uint32_t BX_n) {
    if (myDataWritePtr == nullptr) {
      edm::LogError("UCTCTP7RawData5BX") << "I was made in read-only mode";
      return;
    }
    size_t index = getFeatureIndex(HF, negativeEta, cEta, iPhi, BX_n);
    uint32_t shift = (cEta - 30) * 2;
    if (cEta == 41)
      shift = 20;  // 41 occurs on b-fiber but shares the position of 40
    if (shift >= 8) {
      uint32_t& data = myDataWritePtr[index];
      data |= (fb & 0x3) << (shift - 8);
    } else {
      uint32_t& data = myDataWritePtr[index - 1];
      data |= (fb & 0x3) << (shift + 24);
    }
  }

  uint32_t getHFFeatureBits(bool negativeEta, uint32_t cEta, uint32_t iPhi, uint32_t BX_n) {
    size_t index = getFeatureIndex(HF, negativeEta, cEta, iPhi, BX_n);
    // Stitch together the top 8 bits from previous 32-bit word and bottom 14 bits from this word
    const uint32_t data = ((myDataPtr[index] & 0x3FFF) << 8) + (myDataPtr[index - 1] >> 24);
    uint32_t shift = (cEta - 30) * 2;
    if (cEta == 41)
      shift = 20;  // 41 occurs on b-fiber but shares the position of 40
    return ((data >> shift) & 0x3);
  }

  uint32_t getLinkStatus(CaloType cType, bool negativeEta, uint32_t cEta, uint32_t iPhi, uint32_t BX_n) {
    size_t index = getFeatureIndex(cType, negativeEta, cEta, iPhi, BX_n);
    const uint32_t data = myDataPtr[index];
    return (data >> 16);
  }

  size_t getSummaryIndex(bool negativeEta, uint32_t region, uint32_t BX_n) {
    size_t index = 2 * 14 * (3 + 3) * 5 + 4 * 4 * 5 + (region / 2) + 4 * BX_n;
    if (negativeEta)
      index += 4 * 5;
    if (index >= 192 * 5) {
      edm::LogError("UCTCTP7RawData5BX") << "Managed to calculate an out-of-bounds index, buyer beware";
    }
    return index;
  }

  void setRegionSummary(bool negativeEta, uint32_t region, uint32_t regionData, uint32_t BX_n) {
    if (myDataWritePtr == nullptr) {
      edm::LogError("UCTCTP7RawData5BX") << "I was made in read-only mode";
      return;
    }
    size_t index = getSummaryIndex(negativeEta, region, BX_n);
    uint32_t& data = myDataWritePtr[index];
    data |= (regionData & 0xFFFF) << (16 * (region % 2));
  }

  uint32_t getRegionSummary(bool negativeEta, uint32_t region, uint32_t BX_n) {
    size_t index = getSummaryIndex(negativeEta, region, BX_n);
    const uint32_t data = myDataPtr[index];
    return ((data >> (16 * (region % 2))) & 0xFFFF);
  }

  uint32_t getRegionET(bool negativeEta, uint32_t region, uint32_t BX_n) {
    return (getRegionSummary(negativeEta, region, BX_n) & 0x3FF);
  }

  bool getRegionEGVeto(bool negativeEta, uint32_t region, uint32_t BX_n) {
    return (getRegionSummary(negativeEta, region, BX_n) & 0x0400);
  }

  bool getRegionTauVeto(bool negativeEta, uint32_t region, uint32_t BX_n) {
    return (getRegionSummary(negativeEta, region, BX_n) & 0x0800);
  }

  uint32_t getRegionHitLocation(bool negativeEta, uint32_t region, uint32_t BX_n) {
    return ((getRegionSummary(negativeEta, region, BX_n) & 0xF000) >> 12);
  }

  bool isTowerMasked(CaloType cType, bool negativeEta, uint32_t cEta, uint32_t iPhi, uint32_t BX_n) {
    uint32_t linkStatus = getLinkStatus(cType, negativeEta, cEta, iPhi, BX_n);
    uint32_t tower = iPhi;
    if ((cEta % 2) == 0)
      tower += 4;
    if (cType == HF) {
      tower = (cEta - 30);
      if (cEta == 41)
        tower = 10;
    }
    return ((linkStatus & (0x1 << tower)) != 0);
  }

  bool isLinkMisaligned(CaloType cType, bool negativeEta, uint32_t cEta, uint32_t iPhi, uint32_t BX_n) {
    uint32_t linkStatus = getLinkStatus(cType, negativeEta, cEta, iPhi, BX_n);
    if (cType == EBEE && (cEta == 17 || cEta == 21)) {
      return ((linkStatus & 0x00000100) != 0);
    }
    return ((linkStatus & 0x00001000) != 0);
  }

  bool isLinkInError(CaloType cType, bool negativeEta, uint32_t cEta, uint32_t iPhi, uint32_t BX_n) {
    uint32_t linkStatus = getLinkStatus(cType, negativeEta, cEta, iPhi, BX_n);
    if (cType == EBEE && (cEta == 17 || cEta == 21)) {
      return ((linkStatus & 0x00000200) != 0);
    }
    return ((linkStatus & 0x00002000) != 0);
  }

  bool isLinkDown(CaloType cType, bool negativeEta, uint32_t cEta, uint32_t iPhi, uint32_t BX_n) {
    uint32_t linkStatus = getLinkStatus(cType, negativeEta, cEta, iPhi, BX_n);
    if (cType == EBEE && (cEta == 17 || cEta == 21)) {
      return ((linkStatus & 0x00000400) != 0);
    }
    return ((linkStatus & 0x00004000) != 0);
  }

  bool isLinkMasked(CaloType cType, bool negativeEta, uint32_t cEta, uint32_t iPhi, uint32_t BX_n) {
    uint32_t linkStatus = getLinkStatus(cType, negativeEta, cEta, iPhi, BX_n);
    if (cType == EBEE && (cEta == 17 || cEta == 21)) {
      return ((linkStatus & 0x00000800) != 0);
    }
    return ((linkStatus & 0x00008000) != 0);
  }

private:
  // Pointer to contiguous array of 192*5 values
  // We assume instantiator of this class will gurantee that fact
  const uint32_t* myDataPtr;
  // == myDataPtr unless read-only
  uint32_t* myDataWritePtr = nullptr;
};

#endif