Service providing device detector description from JSON files. More...

#include <JSONDeviceDetectorDescriptionProviderSvc.h>

Inheritance diagram for ActsTrk::JSONDeviceDetectorDescriptionProviderSvc:

Collaboration diagram for ActsTrk::JSONDeviceDetectorDescriptionProviderSvc:

Public Member Functions
virtual StatusCode	initialize () override
	Function initializing and executing the file loading.
Athena<->detray ID map accessors for EDM converters
virtual const std::unordered_map< uint64_t, Identifier > &	detrayToAthenaMap () const override
virtual const std::unordered_map< Identifier, uint64_t > &	athenaToDetrayMap () const override

Private Member Functions
StatusCode	loadIdMaps ()
	Helper function to load Athena<->detray ID maps from csv.

Private Attributes
ServiceHandle< StoreGateSvc >	m_detStore {this, "DetectorStore", "StoreGateSvc/DetectorStore"}
std::unordered_map< uint64_t, Identifier >	m_detrayToAthena
std::unordered_map< Identifier, uint64_t >	m_athenaToDetray
The host and device memory resources tool to use for memory allocations
ToolHandle< AthDevice::IMemoryResourcesTool >	m_MRs
ToolHandle< AthDevice::ICopyTool >	m_copy
	The copy tool used for copying data to device.
The input JSON file names, path resolved with PathResolver
Gaudi::Property< std::string >	m_geometryFile
Gaudi::Property< std::string >	m_digitizationFile
Gaudi::Property< std::string >	m_conditionsFile
Gaudi::Property< std::string >	m_mapFile
The output object names
Gaudi::Property< std::string >	m_deviceDesignObjectName
Gaudi::Property< std::string >	m_deviceCondObjectName
Gaudi::Property< std::string >	m_hostDesignObjectName
Gaudi::Property< std::string >	m_hostCondObjectName
Gaudi::Property< std::string >	m_deviceDetectorName
Gaudi::Property< std::string >	m_hostDetectorName

Detailed Description

Service providing device detector description from JSON files.

This service loads detector description data from JSON files, which are needed for executing track reconstruction on GPU. The service provides the following data:

JSON geometry file -> detray geometry (required)
JSON digitization file -> traccc digitization config (required)
JSON conditions file -> traccc conditions config (required)
CSV map file -> athena<->detray ID map (required)

To be added in the future (only needed in track reco on device):

JSON material file -> detray material (optional)
JSON surface grid file -> detray surface grid (optional)
CVF magnetic field -> covfie magnetic field (required)

All objects are recorded to detector store as pointers to device objects, apart from the athena<->detray ID map. Additionally the digitization and conditions objects are stored in detector store as host objects, which are needed for EDM conversions.

Author: Neža Ribarič neza..nosp@m.riba.nosp@m.ric@c.nosp@m.ern..nosp@m.ch

Definition at line 61 of file JSONDeviceDetectorDescriptionProviderSvc.h.

Member Function Documentation

◆ athenaToDetrayMap()

const std::unordered_map< Identifier, uint64_t > & ActsTrk::JSONDeviceDetectorDescriptionProviderSvc::athenaToDetrayMap ( ) const

overridevirtual

Definition at line 122 of file JSONDeviceDetectorDescriptionProviderSvc.cxx.

                                                                                                                {
 return m_athenaToDetray;
}

◆ detrayToAthenaMap()

const std::unordered_map< uint64_t, Identifier > & ActsTrk::JSONDeviceDetectorDescriptionProviderSvc::detrayToAthenaMap ( ) const

overridevirtual

Definition at line 118 of file JSONDeviceDetectorDescriptionProviderSvc.cxx.

                                                                                                                {
 return m_detrayToAthena;
}

◆ initialize()

StatusCode ActsTrk::JSONDeviceDetectorDescriptionProviderSvc::initialize ( )

overridevirtual

Function initializing and executing the file loading.

Definition at line 26 of file JSONDeviceDetectorDescriptionProviderSvc.cxx.

