The RandomSurfaceBuilder is a simple Tool that helps to construct randomly poisitioned surfaces - mainly for validation studies. More...

#include <RandomSurfaceBuilder.h>

Inheritance diagram for Trk::RandomSurfaceBuilder:

Collaboration diagram for Trk::RandomSurfaceBuilder:

Public Member Functions
	RandomSurfaceBuilder (const std::string &, const std::string &, const IInterface *)
	Constructor.
virtual	~RandomSurfaceBuilder ()
	Destructor.
StatusCode	initialize ()
	AlgTool initialize method.
StatusCode	finalize ()
	AlgTool finalize method.
const std::vector< const Surface * > *	surfaces () const
	SurfaceBuilder interface method - provide a vector of surfaces -.
const Surface *	surface () const
	SurfaceBuilder interface method - provice a single surface.
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 (ISurfaceBuilder, 1, 0)
	Creates the InterfaceID and interfaceID() method.

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
SmartIF< IRndmGenSvc >	m_rndmSvc
	random number engine used
Rndm::Numbers *	m_gaussDist
Rndm::Numbers *	m_flatDist
size_t	m_numberOfSurfaces
bool	m_enableCones
std::vector< double >	m_worldDimensions
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

The RandomSurfaceBuilder is a simple Tool that helps to construct randomly poisitioned surfaces - mainly for validation studies.

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

Definition at line 33 of file RandomSurfaceBuilder.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

◆ RandomSurfaceBuilder()

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

Constructor.

Definition at line 23 of file RandomSurfacesBuilder.cxx.

: AthAlgTool(t,n,p),    
  m_gaussDist(nullptr),
  m_flatDist(nullptr),
  m_numberOfSurfaces(100),
  m_enableCones(false)
{
   
    declareInterface<ISurfaceBuilder>(this);
   
    // the active dimensions
    declareProperty("NumberOfSurfaces", m_numberOfSurfaces);
    declareProperty("WorldDimensions",  m_worldDimensions);
}

◆ ~RandomSurfaceBuilder()

Trk::RandomSurfaceBuilder::~RandomSurfaceBuilder ( )

virtual

Destructor.

Definition at line 39 of file RandomSurfacesBuilder.cxx.

