Base class tool to step recursively through the Tracking Geometry, it starts from the TrackingGeometry, retrieves the highest volume and then processes all contained objects. More...

#include <RecursiveGeometryProcessor.h>

Inheritance diagram for Trk::RecursiveGeometryProcessor:

Collaboration diagram for Trk::RecursiveGeometryProcessor:

Public Member Functions
	RecursiveGeometryProcessor (const std::string &, const std::string &, const IInterface *)
	Constructor.
virtual	~RecursiveGeometryProcessor ()
	Destructor.
StatusCode	initialize ()
	AlgTool initialize method.
StatusCode	finalize ()
	AlgTool finalize method.
virtual StatusCode	process (TrackingGeometry &tgeo) const
	Processor Action to work on TrackingGeometry& tgeo.
virtual StatusCode	process (TrackingVolume &tvol, size_t level=0) const
	Processor Action to work on TrackingVolumes - the level is for the hierachy tree.
virtual StatusCode	process (Layer &lay, size_t level=0) const
	Processor Action to work on Layers.
virtual StatusCode	process (Surface &surf, size_t level=0) const
	Processor Action to work on Surfaces.
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	sysInitialize () override
	Perform system initialization for an algorithm.
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
	DeclareInterfaceID (IGeometryProcessor, 1, 0)
	Creates the InterfaceID and interfaceID() method.

Protected Member Functions
virtual StatusCode	processNode (const TrackingVolume &tvol, size_t level=0) const
	Dedicated action for the different processors.
virtual StatusCode	processNode (const Layer &lay, size_t level=0) const
	Processor Action to work on Layers.
virtual StatusCode	processNode (const Surface &surf, size_t level=0) const
	Processor Action to work on Surfaces.
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
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

Base class tool to step recursively through the Tracking Geometry, it starts from the TrackingGeometry, retrieves the highest volume and then processes all contained objects.

The processNode() methods are to be overloaded by inherited classes

Author: Andre.nosp@m.as.S.nosp@m.alzbu.nosp@m.rger.nosp@m.@cern.nosp@m..ch

Definition at line 38 of file RecursiveGeometryProcessor.h.

Member Typedef Documentation

◆ StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

◆ RecursiveGeometryProcessor()

Trk::RecursiveGeometryProcessor::RecursiveGeometryProcessor	(	const std::string &	t,
		const std::string &	n,
		const IInterface *	p )

Constructor.

Definition at line 20 of file RecursiveGeometryProcessor.cxx.

: AthAlgTool(t,n,p)
{
    declareInterface<Trk::IGeometryProcessor>(this);
}

◆ ~RecursiveGeometryProcessor()

Trk::RecursiveGeometryProcessor::~RecursiveGeometryProcessor ( )

virtualdefault

Destructor.

Member Function Documentation

◆ declareGaudiProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< AlgTool > >::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());
 
  }

◆ DeclareInterfaceID()

Trk::IGeometryProcessor::DeclareInterfaceID	(	IGeometryProcessor	,
		1	,
		0	)

inherited

Creates the InterfaceID and interfaceID() method.

◆ declareProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< AlgTool > >::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< AlgTool > >::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< AlgTool > >::m_detStore

StoreGateSvc_t m_detStore

Definition AthCommonDataStore.h:393

◆ evtStore()

ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< AlgTool > >::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< AlgTool > >::m_evtStore

StoreGateSvc_t m_evtStore

Definition AthCommonDataStore.h:390

◆ extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::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

◆ finalize()

StatusCode Trk::RecursiveGeometryProcessor::finalize ( )

AlgTool finalize method.

Definition at line 39 of file RecursiveGeometryProcessor.cxx.

{
    ATH_MSG_INFO( "finalize() successful" );
    return StatusCode::SUCCESS;
}

◆ initialize()

StatusCode Trk::RecursiveGeometryProcessor::initialize ( )

AlgTool initialize method.

Definition at line 32 of file RecursiveGeometryProcessor.cxx.

{
    ATH_MSG_INFO( "initialize()" );
    return StatusCode::SUCCESS;
}

◆ inputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< AlgTool > >::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< AlgTool >::msg ( ) const

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

◆ msgLvl()

bool AthCommonMsg< AlgTool >::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< AlgTool > >::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.

◆ process() [1/4]

StatusCode Trk::RecursiveGeometryProcessor::process	(	Trk::Layer &	lay,
		size_t	level = 0 ) const

virtual

Processor Action to work on Layers.

Implements Trk::IGeometryProcessor.

