VMMChannel.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2022 CERN for the benefit of the ATLAS collaboration
*/
#ifndef _MUON_VMM_CHANNEL_H_
#define _MUON_VMM_CHANNEL_H_
 
#include "MuonNSWCommonDecode/NSWResourceId.h"
#include "MuonNSWCommonDecode/NSWElink.h"
#include "MuonNSWCommonDecode/NSWOfflineHelper.h"
 
namespace Muon
{
  namespace nsw
  {
    class VMMChannel
    {
     private:
      uint32_t m_vmm_word;
 
      uint16_t m_roc_vmm;      // vmm capture on the ROC
      uint16_t m_chan;         // vmm channel
      uint16_t m_pdo;          // adc amplitude
      uint16_t m_tdo;          // peaking time 
      uint16_t m_rel;          // relative BCID
      bool     m_neighbor;     // flag
      bool     m_parity;       // parity
 
      Muon::nsw::NSWElink *m_elink;
 
      // Offline helper converts online parameters into channel type and channel number
 
      std::unique_ptr <Muon::nsw::helper::NSWOfflineHelper> m_offlineHelper;
 
     private:
      uint8_t  calculate_word_parity (uint32_t w, uint8_t p = 0);
 
     public:
      VMMChannel (uint32_t vmm_word, Muon::nsw::NSWElink *elink);
      virtual ~VMMChannel () {};
 
      bool calculate_parity ();
 
      // Hit word
 
      uint32_t vmm_word () {return m_vmm_word;};
 
      // Decoded components of hit wors
 
      bool     neighbor     () {return m_neighbor;};
      bool     parity       () {return m_parity;};
      uint16_t pdo          () {return m_pdo;};
      uint16_t tdo          () {return m_tdo;};
      uint16_t rel_bcid     () {return m_rel;};
      uint16_t vmm_channel  () {return m_chan;};
      uint16_t roc_vmm      () {return m_roc_vmm;};
      uint16_t vmm          () {return m_offlineHelper->vmm();};
 
      // Access to Detector logical ID
 
      const Muon::nsw::NSWElink *elink () const {return m_elink;};
 
      // Direct access to offline parameters from elinkId
 
      bool is_large_station  () {return m_elink->elinkId ()->is_large_station ();};
 
      int8_t  station_eta    () {return m_elink->elinkId ()->station_eta ();};
      uint8_t station_phi    () {return m_elink->elinkId ()->station_phi ();};
      uint8_t multi_layer    () {return m_elink->elinkId ()->multi_layer ();};
      uint8_t gas_gap        () {return m_elink->elinkId ()->gas_gap ();};
 
      // Offline parameters
 
      uint8_t  channel_type   () {return m_offlineHelper->channel_type ();};
      uint16_t channel_number () {return m_offlineHelper->channel_number ();};
    };
  }
}
 
inline uint8_t Muon::nsw::VMMChannel::calculate_word_parity (uint32_t w, uint8_t p)
{
  while (w > 0)
  {
    p ^= w & 0x1;
    w = w >> 1;
  }
 
  return p;
}
 
inline bool Muon::nsw::VMMChannel::calculate_parity ()
{
  uint8_t p = 0 ^ (m_neighbor ? 1 : 0);
  uint16_t bcid = m_elink->bcId () + m_rel;
 
  p = this->calculate_word_parity (bcid, p);
  p = this->calculate_word_parity (m_pdo, p);
  p = this->calculate_word_parity (m_tdo, p);
 
  return (p > 0);
}
 
inline Muon::nsw::VMMChannel::VMMChannel (uint32_t vmm_word, Muon::nsw::NSWElink *elink)
: m_vmm_word (vmm_word), m_elink (elink)
{
  m_tdo      = Muon::nsw::helper::get_bits (vmm_word, Muon::nsw::bitMaskVmmHitTDC, Muon::nsw::bitPosVmmHitTDC);  // should be 0 if noTDC is true
  m_pdo      = Muon::nsw::helper::get_bits (vmm_word, Muon::nsw::bitMaskVmmHitADC, Muon::nsw::bitPosVmmHitADC);
  m_chan     = Muon::nsw::helper::get_bits (vmm_word, Muon::nsw::bitMaskVmmHitCHANNEL, Muon::nsw::bitPosVmmHitCHANNEL);
  m_roc_vmm  = Muon::nsw::helper::get_bits (vmm_word, Muon::nsw::bitMaskVmmHitVMMID, Muon::nsw::bitPosVmmHitVMMID);
  m_rel      = Muon::nsw::helper::get_bits (vmm_word, Muon::nsw::bitMaskVmmHitRELBCID, Muon::nsw::bitPosVmmHitRELBCID);
  m_neighbor = Muon::nsw::helper::get_bits (vmm_word, Muon::nsw::bitMaskVmmHitN, Muon::nsw::bitPosVmmHitN);
  m_parity   = Muon::nsw::helper::get_bits (vmm_word, Muon::nsw::bitMaskVmmHitP, Muon::nsw::bitPosVmmHitP);
 
  // For sTGCs: convert the vmm capture on the ROC (vmm in the fragment) to the nominal vmm number on the FEB
  uint16_t vmm{m_roc_vmm};
  constexpr uint16_t vmmRemap[8] = { 2, 3, 0, 1, 5, 4, 6, 7 };  
  if (elink->elinkId()->detId() == eformat::MUON_STGC_ENDCAP_A_SIDE || elink->elinkId()->detId() == eformat::MUON_STGC_ENDCAP_C_SIDE)
    vmm = vmmRemap [m_roc_vmm];
 
  m_offlineHelper = std::make_unique <Muon::nsw::helper::NSWOfflineHelper> (elink->elinkId (), vmm, m_chan);
}
 
#endif // _MUON_VMM_CHANNEL_H_