Class providing SimHits. More...

#include <SensitivePMT.h>

Inheritance diagram for SensitivePMT:

Public Member Functions
	SensitivePMT ()
	Constructor.

bool	step (G4Step aStep, G4TouchableHistory ) override
	Process each step, fill TOPSimHits and TOPSimPhotons.

void	setPMTReplicaDepth (int depth)
	Sets replica depth of PMT volume.

void	setModuleReplicaDepth (int depth)
	Sets replica depth of module volume.

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.

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
int	m_pmtReplicaDepth = 2
	replica depth of PMT volume

int	m_moduleReplicaDepth = 5
	replica depth of module volume

TOPGeometryPar *	m_topgp = TOPGeometryPar::Instance()
	geometry parameters

StoreArray< MCParticle >	m_mcParticles
	collection of MC particles

StoreArray< TOPSimHit >	m_simHits
	collection of simulated hits

StoreArray< TOPSimPhoton >	m_simPhotons
	collection of simulated photons

RelationArray	m_relParticleHit {m_mcParticles, m_simHits}
	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 SimHits.

Definition at line 30 of file SensitivePMT.h.

Constructor & Destructor Documentation

◆ SensitivePMT()

SensitivePMT ( )

Constructor.

Definition at line 34 of file SensitivePMT.cc.

                              :
      Simulation::SensitiveDetectorBase("TOP", Const::TOP)
    {
 
      m_simHits.registerInDataStore();
      m_mcParticles.registerRelationTo(m_simHits);
 
      m_simPhotons.registerInDataStore(DataStore::c_DontWriteOut);
      m_simHits.registerRelationTo(m_simPhotons, DataStore::c_Event,
                                   DataStore::c_DontWriteOut);
 
      registerMCParticleRelation(m_relParticleHit);
 
    }

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.

42{ return s_mcRelations; }

Belle2::Simulation::SensitiveDetectorBase::s_mcRelations

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.

Definition: SensitiveDetectorBase.h:87

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

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

50{ s_active = activeStatus; }

◆ setModuleReplicaDepth()

void setModuleReplicaDepth ( int depth )

inline

Sets replica depth of module volume.

Parameters

depth replica depth

Definition at line 56 of file SensitivePMT.h.

56{m_moduleReplicaDepth = depth;}

Belle2::TOP::SensitivePMT::m_moduleReplicaDepth

int m_moduleReplicaDepth

replica depth of module volume

Definition: SensitivePMT.h:61

◆ setPMTReplicaDepth()

void setPMTReplicaDepth ( int depth )

inline

Sets replica depth of PMT volume.

Parameters

depth replica depth

Definition at line 50 of file SensitivePMT.h.

50{m_pmtReplicaDepth = depth;}

Belle2::TOP::SensitivePMT::m_pmtReplicaDepth

int m_pmtReplicaDepth

replica depth of PMT volume

Definition: SensitivePMT.h:60

◆ step()

G4bool step	(	G4Step *	aStep,
		G4TouchableHistory *
	)

overridevirtual

Process each step, fill TOPSimHits and TOPSimPhotons.

Parameters

aStep Current Geant4 step in the sensitive medium.

Returns: true if optical photon detected.

Implements SensitiveDetectorBase.