{
  ATH_MSG_DEBUG("Initializing  device detector description provider service ");
 
  ATH_CHECK(m_MRs.retrieve());
  ATH_CHECK(m_copy.retrieve());
  ATH_CHECK(loadIdMaps());
 
  auto hostDesign = std::make_unique<traccc::detector_design_description::host>(*m_MRs->hostMR());
  auto hostCond   = std::make_unique<traccc::detector_conditions_description::host>(*m_MRs->hostMR());
 
  std::unique_ptr<traccc::detector_design_description::buffer>     deviceDesign;
  std::unique_ptr<traccc::detector_conditions_description::buffer> deviceCond; 
 
  auto copy = m_copy->copy(EventContext{});
 
  if (m_geometryFile.value().empty() ||
      m_digitizationFile.value().empty() ||
      m_conditionsFile.value().empty()) {
    ATH_MSG_FATAL("GeometryFile, " << m_geometryFile.value() <<
                            ", DigitizationFile, " << m_digitizationFile.value() << " or ConditionsFile, " << m_conditionsFile.value() << ", is empty!");
    return StatusCode::FAILURE;
  }
 
  ATH_MSG_INFO("Reading detector description from files:"
      << "  geometry:     " << m_geometryFile.value()
      << ",  digitization: " << m_digitizationFile.value()
      << ",  conditions:   " << m_conditionsFile.value());
 
  // Construct detector geometry
  ATH_MSG_INFO("Loading traccc detector");
  auto hostDetector = std::make_unique<traccc::host_detector>();
  traccc::io::read_detector(
      *hostDetector, *m_MRs->hostMR(),
      PathResolverFindCalibFile(m_geometryFile.value()));
 
  auto deviceDetector =
        std::make_unique<traccc::detector_buffer>(traccc::buffer_from_host_detector(*hostDetector, m_MRs->mainMR(), const_cast<vecmem::copy&>(*copy)));
  
  // Construct detector description
  traccc::io::read_detector_description(
      *hostDesign, *hostCond,
      PathResolverFindCalibFile(m_geometryFile.value()),
      PathResolverFindCalibFile(m_digitizationFile.value()),
      PathResolverFindCalibFile(m_conditionsFile.value()),
      traccc::data_format::json);
 
  ATH_MSG_DEBUG(hostDesign->size() << " design entries, "
                << hostCond->size() << " conditions entries");
 
  // Copy design to device
  std::vector<unsigned int> sizes;
  sizes.reserve(hostDesign->size());
  for (std::size_t i = 0; i < hostDesign->size(); ++i) {
    const auto& e = hostDesign->at(i);
    sizes.push_back(static_cast<unsigned int>(
        std::max(e.bin_edges_x().size(), e.bin_edges_y().size())));
  }
 
  deviceDesign =
        std::make_unique<traccc::detector_design_description::buffer>(
          sizes, m_MRs->mainMR(), m_MRs->hostMR(),
          vecmem::data::buffer_type::resizable);
  (*copy).setup(*deviceDesign)->wait();
  (*copy)(vecmem::get_data(*hostDesign), *deviceDesign)->wait();
 
  // Copy conditions to device
  deviceCond =
      std::make_unique<traccc::detector_conditions_description::buffer>(
          static_cast<traccc::detector_conditions_description::buffer::size_type>(
              hostCond->size()),
          m_MRs->mainMR());
  (*copy).setup(*deviceCond)->wait();
  (*copy)(vecmem::get_data(*hostCond), *deviceCond)->wait();
 
  ATH_MSG_INFO("Detector description built from files");
 
  // Record device and host objects
  // Host objects are needed for EDM conversions
  constexpr bool allowMods = false;
  ATH_CHECK(m_detStore->record(std::move(deviceDesign), m_deviceDesignObjectName.value(), allowMods));
  ATH_CHECK(m_detStore->record(std::move(deviceCond), m_deviceCondObjectName.value(), allowMods));
  ATH_CHECK(m_detStore->record(std::move(hostDesign), m_hostDesignObjectName.value(), allowMods));
  ATH_CHECK(m_detStore->record(std::move(hostCond), m_hostCondObjectName.value(), allowMods));
 
  ATH_CHECK(m_detStore->record(std::move(deviceDetector), m_deviceDetectorName.value(), allowMods));
  ATH_CHECK(m_detStore->record(std::move(hostDetector), m_hostDetectorName.value(), allowMods));
 
  ATH_MSG_DEBUG("Successfully initialized");
  return StatusCode::SUCCESS;
}

◆ loadIdMaps()

StatusCode ActsTrk::JSONDeviceDetectorDescriptionProviderSvc::loadIdMaps ( )

private

Helper function to load Athena<->detray ID maps from csv.

Definition at line 126 of file JSONDeviceDetectorDescriptionProviderSvc.cxx.

