Trk::CombinedExtrapolatorTest Class Reference

The ExtrapolatorTest Algorithm runs a number of n test extrapolations from randomly distributed Track Parameters to geometry outer boundary and back to perigee. More...

#include <CombinedExtrapolatorTest.h>

Inheritance diagram for Trk::CombinedExtrapolatorTest:

Collaboration diagram for Trk::CombinedExtrapolatorTest:

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

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

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

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

Private Attributes
ToolHandle< IExtrapolator >	m_extrapolator {this, "Extrapolator", "Trk::Extrapolator/AtlasExtrapolator"}
	The Extrapolator to be retrieved.
Rndm::Numbers *	m_gaussDist = nullptr
	Random Number setup.
Rndm::Numbers *	m_flatDist = nullptr
DoubleProperty	m_sigmaD0 {this, "StartPerigeeSigmaD0", 17.*Gaudi::Units::micrometer}
DoubleProperty	m_minZ0 {this, "StartPerigeeMinZ0", -25000.}
DoubleProperty	m_maxZ0 {this, "StartPerigeeMaxZ0", +25000.}
DoubleProperty	m_minP {this, "StartPerigeeMinP", 0.5*Gaudi::Units::GeV}
DoubleProperty	m_maxP {this, "StartPerigeeMaxP", 50000.*Gaudi::Units::GeV}
const Trk::TrackingVolume *	m_outerBoundary = nullptr
const Trk::TrackingGeometry *	m_trackingGeometry = nullptr
IntegerProperty	m_particleType
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

The ExtrapolatorTest Algorithm runs a number of n test extrapolations from randomly distributed Track Parameters to geometry outer boundary and back to perigee.

Author

Sarka Todorova sarka.nosp@m..tod.nosp@m.orova.nosp@m.@cer.nosp@m.n.ch

Definition at line 37 of file CombinedExtrapolatorTest.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

CombinedExtrapolatorTest()

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

Standard Athena-Algorithm Constructor.

Definition at line 18 of file CombinedExtrapolatorTest.cxx.

  :
  AthAlgorithm(name,pSvcLocator) {}

~CombinedExtrapolatorTest()

Trk::CombinedExtrapolatorTest::~CombinedExtrapolatorTest

(

)

Default Destructor.

Definition at line 24 of file CombinedExtrapolatorTest.cxx.

{
  delete m_gaussDist;
  delete m_flatDist;
}

Member Function Documentation

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.

{ return m_detStore; }

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.

{ return m_evtStore; }

execute()

StatusCode Trk::CombinedExtrapolatorTest::execute

(

)

standard Athena-Algorithm method

Definition at line 61 of file CombinedExtrapolatorTest.cxx.