Definition at line 50 of file SensitivePMT.cc.

    {
      // photon track
      G4Track& photon  = *aStep->GetTrack();
 
      // check if the track is an optical photon
      if (photon.GetDefinition() != G4OpticalPhoton::OpticalPhotonDefinition()) return false;
 
      // photon energy in [eV]
      double energy = photon.GetKineticEnergy() * Unit::MeV / Unit::eV;
 
      // pmt and module ID
      int pmtID = photon.GetTouchableHandle()->GetReplicaNumber(m_pmtReplicaDepth);
      int moduleID = photon.GetTouchableHandle()->GetReplicaNumber(m_moduleReplicaDepth);
 
      // hit position in local frame, converted to Basf units
      G4ThreeVector localPosition = photon.GetTouchableHandle()->GetHistory()->GetTopTransform().TransformPoint(photon.GetPosition());
      double xLocal = localPosition.x() * Unit::mm;
      double yLocal = localPosition.y() * Unit::mm;
 
      // apply quantum efficiency if not yet done
      bool applyQE = true;
      double fraction = 1;
      auto* info = dynamic_cast<Simulation::TrackInfo*>(photon.GetUserInformation());
      if (info) {
        applyQE = info->getStatus() < 3;
        fraction = info->getFraction();
      }
      if (applyQE) {
        double qeffi = m_topgp->getPMTEfficiency(energy, moduleID, pmtID, xLocal, yLocal);
        if (qeffi == 0 or gRandom->Uniform() * fraction > qeffi) {
          photon.SetTrackStatus(fStopAndKill);
          return false;
        }
        if (info) {
          info->setStatus(3);
          info->setFraction(qeffi);
        }
      }
 
      // photon at detection
      const G4ThreeVector& g_detPoint = photon.GetPosition();
      const G4ThreeVector& g_detMomDir = photon.GetMomentumDirection();
      ROOT::Math::XYZPoint detPoint(g_detPoint.x(), g_detPoint.y(), g_detPoint.z());
      ROOT::Math::XYZVector detMomDir(g_detMomDir.x(), g_detMomDir.y(), g_detMomDir.z());
      double detTime = photon.GetGlobalTime();
      double length = photon.GetTrackLength();
 
      // photon at emission
      const G4ThreeVector& g_emiPoint = photon.GetVertexPosition();
      const G4ThreeVector& g_emiMomDir = photon.GetVertexMomentumDirection();
      ROOT::Math::XYZPoint emiPoint(g_emiPoint.x(), g_emiPoint.y(), g_emiPoint.z());
      ROOT::Math::XYZVector emiMomDir(g_emiMomDir.x(), g_emiMomDir.y(), g_emiMomDir.z());
      double emiTime = photon.GetGlobalTime() - photon.GetLocalTime();
 
      // convert to basf2 units
      emiPoint = emiPoint * Unit::mm;
      detPoint = detPoint * Unit::mm;
      length = length * Unit::mm;
 
      // write to store arrays; add relations
 
      auto* simHit = m_simHits.appendNew(moduleID, pmtID, xLocal, yLocal,
                                         detTime, energy);
 
      int parentID = photon.GetParentID();
      if (parentID == 0) parentID = photon.GetTrackID();
      m_relParticleHit.add(parentID, simHit->getArrayIndex());
 
      const auto* geo = m_topgp->getGeometry();
      if (geo->isModuleIDValid(moduleID)) {
        // transform to local frame
        const auto& module = geo->getModule(moduleID);
        emiPoint = module.pointToLocal(emiPoint);
        detPoint = module.pointToLocal(detPoint);
        emiMomDir = module.momentumToLocal(emiMomDir);
        detMomDir = module.momentumToLocal(detMomDir);
      } else {
        B2ERROR("TOP::SensitivePMT: undefined module ID."
                << LogVar("moduleID", moduleID));
      }
      auto* simPhoton = m_simPhotons.appendNew(moduleID,
                                               emiPoint, emiMomDir, emiTime,
                                               detPoint, detMomDir, detTime,
                                               length, energy);
 
      simHit->addRelationTo(simPhoton);
 
      // kill photon after detection
      photon.SetTrackStatus(fStopAndKill);
 
      return true;
    }

Member Data Documentation

◆ m_mcParticles

StoreArray<MCParticle> m_mcParticles

private

collection of MC particles

Definition at line 64 of file SensitivePMT.h.

◆ m_moduleReplicaDepth

int m_moduleReplicaDepth = 5

private

replica depth of module volume

Definition at line 61 of file SensitivePMT.h.

◆ m_pmtReplicaDepth

int m_pmtReplicaDepth = 2

private

replica depth of PMT volume

Definition at line 60 of file SensitivePMT.h.

◆ m_relParticleHit

RelationArray m_relParticleHit {m_mcParticles, m_simHits}

private

relations

Definition at line 67 of file SensitivePMT.h.

◆ m_simHits

StoreArray<TOPSimHit> m_simHits

private

collection of simulated hits

Definition at line 65 of file SensitivePMT.h.

◆ m_simPhotons

StoreArray<TOPSimPhoton> m_simPhotons

private

collection of simulated photons

Definition at line 66 of file SensitivePMT.h.

◆ m_subdetector

Const::EDetector m_subdetector

privateinherited

Subdetector the class belongs to.

Definition at line 91 of file SensitiveDetectorBase.h.

◆ m_topgp

TOPGeometryPar* m_topgp = TOPGeometryPar::Instance()

private

geometry parameters

Definition at line 62 of file SensitivePMT.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:

top/simulation/include/SensitivePMT.h
top/simulation/src/SensitivePMT.cc

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ SensitivePMT()

Member Function Documentation

◆ getMCParticleRelations()

◆ ProcessHits()

◆ registerMCParticleRelation() [1/2]

◆ registerMCParticleRelation() [2/2]

◆ setActive()

◆ setModuleReplicaDepth()

◆ setPMTReplicaDepth()

◆ step()

Member Data Documentation

◆ m_mcParticles

◆ m_moduleReplicaDepth

◆ m_pmtReplicaDepth

◆ m_relParticleHit

◆ m_simHits

◆ m_simPhotons

◆ m_subdetector

◆ m_topgp

◆ s_active

◆ s_mcRelations