utl::Particle Class Reference

Describes a particle for Simulation. More...

#include <Particle.h>

Public Types
enum	Source {   eShower, eBackground, eShowerFromMuonDecay, eShowerFromLocalHadron,   eCornerClipping }
enum	Type {   eUndefined = 0, eElectron = 11, ePositron = -11, eNuElectron = 12,   eAntiNuElectron = -12, eMuon = 13, eAntiMuon = -13, eNuMuon = 14,   eAntiNuMuon = -14, eTau = 15, eAntiTau = -15, eNuTau = 16,   eAntiNuTau = -16, ePhoton = 22, eDecayedMuon = 96, eDecayedAntiMuon = 95,   ePiZero = 111, eRhoZero = 113, ePiPlus = 211, ePiMinus = -211,   eRhoPlus = 213, eRhoMinus = -213, eEta = 221, eOmegaMeson = 223,   eKaon0L = 130, eKaon0S = 310, eKaonStarZero = 313, eAntiKaonStarZero = -313,   eKaonPlus = 321, eKaonMinus = -321, eKaonStarPlus = 323, eAntiKaonStarMinus = -323,   ePhi = 333, eDeltaMinus = 1114, eAntiDeltaPlus = -1114, eNeutron = 2112,   eAntiNeutron = -2112, eDeltaZero = 2114, eAntiDeltaZero = -2114, eProton = 2212,   eAntiProton = -2212, eDeltaPlus = 2214, eAntiDeltaMinus = -2214, eDeltaPlusPlus = 2224,   eAntiDeltaMinusMinus = -2224, eLambda = 3122, eAntiLambda = -3122, eSigmaPlus = 3222,   eSigmaZero = 3212, eSigmaMinus = 3112, eAntiSigmaPlus = -3222, eAntiSigmaZero = -3212,   eAntiSigmaMinus = -3112, eXiZero = 3322, eXiMinus = 3312, eAntiXiZero = -3322,   eAntiXiMinus = -3312, eOmegaMinus = 3332, eAntiOmegaMinus = -3332, eLambdac = 4122,   eIron = 1000026056 }
	Particle types. More...

Public Member Functions
const Vector &	GetDirection () const
	Unit vector giving particle direction. More...
double	GetKineticEnergy () const
	Get kinetic energy of the particle. More...
double	GetMass () const
	Mass of the particle. More...
Vector	GetMomentum () const
	Vector giving particle momentum. More...
std::string	GetName () const
	string with particle name More...
Particle &	GetParent ()
const Particle &	GetParent () const
const Point &	GetPosition () const
	Position of the particle. More...
const utl::Point &	GetProductionPoint () const
Source	GetSource () const
	Source of the particle (eg. shower or background) More...
const TimeInterval &	GetTime () const
	Arrival time delay at the ground. More...
double	GetTotalEnergy () const
	Get Total (relativistic) energy. More...
int	GetType () const
double	GetWeight () const
	Particle weight (assigned by shower generator thinning algorithms) More...
bool	HasParent () const
bool	HasProductionPoint () const
	Particle (const int type, const Source &source, const Point &position, const Vector &direction, const TimeInterval &time, const double weight, const double kineticEnergy)
	Constructor using kinetic energy. More...
	Particle (const int type, const Source &source, const Point &position, const Vector &momentum, const TimeInterval &time, const double weight)
	Constructor using momentum. More...
void	SetDirection (const utl::Vector &direction)
void	SetKineticEnergy (const double ke)
	Set kinetic energy of the particle. More...
void	SetMomentum (const utl::Vector &momentum)
void	SetParent (Particle &parent)
void	SetPosition (const utl::Point &position)
void	SetProductionPoint (const utl::Point &point)
void	SetTime (const TimeInterval &time)
void	SetTotalEnergy (const double totE)
	Set Total (relativistic) energy. More...
void	SetWeight (const double weight)

