GHit Class Reference

Represents a hit in the detector. More...

#include <ghit.h>

Inheritance diagram for GHit:

Collaboration diagram for GHit:

Public Member Functions
	GHit (GTouchable *gt, const HitBitSet hbs, const G4Step *thisStep=nullptr, const string cScheme="default")
	Constructor for GHit. More...
	~GHit ()=default
	Destructor for GHit. More...
void *	operator new (size_t)
	Overloaded new operator using G4Allocator. More...
void	operator delete (void *)
	Overloaded delete operator using G4Allocator. More...
void	Draw () override
	Draws the hit using Geant4 visualization. More...
bool	is_same_hit (GHit *hit)
	Compare two ghits. More...
const vector< float >	getEdeps () const
	Gets the energy depositions from each step. More...
const vector< float >	getTimes () const
	Gets the time stamps for each step. More...
const vector< G4ThreeVector >	getGlobalPositions () const
	Gets the global positions recorded for the hit. More...
const vector< G4ThreeVector >	getLocalPositions () const
	Gets the local positions recorded for the hit. More...
const vector< int >	getPids () const
	Gets the particle IDs recorded for the hit. More...
int	getPid () const
	Returns the first particle ID. More...
vector< float >	getEs () const
	Gets the energy values recorded in bit 1. More...
float	getE () const
	Returns the first energy value. More...
const string	getProcessName () const
	Gets the process name associated with the hit. More...
const GTouchable *	getGTouchable () const
	Returns the GTouchable associated with the hit. More...
const vector< GIdentifier >	getGID () const
	Returns the detector element identity. More...
const vector< double >	getDetectorDimensions () const
	Returns the dimensions of the detector element. More...
void	calculateInfosForBit (int bit)
	Calculates averaged hit information for the specified bit. More...
float	getTotalEnergyDeposited ()
	Computes the total energy deposited. More...
float	getAverageTime ()
G4ThreeVector	getAvgLocalPosition ()
	Computes the average local position of the hit. More...
G4ThreeVector	getAvgGlobaPosition ()
	Computes the average global position of the hit. More...
void	addHitInfosForBitset (const HitBitSet hbs, const G4Step *thisStep)
	Adds hit information based on a HitBitSet. More...
vector< int >	getTTID ()
	Returns the touchable identity values as integers. More...

Detailed Description

This class is derived from G4VHit and is used to store information about a detector hit. It collects standard hit data (energy, time, positions) as well as additional information based on a configurable HitBitSet.

Definition at line 29 of file ghit.h.

Constructor & Destructor Documentation

GHit()

GHit::GHit	(	GTouchable *	gt,
		const HitBitSet	hbs,
		const G4Step *	thisStep = nullptr,
		const string	cScheme = "default"
	)

Parameters

gt	Pointer to the GTouchable that produced the hit.
thisStep	Pointer to the G4Step associated with the hit.
hbs	Bitset selecting which hit information to record.
cScheme	Color schema for visualization (default is "default").

Definition at line 16 of file ghit.cc.

~GHit()

GHit::~GHit ( )

default

Member Function Documentation

addHitInfosForBitset()

void GHit::addHitInfosForBitset	(	const HitBitSet	hbs,
		const G4Step *	thisStep
	)

This method extracts common hit data (positions, energy deposit, time) and then iterates over the bits in the HitBitSet to add additional information.

Parameters

hbs	The HitBitSet that selects which additional information to record.
thisStep	The current G4Step from which hit data is extracted.

Definition at line 17 of file addHitInfos.cc.

calculateInfosForBit()

void GHit::calculateInfosForBit

(

int

bit

)

For bit 0, it calculates the total energy deposited, average time, and weighted average positions. The computation uses energy deposition as weights. For other bits, placeholders exist for future extensions. Notice: if the energy deposited is very low (~50eV), the rounding error on the average calculations could be up to 10^-3.

Parameters

bit	The bit index for which to calculate the information.

Definition at line 17 of file calculations.cc.

