ClusterMakerTool.cxx

Go to the documentation of this file.

/*
  Copyright (C) 2002-2025 CERN for the benefit of the ATLAS collaboration
*/
 
//***************************************************************************
//
// Implementation for ClusterMaker
//
//****************************************************************************
 
#include "CLHEP/Units/SystemOfUnits.h"
#include "CLHEP/Matrix/SymMatrix.h"
#include "GaudiKernel/ToolHandle.h"
#include "GaudiKernel/ServiceHandle.h"
#include "SiClusterizationTool/ClusterMakerTool.h"
#include "InDetReadoutGeometry/SiDetectorElement.h"
#include "ReadoutGeometryBase/SiLocalPosition.h"
#include "PixelReadoutGeometry/PixelModuleDesign.h"
#include "InDetPrepRawData/PixelCluster.h"
#include "InDetPrepRawData/SCT_Cluster.h"
#include "InDetPrepRawData/SiWidth.h"
 
#include "InDetIdentifier/PixelID.h"
#include "AtlasDetDescr/AtlasDetectorID.h"
 
#include "EventPrimitives/EventPrimitives.h"
 
#include "xAODInDetMeasurement/Utilities.h"
 
#include <memory>
 
using PixelCalib::PixelOfflineCalibData;
using CLHEP::micrometer;
 
namespace {
 
inline double square(const double x){
    return x*x;
}
constexpr double ONE_TWELFTH = 1./12.;
 
// Some methods below can be parameterized on the pixel cluster type,
// The following functions allow using a function parameter for common
// operations.
//   [ Omegax = TOT1/(TOT1+TOT2), where TOT1 and TOT2 are the sum of the
//     charges of the first and last row of the cluster respectively
//     Omegay: similar definition with columns rather than rows ]
InDet::PixelCluster newInDetpixelCluster(const Identifier& RDOId,
                      const Amg::Vector2D& locpos,
                      const Amg::Vector3D& globpos,
                      std::vector<Identifier>&& rdoList,
                      const int lvl1a,
                      std::vector<int>&& totList,
                      std::vector<float>&& chargeList,
                      const InDet::SiWidth& width,
                      const InDetDD::SiDetectorElement* detEl,
                      Amg::MatrixX&& locErrMat,
                      const float omegax,
                      const float omegay,
                      bool split,
                      float splitProb1,
                      float splitProb2)
{
    return InDet::PixelCluster(RDOId,
                   locpos,
                   globpos,
                   std::move(rdoList),
                   lvl1a,
                   std::move(totList),
                   std::move(chargeList),
                   width,
                   detEl,
                   std::move(locErrMat),
                   omegax,
                   omegay,
                   split,
                   splitProb1,
                   splitProb2);
}
 
// Function-like class to add an xAOD::PixelCluster to an
// xAOD::PixelClusterContainer. This is needed because the
// PixelCluster object needs an aux store for the setMeasurement call
// to not crash
class AddNewxAODpixelCluster {
public:
    explicit AddNewxAODpixelCluster(xAOD::PixelCluster& cluster)
    : m_cluster(&cluster) {}
 
