Class to describe the energy deposit of a single particle. More...

#include <dataobjects/ParticleHit.h>

Public Member Functions
	ParticleHit ()
	Constructor. More...

	ParticleHit (int particlePDG, float eDep, float entranceEnergy, Point entrancePoint, Point exitPoint, Momentum entranceMomentum, int trackID, int parentTrackID, float time)
	Constructor. More...

virtual	~ParticleHit ()=default
	Virtual destructor. More...

float	EDep () const
	Get the deposited energy. More...

void	SetEDep (float eDep)
	Set the energy deposit of the hit. More...

const Point &	EntrancePoint () const
	Get the entrance point in the hit volume. More...

void	SetEntrancePoint (Point entrancePoint)
	Set the entrance point in the hit volume. More...

const Point &	ExitPoint () const
	Get the exit point from the hit volume. More...

void	SetExitPoint (Point exitPoint)
	Set the exit point from the hit volume. More...

const Momentum &	EntranceMomentum () const
	Get the momentum at the entrance in the hit volume. More...

void	SetEntranceMomentum (Momentum entranceMomentum)
	Set the momentum at the entrance in the hit volume. More...

float	EntranceEnergy () const
	Get the particle energy at the entrance in the hit volume. More...

void	SetEntranceEnergy (float entranceEnergy)
	Set the particle energy at the entrance in the hit volume. More...

int	ParticlePDG () const
	Get the PDG code of the particle. More...

void	SetParticlePDG (int particlePdg)
	Set the PDG code of the particle. More...

int	TrackID () const
	Get the ID of the particle track. More...

void	SetTrackID (int trackID)
	Set the track ID of the particle. More...

int	ParentTrackID () const
	Get the ID of the parent particle track. More...

void	SetParentTrackID (int parentTrackID)
	Set the track ID of the parent particle. More...

float	Time () const
	Get the particle track arrival time in ns. More...

void	SetTime (float time)
	Set the particle track arrival time (in ns). More...

bool	operator== (const ParticleHit &rhs) const
	Comparison operator. More...

Private Attributes
int	_particlePdg
	Particle PDG ID. More...

float	_eDep
	Deposited energy. More...

float	_entranceEnergy
	Entrance kinetic energy. More...

Point	_entrancePoint
	Entrance point. More...

Point	_exitPoint
	Exit point. More...

Momentum	_entranceMomentum
	Entrance momentum. More...

int	_trackID
	The track ID of the particle. More...

int	_parentTrackID
	The track ID of the particle. More...

float	_time
	The particle time of arrival. More...

Detailed Description

Class to describe the energy deposit of a single particle.

This class provides information about the energy deposit of a single particle. It is meant to describe Monte Carlo data, where single-particle energy deposits are available.

Constructor & Destructor Documentation

◆ ParticleHit() [1/2]

Herd::ParticleHit::ParticleHit ( )

inline

Constructor.

◆ ParticleHit() [2/2]

Herd::ParticleHit::ParticleHit	(	int	particlePDG,
		float	eDep,
		float	entranceEnergy,
		Point	entrancePoint,
		Point	exitPoint,
		Momentum	entranceMomentum,
		int	trackID,
		int	parentTrackID,
		float	time
	)

inline

Constructor.

Parameters

particlePDG	The PDG code of the particle.
eDep	The energy deposited by the particle in the volume.
entranceEnergy	Particle energy at volume entrance.
entrancePoint	Coordinates of the entrance point [cm].
exitPoint	Coordinates of the exit point [cm].
entranceMomentum	Particle momentum at volume entrance.
trackID	The ID of the particle track.
parentTrackID	The ID of the parent particle track. Must be 0 if the current particle is a primary.

◆ ~ParticleHit()

virtual Herd::ParticleHit::~ParticleHit ( )

virtualdefault

Virtual destructor.

Member Function Documentation

◆ EDep()

float Herd::ParticleHit::EDep ( ) const

inline

Get the deposited energy.

Returns: The deposited energy [GeV].

◆ EntranceEnergy()

float Herd::ParticleHit::EntranceEnergy ( ) const

inline

Get the particle energy at the entrance in the hit volume.

Returns: The particle energy at the entrance in the hit volume [GeV].

◆ EntranceMomentum()

const Momentum& Herd::ParticleHit::EntranceMomentum ( ) const

inline

Get the momentum at the entrance in the hit volume.

Returns: The momentum at the entrance in the hit volume [GeV].

◆ EntrancePoint()

const Point& Herd::ParticleHit::EntrancePoint ( ) const

inline

Get the entrance point in the hit volume.

Returns: The entrance point in the hit volume [cm].

◆ ExitPoint()

const Point& Herd::ParticleHit::ExitPoint ( ) const

inline

Get the exit point from the hit volume.

Returns: The exit point from the hit volume [cm].

