This struct contains the components common to RDOtoTracccCellConverterAlg and PhaseIIRDOtoTracccCellConverterAlg. More...

#include <RDOtoTracccCellConverterCommons.h>

Inheritance diagram for ActsTrk::RDOtoTracccCellConverterCommons:

Collaboration diagram for ActsTrk::RDOtoTracccCellConverterCommons:

Public Member Functions
	RDOtoTracccCellConverterCommons (AthReentrantAlgorithm &parent)
StatusCode	initialize ()
StatusCode	finalize ()
traccc::edm::silicon_cell_collection::buffer	sortCells (vecmem::copy const &host_copy, traccc::edm::silicon_cell_collection::device const &cells) const
StatusCode	copyToGpuAndRecordToSG (EventContext const &ctx, traccc::edm::silicon_cell_collection::buffer const &cells) const
StatusCode	decodeTimeBins ()
bool	passTiming (const std::bitset< 3 > &timePattern) const
StatusCode	buildDetrayMaps () const
bool	msgLvl (const MSG::Level lvl) const
	Test the output level.
MsgStream &	msg () const
	The standard message stream.
MsgStream &	msg (const MSG::Level lvl) const
	The standard message stream.
void	setLevel (MSG::Level lvl)
	Change the current logging level.

Public Attributes
AthReentrantAlgorithm &	m_parent
SG::WriteHandleKey< traccc::edm::silicon_cell_collection::buffer >	m_tracccCellsKey
std::atomic< int >	m_nPix = 0
std::atomic< int >	m_nStrip = 0
std::atomic< int >	m_nCells = 0
const PixelID *	m_pixelID {nullptr}
const SCT_ID *	m_stripID {nullptr}
ToolHandle< AthDevice::IMemoryResourceTool >	m_hostMR
ToolHandle< AthDevice::IMemoryResourceTool >	m_deviceMR
ToolHandle< AthDevice::ICopiesTool >	m_copiesTool
Gaudi::Property< std::string >	m_geoIdMappingObjectName
const ActsTrk::GeometryIdMapping *	m_geoIdMapping {nullptr}
Gaudi::Property< std::string >	m_hostCondObjectName
const traccc::detector_conditions_description::host *	m_hostCond {nullptr}
const std::unordered_map< Identifier, uint64_t > *	m_athenaToDetray {nullptr}
std::unordered_map< uint64_t, unsigned int >	m_DetrayIdToDetDescrIndexMap {}
Gaudi::Property< bool >	m_CPUCellSorting
Gaudi::Property< bool >	m_UsePixelToTForCellActivation
StringProperty	m_stripRDOTimeBinStr
int	m_stripRDOTimeBinBits [3] {-1, -1, -1}

Private Member Functions
void	initMessaging () const
	Initialize our message level and MessageSvc.

Private Attributes
std::string	m_nm
	Message source name.
boost::thread_specific_ptr< MsgStream >	m_msg_tls
	MsgStream instance (a std::cout like with print-out levels).
std::atomic< IMessageSvc * >	m_imsg { nullptr }
	MessageSvc pointer.
std::atomic< MSG::Level >	m_lvl { MSG::NIL }
	Current logging level.
std::atomic_flag m_initialized	ATLAS_THREAD_SAFE = ATOMIC_FLAG_INIT
	Messaging initialized (initMessaging).

Detailed Description

This struct contains the components common to RDOtoTracccCellConverterAlg and PhaseIIRDOtoTracccCellConverterAlg.

Output key, copy objects, memory resources, detector descriptions and conditions, athena to detray conversion maps, ...

Definition at line 37 of file RDOtoTracccCellConverterCommons.h.

Constructor & Destructor Documentation

◆ RDOtoTracccCellConverterCommons()

ActsTrk::RDOtoTracccCellConverterCommons::RDOtoTracccCellConverterCommons ( AthReentrantAlgorithm & parent )

