A class for connecting the simulation to an analysis package. More...

#include <IORTAnalysisManager.hh>

Collaboration diagram for IORTAnalysisManager:

Public Member Functions
	~IORTAnalysisManager ()

void	book ()
	Book the histograms and ntuples. More...

void	SetAnalysisFileName (G4String)
	Set name for the analysis file .root (used by macro) More...

void	FillEnergyDeposit (G4int voxelXId, G4int voxelYId, G4int voxelZId, G4double energyDeposit)
	Fill the ntuple with the energy deposit in the phantom. More...

void	BraggPeak (G4int, G4double)
	Fill 1D histogram with the Bragg peak in the phantom. More...

void	SecondaryProtonEnergyDeposit (G4int slice, G4double energy)
	Fill 1D histogram with the energy deposit of secondary protons. More...

void	SecondaryNeutronEnergyDeposit (G4int slice, G4double energy)
	Fill 1D histogram with the energy deposit of secondary neutrons. More...

void	SecondaryAlphaEnergyDeposit (G4int slice, G4double energy)
	Fill 1D histogram with the energy deposit of secondary alpha particles. More...

void	SecondaryGammaEnergyDeposit (G4int slice, G4double energy)
	Fill 1D histogram with the energy deposit of secondary gamma. More...

void	SecondaryElectronEnergyDeposit (G4int slice, G4double energy)
	Fill 1D histogram with the energy deposit of secondary electrons. More...

void	SecondaryTritonEnergyDeposit (G4int slice, G4double energy)
	Fill 1D histogram with the energy deposit of secondary tritons. More...

void	SecondaryDeuteronEnergyDeposit (G4int slice, G4double energy)
	Fill 1D histogram with the energy deposit of secondary deuterons. More...

void	SecondaryPionEnergyDeposit (G4int slice, G4double energy)
	Fill 1D histogram with the energy deposit of secondary pions. More...

void	electronEnergyDistribution (G4double secondaryParticleKineticEnergy)
	Energy distribution of secondary electrons originated in the phantom. More...

void	gammaEnergyDistribution (G4double secondaryParticleKineticEnergy)
	Energy distribution of secondary gamma originated in the phantom. More...

void	deuteronEnergyDistribution (G4double secondaryParticleKineticEnergy)
	Energy distribution of secondary deuterons originated in the phantom. More...

void	tritonEnergyDistribution (G4double secondaryParticleKineticEnergy)
	Energy distribution of secondary tritons originated in the phantom. More...

void	alphaEnergyDistribution (G4double secondaryParticleKineticEnergy)
	Energy distribution of secondary alpha originated in the phantom. More...

void	heliumEnergy (G4double secondaryParticleKineticEnergy)
	Energy distribution of the helium (He3 and alpha) particles after the phantom. More...

void	hydrogenEnergy (G4double secondaryParticleKineticEnergy)
	Energy distribution of the hydrogen (proton, d, t) particles after the phantom. More...

void	FillKineticFragmentTuple (G4int i, G4int j, G4int k, G4int A, G4double Z, G4double kinEnergy)

void	FillKineticEnergyPrimaryNTuple (G4int i, G4int j, G4int k, G4double kinEnergy)
	Energy by voxel, mass number A and atomic number Z. More...

void	FillVoxelFragmentTuple (G4int i, G4int j, G4int k, G4int A, G4double Z, G4double energy, G4double fluence)

void	FillFragmentTuple (G4int A, G4double Z, G4double energy, G4double posX, G4double posY, G4double posZ)
	Energy ntuple. More...

void	FillLetFragmentTuple (G4int i, G4int j, G4int k, G4int A, G4double Z, G4double letT, G4double letD)
	let ntuple More...

void	genericIonInformation (G4int, G4double, G4int, G4double)

void	ThintargetBeamDisp (G4double, G4double)

void	startNewEvent ()
	Tell the analysis manager that a new event is starting. More...

void	setGeometryMetaData (G4double, G4double, G4double)
	from the detector construction information about the geometry can be written as metadata More...

void	setBeamMetaData (G4double, G4double)
	metadata about the beam can be written this way More...

void	flush ()
	Close the .hbk file with the histograms and the ntuples. More...

Static Public Member Functions
static IORTAnalysisManager *	GetInstance ()
	Get the pointer to the analysis manager. More...

Private Member Functions
	IORTAnalysisManager ()
	Analysis manager is a singleton object (there is only one instance). More...

