SensitiveDetector Class Reference

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

#include <SensitiveDetector.h>

Inheritance diagram for SensitiveDetector:

Public Member Functions
	SensitiveDetector ()
	Constructor.

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.

Private Member Functions
bool	finishTrack ()
	finish a track
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
G4EmSaturation *	m_saturationEngine
	needed to call Birk's law
StoreArray< MCParticle >	m_mcParticles
	store array of the MCParticles
StoreArray< CLAWSSimHit >	m_simHits
	store array of the SimHits
RelationArray	m_relMCSimHit {m_mcParticles, m_simHits}
	relation array of the MCParticle -> SimHit relation
std::stack< SensorTraversal >	m_tracks
	Stack of tracks to keep track of particles.
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 CLAWS detector.

Definition at line 29 of file SensitiveDetector.h.

Constructor & Destructor Documentation

SensitiveDetector()

SensitiveDetector

(

)

Constructor.

Definition at line 31 of file SensitiveDetector.cc.

                                        :
      Simulation::SensitiveDetectorBase("CLAWSSensitiveDetector", Const::invalidDetector)
    {
      //Register all collections we want to modify and require those we want to use
      m_mcParticles.registerInDataStore();
      m_simHits.registerInDataStore();
      m_relMCSimHit.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(m_relMCSimHit, RelationArray::c_negativeWeight);
 
#if G4VERSION_NUMBER < 1010
      m_saturationEngine = new G4EmSaturation();
#else
      m_saturationEngine = new G4EmSaturation(1); // verbose level
#endif
    }

Member Function Documentation

finishTrack()

bool finishTrack ( )

private

finish a track

Definition at line 122 of file SensitiveDetector.cc.

    {
      SensorTraversal& traversal = m_tracks.top();
      // ignore everything below 1eV
      bool save = traversal.getDepEnergy() > Unit::eV;
      if (save) {
        auto momEntry = vecToFloat(traversal.getEntryMomentum());
        auto posEntry = vecToFloat(traversal.getEntryPosition());
        auto posExit = vecToFloat(traversal.getExitPosition());
        int hitIndex = m_simHits.getEntries();
        m_simHits.appendNew(
          traversal.getLadderID(), traversal.getSensorID(),
          traversal.getPDGCode(), traversal.getEntryTime(),
          traversal.getDepEnergy(), traversal.getVisibleEnergy(),
          traversal.getLength(), posEntry.data(), posExit.data(),
          momEntry.data()
        );
        m_relMCSimHit.add(traversal.getTrackID(), hitIndex, traversal.getDepEnergy());
      }
      //No we just need to take care of the stack of traversals
      if (m_tracks.size() == 1) {
        //reuse traversal to keep memory if this is the first one
        traversal.reset();
      } else {
        //this should only happen if the parent track got suspended. As this
        //rarely happens in PXD we do not care for re-usability here
        m_tracks.pop();
      }
      return save;
    }

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.");
      }
    }

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

    {
      //Get scintilator ladder and sensor number
      const G4TouchableHistory* touchable = dynamic_cast<const G4TouchableHistory*>(step->GetPreStepPoint()->GetTouchable());
      int ladderID = touchable->GetVolume(2)->GetCopyNo();
      int sensorID = touchable->GetVolume(1)->GetCopyNo();
 
      //Get Track information
      const G4Track& track = *step->GetTrack();
      const int trackID = track.GetTrackID();
      const int pdgCode = step->GetTrack()->GetDefinition()->GetPDGEncoding();
      // deposited Energy in Geant4 Units
      double depEnergy  = step->GetTotalEnergyDeposit();
      // get visible energy deposition
      double visibleEnergy = m_saturationEngine->VisibleEnergyDeposition(
                               track.GetDefinition(),
                               track.GetMaterialCutsCouple(),
                               step->GetStepLength(),
                               depEnergy, 0.
                             );
      // convert into Belle2 Units
      depEnergy *= Unit::GeV / CLHEP::GeV;
      visibleEnergy *= Unit::GeV / CLHEP::GeV;
 
      // get pre and post step point
      const G4StepPoint& preStep = *step->GetPreStepPoint();
      const G4StepPoint& postStep = *step->GetPostStepPoint();
 
      // check if this is the same sensor traversal, otherwise add one to the stack
      if (m_tracks.empty() || (!m_tracks.top().check(trackID, ladderID, sensorID))) {
        m_tracks.push(SensorTraversal());
      }
      // get the top of the stack
      SensorTraversal& traversal = m_tracks.top();
 
      //If new track, remember values
      if (traversal.getTrackID() == 0) {
        bool isPrimary = Simulation::TrackInfo::getInfo(track).hasStatus(MCParticle::c_PrimaryParticle);
        //Add start position
        const G4ThreeVector preStepPos = preStep.GetPosition() / CLHEP::mm * Unit::mm;
        const G4ThreeVector preStepMom = preStep.GetMomentum() / CLHEP::MeV * Unit::MeV;
        const double time = preStep.GetGlobalTime() / CLHEP::ns * Unit::ns;
        traversal.setInitial(trackID, ladderID, sensorID, pdgCode, isPrimary, preStepPos, preStepMom, time);
        //Remember if the track came from the outside
        if (preStep.GetStepStatus() == fGeomBoundary) traversal.hasEntered();
      }
 
      //Add current step
      const G4ThreeVector postStepPos = postStep.GetPosition() / CLHEP::mm * Unit::mm;
      const double length = step->GetStepLength() / CLHEP::cm * Unit::cm;
      traversal.add(postStepPos, depEnergy, visibleEnergy, length);
 
      //check if we are leaving the volume
      bool isLeaving = (postStep.GetStepStatus() == fGeomBoundary);
      if (isLeaving) traversal.hasLeft();
 
      //if we are leaving or the track is stopped, finish it
      if (isLeaving || track.GetTrackStatus() >= fStopAndKill) {
        bool contained = traversal.isContained();
        bool saved = finishTrack();
        //we mark all particles as important which created a hit and entered or left the volume
        if (saved && !contained) {
          Simulation::TrackInfo::getInfo(track).setIgnore(false);
        }
        return saved;
      }
      // Track not finished, return false right now
      return false;
    }

Member Data Documentation

m_mcParticles

StoreArray<MCParticle> m_mcParticles

private

store array of the MCParticles

Definition at line 47 of file SensitiveDetector.h.

m_relMCSimHit

RelationArray m_relMCSimHit {m_mcParticles, m_simHits}

private

relation array of the MCParticle -> SimHit relation

Definition at line 51 of file SensitiveDetector.h.

m_saturationEngine

G4EmSaturation* m_saturationEngine

private

needed to call Birk's law

Definition at line 44 of file SensitiveDetector.h.

m_simHits

StoreArray<CLAWSSimHit> m_simHits

private

store array of the SimHits

Definition at line 49 of file SensitiveDetector.h.

m_subdetector

Const::EDetector m_subdetector

privateinherited

Subdetector the class belongs to.

Definition at line 91 of file SensitiveDetectorBase.h.

m_tracks

std::stack<SensorTraversal> m_tracks

private

Stack of tracks to keep track of particles.

Definition at line 54 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/claws/simulation/include/SensitiveDetector.h
• beast/claws/simulation/src/SensitiveDetector.cc