◆ operator==()

bool Herd::ParticleHit::operator== ( const ParticleHit & rhs ) const

inline

Comparison operator.

Parameters

rhs	The right hand side of the comparison expression.

Returns: true if the two ParticleHit objects are equal member-wise.

◆ ParentTrackID()

int Herd::ParticleHit::ParentTrackID ( ) const

inline

Get the ID of the parent particle track.

Will return 0 if the current particle is a primary.

Returns: The track ID.

◆ ParticlePDG()

int Herd::ParticleHit::ParticlePDG ( ) const

inline

Get the PDG code of the particle.

Returns: The pdg code of the particle.

◆ SetEDep()

void Herd::ParticleHit::SetEDep ( float eDep )

inline

Set the energy deposit of the hit.

Parameters

eDep	The deposited energy [GeV].

◆ SetEntranceEnergy()

void Herd::ParticleHit::SetEntranceEnergy ( float entranceEnergy )

inline

Set the particle energy at the entrance in the hit volume.

Parameters

entranceEnergy The particle energy at the entrance in the hit volume [GeV].

◆ SetEntranceMomentum()

void Herd::ParticleHit::SetEntranceMomentum ( Momentum entranceMomentum )

inline

Set the momentum at the entrance in the hit volume.

Parameters

entranceMomentum The momentum at the entrance in the hit volume [GeV].

◆ SetEntrancePoint()

void Herd::ParticleHit::SetEntrancePoint ( Point entrancePoint )

inline

Set the entrance point in the hit volume.

Parameters

entrancePoint The entrance point in the hit volume [cm].

◆ SetExitPoint()

void Herd::ParticleHit::SetExitPoint ( Point exitPoint )

inline

Set the exit point from the hit volume.

Parameters

exitPoint The exit point from the hit volume [cm].

◆ SetParentTrackID()

void Herd::ParticleHit::SetParentTrackID ( int parentTrackID )

inline

Set the track ID of the parent particle.

Must be 0 if the current particle is a primary.

Parameters

parentTrackID The track ID.

◆ SetParticlePDG()

void Herd::ParticleHit::SetParticlePDG ( int particlePdg )

inline

Set the PDG code of the particle.

Parameters

particlePdg The PDG code of the particle.

◆ SetTime()

void Herd::ParticleHit::SetTime ( float time )

inline

Set the particle track arrival time (in ns).

Parameters

parentTrackID The track ID.

◆ SetTrackID()

void Herd::ParticleHit::SetTrackID ( int trackID )

inline

Set the track ID of the particle.

Parameters

trackID The track ID.

◆ Time()

float Herd::ParticleHit::Time ( ) const

inline

Get the particle track arrival time in ns.

Returns: The track ID.

◆ TrackID()

int Herd::ParticleHit::TrackID ( ) const

inline

Get the ID of the particle track.

Returns: The track ID.

Member Data Documentation

◆ _eDep

float Herd::ParticleHit::_eDep

private

Deposited energy.

◆ _entranceEnergy

float Herd::ParticleHit::_entranceEnergy

private

Entrance kinetic energy.

◆ _entranceMomentum

Momentum Herd::ParticleHit::_entranceMomentum

private

Entrance momentum.

◆ _entrancePoint

Point Herd::ParticleHit::_entrancePoint

private

Entrance point.

◆ _exitPoint

Point Herd::ParticleHit::_exitPoint

private

Exit point.

◆ _parentTrackID

int Herd::ParticleHit::_parentTrackID

private

The track ID of the particle.

◆ _particlePdg

int Herd::ParticleHit::_particlePdg

private

Particle PDG ID.

◆ _time

float Herd::ParticleHit::_time

private

The particle time of arrival.

◆ _trackID

int Herd::ParticleHit::_trackID

private

The track ID of the particle.

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

/builds/herd/HerdSoftware/include/analysis/dataobjects/ParticleHit.h

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ParticleHit() [1/2]

◆ ParticleHit() [2/2]

◆ ~ParticleHit()

Member Function Documentation

◆ EDep()

◆ EntranceEnergy()

◆ EntranceMomentum()

◆ EntrancePoint()

◆ ExitPoint()

◆ operator==()

◆ ParentTrackID()

◆ ParticlePDG()

◆ SetEDep()

◆ SetEntranceEnergy()

◆ SetEntranceMomentum()

◆ SetEntrancePoint()

◆ SetExitPoint()

◆ SetParentTrackID()

◆ SetParticlePDG()

◆ SetTime()

◆ SetTrackID()

◆ Time()

◆ TrackID()

Member Data Documentation

◆ _eDep

◆ _entranceEnergy

◆ _entranceMomentum

◆ _entrancePoint

◆ _exitPoint

◆ _parentTrackID

◆ _particlePdg

◆ _time

◆ _trackID