Definition at line 18 of file RDOtoTracccCellConverterCommons.cxx.

  : AthMessaging{"RDOtoTracccCellConverterCommons"}
  , m_parent{parent}
  , m_tracccCellsKey{&parent, "TracccCells", "", "Output traccc cell collection buffer"}
  , m_hostMR{&parent, "HostMR", "", "The host memory resource tool to use"}
  , m_deviceMR{&parent, "DeviceMR", "", "The device memory resource tool to use"}
  , m_copiesTool{&parent, "CopiesTool", "", "Tool that provides host and device copy objects"}
  , m_geoIdMappingObjectName{&parent, "GeoIdMappingObjectName", "",
      "StoreGate name for the detray/acts/athena geo id mapping"} 
  , m_hostCondObjectName{&parent, "HostConditionsObjectName", "",
      "Traccc host conditions object"}
  , m_CPUCellSorting{&parent, "CPUCellSorting", false,
      "Whether to sort traccc cells on CPU or GPU"}
  , m_UsePixelToTForCellActivation{&parent, "UsePixelToTForCellActivation", true,
      "Use Pixel hit time over threshold value to set traccc cell activation value, otherwise defaults to 1"}
  , m_stripRDOTimeBinStr{&parent, "timeBins", "Allowed time bins pattern for Strip RDOs"} 
{
}

Member Function Documentation

◆ buildDetrayMaps()

StatusCode ActsTrk::RDOtoTracccCellConverterCommons::buildDetrayMaps ( ) const

Definition at line 58 of file RDOtoTracccCellConverterCommons.cxx.

{
  
  const auto& gids = m_hostCond->geometry_id();
  // NOTE: m_DetrayIdToDetDescrIndexMap is built once here; 
  // meaning it is only valid as long as the geometry does not change.
  // if the job ever spans multiple IOVs with a
  // genuinely different geometry_id() payload, this caching strategy
  // would need to become IOV-aware instead.
  const_cast<RDOtoTracccCellConverterCommons*>(this)->m_DetrayIdToDetDescrIndexMap.reserve(gids.size());
  for (unsigned int i = 0; i < gids.size(); ++i) {
    const_cast<RDOtoTracccCellConverterCommons*>(this)->m_DetrayIdToDetDescrIndexMap[gids[i].value()] = i;
  }
  ATH_MSG_INFO("Built detray→detcond map with "
      << m_DetrayIdToDetDescrIndexMap.size() << " entries");
 
  return StatusCode::SUCCESS;
}

◆ copyToGpuAndRecordToSG()

StatusCode ActsTrk::RDOtoTracccCellConverterCommons::copyToGpuAndRecordToSG	(	EventContext const &	ctx,
		traccc::edm::silicon_cell_collection::buffer const &	cells ) const

Definition at line 101 of file RDOtoTracccCellConverterCommons.cxx.

{
  auto device_copy = m_copiesTool->deviceCopy(ctx);
  auto traccc_cells_gpu_buffer = std::make_unique<traccc::edm::silicon_cell_collection::buffer>(
    cells.capacity(), m_deviceMR->mr());
 
  // We ignore() the setup and wait() on the copy to allow parallelism.
  device_copy->setup(*traccc_cells_gpu_buffer)->ignore();
  (*device_copy)(cells, *traccc_cells_gpu_buffer)->wait();
 
  auto outputTracccCells = SG::makeHandle(m_tracccCellsKey, ctx);
  ATH_CHECK(outputTracccCells.record(std::move(traccc_cells_gpu_buffer)));
  return StatusCode::SUCCESS;
}

◆ decodeTimeBins()

StatusCode ActsTrk::RDOtoTracccCellConverterCommons::decodeTimeBins ( )

Definition at line 142 of file RDOtoTracccCellConverterCommons.cxx.

{
  static const size_t MAX_BINS = 2;
  if (m_stripRDOTimeBinStr.size() > MAX_BINS) {
    ATH_MSG_WARNING("Time bin string has excess characters");
  }
 
  for (size_t i = 0; i < MAX_BINS; ++i) {
    switch (std::toupper(m_stripRDOTimeBinStr[i])) {
      case 'X': m_stripRDOTimeBinBits[i] = -1; break;
      case '0': m_stripRDOTimeBinBits[i] =  0; break;
      case '1': m_stripRDOTimeBinBits[i] =  1; break;
      default:
          ATH_MSG_FATAL("Invalid time bin string: " << m_stripRDOTimeBinStr);
          return StatusCode::FAILURE;
    }
  }
  return StatusCode::SUCCESS;
}

◆ finalize()

StatusCode ActsTrk::RDOtoTracccCellConverterCommons::finalize ( )