    xAOD::PixelCluster* operator()(const Identifier& /*RDOId*/,
                   const Amg::Vector2D& locpos,
                   const Amg::Vector3D& globpos,
                   const std::vector<Identifier>& rdoList,
                   const int lvl1a,
                   const std::vector<int>& totList,
                   const std::vector<float>& chargeList,
                   const InDet::SiWidth& width,
                   const InDetDD::SiDetectorElement* detEl,
                   const Amg::MatrixX& locErrMat,
                   bool split,
                   float splitProb1,
                   float splitProb2) {
    IdentifierHash idHash = detEl->identifyHash();
 
    Eigen::Matrix<float,2,1> localPosition(locpos.x(), locpos.y());
    Eigen::Matrix<float,2,2> localCovariance = Eigen::Matrix<float,2,2>::Zero();
    localCovariance(0, 0) = locErrMat(0, 0);
    localCovariance(1, 1) = locErrMat(1, 1);
 
    m_cluster->setMeasurement<2>(idHash, localPosition, localCovariance);
    m_cluster->setRDOlist(rdoList);
    m_cluster->globalPosition() = globpos.cast<float>();
    m_cluster->setToTlist(totList);
    m_cluster->setTotalToT( xAOD::xAODInDetMeasurement::Utilities::computeTotalToT(totList) );
    m_cluster->setChargelist(chargeList);
    m_cluster->setTotalCharge( xAOD::xAODInDetMeasurement::Utilities::computeTotalCharge(chargeList) );
    m_cluster->setLVL1A(lvl1a);
    m_cluster->setChannelsInPhiEta(width.colRow()[0], width.colRow()[1]);
    m_cluster->setWidthInEta(static_cast<float>(width.widthPhiRZ()[1]));
    m_cluster->setIsSplit(split);
    m_cluster->setSplitProbabilities(splitProb1, splitProb2);
 
    return m_cluster;
    }
 
private:
  xAOD::PixelCluster *m_cluster;
};
 
 
}
 
 
namespace InDet {
 
// using namespace Trk;
 
// Constructor with parameters:
ClusterMakerTool::ClusterMakerTool(const std::string& t,
                                   const std::string& n,
                                   const IInterface* p) :
  AthAlgTool(t,n,p)
{
  declareInterface<ClusterMakerTool>(this);
}
 
//================ Initialisation =============================================
 
StatusCode  ClusterMakerTool::initialize(){
  // Code entered here will be executed once at program start.
 
   ATH_MSG_DEBUG ( name() << " initialize()" );
 
   if (not m_pixelReadout.empty()) {
     ATH_CHECK(m_pixelReadout.retrieve());
   }
 
   if (not m_pixelLorentzAngleTool.empty()) {
     ATH_CHECK(m_pixelLorentzAngleTool.retrieve());
   } else {
     m_pixelLorentzAngleTool.disable();
   }
   if (not m_sctLorentzAngleTool.empty()) {
     ATH_CHECK(m_sctLorentzAngleTool.retrieve());
   } else {
     m_sctLorentzAngleTool.disable();
   }
 
 
   return StatusCode::SUCCESS;
}
 
 
// Compute the pixel cluster global position, and the error associated
// to the position.
// Called by the pixel clustering tools
//
// Input parameters
// - the cluster Identifier
// - the position in local reference frame
// - the list of identifiers of the Raw Data Objects belonging to the cluster
// - the width of the cluster
// - the module the cluster belongs to
// - wheter the cluster contains ganged pixels
// - the error strategy, currently
//    0: cluster width/sqrt(12.)
//    1: pixel pitch/sqrt(12.)
//    2: parametrized as a function ofpseudorapidity and cluster size
//       (default)
//   10: CTB parametrization (as a function of module and cluster size)
//       no magnetic field
// - const reference to a PixelID helper class
 
template <typename ClusterType, typename  IdentifierVec, typename ToTList>
ClusterType ClusterMakerTool::makePixelCluster(
                         const Identifier& clusterID,
                         const Amg::Vector2D& localPos,
                         IdentifierVec&& rdoList,
                         const int lvl1a,
                         ToTList&& totList,
                         const SiWidth& width,
                         const InDetDD::SiDetectorElement* element,
                         bool  ganged,
                         int errorStrategy,
                         const PixelID& pixelID,
                         bool split,
                         double splitProb1,
                         double splitProb2,
                         const PixelChargeCalibCondData *calibData,
                         const PixelOfflineCalibData *offlineCalibData,
                         const EventContext& ctx,
                         xAOD::PixelCluster* cluster) const{
 
  ATH_MSG_VERBOSE("ClusterMakerTool called, number ");
  if ( errorStrategy==2 && m_forceErrorStrategy1B ) errorStrategy=1;
 
  // Fill vector of charges and compute charge balance
  const InDetDD::PixelModuleDesign* design = (dynamic_cast<const InDetDD::PixelModuleDesign*>(&element->design()));
  if (not design){
    throw std::runtime_error( "Dynamic cast failed for design in ClusterMakerTool.cxx");
  }
  int rowMin = design->rows();
  int rowMax = 0;
  int colMin = design->columns();
  int colMax = 0;
  float qRowMin = 0;  float qRowMax = 0;
  float qColMin = 0;  float qColMax = 0;
  std::vector<float> chargeList;
  int nRDO=rdoList.size();
  if (calibData) {
    chargeList.reserve(nRDO);
    for (int i=0; i<nRDO; i++) {
      Identifier pixid=rdoList[i];
      int ToT=totList[i];
 
      float charge = ToT;
      Identifier moduleID = pixelID.wafer_id(pixid);
      IdentifierHash moduleHash = pixelID.wafer_hash(moduleID); // wafer hash
      unsigned int FE = m_pixelReadout->getFE(pixid, moduleID);
      InDetDD::PixelDiodeType type = m_pixelReadout->getDiodeType(pixid);
      charge = calibData->getCharge(type, moduleHash, FE, ToT);
      if (design->getReadoutTechnology() != InDetDD::PixelReadoutTechnology::RD53 && (moduleHash<12 || moduleHash>2035)) {
        charge = ToT/8.0*(8000.0-1200.0)+1200.0;
      }
      chargeList.push_back(charge);
    }
  }
 
  for (int i=0; i<nRDO; i++) {
    Identifier pixid=rdoList[i];
    int ToT=totList[i];
 
    float charge = ToT;
    if (calibData) { charge=chargeList[i]; }
 
    //     std::cout << "tot, charge =  " << ToT << " " << charge << std::endl;
    int row = pixelID.phi_index(pixid);
    int col = pixelID.eta_index(pixid);
    if (row == rowMin) qRowMin += charge;
    if (row < rowMin){
      rowMin = row;
      qRowMin = charge;
    }
 
    if (row == rowMax) qRowMax += charge;
    if (row > rowMax){
      rowMax = row;
      qRowMax = charge;
    }
    if (col == colMin) qColMin += charge;
    if (col < colMin){
      colMin = col;
      qColMin = charge;
    }
 
    if (col == colMax) qColMax += charge;
    if (col > colMax){
      colMax = col;
      qColMax = charge;
    }
  }
 
  Identifier newClusterID = pixelID.pixel_id(pixelID.wafer_id(clusterID),rowMin,colMin);
  // Compute omega for charge interpolation correction (if required)
  // Two pixels may have charge=0 (very rarely, hopefully)
  float omegax = -1;
  float omegay = -1;
  if(qRowMin+qRowMax > 0) omegax = qRowMax/float(qRowMin+qRowMax);
  if(qColMin+qColMax > 0) omegay = qColMax/float(qColMin+qColMax);
 
  ATH_MSG_VERBOSE("omega =  " << omegax << " " << omegay);
 
// ask for Lorentz correction, get global position
  double shift = m_pixelLorentzAngleTool->getLorentzShift(element->identifyHash(), ctx);
  Amg::Vector2D locpos(localPos[Trk::locX]+shift, localPos[Trk::locY]);
// find global position of element
  const Amg::Transform3D& T = element->surface().transform();
  double Ax[3] = {T(0,0),T(1,0),T(2,0)};
  double Ay[3] = {T(0,1),T(1,1),T(2,1)};
  double R [3] = {T(0,3),T(1,3),T(2,3)};
 
  const Amg::Vector2D&    M = locpos;
  Amg::Vector3D globalPos(M[0]*Ax[0]+M[1]*Ay[0]+R[0],M[0]*Ax[1]+M[1]*Ay[1]+R[1],M[0]*Ax[2]+M[1]*Ay[2]+R[2]);
 
  // error matrix
  const Amg::Vector2D& colRow = width.colRow();// made ref to avoid
                                             // unnecessary copy EJWM
  auto errorMatrix = Amg::MatrixX(2,2);
  errorMatrix.setIdentity();
 
  // switches are more readable **OPT**
  // actually they're slower as well (so I'm told) so perhaps
  // this should be re-written at some point EJWM
  double eta = std::abs(globalPos.eta());
  double zPitch = width.z()/colRow.y();
 
  const AtlasDetectorID* aid = element->getIdHelper();
 
  if (aid->helper() != AtlasDetectorID::HelperType::Pixel){
    throw std::runtime_error( "Wrong helper type in ClusterMakerTool.cxx.");
  }
  const PixelID* pid = static_cast<const PixelID*>(aid);
  int layer = pid->layer_disk(clusterID);
  int phimod = pid->phi_module(clusterID);
  switch (errorStrategy){
  case 0:
    errorMatrix.fillSymmetric(0,0,square(width.phiR())*ONE_TWELFTH);
    errorMatrix.fillSymmetric(1,1,square(width.z())*ONE_TWELFTH);
    break;
  case 1:
    errorMatrix.fillSymmetric(0,0,square(width.phiR()/colRow.x())*ONE_TWELFTH);
    errorMatrix.fillSymmetric(1,1,square(width.z()/colRow.y())*ONE_TWELFTH);
    break;
  case 2:
    // use parameterization only if the cluster does not
    // contain long pixels or ganged pixels
    // Also require calibration service is available....
    if (!ganged && zPitch>399*micrometer && zPitch<401*micrometer) {
        if (offlineCalibData) {
        if (element->isBarrel()) {
          int ibin = offlineCalibData->getPixelClusterErrorData()->getBarrelBin(eta,int(colRow.y()),int(colRow.x()));
          double phiError = offlineCalibData->getPixelClusterErrorData()->getPixelBarrelPhiError(ibin);
          double etaError = offlineCalibData->getPixelClusterErrorData()->getPixelBarrelEtaError(ibin);
          errorMatrix.fillSymmetric(0,0,pow(phiError,2));
          errorMatrix.fillSymmetric(1,1,pow(etaError,2));
        }
        else {
          int ibin = offlineCalibData->getPixelClusterErrorData()->getEndcapBin(int(colRow.y()),int(colRow.x()));
          double phiError = offlineCalibData->getPixelClusterErrorData()->getPixelEndcapPhiError(ibin);
          double etaError = offlineCalibData->getPixelClusterErrorData()->getPixelEndcapRError(ibin);
          errorMatrix.fillSymmetric(0,0,square(phiError));
          errorMatrix.fillSymmetric(1,1,square(etaError));
        }
      }
    }else{// cluster with ganged and/or long pixels
      errorMatrix.fillSymmetric(0,0,square(width.phiR()/colRow.x())*ONE_TWELFTH);
      errorMatrix.fillSymmetric(1,1,square(zPitch)*ONE_TWELFTH);
    }
    break;
 
  case 10:
    errorMatrix.fillSymmetric(0,0,square( getPixelCTBPhiError(layer,phimod,int(colRow.x()))));
    errorMatrix.fillSymmetric(1,1,square(width.z()/colRow.y())*ONE_TWELFTH);
    break;
 
  default:
    errorMatrix.fillSymmetric(0,0,square(width.phiR()/colRow.x())*ONE_TWELFTH);
    errorMatrix.fillSymmetric(1,1,square(width.z()/colRow.y())*ONE_TWELFTH);
    break;
  }
 
  //1) We want to move always for the Trk::PixelCluster
  //2) We forward the  rdoList and chargeList that could have be passed
  // different ways.
  //
  static_assert(std::is_same_v<ClusterType, PixelCluster> ||
                    std::is_same_v<std::remove_pointer_t<ClusterType>,
                                   xAOD::PixelCluster>,
                "Not an InDet::PixelCluster or xAOD::PixelCluster");
  if constexpr (std::is_same<ClusterType, InDet::PixelCluster>::value) {
  return newInDetpixelCluster(newClusterID, locpos,
                              globalPos,
                              std::forward<IdentifierVec>(rdoList),
                              lvl1a,
                              std::forward<ToTList>(totList),
                              std::move(chargeList),
                              width,
                              element,
                              std::move(errorMatrix),
                              omegax,
                              omegay,
                              split,
                              splitProb1,
                              splitProb2);
  } else{
  return AddNewxAODpixelCluster(*cluster)(newClusterID,
            locpos,
            globalPos,
            std::forward<IdentifierVec>(rdoList),
            lvl1a,
            std::forward<ToTList>(totList),
            chargeList,
            width,
            element,
            errorMatrix,
            split,
            splitProb1,
            splitProb2);
  }
}
 
PixelCluster ClusterMakerTool::pixelCluster(
    const Identifier& clusterID,
    const Amg::Vector2D& localPos,
    std::vector<Identifier>&& rdoList,
    const int lvl1a,
    std::vector<int>&& totList,
    const SiWidth& width,
    const InDetDD::SiDetectorElement* element,
    bool ganged,
    int errorStrategy,
    const PixelID& pixelID,
    bool split,
    double splitProb1,
    double splitProb2,
    const PixelChargeCalibCondData *calibData,
    const PixelOfflineCalibData *offlineCalibData,
    const EventContext& ctx) const
{
  return makePixelCluster<PixelCluster>(
      clusterID,
      localPos,
      std::move(rdoList),
      lvl1a,
      std::move(totList),
      width,
      element,
      ganged,
      errorStrategy,
      pixelID,
      split,
      splitProb1,
      splitProb2,
      calibData,
      offlineCalibData,
      ctx);
}
 
xAOD::PixelCluster* ClusterMakerTool::xAODpixelCluster(
    xAOD::PixelCluster& cluster,
    const Amg::Vector2D& localPos,
    const std::vector<Identifier>& rdoList,
    const int lvl1a,
    const std::vector<int>& totList,
    const SiWidth& width,
    const InDetDD::SiDetectorElement* element,
    bool ganged,
    int errorStrategy,
    const PixelID& pixelID,
    bool split,
    double splitProb1,
    double splitProb2,
    const PixelChargeCalibCondData *calibData,
    const PixelOfflineCalibData *offlineCalibData,
    const EventContext& ctx) const
{
    return makePixelCluster<xAOD::PixelCluster*>(
    Identifier(),
    localPos,
    rdoList,
    lvl1a,
    totList,
    width,
    element,
    ganged,
    errorStrategy,
    pixelID,
    split,
    splitProb1,
    splitProb2,
    calibData,
    offlineCalibData,
  ctx,
  &cluster);
}
 
// Computes global position and errors for SCT cluster.
// Called by SCT Clustering tools
//
// Input parameters
// - the cluster Identifier
// - the position in local reference frame
// - the list of identifiers of the Raw Data Objects belonging to the cluster
// - the width of the cluster
// - the module the cluster belongs to
// - the error strategy, currently
//    0: Cluster Width/sqrt(12.)
//    1: Set to a different values for one and two-strip clusters (def.)
// The scale factors were derived by the study reported on 25th September 2006.
// https://indico.cern.ch/event/430391/contributions/1066157/attachments/929942/1317007/SCTSoft_25Sept06_clusters.pdf
 
SCT_Cluster
ClusterMakerTool::sctCluster(const Identifier& clusterID,
                             const Amg::Vector2D& localPos,
                             std::vector<Identifier>&& rdoList,
                             const SiWidth& width,
                             const InDetDD::SiDetectorElement* element,
                             int errorStrategy) const
{
 
  double shift =
    m_sctLorentzAngleTool->getLorentzShift(element->identifyHash(), Gaudi::Hive::currentContext());
  Amg::Vector2D locpos(localPos[Trk::locX] + shift, localPos[Trk::locY]);
 
  // error matrix
  const Amg::Vector2D& colRow = width.colRow(); // made ref to avoid
                                                // unnecessary copy EJWM
 
  auto errorMatrix = Amg::MatrixX(2,2);
    errorMatrix.setIdentity();
 
    // switches are more readable **OPT**
    // actually they're slower as well (so I'm told) so perhaps
    // this should be re-written at some point EJWM
 
    switch (errorStrategy){
    case 0:
      errorMatrix.fillSymmetric(0,0,square(width.phiR())*ONE_TWELFTH);
      errorMatrix.fillSymmetric(1,1,square(width.z())*ONE_TWELFTH);
      break;
    case 1:
      // mat(1,1) = pow(width.phiR()/colRow.x(),2)/12;
      // single strip - resolution close to pitch/sqrt(12)
      // two-strip hits: better resolution, approx. 40% lower
      if(colRow.x() == 1){
        errorMatrix.fillSymmetric(0,0,square(1.05*width.phiR())*ONE_TWELFTH);
      }
      else if(colRow.x() == 2){
        errorMatrix.fillSymmetric(0,0,square(0.27*width.phiR())*ONE_TWELFTH);
      }
      else{
        errorMatrix.fillSymmetric(0,0,square(width.phiR())*ONE_TWELFTH);
      }
      errorMatrix.fillSymmetric(1,1,square(width.z()/colRow.y())*ONE_TWELFTH);
      break;
    default:
      // single strip - resolution close to pitch/sqrt(12)
      // two-strip hits: better resolution, approx. 40% lower
      if(colRow.x() == 1){
        errorMatrix.fillSymmetric(0,0,square(width.phiR())*ONE_TWELFTH);
      }
      else if(colRow.x() == 2){
        errorMatrix.fillSymmetric(0,0,square(0.27*width.phiR())*ONE_TWELFTH);
      }
      else{
        errorMatrix.fillSymmetric(0,0,square(width.phiR())*ONE_TWELFTH);
      }
      errorMatrix.fillSymmetric(1,1,square(width.z()/colRow.y())*ONE_TWELFTH);
      break;
    }
 
  auto designShape = element->design().shape();
    // rotation for endcap SCT
    if(designShape == InDetDD::Trapezoid || designShape == InDetDD::Annulus) {
          double sn      = element->sinStereoLocal(localPos);
          double sn2     = sn*sn;
          double cs2     = 1.-sn2;
          double w       = element->phiPitch(localPos)/element->phiPitch();
          double v0      = (errorMatrix)(0,0)*w*w;
          double v1      = (errorMatrix)(1,1);
          errorMatrix.fillSymmetric(0,0,cs2*v0+sn2*v1);
          errorMatrix.fillSymmetric(0,1,sn*sqrt(cs2)*(v0-v1));
          errorMatrix.fillSymmetric(1,1,sn2*v0+cs2*v1);
    } //else if (designShape == InDetDD::PolarAnnulus) {// Polar rotation for endcap}
 
  return SCT_Cluster(clusterID, locpos, std::move(rdoList), width, element, std::move(errorMatrix));
 
}
 
//---------------------------------------------------------------------------
// CTB parameterization, B field off
double ClusterMakerTool::getPixelCTBPhiError(int layer, int phi,
                                 int phiClusterSize) const{
 
 double sigmaL0Phi1[3] = { 8.2*micrometer,  9.7*micrometer, 14.6*micrometer};
 double sigmaL1Phi1[3] = {14.6*micrometer,  9.3*micrometer, 14.6*micrometer};
 double sigmaL2Phi1[3] = {14.6*micrometer,  8.6*micrometer, 14.6*micrometer};
 double sigmaL0Phi0[3] = {14.6*micrometer, 13.4*micrometer, 13.0*micrometer};
 double sigmaL1Phi0[3] = {14.6*micrometer,  8.5*micrometer, 11.0*micrometer};
 double sigmaL2Phi0[3] = {14.6*micrometer, 11.6*micrometer,  9.3*micrometer};
 
 if(phiClusterSize > 3) return 14.6*micrometer;
 
 if(layer == 0 && phi == 0) return sigmaL0Phi0[phiClusterSize-1];
 if(layer == 1 && phi == 0) return sigmaL1Phi0[phiClusterSize-1];
 if(layer == 2 && phi == 0) return sigmaL2Phi0[phiClusterSize-1];
 if(layer == 0 && phi == 1) return sigmaL0Phi1[phiClusterSize-1];
 if(layer == 1 && phi == 1) return sigmaL1Phi1[phiClusterSize-1];
 if(layer == 2 && phi == 1) return sigmaL2Phi1[phiClusterSize-1];
 
 // shouldn't really happen...
 ATH_MSG_WARNING("Unexpected layer and phi numbers: layer = "
                 << layer << " and phi = " << phi);
 return 14.6*micrometer;
 
}
 
}