Static Public Member Functions
static int	NucleusCode (const int charge, const int atomicNumber)
	Calculate particle type code for a given (A, Z) More...

Private Attributes
utl::Vector	fDirection
double	fKineticEnergy = 0
boost::shared_ptr< Particle >	fParent
utl::Point	fPosition
boost::shared_ptr< const utl::Point >	fProductionPoint
ParticlePropertiesPtr	fProperties
Source	fSource = eShower
TimeInterval	fTime
double	fWeight = 0

Detailed Description

Describes a particle for Simulation.

Author

Stefano Argiro'

Date

27 January 2003

Definition at line 26 of file Particle.h.

Member Enumeration Documentation

enum utl::Particle::Source

Enumerator
eShower
eBackground
eShowerFromMuonDecay
eShowerFromLocalHadron
eCornerClipping

Definition at line 31 of file Particle.h.

enum utl::Particle::Type

Particle types.

Enumeration of type codes of the particles appearing in Auger simulations. The codes com from the PDG http://pdg.lbl.gov/.

For an extension to nuclei, see utl::NucleusProperties.

Enumerator
eUndefined
eElectron
ePositron
eNuElectron
eAntiNuElectron
eMuon
eAntiMuon
eNuMuon
eAntiNuMuon
eTau
eAntiTau
eNuTau
eAntiNuTau
ePhoton
eDecayedMuon
eDecayedAntiMuon
ePiZero
eRhoZero
ePiPlus
ePiMinus
eRhoPlus
eRhoMinus
eEta
eOmegaMeson
eKaon0L
eKaon0S
eKaonStarZero
eAntiKaonStarZero
eKaonPlus
eKaonMinus
eKaonStarPlus
eAntiKaonStarMinus
ePhi
eDeltaMinus
eAntiDeltaPlus
eNeutron
eAntiNeutron
eDeltaZero
eAntiDeltaZero
eProton
eAntiProton
eDeltaPlus
eAntiDeltaMinus
eDeltaPlusPlus
eAntiDeltaMinusMinus
eLambda
eAntiLambda
eSigmaPlus
eSigmaZero
eSigmaMinus
eAntiSigmaPlus
eAntiSigmaZero
eAntiSigmaMinus
eXiZero
eXiMinus
eAntiXiZero
eAntiXiMinus
eOmegaMinus
eAntiOmegaMinus
eLambdac
eIron

Definition at line 48 of file Particle.h.

Constructor & Destructor Documentation

Particle::Particle	(	const int	type,
		const Source &	source,
		const Point &	position,
		const Vector &	direction,
		const TimeInterval &	time,
		const double	weight,
		const double	kineticEnergy
	)

Constructor using kinetic energy.

Definition at line 25 of file Particle.cc.

Referenced by SetParent().

Particle::Particle	(	const int	type,
		const Source &	source,
		const Point &	position,
		const Vector &	momentum,
		const TimeInterval &	time,
		const double	weight
	)

Constructor using momentum.

Definition at line 39 of file Particle.cc.

References SetMomentum().

Member Function Documentation

const Vector& utl::Particle::GetDirection ( ) const

inline

Unit vector giving particle direction.

Definition at line 114 of file Particle.h.

References fDirection.

Referenced by otoa::MD2ADST::AddParticle(), sevt::Station::AddParticle(), FastTankSimulatorOG::FastTankSimulator::CalculateDistanceInTank(), G4StationSimulatorOG::G4StationPrimaryGenerator::GeneratePrimaries(), ParticleInjectorNEU::ParticleInjector::InjectParticles(), RPCSimulatorLX::RPCSimulator::Run(), MdShowerRegeneratorAG::MdShowerRegenerator::Run(), CachedXShowerRegeneratorAG::CachedXShowerRegenerator::Run(), CachedShowerRegeneratorASCII::CachedShowerRegenerator::Run(), CachedShowerRegeneratorOG::CachedShowerRegenerator::Run(), FastTankSimulatorOG::FastTankSimulator::SimulateComptonScattering(), FastTankSimulatorOG::FastTankSimulator::SimulatePairProduction(), FastTankSimulatorOG::FastTankSimulator::SimulatePhotons(), MdCounterSimulatorAG::MdCounterSimulator::SimulatePulses(), and testParticle::testMomentum().

