#include <ActsMaterialMapping.h>

Inheritance diagram for ActsMaterialMapping:

Collaboration diagram for ActsMaterialMapping:

Public Member Functions
virtual StatusCode	initialize () override
virtual StatusCode	execute () override
virtual StatusCode	finalize () override
	AthAlgorithm (const std::string &name, ISvcLocator *pSvcLocator)
	Constructor with parameters:
virtual StatusCode	sysInitialize () override
	Override sysInitialize.
virtual const DataObjIDColl &	extraOutputDeps () const override
	Return the list of extra output dependencies.
ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard `StoreGateSvc` (event store) Returns (kind of) a pointer to the `StoreGateSvc`.
const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard `StoreGateSvc/DetectorStore` Returns (kind of) a pointer to the `StoreGateSvc`.
virtual StatusCode	sysStart () override
	Handle START transition.
virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles.
virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles.
Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T, V, H > &t)
void	updateVHKA (Gaudi::Details::PropertyBase &)
MsgStream &	msg () const
bool	msgLvl (const MSG::Level lvl) const

Protected Member Functions
void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution
std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void >	renounce (T &h)
void	extraDeps_update_handler (Gaudi::Details::PropertyBase &ExtraDeps)
	Add StoreName to extra input/output deps as needed.

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
ServiceHandle< IActsMaterialTrackWriterSvc >	m_materialTrackWriterSvc {this, "MaterialWriterSvc", "ActsMaterialTrackWriterSvc"}
PublicToolHandle< ActsTrk::ITrackingGeometryTool >	m_trackingGeometryTool {this, "TrackingGeometryTool", "ActsTrackingGeometryTool"}
Gaudi::Property< bool >	m_mapSurfaces {this, "mapSurfaces", true, "Map the material onto surfaces"}
Gaudi::Property< bool >	m_mapVolumes {this, "mapVolumes", true, "Map the material onto volumes"}
ToolHandle< IActsMaterialStepConverterTool >	m_materialStepConverterTool {this, "MaterialStepConverterTool", "ActsMaterialStepConverterTool"}
SG::ReadHandleKey< Trk::MaterialStepCollection >	m_inputMaterialStepCollection {this, "MaterialStepRecordsKey", "MaterialStepRecords"}
ToolHandle< IActsSurfaceMappingTool >	m_surfaceMappingTool {this, "SurfaceMappingTool", "ActsSurfaceMappingTool"}
ToolHandle< IActsVolumeMappingTool >	m_volumeMappingTool {this, "VolumeMappingTool", "ActsVolumeMappingTool"}
ToolHandle< IActsMaterialJsonWriterTool >	m_materialJsonWriterTool {this, "MaterialJsonWriterTool", "ActsMaterialJsonWriterTool"}
Acts::MagneticFieldContext	m_mctx {}
Acts::GeometryContext	m_gctx {}
Acts::SurfaceMaterialMapper::State	m_mappingState {m_gctx, m_mctx}
Acts::VolumeMaterialMapper::State	m_mappingStateVol {m_gctx,m_mctx}
DataObjIDColl	m_extendedExtraObjects
StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default)
StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default)
std::vector< SG::VarHandleKeyArray * >	m_vhka
bool	m_varHandleArraysDeclared

Detailed Description

Definition at line 52 of file ActsMaterialMapping.h.

Member Typedef Documentation

◆ StoreGateSvc_t

typedef ServiceHandle<StoreGateSvc> AthCommonDataStore< AthCommonMsg< Algorithm > >::StoreGateSvc_t

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Member Function Documentation

◆ AthAlgorithm()

AthAlgorithm::AthAlgorithm	(	const std::string &	name,
		ISvcLocator *	pSvcLocator )

Constructor with parameters:

Definition at line 51 of file AthAlgorithm.cxx.

                                                       :
  ::AthCommonDataStore<AthCommonMsg<Algorithm>>   ( name, pSvcLocator )
{
  // Set up to run AthAlgorithmDHUpdate in sysInitialize before
  // merging dependency lists.  This extends the output dependency
  // list with any symlinks implied by inheritance relations.
  m_updateDataHandles =
    std::make_unique<AthenaBaseComps::AthAlgorithmDHUpdate>
    (m_extendedExtraObjects,
     std::move (m_updateDataHandles));
}

