BkgSensitiveDetector Class Reference

The Class for BeamBackground Sensitive Detector. More...

#include <BkgSensitiveDetector.h>

Inheritance diagram for BkgSensitiveDetector:

Public Member Functions
	BkgSensitiveDetector (const char *subDet, int iden=0)
	Constructor.
bool	step (G4Step *aStep, G4TouchableHistory *) override
	Process each step and calculate variables defined in PXDSimHit.

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_subDet
	Subdetector id number.
int	m_identifier
	Identifier of subdetector component.
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.
int	m_eclrepscale
	Replica (=sector) scale in ECL.
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

The Class for BeamBackground Sensitive Detector.

In this class, every variable defined in BeamBackHit will be calculated, and stored in datastore.

Definition at line 25 of file BkgSensitiveDetector.h.

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.

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

Member Data Documentation

m_eclrepscale

int m_eclrepscale

private

Replica (=sector) scale in ECL.

Definition at line 75 of file BkgSensitiveDetector.h.

m_energyDeposit

double m_energyDeposit

private

Energy deposited in volume.

Definition at line 69 of file BkgSensitiveDetector.h.

m_identifier

int m_identifier

private

Identifier of subdetector component.

Definition at line 51 of file BkgSensitiveDetector.h.

m_startEnergy

double m_startEnergy

private

Particle energy at the entrance in volume.

Definition at line 66 of file BkgSensitiveDetector.h.

m_startMom

ROOT::Math::XYZVector m_startMom

private

Particle momentum at the entrance in volume.

Definition at line 60 of file BkgSensitiveDetector.h.

m_startPos

ROOT::Math::XYZVector m_startPos

private

Particle position at the entrance in volume.

Definition at line 57 of file BkgSensitiveDetector.h.

m_startTime

double m_startTime

private

Global time.

Definition at line 63 of file BkgSensitiveDetector.h.

m_subDet

int m_subDet

private

Subdetector id number.

Definition at line 48 of file BkgSensitiveDetector.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 54 of file BkgSensitiveDetector.h.

m_trackLength

double m_trackLength

private

Length of the track in the volume.

Definition at line 72 of file BkgSensitiveDetector.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:

• simulation/background/include/BkgSensitiveDetector.h
• simulation/background/src/BkgSensitiveDetector.cc