Non-interacting timed material effects updator. More...

#include <NIMatEffUpdator.h>

Inheritance diagram for Trk::NIMatEffUpdator:

Collaboration diagram for Trk::NIMatEffUpdator:

Public Member Functions
	NIMatEffUpdator (const std::string &, const std::string &, const IInterface *)
	AlgTool constructor for NIMatEffUpdator.
virtual	~NIMatEffUpdator ()
	Destructor.
StatusCode	initialize ()
	AlgTool initailize method.
StatusCode	finalize ()
	AlgTool finalize method.
std::unique_ptr< Trk::TrackParameters >	update (const Trk::TrackParameters *parm, const Trk::Layer &sf, Trk::TimeLimit &time, Trk::PathLimit &path, Trk::GeometrySignature geoID, Trk::PropDirection dir=Trk::alongMomentum, Trk::ParticleHypothesis particle=Trk::pion) const
	Updator interface (full update for a layer): given track parameters are deleted internally, if no update has to be done, the pointer is returned.
std::unique_ptr< Trk::TrackParameters >	update (double time, const Trk::TrackParameters *parm, const Trk::MaterialEffectsOnTrack &meff, Trk::ParticleHypothesis particle=Trk::pion, Trk::MaterialUpdateMode matupmode=Trk::addNoise) const
	User updator interface (full update for a layer): The parmeters are given as a pointer.
std::unique_ptr< Trk::TrackParameters >	update (double time, const Trk::TrackParameters &parm, const Trk::MaterialProperties &mprop, double pathcorrection, Trk::PropDirection dir=Trk::alongMomentum, Trk::ParticleHypothesis particle=Trk::pion, Trk::MaterialUpdateMode matupmode=Trk::addNoise) const
	Updator interface: The parmeters are given as a reference, MaterialProperties based material update.
void	recordBremPhoton (double, double, double, const Amg::Vector3D &, Amg::Vector3D &, Trk::ParticleHypothesis) const
	dummy helper function for a brem photon record
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 std::unique_ptr< TrackParameters >	interact (double time, const Amg::Vector3D &position, const Amg::Vector3D &momentum, ParticleHypothesis particle, int process, const Trk::Material *extMatProp=nullptr) const
	Updator interface: Perform pre-selected interaction.
virtual void	validationAction () const
	Validation Action: Can be implemented optionally, outside access to internal validation steps.
virtual void	modelAction (const TrackParameters *parm=nullptr) const
	Model Action: Can be implemented optionally.

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
ToolHandle< Trk::IMaterialEffectsUpdator >	m_matUpdator {this, "MaterialEffectsUpdator", "Trk::MaterialEffectsUpdator/MaterialEffectsUpdator"}
	rely on MaterialEffectsIUpdator
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

Non-interacting timed material effects updator.

Dummy interaction and dense material update.

Layer (point-like) update as in MatEffUpdator.

Author: sarka.nosp@m..tod.nosp@m.orova.nosp@m.@cer.nosp@m.n.ch

Definition at line 41 of file NIMatEffUpdator.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

◆ NIMatEffUpdator()

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

AlgTool constructor for NIMatEffUpdator.

Definition at line 19 of file NIMatEffUpdator.cxx.

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

◆ ~NIMatEffUpdator()

Trk::NIMatEffUpdator::~NIMatEffUpdator ( )

virtualdefault

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.

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::NIMatEffUpdator::finalize ( )

AlgTool finalize method.

Definition at line 46 of file NIMatEffUpdator.cxx.

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

◆ initialize()

StatusCode Trk::NIMatEffUpdator::initialize ( )

AlgTool initailize method.

