Test calling the internal surface intersection methods. More...

#include <BinUtilityTest.h>

Inheritance diagram for Trk::BinUtilityTest:

Collaboration diagram for Trk::BinUtilityTest:

Public Member Functions
	BinUtilityTest (const std::string &name, ISvcLocator *pSvcLocator)
	Standard Athena-Algorithm Constructor.
StatusCode	runTest ()
StatusCode	initialize ()
	standard Athena-Algorithm method
StatusCode	execute ()
	standard Athena-Algorithm method
StatusCode	finalize ()
	standard Athena-Algorithm method
virtual StatusCode	bookTree ()
virtual StatusCode	initializeTest ()
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.

Protected Attributes
Rndm::Numbers *	m_gaussDist
	Random Number setup.
Rndm::Numbers *	m_flatDist
size_t	m_numTests
	number of tests

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
void	prepareData (std::vector< float > &vec, std::map< float, size_t > &map, float &low, float &high)
	preparation of std::vector and std::map for comparison
size_t	searchInVectorWithBoundary (std::vector< float > &array, float value)
	A binary search with a map - superior in O(10) searches.
size_t	binarySearchWithBoundary (std::vector< float > &array, float value)
	A binary search with underflow/overflow.
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
size_t	m_numberOfSegments
size_t	m_numberOfTestsPerSet
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

Test calling the internal surface intersection methods.

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

Definition at line 31 of file BinUtilityTest.h.

Member Typedef Documentation

◆ StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

◆ BinUtilityTest()

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

Standard Athena-Algorithm Constructor.

Definition at line 13 of file BinUtilityTest.cxx.

                                                                                 :
 Trk::TrkDetDescrUnitTestBase(name, pSvcLocator),
 m_numberOfSegments(10),
 m_numberOfTestsPerSet(100000)
{
    declareProperty("NumberOfSegments",    m_numberOfSegments);
    declareProperty("NumberOfTetsPerSet",  m_numberOfTestsPerSet);
    
    
}

Member Function Documentation

◆ binarySearchWithBoundary()

size_t Trk::BinUtilityTest::binarySearchWithBoundary	(	std::vector< float > &	array,
		float	value )

inlineprivate

A binary search with underflow/overflow.

Definition at line 57 of file BinUtilityTest.h.

        {
            // Binary search in an array of n values to locate value
            // underflow
            if ( value < array[0] ) return 0;
            if ( value > array[array.size()-1] ) return (array.size()-1);
            // prepare and run
            size_t nabove, nbelow, middle;
            // overflow
            nabove = array.size()+1;
            if ( value > array[nabove-2]) return nabove-2;
            // binary search
            nbelow = 0;
            while (nabove-nbelow > 1) {
              middle = (nabove+nbelow)/2;
              if (value == array[middle-1]) return middle-1;
              if (value  < array[middle-1]) nabove = middle;
              else                          nbelow = middle;
            }
            return nbelow-1;
        }

◆ bookTree()

StatusCode Trk::TrkDetDescrUnitTestBase::bookTree ( )

virtualinherited

Reimplemented in Trk::MappingTest.

Definition at line 60 of file TrkDetDescrUnitTestBase.cxx.

60{ return StatusCode::SUCCESS; }

◆ 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 Trk::TrkDetDescrUnitTestBase::execute ( )

inherited

standard Athena-Algorithm method

Definition at line 48 of file TrkDetDescrUnitTestBase.cxx.

{
    return runTest();
}

◆ 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 Trk::TrkDetDescrUnitTestBase::finalize ( )

inherited

standard Athena-Algorithm method

Definition at line 53 of file TrkDetDescrUnitTestBase.cxx.

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

◆ initialize()

StatusCode Trk::TrkDetDescrUnitTestBase::initialize ( )

inherited

standard Athena-Algorithm method

Definition at line 27 of file TrkDetDescrUnitTestBase.cxx.

{
    ATH_MSG_INFO( "Creating random number services, call bookTree() and initializeTest()" );
 
    // intialize the random number generators
    m_gaussDist = new Rndm::Numbers(randSvc(), Rndm::Gauss(0.,1.));
    m_flatDist  = new Rndm::Numbers(randSvc(), Rndm::Flat(0.,1.));
 
    if  (bookTree().isFailure()){
        ATH_MSG_FATAL( "Could not book the TTree object" );
        return StatusCode::FAILURE;
    }
    
    if (initializeTest().isFailure()){
        ATH_MSG_FATAL( "Could not initialize the test" );
        return StatusCode::FAILURE;
    }
    
    return StatusCode::SUCCESS;
}

◆ initializeTest()

StatusCode Trk::TrkDetDescrUnitTestBase::initializeTest ( )

virtualinherited

Reimplemented in Trk::MappingTest, Trk::SurfaceIntersectionTest, and Trk::TrackingGeometryTest.

Definition at line 62 of file TrkDetDescrUnitTestBase.cxx.