{
    delete m_gaussDist;
    delete m_flatDist;
}

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::ISurfaceBuilder::DeclareInterfaceID	(	ISurfaceBuilder	,
		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::RandomSurfaceBuilder::finalize ( )

AlgTool finalize method.

Definition at line 63 of file RandomSurfacesBuilder.cxx.

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

◆ initialize()

StatusCode Trk::RandomSurfaceBuilder::initialize ( )

AlgTool initialize method.

Definition at line 48 of file RandomSurfacesBuilder.cxx.

{
   
   // Random number service
   m_rndmSvc = service("RndmGenSvc");
   ATH_CHECK( m_rndmSvc.isValid() );
 
   // intialize the random number generators
   m_gaussDist = new Rndm::Numbers(m_rndmSvc, Rndm::Gauss(0.,1.));
   m_flatDist  = new Rndm::Numbers(m_rndmSvc, Rndm::Flat(0.,1.));
   
   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.

◆ 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();
  }

◆ surface()

const Trk::Surface * Trk::RandomSurfaceBuilder::surface ( ) const

virtual

SurfaceBuilder interface method - provice a single surface.

Implements Trk::ISurfaceBuilder.

Definition at line 87 of file RandomSurfacesBuilder.cxx.

{
    if (m_worldDimensions.size() < 3 ) return nullptr;
    
    const Trk::Surface* surface = nullptr;
    int sType = std::floor(m_flatDist->shoot()*6);
        
    // neglect 0 if you don't do cones
    if (!m_enableCones && !sType){
        while (!sType)
         sType = std::floor(m_flatDist->shoot()*6);   
    }
    
    sType = sType == 6 ? 5 : sType;
    // create the transform parameters
    double tx = m_worldDimensions[0]*(2*m_flatDist->shoot()-1);
    double ty = m_worldDimensions[1]*(2*m_flatDist->shoot()-1);
    double tz = m_worldDimensions[2]*(2*m_flatDist->shoot()-1);
    double dx = m_flatDist->shoot();
    double dy = m_flatDist->shoot();
    double dz = m_flatDist->shoot();
    
     std::unique_ptr<Amg::Transform3D> transform( new Amg::Transform3D );
     // the direciton and curvilinear UVT frame
     Amg::Vector3D direction(dx,dy,dz);
     
     Trk::CurvilinearUVT curvUVT(direction.normalized());
     // translation
     Amg::Translation3D translation(tx, ty, tz);
     
     // create the rotation 
     Amg::RotationMatrix3D rotation;     
     rotation.col(0) = curvUVT.curvU();
     rotation.col(1) = curvUVT.curvV();
     rotation.col(2) = curvUVT.curvT();
     // curvilinear surfaces are boundless
     (*transform)  = translation;
     (*transform).rotate(rotation);
     ATH_MSG_VERBOSE("Created transform is : " << Amg::toString(*transform));
     
     // create the surface
     switch (sType) {
         // create a cone surface - cone does not exist for old EDM as Measured
         case 0 :  {   
             surface = new Trk::ConeSurface(*transform, m_flatDist->shoot()*0.7*M_PI); 
         } break;
         case 1 : {   
             surface = new Trk::CylinderSurface(*transform, 50.+m_worldDimensions[0]*m_flatDist->shoot(), m_worldDimensions[2]);
         } break;
         // create a disc surface
         case 2 : {   
             surface = new Trk::DiscSurface(*transform, 0., m_worldDimensions[1]);
         } break;
         // create a perigee surface
         case 3 : {   
             surface = new Trk::PerigeeSurface(Amg::Vector3D(tx,ty,tz));
         } break;
         // create a plane surface
         case 4 : {
             surface = new Trk::PlaneSurface(*transform, m_worldDimensions[0], m_worldDimensions[0]);
         } break;
         // create a straight line surface
         case 5 : {
             surface = new Trk::StraightLineSurface(*transform, 50., m_worldDimensions[2]);
         } break;
         default : break;    
     }
  return surface;
}

◆ surfaces()

const std::vector< const Trk::Surface * > * Trk::RandomSurfaceBuilder::surfaces ( ) const

virtual

SurfaceBuilder interface method - provide a vector of surfaces -.

Implements Trk::ISurfaceBuilder.

Definition at line 70 of file RandomSurfacesBuilder.cxx.

{
    std::vector<const Trk::Surface*>* cSurfaces = new std::vector<const Trk::Surface*>();
    cSurfaces->reserve(m_numberOfSurfaces);
    for ( size_t isf = 0; isf < m_numberOfSurfaces; ++isf ){
        const Trk::Surface* csf = surface();
        if (csf) cSurfaces->push_back(csf);
    }
    // check how many surfaces had been created
    if ( cSurfaces->size() != m_numberOfSurfaces )
        ATH_MSG_WARNING("Number of created surfaces (" << cSurfaces->size() 
                    <<  ") does not correspond to chosen number (" << m_numberOfSurfaces << ")." );
    return cSurfaces;
    
}

◆ 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_enableCones

bool Trk::RandomSurfaceBuilder::m_enableCones

private

Definition at line 61 of file RandomSurfaceBuilder.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_flatDist

Rndm::Numbers* Trk::RandomSurfaceBuilder::m_flatDist

private

Definition at line 58 of file RandomSurfaceBuilder.h.

◆ m_gaussDist

Rndm::Numbers* Trk::RandomSurfaceBuilder::m_gaussDist

private

Definition at line 57 of file RandomSurfaceBuilder.h.

◆ m_numberOfSurfaces

size_t Trk::RandomSurfaceBuilder::m_numberOfSurfaces

private

Definition at line 60 of file RandomSurfaceBuilder.h.

◆ m_rndmSvc

SmartIF<IRndmGenSvc> Trk::RandomSurfaceBuilder::m_rndmSvc

private

random number engine used

Definition at line 56 of file RandomSurfaceBuilder.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_worldDimensions

std::vector<double> Trk::RandomSurfaceBuilder::m_worldDimensions

private

Definition at line 62 of file RandomSurfaceBuilder.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

◆ RandomSurfaceBuilder()

◆ ~RandomSurfaceBuilder()

Member Function Documentation

◆ declareGaudiProperty()

◆ DeclareInterfaceID()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ extraDeps_update_handler()

◆ finalize()

◆ initialize()

◆ inputHandles()

◆ msg()

◆ msgLvl()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ surface()

◆ surfaces()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_detStore

◆ m_enableCones

◆ m_evtStore

◆ m_flatDist

◆ m_gaussDist

◆ m_numberOfSurfaces

◆ m_rndmSvc

◆ m_varHandleArraysDeclared

◆ m_vhka

◆ m_worldDimensions