Private Attributes
IORTAnalysisFileMessenger *	fMess

G4String	analysisFileName

G4long	eventCounter

G4double	detectorDistance

G4double	phantomDepth

G4double	beamEnergy

G4double	energyError

G4double	phantomCenterDistance

Static Private Attributes
static IORTAnalysisManager *	instance = 0

Detailed Description

A class for connecting the simulation to an analysis package.

Definition at line 56 of file IORTAnalysisManager.hh.

Constructor & Destructor Documentation

IORTAnalysisManager::IORTAnalysisManager ( )

private

Analysis manager is a singleton object (there is only one instance).

The pointer to this object is available through the use of the method GetInstance();

See also: GetInstance

Definition at line 50 of file IORTAnalysisManager.cc.

References fMess.

Referenced by GetInstance().

Here is the caller graph for this function:

IORTAnalysisManager::~IORTAnalysisManager ( )

Definition at line 58 of file IORTAnalysisManager.cc.

References fMess.

Member Function Documentation

void IORTAnalysisManager::alphaEnergyDistribution ( G4double secondaryParticleKineticEnergy )

Energy distribution of secondary alpha originated in the phantom.

Definition at line 311 of file IORTAnalysisManager.cc.

void IORTAnalysisManager::book ( )

Book the histograms and ntuples.

Definition at line 82 of file IORTAnalysisManager.cc.

References analysisFileName, G4VAnalysisManager::CreateH1(), G4VAnalysisManager::CreateNtuple(), G4VAnalysisManager::CreateNtupleDColumn(), G4VAnalysisManager::CreateNtupleIColumn(), G4VAnalysisManager::FinishNtuple(), G4VAnalysisManager::OpenFile(), G4VAnalysisManager::SetFirstHistoId(), G4VAnalysisManager::SetFirstNtupleId(), and G4VAnalysisManager::SetVerboseLevel().

Here is the call graph for this function:

void IORTAnalysisManager::BraggPeak	(	G4int	slice,
		G4double	energy
	)

Fill 1D histogram with the Bragg peak in the phantom.

Definition at line 231 of file IORTAnalysisManager.cc.

void IORTAnalysisManager::deuteronEnergyDistribution ( G4double secondaryParticleKineticEnergy )

Energy distribution of secondary deuterons originated in the phantom.

Definition at line 299 of file IORTAnalysisManager.cc.

void IORTAnalysisManager::electronEnergyDistribution ( G4double secondaryParticleKineticEnergy )

Energy distribution of secondary electrons originated in the phantom.

Definition at line 287 of file IORTAnalysisManager.cc.

void IORTAnalysisManager::FillEnergyDeposit	(	G4int	voxelXId,
		G4int	voxelYId,
		G4int	voxelZId,
		G4double	energyDeposit
	)

Fill the ntuple with the energy deposit in the phantom.

Definition at line 217 of file IORTAnalysisManager.cc.

References G4VAnalysisManager::AddNtupleRow(), G4VAnalysisManager::FillNtupleDColumn(), and G4VAnalysisManager::FillNtupleIColumn().

Here is the call graph for this function:

void IORTAnalysisManager::FillFragmentTuple	(	G4int	A,
		G4double	Z,
		G4double	energy,
		G4double	posX,
		G4double	posY,
		G4double	posZ
	)

Energy ntuple.

Definition at line 401 of file IORTAnalysisManager.cc.

References G4VAnalysisManager::AddNtupleRow(), G4VAnalysisManager::FillNtupleDColumn(), and G4VAnalysisManager::FillNtupleIColumn().

Referenced by IORTSteppingAction::UserSteppingAction().

Here is the call graph for this function:

Here is the caller graph for this function:

void IORTAnalysisManager::FillKineticEnergyPrimaryNTuple	(	G4int	i,
		G4int	j,
		G4int	k,
		G4double	kinEnergy
	)

Energy by voxel, mass number A and atomic number Z.

Definition at line 346 of file IORTAnalysisManager.cc.

References G4VAnalysisManager::AddNtupleRow(), G4VAnalysisManager::FillNtupleDColumn(), and G4VAnalysisManager::FillNtupleIColumn().

Here is the call graph for this function:

void IORTAnalysisManager::FillKineticFragmentTuple	(	G4int	i,
		G4int	j,
		G4int	k,
		G4int	A,
		G4double	Z,
		G4double	kinEnergy
	)

Definition at line 331 of file IORTAnalysisManager.cc.