Definition at line 30 of file NIMatEffUpdator.cxx.

                               {
  ATH_MSG_INFO("initialize()");
 
  // retrieve the material updator tool
  if (m_matUpdator.retrieve().isFailure()) {
    ATH_MSG_FATAL("Could not retrieve " << m_matUpdator);
    return StatusCode::FAILURE;
  } 
    ATH_MSG_DEBUG("Successfully retrieved " << m_matUpdator);
  
 
  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.

◆ interact()

std::unique_ptr< Trk::TrackParameters > Trk::ITimedMatEffUpdator::interact	(	double	time,
		const Amg::Vector3D &	position,
		const Amg::Vector3D &	momentum,
		ParticleHypothesis	particle,
		int	process,
		const Trk::Material *	extMatProp = nullptr ) const

inlinevirtualinherited

Updator interface: Perform pre-selected interaction.

Definition at line 137 of file ITimedMatEffUpdator.h.

{
  return nullptr;
}

◆ interfaceID()

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

inlinestaticinherited

AlgTool and IAlgTool interface methods.

Definition at line 49 of file ITimedMatEffUpdator.h.

49{ return IID_ITimedMatEffUpdator; }

Trk::IID_ITimedMatEffUpdator

static const InterfaceID IID_ITimedMatEffUpdator("ITimedMatEffUpdator", 1, 0)

Interface ID for ITimedMatEffUpdator.

◆ modelAction()

virtual void Trk::ITimedMatEffUpdator::modelAction ( const TrackParameters * parm = nullptr ) const

inlinevirtualinherited

Model Action: Can be implemented optionally.

Provides the possibility of doing non-local MaterialEffectsUpdates for different models

Definition at line 127 of file ITimedMatEffUpdator.h.

  {
    if (parm)
      return;
  }

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

◆ recordBremPhoton()

void Trk::NIMatEffUpdator::recordBremPhoton	(	double	,
		double	,
		double	,
		const Amg::Vector3D &	,
		Amg::Vector3D &	,
		Trk::ParticleHypothesis	) const

inlinevirtual

dummy helper function for a brem photon record

Reimplemented from Trk::ITimedMatEffUpdator.

Definition at line 88 of file NIMatEffUpdator.h.

89 {};

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

◆ update() [1/3]

std::unique_ptr< Trk::TrackParameters > Trk::NIMatEffUpdator::update	(	const Trk::TrackParameters *	parm,
		const Trk::Layer &	sf,
		Trk::TimeLimit &	time,
		Trk::PathLimit &	path,
		Trk::GeometrySignature	geoID,
		Trk::PropDirection	dir = Trk::alongMomentum,
		Trk::ParticleHypothesis	particle = Trk::pion ) const

virtual

Updator interface (full update for a layer): given track parameters are deleted internally, if no update has to be done, the pointer is returned.

Implements Trk::ITimedMatEffUpdator.

Definition at line 52 of file NIMatEffUpdator.cxx.

                                                                   {
  return m_matUpdator->update(parm, lay, dir, particle);
}

◆ update() [2/3]

std::unique_ptr< Trk::TrackParameters > Trk::NIMatEffUpdator::update	(	double	time,
		const Trk::TrackParameters &	parm,
		const Trk::MaterialProperties &	mprop,
		double	pathcorrection,
		Trk::PropDirection	dir = Trk::alongMomentum,
		Trk::ParticleHypothesis	particle = Trk::pion,
		Trk::MaterialUpdateMode	matupmode = Trk::addNoise ) const

virtual

Updator interface: The parmeters are given as a reference, MaterialProperties based material update.

Implements Trk::ITimedMatEffUpdator.

Definition at line 64 of file NIMatEffUpdator.cxx.

                                                          {
  return m_matUpdator->update(parm, matprop, pathCorrection, dir, particle);
}

◆ update() [3/3]

std::unique_ptr< Trk::TrackParameters > Trk::NIMatEffUpdator::update	(	double	,
		const Trk::TrackParameters *	parm,
		const Trk::MaterialEffectsOnTrack &	,
		Trk::ParticleHypothesis	particle = Trk::pion,
		Trk::MaterialUpdateMode	matupmode = Trk::addNoise ) const

virtual

User updator interface (full update for a layer): The parmeters are given as a pointer.

The parmeters are given as a const pointer. We return newly created non const parameters as unique_ptr Update occurs on the place where the parameters parm are according to the specified MaterialEffectsOnTrack

Reimplemented from Trk::ITimedMatEffUpdator.

Definition at line 75 of file NIMatEffUpdator.cxx.

                                                          {
  return m_matUpdator->update(parm, meff, particle);
}

◆ 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::ITimedMatEffUpdator::validationAction ( ) const

inlinevirtualinherited

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

Definition at line 121 of file ITimedMatEffUpdator.h.

121{}

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_matUpdator

ToolHandle<Trk::IMaterialEffectsUpdator> Trk::NIMatEffUpdator::m_matUpdator {this, "MaterialEffectsUpdator", "Trk::MaterialEffectsUpdator/MaterialEffectsUpdator"}

private

rely on MaterialEffectsIUpdator

Definition at line 93 of file NIMatEffUpdator.h.

94{this, "MaterialEffectsUpdator", "Trk::MaterialEffectsUpdator/MaterialEffectsUpdator"};

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ NIMatEffUpdator()

◆ ~NIMatEffUpdator()

Member Function Documentation

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ extraDeps_update_handler()

◆ finalize()

◆ initialize()

◆ inputHandles()

◆ interact()

◆ interfaceID()

◆ modelAction()

◆ msg()

◆ msgLvl()

◆ outputHandles()

◆ recordBremPhoton()

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ update() [1/3]

◆ update() [2/3]

◆ update() [3/3]

◆ updateVHKA()

◆ validationAction()

Member Data Documentation

◆ m_detStore

◆ m_evtStore

◆ m_matUpdator

◆ m_varHandleArraysDeclared

◆ m_vhka