k4SimGeant4
Loading...
Searching...
No Matches
ISimG4ParticleSmearTool Class Referenceabstract

Interface to the particle smearing tool. More...

#include <SimG4Interface/include/SimG4Interface/ISimG4ParticleSmearTool.h>

Inheritance diagram for ISimG4ParticleSmearTool:
Collaboration diagram for ISimG4ParticleSmearTool:

Public Member Functions

 DeclareInterfaceID (ISimG4ParticleSmearTool, 1, 0)
 
virtual StatusCode smearMomentum (CLHEP::Hep3Vector &aMom, int aPdg=0)=0
 Smear the momentum of the particle.
 
virtual StatusCode checkConditions (double aMinMomentum, double aMaxMomentum, double aMaxEta) const =0
 Check conditions of the smearing model, especially if the given parametrs do not exceed the parameters of the model.
 

Detailed Description

Interface to the particle smearing tool.

(smearing its momentum/energy for the purpose of fast simulation)

Author
Anna Zaborowska

Member Function Documentation

◆ checkConditions()

virtual StatusCode ISimG4ParticleSmearTool::checkConditions ( double aMinMomentum,
double aMaxMomentum,
double aMaxEta ) const
pure virtual

Check conditions of the smearing model, especially if the given parametrs do not exceed the parameters of the model.

Parameters
[in]aMinMomentumMinimum momentum.
[in]aMaxMomentumMaximum momentum.
[in]aMaxEtaMaximum pseudorapidity.
Returns
status code

Implemented in SimG4ParticleSmearFormula, SimG4ParticleSmearRootFile, and SimG4ParticleSmearSimple.

◆ DeclareInterfaceID()

ISimG4ParticleSmearTool::DeclareInterfaceID ( ISimG4ParticleSmearTool ,
1 ,
0  )

◆ smearMomentum()

virtual StatusCode ISimG4ParticleSmearTool::smearMomentum ( CLHEP::Hep3Vector & aMom,
int aPdg = 0 )
pure virtual

Smear the momentum of the particle.

Parameters
aMomParticle momentum to be smeared.
[in]aPdgParticle PDG code.
Returns
status code

Implemented in SimG4ParticleSmearFormula, SimG4ParticleSmearRootFile, and SimG4ParticleSmearSimple.


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