SensitiveDetector Class Reference

Sensitive Detector implementation of the PLUME detector. More...

#include <SensitiveDetector.h>

Inheritance diagram for SensitiveDetector:

Collaboration diagram for SensitiveDetector:

Public Member Functions
	SensitiveDetector ()
	Constructor.
	~SensitiveDetector ()
	Destructor.

Static Public Member Functions
static const std::map< std::string, RelationArray::EConsolidationAction > &	getMCParticleRelations ()
	Return a list of all registered Relations with MCParticles.
static void	setActive (bool activeStatus)
	Enable/Disable all Sensitive Detectors. More...
static void	registerMCParticleRelation (const std::string &name, RelationArray::EConsolidationAction ignoreAction=RelationArray::c_negativeWeight)
	Register an relation involving MCParticles. More...
static void	registerMCParticleRelation (const RelationArray &relation, RelationArray::EConsolidationAction ignoreAction=RelationArray::c_negativeWeight)
	Overload to make it easer to register MCParticle relations. More...

Protected Member Functions
bool	step (G4Step *step, G4TouchableHistory *) override
	Step processing method. More...

Private Member Functions
virtual bool	ProcessHits (G4Step *aStep, G4TouchableHistory *aROhist)
	Check if recording hits is enabled and if so call step() and set the correct MCParticle flag. More...

Private Attributes
int	current_pdgID
	particle PDG id
int	current_sensorID
	sensor ID
int	current_trackID
	track ID
float	current_trackVertex_x
	track production vertex x coordinates in G4 ref
float	current_trackVertex_y
	track production vertex y coordinates in G4 ref
float	current_trackVertex_z
	track production vertex z coordinates in G4 ref
float	current_energyDep
	deposited energy in MeV
float	current_nielDep
	non ionizing deposited energy
float	current_posIN_x
	incoming track position x in G4 ref, in mm
float	current_posIN_y
	incoming track position y in G4 ref, in mm
float	current_posIN_z
	incoming track position z in G4 ref, in mm
float	current_posIN_u
	incoming track position u in sensor ref, in mm
float	current_posIN_v
	incoming track position v in sensor ref, in mm
float	current_posIN_w
	incoming track position w in sensor ref, in mm
float	current_posOUT_u
	outcoming track position u in sensor ref, in mm
float	current_posOUT_v
	outcoming track position v in sensor ref, in mm
float	current_posOUT_w
	outcoming track position w in sensor ref, in mm
float	current_posOUT_x
	outcoming track position x in sensor ref, in mm
float	current_posOUT_y
	outcoming track position y in sensor ref, in mm
float	current_posOUT_z
	outcoming track position z in sensor ref, in mm
float	current_momentum_x
	incoming track momentum, x coordinates in G4 ref, in GeV
float	current_momentum_y
	incoming track momentum, y coordinates in G4 ref, in GeV
float	current_momentum_z
	incoming track momentum, z coordinates in G4 ref, in GeV
float	current_thetaAngle
	local (sensor ref) theta angle, out of sensor plane, in degree
float	current_phiAngle
	local (sensor ref) phi angle, in sensor plane, in degree
float	current_globalTime
	global time
Const::EDetector	m_subdetector
	Subdetector the class belongs to.

Static Private Attributes
static std::map< std::string, RelationArray::EConsolidationAction >	s_mcRelations
	Static set holding all relations which have to be updated at the end of the Event.
static bool	s_active
	Static bool which indicates wether recording of hits is enabled.

Detailed Description

Sensitive Detector implementation of the PLUME detector.

Definition at line 22 of file SensitiveDetector.h.

Member Function Documentation

ProcessHits()

bool ProcessHits ( G4Step *  aStep, G4TouchableHistory *  aROhist  )

inlineprivatevirtualinherited

Check if recording hits is enabled and if so call step() and set the correct MCParticle flag.

Called by Geant4 for each step inside the sensitive volumes attached

Definition at line 94 of file SensitiveDetectorBase.h.

registerMCParticleRelation() [1/2]

