ActsTrk::JSONDeviceDetectorDescriptionProviderSvc Class Reference

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.
MsgStream &	msg () const
bool	msgLvl (const MSG::Level lvl) const

Private Member Functions
StatusCode	loadIdMaps (const std::unique_ptr< traccc::host_detector > &hostDetector)
	Helper function to load Athena<->detray ID maps from csv.

Private Attributes
ServiceHandle< StoreGateSvc >	m_detStore {this, "DetectorStore", "StoreGateSvc/DetectorStore"}
std::unique_ptr< ActsTrk::GeometryIdMapping >	m_idMapping
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_materialFile
Gaudi::Property< std::string >	m_surfaceGridFile
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
Gaudi::Property< std::string >	m_geoIdMappingObjectName

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 58 of file JSONDeviceDetectorDescriptionProviderSvc.h.

Member Function Documentation

initialize()

StatusCode ActsTrk::JSONDeviceDetectorDescriptionProviderSvc::initialize ( )

overridevirtual

Function initializing and executing the file loading.

Definition at line 29 of file JSONDeviceDetectorDescriptionProviderSvc.cxx.

{
  ATH_MSG_DEBUG("Initializing  device detector description provider service ");
 
  ATH_CHECK(m_MRs.retrieve());
  ATH_CHECK(m_copy.retrieve());
 
  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()),
      PathResolverFindCalibFile(m_materialFile.value()),
      PathResolverFindCalibFile(m_surfaceGridFile.value()));
 
  auto deviceDetector =
        std::make_unique<traccc::detector_buffer>(traccc::buffer_from_host_detector(*hostDetector, m_MRs->mainMR(), const_cast<vecmem::copy&>(*copy)));
  
  ATH_CHECK(loadIdMaps(hostDetector));      
  
  // 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 ( const std::unique_ptr< traccc::host_detector > & hostDetector )

private

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

Definition at line 124 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;
  }                     
 
  // Pass 1: the Athena <-> detray map
  // Fill it into a temporary lookup keyed by detray id.
  std::unordered_map<uint64_t, Identifier> detrayToAthenaFromFile;
 
  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);          // handles the 0x-prefixed hex correctly
 
    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;
    }
 
    detrayToAthenaFromFile.emplace(detrayId, athenaId);
  }
 
  ATH_MSG_INFO("Read " << detrayToAthenaFromFile.size()
                        << " detray<->Athena entries from file");
 
  // Pass 2: walk the detray surfaces, read off the ACTS geometry id 
  // and combine with the file-based Athena lookup to fill the
  // full three-way GeometryIdMapping.
  m_idMapping = std::make_unique<ActsTrk::GeometryIdMapping>();
  const auto& itkDetector = hostDetector->as<traccc::itk_detector>();
  const std::size_t nSurfaces = itkDetector.surfaces().size();
  m_idMapping->reserve(nSurfaces);
 
  std::size_t nMatched = 0;
  for (const auto& surface : itkDetector.surfaces()) {
    const Acts::GeometryIdentifier acts_geom_id{surface.source};
 
    auto sf = detray::tracking_surface{itkDetector, surface};
    const auto detrayId = sf.identifier().value();
 
    std::optional<Identifier> athenaId; 
    if (auto it = detrayToAthenaFromFile.find(detrayId);
        it != detrayToAthenaFromFile.end()) {
      athenaId = it->second;
      ++nMatched;
    }
 
    m_idMapping->addEntry(detrayId, acts_geom_id.value(), athenaId);
  }                      
 
  ATH_MSG_INFO("Built GeometryIdMapping with " << m_idMapping->size()
               << " detray/ACTS surfaces, " << nMatched
               << " matched to an Athena module");
               
  ATH_CHECK(m_detStore->record(std::move(m_idMapping), m_geoIdMappingObjectName.value(), false));             
 
  return StatusCode::SUCCESS;
}

msg()

MsgStream & AthCommonMsg< Service >::msg ( ) const

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

msgLvl()

bool AthCommonMsg< Service >::msgLvl ( const MSG::Level lvl ) const

inlineinherited

Definition at line 30 of file AthCommonMsg.h.

                                               {
    return this->msgLevel(lvl);
  }

Member Data Documentation

m_conditionsFile

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

private

Initial value:

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

Definition at line 94 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 77 of file JSONDeviceDetectorDescriptionProviderSvc.h.

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

m_detStore

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

private

Definition at line 70 of file JSONDeviceDetectorDescriptionProviderSvc.h.

{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 107 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 104 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 116 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 91 of file JSONDeviceDetectorDescriptionProviderSvc.h.

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

m_geoIdMappingObjectName

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

private

Initial value:

{
        this, "GeoIdMappingObjectName", "",
        "StoreGate name for the detray/acts/athena geo id mapping"}

Definition at line 122 of file JSONDeviceDetectorDescriptionProviderSvc.h.

                                                     {
        this, "GeoIdMappingObjectName", "",
        "StoreGate name for the detray/acts/athena geo id mapping"};    

m_geometryFile

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

private

Initial value:

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

Definition at line 82 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 113 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 110 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 119 of file JSONDeviceDetectorDescriptionProviderSvc.h.

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

m_idMapping

std::unique_ptr<ActsTrk::GeometryIdMapping> ActsTrk::JSONDeviceDetectorDescriptionProviderSvc::m_idMapping

private

Definition at line 129 of file JSONDeviceDetectorDescriptionProviderSvc.h.

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 97 of file JSONDeviceDetectorDescriptionProviderSvc.h.

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

m_materialFile

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

private

Initial value:

{
        this, "MaterialFile", "",
        "Detray material JSON file"}

Definition at line 85 of file JSONDeviceDetectorDescriptionProviderSvc.h.

                                           {
        this, "MaterialFile", "",
        "Detray material JSON 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 72 of file JSONDeviceDetectorDescriptionProviderSvc.h.

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

m_surfaceGridFile

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

private

Initial value:

{
        this, "SurfaceGridFile", "",
        "Detray surface grid JSON file"}

Definition at line 88 of file JSONDeviceDetectorDescriptionProviderSvc.h.

                                              {
        this, "SurfaceGridFile", "",
        "Detray surface grid JSON file"};        

---

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

• JSONDeviceDetectorDescriptionProviderSvc.h
• JSONDeviceDetectorDescriptionProviderSvc.cxx