◆ declareGaudiProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< Algorithm > >::declareGaudiProperty	(	Gaudi::Property< T, V, H > &	hndl,
		const SG::VarHandleKeyType &	)

inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleKey>

Definition at line 156 of file AthCommonDataStore.h.

  {
    return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                       hndl.value(), 
                                                       hndl.documentation());
 
  }

◆ declareProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< Algorithm > >::declareProperty ( Gaudi::Property< T, V, H > & t )

inlineinherited

Definition at line 145 of file AthCommonDataStore.h.

                                                                     {
    typedef typename SG::HandleClassifier<T>::type htype;
    return AthCommonDataStore<PBASE>::declareGaudiProperty(t, htype());
  }

◆ detStore()

const ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< Algorithm > >::detStore ( ) const

inlineinherited

The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 95 of file AthCommonDataStore.h.

95{ return m_detStore; }

AthCommonDataStore< AthCommonMsg< Algorithm > >::m_detStore

StoreGateSvc_t m_detStore

Definition AthCommonDataStore.h:393

◆ evtStore()

ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< Algorithm > >::evtStore ( )

inlineinherited

The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 85 of file AthCommonDataStore.h.

85{ return m_evtStore; }

AthCommonDataStore< AthCommonMsg< Algorithm > >::m_evtStore

StoreGateSvc_t m_evtStore

Definition AthCommonDataStore.h:390

◆ execute()

StatusCode ActsMaterialMapping::execute ( )

overridevirtual

Definition at line 63 of file ActsMaterialMapping.cxx.

                                        {
  ATH_MSG_DEBUG(name() << "::" << __FUNCTION__);
  const EventContext& ctx = Gaudi::Hive::currentContext();
  SG::ReadHandle<Trk::MaterialStepCollection> materialStepCollection(m_inputMaterialStepCollection, ctx);
 
  if (materialStepCollection.isValid() and not materialStepCollection->empty()) {
    Acts::RecordedMaterialTrack mTrack = m_materialStepConverterTool->convertToMaterialTrack(*materialStepCollection);
 
    if(m_mapSurfaces){
      auto context = m_trackingGeometryTool->getNominalGeometryContext().context();
      std::reference_wrapper<const Acts::GeometryContext> geoContext(context);
      m_mappingState.geoContext = geoContext;
      m_surfaceMappingTool->mapper()->mapMaterialTrack(m_mappingState, mTrack);
    }
    if(m_mapVolumes){
      auto context = m_trackingGeometryTool->getNominalGeometryContext().context();
      std::reference_wrapper<const Acts::GeometryContext> geoContext(context);
      m_mappingStateVol.geoContext = geoContext;
      m_volumeMappingTool->mapper()->mapMaterialTrack(m_mappingStateVol, mTrack);
    }
    m_materialTrackWriterSvc->write(mTrack);
  }
  return StatusCode::SUCCESS;
}

◆ extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< Algorithm > >::extraDeps_update_handler ( Gaudi::Details::PropertyBase & ExtraDeps )

protectedinherited

Add StoreName to extra input/output deps as needed.

use the logic of the VarHandleKey to parse the DataObjID keys supplied via the ExtraInputs and ExtraOuputs Properties to add the StoreName if it's not explicitly given

◆ extraOutputDeps()

const DataObjIDColl & AthAlgorithm::extraOutputDeps ( ) const

overridevirtualinherited

Return the list of extra output dependencies.

This list is extended to include symlinks implied by inheritance relations.

Definition at line 50 of file AthAlgorithm.cxx.

{
  // If we didn't find any symlinks to add, just return the collection
  // from the base class.  Otherwise, return the extended collection.
  if (!m_extendedExtraObjects.empty()) {
    return m_extendedExtraObjects;
  }
  return Algorithm::extraOutputDeps();
}

◆ finalize()

StatusCode ActsMaterialMapping::finalize ( )

overridevirtual