Definition at line 128 of file RecursiveGeometryProcessor.cxx.

                                                                                   {
 
    std::stringstream displayBuffer;
    for (size_t il = 0; il < level; ++il) displayBuffer << " ";
    ATH_MSG_VERBOSE(displayBuffer.str() << "   processing Layer with Index: " << lay.layerIndex() );
 
    // process the node itself
    if (processNode(lay, level).isFailure()){
        ATH_MSG_FATAL("Failed to call processNode(const Layer&). Aborting.");
        return StatusCode::FAILURE;
    }
    // get the subsurface array
    Trk::SurfaceArray* surfArray = lay.surfaceArray();
    if (surfArray) {
        std::span<Trk::Surface * const > layerSurfaces = surfArray->arrayObjects();
        ATH_MSG_VERBOSE(displayBuffer.str() << "   ---> has " << layerSurfaces.size() << " surfaces on the layer.");
 
        auto laySurfIter    = layerSurfaces.begin();
        auto laySurfIterEnd = layerSurfaces.end();
        // loop over the surfaces and draw them
        for ( ; laySurfIter != laySurfIterEnd; ++laySurfIter) {
             if (!(*laySurfIter))
                 ATH_MSG_WARNING("Zero-pointer found in SurfaceArray - indicates problem !");
             if ((*laySurfIter) && process(**laySurfIter, level).isFailure()){
                 ATH_MSG_FATAL("Failed to call process(const Surface&) on confined layer surfaces. Aborting.");
                 return StatusCode::FAILURE;
             }
        }
    }
    // return SUCCESS
    return StatusCode::SUCCESS;
}

◆ process() [2/4]

StatusCode Trk::RecursiveGeometryProcessor::process	(	Trk::Surface &	surf,
		size_t	level = 0 ) const

virtual

Processor Action to work on Surfaces.

Implements Trk::IGeometryProcessor.

Definition at line 162 of file RecursiveGeometryProcessor.cxx.

                                                                                      {
    return processNode(surf, level);
}

◆ process() [3/4]

StatusCode Trk::RecursiveGeometryProcessor::process ( Trk::TrackingGeometry & tgeo ) const

virtual

Processor Action to work on TrackingGeometry& tgeo.

Implements Trk::IGeometryProcessor.

Definition at line 46 of file RecursiveGeometryProcessor.cxx.

                                                                                 {
 
  ATH_MSG_VERBOSE("Start processing the TrackingGeometry recursively");
  // retrieve the highest tracking volume
  Trk::TrackingVolume* worldVolume = tgeo.highestTrackingVolume();
  if (worldVolume){
      ATH_MSG_VERBOSE("TrackingVolume '" << worldVolume->volumeName() << "' retrieved as highest level node.");
      return process(*worldVolume, 0);
  }
  // abort job
  ATH_MSG_FATAL("No highest level TrackingVolume found. Stopping recursive parsing, abort job.");
  return StatusCode::FAILURE;
}

◆ process() [4/4]

StatusCode Trk::RecursiveGeometryProcessor::process	(	Trk::TrackingVolume &	tvol,
		size_t	level = 0 ) const

virtual

Processor Action to work on TrackingVolumes - the level is for the hierachy tree.

Implements Trk::IGeometryProcessor.

Definition at line 61 of file RecursiveGeometryProcessor.cxx.

                                                                                             {
 
  std::stringstream displayBuffer;
  for (size_t il = 0; il < level; ++il) displayBuffer << " ";
  // formatted screen output
  ATH_MSG_VERBOSE(displayBuffer.str() << "TrackingVolume '" << tvol.volumeName() << "'");
 
  // create the action on the volume part of the TrackingVolume
  if (processNode(tvol, level).isFailure() ){
      ATH_MSG_FATAL("Failed to call processNode(const TrackingVolume&). Aborting.");
      return StatusCode::FAILURE;
  }
 
  // Process the contained layers if they exist
  Trk::LayerArray* layerArray = tvol.confinedLayers();
  if (layerArray) {
      // display output
      auto layers = layerArray->arrayObjects();
      ATH_MSG_VERBOSE(displayBuffer.str() << "--> has " << layers.size() << " confined layers." );
      for (const auto & layIter : layers){
          if (!layIter)
             ATH_MSG_WARNING("Zero-pointer found in LayerArray - indicates problem !");
          if ((layIter) && process(*layIter, level).isFailure()){
             ATH_MSG_FATAL("Failed to call process(const Layer&) on confined layers. Aborting.");
             return StatusCode::FAILURE;
          }
      }
   }
 
   // Process the boundary surface layers
   auto bSurfaces = tvol.boundarySurfaces();
   for (auto & bSurface : bSurfaces){
       if (bSurface->surfaceRepresentation().associatedLayer()){
           ATH_MSG_VERBOSE(displayBuffer.str() << "--> has a boundary layer." );
           if (process(
                 const_cast<Trk::Layer&>(
                   *bSurface->surfaceRepresentation().associatedLayer()),level)
                 .isFailure()) {
             ATH_MSG_FATAL("Failed to call process(const Layer&) on boundary "
                           "layer. Aborting.");
             return StatusCode::FAILURE;
           }
       }
   }
 
 
   // Process the contained TrackingVolumes (recursively) if they exist
   Trk::BinnedArray< Trk::TrackingVolume >* confinedVolumes = tvol.confinedVolumes();
   // register the next round
   if (confinedVolumes) {
       auto volumes = confinedVolumes->arrayObjects();
       for (const auto & volumesIter : volumes){
           if (!volumesIter)
              ATH_MSG_WARNING("Zero-pointer found in VolumeArray - indicates problem !");
           if (volumesIter && process(*volumesIter, ++level).isFailure() ){
               ATH_MSG_FATAL("Failed to call process(const TrackingVolume&) on confined volumes. Aborting.");
               return StatusCode::FAILURE;
           }
       }
   }
 
   // return
   return StatusCode::SUCCESS;
 
}