{
  if (m_mapFile.value().empty()) {
    ATH_MSG_FATAL("MapFile not set — detray<->Athena maps will be empty");
    return StatusCode::FAILURE;
  }
 
  ATH_MSG_INFO("Loading detray<->Athena map from "
                       << m_mapFile.value());
 
  std::ifstream mapFile(PathResolverFindCalibFile(m_mapFile.value()));
  if (!mapFile.is_open()) {
    ATH_MSG_FATAL("Cannot open map file: " << m_mapFile.value());
    return StatusCode::FAILURE;
  }
 
  std::string line;
  while (std::getline(mapFile, line)) {
    if (line.empty()) continue;
    std::stringstream ss(line);
    std::string athenaStr, detrayStr;
    if (!std::getline(ss, athenaStr, ',') ||
        !std::getline(ss, detrayStr, ',')) continue;
 
    if (athenaStr.empty()) {
        ATH_MSG_ERROR("Empty Athena identifier string in map file — skipping");
        return StatusCode::FAILURE;
    }
    Identifier athenaId;
    athenaId.set(athenaStr);
 
    uint64_t detrayId = 0;
    try {
        detrayId = std::stoull(detrayStr);
    } catch (const std::exception& e) {
        ATH_MSG_ERROR("Failed to parse detray identifier '" << detrayStr << "': " << e.what());
        return StatusCode::FAILURE;
    }
 
    m_athenaToDetray[athenaId] = detrayId;
    m_detrayToAthena[detrayId] = athenaId;
  }
 
  ATH_MSG_INFO("Loaded " << m_athenaToDetray.size()
                       << " detray<->Athena module mappings");
  return StatusCode::SUCCESS;
}

Member Data Documentation

◆ m_athenaToDetray

std::unordered_map<Identifier, uint64_t> ActsTrk::JSONDeviceDetectorDescriptionProviderSvc::m_athenaToDetray

private

Definition at line 133 of file JSONDeviceDetectorDescriptionProviderSvc.h.

◆ m_conditionsFile

Gaudi::Property<std::string> ActsTrk::JSONDeviceDetectorDescriptionProviderSvc::m_conditionsFile

private

Initial value:

{
        this, "ConditionsFile", "",
        "Traccc conditions config JSON file"}

Definition at line 99 of file JSONDeviceDetectorDescriptionProviderSvc.h.

                                             {
        this, "ConditionsFile", "",
        "Traccc conditions config JSON file"};

◆ m_copy

ToolHandle<AthDevice::ICopyTool> ActsTrk::JSONDeviceDetectorDescriptionProviderSvc::m_copy

private

Initial value:

{

this, "CopyProviderTool", "", "Vecmem copy provider tool"}

The copy tool used for copying data to device.

Definition at line 88 of file JSONDeviceDetectorDescriptionProviderSvc.h.

88 {

89 this, "CopyProviderTool", "", "Vecmem copy provider tool"};

◆ m_detrayToAthena

std::unordered_map<uint64_t, Identifier> ActsTrk::JSONDeviceDetectorDescriptionProviderSvc::m_detrayToAthena

private

Definition at line 132 of file JSONDeviceDetectorDescriptionProviderSvc.h.

◆ m_detStore

ServiceHandle<StoreGateSvc> ActsTrk::JSONDeviceDetectorDescriptionProviderSvc::m_detStore {this, "DetectorStore", "StoreGateSvc/DetectorStore"}

private

Definition at line 81 of file JSONDeviceDetectorDescriptionProviderSvc.h.

81{this, "DetectorStore", "StoreGateSvc/DetectorStore"};

◆ m_deviceCondObjectName

Gaudi::Property<std::string> ActsTrk::JSONDeviceDetectorDescriptionProviderSvc::m_deviceCondObjectName

private

Initial value:

{
        this, "DeviceConditionsObjectName", "",
        "Traccc device conditions object"}

Definition at line 112 of file JSONDeviceDetectorDescriptionProviderSvc.h.

                                                   {
        this, "DeviceConditionsObjectName", "",
        "Traccc device conditions object"};

◆ m_deviceDesignObjectName

Gaudi::Property<std::string> ActsTrk::JSONDeviceDetectorDescriptionProviderSvc::m_deviceDesignObjectName

private

Initial value:

{
        this, "DeviceDigitizationObjectName", "",
        "Traccc device digitization object"}

Definition at line 109 of file JSONDeviceDetectorDescriptionProviderSvc.h.

                                                     {
        this, "DeviceDigitizationObjectName", "",
        "Traccc device digitization object"};