Definition at line 77 of file RDOtoTracccCellConverterCommons.cxx.

{
  //TODO: change to DEBUG once we figure how to set the log level of this class
  // from that of the parent class
  ATH_MSG_INFO("Read total number of pixel hits = " << m_nPix
      << ", total number of strip hits = " << m_nStrip
      << " and created total number of traccc cells = " << m_nCells
      );
  return StatusCode::SUCCESS;
}

◆ initialize()

StatusCode ActsTrk::RDOtoTracccCellConverterCommons::initialize ( )

Definition at line 38 of file RDOtoTracccCellConverterCommons.cxx.

{
  ATH_CHECK(m_parent.detStore()->retrieve(m_pixelID, "PixelID"));
  ATH_CHECK(m_parent.detStore()->retrieve(m_stripID, "SCT_ID"));
 
  ATH_CHECK(m_hostMR.retrieve());
  ATH_CHECK(m_tracccCellsKey.initialize());
  ATH_CHECK(m_copiesTool.retrieve());
 
  ATH_CHECK(m_parent.detStore()->retrieve(m_geoIdMapping, m_geoIdMappingObjectName.value()));
  ATH_CHECK(m_parent.detStore()->retrieve(m_hostCond, m_hostCondObjectName.value()));
 
  ATH_MSG_INFO("Built detray→detcond map with "
      << m_DetrayIdToDetDescrIndexMap.size() << " entries");
 
  ATH_CHECK(decodeTimeBins());
 
  return StatusCode::SUCCESS;
}

◆ initMessaging()

void AthMessaging::initMessaging ( ) const

privateinherited

Initialize our message level and MessageSvc.

This method should only be called once.

Definition at line 39 of file AthMessaging.cxx.

{
  m_imsg = Athena::getMessageSvc();
  // If user did not set an explicit level, set a default
  if (m_lvl == MSG::NIL) {
    m_lvl = m_imsg ?
      static_cast<MSG::Level>( m_imsg.load()->outputLevel(m_nm) ) :
      MSG::INFO;
  }
}

◆ msg() [1/2]

MsgStream & AthMessaging::msg ( ) const

inlineinherited

The standard message stream.

Returns a reference to the default message stream May not be invoked before sysInitialize() has been invoked.

Definition at line 167 of file AthMessaging.h.

{
  MsgStream* ms = m_msg_tls.get();
  if (!ms) {
    if (!m_initialized.test_and_set()) initMessaging();
    ms = new MsgStream(m_imsg,m_nm);
    m_msg_tls.reset( ms );
  }
 
  ms->setLevel (m_lvl);
  return *ms;
}

◆ msg() [2/2]

MsgStream & AthMessaging::msg ( const MSG::Level lvl ) const

inlineinherited

The standard message stream.

Returns a reference to the default message stream May not be invoked before sysInitialize() has been invoked.

Definition at line 182 of file AthMessaging.h.

183{ return msg() << lvl; }

AthMessaging::msg

MsgStream & msg() const

The standard message stream.

Definition AthMessaging.h:167

◆ msgLvl()

bool AthMessaging::msgLvl ( const MSG::Level lvl ) const

inlineinherited

Test the output level.

Parameters

lvl	The message level to test against

Returns: boolean Indicating if messages at given level will be printed

Return values

true	Messages at level "lvl" will be printed

Definition at line 151 of file AthMessaging.h.

{
  // If user did not set explicit message level we have to initialize
  // the messaging and retrieve the default via the MessageSvc.
  if (m_lvl==MSG::NIL && !m_initialized.test_and_set()) initMessaging();
 
  if (m_lvl <= lvl) {
    msg() << lvl;
    return true;
  } else {
    return false;
  }
}

◆ passTiming()

bool ActsTrk::RDOtoTracccCellConverterCommons::passTiming ( const std::bitset< 3 > & timePattern ) const

Definition at line 162 of file RDOtoTracccCellConverterCommons.cxx.