static void registerMCParticleRelation ( const RelationArray &  relation, RelationArray::EConsolidationAction  ignoreAction = RelationArray::c_negativeWeight  )

inlinestaticinherited

Overload to make it easer to register MCParticle relations.

Parameters

relation	RelationArray to register
ignoreAction

Definition at line 66 of file SensitiveDetectorBase.h.

registerMCParticleRelation() [2/2]

void registerMCParticleRelation ( const std::string &  name, RelationArray::EConsolidationAction  ignoreAction = RelationArray::c_negativeWeight  )

staticinherited

Register an relation involving MCParticles.

All Relations which point from an MCParticle to something have to be registered with addMCParticleRelation() because the index of the MCParticles might change at the end of the event. During simulation, the TrackID should be used as index of the MCParticle

Parameters

name	Name of the relation to register
ignoreAction

Definition at line 22 of file SensitiveDetectorBase.cc.

setActive()

static void setActive ( bool  activeStatus )

inlinestaticinherited

Enable/Disable all Sensitive Detectors.

By default, all sensitive detectors won't create hits to make it possible to use the Geant4 Navigator for non-simulation purposes. Only during simulation the sensitive detectors will be enabled to record hits

Parameters

activeStatus

bool to indicate wether hits should be recorded

Definition at line 50 of file SensitiveDetectorBase.h.

step()

bool step ( G4Step *  step, G4TouchableHistory *    )

overrideprotectedvirtual

Step processing method.

Parameters

step	the G4Step with the current step information

Returns

true if a Hit has been created, false if the hit was ignored

Implements SensitiveDetectorBase.