References G4VAnalysisManager::AddNtupleRow(), G4VAnalysisManager::FillNtupleDColumn(), and G4VAnalysisManager::FillNtupleIColumn().

Here is the call graph for this function:

void IORTAnalysisManager::FillLetFragmentTuple	(	G4int	i,
		G4int	j,
		G4int	k,
		G4int	A,
		G4double	Z,
		G4double	letT,
		G4double	letD
	)

let ntuple

Definition at line 386 of file IORTAnalysisManager.cc.

References G4VAnalysisManager::AddNtupleRow(), G4VAnalysisManager::FillNtupleDColumn(), and G4VAnalysisManager::FillNtupleIColumn().

Here is the call graph for this function:

void IORTAnalysisManager::FillVoxelFragmentTuple	(	G4int	i,
		G4int	j,
		G4int	k,
		G4int	A,
		G4double	Z,
		G4double	energy,
		G4double	fluence
	)

Definition at line 361 of file IORTAnalysisManager.cc.

References G4VAnalysisManager::AddNtupleRow(), G4VAnalysisManager::FillNtupleDColumn(), and G4VAnalysisManager::FillNtupleIColumn().

Here is the call graph for this function:

void IORTAnalysisManager::flush ( )

Close the .hbk file with the histograms and the ntuples.

Definition at line 450 of file IORTAnalysisManager.cc.

References G4VAnalysisManager::CloseFile(), eventCounter, and G4VAnalysisManager::Write().

Here is the call graph for this function:

void IORTAnalysisManager::gammaEnergyDistribution ( G4double secondaryParticleKineticEnergy )

Energy distribution of secondary gamma originated in the phantom.

Definition at line 293 of file IORTAnalysisManager.cc.

void IORTAnalysisManager::genericIonInformation	(	G4int	a,
		G4double	z,
		G4int	electronOccupancy,
		G4double	energy
	)

Definition at line 415 of file IORTAnalysisManager.cc.

References G4VAnalysisManager::AddNtupleRow(), G4VAnalysisManager::FillNtupleDColumn(), and G4VAnalysisManager::FillNtupleIColumn().

Here is the call graph for this function:

IORTAnalysisManager * IORTAnalysisManager::GetInstance ( )

static

Get the pointer to the analysis manager.

Definition at line 67 of file IORTAnalysisManager.cc.

References instance, and IORTAnalysisManager().

Referenced by IORTPrimaryGeneratorAction::GeneratePrimaries(), IORTDetectorConstruction::IORTDetectorConstruction(), main(), IORTDetectorSD::ProcessHits(), IORTPrimaryGeneratorAction::SetDefaultPrimaryParticle(), IORTPrimaryGeneratorAction::SetmeanKineticEnergy(), IORTAnalysisFileMessenger::SetNewValue(), IORTPrimaryGeneratorAction::SetsigmaEnergy(), IORTMatrix::StoreDoseFluenceRoot(), and IORTSteppingAction::UserSteppingAction().

Here is the call graph for this function:

Here is the caller graph for this function:

void IORTAnalysisManager::heliumEnergy ( G4double secondaryParticleKineticEnergy )

Energy distribution of the helium (He3 and alpha) particles after the phantom.

Definition at line 317 of file IORTAnalysisManager.cc.

Referenced by IORTSteppingAction::UserSteppingAction().

Here is the caller graph for this function:

void IORTAnalysisManager::hydrogenEnergy ( G4double secondaryParticleKineticEnergy )

Energy distribution of the hydrogen (proton, d, t) particles after the phantom.

Definition at line 323 of file IORTAnalysisManager.cc.

Referenced by IORTSteppingAction::UserSteppingAction().

Here is the caller graph for this function:

void IORTAnalysisManager::SecondaryAlphaEnergyDeposit	(	G4int	slice,
		G4double	energy
	)

Fill 1D histogram with the energy deposit of secondary alpha particles.

Definition at line 251 of file IORTAnalysisManager.cc.

void IORTAnalysisManager::SecondaryDeuteronEnergyDeposit	(	G4int	slice,
		G4double	energy
	)

Fill 1D histogram with the energy deposit of secondary deuterons.

Definition at line 275 of file IORTAnalysisManager.cc.

void IORTAnalysisManager::SecondaryElectronEnergyDeposit	(	G4int	slice,
		G4double	energy
	)

Fill 1D histogram with the energy deposit of secondary electrons.

Definition at line 263 of file IORTAnalysisManager.cc.

