SensitiveDetector Class Reference

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

#include <SensitiveDetector.h>

Inheritance diagram for SensitiveDetector:

Public Member Functions
	SensitiveDetector ()
	Constructor.
int	saveG4TrackInfo (int trackID, int PDG, float Mass, float Energy, float vtx[3], float mom[3])
	Save saveG4TrackInfo into datastore.

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.
static void	registerMCParticleRelation (const std::string &name, RelationArray::EConsolidationAction ignoreAction=RelationArray::c_negativeWeight)
	Register an relation involving MCParticles.
static void	registerMCParticleRelation (const RelationArray &relation, RelationArray::EConsolidationAction ignoreAction=RelationArray::c_negativeWeight)
	Overload to make it easer to register MCParticle relations.

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

Protected Attributes
int	m_trackID
	track id

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.

Private Attributes
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 HE3TUBE detector.

Definition at line 22 of file SensitiveDetector.h.

Constructor & Destructor Documentation

SensitiveDetector()

SensitiveDetector

(

)

Constructor.

Definition at line 29 of file SensitiveDetector.cc.

                                        :
      Simulation::SensitiveDetectorBase("He3tubeSensitiveDetector", Const::invalidDetector)
    {
      m_trackID = 0;
      //Make sure all collections are registered
      StoreArray<MCParticle>   mcParticles;
      StoreArray<He3tubeSimHit>  simHits;
      StoreArray<HE3G4TrackInfo> HE3G4TrackInfos;
      RelationArray relMCSimHit(mcParticles, simHits);
 
      //Register all collections we want to modify and require those we want to use
      mcParticles.registerInDataStore();
      simHits.registerInDataStore();
      relMCSimHit.registerInDataStore();
      HE3G4TrackInfos.registerInDataStore();
      //Register the Relation so that the TrackIDs get replaced by the actual
      //MCParticle indices after simulating the events. This is needed as
      //secondary particles might not be stored so everything relating to those
      //particles will be attributed to the last saved mother particle
      registerMCParticleRelation(relMCSimHit);
    }

Member Function Documentation

getMCParticleRelations()

static const std::map< std::string, RelationArray::EConsolidationAction > & getMCParticleRelations ( )

inlinestaticinherited

Return a list of all registered Relations with MCParticles.

Definition at line 42 of file SensitiveDetectorBase.h.

{ return s_mcRelations; }

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.

    {
      if (!s_active) return false;
      bool result = step(aStep, aROhist);
      // Do not include hits from invalid detector (beast,teastbeam, etc.)
      if (result && (m_subdetector != Const::invalidDetector)) TrackInfo::getInfo(*aStep->GetTrack()).addSeenInDetector(m_subdetector);
      return result;
    }

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(relation.getName(), ignoreAction); }

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.

    {
      std::pair<std::map<std::string, RelationArray::EConsolidationAction>::iterator, bool> insert = s_mcRelations.insert(std::make_pair(
            name, ignoreAction));
      //If the relation already exists and the ignoreAction is different we do have a problem
      if (!insert.second && insert.first->second != ignoreAction) {
        B2FATAL("MCParticle Relation " << name << " already registered with different ignore action.");
      }
    }

saveG4TrackInfo()

int saveG4TrackInfo	(	int	trackID,
		int	PDG,
		float	Mass,
		float	Energy,
		float	vtx[3],
		float	mom[3]
	)

Save saveG4TrackInfo into datastore.

Definition at line 136 of file SensitiveDetector.cc.

    {
      //Get the datastore arrays
      StoreArray<HE3G4TrackInfo> HE3G4TrackInfos;
 
      HE3G4TrackInfos.appendNew(HE3G4TrackInfo(trackID, PDG, Mass, Energy, vtx, mom));
 
      int simhitNumber = HE3G4TrackInfos.getEntries() - 1;
 
      return (simhitNumber);
    }//saveG4TrackInfo

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.

