RAT::VertexGen_Spectrum Class Reference

#include <VertexGen_Spectrum.hh>

Inheritance diagram for RAT::VertexGen_Spectrum:

Public Member Functions
	VertexGen_Spectrum (const char *arg_dbname="SPECTRUM")
virtual	~VertexGen_Spectrum ()
virtual void	GeneratePrimaryVertex (G4Event *argEvent, G4ThreeVector &dx, G4double dt)
virtual void	SetState (G4String newValues)
virtual G4String	GetState ()
virtual void	InitialiseSpectrum ()
virtual double	SampleEnergy ()
virtual bool	ELimitable ()
virtual void	LimitEnergies (double Elo, double Ehi)
virtual double	EMaximum ()
virtual double	EMinimum ()
Public Member Functions inherited from GLG4VertexGen
	GLG4VertexGen (const char *arg_dbname="vertex")

Additional Inherited Members
Protected Attributes inherited from GLG4VertexGen
G4String	_dbname

Detailed Description

Vertex Generator - events of given particle (or ion) type, with energies sampled from spectrum via DB

Author

Jeanne Wilson j.wil.nosp@m.son2.nosp@m.@phys.nosp@m.ics..nosp@m.ox.ac.nosp@m..uk

first version : 18-July-2008

This vertex generator (to be used in composite generators like combo of coincidence) produces isotropic particles or ions with kinetic energies sampled from a data-base defined distribution. An option to limit the range of the energy distribution is available

Constructor & Destructor Documentation

~VertexGen_Spectrum()

RAT::VertexGen_Spectrum::~VertexGen_Spectrum ( )

virtual

---

Member Function Documentation

ELimitable()

virtual bool RAT::VertexGen_Spectrum::ELimitable ( )

inlinevirtual

For this generator, it is possible to limit the output energies

Reimplemented from GLG4VertexGen.

EMaximum()

double RAT::VertexGen_Spectrum::EMaximum ( )

virtual

Return the maximum possible energy

---

Reimplemented from GLG4VertexGen.

EMinimum()

double RAT::VertexGen_Spectrum::EMinimum ( )

virtual

Return the minimum possible energy

---

Reimplemented from GLG4VertexGen.

GeneratePrimaryVertex()

void RAT::VertexGen_Spectrum::GeneratePrimaryVertex ( G4Event *  event, G4ThreeVector &  dx, G4double  dt  )

virtual

generate and add new vertex to this event. Position and time of vertex are offset from 0 by dx and dt. (These are usually derived from GLG4PosGen and GLG4TimeGen.)

---

Implements GLG4VertexGen.

GetState()

G4String RAT::VertexGen_Spectrum::GetState ( )

virtual

return current state

---

Implements GLG4VertexGen.

InitialiseSpectrum()

void RAT::VertexGen_Spectrum::InitialiseSpectrum ( )

virtual

Set up the spectrum array in memory - create normalised cumulative magnitude for easy sampling

---

LimitEnergies()

void RAT::VertexGen_Spectrum::LimitEnergies ( double  Elo, double  Ehi  )

virtual

Set the limits on the generated energy

---

Reimplemented from GLG4VertexGen.

SampleEnergy()

double RAT::VertexGen_Spectrum::SampleEnergy ( )

virtual

Sample energy from spectrum between bounds Elim_lo and Elim_hi

---

SetState()

void RAT::VertexGen_Spectrum::SetState ( G4String  newValues )

virtual

set the state for generator. Format: pname specname where pname is the particle name, and specname is the database spectrum name

---

Implements GLG4VertexGen.

---

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

• /home/docs/checkouts/readthedocs.org/user_builds/ratpac/checkouts/latest/src/gen/include/RAT/VertexGen_Spectrum.hh
• /home/docs/checkouts/readthedocs.org/user_builds/ratpac/checkouts/latest/src/gen/src/VertexGen_Spectrum.cc