Class for ECL Sensitive Detector. More...

#include <SensitiveDetector.h>

Inheritance diagram for SensitiveDetector:

Public Member Functions
	SensitiveDetector (G4String, G4double, G4double)
	Constructor.

	~SensitiveDetector ()
	Destructor.

void	Initialize (G4HCofThisEvent *HCTE) override
	Register ECL hits collection into G4HCofThisEvent.

bool	step (G4Step aStep, G4TouchableHistory history) override
	Process each step and calculate variables defined in ECLHit.

void	EndOfEvent (G4HCofThisEvent *eventHC) override
	Do what you want to do at the end of each event.

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
double	GetHadronIntensityFromDEDX (double)
	Evaluates hadron scintillation component emission function.

int	saveSimHit (G4int, G4int, G4int, G4double, G4double, const G4ThreeVector &, const G4ThreeVector &, double)
	Create ECLSimHit and ECLHit and relations from MCParticle and put them in datastore.

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
TGraph *	m_HadronEmissionFunction = nullptr
	Graph for hadron scintillation component emission function.

G4EmCalculator	m_emCal
	Used to get dE/dx for pulse shape simulations.

StoreArray< ECLSimHit >	m_eclSimHits
	ECLSimHit array.

StoreArray< ECLHit >	m_eclHits
	ECLHit array.

StoreArray< MCParticle >	m_mcParticles
	MCParticle array.

RelationArray	m_eclSimHitRel
	MCParticle to ECLSimHit relation array.

RelationArray	m_eclHitRel
	MCParticle to ECLHit relation array.

int	m_trackID
	current track id

double	m_WeightedTime
	average track time weighted by energy deposition

double	m_energyDeposit
	total energy deposited in a volume by a track

double	m_hadronenergyDeposit
	energy deposited resulting in hadronic scint component

G4ThreeVector	m_WeightedPos
	average track position weighted by energy deposition

G4ThreeVector	m_momentum
	initial momentum of track before energy deposition inside sensitive volume

DBObjPtr< ECLHadronComponentEmissionFunction >	m_ECLHadronComponentEmissionFunction
	Hadron Component Emission Function.

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 for ECL Sensitive Detector.

Definition at line 38 of file SensitiveDetector.h.

Constructor & Destructor Documentation

◆ ~SensitiveDetector()

~SensitiveDetector ( )

Destructor.

Definition at line 51 of file SensitiveDetector.cc.

52{

53}

Member Function Documentation

◆ EndOfEvent()

void EndOfEvent ( G4HCofThisEvent * eventHC )

override

Do what you want to do at the end of each event.

Definition at line 145 of file SensitiveDetector.cc.

{
  struct hit_t { double e, t; };
  map<int, hit_t> a;
 
  struct thit_t { int tid, hid; };
  vector<thit_t> tr;
 
  ECLGeometryPar* eclp = ECLGeometryPar::Instance();
 
  for (const ECLSimHit& t : m_eclSimHits) {
    double tof = t.getFlightTime();
    if (tof >= 8000.0 || tof < -8000.0) continue;
    int TimeIndex = (tof + 8000.0) * (1. / 100);
    int cellId = t.getCellId() - 1;
    int key = cellId * 160 + TimeIndex;
    double edep = t.getEnergyDep();
    double tsen = tof + eclp->time2sensor(cellId, t.getPosition()); // flight time to diode sensor
 
    hit_t& h = a[key];
 
    int trkid = t.getTrackId();
    tr.push_back({trkid, key});
 
    double old_edep = h.e, old_tsen = h.t;
    double new_edep = old_edep + edep;
 
    h.e = new_edep;
    h.t = (old_edep * old_tsen + edep * tsen) / new_edep;
  }
 
  int hitNum = m_eclHits.getEntries();
  //  assert(hitNum == 0);
  for (pair<int, hit_t> t : a) {
    int key = t.first, cellId = key / 160;
    for (const thit_t& s : tr)
      if (s.hid == key) m_eclHitRel.add(s.tid, hitNum);
    const hit_t& h = t.second;
    m_eclHits.appendNew(cellId + 1, h.e, h.t); hitNum++;
  }
}

◆ GetHadronIntensityFromDEDX()

double GetHadronIntensityFromDEDX ( double x )

private

Evaluates hadron scintillation component emission function.

Definition at line 61 of file SensitiveDetector.cc.

{
  if (x < 2) return 0;
  if (x > 232) return m_HadronEmissionFunction->Eval(232);
  return m_HadronEmissionFunction->Eval(x);
}

