G4StepHelper Namespace Reference

helper functions to avoid having to play with the G4Step to retrieve relevant quantities. More...

Functions
G4ThreeVector	preStepPosition (const G4Step *theStep)
	TODO.
G4ThreeVector	postStepPosition (const G4Step *theStep)
	TODO.
std::string	particleName (const G4Step *theStep)
	TODO.
int	particlePDGCode (const G4Step *theStep)
	TODO.
double	depositedEnergy (const G4Step *theStep)
	TODO.
G4LogicalVolume *	getPreStepLogicalVolume (const G4Step *theStep, int iLevel=0)
	TODO.
std::string	getPreStepLogicalVolumeName (const G4Step *theStep, int iLevel=0)
	TODO.
G4VPhysicalVolume *	getPreStepPhysicalVolume (const G4Step *theStep, int iLevel=0)
	TODO.
G4LogicalVolume *	getPostStepLogicalVolume (const G4Step *theStep, int iLevel=0)
	TODO.
std::string	getPostStepLogicalVolumeName (const G4Step *theStep, int iLevel=0)
	TODO.
G4VPhysicalVolume *	getPostStepPhysicalVolume (const G4Step *theStep, int iLevel=0)
	TODO.
int	preStepBranchDepth (const G4Step *theStep)
	TODO.
int	postStepBranchDepth (const G4Step *theStep)
	TODO.
const G4VProcess *	getProcess (const G4Step *theStep)
	TODO.
std::string	getProcessName (const G4Step *theStep)
	TODO.
G4int	getProcessSubType (const G4Step *theStep)
	TODO.

Detailed Description

helper functions to avoid having to play with the G4Step to retrieve relevant quantities.

TODO: These should be standalone functions rather than a class.

Function Documentation

depositedEnergy()

double G4StepHelper::depositedEnergy

(

const G4Step *

theStep

)

TODO.

Definition at line 34 of file StepHelper.cxx.

{
  assert (theStep!=nullptr);
  return theStep->GetTotalEnergyDeposit();
}

getPostStepLogicalVolume()

G4LogicalVolume * G4StepHelper::getPostStepLogicalVolume	(	const G4Step *	theStep,
		int	iLevel = 0 )

TODO.

Definition at line 58 of file StepHelper.cxx.

{
  return getPostStepPhysicalVolume(theStep, iLevel)->GetLogicalVolume();
}

getPostStepLogicalVolumeName()

std::string G4StepHelper::getPostStepLogicalVolumeName	(	const G4Step *	theStep,
		int	iLevel = 0 )

TODO.

Definition at line 62 of file StepHelper.cxx.

{
  return getPostStepLogicalVolume(theStep, iLevel)->GetName();
}

getPostStepPhysicalVolume()

G4VPhysicalVolume * G4StepHelper::getPostStepPhysicalVolume	(	const G4Step *	theStep,
		int	iLevel = 0 )

TODO.

Definition at line 66 of file StepHelper.cxx.

{
  const G4TouchableHistory *history
    = static_cast<const G4TouchableHistory*>(theStep->GetPostStepPoint()->GetTouchable());
  if (iLevel<=0)
    {
      return history->GetVolume(std::abs(iLevel));
    }
  const int nLev=history->GetHistoryDepth();
  return history->GetVolume(nLev-iLevel);
}

getPreStepLogicalVolume()

G4LogicalVolume * G4StepHelper::getPreStepLogicalVolume	(	const G4Step *	theStep,
		int	iLevel = 0 )

TODO.

Definition at line 39 of file StepHelper.cxx.

{
  return getPreStepPhysicalVolume(theStep, iLevel)->GetLogicalVolume();
}

getPreStepLogicalVolumeName()

std::string G4StepHelper::getPreStepLogicalVolumeName	(	const G4Step *	theStep,
		int	iLevel = 0 )

TODO.

Definition at line 43 of file StepHelper.cxx.

{
  return getPreStepLogicalVolume(theStep, iLevel)->GetName();
}

getPreStepPhysicalVolume()

G4VPhysicalVolume * G4StepHelper::getPreStepPhysicalVolume	(	const G4Step *	theStep,
		int	iLevel = 0 )

TODO.

Definition at line 47 of file StepHelper.cxx.

{
  const G4TouchableHistory *history
    = static_cast<const G4TouchableHistory*>(theStep->GetPreStepPoint()->GetTouchable());
  if (iLevel<=0)
    {
      return history->GetVolume(std::abs(iLevel));
    }
  const int nLev=history->GetHistoryDepth();
  return history->GetVolume(nLev-iLevel);
}

getProcess()

const G4VProcess * G4StepHelper::getProcess

(

const G4Step *

theStep

)

TODO.

Definition at line 87 of file StepHelper.cxx.

{
  return theStep->GetPostStepPoint()->GetProcessDefinedStep();
}

getProcessName()

std::string G4StepHelper::getProcessName

(

const G4Step *

theStep

)

TODO.

Definition at line 92 of file StepHelper.cxx.

{
  return getProcess(theStep)->GetProcessName();
}

getProcessSubType()

G4int G4StepHelper::getProcessSubType

(

const G4Step *

theStep

)

TODO.

Definition at line 97 of file StepHelper.cxx.

{
  return getProcess(theStep)->GetProcessSubType();
}

particleName()

std::string G4StepHelper::particleName

(

const G4Step *

theStep

)

TODO.

Definition at line 24 of file StepHelper.cxx.

{
  assert (theStep!=nullptr);
  return theStep->GetTrack()->GetDefinition()->GetParticleName();
}

particlePDGCode()

int G4StepHelper::particlePDGCode

(

const G4Step *

theStep

)

TODO.

Definition at line 29 of file StepHelper.cxx.

{
  assert (theStep!=nullptr);
  return theStep->GetTrack()->GetDefinition()->GetPDGEncoding();
}

postStepBranchDepth()

int G4StepHelper::postStepBranchDepth

(

const G4Step *

theStep

)

TODO.

Definition at line 82 of file StepHelper.cxx.

{
  return static_cast<const G4TouchableHistory*>(theStep->GetPostStepPoint()->
          GetTouchable())->GetHistoryDepth();
}

postStepPosition()

G4ThreeVector G4StepHelper::postStepPosition

(

const G4Step *

theStep

)

TODO.

Definition at line 19 of file StepHelper.cxx.

{
  assert (theStep!=nullptr);
  return theStep->GetPostStepPoint()->GetPosition();
}

preStepBranchDepth()

int G4StepHelper::preStepBranchDepth

(

const G4Step *

theStep

)

TODO.

Definition at line 77 of file StepHelper.cxx.

{
  return static_cast<const G4TouchableHistory*>(theStep->GetPreStepPoint()->
          GetTouchable())->GetHistoryDepth();
}

preStepPosition()

G4ThreeVector G4StepHelper::preStepPosition

(

const G4Step *

theStep

)

TODO.

Definition at line 14 of file StepHelper.cxx.

{
  assert (theStep!=nullptr);
  return theStep->GetPreStepPoint()->GetPosition();
}