Definition at line 88 of file ActsMaterialMapping.cxx.

                                         {
  ATH_MSG_DEBUG(name() << "::" << __FUNCTION__);
  Acts::DetectorMaterialMaps detectorMaterial;
 
  // Finalize all the maps using the cached state
  if(m_mapSurfaces && m_mapVolumes){
    m_surfaceMappingTool->mapper()->finalizeMaps(m_mappingState);
    m_volumeMappingTool->mapper()->finalizeMaps(m_mappingStateVol);
    // Loop over the state, and collect the maps for surfaces
    for (auto& [key, value] : m_mappingState.surfaceMaterial) {
      detectorMaterial.first.insert({key, std::move(value)});
    }
    // Loop over the state, and collect the maps for volumes
    for (auto& [key, value] : m_mappingStateVol.volumeMaterial) {
      detectorMaterial.second.insert({key, std::move(value)});
    }
  }
  else{
    if(m_mapSurfaces){
      m_surfaceMappingTool->mapper()->finalizeMaps(m_mappingState);
      // Loop over the state, and collect the maps for surfaces
      for (auto& [key, value] : m_mappingState.surfaceMaterial) {
        detectorMaterial.first.insert({key, std::move(value)});
      }
      // Loop over the state, and collect the maps for volumes
      for (auto& [key, value] : m_mappingState.volumeMaterial) {
        detectorMaterial.second.insert({key, std::move(value)});
      }
    }
    if(m_mapVolumes){
      m_volumeMappingTool->mapper()->finalizeMaps(m_mappingStateVol);
      // Loop over the state, and collect the maps for surfaces
      for (auto& [key, value] : m_mappingStateVol.surfaceMaterial) {
        detectorMaterial.first.insert({key, std::move(value)});
      }
      // Loop over the state, and collect the maps for volumes
      for (auto& [key, value] : m_mappingStateVol.volumeMaterial) {
        detectorMaterial.second.insert({key, std::move(value)});
      }
    }
  }
  
  const auto & context = m_trackingGeometryTool->getNominalGeometryContext();
  m_materialJsonWriterTool->write(context, detectorMaterial);
 
  return StatusCode::SUCCESS;
 
}

◆ initialize()

StatusCode ActsMaterialMapping::initialize ( )

overridevirtual

Definition at line 40 of file ActsMaterialMapping.cxx.

                                           {
  ATH_MSG_DEBUG(name() << "::" << __FUNCTION__);
 
  if(!m_mapSurfaces && !m_mapVolumes){
    ATH_MSG_ERROR("No element to map onto defined.");
    return StatusCode::FAILURE;
  }
  ATH_CHECK(m_trackingGeometryTool.retrieve());
  ATH_CHECK(m_materialStepConverterTool.retrieve() );
  ATH_CHECK(m_materialTrackWriterSvc.retrieve() );
  if(m_mapSurfaces){
    ATH_CHECK(m_surfaceMappingTool.retrieve() );
    m_mappingState = m_surfaceMappingTool->mappingState();
  }
  if(m_mapVolumes){
    ATH_CHECK(m_volumeMappingTool.retrieve() );
    m_mappingStateVol = m_volumeMappingTool->mappingState();
  }
  ATH_CHECK(m_materialJsonWriterTool.retrieve() );
  ATH_CHECK( m_inputMaterialStepCollection.initialize() );
  return StatusCode::SUCCESS;
}

◆ inputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< Algorithm > >::inputHandles ( ) const

overridevirtualinherited

Return this algorithm's input handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

◆ msg()

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

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

◆ msgLvl()

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

inlineinherited

Definition at line 30 of file AthCommonMsg.h.

                                               {
    return this->msgLevel(lvl);
  }

◆ outputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< Algorithm > >::outputHandles ( ) const

overridevirtualinherited

Return this algorithm's output handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

◆ renounce()

std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void > AthCommonDataStore< AthCommonMsg< Algorithm > >::renounce ( T & h )

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

  {
    h.renounce();
    PBASE::renounce (h);
  }

◆ renounceArray()

void AthCommonDataStore< AthCommonMsg< Algorithm > >::renounceArray ( SG::VarHandleKeyArray & handlesArray )

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                          {
    handlesArray.renounce();
  }

◆ sysInitialize()

StatusCode AthAlgorithm::sysInitialize ( )

overridevirtualinherited

Override sysInitialize.