62{ 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.

◆ prepareData()

void Trk::BinUtilityTest::prepareData	(	std::vector< float > &	vec,
		std::map< float, size_t > &	map,
		float &	low,
		float &	high )

private

preparation of std::vector and std::map for comparison

Definition at line 66 of file BinUtilityTest.cxx.

                                                                                                              {
 
    // create the boundaries
        low  = 500.*Trk::TrkDetDescrUnitTestBase::m_flatDist->shoot();
        high = low + 1000.*Trk::TrkDetDescrUnitTestBase::m_flatDist->shoot();
        float range = high - low;
        map[low]  = 0;
        map[high] = 0;
        for (size_t is = 0; is < m_numberOfSegments-1; ++is){
           map[low + range*m_flatDist->shoot()]  = 0;
        }
        // now prepare the vector
        vec.reserve(m_numberOfSegments+1);
        std::map< float, size_t >::iterator sIter = map.begin();
        for (size_t cs = 0 ; sIter != map.end(); ++sIter, ++cs ){
        vec.push_back((*sIter).first);
                (*sIter).second = cs;
        }
}

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

◆ runTest()

StatusCode Trk::BinUtilityTest::runTest ( )

virtual

Implements Trk::TrkDetDescrUnitTestBase.

Definition at line 24 of file BinUtilityTest.cxx.

{
 
    ATH_MSG_VERBOSE("Running the BinUtilityTest Test");
 
    // Contstruction of bin array test
    // add a closed equidistant binning in Rphi
    Trk::BinUtility testUtil(10, 0., m_flatDist->shoot()*1000.*M_PI, Trk::closed, Trk::binRPhi);
    ATH_MSG_VERBOSE(" Created 1D bin utitlity : " << testUtil );
    // add an equidistant binning in Z
    testUtil += Trk::BinUtility(24, -400., 400., Trk::open, Trk::binZ);
    ATH_MSG_VERBOSE(" Created 2D bin utitlity : " << testUtil );
    // add a bi equidistant binning in X
    testUtil += Trk::BinUtility(5, m_flatDist->shoot()*10., m_flatDist->shoot()*80., 1000.+m_flatDist->shoot()*1000 , Trk::open, Trk::binX);
    ATH_MSG_VERBOSE(" Created 3D bin utitlity : " << testUtil );
 
    // Arbitrary binning test
    for (size_t it = 0; it < Trk::TrkDetDescrUnitTestBase::m_numTests; ++it) {
         std::vector<float>             binVector;
         std::map<float, size_t>        binMap;
         float                          low;
         float                          high;
         
         prepareData(binVector, binMap, low, high);
         
         Trk::BinUtility binUtility(binVector, Trk::open, Trk::binX);
         
         // run the test n times
         for (size_t itpv = 0; itpv < m_numberOfTestsPerSet; ++itpv) {
            float value = low + (high - low) * Trk::TrkDetDescrUnitTestBase::m_flatDist->shoot();
            Amg::Vector3D testPosition(value, 0., 0.);
            size_t binVec  =  searchInVectorWithBoundary(binVector, testPosition.x());
            size_t binBin  =  binarySearchWithBoundary(binVector, testPosition.x());
            size_t binUtil =  binUtility.bin(testPosition, 0);
            if (binVec != binBin || binVec != binUtil )
               ATH_MSG_WARNING("Searches through binary (" << binBin << "), vector (" << binVec << ") or tutility  (" << binUtil << ") differ.");
         }
         
    }
    return StatusCode::SUCCESS;
}

◆ searchInVectorWithBoundary()

size_t Trk::BinUtilityTest::searchInVectorWithBoundary	(	std::vector< float > &	array,
		float	value )

inlineprivate

A binary search with a map - superior in O(10) searches.

Definition at line 45 of file BinUtilityTest.h.

        {
            if ( value < array[0] ) return 0;
            if ( value > array[array.size()-1] ) return (array.size()-1);
            std::vector<float>::iterator vIter = array.begin();
            size_t bin = 0; 
            for ( ; vIter !=  array.end() ;  ++vIter, ++bin )
                if ((*vIter) > value) break; 
            return (bin-1);            
        }

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

Rndm::Numbers* Trk::TrkDetDescrUnitTestBase::m_flatDist

protectedinherited

Definition at line 58 of file TrkDetDescrUnitTestBase.h.

◆ m_gaussDist

Rndm::Numbers* Trk::TrkDetDescrUnitTestBase::m_gaussDist

protectedinherited

Random Number setup.

Definition at line 57 of file TrkDetDescrUnitTestBase.h.

◆ m_numberOfSegments

size_t Trk::BinUtilityTest::m_numberOfSegments

private

Definition at line 79 of file BinUtilityTest.h.

◆ m_numberOfTestsPerSet

size_t Trk::BinUtilityTest::m_numberOfTestsPerSet

private

Definition at line 80 of file BinUtilityTest.h.

◆ m_numTests

size_t Trk::TrkDetDescrUnitTestBase::m_numTests

protectedinherited

number of tests

Definition at line 61 of file TrkDetDescrUnitTestBase.h.

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

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

Public Member Functions

Protected Member Functions

Protected Attributes

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ BinUtilityTest()

Member Function Documentation

◆ binarySearchWithBoundary()

◆ bookTree()

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ execute()

◆ extraDeps_update_handler()

◆ extraOutputDeps()

◆ finalize()

◆ initialize()

◆ initializeTest()

◆ inputHandles()

◆ msg()

◆ msgLvl()

◆ outputHandles()

◆ prepareData()

◆ renounce()

◆ renounceArray()

◆ runTest()

◆ searchInVectorWithBoundary()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_detStore

◆ m_evtStore

◆ m_extendedExtraObjects

◆ m_flatDist

◆ m_gaussDist

◆ m_numberOfSegments

◆ m_numberOfTestsPerSet

◆ m_numTests

◆ m_varHandleArraysDeclared

◆ m_vhka