AWESOMESensitiveDetector Class Reference

Sensitive Detector implementation of the AWESOME detector. More...

#include <AWESOMESensitiveDetector.h>

Inheritance diagram for AWESOMESensitiveDetector:

Public Member Functions
	AWESOMESensitiveDetector ()
	Constructor.
bool	step (G4Step *step, G4TouchableHistory *) override
	Step processing method.

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
StoreArray< MCParticle >	m_MCParticles
	MC particles.
StoreArray< AWESOMESimHit >	m_SimHits
	AWESOME simulated hits.
RelationArray	m_MCParticlesToSimHits {m_MCParticles, m_SimHits}
	Relation array between MCParticles and AWESOMESimHits.
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

Sensitive Detector implementation of the AWESOME detector.

Definition at line 27 of file AWESOMESensitiveDetector.h.

Constructor & Destructor Documentation

AWESOMESensitiveDetector()

AWESOMESensitiveDetector

(

)

Constructor.

Definition at line 27 of file AWESOMESensitiveDetector.cc.

                                                   :
  Simulation::SensitiveDetectorBase{"AwesomeSensitiveDetector", Const::EDetector::TEST}
{
  /* MCParticles must be optional, not required. */
  m_MCParticles.isOptional();
  /* Register the simulted hits and all the necessary relations in the datastore. */
  m_SimHits.registerInDataStore();
  m_MCParticles.registerRelationTo(m_SimHits);
  /*
   * Register the Relation so that the Geant4 TrackIDs get replaced by the actual
   * MCParticle indices after simulating the events. This is needed as
   * secondary particles might not be stored so everything relating to those
   * particles will be attributed to the last saved mother particle.
  */
  registerMCParticleRelation(m_MCParticlesToSimHits);
}

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

step()

bool step ( G4Step *  step, G4TouchableHistory *    )

overridevirtual

Step processing method.

Parameters

step	The G4Step with the current step information.

Returns

true if a hit was created, false otherwise.

Implements SensitiveDetectorBase.

Definition at line 44 of file AWESOMESensitiveDetector.cc.

{
  /* Get some basic information from Geant4. */
  const G4Track& track   = *step->GetTrack();
  const int trackID      = track.GetTrackID();
  const double energyDep = step->GetTotalEnergyDeposit() * Unit::MeV;
  G4StepPoint* preStep   = step->GetPreStepPoint();
  G4StepPoint* postStep  = step->GetPostStepPoint();
  /* Ignore everything below 1 eV. */
  if (energyDep < Unit::eV)
    return false;
  /*
   * Compute other useful quantities to be stored.
   * We must be sure that the quantities are stored using the proper Belle2 units:
   * positions in cm, time in ns, etc.
   */
  const CLHEP::Hep3Vector position = 0.5 * (preStep->GetPosition() + postStep->GetPosition()) / CLHEP::cm; // Now in cm
  const double time = 0.5 * (preStep->GetGlobalTime() + postStep->GetGlobalTime()); // Already in ns
  /* Store the simulated hit. */
  AWESOMESimHit* simHit = m_SimHits.appendNew();
  simHit->setEnergyDep(energyDep);
  simHit->setPosition(B2Vector3{position.x(), position.y(), position.z()});
  simHit->setTime(time);
  /*
   * Add a relation between the current MCParticle and the simulated hit.
   * Since the MCParticle index is not yet defined we use the trackID from Geant4.
   */
  m_MCParticlesToSimHits.add(trackID, simHit->getArrayIndex());
  return true;
}

Member Data Documentation

m_MCParticles

StoreArray<MCParticle> m_MCParticles

private

MC particles.

Definition at line 44 of file AWESOMESensitiveDetector.h.

m_MCParticlesToSimHits

RelationArray m_MCParticlesToSimHits {m_MCParticles, m_SimHits}

private

Relation array between MCParticles and AWESOMESimHits.

Definition at line 50 of file AWESOMESensitiveDetector.h.

m_SimHits

StoreArray<AWESOMESimHit> m_SimHits

private

AWESOME simulated hits.

Definition at line 47 of file AWESOMESensitiveDetector.h.

m_subdetector

Const::EDetector m_subdetector

privateinherited

Subdetector the class belongs to.

Definition at line 91 of file SensitiveDetectorBase.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:

• online_book/awesome/simulation/include/AWESOMESensitiveDetector.h
• online_book/awesome/simulation/src/AWESOMESensitiveDetector.cc