Class for ECL Sensitive Detector for neutron background study. More...

#include <SensitiveDetector.h>

Inheritance diagram for BkgSensitiveDiode:

Public Member Functions
	BkgSensitiveDiode (const G4String &)
	Constructor.

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

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_trackID
	track id

ROOT::Math::XYZVector	m_startPos
	particle position at the entrance in volume

ROOT::Math::XYZVector	m_startMom
	particle momentum at the entrance in volume

double	m_startTime
	global time

double	m_startEnergy
	particle energy at the entrance in volume

double	m_energyDeposit
	energy deposited in volume

double	m_trackLength
	length of the track in the volume

ECLGeometryPar *	m_eclp
	pointer to ECLGeometryPar

StoreArray< MCParticle >	m_mcParticles
	MCParticle array.

StoreArray< BeamBackHit >	m_eclBeamBkgHits
	BeamBackHit array.

RelationArray	m_eclBeamBkgHitRel
	MCParticle to BeamBackHit relation array.

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 for neutron background study.

Definition at line 116 of file SensitiveDetector.h.

Constructor & Destructor Documentation

◆ BkgSensitiveDiode()

BkgSensitiveDiode ( const G4String & name )

explicit

Constructor.

Definition at line 306 of file SensitiveDetector.cc.

                                                        :
  Simulation::SensitiveDetectorBase(name, Const::invalidDetector),
  m_eclBeamBkgHitRel(m_mcParticles, m_eclBeamBkgHits)
{
  registerMCParticleRelation(m_eclBeamBkgHitRel);
  m_eclBeamBkgHits.registerInDataStore();
  m_mcParticles.registerRelationTo(m_eclBeamBkgHits);
 
  m_eclp = ECLGeometryPar::Instance();
  m_energyDeposit = 0;
  m_startEnergy = 0;
  m_startTime = 0;
  m_trackLength = 0;
  m_trackID = -1;
}

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

◆ step()

bool step	(	G4Step *	aStep,
		G4TouchableHistory *	history
	)

overridevirtual

Process each step and calculate variables defined in ECLHit.

Implements SensitiveDetectorBase.

Definition at line 325 of file SensitiveDetector.cc.

{
  const G4StepPoint& s0 = *aStep->GetPreStepPoint();
  const G4Track&  track = *aStep->GetTrack();
 
  if (m_trackID != track.GetTrackID()) { //TrackID changed, store track information
    m_trackID = track.GetTrackID();
    //Get world position
    const G4ThreeVector& worldPosition = s0.GetPosition();
    const double mm2cm = Unit::mm / Unit::cm;
    m_startPos.SetXYZ(worldPosition.x() * mm2cm, worldPosition.y() * mm2cm, worldPosition.z() * mm2cm);
    //Get momentum
    const G4ThreeVector& momentum = s0.GetMomentum() ;
    m_startMom.SetXYZ(momentum.x() * Unit::MeV, momentum.y() * Unit::MeV, momentum.z() * Unit::MeV);
    //Get time
    m_startTime = s0.GetGlobalTime();
    //Get energy
    m_startEnergy = s0.GetKineticEnergy() * Unit::MeV;
    //Reset energy deposit;
    m_energyDeposit = 0;
    //Reset track length;
    m_trackLength = 0;
  }
  //Update energy deposit
  m_energyDeposit += aStep->GetTotalEnergyDeposit() * Unit::MeV;
  m_trackLength += aStep->GetStepLength() * Unit::mm;
  //Save Hit if track leaves volume or is killed
  if (track.GetNextVolume() != track.GetVolume() ||
      track.GetTrackStatus() >= fStopAndKill) {
    int pdgCode = track.GetDefinition()->GetPDGEncoding();
    double endEnergy = track.GetKineticEnergy() * Unit::MeV;
    double neutWeight = 0;
    if (pdgCode == Const::neutron.getPDGCode()) {
      BkgNeutronWeight& wt = BkgNeutronWeight::getInstance();
      neutWeight = wt.getWeight(m_startEnergy / Unit::MeV);
    }
 
    int bkgHitNumber = m_eclBeamBkgHits.getEntries();
    m_eclBeamBkgHitRel.add(m_trackID, bkgHitNumber);
 
    int cellID = m_eclp->TouchableDiodeToCellID(s0.GetTouchable());
    m_eclBeamBkgHits.appendNew(6, cellID, pdgCode, m_trackID, m_startPos, m_startMom, m_startTime, endEnergy, m_startEnergy,
                               m_energyDeposit, m_trackLength, neutWeight);
 
    //Reset TrackID
    m_trackID = 0;
  }
  return true;
}

Member Data Documentation

◆ m_eclBeamBkgHitRel

RelationArray m_eclBeamBkgHitRel

private

MCParticle to BeamBackHit relation array.

Definition at line 134 of file SensitiveDetector.h.

◆ m_eclBeamBkgHits

StoreArray<BeamBackHit> m_eclBeamBkgHits

private

BeamBackHit array.

Definition at line 133 of file SensitiveDetector.h.

◆ m_eclp

ECLGeometryPar* m_eclp

private

pointer to ECLGeometryPar

Definition at line 131 of file SensitiveDetector.h.

◆ m_energyDeposit

double m_energyDeposit

private

energy deposited in volume

Definition at line 129 of file SensitiveDetector.h.

◆ m_mcParticles

StoreArray<MCParticle> m_mcParticles

private

MCParticle array.

Definition at line 132 of file SensitiveDetector.h.

◆ m_startEnergy

double m_startEnergy

private

particle energy at the entrance in volume

Definition at line 128 of file SensitiveDetector.h.

◆ m_startMom

ROOT::Math::XYZVector m_startMom

private

particle momentum at the entrance in volume

Definition at line 126 of file SensitiveDetector.h.

◆ m_startPos

ROOT::Math::XYZVector m_startPos

private

particle position at the entrance in volume

Definition at line 125 of file SensitiveDetector.h.

◆ m_startTime

double m_startTime

private

global time

Definition at line 127 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

track id

Definition at line 124 of file SensitiveDetector.h.

◆ m_trackLength

double m_trackLength

private

length of the track in the volume

Definition at line 130 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

◆ BkgSensitiveDiode()

Member Function Documentation

◆ getMCParticleRelations()

◆ ProcessHits()

◆ registerMCParticleRelation() [1/2]

◆ registerMCParticleRelation() [2/2]

◆ setActive()

◆ step()

Member Data Documentation

◆ m_eclBeamBkgHitRel

◆ m_eclBeamBkgHits

◆ m_eclp

◆ m_energyDeposit

◆ m_mcParticles

◆ m_startEnergy

◆ m_startMom

◆ m_startPos

◆ m_startTime

◆ m_subdetector

◆ m_trackID

◆ m_trackLength

◆ s_active

◆ s_mcRelations