migrate theta-module readout and related code to k4geo (#59)

* k4geo migration * update comments in includes * k4geo migration * k4geo migration * fix headers * add theta-based readout for HCAL * retrieve only tools with names set * remove legacy code for nested volumes * make HCal positioning tool empty by default so that code tries to retrieve them only if specified by user - i.e. not needed for ECAL-only clustering * remove debug printout * restore original code
HEP-FCC · Dec 13, 2023 · 1db533f · 1db533f
1 parent 9666b9f
commit 1db533f
Show file tree

Hide file tree

Showing 79 changed files with 864 additions and 768 deletions.
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -27,7 +27,7 @@ find_package(Gaudi)
 find_package(k4FWCore) # implicit: Gaudi
 find_package(EDM4HEP 0.10.1) # implicit: Podio
 find_package(DD4hep)
-find_package(FCCDetectors)
+find_package(k4geo)
 #---------------------------------------------------------------
 
 

diff --git a/README.md b/README.md
@@ -12,5 +12,5 @@ source /cvmfs/sw-nightlies.hsf.org/key4hep/setup.sh
 * EDM4HEP
 * k4FWCore
 * DD4hep
-* FCCDetectors
-* FCC-EDM (will be replaced by EDM4HEP)
+* k4geo
+
diff --git a/RecCalorimeter/CMakeLists.txt b/RecCalorimeter/CMakeLists.txt
@@ -15,8 +15,8 @@ gaudi_add_module(k4RecCalorimeterPlugins
                       EDM4HEP::edm4hep
                       ROOT::Core
                       ROOT::Hist
-                      FCCDetectors::DetSegmentation
-                      FCCDetectors::DetCommon
+                      k4geo::detectorSegmentations
+                      k4geo::detectorCommon
                       )
 
 install(TARGETS k4RecCalorimeterPlugins

diff --git a/RecCalorimeter/src/components/CalibrateCaloHitsTool.h b/RecCalorimeter/src/components/CalibrateCaloHitsTool.h
@@ -4,7 +4,7 @@
 // from Gaudi
 #include "GaudiAlg/GaudiTool.h"
 
-// FCCSW
+// k4FWCore
 #include "k4Interface/ICalibrateCaloHitsTool.h"
 
 #include <vector>

diff --git a/RecCalorimeter/src/components/CalibrateInLayersTool.cpp b/RecCalorimeter/src/components/CalibrateInLayersTool.cpp
@@ -1,6 +1,6 @@
 #include "CalibrateInLayersTool.h"
 
-// FCCSW
+// k4FWCore
 #include "k4Interface/IGeoSvc.h"
 
 // DD4hep

diff --git a/RecCalorimeter/src/components/CalibrateInLayersTool.h b/RecCalorimeter/src/components/CalibrateInLayersTool.h
@@ -5,7 +5,7 @@
 #include "GaudiAlg/GaudiTool.h"
 #include "GaudiKernel/ServiceHandle.h"
 
-// FCCSW
+// k4FWCore
 #include "k4Interface/ICalibrateCaloHitsTool.h"
 class IGeoSvc;
 

diff --git a/RecCalorimeter/src/components/CaloTopoCluster.cpp b/RecCalorimeter/src/components/CaloTopoCluster.cpp
@@ -1,10 +1,12 @@
 #include "CaloTopoCluster.h"
 #include "NoiseCaloCellsFromFileTool.h"
 
-// FCCSW
-#include "DetCommon/DetUtils.h"
+// k4FWCore
 #include "k4Interface/IGeoSvc.h"
 
+// k4geo
+#include "detectorCommon/DetUtils_k4geo.h"
+
 // datamodel
 #include "edm4hep/Cluster.h"
 #include "edm4hep/ClusterCollection.h"

diff --git a/RecCalorimeter/src/components/CaloTopoCluster.h b/RecCalorimeter/src/components/CaloTopoCluster.h
@@ -5,7 +5,7 @@
 #include "GaudiAlg/GaudiAlgorithm.h"
 #include "GaudiKernel/ToolHandle.h"
 
-// FCCSW
+// k4FWCore
 #include "k4FWCore/DataHandle.h"
 #include "k4Interface/ICaloReadCellNoiseMap.h"
 #include "k4Interface/ICaloReadNeighboursMap.h"

diff --git a/RecCalorimeter/src/components/CaloTopoClusterInputTool.cpp b/RecCalorimeter/src/components/CaloTopoClusterInputTool.cpp
@@ -1,9 +1,9 @@
 #include "CaloTopoClusterInputTool.h"
 
-// FCCSW
+// k4FWCore
 #include "k4Interface/IGeoSvc.h"
 
-// datamodel
+// edm4hep
 #include "edm4hep/CalorimeterHit.h"
 #include "edm4hep/CalorimeterHitCollection.h"
 

diff --git a/RecCalorimeter/src/components/CaloTopoClusterInputTool.h b/RecCalorimeter/src/components/CaloTopoClusterInputTool.h
@@ -3,7 +3,7 @@
 // from Gaudi
 #include "GaudiAlg/GaudiTool.h"
 
-// FCCSW
+// k4FWCore
 #include "k4FWCore/DataHandle.h"
 #include "k4Interface/ITopoClusterInputTool.h"
 
@@ -77,7 +77,8 @@ class CaloTopoClusterInputTool : public GaudiTool, virtual public ITopoClusterIn
   Gaudi::Property<std::string> m_ecalEndcapReadoutName{this, "ecalEndcapReadoutName", "",
                                                       "name of the ecal endcap readout"};
   /// Name of the ecal forward calorimeter readout
-  Gaudi::Property<std::string> m_ecalFwdReadoutName{this, "ecalFwdReadoutName", "", "name of the ecal fwd readout"};
+  Gaudi::Property<std::string> m_ecalFwdReadoutName{this, "ecalFwdReadoutName", "",
+                                                    "name of the ecal fwd readout"};
   /// Name of the hadronic barrel readout
   Gaudi::Property<std::string> m_hcalBarrelReadoutName{this, "hcalBarrelReadoutName", "",
                                                        "name of the hcal barrel readout"};

diff --git a/RecCalorimeter/src/components/CaloTowerTool.cpp b/RecCalorimeter/src/components/CaloTowerTool.cpp
@@ -1,9 +1,9 @@
 #include "CaloTowerTool.h"
 
-// FCCSW
+// k4FWCore
 #include "k4Interface/IGeoSvc.h"
 
-// datamodel
+// edm4hep
 #include "edm4hep/CalorimeterHitCollection.h"
 #include "edm4hep/Cluster.h"
 #include "edm4hep/MutableCluster.h"
@@ -113,12 +113,12 @@ StatusCode CaloTowerTool::finalize() {
 std::pair<double, double> CaloTowerTool::retrievePhiEtaExtrema(dd4hep::DDSegmentation::Segmentation* aSegmentation, SegmentationType aType) {
   double phiMax = -1;
   double etaMax = -1;
-  dd4hep::DDSegmentation::FCCSWGridPhiEta* segmentation = nullptr;
+  dd4hep::DDSegmentation::FCCSWGridPhiEta_k4geo* segmentation = nullptr;
   if (aSegmentation != nullptr) {
     switch (aType) {
     case SegmentationType::kPhiEta: {
       info() << "== Retrieving phi-eta segmentation " << aSegmentation->name() << endmsg;
-      segmentation = dynamic_cast<dd4hep::DDSegmentation::FCCSWGridPhiEta*>(aSegmentation);
+      segmentation = dynamic_cast<dd4hep::DDSegmentation::FCCSWGridPhiEta_k4geo*>(aSegmentation);
       phiMax = fabs(segmentation->offsetPhi()) + M_PI / (double)segmentation->phiBins();
       etaMax = fabs(segmentation->offsetEta()) + segmentation->gridSizeEta() * 0.5;
       break;
@@ -128,7 +128,7 @@ std::pair<double, double> CaloTowerTool::retrievePhiEtaExtrema(dd4hep::DDSegment
       double eta = -1;
       info() << "== Retrieving multi segmentation " << aSegmentation->name() << endmsg;
       for (const auto& subSegm: dynamic_cast<dd4hep::DDSegmentation::MultiSegmentation*>(aSegmentation)->subSegmentations()) {
-        segmentation = dynamic_cast<dd4hep::DDSegmentation::FCCSWGridPhiEta*>(subSegm.segmentation);
+        segmentation = dynamic_cast<dd4hep::DDSegmentation::FCCSWGridPhiEta_k4geo*>(subSegm.segmentation);
         phi = fabs(segmentation->offsetPhi()) + M_PI / (double)segmentation->phiBins();
         eta = fabs(segmentation->offsetEta()) + segmentation->gridSizeEta() * 0.5;
         if (eta > etaMax) { etaMax = eta;}
@@ -320,10 +320,10 @@ void CaloTowerTool::CellsIntoTowers(std::vector<std::vector<float>>& aTowers,
   float fracEtaMin = 1.0, fracEtaMax = 1.0, fracEtaMiddle = 1.0;
   float fracPhiMin = 1.0, fracPhiMax = 1.0, fracPhiMiddle = 1.0;
   float epsilon = 0.0001;
-  const dd4hep::DDSegmentation::FCCSWGridPhiEta* segmentation = nullptr;
+  const dd4hep::DDSegmentation::FCCSWGridPhiEta_k4geo* segmentation = nullptr;
   const dd4hep::DDSegmentation::MultiSegmentation* multisegmentation = nullptr;
   if( aType == SegmentationType::kPhiEta) {
-      segmentation = dynamic_cast<const dd4hep::DDSegmentation::FCCSWGridPhiEta*>(aSegmentation);
+      segmentation = dynamic_cast<const dd4hep::DDSegmentation::FCCSWGridPhiEta_k4geo*>(aSegmentation);
   } else if( aType == SegmentationType::kMulti) {
     multisegmentation = dynamic_cast<const dd4hep::DDSegmentation::MultiSegmentation*>(aSegmentation);
   }
@@ -332,7 +332,7 @@ void CaloTowerTool::CellsIntoTowers(std::vector<std::vector<float>>& aTowers,
     pass = true;
     // if multisegmentation is used - first find out which segmentation to use
     if( aType == SegmentationType::kMulti) {
-      segmentation = dynamic_cast<const dd4hep::DDSegmentation::FCCSWGridPhiEta*>(&multisegmentation->subsegmentation(cell.getCellID()));
+      segmentation = dynamic_cast<const dd4hep::DDSegmentation::FCCSWGridPhiEta_k4geo*>(&multisegmentation->subsegmentation(cell.getCellID()));
     }
     if (m_useHalfTower) {
         uint layerId = m_decoder->get(cell.getCellID(), "layer");
@@ -416,7 +416,7 @@ std::pair<dd4hep::DDSegmentation::Segmentation*, CaloTowerTool::SegmentationType
     info() << "Readout does not exist! Please check if it is correct. Processing without it." << endmsg;
   } else {
     info() << "Readout " << aReadoutName << " found." << endmsg;
-    segmentation = dynamic_cast<dd4hep::DDSegmentation::FCCSWGridPhiEta*>(
+    segmentation = dynamic_cast<dd4hep::DDSegmentation::FCCSWGridPhiEta_k4geo*>(
       m_geoSvc->getDetector()->readout(aReadoutName).segmentation().segmentation());
     if (segmentation == nullptr) {
       segmentation = dynamic_cast<dd4hep::DDSegmentation::MultiSegmentation*>(
@@ -427,7 +427,7 @@ std::pair<dd4hep::DDSegmentation::Segmentation*, CaloTowerTool::SegmentationType
         // check if multisegmentation contains only phi-eta sub-segmentations
         dd4hep::DDSegmentation::Segmentation* subsegmentation = nullptr;
         for (const auto& subSegm: dynamic_cast<dd4hep::DDSegmentation::MultiSegmentation*>(segmentation)->subSegmentations()) {
-          subsegmentation = dynamic_cast<dd4hep::DDSegmentation::FCCSWGridPhiEta*>(subSegm.segmentation);
+          subsegmentation = dynamic_cast<dd4hep::DDSegmentation::FCCSWGridPhiEta_k4geo*>(subSegm.segmentation);
           if (subsegmentation == nullptr) {
             error() << "At least one of the sub-segmentations in MultiSegmentation named " << aReadoutName << " is not a phi-eta grid." << endmsg;
             return std::make_pair(nullptr, SegmentationType::kWrong);

diff --git a/RecCalorimeter/src/components/CaloTowerTool.h b/RecCalorimeter/src/components/CaloTowerTool.h
@@ -4,20 +4,16 @@
 // from Gaudi
 #include "GaudiAlg/GaudiTool.h"
 
-// FCCSW
-#include "DetSegmentation/FCCSWGridPhiEta.h"
+// k4geo
+#include "detectorSegmentations/FCCSWGridPhiEta_k4geo.h"
+
+// k4FWCore
 #include "k4FWCore/DataHandle.h"
 #include "k4Interface/ITowerTool.h"
-
 class IGeoSvc;
-#include "DDSegmentation/MultiSegmentation.h"
 
-// datamodel
-namespace edm4hep {
-class CalorimeterHitCollection;
-class CalorimeterHit;
-class Cluster;
-}
+// dd4hep
+#include "DDSegmentation/MultiSegmentation.h"
 
 namespace dd4hep {
 namespace DDSegmentation {
@@ -26,6 +22,14 @@ class BitFieldCoder;
 }
 }
 
+// edm4hep
+namespace edm4hep {
+class CalorimeterHitCollection;
+class CalorimeterHit;
+class Cluster;
+}
+
+
 /** @class CaloTowerTool Reconstruction/RecCalorimeter/src/components/CaloTowerTool.h
  * CaloTowerTool.h
  *

diff --git a/RecCalorimeter/src/components/ConeSelection.cpp b/RecCalorimeter/src/components/ConeSelection.cpp
@@ -1,7 +1,7 @@
 #include "ConeSelection.h"
 
 // FCC Detectors
-#include "DetCommon/DetUtils.h"
+#include "detectorCommon/DetUtils_k4geo.h"
 
 // DD4hep
 #include "DD4hep/Detector.h"

diff --git a/RecCalorimeter/src/components/ConstNoiseTool.cpp b/RecCalorimeter/src/components/ConstNoiseTool.cpp
@@ -1,7 +1,9 @@
 #include "ConstNoiseTool.h"
 
-// FCCSW
-#include "DetCommon/DetUtils.h"
+// k4geo
+#include "detectorCommon/DetUtils_k4geo.h"
+
+// k4FWCore
 #include "k4Interface/IGeoSvc.h"
 
 // DD4hep

diff --git a/RecCalorimeter/src/components/ConstNoiseTool.h b/RecCalorimeter/src/components/ConstNoiseTool.h
@@ -5,8 +5,10 @@
 #include "GaudiAlg/GaudiTool.h"
 class IRndmGenSvc;
 
-// FCCSW
-#include "DetSegmentation/FCCSWGridPhiEta.h"
+// k4geo
+#include "detectorSegmentations/FCCSWGridPhiEta_k4geo.h"
+
+// k4FWCore
 #include "k4Interface/INoiseConstTool.h"
 class IGeoSvc;
 

diff --git a/RecCalorimeter/src/components/CorrectCaloClusters.cpp b/RecCalorimeter/src/components/CorrectCaloClusters.cpp
@@ -7,8 +7,8 @@
 #include "k4Interface/IGeoSvc.h"
 
 // FCC Detectors
-#include "DetCommon/DetUtils.h"
-#include "DetSegmentation/FCCSWGridPhiEta.h"
+#include "detectorCommon/DetUtils_k4geo.h"
+#include "detectorSegmentations/FCCSWGridPhiEta_k4geo.h"
 
 // DD4hep
 #include "DD4hep/Detector.h"

diff --git a/RecCalorimeter/src/components/CorrectCaloClusters.h b/RecCalorimeter/src/components/CorrectCaloClusters.h
@@ -29,7 +29,7 @@ namespace edm4hep {
 // DD4HEP
 namespace dd4hep {
   namespace DDSegmentation {
-    class FCCSWGridPhiEta;
+    class FCCSWGridPhiEta_k4geo;
     class MultiSegmentation;
     class BitFieldCoder;
   }

diff --git a/RecCalorimeter/src/components/CorrectECalBarrelSliWinCluster.cpp b/RecCalorimeter/src/components/CorrectECalBarrelSliWinCluster.cpp
@@ -1,28 +1,32 @@
 #include "CorrectECalBarrelSliWinCluster.h"
 
-// FCCSW
-#include "DetCommon/DetUtils.h"
+// k4geo
+#include "detectorCommon/DetUtils_k4geo.h"
+#include "detectorSegmentations/FCCSWGridPhiEta_k4geo.h"
+
+// k4FWCore
 #include "k4Interface/IGeoSvc.h"
-#include "DetSegmentation/FCCSWGridPhiEta.h"
+
+// Gaudi
 #include "GaudiKernel/ITHistSvc.h"
+#include "GaudiKernel/MsgStream.h"
 
 // DD4hep
 #include "DD4hep/Detector.h"
 #include "DDSegmentation/MultiSegmentation.h"
 
-// our EDM4HEP
+// edm4hep
 #include "edm4hep/Cluster.h"
 #include "edm4hep/ClusterCollection.h"
 #include "edm4hep/CalorimeterHitCollection.h"
 #include "edm4hep/MCParticleCollection.h"
 #include "edm4hep/VertexCollection.h"
 
-// Root
+// ROOT
 #include "TFile.h"
 #include "TLorentzVector.h"
 #include "TFitResult.h"
 #include "TGraphErrors.h"
-#include <GaudiKernel/MsgStream.h>
 
 DECLARE_COMPONENT(CorrectECalBarrelSliWinCluster)
 
@@ -147,7 +151,7 @@ StatusCode CorrectECalBarrelSliWinCluster::initialize() {
       return StatusCode::FAILURE;
     }
     // retrieve PhiEta segmentation
-    m_segmentationPhiEta[m_systemId[iSys]] = dynamic_cast<dd4hep::DDSegmentation::FCCSWGridPhiEta*>(
+    m_segmentationPhiEta[m_systemId[iSys]] = dynamic_cast<dd4hep::DDSegmentation::FCCSWGridPhiEta_k4geo*>(
         m_geoSvc->getDetector()->readout(m_readoutName[iSys]).segmentation().segmentation());
     m_segmentationMulti[m_systemId[iSys]] = dynamic_cast<dd4hep::DDSegmentation::MultiSegmentation*>(
         m_geoSvc->getDetector()->readout(m_readoutName[iSys]).segmentation().segmentation());
@@ -235,7 +239,7 @@ StatusCode CorrectECalBarrelSliWinCluster::execute() {
 
   // TODO change that so all systems can be used
   uint systemId = m_systemId[0];
-  const dd4hep::DDSegmentation::FCCSWGridPhiEta* segmentation = nullptr;
+  const dd4hep::DDSegmentation::FCCSWGridPhiEta_k4geo* segmentation = nullptr;
   if (m_segmentationPhiEta[systemId] != nullptr) {
     segmentation = m_segmentationPhiEta[systemId];
   }
@@ -267,7 +271,7 @@ StatusCode CorrectECalBarrelSliWinCluster::execute() {
     newCluster.setPosition(cluster.getPosition());
     for (auto cell = cluster.hits_begin(); cell != cluster.hits_end(); cell++) {
       if (m_segmentationMulti[systemId] != nullptr) {
-        segmentation = dynamic_cast<const dd4hep::DDSegmentation::FCCSWGridPhiEta*>(&m_segmentationMulti[systemId]->subsegmentation(cell->getCellID()));
+        segmentation = dynamic_cast<const dd4hep::DDSegmentation::FCCSWGridPhiEta_k4geo*>(&m_segmentationMulti[systemId]->subsegmentation(cell->getCellID()));
         oldEtaId = int(floor((oldEta + 0.5 * segmentation->gridSizeEta() - segmentation->offsetEta()) / segmentation->gridSizeEta()));
         oldPhiId = int(floor((oldPhi + 0.5 * segmentation->gridSizePhi() - segmentation->offsetPhi()) / segmentation->gridSizePhi()));
       }
@@ -319,7 +323,7 @@ StatusCode CorrectECalBarrelSliWinCluster::execute() {
     // repeat but calculating eta barycentre in each layer
     for (auto cell = newCluster.hits_begin(); cell != newCluster.hits_end(); cell++) {
       if (m_segmentationMulti[systemId] != nullptr) {
-        segmentation = dynamic_cast<const dd4hep::DDSegmentation::FCCSWGridPhiEta*>(&m_segmentationMulti[systemId]->subsegmentation(cell->getCellID()));
+        segmentation = dynamic_cast<const dd4hep::DDSegmentation::FCCSWGridPhiEta_k4geo*>(&m_segmentationMulti[systemId]->subsegmentation(cell->getCellID()));
       }
       dd4hep::DDSegmentation::CellID cID = cell->getCellID();
       uint layer = m_decoder[systemId]->get(cID, m_layerFieldName) + m_firstLayerId;

diff --git a/RecCalorimeter/src/components/CorrectECalBarrelSliWinCluster.h b/RecCalorimeter/src/components/CorrectECalBarrelSliWinCluster.h
@@ -22,7 +22,7 @@ class VertexCollection;
 
 namespace dd4hep {
 namespace DDSegmentation {
-class FCCSWGridPhiEta;
+class FCCSWGridPhiEta_k4geo;
 class MultiSegmentation;
 class BitFieldCoder;
 }
@@ -153,7 +153,7 @@ class CorrectECalBarrelSliWinCluster : public GaudiAlgorithm {
   Gaudi::Property<std::vector<std::string>> m_readoutName{
       this, "readoutName", {"ECalBarrelPhiEta"}, "Names of the detector readout, corresponding to systemId"};
   /// map of system Id to segmentation, created based on m_readoutName and m_systemId
-  std::map<uint, dd4hep::DDSegmentation::FCCSWGridPhiEta*> m_segmentationPhiEta;
+  std::map<uint, dd4hep::DDSegmentation::FCCSWGridPhiEta_k4geo*> m_segmentationPhiEta;
   std::map<uint, dd4hep::DDSegmentation::MultiSegmentation*> m_segmentationMulti;
   /// map of system Id to decoder, created based on m_readoutName and m_systemId
   std::map<uint, dd4hep::DDSegmentation::BitFieldCoder*> m_decoder;

diff --git a/RecCalorimeter/src/components/CreateCaloCells.cpp b/RecCalorimeter/src/components/CreateCaloCells.cpp
@@ -1,15 +1,17 @@
 #include "CreateCaloCells.h"
 
-// FCCSW
-#include "DetCommon/DetUtils.h"
+// k4geo
+#include "detectorCommon/DetUtils_k4geo.h"
+
+// k4FWCore
 #include "k4Interface/IGeoSvc.h"
 
 // DD4hep
 #include "DD4hep/Detector.h"
 #include "DD4hep/Volumes.h"
 #include "TGeoManager.h"
 
-// EDM4HEP
+// edm4hep
 #include "edm4hep/CalorimeterHit.h"
 
 DECLARE_COMPONENT(CreateCaloCells)