PixelDiodeMatrix.cxx

Go to the documentation of this file.

/*
  Copyright (C) 2002-2025 CERN for the benefit of the ATLAS collaboration
*/
 
#include "ReadoutGeometryBase/PixelDiodeMatrix.h"
#include "ReadoutGeometryBase/SiCellId.h"
#include "TrkEventPrimitives/ParamDefs.h"
 
#include <cassert>
#include <utility>
 
namespace InDetDD {
 
std::shared_ptr<const PixelDiodeMatrix> PixelDiodeMatrix::construct(double phiWidth, double etaWidth)
{
  class Helper : public PixelDiodeMatrix{};
  std::shared_ptr<PixelDiodeMatrix> ptr = std::make_shared<Helper>();
  ptr->initialize(phiWidth, etaWidth);
  return ptr;
}
 
void PixelDiodeMatrix::initialize(double phiWidth, double etaWidth)
{
  m_phiWidth = phiWidth;
  m_phiWidthInverse = 1. / phiWidth;
  m_etaWidth = etaWidth;
  m_etaWidthInverse = 1. / etaWidth;
  m_phiCells = 1;
  m_etaCells = 1;
  m_direction = phiDir; // Irrelevant
  m_numCells = 0;
  m_lowerCell = nullptr;
  m_middleCells = nullptr;
  m_upperCell = nullptr;
  m_singleCell = true;
}
 
std::shared_ptr<const PixelDiodeMatrix> PixelDiodeMatrix::construct(Direction direction,  // phi or eta
                                                                    std::shared_ptr<const PixelDiodeMatrix> lowerCell,
                                                                    std::shared_ptr<const PixelDiodeMatrix> middleCells,
                                                                    int numCells,
                                                                    std::shared_ptr<const PixelDiodeMatrix> upperCell)
{
  class Helper : public PixelDiodeMatrix{};
  std::shared_ptr<PixelDiodeMatrix> ptr = std::make_shared<Helper>();
  ptr->initialize(direction,
                  std::move(lowerCell),
                  std::move(middleCells),
                  numCells,
                  std::move(upperCell));
  return ptr;
}
 
void PixelDiodeMatrix::initialize(Direction direction,  // phi or eta
                                  std::shared_ptr<const PixelDiodeMatrix> lowerCell,
                                  std::shared_ptr<const PixelDiodeMatrix> middleCells,
                                  int numCells,
                                  std::shared_ptr<const PixelDiodeMatrix> upperCell)
{
  m_phiWidth = 0;
  m_etaWidth = 0;
  m_phiCells = 0;
  m_etaCells = 0;
  m_direction = direction;
  m_numCells = numCells;
  m_lowerCell = std::move(lowerCell);
  m_middleCells = std::move(middleCells);
  m_upperCell = std::move(upperCell);
  m_singleCell = false;
 
  // middleCells must be non zero.
  assert(m_middleCells);
 
  if (m_direction == phiDir) {
 
    // In eta direction widths must be all the same.
    if (m_middleCells){
      m_etaWidth = m_middleCells->etaWidth();
      m_etaCells = m_middleCells->etaCells();
    }
    // Check lower and upper are consistent
    // TODO.
 
    if (m_lowerCell) {
      m_phiWidth += m_lowerCell->phiWidth();
      m_phiCells += m_lowerCell->phiCells();
    }
 
    if (m_middleCells){
      m_phiWidth += m_numCells * m_middleCells->phiWidth();
      m_phiCells += m_numCells * m_middleCells->phiCells();
    }
 
    if (m_upperCell) {
      m_phiWidth += m_upperCell->phiWidth();
      m_phiCells += m_upperCell->phiCells();
    }
 
  } else { // eta Direction
 
    // In phi direction widths must be all the same.
    if (m_middleCells){
      m_phiWidth = m_middleCells->phiWidth();
      m_phiCells = m_middleCells->phiCells();
    }
    // Check lower and upper are consistent
    // TODO.
 
    if (m_lowerCell) {
      m_etaWidth += m_lowerCell->etaWidth();
      m_etaCells += m_lowerCell->etaCells();
    }
 
    if (m_middleCells){
      m_etaWidth += m_numCells * m_middleCells->etaWidth();
      m_etaCells += m_numCells * m_middleCells->etaCells();
    }
 
    if (m_upperCell) {
      m_etaWidth += m_upperCell->etaWidth();
      m_etaCells += m_upperCell->etaCells();
    }
 
  }
 
  m_phiWidthInverse = 1. / m_phiWidth;
  m_etaWidthInverse = 1. / m_etaWidth;
}
 
const PixelDiodeMatrix*
PixelDiodeMatrix::cellIdOfPosition(const Amg::Vector2D & relPosition, SiCellId & cellId) const

 
{
  using Trk::distPhi;
  using Trk::distEta;
 
  if (m_singleCell) {
    return this;
  }
 
  double relPosDir = 0; // Relative position along m_direction
  int startIndex = 0;
  double pitch = 0;
  double pitchInverse = 0;
  int middleCells = 0;
 
  if (m_direction == phiDir) {
 
    relPosDir = relPosition[distPhi];
    pitch = m_middleCells->phiWidth();
    pitchInverse = m_middleCells->phiWidthInverse();
    middleCells = m_middleCells->phiCells();
 
    if (m_lowerCell) {
      if (relPosDir < m_lowerCell->phiWidth()) {
        return m_lowerCell->cellIdOfPosition(relPosition, cellId);
      } else {
        relPosDir  -= m_lowerCell->phiWidth();
        startIndex += m_lowerCell->phiCells();
      }
    }
  } else { // etaDir
 
    relPosDir = relPosition[distEta];
    pitch = m_middleCells->etaWidth();
    pitchInverse = m_middleCells->etaWidthInverse();
    middleCells = m_middleCells->etaCells();
 
    if (m_lowerCell) {
      if (relPosDir < m_lowerCell->etaWidth()) {
        return m_lowerCell->cellIdOfPosition(relPosition, cellId);
      } else {
        relPosDir  -= m_lowerCell->etaWidth();
        startIndex += m_lowerCell->etaCells();
      }
    }
  }
 
 
  int index = relPosDir * pitchInverse;
 
  const PixelDiodeMatrix *nextCell{};
 
  bool outOfBounds = index >= m_numCells;
  if (m_upperCell != nullptr && outOfBounds) {
    // We are in the upper cell.
    index = m_numCells;
    nextCell = m_upperCell.get();
  } else {
    // We are in the middle cells
    // Make sure its in range (in case of rounding errors)
    if (outOfBounds) index = m_numCells - 1;
    nextCell = m_middleCells.get();
  }
 
  if (index > 0) { // Make sure its in range (in case of rounding errors)
    relPosDir  -= index *  pitch;
    startIndex += index *  middleCells;
  }
 
  int newPhiIndex = cellId.phiIndex();
  int newEtaIndex = cellId.etaIndex();
  const PixelDiodeMatrix *cell{};
 
  if (m_direction == phiDir) {
    if (nextCell->singleCell()) {
      newPhiIndex += startIndex;
      cell = nextCell;
    } else {
      Amg::Vector2D newRelPos(relPosDir, relPosition[distEta]);
      SiCellId relId(0,0);
      cell = nextCell->cellIdOfPosition(newRelPos, relId);
      newPhiIndex += startIndex + relId.phiIndex();
      newEtaIndex += relId.etaIndex();
    }
  } else {
    if (nextCell->singleCell()) {
      newEtaIndex += startIndex;
      cell = nextCell;
    } else {
      Amg::Vector2D newRelPos(relPosition[distPhi], relPosDir);
      SiCellId relId(0,0);
      cell = nextCell->cellIdOfPosition(newRelPos, relId);
      newPhiIndex += relId.phiIndex();
      newEtaIndex += startIndex + relId.etaIndex();
    }
  }
 
  cellId = SiCellId(newPhiIndex, newEtaIndex);
  return cell;
}
 
 
 
const PixelDiodeMatrix *
PixelDiodeMatrix::positionOfCell(const PixelDiodeMatrix *matrix, const SiCellId & cellId, Amg::Vector2D & dest_position)
 
  
 
{
  using Trk::distPhi;
  using Trk::distEta;
  Amg::Vector2D position{
     -matrix->phiHalfWidth(),
     -matrix->etaHalfWidth()
  };
 
  int rel_phi_index = cellId.phiIndex();
  int rel_eta_index = cellId.etaIndex();
  for( ;!matrix->m_singleCell; ) {
 
     int relIndex = 0; // Relative index along m_direction
     double pitch = 0;
     int nMiddleCells = 0;
     double startPos = 0;
     const auto direction = matrix->m_direction;
 
     if (direction == PixelDiodeMatrix::phiDir) {
 
        relIndex = rel_phi_index;
 
        const PixelDiodeMatrix *lowerCell = matrix->m_lowerCell.get();
        if (lowerCell) {
           if (relIndex < lowerCell->phiCells()) {
              matrix = lowerCell;
              continue;
           } else {
              relIndex -=  lowerCell->phiCells();
          startPos +=  lowerCell->phiWidth();
           }
        }
        const PixelDiodeMatrix *middleCells = matrix->m_middleCells.get();
        assert(middleCells);
        pitch = middleCells->phiWidth();
        nMiddleCells = middleCells->phiCells();
 
     } else { // etaDir
 
        relIndex = rel_eta_index;
        const PixelDiodeMatrix *lowerCell = matrix->m_lowerCell.get();
        if (lowerCell) {
           if (relIndex < lowerCell->etaCells()) {
              matrix = lowerCell;
              continue;
           } else {
          relIndex -=  lowerCell->etaCells();
          startPos +=  lowerCell->etaWidth();
           }
        }
        const PixelDiodeMatrix *middleCells = matrix->m_middleCells.get();
        assert(middleCells);
        pitch = middleCells->etaWidth();
        nMiddleCells = middleCells->etaCells();
 
     }
 
     int index = std::min(relIndex / nMiddleCells,matrix->m_numCells); // @TODO upper bound correct ?
     relIndex -= index * nMiddleCells;
     startPos += index * pitch;
 
     matrix = (matrix->m_upperCell && index == matrix->m_numCells ) ? matrix->m_upperCell.get() : matrix->m_middleCells.get();
 
     if (direction == PixelDiodeMatrix::phiDir) {
        rel_phi_index = relIndex;
        position[distPhi] += startPos;
     } else {
        rel_eta_index = relIndex;
        position[distEta] += startPos;
     }
  }
  position[distPhi] += matrix->phiHalfWidth();
  position[distEta] += matrix->etaHalfWidth();
  dest_position = position;
  return matrix;
}
 
std::string
PixelDiodeMatrix::createDebugStringRepr(unsigned int level) const
{
  std::string prefix(level, ' ');
 
  // base case: single cell
  if (m_singleCell) {
    std::string cellSize = "";
    cellSize += prefix + "phi: " + std::to_string(m_phiWidth) + "\n";
    cellSize += prefix + "eta: " + std::to_string(m_etaWidth) + "\n";
    return cellSize;
  }
 
  std::string cellContent = "";
 
  if (m_lowerCell == nullptr && m_middleCells == nullptr && m_upperCell == nullptr) {
    cellContent += prefix + "completly empty (WARNING: there should always be at least one cell!)\n";
    return cellContent;
  }
 
  cellContent += prefix + "direction: ";
  if (m_direction == phiDir)      { cellContent += "phi\n"; }
  else if (m_direction == etaDir) { cellContent += "eta\n"; }
  else                            { cellContent += "unknown\n"; }
 
  // recursive call for nested cells
  if (m_lowerCell != nullptr) {
    cellContent += prefix + "lowerCell: \n";
    cellContent += m_lowerCell->createDebugStringRepr(level + 1);
  }
  if (m_middleCells != nullptr) {
    cellContent += prefix + "middleCells: " + std::to_string(m_numCells) + "x :\n";
    cellContent += m_middleCells->createDebugStringRepr(level + 1);
  }
  if (m_upperCell != nullptr) {
    cellContent += prefix + "upperCell: \n";
    cellContent += m_upperCell->createDebugStringRepr(level + 1);
  }
 
  return cellContent;
}
 
} // end namespace