double utl::Particle::GetKineticEnergy ( ) const

inline

Get kinetic energy of the particle.

Definition at line 130 of file Particle.h.

References fKineticEnergy.

Referenced by otoa::MD2ADST::AddParticle(), FastTankSimulatorOG::FastTankSimulator::CalculateIntegratedCerenkovRate(), G4StationSimulatorOG::G4StationPrimaryGenerator::GeneratePrimaries(), MdShowerRegeneratorAG::MdShowerRegenerator::Run(), CachedXShowerRegeneratorAG::CachedXShowerRegenerator::Run(), CachedShowerRegeneratorASCII::CachedShowerRegenerator::Run(), CachedDirectInjectorOG::CachedDirectInjector::Run(), FastTankSimulatorOG::FastTankSimulator::SimulateComptonScattering(), FastTankSimulatorOG::FastTankSimulator::SimulateElectrons(), FastTankSimulatorOG::FastTankSimulator::SimulateMuons(), FastTankSimulatorOG::FastTankSimulator::SimulatePairProduction(), FastTankSimulatorOG::FastTankSimulator::SimulatePhotons(), and testParticle::testMomentum().

double utl::Particle::GetMass ( ) const

inline

Mass of the particle.

Definition at line 142 of file Particle.h.

References fProperties.

Referenced by GetMomentum(), GetTotalEnergy(), SetMomentum(), SetTotalEnergy(), testParticle::testMomentum(), and testParticle::testProperties().

utl::Vector Particle::GetMomentum

(

)

const

Vector giving particle momentum.

Definition at line 55 of file Particle.cc.

References fDirection, fKineticEnergy, GetMass(), utl::m, G4StationSimulatorOG::p, utl::Sqr(), and sqrt().

Referenced by testParticle::testMomentum().

std::string utl::Particle::GetName ( ) const

inline

string with particle name

Definition at line 104 of file Particle.h.

References fProperties.

Referenced by compareNames(), CompareNames(), G4StationSimulatorOG::G4StationPrimaryGenerator::GeneratePrimaries(), testParticle::testMomentum(), and testParticle::testProperties().

Particle& utl::Particle::GetParent ( )

inline

Definition at line 148 of file Particle.h.

References fParent.

Referenced by cevt::StationSimData::AddParticle(), io::CorsikaShowerFileParticleIterator::GetOneParticle(), cevt::Station::GetSignalComponent(), and io::Particle_ROOT::Particle_ROOT().

const Particle& utl::Particle::GetParent ( ) const

inline

Definition at line 149 of file Particle.h.

References fParent.

const Point& utl::Particle::GetPosition ( ) const

inline

Position of the particle.

Definition at line 110 of file Particle.h.

References fPosition.

Referenced by otoa::MD2ADST::AddParticle(), sevt::Station::AddParticle(), FastTankSimulatorOG::FastTankSimulator::CalculateDistanceInTank(), G4StationSimulatorOG::G4StationPrimaryGenerator::GeneratePrimaries(), io::CorsikaShowerFileParticleIterator::GetOneParticle(), ParticleInjectorNEU::ParticleInjector::InjectParticles(), RPCSimulatorLX::RPCSimulator::Run(), MdShowerRegeneratorAG::MdShowerRegenerator::Run(), CachedXShowerRegeneratorAG::CachedXShowerRegenerator::Run(), CachedShowerRegeneratorASCII::CachedShowerRegenerator::Run(), CachedDirectInjectorOG::CachedDirectInjector::Run(), CachedShowerRegeneratorOG::CachedShowerRegenerator::Run(), FastTankSimulatorOG::FastTankSimulator::SimulateComptonScattering(), FastTankSimulatorOG::FastTankSimulator::SimulatePairProduction(), FastTankSimulatorOG::FastTankSimulator::SimulatePhotons(), and MdCounterSimulatorAG::MdCounterSimulator::SimulatePulses().

