CbmMvdAddress.h

Go to the documentation of this file.

/* Copyright (C) 2025 IKF Frankfurt University, Frankfurt am Main
   SPDX-License-Identifier: GPL-3.0-only
   Authors: Ajit Kumar [committer], Jan Michel*/

 
 
#ifndef CBMMVDADDRESS_H
#define CBMMVDADDRESS_H 1
 
#include "CbmAddress.h"  // for CbmAddress
 
#ifndef NO_ROOT
#include <Rtypes.h>  // for ClassDef
#endif
 
#include <cstdint>

enum MvdElementLevel
{
  kMvdSystem,    
  kMvdStation,   
  kMvdSideUD,    
  kMvdSideLR,    
  kMvdSideTB,    
  kMvdLadder,    
  kMvdSensor,    
  kMvdSensorY,   
  kMvdSensorX,   
  kMvdNofLevels  
};



class CbmMvdAddress : public CbmAddress {
 
 public:
  static uint32_t GetAddress(int32_t station = 0, int32_t sideUD = 0, int32_t sideLR = 0, int32_t sideTB = 0,
                             int32_t ladder = 0, int32_t sensor = 0, int32_t sensorY = 0, int32_t sensorX = 0);
 
  static uint32_t GetAddress(int32_t* elementIds);
 
  static int32_t GetNofLevels() { return kMvdNofLevels; }
 
  static int32_t GetNofBits(int32_t level)
  {
    if (level < 0 || level >= kMvdNofLevels) return 0;
    return fgkBits[level];
  }
 
  static int32_t GetElementId(uint32_t address, int32_t level)
  {
    if (level < 0 || level >= kMvdNofLevels) return -1;
    return (address & (fgkMask[level] << fgkShift[level])) >> fgkShift[level];
  }
 
  // Derivatives for convenience
  static int32_t GetSystemIndex(uint32_t address) { return GetElementId(address, kMvdSystem); }
  static int32_t GetStationIndex(uint32_t address) { return GetElementId(address, kMvdStation); }
  static int32_t GetSideUDIndex(uint32_t address) { return GetElementId(address, kMvdSideUD); }
  static int32_t GetSideLRIndex(uint32_t address) { return GetElementId(address, kMvdSideLR); }
  static int32_t GetSideTBIndex(uint32_t address) { return GetElementId(address, kMvdSideTB); }
  static int32_t GetLadderIndex(uint32_t address) { return GetElementId(address, kMvdLadder); }
  static int32_t GetSensorIndex(uint32_t address) { return GetElementId(address, kMvdSensor); }
  static int32_t GetSensorYIndex(uint32_t address) { return GetElementId(address, kMvdSensorY); }
  static int32_t GetSensorXIndex(uint32_t address) { return GetElementId(address, kMvdSensorX); }

  // TODO: Unify the name of the function: it may be also defined for other detector subsystems to
  //       mask individual channels and leave an address of the whole sensor/module.
  static uint32_t GetDetectorId(uint32_t address)
  {
    return ((1 << (fgkBitsSensorNr + fgkBits[kMvdSystem])) - 1) & address;
  }
 
  // FIXME: 07/2025 Compatibility layer for Vertical Test and simulations
  static uint32_t GetAddressFromSensorNrAndPixelXY(int32_t sensorNr, int32_t sensorY, int32_t sensorX);
  static int32_t GetSensorNrFromAddress(uint32_t address)
  {
    return (address & (fgkMaskSensorNr << fgkShiftSensorNr)) >> fgkShiftSensorNr;
  }
 

  static int32_t GetElementAddress(int32_t address, int32_t level)
  {
    int32_t mask = (1 << (CbmMvdAddress::fgkShift[level] + CbmMvdAddress::fgkBits[level])) - 1;
    return address & mask;
  }
 
  static void Print();
 
  static uint32_t SetElementId(uint32_t address, int32_t level, int32_t newId);
 
 private:
  static constexpr int32_t fgkBits[kMvdNofLevels] = {
    4,   // System (kMVD)
    2,   // Station
    1,   // SideUD (Upstream/Downstream)
    1,   // SideLR (Left/Right)
    1,   // SideTB (Top/Bottom)
    2,   // Ladder
    2,   // Sensor
    9,   // SensorY
    10,  // SensorX
  };
 
  static const int32_t fgkShift[kMvdNofLevels];
  static const int32_t fgkMask[kMvdNofLevels];
 
  // FIXME: 07/2025 Compatibility layer for Vertical Test and simulations
  // => To be cleaned up once the CbmMvdDigi class has been updated/reviewed/rewritten
  static constexpr int32_t fgkBitsSensorNr = fgkBits[kMvdStation] + fgkBits[kMvdSideUD] + fgkBits[kMvdSideLR]
                                             + fgkBits[kMvdSideTB] + fgkBits[kMvdLadder] + fgkBits[kMvdSensor];
  static const int32_t fgkShiftSensorNr;
  static const int32_t fgkMaskSensorNr;
 
#ifndef NO_ROOT
  ClassDef(CbmMvdAddress, 1);
#endif
};
 
#endif /* CBMMVDADDRESS_H */