{
  msg(MSG::INFO) << " execute()" << endmsg;
  const EventContext& ctx = Gaudi::Hive::currentContext();
  // retrieve outer boundary
  if (!m_outerBoundary) {
    m_trackingGeometry = m_extrapolator->trackingGeometry();
    m_outerBoundary = m_trackingGeometry->highestTrackingVolume();
    if (!m_outerBoundary) {
      msg(MSG::FATAL) << "Could not retrieve geometry boundary  from " << m_extrapolator << ". Exiting."<<endmsg;
      return StatusCode::FAILURE;
    }
    msg(MSG::INFO) << " boundary retrieved " << endmsg;
  }
  
  // generate with random number generator
  double d0 = m_gaussDist->shoot() * m_sigmaD0;
  double z0 = m_minZ0 + m_flatDist->shoot() * (m_maxZ0-m_minZ0);
  double phi = 2.*M_PI * m_flatDist->shoot() - M_PI;
  double ctheta = -1. + 2* m_flatDist->shoot();
  double theta = acos(ctheta);
  double p = m_minP + m_flatDist->shoot()*(m_maxP-m_minP);
  double charge = (m_flatDist->shoot() > 0.5 ) ? -1. : 1.;
  double qOverP = charge/(p);
 
  // the initial perigee with random numbers
  const Trk::PerigeeSurface perSurface;
  Trk::Perigee initialPerigee(d0, z0, phi, theta, qOverP,perSurface); 
  // input covariance matrix
  const Trk::TrackParameters* seed = initialPerigee.clone();
 
  const Trk::PerigeeSurface& pSf = initialPerigee.associatedSurface();
  
  const Trk::TrackParameters* destParameters = m_extrapolator->extrapolateToVolume(
    ctx, 
    *seed,
    *m_outerBoundary, 
    Trk::alongMomentum,
    static_cast<Trk::ParticleHypothesis>(m_particleType.value())).release();
 
  if (!destParameters || !Trk::TrackingGeometry::atVolumeBoundary(destParameters->position(),m_outerBoundary,0.001) ) {
    msg(MSG::ERROR) << " extrapolation to outer boundary failed for input parameters: " << initialPerigee.parameters() << endmsg;
 
  } else {
    // forward extrapolation ok
    msg(MSG::INFO) << " outer boundary reached at: " << destParameters->position().perp() <<","<<destParameters->position().z() << endmsg;
     msg(MSG::INFO) << "cov matrix:"<< destParameters->covariance() << endmsg;
 
    const Trk::TrackParameters* peri = m_extrapolator->extrapolate(
      ctx, 
      *destParameters,
      pSf, 
      Trk::oppositeMomentum,
      false,
      static_cast<Trk::ParticleHypothesis>(m_particleType.value())).release();
    if ( peri) {
      msg(MSG::INFO) << " extrapolation to perigee:input: " << initialPerigee.parameters() << endmsg;
      msg(MSG::INFO) << " extrapolation to perigee:output: " << peri->parameters() << endmsg;
       msg(MSG::INFO) << "cov matrix:"<< peri->covariance() << endmsg;
    } else {
      msg(MSG::ERROR) << " extrapolation to perigee failed for input parameters: " << destParameters->parameters() << endmsg;
    }
    delete peri;
  }
  
  delete destParameters;
  
  return StatusCode::SUCCESS;
}

extraDeps_update_handler()

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

protectedinherited

Add StoreName to extra input/output deps as needed.

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

extraOutputDeps()

const DataObjIDColl & AthAlgorithm::extraOutputDeps ( ) const

overridevirtualinherited

Return the list of extra output dependencies.

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

Definition at line 50 of file AthAlgorithm.cxx.

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

finalize()

StatusCode Trk::CombinedExtrapolatorTest::finalize

(

)

standard Athena-Algorithm method

Definition at line 53 of file CombinedExtrapolatorTest.cxx.

{
  // Code entered here will be executed once at the end of the program run.
  return StatusCode::SUCCESS;
}

initialize()

StatusCode Trk::CombinedExtrapolatorTest::initialize

(

)

standard Athena-Algorithm method

Definition at line 33 of file CombinedExtrapolatorTest.cxx.

{
  // Code entered here will be executed once at program start.
  msg(MSG::INFO) << " initialize()" << endmsg;
 
  // Get Extrapolator from ToolService   
  if (m_extrapolator.retrieve().isFailure()) {
        msg(MSG::FATAL) << "Could not retrieve Tool " << m_extrapolator << ". Exiting."<<endmsg;
        return StatusCode::FAILURE;
  }
  
  m_gaussDist = new Rndm::Numbers(randSvc(), Rndm::Gauss(0.,1.));
  m_flatDist  = new Rndm::Numbers(randSvc(), Rndm::Flat(0.,1.));
 
  msg(MSG::INFO) << "initialize() successful in " << endmsg;
  return StatusCode::SUCCESS;
}

inputHandles()

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

overridevirtualinherited

Return this algorithm's input handles.

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

msg()

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

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

msgLvl()

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

inlineinherited

Definition at line 30 of file AthCommonMsg.h.

                                               {
    return this->msgLevel(lvl);
  }

outputHandles()

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

overridevirtualinherited

Return this algorithm's output handles.

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

renounce()

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

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

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

renounceArray()

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

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                          {
    handlesArray.renounce();
  }

sysInitialize()

StatusCode AthAlgorithm::sysInitialize ( )

overridevirtualinherited

Override sysInitialize.

Override sysInitialize from the base class.

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

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

