Trk::MultipleScatteringUpdator Class Reference

The Formula used is the highland formula for the projected scattering angle : More...

#include <MultipleScatteringUpdator.h>

Inheritance diagram for Trk::MultipleScatteringUpdator:

Collaboration diagram for Trk::MultipleScatteringUpdator:

Public Member Functions
	MultipleScatteringUpdator (const std::string &, const std::string &, const IInterface *)
	AlgTool like constructor.
virtual	~MultipleScatteringUpdator ()
	Virtual destructor.
virtual StatusCode	initialize () override
	AlgTool initailize method.
virtual double	sigmaSquare (const MaterialProperties &mat, double p, double pathcorrection, ParticleHypothesis particle=pion, double deltaE=0.) const override
	Calculate the sigma on theta introduced by multiple scattering, according to the RutherFord-Scott Formula.
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
virtual void	validationAction () const
	Validation Action: Can be implemented optionally, outside access to internal validation steps.

Static Public Member Functions
static const InterfaceID &	interfaceID ()
	AlgTool and IAlgTool interface methods.

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
BooleanProperty	m_useTrkUtils
BooleanProperty	m_log_include
BooleanProperty	m_gaussianMixture
BooleanProperty	m_optGaussianMixtureG4
ServiceHandle< IAthRNGSvc >	m_rndGenSvc
	Random Generator service.
ATHRNG::RNGWrapper *	m_rngWrapper = nullptr
	Random engine.
StringProperty	m_randomEngineName
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 Formula used is the highland formula for the projected scattering angle :

\( \theta_{ms} = \frac{13.6MeV}{p}\cdot\sqrt{t/X_{0}}[1 + 0.038\ln(t/X_{0})] \)

What is returned is the square of the expectation value of the deflection \( < (\theta_ms)^2 > = \sigma_ms^2 \)

• For electrons the

  Author

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

Definition at line 42 of file MultipleScatteringUpdator.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

MultipleScatteringUpdator()

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

AlgTool like constructor.

Definition at line 47 of file MultipleScatteringUpdator.cxx.

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

~MultipleScatteringUpdator()

Trk::MultipleScatteringUpdator::~MultipleScatteringUpdator ( )

virtualdefault

Virtual destructor.

Member Function Documentation

declareGaudiProperty()

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

inlineprivateinherited

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

Definition at line 156 of file AthCommonDataStore.h.

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

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.

{ return m_detStore; }

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.