{
  // Convert the given timebin to a bit set and test each bit
  // if bit is -1 (i.e. X) it always passes, otherwise require exact match of 0/1
  // N.B. bitset has opposite order to the bit pattern we define
  if (m_stripRDOTimeBinBits[0] != -1 and timePattern.test(2) != static_cast<bool>(m_stripRDOTimeBinBits[0])) return false;
  if (m_stripRDOTimeBinBits[1] != -1 and timePattern.test(1) != static_cast<bool>(m_stripRDOTimeBinBits[1])) return false;
  if (m_stripRDOTimeBinBits[2] != -1 and timePattern.test(0) != static_cast<bool>(m_stripRDOTimeBinBits[2])) return false;
  return true;
}

◆ setLevel()

void AthMessaging::setLevel ( MSG::Level lvl )

inherited

Change the current logging level.

Use this rather than msg().setLevel() for proper operation with MT.

Definition at line 28 of file AthMessaging.cxx.

{
  m_lvl = lvl;
}

◆ sortCells()

traccc::edm::silicon_cell_collection::buffer ActsTrk::RDOtoTracccCellConverterCommons::sortCells	(	vecmem::copy const &	host_copy,
		traccc::edm::silicon_cell_collection::device const &	cells ) const

Definition at line 88 of file RDOtoTracccCellConverterCommons.cxx.

{
  traccc::edm::silicon_cell_collection::buffer sorted_cells_host_buffer{
    cells.size(), m_hostMR->mr()};
  host_copy.setup(sorted_cells_host_buffer)->wait();
  traccc::edm::silicon_cell_collection::device sorted_cells{sorted_cells_host_buffer};
  sort_traccc_soa(sorted_cells, cells);
  return sorted_cells_host_buffer;
}

Member Data Documentation

◆ ATLAS_THREAD_SAFE

std::atomic_flag m_initialized AthMessaging::ATLAS_THREAD_SAFE = ATOMIC_FLAG_INIT

mutableprivateinherited

Messaging initialized (initMessaging).

Definition at line 141 of file AthMessaging.h.

◆ m_athenaToDetray

const std::unordered_map<Identifier, uint64_t>* ActsTrk::RDOtoTracccCellConverterCommons::m_athenaToDetray {nullptr}

Definition at line 65 of file RDOtoTracccCellConverterCommons.h.

65{nullptr};

◆ m_copiesTool

ToolHandle<AthDevice::ICopiesTool> ActsTrk::RDOtoTracccCellConverterCommons::m_copiesTool

Definition at line 57 of file RDOtoTracccCellConverterCommons.h.

◆ m_CPUCellSorting

Gaudi::Property<bool> ActsTrk::RDOtoTracccCellConverterCommons::m_CPUCellSorting

Definition at line 68 of file RDOtoTracccCellConverterCommons.h.

◆ m_DetrayIdToDetDescrIndexMap

std::unordered_map<uint64_t, unsigned int> ActsTrk::RDOtoTracccCellConverterCommons::m_DetrayIdToDetDescrIndexMap {}

Definition at line 66 of file RDOtoTracccCellConverterCommons.h.

66{};

◆ m_deviceMR

ToolHandle<AthDevice::IMemoryResourceTool> ActsTrk::RDOtoTracccCellConverterCommons::m_deviceMR

Definition at line 56 of file RDOtoTracccCellConverterCommons.h.

◆ m_geoIdMapping

const ActsTrk::GeometryIdMapping* ActsTrk::RDOtoTracccCellConverterCommons::m_geoIdMapping {nullptr}

Definition at line 60 of file RDOtoTracccCellConverterCommons.h.

60{nullptr};

◆ m_geoIdMappingObjectName

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

Definition at line 59 of file RDOtoTracccCellConverterCommons.h.

◆ m_hostCond

const traccc::detector_conditions_description::host* ActsTrk::RDOtoTracccCellConverterCommons::m_hostCond {nullptr}

Definition at line 62 of file RDOtoTracccCellConverterCommons.h.

62{nullptr};

◆ m_hostCondObjectName

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

Definition at line 61 of file RDOtoTracccCellConverterCommons.h.

◆ m_hostMR

ToolHandle<AthDevice::IMemoryResourceTool> ActsTrk::RDOtoTracccCellConverterCommons::m_hostMR

Definition at line 55 of file RDOtoTracccCellConverterCommons.h.

◆ m_imsg

std::atomic<IMessageSvc*> AthMessaging::m_imsg { nullptr }

mutableprivateinherited

MessageSvc pointer.

Definition at line 135 of file AthMessaging.h.