{ s_active = activeStatus; }

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 51 of file SensitiveDetector.cc.

    {
      //Get Track information
      const G4Track& track    = *step->GetTrack();
      const int trackID       = track.GetTrackID();
      const double depEnergy  = step->GetTotalEnergyDeposit() * CLHEP::MeV;
      const double nielEnergy = step->GetNonIonizingEnergyDeposit() * CLHEP::MeV;
      const G4ThreeVector G4tkPos = step->GetTrack()->GetPosition();
      float tkPos[3];
      tkPos[0] = G4tkPos.x() * CLHEP::cm;
      tkPos[1] = G4tkPos.y() * CLHEP::cm;
      tkPos[2] = G4tkPos.z() * CLHEP::cm;
      const G4ThreeVector G4tkMom = step->GetTrack()->GetMomentum();
      float tkMom[3];
      tkMom[0] = G4tkMom.x() * CLHEP::MeV;
      tkMom[1] = G4tkMom.y() * CLHEP::MeV;
      tkMom[2] = G4tkMom.z() * CLHEP::MeV;
      const G4ThreeVector G4tkMomDir = step->GetTrack()->GetMomentumDirection();
      float tkMomDir[3];
      tkMomDir[0] = G4tkMomDir.x() * CLHEP::MeV;
      tkMomDir[1] = G4tkMomDir.y() * CLHEP::MeV;
      tkMomDir[2] = G4tkMomDir.z() * CLHEP::MeV;
      const int tkPDG = step->GetTrack()->GetDefinition()->GetPDGEncoding();
      const double tkKEnergy = step->GetTrack()->GetKineticEnergy();
      const int detNb = step->GetTrack()->GetVolume()->GetCopyNo();
      const double GlTime = step->GetPreStepPoint()->GetGlobalTime();
      //Ignore everything below 1eV
      //if (depEnergy < CLHEP::eV) return false;
 
      //Get the datastore arrays
      StoreArray<MCParticle>  mcParticles;
      StoreArray<He3tubeSimHit> simHits;
      RelationArray relMCSimHit(mcParticles, simHits);
 
      //find out if the process that created the particle was a neutron process
      bool neuProc = false;
      G4String CPName;
      if (step->GetTrack()->GetCreatorProcess() != 0) {
        const  G4VProcess* creator = step->GetTrack()->GetCreatorProcess();
        CPName = creator->GetProcessName();
        if (G4StrUtil::contains(CPName, "Neutron")) neuProc = true;
      }
 
      //set TrackID
      m_trackID = track.GetTrackID();
      //Save Hit if track leaves volume or is killed
      if (track.GetNextVolume() != track.GetVolume() || track.GetTrackStatus() >= fStopAndKill) {
        auto& mcparticle = Simulation::TrackInfo::getInfo(track);
        int PDG = mcparticle.getPDG();
        float Mass = mcparticle.getMass();
        float Energy = mcparticle.getEnergy();
        float vtx[3];
        vtx[0] = mcparticle.getProductionVertex().X();
        vtx[1] = mcparticle.getProductionVertex().Y();
        vtx[2] = mcparticle.getProductionVertex().Z();
        float mom[3];
        mom[0] = mcparticle.getMomentum().X();
        mom[1] = mcparticle.getMomentum().Y();
        mom[2] = mcparticle.getMomentum().Z();
        saveG4TrackInfo(m_trackID, PDG, Mass, Energy, vtx, mom);
        //Reset TrackID
        m_trackID = 0;
      }
 
      StoreArray<He3tubeSimHit> He3tubeHits;
      He3tubeSimHit* hit = He3tubeHits.appendNew(
                             depEnergy,
                             nielEnergy,
                             tkPDG,
                             tkKEnergy,
                             detNb,
                             GlTime,
                             tkPos,
                             tkMom,
                             tkMomDir,
                             neuProc
                           );
 
      //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(trackID, hit->getArrayIndex(), 1.0);
 
      return true;
    }

Member Data Documentation

m_subdetector

Const::EDetector m_subdetector

privateinherited

Subdetector the class belongs to.

Definition at line 91 of file SensitiveDetectorBase.h.

m_trackID

int m_trackID

protected

track id

Definition at line 44 of file SensitiveDetector.h.

s_active

bool s_active

staticprivateinherited

Static bool which indicates wether recording of hits is enabled.

Definition at line 89 of file SensitiveDetectorBase.h.

s_mcRelations

map< string, RelationArray::EConsolidationAction > s_mcRelations

staticprivateinherited

Static set holding all relations which have to be updated at the end of the Event.

Definition at line 87 of file SensitiveDetectorBase.h.

---

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

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