◆ processNode() [1/3]

StatusCode Trk::RecursiveGeometryProcessor::processNode	(	const Layer &	lay,
		size_t	level = 0 ) const

protectedvirtual

Processor Action to work on Layers.

Reimplemented in Trk::GeometryAsciiDumper, Trk::GeometryJsonDumper, Trk::GeometryTTreeDumper, Trk::LayerMaterialInspector, and Trk::TrackingVolumeDisplayer.

Definition at line 172 of file RecursiveGeometryProcessor.cxx.

                                                                                    {
    return StatusCode::SUCCESS;
}

◆ processNode() [2/3]

StatusCode Trk::RecursiveGeometryProcessor::processNode	(	const Surface &	surf,
		size_t	level = 0 ) const

protectedvirtual

Processor Action to work on Surfaces.

Reimplemented in Trk::GeometryAsciiDumper, Trk::GeometryJsonDumper, Trk::GeometryTTreeDumper, Trk::LayerMaterialInspector, and Trk::TrackingVolumeDisplayer.

Definition at line 176 of file RecursiveGeometryProcessor.cxx.

                                                                                      {
    return StatusCode::SUCCESS;
}

◆ processNode() [3/3]

StatusCode Trk::RecursiveGeometryProcessor::processNode	(	const TrackingVolume &	tvol,
		size_t	level = 0 ) const

protectedvirtual

Dedicated action for the different processors.

Processor Action to work on TrackingVolumes - the level is for the hierachy tree

Reimplemented in Trk::GeometryAsciiDumper, Trk::GeometryJsonDumper, Trk::GeometryTTreeDumper, Trk::LayerMaterialInspector, and Trk::TrackingVolumeDisplayer.

Definition at line 167 of file RecursiveGeometryProcessor.cxx.

                                                                                             {
    return StatusCode::SUCCESS;
}

◆ 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< AlgTool > >::renounce ( T & h )

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

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

◆ renounceArray()

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

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                          {
    handlesArray.renounce();
  }

◆ sysInitialize()

virtual StatusCode AthCommonDataStore< AthCommonMsg< AlgTool > >::sysInitialize ( )

overridevirtualinherited

Perform system initialization for an algorithm.

We override this to declare all the elements of handle key arrays at the end of initialization. See comments on updateVHKA.

Reimplemented in asg::AsgMetadataTool, AthCheckedComponent< AthAlgTool >, AthCheckedComponent<::AthAlgTool >, and DerivationFramework::CfAthAlgTool.

◆ sysStart()

virtual StatusCode AthCommonDataStore< AthCommonMsg< AlgTool > >::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< AlgTool > >::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< AlgTool > >::m_detStore

privateinherited

Pointer to StoreGate (detector store by default)

Definition at line 393 of file AthCommonDataStore.h.

◆ m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_evtStore

privateinherited

Pointer to StoreGate (event store by default)

Definition at line 390 of file AthCommonDataStore.h.

◆ m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< AlgTool > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

◆ m_vhka

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

privateinherited

Definition at line 398 of file AthCommonDataStore.h.

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

Constructor & Destructor Documentation

◆ RecursiveGeometryProcessor()

◆ ~RecursiveGeometryProcessor()

Member Function Documentation

◆ declareGaudiProperty()

◆ DeclareInterfaceID()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ extraDeps_update_handler()

◆ finalize()

◆ initialize()

◆ inputHandles()

◆ msg()

◆ msgLvl()

◆ outputHandles()

◆ process() [1/4]

◆ process() [2/4]

◆ process() [3/4]

◆ process() [4/4]

◆ processNode() [1/3]

◆ processNode() [2/3]

◆ processNode() [3/3]

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_detStore

◆ m_evtStore

◆ m_varHandleArraysDeclared

◆ m_vhka