GGSPartHit Class Reference

Definition of GGS Particle Hit. More...

#include <GGSPartHit.h>

Inheritance diagram for GGSPartHit:

Collaboration diagram for GGSPartHit:

Public Member Functions
	GGSPartHit ()
	Constructor.
	~GGSPartHit ()
	Destructor.
	GGSPartHit (const GGSPartHit &right)
	Copy constructor. More...
const GGSPartHit &	operator= (const GGSPartHit &right)
	Assignment operator. More...
bool	operator== (const GGSPartHit &right) const
	Comparison operator. More...
void *	operator new (size_t size)
	Operator new. More...
void	operator delete (void *aHit)
	Operator delete. More...
virtual void	UserInit (G4Step *aStep)
	User initialization of hit global properties. More...
virtual void	AddStep (const G4Step &step)
	Adds a step to the particle hit. More...
void	SetTrackID (G4int id)
	Track ID setter. More...
void	SetParentID (G4int id)
	Parent's track ID setter. More...
void	SetParticlePdg (G4int pdg)
	PDG code setter. More...
void	SetPosHitsStorage (bool flag)
	Turn on or off the storage of position hits. More...
G4double	GetEnergyDeposit () const
	Energy deposit getter. More...
G4double	GetTime () const
	Time getter. More...
G4double	GetPathLength () const
	Path length getter. More...
G4ThreeVector	GetEntrancePoint () const
	Entrance point getter. More...
G4ThreeVector	GetExitPoint () const
	Exit point getter. More...
G4ThreeVector	GetEntranceMomentum () const
	Entrance momentum getter. More...
G4double	GetEntranceEnergy () const
	Entrance energy getter. More...
G4int	GetTrackID () const
	Track ID getter. More...
G4int	GetParentID () const
	Parent's track ID getter. More...
G4int	GetParticlePdg () const
	PDG code getter. More...
GGSPosHitsCollection *	GetPosHits ()
	Getter of container of position hits. More...

Protected Attributes
G4double	_eDep
G4double	_time
G4double	_pathLength
G4ThreeVector	_entrancePoint
G4ThreeVector	_exitPoint
G4ThreeVector	_entranceMomentum
G4double	_entranceEnergy
G4int	_trackID
G4int	_parentID
G4int	_particlePdg
bool	_isReset
GGSPosHitsCollection *	_posHits

Detailed Description

Definition of GGS Particle Hit.

A particle hit is associated to a sensitive physical volume and a particle. It carries information about total energy release of that particle in that volume during the current event. So if in the current event there are N volumes and the i-th volume is traversed by M_i particles, then there will be sum_i (M_i) particle hits in the event. Note that if a particle passes through a sensitive volume without releasing energy (eg., a neutrino) the corresponding particle hit will be generated anyway with zero energy release.

Definition at line 36 of file GGSPartHit.h.

Constructor & Destructor Documentation

GGSPartHit::GGSPartHit

(

const GGSPartHit &

right

)

Copy constructor.

Parameters

right

The object to be copied into current one.

Definition at line 23 of file GGSPartHit.cpp.

                                              : G4VHit() {
  _eDep = right._eDep;
  _time = right._time;
  _pathLength = right._pathLength;
  _entrancePoint = right._entrancePoint;
  _exitPoint = right._exitPoint;
  _entranceMomentum = right._entranceMomentum;
  _entranceEnergy = right._entranceEnergy;
  _trackID = right._trackID;
  _parentID = right._parentID;
  _particlePdg = right._particlePdg;
  _isReset = right._isReset;

  if (right._posHits == NULL) {
    _posHits = NULL;
  } else
    _posHits = new GGSPosHitsCollection(*right._posHits);
}

Member Function Documentation

void GGSPartHit::AddStep ( const G4Step &  step )

virtual

Adds a step to the particle hit.

This method adds a step to the particle hit. The particle hit integral quantities (scoring value and path length) will be incremented by the corresponding step quantities. The exit point from the volume will be updated with the value of the end point of the step; if the step is the first to be added, its values for start point, energy, momentum and time will be used to set the values of entrance point, energy, momentum and time of the particle hit.

