Trk::TrackingVolumeDisplayer Class Reference

#include <TrackingVolumeDisplayer.h>

Inheritance diagram for Trk::TrackingVolumeDisplayer:

Collaboration diagram for Trk::TrackingVolumeDisplayer:

Public Member Functions
	TrackingVolumeDisplayer (const std::string &, const std::string &, const IInterface *)
	Constructor. More...
virtual	~TrackingVolumeDisplayer ()
	Destructor. More...
StatusCode	initialize ()
	AlgTool initialize method. More...
StatusCode	finalize ()
	AlgTool finalize method. More...
virtual StatusCode	process (TrackingGeometry &tgeo) const
	Processor Action to work on TrackingGeometry& tgeo. More...
virtual StatusCode	process (TrackingVolume &tvol, size_t level=0) const
	Processor Action to work on TrackingVolumes - the level is for the hierachy tree. More...
virtual StatusCode	process (Layer &lay, size_t level=0) const
	Processor Action to work on Layers. More...
virtual StatusCode	process (Surface &surf, size_t level=0) const
	Processor Action to work on Surfaces. More...
ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc. More...
const ServiceHandle< StoreGateSvc > &	evtStore () const
	The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc. More...
const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc. More...
virtual StatusCode	sysInitialize () override
	Perform system initialization for an algorithm. More...
virtual StatusCode	sysStart () override
	Handle START transition. More...
virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles. More...
virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles. More...
Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T > &t)
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleKey &hndl, const std::string &doc, const SG::VarHandleKeyType &)
	Declare a new Gaudi property. More...
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleBase &hndl, const std::string &doc, const SG::VarHandleType &)
	Declare a new Gaudi property. More...
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleKeyArray &hndArr, const std::string &doc, const SG::VarHandleKeyArrayType &)
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, T &property, const std::string &doc, const SG::NotHandleType &)
	Declare a new Gaudi property. More...
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, T &property, const std::string &doc="none")
	Declare a new Gaudi property. More...
void	updateVHKA (Gaudi::Details::PropertyBase &)
MsgStream &	msg () const
MsgStream &	msg (const MSG::Level lvl) const
bool	msgLvl (const MSG::Level lvl) const
	DeclareInterfaceID (IGeometryProcessor, 1, 0)
	Creates the InterfaceID and interfaceID() method. More...

Protected Member Functions
void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution More...
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. More...

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
StatusCode	processNode (const TrackingVolume &tvol, size_t level=0) const
	Current implementation: write root visualization to file stream. More...
StatusCode	processNode (const Layer &lay, size_t level=0) const
	Current implementation: write root visualization to file stream. More...
StatusCode	processNode (const Surface &, size_t level=0) const
	Current implementation: write root visualization to file stream. More...
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey> More...
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleKeyArrayType &)
	specialization for handling Gaudi::Property<SG::VarHandleKeyArray> More...
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleType &)
	specialization for handling Gaudi::Property<SG::VarHandleBase> More...
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &t, const SG::NotHandleType &)
	specialization for handling everything that's not a Gaudi::Property<SG::VarHandleKey> or a <SG::VarHandleKeyArray> More...

Static Private Member Functions
static void	openFile (std::ofstream &output, const std::string &filename)
	File handling: open + write header. More...
static void	closeFile (std::ofstream &output)
	File handling: write footer + close. More...
static int	colorCodeFromMaterial (const Trk::MaterialProperties *prop, std::ofstream &output)
	calculate the color code from the Material More...

Private Attributes
int	m_volumeCounter
	volume counter More...
std::ofstream	m_fileVolumeOutput
	file output for visualization action More...
std::string	m_fileVolumeOutputName
	file name for visualization action More...
bool	m_fileVolumeOutputMode
	steer writing More...
std::ofstream	m_fileLayerOutput
	file output for visualization action More...
std::string	m_fileLayerOutputName
	file name for visualization action More...
bool	m_fileLayerOutputMode
	steer writing More...
std::ofstream	m_fileSurfaceOutput
	file output for visualization action More...