Override sysInitialize from the base class.

Loop through all output handles, and if they're WriteCondHandles, automatically register them and this Algorithm with the CondSvc

Scan through all outputHandles, and if they're WriteCondHandles, register them with the CondSvc

Reimplemented from AthCommonDataStore< AthCommonMsg< Algorithm > >.

Reimplemented in AthAnalysisAlgorithm, AthFilterAlgorithm, AthHistogramAlgorithm, and PyAthena::Alg.

Definition at line 66 of file AthAlgorithm.cxx.

                                       {
  StatusCode sc=AthCommonDataStore<AthCommonMsg<Algorithm>>::sysInitialize();
 
  if (sc.isFailure()) {
    return sc;
  }
  ServiceHandle<ICondSvc> cs("CondSvc",name());
  for (auto h : outputHandles()) {
    if (h->isCondition() && h->mode() == Gaudi::DataHandle::Writer) {
      // do this inside the loop so we don't create the CondSvc until needed
      if ( cs.retrieve().isFailure() ) {
        ATH_MSG_WARNING("no CondSvc found: won't autoreg WriteCondHandles");
        return StatusCode::SUCCESS;
      }
      if (cs->regHandle(this,*h).isFailure()) {
        sc = StatusCode::FAILURE;
        ATH_MSG_ERROR("unable to register WriteCondHandle " << h->fullKey()
                      << " with CondSvc");
      }
    }
  }
  return sc;
}

◆ sysStart()

virtual StatusCode AthCommonDataStore< AthCommonMsg< Algorithm > >::sysStart ( )

overridevirtualinherited

Handle START transition.

We override this in order to make sure that conditions handle keys can cache a pointer to the conditions container.

◆ updateVHKA()

void AthCommonDataStore< AthCommonMsg< Algorithm > >::updateVHKA ( Gaudi::Details::PropertyBase & )

inlineinherited

Definition at line 308 of file AthCommonDataStore.h.

                                               {
    // debug() << "updateVHKA for property " << p.name() << " " << p.toString() 
    //         << "  size: " << m_vhka.size() << endmsg;
    for (auto &a : m_vhka) {
      std::vector<SG::VarHandleKey*> keys = a->keys();
      for (auto k : keys) {
        k->setOwner(this);
      }
    }
  }

Member Data Documentation

◆ m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< Algorithm > >::m_detStore

privateinherited

Pointer to StoreGate (detector store by default)

Definition at line 393 of file AthCommonDataStore.h.

◆ m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< Algorithm > >::m_evtStore

privateinherited

Pointer to StoreGate (event store by default)

Definition at line 390 of file AthCommonDataStore.h.

◆ m_extendedExtraObjects

DataObjIDColl AthAlgorithm::m_extendedExtraObjects

privateinherited

Definition at line 79 of file AthAlgorithm.h.

◆ m_gctx

Acts::GeometryContext ActsMaterialMapping::m_gctx {}

private

Definition at line 71 of file ActsMaterialMapping.h.

71{};

◆ m_inputMaterialStepCollection

SG::ReadHandleKey<Trk::MaterialStepCollection> ActsMaterialMapping::m_inputMaterialStepCollection {this, "MaterialStepRecordsKey", "MaterialStepRecords"}

private

Definition at line 65 of file ActsMaterialMapping.h.

65{this, "MaterialStepRecordsKey", "MaterialStepRecords"};

◆ m_mappingState

Acts::SurfaceMaterialMapper::State ActsMaterialMapping::m_mappingState {m_gctx, m_mctx}

private

Definition at line 72 of file ActsMaterialMapping.h.

72{m_gctx, m_mctx};

ActsMaterialMapping::m_mctx

Acts::MagneticFieldContext m_mctx

Definition ActsMaterialMapping.h:70

ActsMaterialMapping::m_gctx

Acts::GeometryContext m_gctx

Definition ActsMaterialMapping.h:71

◆ m_mappingStateVol

Acts::VolumeMaterialMapper::State ActsMaterialMapping::m_mappingStateVol {m_gctx,m_mctx}

private

Definition at line 73 of file ActsMaterialMapping.h.

73{m_gctx,m_mctx};

◆ m_mapSurfaces