{ 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

initialize()

StatusCode Trk::MultipleScatteringUpdator::initialize ( )

overridevirtual

AlgTool initailize method.

Definition at line 59 of file MultipleScatteringUpdator.cxx.

                                         {
  // if Gaussian mixture is required
  if (m_gaussianMixture) {
    // get the random generator service
    if (m_rndGenSvc.retrieve().isFailure()) {
      ATH_MSG_WARNING("Could not retrieve " << m_rndGenSvc << " -> switching Gaussian mixture model off.");
      m_gaussianMixture = false;
    } else {
      ATH_MSG_VERBOSE("Successfully retrieved " << m_rndGenSvc);
    }
 
    // Get own engine with own seeds:
    m_rngWrapper = m_gaussianMixture ? m_rndGenSvc->getEngine(this, m_randomEngineName) : nullptr;
    if (!m_rngWrapper) {
      ATH_MSG_WARNING(
        "Could not get random engine '" << m_randomEngineName << "' -> switching Gaussian mixture model off.");
      m_gaussianMixture = false;
    }
  }
  if (m_gaussianMixture) {
    ATH_MSG_VERBOSE("Gaussian mixture model = ON ... optimised = " << m_optGaussianMixtureG4);
  } else {
    ATH_MSG_VERBOSE("Gaussian mixture model = OFF");
  }
 
  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.

interfaceID()

const InterfaceID & Trk::IMultipleScatteringUpdator::interfaceID ( )

inlinestaticinherited

AlgTool and IAlgTool interface methods.

Definition at line 36 of file IMultipleScatteringUpdator.h.

{ return IID_IMultipleScatteringUpdator; };

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

sigmaSquare()

double Trk::MultipleScatteringUpdator::sigmaSquare ( const MaterialProperties & mat, double p, double pathcorrection, ParticleHypothesis particle = pion, double deltaE = 0. ) const

overridevirtual

Calculate the sigma on theta introduced by multiple scattering, according to the RutherFord-Scott Formula.

Implements Trk::IMultipleScatteringUpdator.

Definition at line 88 of file MultipleScatteringUpdator.cxx.

                                                          {
  if (mat.thicknessInX0() <= 0. || particle == Trk::geantino) {
    return 0.;
  }
 
  // make sure the path correction is positive to avoid a floating point exception
  pathcorrection *= pathcorrection < 0. ? (-1.) : (1);
 
  // scale the path length to the radiation length
  double t = pathcorrection * mat.thicknessInX0();
 
  // kinematics (relativistic)
  double m = Trk::ParticleMasses::mass[particle];
  double E = sqrt(p * p + m * m);
  double beta = p / E;
 
  double sigma2(0.);
 
  double sigma = Trk::MaterialInteraction::sigmaMS(t, p, beta);
  sigma2 = sigma * sigma;
 
  if (m_useTrkUtils && particle != Trk::electron) {
    return sigma2;
  }
 
// Code below will not be used if the parameterization of TrkUtils is used
 
 
  if (particle != Trk::electron) {
    if (auto denom = beta * p; not close_to_zero(denom)){
      // the highland formula
      sigma2 = s_main_RutherfordScott / denom;
    }
 
    if (m_log_include) {
      sigma2 *= (1. + s_log_RutherfordScott * std::log(t));
    }
 
    sigma2 *= (sigma2 * t);
  }else {
    // Electron multiple scattering effects - see Highland NIM 129 (1975) p497-499
    // (Highland extension to the Rossi-Greisen formulation)
    // NOTE: The formula can be extended by replacing the momentum^2 term with pi * pf
    sigma2 = s_main_RossiGreisen / (beta * p);
    sigma2 *= (sigma2 * t);
 
    if (m_log_include) {
      double factor = 1. + s_log_RossiGreisen * std::log10(10. * t);
      factor *= factor;
      sigma2 *= factor;
    }
  }
 
  // use the Gaussian mixture model
  if (m_gaussianMixture) {
    // Reseed the RNG if needed.
    const EventContext& ctx = Gaudi::Hive::currentContext();
    if (m_rngWrapper->evtSeeded(ctx) != ctx.evt()) {
      // Ok, the wrappers are unique to this algorithm and a given slot,
      // so cannot be accessed concurrently.
      ATHRNG::RNGWrapper* wrapper_nc ATLAS_THREAD_SAFE = m_rngWrapper;
      wrapper_nc->setSeed (this->name(), ctx);
    }
    CLHEP::HepRandomEngine* engine = m_rngWrapper->getEngine (ctx);
    // d_0'
    double dprime{};
    if (auto denom = beta * beta; not close_to_zero(denom)){
      dprime = t / denom;
    } else {
      ATH_MSG_WARNING("Trk::MultipleScatteringUpdator::sigmaSquare: beta close to zero");
      return 0.;
    }
    double log_dprime = std::log(dprime);
    // d_0''
    double log_dprimeprime = std::log(std::pow(mat.averageZ(), 2.0 / 3.0) * dprime);
    // get epsilon
    double epsilon = log_dprimeprime < 0.5 ?
                     s_gausMixEpsilon_a0 + s_gausMixEpsilon_a1 * log_dprimeprime + s_gausMixEpsilon_a2 *
                     log_dprimeprime * log_dprimeprime :
                     s_gausMixEpsilon_b0 + s_gausMixEpsilon_b1 * log_dprimeprime + s_gausMixEpsilon_b2 *
                     log_dprimeprime * log_dprimeprime;
    // the standard sigma
    double sigma1square = s_gausMixSigma1_a0 + s_gausMixSigma1_a1 * log_dprime + s_gausMixSigma1_a2 * log_dprime *
                          log_dprime;
    // G4 optimised / native double Gaussian model
    if (!m_optGaussianMixtureG4) {
      if (auto denom = p * p;not close_to_zero(denom)){
        sigma2 = 225. * dprime / (p * p);
      } else {
        ATH_MSG_WARNING("Trk::MultipleScatteringUpdator::sigmaSquare: p close to zero");
      }
    }
    // throw the random number core/tail
    if (CLHEP::RandFlat::shoot(engine) < epsilon) {
      sigma2 *= (1. - (1. - epsilon) * sigma1square) / epsilon;
    }
  }
 
  return sigma2;
}

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

validationAction()

virtual void Trk::IMultipleScatteringUpdator::validationAction ( ) const

inlinevirtualinherited

Validation Action: Can be implemented optionally, outside access to internal validation steps.

Definition at line 48 of file IMultipleScatteringUpdator.h.

{}

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_gaussianMixture

BooleanProperty Trk::MultipleScatteringUpdator::m_gaussianMixture

private

Initial value:

{this, "GaussianMixtureModel", false,
    "mainly for Fatras"}

Definition at line 71 of file MultipleScatteringUpdator.h.

                                   {this, "GaussianMixtureModel", false,
    "mainly for Fatras"};

m_log_include

BooleanProperty Trk::MultipleScatteringUpdator::m_log_include

private

Initial value:

{this, "MultipleScatteringLogarithmicTermOn", true,
    "boolean switch to include log term"}

Definition at line 69 of file MultipleScatteringUpdator.h.

                               {this, "MultipleScatteringLogarithmicTermOn", true,
    "boolean switch to include log term"};

m_optGaussianMixtureG4

BooleanProperty Trk::MultipleScatteringUpdator::m_optGaussianMixtureG4

private

Initial value:

{this, "G4OptimisedGaussianMixtureModel", true,
    "modifies the Fruehwirth/Regler model to fit with G4"}

Definition at line 73 of file MultipleScatteringUpdator.h.

                                        {this, "G4OptimisedGaussianMixtureModel", true,
    "modifies the Fruehwirth/Regler model to fit with G4"};

m_randomEngineName

StringProperty Trk::MultipleScatteringUpdator::m_randomEngineName

private

Initial value:

{this, "RandomStreamName", "TrkExRnd",
    "Name of the random number stream"}

Definition at line 82 of file MultipleScatteringUpdator.h.

                                   {this, "RandomStreamName", "TrkExRnd",
    "Name of the random number stream"};

m_rndGenSvc

ServiceHandle<IAthRNGSvc> Trk::MultipleScatteringUpdator::m_rndGenSvc

private

Initial value:

{this, "RandomNumberService", "AthRNGSvc",
    "Name of the random number service"}

Random Generator service.

Definition at line 78 of file MultipleScatteringUpdator.h.

                                       {this, "RandomNumberService", "AthRNGSvc",
    "Name of the random number service"};

m_rngWrapper

ATHRNG::RNGWrapper* Trk::MultipleScatteringUpdator::m_rngWrapper = nullptr

private

Random engine.

Definition at line 81 of file MultipleScatteringUpdator.h.

m_useTrkUtils

BooleanProperty Trk::MultipleScatteringUpdator::m_useTrkUtils

private

Initial value:

{this, "UseTrkUtils", true,
      "use eloss parametrisation from TrkUtils MaterialInterAction.h"}

Definition at line 67 of file MultipleScatteringUpdator.h.

                               {this, "UseTrkUtils", true,
      "use eloss parametrisation from TrkUtils MaterialInterAction.h"};

m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< AlgTool > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

m_vhka

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

privateinherited

Definition at line 398 of file AthCommonDataStore.h.

---

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

• MultipleScatteringUpdator.h
• MultipleScatteringUpdator.cxx