const utl::Point& utl::Particle::GetProductionPoint ( ) const

inline

Definition at line 153 of file Particle.h.

References fProductionPoint.

Referenced by io::Particle_ROOT::Particle_ROOT(), and G4StationSimulatorOG::G4StationSteppingAction::UserSteppingAction().

Source utl::Particle::GetSource ( ) const

inline

Source of the particle (eg. shower or background)

Definition at line 107 of file Particle.h.

References fSource.

Referenced by G4StationSimulatorOG::G4StationSimulator::AddInjectedParticle(), otoa::MD2ADST::AddParticle(), TabulatedTankSimulatorNS::TabulatedTankSimulator::AddPhoton(), cevt::Station::GetSignalComponent(), CachedShowerRegeneratorOG::IsMuonic(), CachedXShowerRegeneratorAG::CachedXShowerRegenerator::Run(), CachedShowerRegeneratorASCII::CachedShowerRegenerator::Run(), G4XTankSimulatorAG::G4XTankPMT::SetParticle(), FastTankSimulatorOG::FastTankSimulator::SimulateComptonScattering(), FastTankSimulatorOG::FastTankSimulator::SimulatePairProduction(), FastTankSimulatorOG::FastTankSimulator::SimulatePhotons(), and G4StationSimulatorOG::G4StationSteppingAction::UserSteppingAction().

const TimeInterval& utl::Particle::GetTime ( ) const

inline

Arrival time delay at the ground.

Definition at line 122 of file Particle.h.

References fTime.

Referenced by FastTankSimulatorOG::FastTankSimulator::CalculatePhotoElectrons(), G4StationSimulatorOG::G4StationPrimaryGenerator::GeneratePrimaries(), RPCSimulatorLX::RPCSimulator::Run(), MdShowerRegeneratorAG::MdShowerRegenerator::Run(), CachedXShowerRegeneratorAG::CachedXShowerRegenerator::Run(), CachedShowerRegeneratorASCII::CachedShowerRegenerator::Run(), CachedDirectInjectorOG::CachedDirectInjector::Run(), FastTankSimulatorOG::FastTankSimulator::SimulateComptonScattering(), FastTankSimulatorOG::FastTankSimulator::SimulatePairProduction(), FastTankSimulatorOG::FastTankSimulator::SimulatePhotons(), and MdCounterSimulatorAG::MdCounterSimulator::SimulatePulses().

double utl::Particle::GetTotalEnergy ( ) const

inline

Get Total (relativistic) energy.

Definition at line 136 of file Particle.h.

References fKineticEnergy, and GetMass().

Referenced by testParticle::testMomentum().

int utl::Particle::GetType ( ) const

inline

Definition at line 101 of file Particle.h.

References fProperties.

