SensitiveBar Class Reference

Class providing information on MCParticles hitting the bars. More...

#include <SensitiveBar.h>

Inheritance diagram for SensitiveBar:

Collaboration diagram for SensitiveBar:

Public Member Functions
	SensitiveBar ()
	Constructor.
bool	step (G4Step *aStep, G4TouchableHistory *) override
	Process each step and fill TOPBarHits. More...
void	setReplicaDepth (int depth)
	Sets replica depth of module volume. More...

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...

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	m_replicaDepth = 2
	replica depth of module volume
TOPGeometryPar *	m_topgp = TOPGeometryPar::Instance()
	geometry parameters
std::vector< int >	m_trackIDs
	track ID's
StoreArray< MCParticle >	m_mcParticles
	collection of MC particles
StoreArray< TOPBarHit >	m_barHits
	collection of entrance-to-bar hits
RelationArray	m_relParticleHit {m_mcParticles, m_barHits}
	relations
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

Class providing information on MCParticles hitting the bars.

Applies also quantum efficiency to reduce the number of propagating photons.

Definition at line 41 of file SensitiveBar.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 98 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 70 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 24 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 54 of file SensitiveDetectorBase.h.

setReplicaDepth()

void setReplicaDepth ( int  depth )

inline

Sets replica depth of module volume.

Parameters

depth

replica depth

Definition at line 61 of file SensitiveBar.h.

{m_mcParticles, m_barHits}; 

step()

bool step ( G4Step *  aStep, G4TouchableHistory *    )

overridevirtual

Process each step and fill TOPBarHits.

Parameters

aStep

Current Geant4 step in the sensitive medium.

Returns

true when particle that is not an optical photon enters the bar

Implements SensitiveDetectorBase.

Definition at line 55 of file SensitiveBar.cc.

    {
 
      // get track and particle definition
 
      G4Track* aTrack = aStep->GetTrack();
      G4ParticleDefinition* particle = aTrack->GetDefinition();
 
      // if optical photon, apply QE and return false
 
      if (particle == G4OpticalPhoton::OpticalPhotonDefinition()) {
        auto* info = dynamic_cast<Simulation::TrackInfo*>(aTrack->GetUserInformation());
        if (!info) return false;
        if (info->getStatus() < 2) {
          double energy = aTrack->GetKineticEnergy() * Unit::MeV / Unit::eV;
          double qeffi = m_topgp->getPMTEfficiencyEnvelope(energy);
          double fraction = info->getFraction();
          if (qeffi == 0 or gRandom->Uniform() * fraction > qeffi) {
            aTrack->SetTrackStatus(fStopAndKill);
            return false;
          }
          info->setStatus(2);
          info->setFraction(qeffi);
        }
        return false;
      }
 
      // continue for other particles, if they enter the volume for the first time
 
      G4StepPoint* PrePosition =  aStep->GetPreStepPoint();
      if (PrePosition->GetStepStatus() != fGeomBoundary) return false; // not on boundary
 
      if (m_barHits.getEntries() == 0) {
        for (auto& trackID : m_trackIDs) trackID = -1; // reset on new event
      }
 
      int moduleID = PrePosition->GetTouchableHandle()->GetReplicaNumber(m_replicaDepth);
      const auto* geo = m_topgp->getGeometry();
      if (!geo->isModuleIDValid(moduleID)) {
        B2ERROR("TOP::SensitiveBar: undefined module ID."
                << LogVar("moduleID", moduleID));
        return false;
      }
 
      int trackID = aTrack->GetTrackID();
      if (trackID == m_trackIDs[moduleID - 1]) return false; // not first time on boundary
      m_trackIDs[moduleID - 1] = trackID;
 
      // particle other than optical photon entered the volume for the first time
      // convert to basf2 units and write-out the hit
 
      G4ThreeVector worldPosition = PrePosition->GetPosition();
      double tracklength = aTrack->GetTrackLength() - aStep->GetStepLength();
      double globalTime = PrePosition->GetGlobalTime();
      G4ThreeVector momentum = PrePosition->GetMomentum();
 
      TVector3 TPosition(worldPosition.x(), worldPosition.y(), worldPosition.z());
      TVector3 TMomentum(momentum.x(), momentum.y(), momentum.z());
      TVector3 TOrigin(aTrack->GetVertexPosition().x(),
                       aTrack->GetVertexPosition().y(),
                       aTrack->GetVertexPosition().z());
 
      // convert to Basf2 units
      TPosition = TPosition * Unit::mm;
      TMomentum = TMomentum  * Unit::MeV;
      TOrigin = TOrigin * Unit::mm;
      tracklength = tracklength * Unit::mm;
 
      const auto& module = geo->getModule(moduleID);
      TVector3 locPosition = module.pointToLocal(TPosition);
      TVector3 locMomentum = module.momentumToLocal(TMomentum);
      double theta = locMomentum.Theta();
      double phi = locMomentum.Phi();
 
      int PDG = (int)(particle->GetPDGEncoding());
 
      // write hit to datastore
      auto* hit = m_barHits.appendNew(moduleID, PDG, TOrigin, TPosition, TMomentum,
                                      globalTime, tracklength, locPosition,
                                      theta, phi);
 
      // set the relation
      m_relParticleHit.add(trackID, hit->getArrayIndex());
 
      return true;
    }

---

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

• top/simulation/include/SensitiveBar.h
• top/simulation/src/SensitiveBar.cc