std::string	m_fileSurfaceOutputName
	file name for visualization action More...
bool	m_fileSurfaceOutputMode
	steer writing More...
bool	m_fileSurfaceOutputSplit
	use one file for each layer More...
StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default) More...
StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default) More...
std::vector< SG::VarHandleKeyArray * >	m_vhka
bool	m_varHandleArraysDeclared

Static Private Attributes
static int	s_displaySurfaces = 0
	static surface counter More...

Detailed Description

The TrackingVolumeDisplayer writes a root .C file which can be executed and used the OpenGL root viewer

Author

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

Definition at line 34 of file TrackingVolumeDisplayer.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

TrackingVolumeDisplayer()

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

Constructor.

Definition at line 36 of file TrackingVolumeDisplayer.cxx.

                                                                                                               : 
  Trk::RecursiveGeometryProcessor(t,n,p),
  m_volumeCounter(0),
  m_fileVolumeOutputName("TrackingGeometryVolumeDisplay.C"),
  m_fileVolumeOutputMode(true),
  m_fileLayerOutputName("TrackingGeometryLayerDisplay.C"),
  m_fileLayerOutputMode(true),
  m_fileSurfaceOutputName("TrackingGeometrySurfaceDisplay.C"),
  m_fileSurfaceOutputMode(true),
  m_fileSurfaceOutputSplit(false)
{
    // set name and output type
    declareProperty("TrackingVolumeOutputFile",  m_fileVolumeOutputName);
    declareProperty("TrackingVolumeOutput",      m_fileVolumeOutputMode);
    declareProperty("LayerOutputFile",           m_fileLayerOutputName);
    declareProperty("LayerOutput",               m_fileLayerOutputMode);
    declareProperty("SurfaceOutputFile",         m_fileSurfaceOutputName);
    declareProperty("SurfaceOutput",             m_fileSurfaceOutputMode);
    declareProperty("SurfaceOutputSplit",        m_fileSurfaceOutputSplit);
}

~TrackingVolumeDisplayer()

Trk::TrackingVolumeDisplayer::~TrackingVolumeDisplayer ( )

virtualdefault

Destructor.

Member Function Documentation

closeFile()

void Trk::TrackingVolumeDisplayer::closeFile ( std::ofstream &  output )

staticprivate

File handling: write footer + close.

Definition at line 118 of file TrackingVolumeDisplayer.cxx.

{
    out << "worldnode->cd();" << '\n';
    out << "worldnode->Draw(\"ogl\");" << '\n';
    out << "tg->Update();" << '\n';
    out << "}" << '\n';
    out.close();
}

colorCodeFromMaterial()

int Trk::TrackingVolumeDisplayer::colorCodeFromMaterial ( const Trk::MaterialProperties *  prop, std::ofstream &  output  )

staticprivate

calculate the color code from the Material

Definition at line 372 of file TrackingVolumeDisplayer.cxx.

{
    if (!prop) return 6;
    // start from 100 and reduce by radiation length
    int color = 100;
    double tInX0 = prop->thicknessInX0();
    // write out a comment line
    output << "// MaterialProperties : t/X0    = " << tInX0 << std::endl;
    output << "//     zOverAtimesRho : Z/A*rho = " << prop->zOverAtimesRho() << std::endl;
    // 0 % : --> color code 100
    // 4 % : --> color code 52 
    color -= int(tInX0 * 1200);
    return color;
}