◆ 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

◆ Initialize()

void Initialize ( G4HCofThisEvent * HCTE )

override

Register ECL hits collection into G4HCofThisEvent.

Definition at line 55 of file SensitiveDetector.cc.

56{

57}

◆ 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); }

Belle2::Simulation::SensitiveDetectorBase::registerMCParticleRelation

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

Register an relation involving MCParticles.

Definition: SensitiveDetectorBase.cc:22

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

◆ saveSimHit()

int saveSimHit	(	G4int	cellId,
		G4int	trackID,
		G4int	pid,
		G4double	tof,
		G4double	edep,
		const G4ThreeVector &	mom,
		const G4ThreeVector &	pos,
		double	Hadronedep
	)

private

Create ECLSimHit and ECLHit and relations from MCParticle and put them in datastore.

Definition at line 187 of file SensitiveDetector.cc.

{
  int simhitNumber = m_eclSimHits.getEntries();
  m_eclSimHitRel.add(trackID, simhitNumber);
  tof  *= 1 / CLHEP::ns;
  edep *= 1 / CLHEP::GeV;
  m_eclSimHits.appendNew(cellId + 1, trackID, pid, tof, edep, mom * (1 / CLHEP::GeV), pos * (1 / CLHEP::cm), Hadronedep);
  return simhitNumber;
}

◆ 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; }

◆ step()

bool step	(	G4Step *	aStep,
		G4TouchableHistory *	history
	)

overridevirtual

Process each step and calculate variables defined in ECLHit.

Implements SensitiveDetectorBase.

Definition at line 84 of file SensitiveDetector.cc.

{
  //
  double preKineticEnergy = aStep->GetPreStepPoint()->GetKineticEnergy();
  double postKineticEnergy = aStep->GetPostStepPoint()->GetKineticEnergy();
  double avgKineticEnergy = 0.5 * (preKineticEnergy + postKineticEnergy);
  const G4ParticleDefinition* StepParticleDefinition = aStep->GetTrack()->GetParticleDefinition();
  G4Material* StepMaterial = aStep->GetTrack()->GetMaterial();
  const double CsIDensity = 4.51; //gcm^-3
  double ELE_DEDX = m_emCal.ComputeDEDX(avgKineticEnergy, StepParticleDefinition, "eIoni",
                                        StepMaterial) / CLHEP::MeV * CLHEP::cm / (CsIDensity);
  double MU_DEDX = m_emCal.ComputeDEDX(avgKineticEnergy, StepParticleDefinition, "muIoni",
                                       StepMaterial) / CLHEP::MeV * CLHEP::cm / (CsIDensity);
  double HAD_DEDX = m_emCal.ComputeDEDX(avgKineticEnergy, StepParticleDefinition, "hIoni",
                                        StepMaterial) / CLHEP::MeV * CLHEP::cm / (CsIDensity);
  double ION_DEDX = m_emCal.ComputeDEDX(avgKineticEnergy, StepParticleDefinition, "ionIoni",
                                        StepMaterial) / CLHEP::MeV * CLHEP::cm / (CsIDensity);
  G4double DEDX_val = ELE_DEDX + MU_DEDX + HAD_DEDX + ION_DEDX; //Ionization dE/dx for any particle type
 
  G4double edep = aStep->GetTotalEnergyDeposit();
  double LightOutputCorrection = GetCsITlScintillationEfficiency(DEDX_val);
  edep *= LightOutputCorrection;
  const G4StepPoint& s0 = *aStep->GetPreStepPoint();
  const G4StepPoint& s1 = *aStep->GetPostStepPoint();
  const G4Track&  track = *aStep->GetTrack();
 
  if (m_trackID != track.GetTrackID()) { //TrackID changed, store track informations
    m_trackID = track.GetTrackID();
    m_momentum = s0.GetMomentum(); // Get momentum
    //Reset track parameters
    m_energyDeposit = 0;
    m_WeightedTime = 0;
    m_WeightedPos.set(0, 0, 0);
    m_hadronenergyDeposit = 0;
  }
  //Update energy deposit
  G4double hedep = 0.5 * edep; // half of energy deposition -- for averaging purpose
  m_energyDeposit += edep;
  m_WeightedTime  += (s0.GetGlobalTime() + s1.GetGlobalTime()) * hedep;
  m_WeightedPos   += (s0.GetPosition()   + s1.GetPosition()) * hedep;
  //
  //Calculate hadronic scintillation component intensity from dEdx
  m_hadronenergyDeposit += (edep / CLHEP::GeV) * GetHadronIntensityFromDEDX(DEDX_val);
  //
  //Save Hit if track leaves volume or is killed
  if (track.GetNextVolume() != track.GetVolume() || track.GetTrackStatus() >= fStopAndKill) {
    if (m_energyDeposit > 0.0) {
      ECLGeometryPar* eclp = ECLGeometryPar::Instance();
      G4int cellID = eclp->TouchableToCellID(s0.GetTouchable());
      G4double dTotalEnergy = 1 / m_energyDeposit;
      m_WeightedTime *= dTotalEnergy;
      m_WeightedPos  *= dTotalEnergy;
      int pdgCode = track.GetDefinition()->GetPDGEncoding();
      saveSimHit(cellID, m_trackID, pdgCode, m_WeightedTime, m_energyDeposit, m_momentum, m_WeightedPos, m_hadronenergyDeposit);
    }
    //Reset TrackID
    m_trackID = 0;
  }
  return true;
}