Definition at line 92 of file SensitiveDetector.cc.

    {
 
      //Get track information, and pre- and post-step
      const G4Track& track = *step->GetTrack();
      const G4StepPoint& preStepPoint = *step->GetPreStepPoint();
      const G4StepPoint& postStepPoint = *step->GetPostStepPoint();
 
 
      // If new track, store general information from this first step
      if (current_trackID != track.GetTrackID()) { // if new track
        current_trackID = track.GetTrackID();
        current_trackVertex_x = track.GetVertexPosition().x();
        current_trackVertex_y = track.GetVertexPosition().y();
        current_trackVertex_z = track.GetVertexPosition().z();
        current_pdgID = track.GetDefinition()->GetPDGEncoding();
        current_sensorID =  preStepPoint.GetTouchableHandle()->GetReplicaNumber(1);
 
        // since this is first step in volume store track incidence and momentum and reset energy loss
        G4ThreeVector preStepPointPosition = preStepPoint.GetPosition();
        G4ThreeVector trackMomentum = track.GetMomentum();
        current_energyDep = 0.;
        current_nielDep = 0.;
 
        current_posIN_x = preStepPointPosition.x();
        current_posIN_y = preStepPointPosition.y();
        current_posIN_z = preStepPointPosition.z();
        current_momentum_x = trackMomentum.x();
        current_momentum_y = trackMomentum.y();
        current_momentum_z = trackMomentum.z();
 
        // We want the track angles of incidence on the local volume and the local position
        G4TouchableHandle theTouchable = preStepPoint.GetTouchableHandle();
        G4ThreeVector worldDirection = preStepPoint.GetMomentumDirection();
        G4ThreeVector localDirection = theTouchable->GetHistory()->GetTopTransform().TransformAxis(worldDirection);
 
        if (localDirection.z() < 0.) {
          current_thetaAngle = M_PI - acos(-1. * localDirection.z());
        } else {
          current_thetaAngle = acos(localDirection.z());
        }
 
 
        if (localDirection.x() < 0. && localDirection.y() > 0.) {
          current_phiAngle = atan(-1. * localDirection.x() / localDirection.y());
        } else if (localDirection.x() < 0. && localDirection.y() < 0.) {
          current_phiAngle = M_PI - atan(localDirection.x() / localDirection.y());
        } else if (localDirection.x() > 0. && localDirection.y() < 0.) {
          current_phiAngle = M_PI + atan(-1. * localDirection.x() / localDirection.y());
        } else if (localDirection.x() > 0. && localDirection.y() > 0.) {
          current_phiAngle = 2. * M_PI - atan(localDirection.x() / localDirection.y());
        } else if (localDirection.x() < 0. && localDirection.y() == 0.) {
          current_phiAngle = M_PI / 2.;
        } else if (localDirection.x() > 0. && localDirection.y() == 0.) {
          current_phiAngle = 3.* M_PI / 2.;
        } else if (localDirection.x() == 0. && localDirection.y() > 0.) {
          current_phiAngle = 0.;
        } else if (localDirection.x() == 0. && localDirection.y() < 0.) {
          current_phiAngle = M_PI;
        }
 
        G4ThreeVector localINPosition = theTouchable->GetHistory()->GetTopTransform().TransformPoint(preStepPointPosition);
        current_posIN_u = localINPosition.y();
        current_posIN_v = - localINPosition.x();
        current_posIN_w = localINPosition.z();
 
        current_globalTime = step->GetPreStepPoint()->GetGlobalTime();
 
      }  // end if new track
 
      // Update information at each step
      current_energyDep += step->GetTotalEnergyDeposit();
      current_nielDep += step->GetNonIonizingEnergyDeposit();
 
      // If track leaves volume or is killed, store final step info and save simHit
      if (track.GetNextVolume() != track.GetVolume() || track.GetTrackStatus() >= fStopAndKill) { // if last step
 
        G4ThreeVector postStepPointPosition = postStepPoint.GetPosition();
 
        current_posOUT_x = postStepPointPosition.x();
        current_posOUT_y = postStepPointPosition.y();
        current_posOUT_z = postStepPointPosition.z();
        G4ThreeVector localOUTPosition = preStepPoint.GetTouchableHandle()->GetHistory()->GetTopTransform().TransformPoint(
                                           postStepPointPosition);
        current_posOUT_u = localOUTPosition.y();
        current_posOUT_v = - localOUTPosition.x();
        current_posOUT_w = localOUTPosition.z();
 
        //Get the datastore arrays
        StoreArray<MCParticle>  mcParticles;
        StoreArray<PlumeSimHit> simHits;
 
        if (current_energyDep > CLHEP::eV) {
 
          RelationArray relMCSimHit(mcParticles, simHits);
          PlumeSimHit* hit = simHits.appendNew(
                               current_pdgID,
                               current_sensorID,
                               current_trackID,
                               current_trackVertex_x / CLHEP::mm,
                               current_trackVertex_y / CLHEP::mm,
                               current_trackVertex_z / CLHEP::mm,
                               current_energyDep / CLHEP::MeV,
                               current_nielDep / CLHEP::MeV,
                               current_posIN_x / CLHEP::mm,
                               current_posIN_y / CLHEP::mm,
                               current_posIN_z / CLHEP::mm,
                               current_posIN_u / CLHEP::mm,
                               current_posIN_v / CLHEP::mm,
                               current_posIN_w / CLHEP::mm,
                               current_posOUT_u / CLHEP::mm,
                               current_posOUT_v / CLHEP::mm,
                               current_posOUT_w / CLHEP::mm,
                               current_momentum_x / CLHEP::GeV,
                               current_momentum_y / CLHEP::GeV,
                               current_momentum_z / CLHEP::GeV,
                               current_thetaAngle / CLHEP::degree,
                               current_phiAngle / CLHEP::degree,
                               current_globalTime / CLHEP::nanosecond
                             );
 
          //Add Relation between SimHit and MCParticle with a weight of 1. Since
          //the MCParticle index is not yet defined we use the trackID from Geant4
          relMCSimHit.add(current_trackID, hit->getArrayIndex(), 1.0);
        }
 
        //Reset TrackID
        current_trackID = 0;
 
      } // end if last
 
 
      //Ignore everything below 1eV
      if (current_energyDep < CLHEP::eV) return false;
 
 
      return true;
    }

---

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

• beast/plume/simulation/include/SensitiveDetector.h
• beast/plume/simulation/src/SensitiveDetector.cc