Gaudi::Property<bool> ActsMaterialMapping::m_mapSurfaces {this, "mapSurfaces", true, "Map the material onto surfaces"}

private

Definition at line 62 of file ActsMaterialMapping.h.

62{this, "mapSurfaces", true, "Map the material onto surfaces"};

◆ m_mapVolumes

Gaudi::Property<bool> ActsMaterialMapping::m_mapVolumes {this, "mapVolumes", true, "Map the material onto volumes"}

private

Definition at line 63 of file ActsMaterialMapping.h.

63{this, "mapVolumes", true, "Map the material onto volumes"};

◆ m_materialJsonWriterTool

ToolHandle<IActsMaterialJsonWriterTool> ActsMaterialMapping::m_materialJsonWriterTool {this, "MaterialJsonWriterTool", "ActsMaterialJsonWriterTool"}

private

Definition at line 68 of file ActsMaterialMapping.h.

68{this, "MaterialJsonWriterTool", "ActsMaterialJsonWriterTool"};

◆ m_materialStepConverterTool

ToolHandle<IActsMaterialStepConverterTool> ActsMaterialMapping::m_materialStepConverterTool {this, "MaterialStepConverterTool", "ActsMaterialStepConverterTool"}

private

Definition at line 64 of file ActsMaterialMapping.h.

64{this, "MaterialStepConverterTool", "ActsMaterialStepConverterTool"};

◆ m_materialTrackWriterSvc

ServiceHandle<IActsMaterialTrackWriterSvc> ActsMaterialMapping::m_materialTrackWriterSvc {this, "MaterialWriterSvc", "ActsMaterialTrackWriterSvc"}

private

Definition at line 60 of file ActsMaterialMapping.h.

60{this, "MaterialWriterSvc", "ActsMaterialTrackWriterSvc"};

◆ m_mctx

Acts::MagneticFieldContext ActsMaterialMapping::m_mctx {}

private

Definition at line 70 of file ActsMaterialMapping.h.

70{};

◆ m_surfaceMappingTool

ToolHandle<IActsSurfaceMappingTool> ActsMaterialMapping::m_surfaceMappingTool {this, "SurfaceMappingTool", "ActsSurfaceMappingTool"}

private

Definition at line 66 of file ActsMaterialMapping.h.

66{this, "SurfaceMappingTool", "ActsSurfaceMappingTool"};

◆ m_trackingGeometryTool

PublicToolHandle<ActsTrk::ITrackingGeometryTool> ActsMaterialMapping::m_trackingGeometryTool {this, "TrackingGeometryTool", "ActsTrackingGeometryTool"}

private

Definition at line 61 of file ActsMaterialMapping.h.

61{this, "TrackingGeometryTool", "ActsTrackingGeometryTool"};

◆ m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< Algorithm > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

◆ m_vhka

std::vector<SG::VarHandleKeyArray*> AthCommonDataStore< AthCommonMsg< Algorithm > >::m_vhka

privateinherited

Definition at line 398 of file AthCommonDataStore.h.

◆ m_volumeMappingTool

ToolHandle<IActsVolumeMappingTool> ActsMaterialMapping::m_volumeMappingTool {this, "VolumeMappingTool", "ActsVolumeMappingTool"}

private

Definition at line 67 of file ActsMaterialMapping.h.

67{this, "VolumeMappingTool", "ActsVolumeMappingTool"};

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

Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Member Function Documentation

◆ AthAlgorithm()

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ execute()

◆ extraDeps_update_handler()

◆ extraOutputDeps()

◆ finalize()

◆ initialize()

◆ inputHandles()

◆ msg()

◆ msgLvl()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_detStore

◆ m_evtStore

◆ m_extendedExtraObjects

◆ m_gctx

◆ m_inputMaterialStepCollection

◆ m_mappingState

◆ m_mappingStateVol

◆ m_mapSurfaces

◆ m_mapVolumes

◆ m_materialJsonWriterTool

◆ m_materialStepConverterTool

◆ m_materialTrackWriterSvc

◆ m_mctx

◆ m_surfaceMappingTool

◆ m_trackingGeometryTool

◆ m_varHandleArraysDeclared

◆ m_vhka

◆ m_volumeMappingTool