◆ m_deviceDetectorName

Gaudi::Property<std::string> ActsTrk::JSONDeviceDetectorDescriptionProviderSvc::m_deviceDetectorName

private

Initial value:

{
        this, "DeviceDetectorName", "",
        "Detray device detector object"}

Definition at line 121 of file JSONDeviceDetectorDescriptionProviderSvc.h.

                                                 {
        this, "DeviceDetectorName", "",
        "Detray device detector object"};

◆ m_digitizationFile

Gaudi::Property<std::string> ActsTrk::JSONDeviceDetectorDescriptionProviderSvc::m_digitizationFile

private

Initial value:

{
        this, "DigitizationFile", "",
        "Traccc digitization config JSON file"}

Definition at line 96 of file JSONDeviceDetectorDescriptionProviderSvc.h.

                                               {
        this, "DigitizationFile", "",
        "Traccc digitization config JSON file"};

◆ m_geometryFile

Gaudi::Property<std::string> ActsTrk::JSONDeviceDetectorDescriptionProviderSvc::m_geometryFile

private

Initial value:

{
        this, "GeometryFile", "",
        "Detray geometry JSON file"}

Definition at line 93 of file JSONDeviceDetectorDescriptionProviderSvc.h.

                                           {
        this, "GeometryFile", "",
        "Detray geometry JSON file"};

◆ m_hostCondObjectName

Gaudi::Property<std::string> ActsTrk::JSONDeviceDetectorDescriptionProviderSvc::m_hostCondObjectName

private

Initial value:

{
        this, "HostConditionsObjectName", "",
        "Traccc host conditions object"}

Definition at line 118 of file JSONDeviceDetectorDescriptionProviderSvc.h.

                                                 {
        this, "HostConditionsObjectName", "",
        "Traccc host conditions object"};

◆ m_hostDesignObjectName

Gaudi::Property<std::string> ActsTrk::JSONDeviceDetectorDescriptionProviderSvc::m_hostDesignObjectName

private

Initial value:

{
        this, "HostDigitizationObjectName", "",
        "Traccc host digitization object"}

Definition at line 115 of file JSONDeviceDetectorDescriptionProviderSvc.h.

                                                   {
        this, "HostDigitizationObjectName", "",
        "Traccc host digitization object"};

◆ m_hostDetectorName

Gaudi::Property<std::string> ActsTrk::JSONDeviceDetectorDescriptionProviderSvc::m_hostDetectorName

private

Initial value:

{
        this, "HostDetectorName", "",
        "Detray host detector object"}

Definition at line 124 of file JSONDeviceDetectorDescriptionProviderSvc.h.

                                               {
        this, "HostDetectorName", "",
        "Detray host detector object"};    

◆ m_mapFile

Gaudi::Property<std::string> ActsTrk::JSONDeviceDetectorDescriptionProviderSvc::m_mapFile

private

Initial value:

{
        this, "MapFile", "",
        "Path to the athena<->detray ID map CSV file"}

Definition at line 102 of file JSONDeviceDetectorDescriptionProviderSvc.h.

                                      {
        this, "MapFile", "",
        "Path to the athena<->detray ID map CSV file"};   

◆ m_MRs

ToolHandle<AthDevice::IMemoryResourcesTool> ActsTrk::JSONDeviceDetectorDescriptionProviderSvc::m_MRs

private

Initial value:

{
        this, "MemoryResourcesTool", "",
        "The memory resources tool to use for allocating memory on the device"}

Definition at line 83 of file JSONDeviceDetectorDescriptionProviderSvc.h.

                                                   {
        this, "MemoryResourcesTool", "",
        "The memory resources tool to use for allocating memory on the device"};

The documentation for this class was generated from the following files:

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Member Function Documentation

◆ athenaToDetrayMap()

◆ detrayToAthenaMap()

◆ initialize()

◆ loadIdMaps()

Member Data Documentation

◆ m_athenaToDetray

◆ m_conditionsFile

◆ m_copy

◆ m_detrayToAthena

◆ m_detStore

◆ m_deviceCondObjectName

◆ m_deviceDesignObjectName

◆ m_deviceDetectorName

◆ m_digitizationFile

◆ m_geometryFile

◆ m_hostCondObjectName

◆ m_hostDesignObjectName

◆ m_hostDetectorName

◆ m_mapFile

◆ m_MRs