Reimplemented from AthCommonDataStore< AthCommonMsg< Algorithm > >.

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

Definition at line 66 of file AthAlgorithm.cxx.

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

sysStart()

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

overridevirtualinherited

Handle START transition.

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

updateVHKA()

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

inlineinherited

Definition at line 308 of file AthCommonDataStore.h.

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

Member Data Documentation

m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< Algorithm > >::m_detStore

privateinherited

Pointer to StoreGate (detector store by default)

Definition at line 393 of file AthCommonDataStore.h.

m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< Algorithm > >::m_evtStore

privateinherited

Pointer to StoreGate (event store by default)

Definition at line 390 of file AthCommonDataStore.h.

m_extendedExtraObjects

DataObjIDColl AthAlgorithm::m_extendedExtraObjects

privateinherited

Definition at line 79 of file AthAlgorithm.h.

m_extrapolator

ToolHandle<IExtrapolator> Trk::CombinedExtrapolatorTest::m_extrapolator {this, "Extrapolator", "Trk::Extrapolator/AtlasExtrapolator"}

private

The Extrapolator to be retrieved.

Definition at line 55 of file CombinedExtrapolatorTest.h.

{this, "Extrapolator", "Trk::Extrapolator/AtlasExtrapolator"};

m_flatDist

Rndm::Numbers* Trk::CombinedExtrapolatorTest::m_flatDist = nullptr

private

Definition at line 60 of file CombinedExtrapolatorTest.h.

m_gaussDist

Rndm::Numbers* Trk::CombinedExtrapolatorTest::m_gaussDist = nullptr

private

Random Number setup.

Definition at line 59 of file CombinedExtrapolatorTest.h.

m_maxP

DoubleProperty Trk::CombinedExtrapolatorTest::m_maxP {this, "StartPerigeeMaxP", 50000.*Gaudi::Units::GeV}

private

Definition at line 66 of file CombinedExtrapolatorTest.h.

{this, "StartPerigeeMaxP", 50000.*Gaudi::Units::GeV};

m_maxZ0

DoubleProperty Trk::CombinedExtrapolatorTest::m_maxZ0 {this, "StartPerigeeMaxZ0", +25000.}

private

Definition at line 64 of file CombinedExtrapolatorTest.h.

{this, "StartPerigeeMaxZ0", +25000.};

m_minP

DoubleProperty Trk::CombinedExtrapolatorTest::m_minP {this, "StartPerigeeMinP", 0.5*Gaudi::Units::GeV}

private

Definition at line 65 of file CombinedExtrapolatorTest.h.

{this, "StartPerigeeMinP", 0.5*Gaudi::Units::GeV};

m_minZ0

DoubleProperty Trk::CombinedExtrapolatorTest::m_minZ0 {this, "StartPerigeeMinZ0", -25000.}

private

Definition at line 63 of file CombinedExtrapolatorTest.h.

{this, "StartPerigeeMinZ0", -25000.};

m_outerBoundary

const Trk::TrackingVolume* Trk::CombinedExtrapolatorTest::m_outerBoundary = nullptr

private

Definition at line 68 of file CombinedExtrapolatorTest.h.

m_particleType

IntegerProperty Trk::CombinedExtrapolatorTest::m_particleType

private

Initial value:

{this, "ParticleType", Trk::muon,
    "the particle type for the extrap."}

Definition at line 71 of file CombinedExtrapolatorTest.h.

                                    {this, "ParticleType", Trk::muon,
    "the particle type for the extrap."};

m_sigmaD0

DoubleProperty Trk::CombinedExtrapolatorTest::m_sigmaD0 {this, "StartPerigeeSigmaD0", 17.*Gaudi::Units::micrometer}

private

Definition at line 62 of file CombinedExtrapolatorTest.h.

{this, "StartPerigeeSigmaD0", 17.*Gaudi::Units::micrometer};

m_trackingGeometry

const Trk::TrackingGeometry* Trk::CombinedExtrapolatorTest::m_trackingGeometry = nullptr

private

Definition at line 69 of file CombinedExtrapolatorTest.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:

• CombinedExtrapolatorTest.h
• CombinedExtrapolatorTest.cxx