The step object itself can be stored as a GGSPosHit by calling SetPosHitsStorage with proper parameter. The container of stored position hit objects can be retrieved with the GetPosHits method. Default behavior is to not store GGSPosHit objects; user must be aware that storing GGSPosHit objects could result in a great increase in memory consumption if the sensitive element is thick or traversed by many particles (e.g. a scintillating bar in an e.m. calorimeter).

Parameters

step	the G4Step object representing the simulation step to be added.

Definition at line 101 of file GGSPartHit.cpp.

                                           {
  _eDep += step.GetTotalEnergyDeposit();
  _pathLength += step.GetStepLength();
  _exitPoint = step.GetPostStepPoint()->GetPosition();

  if (_isReset) {
    // First step for this particle hit: store initial values
    _isReset = false;
    _time = step.GetPreStepPoint()->GetGlobalTime();
    _entrancePoint = step.GetPreStepPoint()->GetPosition();
    _entranceMomentum = step.GetPreStepPoint()->GetMomentum();
    _entranceEnergy = step.GetPreStepPoint()->GetKineticEnergy();
    _trackID = step.GetTrack()->GetTrackID();
    _parentID = step.GetTrack()->GetParentID();
    _particlePdg = step.GetTrack()->GetDefinition()->GetPDGEncoding();
  }
}

G4double GGSPartHit::GetEnergyDeposit ( ) const

inline

Energy deposit getter.

Returns

The energy deposit.

Definition at line 148 of file GGSPartHit.h.

{ return _eDep; }

G4double GGSPartHit::GetEntranceEnergy ( ) const

inline

Entrance energy getter.

Gets the energy of the particle at entrance in the volume.

Returns

The entrance energy.

Definition at line 192 of file GGSPartHit.h.

{ return _entranceEnergy; }

G4ThreeVector GGSPartHit::GetEntranceMomentum ( ) const

inline

Entrance momentum getter.

Gets the momentum of the particle at entrance in the volume.

Returns

The entrance moemntum.

Definition at line 184 of file GGSPartHit.h.

{ return _entranceMomentum; }

G4ThreeVector GGSPartHit::GetEntrancePoint ( ) const

inline

Entrance point getter.

Gets the particle's entrance point in the volume.

Returns

The entrance point.

Definition at line 168 of file GGSPartHit.h.

{ return _entrancePoint; }

G4ThreeVector GGSPartHit::GetExitPoint ( ) const

inline

Exit point getter.

Gets the particle's exit point from the volume.

Returns

The exit point.

Definition at line 176 of file GGSPartHit.h.

{ return _exitPoint; }

G4int GGSPartHit::GetParentID ( ) const

inline

Parent's track ID getter.

Returns

The track ID of the parent of the particle.

Definition at line 204 of file GGSPartHit.h.

{ return _parentID; }

G4int GGSPartHit::GetParticlePdg ( ) const

inline

PDG code getter.

Returns

PDG code of the particle.

Definition at line 210 of file GGSPartHit.h.

{ return _particlePdg; }

G4double GGSPartHit::GetPathLength ( ) const

inline

Path length getter.

Returns

The total path length of particles traversing the volume.

Definition at line 160 of file GGSPartHit.h.

{ return _pathLength; }

GGSPosHitsCollection* GGSPartHit::GetPosHits ( )

inline

Getter of container of position hits.

Returns

pointer to the position hit container (NULL if storage of position hits has not been previously turned on by calling SetPosHitsStorage).

Definition at line 218 of file GGSPartHit.h.

{ return _posHits; }

G4double GGSPartHit::GetTime ( ) const

inline

Time getter.

Returns

The time of initial energy deposit.

Definition at line 154 of file GGSPartHit.h.

{ return _time; }

G4int GGSPartHit::GetTrackID ( ) const

inline

Track ID getter.

Returns

The track ID of the particle.

Definition at line 198 of file GGSPartHit.h.

{ return _trackID; }

void GGSPartHit::operator delete ( void *  aHit )

inline

Operator delete.

This implementation uses G4Allocator.

Parameters

aHit	The current hit to be deleted.

See Also

GGSPartHitAllocator.

Definition at line 253 of file GGSPartHit.h.