Referenced by G4StationSimulatorOG::G4StationSimulator::AddInjectedParticle(), cevt::StationSimData::AddParticle(), otoa::MD2ADST::AddParticle(), TabulatedTankSimulatorNS::TabulatedTankSimulator::AddPhoton(), FastTankSimulatorOG::FastTankSimulator::CalculateIntegratedCerenkovRate(), FastTankSimulatorOG::FastTankSimulator::CalculatePhotoElectrons(), sevt::ScintillatorSimData::CountParticle(), sevt::StationSimData::CountParticle(), cevt::Station::GetSignalComponent(), CachedShowerRegeneratorOG::IsMuonic(), io::AiresShowerFile::Read(), RPCSimulatorLX::RPCSimulator::Run(), FastTankSimulatorOG::FastTankSimulator::Run(), MdShowerRegeneratorAG::MdShowerRegenerator::Run(), UnderGrdInjectorAG::UnderGrdInjector::Run(), CachedXShowerRegeneratorAG::CachedXShowerRegenerator::Run(), CachedShowerRegeneratorASCII::CachedShowerRegenerator::Run(), G4TankSimulatorASCII::G4TankPMT::SetComponent(), G4XTankSimulatorAG::G4XTankPMT::SetComponent(), EdepSimulatorAG::SteppingAction::SetImpingingParticle(), FastTankSimulatorOG::FastTankSimulator::SimulatePhotons(), MdCounterSimulatorAG::MdCounterSimulator::SimulatePulses(), testParticle::testMomentum(), and testParticle::testProperties().

double utl::Particle::GetWeight ( ) const

inline

Particle weight (assigned by shower generator thinning algorithms)

Definition at line 126 of file Particle.h.

References fWeight.

Referenced by io::AiresShowerFile::Read(), RPCSimulatorLX::RPCSimulator::Run(), MdShowerRegeneratorAG::MdShowerRegenerator::Run(), CachedXShowerRegeneratorAG::CachedXShowerRegenerator::Run(), CachedShowerRegeneratorASCII::CachedShowerRegenerator::Run(), FastTankSimulatorOG::FastTankSimulator::SimulateComptonScattering(), FastTankSimulatorOG::FastTankSimulator::SimulatePairProduction(), FastTankSimulatorOG::FastTankSimulator::SimulatePhotons(), and MdCounterSimulatorAG::MdCounterSimulator::SimulatePulses().

bool utl::Particle::HasParent ( ) const

inline

Definition at line 147 of file Particle.h.

References fParent.

Referenced by cevt::StationSimData::AddParticle(), cevt::Station::GetSignalComponent(), and io::Particle_ROOT::Particle_ROOT().

bool utl::Particle::HasProductionPoint ( ) const

inline

Definition at line 152 of file Particle.h.

References fProductionPoint.

Referenced by io::Particle_ROOT::Particle_ROOT(), and G4StationSimulatorOG::G4StationSteppingAction::UserSteppingAction().

int Particle::NucleusCode ( const int  charge, const int  atomicNumber  )

static

Calculate particle type code for a given (A, Z)

Definition at line 74 of file Particle.cc.

References utl::NucleusProperties::TypeCode().

void utl::Particle::SetDirection ( const utl::Vector &  direction )

inline

Definition at line 115 of file Particle.h.

References fDirection.

Referenced by MdShowerRegeneratorAG::MdShowerRegenerator::Run().

void utl::Particle::SetKineticEnergy ( const double  ke )

inline

Set kinetic energy of the particle.

Definition at line 133 of file Particle.h.

References fKineticEnergy.

void Particle::SetMomentum

(

const utl::Vector &

momentum

)

Definition at line 65 of file Particle.cc.

References fDirection, fKineticEnergy, utl::Vector::GetMag2(), GetMass(), utl::m, utl::Normalized(), utl::Sqr(), and sqrt().

Referenced by Particle(), and testParticle::testMomentum().

void utl::Particle::SetParent ( Particle &  parent )

inline

Definition at line 150 of file Particle.h.

References fParent, and Particle().

Referenced by io::CorsikaShowerFileParticleIterator::GetOneParticle(), io::Particle_ROOT::operator>>(), MdShowerRegeneratorAG::MdShowerRegenerator::Run(), GroundPropagatorAG::GroundPropagator::Run(), EdepSimulatorAG::EdepSimulator::Run(), CachedXShowerRegeneratorAG::CachedXShowerRegenerator::Run(), G4XTankSimulatorAG::G4XTankSimulator::RunFast(), G4XTankSimulatorAG::G4XTankSimulator::RunFull(), and G4StationSimulatorOG::G4StationSteppingAction::UserSteppingAction().