void IORTAnalysisManager::SecondaryGammaEnergyDeposit	(	G4int	slice,
		G4double	energy
	)

Fill 1D histogram with the energy deposit of secondary gamma.

Definition at line 257 of file IORTAnalysisManager.cc.

void IORTAnalysisManager::SecondaryNeutronEnergyDeposit	(	G4int	slice,
		G4double	energy
	)

Fill 1D histogram with the energy deposit of secondary neutrons.

Definition at line 245 of file IORTAnalysisManager.cc.

void IORTAnalysisManager::SecondaryPionEnergyDeposit	(	G4int	slice,
		G4double	energy
	)

Fill 1D histogram with the energy deposit of secondary pions.

Definition at line 281 of file IORTAnalysisManager.cc.

void IORTAnalysisManager::SecondaryProtonEnergyDeposit	(	G4int	slice,
		G4double	energy
	)

Fill 1D histogram with the energy deposit of secondary protons.

Definition at line 239 of file IORTAnalysisManager.cc.

void IORTAnalysisManager::SecondaryTritonEnergyDeposit	(	G4int	slice,
		G4double	energy
	)

Fill 1D histogram with the energy deposit of secondary tritons.

Definition at line 269 of file IORTAnalysisManager.cc.

void IORTAnalysisManager::SetAnalysisFileName ( G4String aFileName )

Set name for the analysis file .root (used by macro)

Definition at line 75 of file IORTAnalysisManager.cc.

References analysisFileName.

void IORTAnalysisManager::setBeamMetaData	(	G4double	meanKineticEnergy,
		G4double	sigmaEnergy
	)

metadata about the beam can be written this way

Definition at line 443 of file IORTAnalysisManager.cc.

References beamEnergy, and energyError.

void IORTAnalysisManager::setGeometryMetaData	(	G4double	endDetectorPosition,
		G4double	waterThickness,
		G4double	phantomCenter
	)

from the detector construction information about the geometry can be written as metadata

Definition at line 434 of file IORTAnalysisManager.cc.

References detectorDistance, phantomCenterDistance, and phantomDepth.

void IORTAnalysisManager::startNewEvent ( )

Tell the analysis manager that a new event is starting.

Definition at line 429 of file IORTAnalysisManager.cc.

References eventCounter.

Referenced by IORTPrimaryGeneratorAction::GeneratePrimaries().

Here is the caller graph for this function:

void IORTAnalysisManager::ThintargetBeamDisp	(	G4double	,
		G4double
	)

void IORTAnalysisManager::tritonEnergyDistribution ( G4double secondaryParticleKineticEnergy )

Energy distribution of secondary tritons originated in the phantom.

Definition at line 305 of file IORTAnalysisManager.cc.

Member Data Documentation

G4String IORTAnalysisManager::analysisFileName

private

Definition at line 172 of file IORTAnalysisManager.hh.

Referenced by book(), and SetAnalysisFileName().

G4double IORTAnalysisManager::beamEnergy

private

Definition at line 177 of file IORTAnalysisManager.hh.

Referenced by setBeamMetaData().

G4double IORTAnalysisManager::detectorDistance

private

Definition at line 175 of file IORTAnalysisManager.hh.

Referenced by setGeometryMetaData().

G4double IORTAnalysisManager::energyError

private

Definition at line 178 of file IORTAnalysisManager.hh.

Referenced by setBeamMetaData().

G4long IORTAnalysisManager::eventCounter

private

Definition at line 174 of file IORTAnalysisManager.hh.

Referenced by flush(), and startNewEvent().

IORTAnalysisFileMessenger* IORTAnalysisManager::fMess

private

Definition at line 170 of file IORTAnalysisManager.hh.

Referenced by IORTAnalysisManager(), and ~IORTAnalysisManager().

IORTAnalysisManager * IORTAnalysisManager::instance = 0

staticprivate

Definition at line 169 of file IORTAnalysisManager.hh.

Referenced by GetInstance().

G4double IORTAnalysisManager::phantomCenterDistance

private

Definition at line 179 of file IORTAnalysisManager.hh.

Referenced by setGeometryMetaData().

G4double IORTAnalysisManager::phantomDepth

private

Definition at line 176 of file IORTAnalysisManager.hh.

Referenced by setGeometryMetaData().

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

geant4.10.02.p01/examples/advanced/iort_therapy/include/IORTAnalysisManager.hh
geant4.10.02.p01/examples/advanced/iort_therapy/src/IORTAnalysisManager.cc

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation