StripDetectorTool.cxx

Go to the documentation of this file.

/*
  Copyright (C) 2002-2026 CERN for the benefit of the ATLAS collaboration
*/
#include "StripDetectorTool.h"
#include "StripGmxInterface.h"
 
#include <SCT_ReadoutGeometry/SCT_DetectorManager.h>
#include <SCT_ReadoutGeometry/SCT_ModuleSideDesign.h>
 
#include <DetDescrConditions/AlignableTransformContainer.h>
#include <GeoModelKernel/GeoPhysVol.h>
#include <GeoModelUtilities/GeoModelExperiment.h>
#include <SGTools/DataProxy.h>
#include "GeoModelRead/ReadGeoModel.h"
 
 
namespace ITk
{
 
StripDetectorTool::StripDetectorTool(const std::string &type,
                                     const std::string &name,
                                     const IInterface *parent)
 : GeoModelXmlTool(type, name, parent)
{
}
 
 
StatusCode StripDetectorTool::create()
{
  // retrieve the common stuff
  ATH_CHECK(createBaseTool());
 
  GeoModelExperiment *theExpt = nullptr;
  ATH_CHECK(detStore()->retrieve(theExpt, "ATLAS"));
  const SCT_ID *idHelper = nullptr;
  ATH_CHECK(detStore()->retrieve(idHelper, "SCT_ID"));
 
  m_commonItems = std::make_unique<InDetDD::SiCommonItems>(idHelper);
 
 
  // If we are not taking the geo from sqlite, check the availability of tables 
  // (or that we have a local geometry)
  std::string node{"SCT"};
  std::string table{"ITKXDD"};
 
  GeoModelIO::ReadGeoModel* sqlreader = getSqliteReader();
 
  if(!sqlreader){
      if (!isAvailable(node, table)) {
        ATH_MSG_INFO("Trying new " << m_detectorName.value() << " database location.");
        node = "InnerDetector";
        table = "StripXDD";
        if (!isAvailable(node, table)) {
           ATH_MSG_ERROR("No ITk Strip geometry found. ITk Strip can not be built.");
           return StatusCode::FAILURE;
        }
      }
  }
  //
  // Create the detector manager
  //
  // The * converts a ConstPVLink to a ref to a GeoVPhysVol
  // The & takes the address of the GeoVPhysVol
  GeoPhysVol *world = &*theExpt->getPhysVol();
  auto *manager = new InDetDD::SCT_DetectorManager(&*detStore(), m_detectorName, m_doEndcapEtaNeighbour);
  manager->addFolder(m_alignmentFolderName);
 
  InDetDD::ITk::StripGmxInterface gmxInterface(manager, m_commonItems.get(), &m_waferTree);
  // Load the geometry, create the volume, 
  // node,table are the location in the DB to look for the clob
  // empty strings are the (optional) containing detector and envelope names
  // allowed to pass a null sqlreader ptr - it will be used to steer the source of the geometry
  const GeoVPhysVol* topVolume = createTopVolume(world, gmxInterface, node, table,"","",sqlreader);
  // if we are using SQLite inputs, 
  if(sqlreader){
        ATH_MSG_INFO("Building Strip Readout Geometry from SQLite using "<<m_geoDbTagSvc->getParamSvcName());
        gmxInterface.buildReadoutGeometryFromSqlite(m_sqliteReadSvc.operator->(),sqlreader);
  }
 
  if (topVolume) { //see that a valid pointer is returned
    manager->addTreeTop(topVolume);
    doNumerology(manager);
    manager->initNeighbours();
  } else {
    ATH_MSG_FATAL("Could not find the Top Volume!!!");
    return StatusCode::FAILURE;
  }
 
  // set the manager
  m_detManager = manager;
 
  ATH_CHECK(detStore()->record(m_detManager, m_detManager->getName()));
  theExpt->addManager(m_detManager);
 
  return StatusCode::SUCCESS;
}
 
 
StatusCode StripDetectorTool::clear()
{
  SG::DataProxy* proxy = detStore()->proxy(ClassID_traits<InDetDD::SCT_DetectorManager>::ID(),m_detManager->getName());
  if (proxy) {
    proxy->reset();
    m_detManager = nullptr;
  }
  return StatusCode::SUCCESS;
}
 
void StripDetectorTool::doNumerology(InDetDD::SCT_DetectorManager * manager)
{
  ATH_MSG_INFO("\n\nSCT Numerology:\n===============\n\nNumber of parts is " << m_waferTree.nParts() << "\n");
  InDetDD::SiNumerology n;
 
  bool barrelDone = false;
  for (int b = -1; b <= 1; ++b) {
    if (m_waferTree.count(b)) {
      msg(MSG::DEBUG) << "  Found barrel with index " << b << std::endl;
      n.addBarrel(b);
      if (!barrelDone) {
        n.setNumLayers(m_waferTree[b].nLayers());
        msg(MSG::DEBUG) << "    Number of barrel layers = " << n.numLayers() << std::endl;
        for (LayerDisk::iterator l = m_waferTree[b].begin(); l != m_waferTree[b].end(); ++l) {
          n.setNumEtaModulesForLayer(l->first, l->second.nEtaModules());
          // All staves within a layer are assumed identical, so we can just look at the first eta
          n.setNumPhiModulesForLayer(l->first, l->second.begin()->second.nPhiModules());
          msg(MSG::DEBUG) << "    layer = " << l->first << " has " << n.numEtaModulesForLayer(l->first)
                        << " etaModules each with " <<  n.numPhiModulesForLayer(l->first) << " phi modules" << std::endl;
        }
        barrelDone = true;
      }
    }
 
  }
 
  bool endcapDone = false;
  for (int ec = -2; ec <= 2; ec += 4) {
    if (m_waferTree.count(ec)) {
      msg(MSG::DEBUG) << "  Found endcap with index " << ec << std::endl;
      n.addEndcap(ec);
      if (!endcapDone) {
        n.setNumDisks(m_waferTree[ec].nLayers());
        msg(MSG::DEBUG) << "    Number of endcap wheels = " << n.numDisks() << std::endl;
        for (LayerDisk::iterator l = m_waferTree[ec].begin(); l != m_waferTree[ec].end(); ++l) {
          n.setNumRingsForDisk(l->first, l->second.nEtaModules());
          msg(MSG::DEBUG) << "    Wheel " << l->first << " has " << n.numRingsForDisk(l->first) << " rings" << std::endl;
          for (EtaModule::iterator eta = l->second.begin(); eta != l->second.end(); ++eta) {
            n.setNumPhiModulesForDiskRing(l->first, eta->first, eta->second.nPhiModules());
            msg(MSG::DEBUG) << "      Ring " << eta->first << " has "
                           << n.numPhiModulesForDiskRing(l->first, eta->first) << " phi modules" << std::endl;
          }
        }
        endcapDone = true;
      }
    }
  }
 
  msg(MSG::INFO) << endmsg;
 
  int totalWafers = 0;
  for (BarrelEndcap::iterator bec = m_waferTree.begin(); bec != m_waferTree.end(); ++bec) {
    for (LayerDisk::iterator ld = bec->second.begin(); ld != bec->second.end(); ++ld) {
      for (EtaModule::iterator eta = ld->second.begin(); eta != ld->second.end(); ++eta) {
        for (PhiModule::iterator phi = eta->second.begin(); phi != eta->second.end(); ++phi) {
          for (Side::iterator side =phi->second.begin(); side != phi->second.end(); ++side) {
            totalWafers++;
          }
        }
      }
    }
  }
  ATH_MSG_INFO("Total number of wafers added is " << totalWafers);
  const SCT_ID *sctIdHelper = static_cast<const SCT_ID *> (m_commonItems->getIdHelper());
  ATH_MSG_INFO("Total number of wafer identifiers is " << sctIdHelper->wafer_hash_max());
  //
  // Used in digitization to create one vector big enough to hold all strips, whichever detector is in consideration.
  // Anyway they are common to pixels and strips! Pixels dominate the EtaCell count (which traditionally the SCT does not set)
  //
  n.setMaxNumEtaCells(1);
  for (int d = 0; d < manager->numDesigns(); ++d) {
    n.setMaxNumPhiCells(manager->getSCT_Design(d)->cells());
  }
  ATH_MSG_INFO("Max. eta cells is " << n.maxNumEtaCells());
  ATH_MSG_INFO("Max. phi cells is " << n.maxNumPhiCells());
  ATH_MSG_INFO("Max. no. strips is " << n.maxNumStrips());
 
  manager->numerology() = std::move(n);
 
  ATH_MSG_INFO("End of numerology\n");
 
  //
  //  Alignment preparation
  //
  if (m_alignable) {
    ATH_MSG_INFO("Set up alignment directories");
    const std::string topFolder(m_alignmentFolderName);
    const std::string barrelBase("/SCTB");
    const std::string endcapBase("/SCTE");
    std::string baseName("");
 
    // Register the keys and the level corresponding to the key
    // and whether it expects a global or local shift.
    // level 0: sensor, level 1: module, level 2, layer/disc, level 3: whole barrel/enccap
    //Before the type was determined from content; would be better to just set it explcitly if we only expect one
    //Format for ITk strip. Set it to "static_run1" for the moment, since this is what exisits in the conditions
    //but this should be revisited in future
    InDetDD::AlignFolderType alignFolderType = InDetDD::static_run1 ;
    manager->addAlignFolderType(alignFolderType);
 
    switch (alignFolderType) {
    case InDetDD::static_run1:
      manager->addChannel(topFolder + "/ID", 3, InDetDD::global);
      manager->addChannel(topFolder + "/SCT",2, InDetDD::global);
      for (BarrelEndcap::iterator bec = m_waferTree.begin(); bec != m_waferTree.end(); ++bec) {
        switch (bec->first) {
        case -2:
          baseName = topFolder + endcapBase + "C";
        break;
        case 0:
          baseName = topFolder + barrelBase;
        break;
        case 2:
          baseName = topFolder + endcapBase + "A";
        break;
        default:
          ATH_MSG_FATAL("Unknown SCT part with bec-ID " << bec->first << " encountered.");
          throw std::runtime_error("Unknown ITkStrip part for alignment.");
        }
        for (LayerDisk::iterator ld = bec->second.begin(); ld != bec->second.end(); ++ld) {
          std::ostringstream layer;
          layer << ld->first + 1;
          manager->addChannel(baseName + layer.str(), 1, InDetDD::local);
        }
      }
    break;
    // To be added: case InDetDD::timedependent_run2:, see SCT_GeoModel
    default:
      ATH_MSG_FATAL("Alignment requested for unknown alignment folder type in StripDetectorFactory.");
      throw std::runtime_error("Wrong alignment folder type for StripDetectorFactory in StripGeoModelXml.");
    }
  }
 
  return;
}
 
 
} // namespace ITk