declareGaudiProperty() [1/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty ( Gaudi::Property< T > &  hndl, const SG::VarHandleKeyArrayType &    )

inlineprivateinherited

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

Definition at line 170 of file AthCommonDataStore.h.

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

declareGaudiProperty() [2/4]

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

declareGaudiProperty() [3/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty ( Gaudi::Property< T > &  hndl, const SG::VarHandleType &    )

inlineprivateinherited

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

Definition at line 184 of file AthCommonDataStore.h.

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

declareGaudiProperty() [4/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty ( Gaudi::Property< T > &  t, const SG::NotHandleType &    )

inlineprivateinherited

specialization for handling everything that's not a Gaudi::Property<SG::VarHandleKey> or a <SG::VarHandleKeyArray>

Definition at line 199 of file AthCommonDataStore.h.

  {
    return PBASE::declareProperty(t);
  }

DeclareInterfaceID()

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

inherited

Creates the InterfaceID and interfaceID() method.

declareProperty() [1/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( const std::string &  name, SG::VarHandleBase &  hndl, const std::string &  doc, const SG::VarHandleType &    )

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
hndl	Object holding the property value.
doc	Documentation string for the property.

This is the version for types that derive from SG::VarHandleBase. The property value object is put on the input and output lists as appropriate; then we forward to the base class.

Definition at line 245 of file AthCommonDataStore.h.

  {
    this->declare(hndl.vhKey());
    hndl.vhKey().setOwner(this);
 
    return PBASE::declareProperty(name,hndl,doc);
  }

declareProperty() [2/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( const std::string &  name, SG::VarHandleKey &  hndl, const std::string &  doc, const SG::VarHandleKeyType &    )

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
hndl	Object holding the property value.
doc	Documentation string for the property.

This is the version for types that derive from SG::VarHandleKey. The property value object is put on the input and output lists as appropriate; then we forward to the base class.

Definition at line 221 of file AthCommonDataStore.h.

  {
    this->declare(hndl);
    hndl.setOwner(this);
 
    return PBASE::declareProperty(name,hndl,doc);
  }

declareProperty() [3/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( const std::string &  name, SG::VarHandleKeyArray &  hndArr, const std::string &  doc, const SG::VarHandleKeyArrayType &    )

inlineinherited

Definition at line 259 of file AthCommonDataStore.h.

  {
 
    // std::ostringstream ost;
    // ost << Algorithm::name() << " VHKA declareProp: " << name 
    //     << " size: " << hndArr.keys().size() 
    //     << " mode: " << hndArr.mode() 
    //     << "  vhka size: " << m_vhka.size()
    //     << "\n";
    // debug() << ost.str() << endmsg;
 
    hndArr.setOwner(this);
    m_vhka.push_back(&hndArr);
 
    Gaudi::Details::PropertyBase* p =  PBASE::declareProperty(name, hndArr, doc);
    if (p != 0) {
      p->declareUpdateHandler(&AthCommonDataStore<PBASE>::updateVHKA, this);
    } else {
      ATH_MSG_ERROR("unable to call declareProperty on VarHandleKeyArray " 
                    << name);
    }
 
    return p;
 
  }

declareProperty() [4/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( const std::string &  name, T &  property, const std::string &  doc, const SG::NotHandleType &    )

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
property	Object holding the property value.
doc	Documentation string for the property.

This is the generic version, for types that do not derive from SG::VarHandleKey. It just forwards to the base class version of declareProperty.

Definition at line 333 of file AthCommonDataStore.h.

  {
    return PBASE::declareProperty(name, property, doc);
  }

declareProperty() [5/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( const std::string &  name, T &  property, const std::string &  doc = "none"  )

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
property	Object holding the property value.
doc	Documentation string for the property.

This dispatches to either the generic declareProperty or the one for VarHandle/Key/KeyArray.

Definition at line 352 of file AthCommonDataStore.h.

  {
    typedef typename SG::HandleClassifier<T>::type htype;
    return declareProperty (name, property, doc, htype());
  }

declareProperty() [6/6]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( Gaudi::Property< T > &  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.

{ return m_detStore; }

evtStore() [1/2]

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.

{ return m_evtStore; }

evtStore() [2/2]

const ServiceHandle<StoreGateSvc>& AthCommonDataStore< AthCommonMsg< AlgTool > >::evtStore ( ) const

inlineinherited

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

Definition at line 90 of file AthCommonDataStore.h.

{ return m_evtStore; }

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::TrackingVolumeDisplayer::finalize

(

)

AlgTool finalize method.

Definition at line 87 of file TrackingVolumeDisplayer.cxx.

{
    ATH_MSG_INFO( "finalize() successful" );    
 
    // open the file for writing 
    if (m_fileVolumeOutputMode)
        closeFile(m_fileVolumeOutput);
    // open the file for writing
    if (m_fileLayerOutputMode)
        closeFile(m_fileLayerOutput);
    // open the file for writing
    if (m_fileSurfaceOutputMode && !m_fileSurfaceOutputSplit)
        closeFile(m_fileSurfaceOutput);
 
    return StatusCode::SUCCESS;
}

initialize()

StatusCode Trk::TrackingVolumeDisplayer::initialize

(

)

AlgTool initialize method.

Definition at line 63 of file TrackingVolumeDisplayer.cxx.

{
 
    ATH_MSG_INFO( "initialize()" );    
 
    if (Trk::RecursiveGeometryProcessor::initialize().isFailure()){
        ATH_MSG_FATAL("Could not initialize base tool. Aborting.");
        return StatusCode::FAILURE;
    }
 
    // open the file for writing 
    if (m_fileVolumeOutputMode)
        openFile(m_fileVolumeOutput, m_fileVolumeOutputName);
    // open the file for writing
    if (m_fileLayerOutputMode)
        openFile(m_fileLayerOutput, m_fileLayerOutputName);
    // open the file for writing
    if (m_fileSurfaceOutputMode && !m_fileSurfaceOutputSplit)
        openFile(m_fileSurfaceOutput, m_fileSurfaceOutputName);
 
    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() [1/2]

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

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

msg() [2/2]

MsgStream& AthCommonMsg< AlgTool >::msg ( const MSG::Level  lvl ) const

inlineinherited

Definition at line 27 of file AthCommonMsg.h.

                                                  {
    return this->msgStream(lvl);
  }

msgLvl()

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

inlineinherited

Definition at line 30 of file AthCommonMsg.h.

                                               {
    return this->msgLevel(lvl);
  }

openFile()

void Trk::TrackingVolumeDisplayer::openFile ( std::ofstream &  output, const std::string &  filename  )

staticprivate

File handling: open + write header.

Definition at line 105 of file TrackingVolumeDisplayer.cxx.

{
    // open the file
    out.open(filename.c_str());
    // write the header
    out << "{" << '\n';  
    out << "tg = new TCanvas(\"tg\",\"Geometry Shapes\",200,10,700,500);" <<'\n';
    out << "   world = new TBRIK(\"BRIK\",\"BRIK\",\"void\",2,2,2);" << '\n';
    out << "   worldnode = new TNode(\"NODE1\",\"NODE1\",\"BRIK\");" << '\n';
    out << "   worldnode->cd();" << '\n';
}

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

virtualinherited

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) {
        Trk::BinnedArraySpan<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

virtualinherited

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

virtualinherited

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

virtualinherited

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::TrackingVolumeDisplayer::processNode ( const Layer &  lay, size_t  level = 0  ) const

privatevirtual

Current implementation: write root visualization to file stream.

Reimplemented from Trk::RecursiveGeometryProcessor.

Definition at line 166 of file TrackingVolumeDisplayer.cxx.

{
    
    ATH_MSG_VERBOSE("Writing display information for Layer.");
    // get the identifier
    int layerIndex = lay.layerIndex().value();
    int layerIndexStr = (layerIndex < 0) ? (-layerIndex)+1 : layerIndex;  
    // the layer position
    const Amg::Vector3D& layerPosition  = lay.surfaceRepresentation().center();
    double               layerPositionZ = layerPosition.z();
    // output mode
    if (m_fileSurfaceOutputMode && m_fileSurfaceOutputSplit) {
        std::stringstream ss;
        std::string str;
        ss << "Layer" << layerIndexStr << "_" << m_fileSurfaceOutputName; 
        ss >> str;
        openFile(m_fileSurfaceOutput, str);
        m_fileSurfaceOutput<<"// Enclosing Volume: "<<lay.enclosingTrackingVolume()->volumeName()<<std::endl;
    }
 
    if (m_fileSurfaceOutputMode) {
        const Trk::SurfaceArray* surfArray = lay.surfaceArray();
        if (surfArray) {
            const auto & layerSurfaces = surfArray->arrayObjects();
            // loop over the surfaces and draw them
            for (const auto & laySurfIter : layerSurfaces) {
                if ( laySurfIter && processNode(*laySurfIter).isFailure()){
                    ATH_MSG_FATAL("Failed to call processNode(const Surface& sf) on sub surface. Abort.");
                    return StatusCode::FAILURE;
                }
            }
        }
    }
    if (m_fileSurfaceOutputMode && m_fileSurfaceOutputSplit)
        closeFile(m_fileSurfaceOutput);
 
    const Trk::Surface& lSurface = lay.surfaceRepresentation();
    int layerColor = lay.enclosingTrackingVolume() ? lay.enclosingTrackingVolume()->colorCode() : 22;
 
    // CYLINDER SECTION
    if (lSurface.type() == Trk::SurfaceType::Cylinder && layerIndex > 0) {
        // get the Bounds
        const Trk::CylinderBounds* cylBo = dynamic_cast<const Trk::CylinderBounds*>(&lSurface.bounds());
        if (!cylBo) {
          m_fileLayerOutput << "ERROR Cylinder surface without CylinderBounds\n";
          return StatusCode::FAILURE;
        }
        else {
        // set the boundaries
        double radius  = cylBo->r();
        double halfZ   = cylBo->halflengthZ();
        m_fileLayerOutput << "Cylinder" << layerIndexStr << " = new TTUBE(\"CylinderLayer";
        m_fileLayerOutput << layerIndexStr << "\",\"CylinderLayer" << layerIndex << "\",\"void\",";
        m_fileLayerOutput << int(radius-5) << "," << int(radius+5) << "," << int(halfZ) << ");" << '\n';
        // get the line color 
        m_fileLayerOutput << "Cylinder" << layerIndexStr << "->SetLineColor(" << layerColor << ");" << '\n';
        // write the node
        m_fileLayerOutput <<"Node" << layerIndexStr << " = new TNode(\"CylinderNode" << layerIndex;
        m_fileLayerOutput << "\",\"CylinderNode" << layerIndexStr << "\",\"CylinderLayer";
        m_fileLayerOutput << layerIndexStr << "\"," << 0 << "," << 0 << "," << int(layerPositionZ) << ");" << '\n';
        m_fileLayerOutput <<'\n';
 
        return StatusCode::SUCCESS;
        }
    } else if (lSurface.type() == Trk::SurfaceType::Disc && layerIndex > 0) {
        // get the Bounds
        const Trk::DiscBounds* discBo = dynamic_cast<const Trk::DiscBounds*>(&lSurface.bounds());
        if (!discBo) {
          m_fileLayerOutput << "ERROR Disc surface without DiscBounds\n";
          return StatusCode::FAILURE;
        }
        else {
 
        // set the boundaries
        double rMin    = discBo->rMin();
        double rMax    = discBo->rMax();
 
        m_fileLayerOutput << "Disc" << layerIndexStr << " = new TTUBE(\"DiscLayer" << layerIndexStr << "\",\"DiscLayer" << layerIndex << "\",\"void\",";
        m_fileLayerOutput << int(rMin+1.) << "," << int(rMax-1.) << ",10);" << '\n';
        // get the line color 
        m_fileLayerOutput << "Disc" << layerIndexStr << "->SetLineColor(" << layerColor << ");" << '\n';
        // write the node
        m_fileLayerOutput << "DiscNode" << layerIndexStr << " = new TNode(\"DiscNode" << layerIndex;
        m_fileLayerOutput << "\",\"DiscNode" << layerIndexStr << "\",\"DiscLayer";
        m_fileLayerOutput << layerIndexStr << "\"," << 0 << "," << 0 << "," << int(layerPositionZ) << ");" << '\n';
        m_fileLayerOutput <<'\n';
        return StatusCode::SUCCESS;
        }
    }
    return StatusCode::SUCCESS;    
}

processNode() [2/3]

StatusCode Trk::TrackingVolumeDisplayer::processNode ( const Surface &  sf, size_t  level = 0  ) const

privatevirtual

Current implementation: write root visualization to file stream.

Reimplemented from Trk::RecursiveGeometryProcessor.

Definition at line 259 of file TrackingVolumeDisplayer.cxx.

{
 
    ++s_displaySurfaces;
 
    ATH_MSG_VERBOSE("Writing display information for Surface.");
 
 
    m_fileSurfaceOutput << "// ---------------------- Surface -------------------------------// " << std::endl;
 
    // surface center
    double surfX = sf.center().x();
    double surfY = sf.center().y();
    double surfZ = sf.center().z();
    // rotation matrix
    const Amg::RotationMatrix3D sfRot = sf.transform().rotation();
 
    // ROOT wants the angles in degrees
    const double convFac = 180./M_PI;
    double xPhi   = sfRot.col(0).phi()*convFac;
    double xTheta = sfRot.col(0).theta()*convFac;
    double yPhi   = sfRot.col(1).phi()*convFac;
    double yTheta = sfRot.col(1).theta()*convFac;
    double zPhi   = sfRot.col(2).phi()*convFac;
    double zTheta = sfRot.col(2).theta()*convFac;
 
    // surface 
    TString surfaceString   = "Surface_";
    surfaceString  += s_displaySurfaces;
    TString rotationString  = "Rotation_";
    rotationString += s_displaySurfaces;
    TString nodeString      = "Node";
    nodeString     += s_displaySurfaces;
    // test version just with planar bounds
    const Trk::RectangleBounds* recBo = dynamic_cast<const Trk::RectangleBounds*>(&(sf.bounds()));
    const Trk::TrapezoidBounds* traBo = recBo ? nullptr : dynamic_cast<const Trk::TrapezoidBounds*>(&(sf.bounds()));
    const Trk::DiscTrapezoidalBounds* disctraBo = (recBo || traBo) ? nullptr : dynamic_cast<const Trk::DiscTrapezoidalBounds*>(&(sf.bounds()));
    if (recBo) {
        // it is a rectangle surface
        double halfX = recBo->halflengthX();
        double halfY = recBo->halflengthY();
        // prepare the surface
        m_fileSurfaceOutput << surfaceString << " =  new TBRIK(\""<< surfaceString << "\",\"" << surfaceString<< "\",\"void\",";
        m_fileSurfaceOutput << halfX << ","<<  halfY <<" ,2);" << '\n';
 
        m_fileSurfaceOutput << surfaceString << "->SetLineColor(80);" << std::endl;
 
        // the rotation    
        m_fileSurfaceOutput << rotationString << "= new TRotMatrix(\" "<< rotationString << " \",\" " << rotationString << " \", ";
        m_fileSurfaceOutput << xTheta << "," << xPhi << "," << yTheta << "," << yPhi << ", " << zTheta << "," << zPhi << ");" << std::endl;
 
    } else if (traBo) {
      //example
        //TGTRA gtra = new TGTRA("GTRA","GTRA","void",390,0,0,20,60,40,90,15120,80180,15);
        // prepare the surface (swap Y and Z)
        m_fileSurfaceOutput << surfaceString << " =  new TTRD1(\""<< surfaceString << "\",\"" << surfaceString<< "\",\"void\",";
        m_fileSurfaceOutput << traBo->minHalflengthX() << "," << traBo->maxHalflengthX() << ",2," << traBo->halflengthY() << ");"  << '\n';
 
        m_fileSurfaceOutput << surfaceString << "->SetLineColor(80);" << std::endl;
 
        // the rotation (swap Y and Z)
        m_fileSurfaceOutput << rotationString << "= new TRotMatrix(\" "<< rotationString << " \",\" " << rotationString << " \", ";
        m_fileSurfaceOutput << xTheta << "," << xPhi << ", " << zTheta << "," << zPhi << "," << yTheta << "," << yPhi << ");" << std::endl;
    } else if (disctraBo) {
      //double rMedium  = disctraBo->rCenter();
      //double Rc = (sf.center()).perp();
      //double side = (sf.normal()).z();
      //double stereo = side*2.*asin(Rc/(2.*rMedium));
      //double avePhi = (side>0) ? disctraBo->averagePhi()+stereo : -disctraBo->averagePhi()+M_PI+stereo; 
 
      double stereo  = disctraBo->stereo();
      double rMedium = disctraBo->rCenter();
      double avePhi  = disctraBo->averagePhi()+stereo;
      
      surfX = rMedium*cos(avePhi);
      surfY = rMedium*sin(avePhi);
      surfZ = (sf.center()).z();
 
      Amg::RotationMatrix3D rotation;
      rotation = Amg::AngleAxis3D(0., Amg::Vector3D::UnitX())*
    Amg::AngleAxis3D(0., Amg::Vector3D::UnitY())*
    Amg::AngleAxis3D(-M_PI/2.+avePhi-surfZ/fabs(surfZ)*stereo, Amg::Vector3D::UnitZ());
 
      // ROOT wants the angles in degrees
      xPhi   = rotation.col(0).phi()*convFac;
      xTheta = rotation.col(0).theta()*convFac;
      yPhi   = rotation.col(1).phi()*convFac;
      yTheta = rotation.col(1).theta()*convFac;
      zPhi   = rotation.col(2).phi()*convFac;
      zTheta = rotation.col(2).theta()*convFac;
    
      //example
      //TGTRA gtra = new TGTRA("GTRA","GTRA","void",390,0,0,20,60,40,90,15120,80180,15);
      // prepare the surface (swap Y and Z)
      m_fileSurfaceOutput << surfaceString << " =  new TTRD1(\""<< surfaceString << "\",\"" << surfaceString<< "\",\"void\",";
      m_fileSurfaceOutput << disctraBo->minHalflengthX() << "," << disctraBo->maxHalflengthX() << ",2," << disctraBo->halflengthY() << ");"  << '\n';
      
      m_fileSurfaceOutput << surfaceString << "->SetLineColor(80);" << std::endl;
      
      // the rotation (swap Y and Z)
      m_fileSurfaceOutput << rotationString << "= new TRotMatrix(\" "<< rotationString << " \",\" " << rotationString << " \", ";
      m_fileSurfaceOutput << xTheta << "," << xPhi << ", " << zTheta << "," << zPhi << "," << yTheta << "," << yPhi << ");" << std::endl;
    }
    
    // the node
    m_fileSurfaceOutput << nodeString << " = new TNode(\"" << nodeString << "\",\"" << nodeString << "\"," << surfaceString;
    m_fileSurfaceOutput << "," << surfX << ", " << surfY << "," << surfZ << ", " << rotationString << ");" << std::endl;
    
    return StatusCode::SUCCESS;    
 
}

processNode() [3/3]

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

privatevirtual

Current implementation: write root visualization to file stream.

Reimplemented from Trk::RecursiveGeometryProcessor.

Definition at line 128 of file TrackingVolumeDisplayer.cxx.

{
 
    ATH_MSG_VERBOSE("Writing display information for TrackingVolume.");
 
    // make a dynamic cast to the CylinderVolumeBounds
    const Trk::CylinderVolumeBounds* cvol = dynamic_cast<const Trk::CylinderVolumeBounds*>(&tvol.volumeBounds());
 
    double rMin  = 0.;
    double rMax  = 0.;
    double halfZ = 0.; 
 
    if (cvol) {
        // from the color code one can determine if its a gap volume
        // set the boundaries
        rMin  = cvol->innerRadius();
        rMax  = cvol->outerRadius();
        halfZ = cvol->halflengthZ();
    }
 
   // get the name
   const std::string& volumeName = tvol.volumeName();
   // write a debug line
   m_fileVolumeOutput << "// Processing TrackingVolume '" << volumeName << "'. " << '\n'; 
   m_fileVolumeOutput << "CylinderVolume" << m_volumeCounter  << " = new TTUBE(\"" << volumeName << "\",\"" << volumeName << "\",\"void\",";
   m_fileVolumeOutput << int(rMin)+1 << "," << int(rMax)-1 << "," << int(halfZ)-1 << ");" << '\n';
   m_fileVolumeOutput << "CylinderVolume" << m_volumeCounter  << "->SetLineColor(" << tvol.colorCode() << ");" << '\n';
   double zPos = tvol.center().z();
   m_fileVolumeOutput << "CylinderNode" << m_volumeCounter << " = new TNode(\"" << volumeName << "Node\",\"" << volumeName << "Node\",\"";
   m_fileVolumeOutput << volumeName << "\"," << 0 << "," << 0 << "," << int(zPos) << ");" << '\n';
   m_fileVolumeOutput <<'\n';
   ++m_volumeCounter;
   
   // return successful
   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 DerivationFramework::CfAthAlgTool, AthCheckedComponent< AthAlgTool >, AthCheckedComponent<::AthAlgTool >, and asg::AsgMetadataTool.

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_fileLayerOutput

std::ofstream Trk::TrackingVolumeDisplayer::m_fileLayerOutput

mutableprivate

file output for visualization action

Definition at line 73 of file TrackingVolumeDisplayer.h.

m_fileLayerOutputMode

bool Trk::TrackingVolumeDisplayer::m_fileLayerOutputMode

mutableprivate

steer writing

Definition at line 75 of file TrackingVolumeDisplayer.h.

m_fileLayerOutputName

std::string Trk::TrackingVolumeDisplayer::m_fileLayerOutputName

mutableprivate

file name for visualization action

Definition at line 74 of file TrackingVolumeDisplayer.h.

m_fileSurfaceOutput

std::ofstream Trk::TrackingVolumeDisplayer::m_fileSurfaceOutput

mutableprivate

file output for visualization action

Definition at line 77 of file TrackingVolumeDisplayer.h.

m_fileSurfaceOutputMode

bool Trk::TrackingVolumeDisplayer::m_fileSurfaceOutputMode

mutableprivate

steer writing

Definition at line 79 of file TrackingVolumeDisplayer.h.

m_fileSurfaceOutputName

std::string Trk::TrackingVolumeDisplayer::m_fileSurfaceOutputName

mutableprivate

file name for visualization action

Definition at line 78 of file TrackingVolumeDisplayer.h.

m_fileSurfaceOutputSplit

bool Trk::TrackingVolumeDisplayer::m_fileSurfaceOutputSplit

mutableprivate

use one file for each layer

Definition at line 80 of file TrackingVolumeDisplayer.h.

m_fileVolumeOutput

std::ofstream Trk::TrackingVolumeDisplayer::m_fileVolumeOutput

mutableprivate

file output for visualization action

Definition at line 69 of file TrackingVolumeDisplayer.h.

m_fileVolumeOutputMode

bool Trk::TrackingVolumeDisplayer::m_fileVolumeOutputMode

mutableprivate

steer writing

Definition at line 71 of file TrackingVolumeDisplayer.h.

m_fileVolumeOutputName

std::string Trk::TrackingVolumeDisplayer::m_fileVolumeOutputName

mutableprivate

file name for visualization action

Definition at line 70 of file TrackingVolumeDisplayer.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.

m_volumeCounter

int Trk::TrackingVolumeDisplayer::m_volumeCounter

mutableprivate

volume counter

Definition at line 67 of file TrackingVolumeDisplayer.h.

s_displaySurfaces

int Trk::TrackingVolumeDisplayer::s_displaySurfaces = 0

staticprivate

static surface counter

Definition at line 82 of file TrackingVolumeDisplayer.h.

---

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

• TrackingVolumeDisplayer.h
• TrackingVolumeDisplayer.cxx