CaloBlueprintNodeBuilder.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2026 CERN for the benefit of the ATLAS collaboration
*/
 
#ifndef ACTSGEOMETRY_CALOBLUEPRINTNODEBUILDER_H
#define ACTSGEOMETRY_CALOBLUEPRINTNODEBUILDER_H
 
#include "ActsGeometryInterfaces/IBlueprintNodeBuilder.h"
#include "CaloDetDescr/CaloDetDescrManager.h"
 
#include "Acts/Surfaces/CylinderSurface.hpp"
#include "Acts/Surfaces/DiscSurface.hpp"
#include "Acts/Surfaces/Surface.hpp"
#include "CaloIdentifier/CaloCell_ID.h"
#include "CaloDetDescr/CaloDetDescrElement.h"
 
#include <map>
#include <string>
#include <vector>
#include <memory>
 
using caloSampleSurfaceMap_t = std::map<std::pair<std::string, CaloCell_ID::CaloSample>, std::vector<std::shared_ptr<Acts::Surface> > >;
using caloSampleDDEElementsMap_t = std::map<std::pair<std::string, CaloCell_ID::CaloSample>, std::vector<const CaloDetDescrElement*> >;
using caloDimensionMap_t = std::map<std::string, double>;
 
namespace ActsTrk {
 
    enum class caloRegion {DiscNegativeZ, DiscPositiveZ, CylinderSymmetricZZero, CylinderNegativeZ, CylinderPositiveZ};

    class CaloBlueprintNodeBuilder : public extends<AthAlgTool, IBlueprintNodeBuilder> {
    public:
        StatusCode initialize() override;
        StatusCode finalize() override;
        using base_class::base_class;

        std::shared_ptr<Acts::BlueprintNode> buildBlueprintNode(const Acts::GeometryContext& gctx,
                                      std::shared_ptr<Acts::BlueprintNode>&& childNode) override;
 
    private:

        void fillMaps(std::map<caloRegion, caloSampleSurfaceMap_t>& caloRegionSampleSurfaceMap,
                      std::map<caloRegion, caloSampleDDEElementsMap_t>& caloRegionSampleDDEElementsMap, std::map<std::string, double>& caloDimensions) const;

        void generateCylinderSurfaces(caloSampleSurfaceMap_t& caloSampleSurfaceMap, caloSampleDDEElementsMap_t& caloSampleDDEElementsMap, bool asymmetricZ) const;

        std::shared_ptr<Acts::CylinderSurface> generateCylinderSurface(const double& maxLArBRadius, const double& minLArBRadius, const double& lowZLarB, const double& highZLarB, bool asymmetricZ) const;

        void addCylindricalTrackingVolumeToCaloNode(Acts::CylinderContainerBlueprintNode& containerNode, const std::string& volumeName,const std::vector<std::shared_ptr<Acts::Surface>>& surfaces, int layerIndex,  const bool& isDisc) const;
 
        void generateDiscSurfaces(caloSampleSurfaceMap_t& caloSampleSurfaceMap, caloSampleDDEElementsMap_t& caloSampleDDEElementsMap) const;
 
        std::shared_ptr<Acts::DiscSurface> generateDiscSurface(const double& z, const double& maxLArBRadius, const double& minLArBRadius) const;
 
        std::unique_ptr<CaloDetDescrManager> m_caloDetSecrMgr;   
 
        //create lists from all possible calo samplings that tracks could hit
        //The first list is for disc shaped samples and the second for cylindrical shaped samples
        //Note that TileGap3 is the barrel, but is disk shaped. 
        std::vector<std::pair<std::string, CaloCell_ID::CaloSample>> m_caloDiscSampleList{
          {"PreSamplerE", CaloCell_ID::PreSamplerE},
          {"EME1",CaloCell_ID::EME1},
          {"EME2",CaloCell_ID::EME2},
          {"EME3",CaloCell_ID::EME3},
          {"HEC0",CaloCell_ID::HEC0},
          {"HEC1",CaloCell_ID::HEC1},
          {"HEC2",CaloCell_ID::HEC2}, 
          {"HEC3",CaloCell_ID::HEC3}, 
          {"TileGap3",CaloCell_ID::TileGap3},
          {"FCAL0",CaloCell_ID::FCAL0},
          {"FCAL1",CaloCell_ID::FCAL1},
          {"FCAL2",CaloCell_ID::FCAL2}};
 
        std::vector<std::pair<std::string, CaloCell_ID::CaloSample>> m_caloCylinderSymmetricSampleList{ 
          { "PreSamplerB", CaloCell_ID::PreSamplerB}, 
          {"EMB1", CaloCell_ID::EMB1},
          {"EMB2", CaloCell_ID::EMB2},
          {"EMB3", CaloCell_ID::EMB3},
          {"TileBar0", CaloCell_ID::TileBar0},
          {"TileBar1", CaloCell_ID::TileBar1},
          {"TileBar2", CaloCell_ID::TileBar2}};
 
        std::vector<std::pair<std::string, CaloCell_ID::CaloSample>> m_caloCylinderAsymmetricSampleList{ 
          {"TileGap1", CaloCell_ID::TileGap1},
          {"TileGap2", CaloCell_ID::TileGap2},
          {"TileExt0", CaloCell_ID::TileExt0},
          {"TileExt1", CaloCell_ID::TileExt1},
          {"TileExt2", CaloCell_ID::TileExt2}};
 
        Gaudi::Property<double> m_radiusTolerance { this
        , "RadiusTolerance"
        , 2.0
        , "Tolerance for determining if a ring of cells in phi has changed the radius w.r.t to the previous ring in phi" };
 
        Gaudi::Property<double> m_zTolerance { this
        , "ZTolerance"
        , 2.0
        , "Tolerance for determining if a ring of cells in phi has changed the z w.r.t to the previous ring in phi" };
 
    // TODO: Temporary function to get the sample name from the enum value.
    std::string getSampleName(CaloCell_ID::CaloSample currentSample) const {
      std::string sampleName = "";
      for ( auto& [name, sample] : m_caloCylinderSymmetricSampleList) {
        if (currentSample == sample) {
          sampleName = name;
          break;
        }
      }
      if (sampleName == "") {
        for ( auto& [name, sample] : m_caloCylinderAsymmetricSampleList) {
          if (currentSample == sample) {
            sampleName = name;
            break;
          }
        }
      }
      if (sampleName == "") {
        for ( auto& [name, sample] : m_caloDiscSampleList) {
          if (currentSample == sample) {
            sampleName = name;
            break;
          }
        }
      }
      return sampleName;
    }
    // TODO: Temporary function to get the sample enum value from the name.
    CaloCell_ID::CaloSample getSampleEnum(const std::string& sampleName) const {
      CaloCell_ID::CaloSample sampleEnum = CaloCell_ID::Unknown;
      for (auto& [name, sample] : m_caloCylinderSymmetricSampleList) {
        if (sampleName == name) {
          sampleEnum = sample;
          break;
        }
      }
      if (sampleEnum == CaloCell_ID::Unknown) {
        for (auto& [name, sample] : m_caloCylinderAsymmetricSampleList) {
          if (sampleName == name) {
            sampleEnum = sample;
            break;
          }
        }
      }
      if (sampleEnum == CaloCell_ID::Unknown) {
        for (auto& [name, sample] : m_caloDiscSampleList) {
          if (sampleName == name) {
            sampleEnum = sample;
            break;
          }
        }
      }
      return sampleEnum;
    }
 
 
  };
}
#endif