135{ nullptr };

◆ m_lvl

std::atomic<MSG::Level> AthMessaging::m_lvl { MSG::NIL }

mutableprivateinherited

Current logging level.

Definition at line 138 of file AthMessaging.h.

138{ MSG::NIL };

◆ m_msg_tls

boost::thread_specific_ptr<MsgStream> AthMessaging::m_msg_tls

mutableprivateinherited

MsgStream instance (a std::cout like with print-out levels).

Definition at line 132 of file AthMessaging.h.

◆ m_nCells

std::atomic<int> ActsTrk::RDOtoTracccCellConverterCommons::m_nCells = 0

mutable

Definition at line 50 of file RDOtoTracccCellConverterCommons.h.

◆ m_nm

std::string AthMessaging::m_nm

privateinherited

Message source name.

Definition at line 129 of file AthMessaging.h.

◆ m_nPix

std::atomic<int> ActsTrk::RDOtoTracccCellConverterCommons::m_nPix = 0

mutable

Definition at line 48 of file RDOtoTracccCellConverterCommons.h.

◆ m_nStrip

std::atomic<int> ActsTrk::RDOtoTracccCellConverterCommons::m_nStrip = 0

mutable

Definition at line 49 of file RDOtoTracccCellConverterCommons.h.

◆ m_parent

AthReentrantAlgorithm& ActsTrk::RDOtoTracccCellConverterCommons::m_parent

Definition at line 44 of file RDOtoTracccCellConverterCommons.h.

◆ m_pixelID

const PixelID* ActsTrk::RDOtoTracccCellConverterCommons::m_pixelID {nullptr}

Definition at line 52 of file RDOtoTracccCellConverterCommons.h.

52{nullptr};

◆ m_stripID

const SCT_ID* ActsTrk::RDOtoTracccCellConverterCommons::m_stripID {nullptr}

Definition at line 53 of file RDOtoTracccCellConverterCommons.h.

53{nullptr};

◆ m_stripRDOTimeBinBits

int ActsTrk::RDOtoTracccCellConverterCommons::m_stripRDOTimeBinBits[3] {-1, -1, -1}

Definition at line 82 of file RDOtoTracccCellConverterCommons.h.

82{-1, -1, -1};

◆ m_stripRDOTimeBinStr

StringProperty ActsTrk::RDOtoTracccCellConverterCommons::m_stripRDOTimeBinStr

Definition at line 81 of file RDOtoTracccCellConverterCommons.h.

◆ m_tracccCellsKey

SG::WriteHandleKey<traccc::edm::silicon_cell_collection::buffer> ActsTrk::RDOtoTracccCellConverterCommons::m_tracccCellsKey

Definition at line 46 of file RDOtoTracccCellConverterCommons.h.

◆ m_UsePixelToTForCellActivation

Gaudi::Property<bool> ActsTrk::RDOtoTracccCellConverterCommons::m_UsePixelToTForCellActivation

Definition at line 69 of file RDOtoTracccCellConverterCommons.h.

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

Public Member Functions

Public Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ RDOtoTracccCellConverterCommons()

Member Function Documentation

◆ buildDetrayMaps()

◆ copyToGpuAndRecordToSG()

◆ decodeTimeBins()

◆ finalize()

◆ initialize()

◆ initMessaging()

◆ msg() [1/2]

◆ msg() [2/2]

◆ msgLvl()

◆ passTiming()

◆ setLevel()

◆ sortCells()

Member Data Documentation

◆ ATLAS_THREAD_SAFE

◆ m_athenaToDetray

◆ m_copiesTool

◆ m_CPUCellSorting

◆ m_DetrayIdToDetDescrIndexMap

◆ m_deviceMR

◆ m_geoIdMapping

◆ m_geoIdMappingObjectName

◆ m_hostCond

◆ m_hostCondObjectName

◆ m_hostMR

◆ m_imsg

◆ m_lvl

◆ m_msg_tls

◆ m_nCells

◆ m_nm

◆ m_nPix

◆ m_nStrip

◆ m_parent

◆ m_pixelID

◆ m_stripID

◆ m_stripRDOTimeBinBits

◆ m_stripRDOTimeBinStr

◆ m_tracccCellsKey

◆ m_UsePixelToTForCellActivation