SensitiveDetector Class Reference

The Class for ARICH Sensitive Detector. More...

#include <SensitiveDetector.h>

Inheritance diagram for SensitiveDetector:

Public Member Functions
	SensitiveDetector ()
	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
DBObjPtr< ARICHSimulationPar >	m_simPar
	simulation parameters from the DB
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 ARICH Sensitive Detector.

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

Definition at line 26 of file SensitiveDetector.h.

Constructor & Destructor Documentation

SensitiveDetector()

SensitiveDetector

(

)

Constructor.

Definition at line 35 of file SensitiveDetector.cc.

                                        :
      Simulation::SensitiveDetectorBase("ARICH", Const::ARICH)
    {
 
      StoreArray<MCParticle> particles;
      StoreArray<ARICHSimHit> hits;
      RelationArray relation(particles, hits);
      registerMCParticleRelation(relation);
      hits.registerInDataStore();
      particles.registerRelationTo(hits);
 
    }

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()

G4bool step ( G4Step *  aStep, G4TouchableHistory *    )

overridevirtual

Process each step and calculate variables defined in PXDSimHit.

Parameters

aStep

Current Geant4 step in the sensitive medium.

Returns

true if a hit was stored, o.w. false.

Implements SensitiveDetectorBase.

Definition at line 49 of file SensitiveDetector.cc.

    {
      //Get particle ID
      G4Track& track  = *aStep->GetTrack();
      if (track.GetDefinition()->GetParticleName() != "opticalphoton") return false;
 
      //Get time (check for proper global time)
      const G4double globalTime = track.GetGlobalTime();
 
      const G4StepPoint& postStep  = *aStep->GetPostStepPoint();
      const G4ThreeVector& postworldPosition = postStep.GetPosition();
 
      const G4StepPoint& preStep  = *aStep->GetPreStepPoint();
      const G4ThreeVector& preworldPosition = preStep.GetPosition();
 
      // direction of photon (+1 is into hapd)
      int dir = -1;
      if (postworldPosition.z() - preworldPosition.z() > 0) dir = +1;
 
      // trigger only on window geometrical boundary
      if (dir == 1 && postStep.GetStepStatus() != fGeomBoundary) { return false;}
      if (dir == -1 && preStep.GetStepStatus() != fGeomBoundary) { return false;}
 
      if ((track.GetNextVolume())->GetName() == "ARICH.HAPDWall") {
        track.SetTrackStatus(fStopAndKill);
        return false;
      }
 
      // Check if photon is internally reflected in HAPD window
      G4OpBoundaryProcessStatus theStatus = Undefined;
 
      G4ProcessManager* OpManager = G4OpticalPhoton::OpticalPhoton()->GetProcessManager();
 
      if (OpManager) {
        G4int MAXofPostStepLoops =
          OpManager->GetPostStepProcessVector()->entries();
        G4ProcessVector* fPostStepDoItVector =
          OpManager->GetPostStepProcessVector(typeDoIt);
        for (G4int i = 0; i < MAXofPostStepLoops; i++) {
          G4VProcess* fCurrentProcess = (*fPostStepDoItVector)[i];
          G4OpBoundaryProcess* opProcess = dynamic_cast<G4OpBoundaryProcess*>(fCurrentProcess);
          if (opProcess) { theStatus = opProcess->GetStatus(); break;}
        }
      }
 
      // if photon is internally reflected and going backward, do nothing
      if (theStatus == 3 && dir < 0) return 0;
      if (theStatus == 4 && dir < 0) { if (gRandom->Uniform() < 0.5) track.SetTrackStatus(fStopAndKill); return 0; }
 
      // apply quantum efficiency if not yet done
      bool applyQE = true;
      Simulation::TrackInfo* info =
        dynamic_cast<Simulation::TrackInfo*>(track.GetUserInformation());
      if (info) applyQE = info->getStatus() < 2;
 
      if (applyQE) {
 
        double energy = track.GetKineticEnergy() / CLHEP::eV;
        double qeffi  = m_simPar->getQE(energy) * m_simPar->getColEff();
 
        double fraction = 1.;
        if (info) fraction = info->getFraction();
        //correct Q.E. for internally reflected photons
        if (theStatus == 3) qeffi *= m_simPar->getQEScaling();
        if (gRandom->Uniform() * fraction > qeffi) {
          // apply possible absorbtion in HAPD window (for internally reflected photons only)
          if (theStatus == 3 && gRandom->Uniform() < m_simPar->getWindowAbsorbtion()) track.SetTrackStatus(fStopAndKill);
          return false;
        }
      }
 
      //Get module ID number
      const G4int moduleID = dir > 0 ? postStep.GetTouchableHandle()->GetReplicaNumber(1) :
                             preStep.GetTouchableHandle()->GetReplicaNumber(2);
 
      if (moduleID <= 0) return false;
      //std::cout << "moduleID " << moduleID << std::endl;
      //      std::cout << m_arichgp->getColEff() << " " << info->getFraction() << " " << m_arichgp->getQEScaling() <<" " << m_arichgp->QE(2.0) << std::endl;
      //Transform to local position
      G4ThreeVector localPosition = dir > 0 ? postStep.GetTouchableHandle()->GetHistory()->GetTopTransform().TransformPoint(
                                      postworldPosition) :
                                    preStep.GetTouchableHandle()->GetHistory()->GetTopTransform().TransformPoint(preworldPosition);
 
      //Get photon energy
      const G4double energy = track.GetKineticEnergy() / CLHEP::eV;
 
      //------------------------------------------------------------
      //                Create ARICHSimHit and save it to datastore
      //------------------------------------------------------------
 
      ROOT::Math::XYVector locpos(localPosition.x() / CLHEP::cm, localPosition.y() / CLHEP::cm);
      StoreArray<ARICHSimHit> arichSimHits;
      ARICHSimHit* simHit = arichSimHits.appendNew(moduleID, locpos, globalTime, energy);
 
      // add relation to MCParticle
      StoreArray<MCParticle> mcParticles;
      RelationArray arichSimHitRel(mcParticles, arichSimHits);
      arichSimHitRel.add(track.GetParentID(), simHit->getArrayIndex());
 
      // after detection photon track is killed
      track.SetTrackStatus(fStopAndKill);
      return true;
    }

Member Data Documentation

m_simPar

DBObjPtr<ARICHSimulationPar> m_simPar

private

simulation parameters from the DB

Definition at line 45 of file SensitiveDetector.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:

• arich/simulation/include/SensitiveDetector.h
• arich/simulation/src/SensitiveDetector.cc