Draw()

void GHit::Draw ( )

override

Depending on the total energy deposited, selects different visual attributes. Uses a G4Circle to represent the hit position. If the globalPositions vector is empty, the method exits safely.

Definition at line 56 of file ghit.cc.

getAverageTime()

float GHit::getAverageTime

(

)

Definition at line 87 of file calculations.cc.

getAvgGlobaPosition()

G4ThreeVector GHit::getAvgGlobaPosition

(

)

Uses energy-weighted averaging if energy deposition is nonzero.

Returns

The averaged global position as a G4ThreeVector.

Definition at line 115 of file calculations.cc.

getAvgLocalPosition()

G4ThreeVector GHit::getAvgLocalPosition

(

)

Uses energy-weighted averaging if available.

Returns

The averaged local position as a G4ThreeVector.

Definition at line 148 of file calculations.cc.

getDetectorDimensions()

const vector<double> GHit::getDetectorDimensions ( ) const

inline

Returns

A vector of double containing the dimensions.

Definition at line 179 of file ghit.h.

getE()

float GHit::getE ( ) const

inline

Note

Assumes Es is non-empty.

Returns

The first energy value.

Definition at line 155 of file ghit.h.

getEdeps()

const vector<float> GHit::getEdeps ( ) const

inline

Returns

A vector of energy deposition values.

Definition at line 111 of file ghit.h.

getEs()

vector<float> GHit::getEs ( ) const

inline

Returns

A vector of energy values.

Definition at line 148 of file ghit.h.

getGID()

const vector<GIdentifier> GHit::getGID ( ) const

inline

Returns

A vector of GIdentifier.

Definition at line 173 of file ghit.h.

getGlobalPositions()

const vector<G4ThreeVector> GHit::getGlobalPositions ( ) const

inline

Returns

A vector of G4ThreeVector representing global positions.

Definition at line 123 of file ghit.h.

getGTouchable()

const GTouchable* GHit::getGTouchable ( ) const

inline

Returns

Pointer to the GTouchable.

Definition at line 167 of file ghit.h.

getLocalPositions()

const vector<G4ThreeVector> GHit::getLocalPositions ( ) const

inline

Returns

A vector of G4ThreeVector representing local positions.

Definition at line 129 of file ghit.h.

getPid()

int GHit::getPid ( ) const

inline

Note

This method assumes that the 'pids' vector is not empty.

Returns

The first particle ID.

Definition at line 142 of file ghit.h.

getPids()

const vector<int> GHit::getPids ( ) const

inline

Returns

A vector of integer particle IDs.

Definition at line 135 of file ghit.h.

getProcessName()

const string GHit::getProcessName ( ) const

inline

Returns

The process name string.

Definition at line 161 of file ghit.h.

getTimes()

const vector<float> GHit::getTimes ( ) const

inline

Returns

A vector of time values.

Definition at line 117 of file ghit.h.

getTotalEnergyDeposited()

float GHit::getTotalEnergyDeposited

(

)

Sums the energy depositions over all steps.

Returns

The total energy deposited.

Definition at line 76 of file calculations.cc.

getTTID()

vector< int > GHit::getTTID

(

)

Iterates over the GIdentifier vector from the associated GTouchable.

Returns

A vector of integer identity values.

Definition at line 37 of file ghit.cc.

is_same_hit()

bool GHit::is_same_hit

(

GHit *

hit

)

Parameters

hit

Returns

Returns true if this gtouchable is the same as the one in the hit.

Definition at line 32 of file ghit.cc.

operator delete()

void GHit::operator delete ( void *  hit )

inline

Parameters

pointer

Pointer to the object to deallocate.

Definition at line 219 of file ghit.h.

operator new()

void * GHit::operator new ( size_t  )

inline

Parameters

size	Size of the object to allocate.

Returns

Pointer to allocated memory.

Definition at line 213 of file ghit.h.

---

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

• ghit.h
• addHitInfos.cc
• calculations.cc
• ghit.cc