Member Data Documentation

◆ m_ECLHadronComponentEmissionFunction

DBObjPtr<ECLHadronComponentEmissionFunction> m_ECLHadronComponentEmissionFunction

private

Hadron Component Emission Function.

Definition at line 76 of file SensitiveDetector.h.

◆ m_eclHitRel

RelationArray m_eclHitRel

private

MCParticle to ECLHit relation array.

Definition at line 69 of file SensitiveDetector.h.

◆ m_eclHits

StoreArray<ECLHit> m_eclHits

private

ECLHit array.

Definition at line 66 of file SensitiveDetector.h.

◆ m_eclSimHitRel

RelationArray m_eclSimHitRel

private

MCParticle to ECLSimHit relation array.

Definition at line 68 of file SensitiveDetector.h.

◆ m_eclSimHits

StoreArray<ECLSimHit> m_eclSimHits

private

ECLSimHit array.

Definition at line 65 of file SensitiveDetector.h.

◆ m_emCal

G4EmCalculator m_emCal

private

Used to get dE/dx for pulse shape simulations.

Definition at line 63 of file SensitiveDetector.h.

◆ m_energyDeposit

double m_energyDeposit

private

total energy deposited in a volume by a track

Definition at line 72 of file SensitiveDetector.h.

◆ m_HadronEmissionFunction

TGraph* m_HadronEmissionFunction = nullptr

private

Graph for hadron scintillation component emission function.

Definition at line 56 of file SensitiveDetector.h.

◆ m_hadronenergyDeposit

double m_hadronenergyDeposit

private

energy deposited resulting in hadronic scint component

Definition at line 73 of file SensitiveDetector.h.

◆ m_mcParticles

StoreArray<MCParticle> m_mcParticles

private

MCParticle array.

Definition at line 67 of file SensitiveDetector.h.

◆ m_momentum

G4ThreeVector m_momentum

private

initial momentum of track before energy deposition inside sensitive volume

Definition at line 75 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_trackID

int m_trackID

private

current track id

Definition at line 70 of file SensitiveDetector.h.

◆ m_WeightedPos

G4ThreeVector m_WeightedPos

private

average track position weighted by energy deposition

Definition at line 74 of file SensitiveDetector.h.

◆ m_WeightedTime

double m_WeightedTime

private

average track time weighted by energy deposition

Definition at line 71 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:

ecl/simulation/include/SensitiveDetector.h
ecl/simulation/src/SensitiveDetector.cc

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ~SensitiveDetector()

Member Function Documentation

◆ EndOfEvent()

◆ GetHadronIntensityFromDEDX()

◆ getMCParticleRelations()

◆ Initialize()

◆ ProcessHits()

◆ registerMCParticleRelation() [1/2]

◆ registerMCParticleRelation() [2/2]

◆ saveSimHit()

◆ setActive()

◆ step()

Member Data Documentation

◆ m_ECLHadronComponentEmissionFunction

◆ m_eclHitRel

◆ m_eclHits

◆ m_eclSimHitRel

◆ m_eclSimHits

◆ m_emCal

◆ m_energyDeposit

◆ m_HadronEmissionFunction

◆ m_hadronenergyDeposit

◆ m_mcParticles

◆ m_momentum

◆ m_subdetector

◆ m_trackID

◆ m_WeightedPos

◆ m_WeightedTime

◆ s_active

◆ s_mcRelations