void utl::Particle::SetPosition ( const utl::Point &  position )

inline

Definition at line 111 of file Particle.h.

References fPosition.

Referenced by ParticleInjectorNEU::ParticleInjector::InjectParticles(), MdShowerRegeneratorAG::MdShowerRegenerator::Run(), UnderGrdInjectorAG::UnderGrdInjector::Run(), CachedXShowerRegeneratorAG::CachedXShowerRegenerator::Run(), CachedShowerRegeneratorASCII::CachedShowerRegenerator::Run(), CachedDirectInjectorOG::CachedDirectInjector::Run(), and CachedShowerRegeneratorOG::CachedShowerRegenerator::Run().

void utl::Particle::SetProductionPoint ( const utl::Point &  point )

inline

Definition at line 154 of file Particle.h.

References fProductionPoint.

Referenced by io::CorsikaShowerFileParticleIterator::GetOneParticle(), io::Particle_ROOT::operator>>(), and G4StationSimulatorOG::G4StationSteppingAction::UserSteppingAction().

void utl::Particle::SetTime ( const TimeInterval &  time )

inline

Definition at line 123 of file Particle.h.

References fTime.

Referenced by MdShowerRegeneratorAG::MdShowerRegenerator::Run(), CachedXShowerRegeneratorAG::CachedXShowerRegenerator::Run(), CachedShowerRegeneratorASCII::CachedShowerRegenerator::Run(), CachedDirectInjectorOG::CachedDirectInjector::Run(), and CachedShowerRegeneratorOG::CachedShowerRegenerator::Run().

void utl::Particle::SetTotalEnergy ( const double  totE )

inline

Set Total (relativistic) energy.

Definition at line 139 of file Particle.h.

References fKineticEnergy, and GetMass().

void utl::Particle::SetWeight ( const double  weight )

inline

Definition at line 127 of file Particle.h.

References fWeight.

Referenced by MdShowerRegeneratorAG::MdShowerRegenerator::Run(), CachedXShowerRegeneratorAG::CachedXShowerRegenerator::Run(), CachedShowerRegeneratorASCII::CachedShowerRegenerator::Run(), and CachedShowerRegeneratorOG::CachedShowerRegenerator::Run().

Member Data Documentation

utl::Vector utl::Particle::fDirection

private

Definition at line 166 of file Particle.h.

Referenced by GetDirection(), GetMomentum(), SetDirection(), and SetMomentum().

double utl::Particle::fKineticEnergy = 0

private

Definition at line 170 of file Particle.h.

Referenced by GetKineticEnergy(), GetMomentum(), GetTotalEnergy(), SetKineticEnergy(), SetMomentum(), and SetTotalEnergy().

boost::shared_ptr<Particle> utl::Particle::fParent

private

Definition at line 158 of file Particle.h.

Referenced by GetParent(), HasParent(), and SetParent().

utl::Point utl::Particle::fPosition

private

Definition at line 165 of file Particle.h.

Referenced by GetPosition(), and SetPosition().

boost::shared_ptr<const utl::Point> utl::Particle::fProductionPoint

private

Definition at line 159 of file Particle.h.

Referenced by GetProductionPoint(), HasProductionPoint(), and SetProductionPoint().

ParticlePropertiesPtr utl::Particle::fProperties

private

Definition at line 162 of file Particle.h.

Referenced by GetMass(), GetName(), and GetType().

Source utl::Particle::fSource = eShower

private

Definition at line 163 of file Particle.h.

Referenced by GetSource().

TimeInterval utl::Particle::fTime

private

Definition at line 168 of file Particle.h.

Referenced by GetTime(), and SetTime().

double utl::Particle::fWeight = 0

private

Definition at line 169 of file Particle.h.

Referenced by GetWeight(), and SetWeight().

---

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

• Particle.h
• Particle.cc