{ GGSPartHitAllocator.FreeSingle((GGSPartHit *)aHit); }

void * GGSPartHit::operator new ( size_t  size )

inline

Operator new.

This implementation uses G4Allocator.

Parameters

size	Unused (needed by the interface).

See Also

GGSPartHitAllocator.

Definition at line 245 of file GGSPartHit.h.

                                            {
  void *aHit;
  aHit = (void *)GGSPartHitAllocator.MallocSingle();
  return aHit;
}

const GGSPartHit & GGSPartHit::operator=

(

const GGSPartHit &

right

)

Assignment operator.

Parameters

right

The object to be assigned to current one.

Returns

The new current object.

Definition at line 44 of file GGSPartHit.cpp.

                                                               {
  if (this != &right) {
    _eDep = right._eDep;
    _time = right._time;
    _pathLength = right._pathLength;
    _entrancePoint = right._entrancePoint;
    _exitPoint = right._exitPoint;
    _entranceMomentum = right._entranceMomentum;
    _entranceEnergy = right._entranceEnergy;
    _trackID = right._trackID;
    _parentID = right._parentID;
    _particlePdg = right._particlePdg;
    _isReset = right._isReset;
    if (right._posHits == NULL) {
      delete _posHits;
      _posHits = NULL;
    } else
      *_posHits = *(right._posHits);
  }
  return *this;
}

bool GGSPartHit::operator==

(

const GGSPartHit &

right

)

const

Comparison operator.

Parameters

right

RHS of comparison.

Returns

true if LHS==RHS.

Definition at line 68 of file GGSPartHit.cpp.

                                                         {
  if ((_eDep == right._eDep) &&                         //
      (_time == right._time) &&                         //
      (_pathLength == right._pathLength) &&             //
      (_entrancePoint == right._entrancePoint) &&       //
      (_exitPoint == right._exitPoint) &&               //
      (_entranceMomentum == right._entranceMomentum) && //
      (_entranceEnergy == right._entranceEnergy) &&     //
      (_trackID == right._trackID) &&                   //
      (_parentID == right._parentID) &&                 //
      (_particlePdg == right._particlePdg)) {

    if (_posHits != NULL) {
      if (right._posHits != NULL) {
        return (*_posHits == *(right._posHits));
      }

      else {
        return false;
      }
    } else {
      if (right._posHits != NULL) {
        return false;
      } else {
        return true;
      }
    }
  } else
    return false;
}

void GGSPartHit::SetParentID ( G4int  id )

inline

Parent's track ID setter.

Parameters

id	The ID of the track of the particle's parent.

Definition at line 126 of file GGSPartHit.h.

{ _parentID = id; }

void GGSPartHit::SetParticlePdg ( G4int  pdg )

inline

PDG code setter.

Parameters

pdg	The PDG code of the particle.

Definition at line 132 of file GGSPartHit.h.

{ _particlePdg = pdg; }

void GGSPartHit::SetPosHitsStorage

(

bool

flag

)

Turn on or off the storage of position hits.

Position hits added to particle hit by AddStep are by default not stored. This method enables or disables position hit storage.

Parameters

flag	if true, position hits will be stored.

Definition at line 121 of file GGSPartHit.cpp.

                                            {

  if (flag == true) {
    if (!_posHits)
      _posHits = new GGSPosHitsCollection;
  } else {
    if (_posHits) {
      delete _posHits;
      _posHits = NULL;
    }
  }
}

void GGSPartHit::SetTrackID ( G4int  id )

inline

Track ID setter.

Parameters

id	The ID of particle's track

Definition at line 120 of file GGSPartHit.h.

{ _trackID = id; }

virtual void GGSPartHit::UserInit ( G4Step *  aStep )

inlinevirtual

User initialization of hit global properties.

This method is called by GGSIntHitSD after initializing the hit object just after its creation, before calling AddStep. Users can override this method in custom hit classes to perform additional custom initialization. The #aStep argument is the simulation step at which the hit is created.

Parameters

aStep

The step at which the hit has been created.

Definition at line 90 of file GGSPartHit.h.

{ GGS_IGNORE_VAR(aStep); }

---

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

• GGSPartHit.h
• GGSPartHit.cpp