TRTSensitiveDetector Class Reference

#include <TRTSensitiveDetector.h>

Inheritance diagram for TRTSensitiveDetector:

Collaboration diagram for TRTSensitiveDetector:

Public Member Functions
	TRTSensitiveDetector (const std::string &name, const std::string &hitCollectionName, int setVerboseLevel=0)
	~TRTSensitiveDetector ()
void	Initialize (G4HCofThisEvent *) override final
G4bool	ProcessHits (G4Step *, G4TouchableHistory *) override final
void	DeleteObjects ()
	Called by TRTRunAction::EndOfRunAction ...
template<class... Args>
void	AddHit (Args &&... args)
	Templated method to stuff a single hit into the sensitive detector class.

Private Member Functions
	FRIEND_TEST (TRTSensitiveDetectortest, ProcessHits)
	FRIEND_TEST (TRTSensitiveDetectortest, AddHit)
void	InitializeHitProcessing ()

Private Attributes
int	m_printMessages
	Configuration paremeters.
int	m_hitsWithZeroEnergyDeposit
G4VProcess *	m_phot
double	m_energyThreshold
double	m_probabilityThreshold
double	m_energyDepositCorrection
double	m_energyThresholdKr
double	m_probabilityThresholdKr
double	m_energyDepositCorrectionKr
double	m_energyThresholdAr
double	m_probabilityThresholdAr
double	m_energyDepositCorrectionAr
double	m_boundaryZ
int	m_hitID
	Properties of current TRTUncompressedHit, set by TRTProcessingOfBarrelHits and TRTProcessingOfEndCapHits friend classes.
HepMcParticleLink	m_partLink
int	m_particleEncoding
double	m_kineticEnergy
double	m_energyDeposit
double	m_energyDepositInKeV
double	m_preStepX
double	m_preStepY
double	m_preStepZ
double	m_postStepX
double	m_postStepY
double	m_postStepZ
double	m_globalTime
std::string	m_HitCollName
	Other member variables.
TRTUncompressedHitCollection *	m_HitColl {nullptr}
AtlasG4EventUserInfo *	m_g4UserEventInfo {nullptr}
const TRTParameters *	m_pParameters
TRTProcessingOfBarrelHits *	m_pProcessingOfBarrelHits
TRTProcessingOfEndCapHits *	m_pProcessingOfEndCapHits
G4Material *	m_pMaterialXe
G4Material *	m_pMaterialKr
G4Material *	m_pMaterialAr

Friends
class	TRTProcessingOfBarrelHits
class	TRTProcessingOfEndCapHits

Detailed Description

Definition at line 25 of file TRTSensitiveDetector.h.

Constructor & Destructor Documentation

TRTSensitiveDetector()

TRTSensitiveDetector::TRTSensitiveDetector	(	const std::string &	name,
		const std::string &	hitCollectionName,
		int	setVerboseLevel = 0 )

Definition at line 42 of file TRTSensitiveDetector.cxx.

  : G4VSensitiveDetector( name ),
    //Variables properly set during InitializeHitProcessing() method
    m_hitsWithZeroEnergyDeposit(0), m_phot(nullptr),
    m_energyThreshold(0.0),   m_probabilityThreshold(0.0),   m_energyDepositCorrection(0.0),
    m_energyThresholdKr(0.0), m_probabilityThresholdKr(0.0), m_energyDepositCorrectionKr(0.0),
    m_energyThresholdAr(0.0), m_probabilityThresholdAr(0.0), m_energyDepositCorrectionAr(0.0),
    m_boundaryZ(0.0),
    //End of variables properly set during InitializeHitProcessing() method
    //Properties of current TRTUncompressedHit
    m_hitID(0), m_particleEncoding(0), m_kineticEnergy(0.0),
    m_energyDeposit(0.0), m_energyDepositInKeV(0.0), m_preStepX(0.0),
    m_preStepY(0.0), m_preStepZ(0.0), m_postStepX(0.0), m_postStepY(0.0),
    m_postStepZ(0.0), m_globalTime(0.0),
    //End of Properties of current TRTUncompressedHit
    m_HitCollName( hitCollectionName ), m_pParameters(nullptr),
    m_pProcessingOfBarrelHits(nullptr), m_pProcessingOfEndCapHits(nullptr),
    m_pMaterialXe(nullptr), m_pMaterialKr(nullptr), m_pMaterialAr(nullptr)
{
  m_pParameters = TRTParameters::GetPointer();
 
  m_printMessages = m_pParameters->GetInteger("PrintMessages"); //FIXME not used - remove?
  verboseLevel = setVerboseLevel;
 
  this->InitializeHitProcessing();
 
  m_pParameters = nullptr;
}

~TRTSensitiveDetector()

TRTSensitiveDetector::~TRTSensitiveDetector ( )

inline

Definition at line 35 of file TRTSensitiveDetector.h.

{ /* don't own any of the pointers... */ }

Member Function Documentation

AddHit()

template<class... Args>

void TRTSensitiveDetector::AddHit ( Args &&... args )

inline

Templated method to stuff a single hit into the sensitive detector class.

This could get rather tricky, but the idea is to allow fast simulations to use the very same SD classes as the standard simulation.

Definition at line 46 of file TRTSensitiveDetector.h.

{ m_HitColl->Emplace( args... ); }

DeleteObjects()

void TRTSensitiveDetector::DeleteObjects

(

)

Called by TRTRunAction::EndOfRunAction ...

Definition at line 344 of file TRTSensitiveDetector.cxx.

{
  if(verboseLevel>4)
    {
      G4cout << GetName() << " DeleteObjects()" << G4endl;
    }
 
  delete m_pProcessingOfBarrelHits;
  delete m_pProcessingOfEndCapHits;
 
  if(verboseLevel>4)
    {
      G4cout << GetName() << " DeleteObjects() done" << G4endl;
    }
}

FRIEND_TEST() [1/2]

TRTSensitiveDetector::FRIEND_TEST ( TRTSensitiveDetectortest , AddHit  )

private

FRIEND_TEST() [2/2]

TRTSensitiveDetector::FRIEND_TEST ( TRTSensitiveDetectortest , ProcessHits  )

private

Initialize()

void TRTSensitiveDetector::Initialize ( G4HCofThisEvent * )

finaloverride

Definition at line 169 of file TRTSensitiveDetector.cxx.

{
  if(verboseLevel>4)
    {
      G4cout << GetName() << " Initialize()" << G4endl;
    }
 
  // The following code etablishes a pointer to the "phot" process.
  // This pointer is used in ProcessHits.
  // For performance reasons we test directly on the pointer address rather
  // than doing the string comparison for each hit in ProcessHits.
 
  if(!m_phot) {  // Only for the first event
    const G4ProcessVector* pVec =
      G4Gamma::Definition()->GetProcessManager()->GetProcessList();
    for(size_t ip=0;ip<pVec->entries();ip++)
      {
        if((*pVec)[ip]->GetProcessName()=="phot")
          {
            m_phot = (*pVec)[ip];
            break;
          }
        if((*pVec)[ip]->GetProcessName()=="GammaGeneralProc")
          {
            G4GammaGeneralProcess *genproc = static_cast<G4GammaGeneralProcess*>((*pVec)[ip]);
            G4VEmProcess *proc = genproc->GetEmProcess("phot");
            if (proc && proc->GetProcessName()=="phot")
              {
                m_phot = proc;
                break;
              }
          }
      }
  }
  if(!m_phot) {
    G4cout << GetName() << "ERROR Did not find the photoelectic process!!!" << G4endl;
  }
 
  // nullptr checks are needed for unit tests because geant4 run is not initialized
  // in real jobs, event manager, and event info are always set
  if(auto* eventManager = G4EventManager::GetEventManager())
  {
    if(auto* eventInfo = static_cast<AtlasG4EventUserInfo*>(eventManager->GetUserInformation())) {
      m_HitColl = eventInfo->GetHitCollectionMap()->Find<TRTUncompressedHitCollection>(m_HitCollName);
      m_g4UserEventInfo = eventInfo;
    }
  }
 
  if(verboseLevel>4)
    {
      G4cout << GetName() << " Initialize() done" << G4endl;
    }
}

InitializeHitProcessing()

void TRTSensitiveDetector::InitializeHitProcessing ( )

private

Definition at line 75 of file TRTSensitiveDetector.cxx.

{
  if(verboseLevel>4)
    {
      G4cout << GetName() << " InitializeHitProcessing()" << G4endl;
    }
  m_hitsWithZeroEnergyDeposit =
    m_pParameters->GetInteger("HitsWithZeroEnergyDeposit");
 
  m_phot = nullptr;
 
  // Parameters describing flourecense in Xe gas mixture:
  // Units of these numbers in management file are in keV; change to default units
 
  m_energyThreshold           = m_pParameters->GetDouble("EnergyThreshold"  ) * CLHEP::keV;
  m_energyThresholdKr         = m_pParameters->GetDouble("EnergyThresholdKr") * CLHEP::keV;
  m_energyThresholdAr         = m_pParameters->GetDouble("EnergyThresholdAr") * CLHEP::keV;
  m_probabilityThreshold      = m_pParameters->GetDouble("ProbabilityThreshold"  );
  m_probabilityThresholdKr    = m_pParameters->GetDouble("ProbabilityThresholdKr");
  m_probabilityThresholdAr    = m_pParameters->GetDouble("ProbabilityThresholdAr");
  m_energyDepositCorrection   = m_pParameters->GetDouble("EnergyDepositCorrection"  ) * CLHEP::keV;
  m_energyDepositCorrectionKr = m_pParameters->GetDouble("EnergyDepositCorrectionKr") * CLHEP::keV;
  m_energyDepositCorrectionAr = m_pParameters->GetDouble("EnergyDepositCorrectionAr") * CLHEP::keV;
  if(verboseLevel>9)
    {
      G4cout << GetName() << " Fluorescence parameters: EnergyThreshold            "
             << m_energyThreshold           << G4endl;
      G4cout << GetName() << " Fluorescence parameters: EnergyThresholdKr          "
             << m_energyThresholdKr         << G4endl;
      G4cout << GetName() << " Fluorescence parameters: EnergyThresholdAr          "
             << m_energyThresholdAr         << G4endl;
      G4cout << GetName() << " Fluorescence parameters: ProbabilityThreshold       "
             << m_probabilityThreshold      << G4endl;
      G4cout << GetName() << " Fluorescence parameters: ProbabilityThresholdKr     "
             << m_probabilityThresholdKr    << G4endl;
      G4cout << GetName() << " Fluorescence parameters: ProbabilityThresholdAr     "
             << m_probabilityThresholdAr    << G4endl;
      G4cout << GetName() << " Fluorescence parameters: EnergyDepositCorrection    "
             << m_energyDepositCorrection   << G4endl;
      G4cout << GetName() << " Fluorescence parameters: EnergyDepositCorrectionKr  "
             << m_energyDepositCorrectionKr << G4endl;
      G4cout << GetName() << " Fluorescence parameters: EnergyDepositCorrectionAr  "
             << m_energyDepositCorrectionAr << G4endl;
    }
  m_boundaryZ = m_pParameters->GetDouble("LengthOfBarrelVolume") / 2.;
 
  TRTParametersForBarrelHits* pParametersForBarrelHits = nullptr;
  TRTParametersForEndCapHits* pParametersForEndCapHits = nullptr;
 
  m_pProcessingOfBarrelHits = new TRTProcessingOfBarrelHits(this);
  m_pProcessingOfEndCapHits = new TRTProcessingOfEndCapHits(this);
 
  pParametersForBarrelHits =
    new TRTParametersForBarrelHits(m_pProcessingOfBarrelHits);
  pParametersForEndCapHits =
    new TRTParametersForEndCapHits(m_pProcessingOfEndCapHits);
 
  delete pParametersForBarrelHits;
  delete pParametersForEndCapHits;
 
  // Get nist material manager
  G4NistManager* nist = G4NistManager::Instance();
  m_pMaterialXe = nist->FindOrBuildMaterial("trt::XeCO2O2");
  if (!m_pMaterialXe && verboseLevel>4)
    {
      G4cout << GetName() << " Could not find Xe material (Only OK if no TRT straws are filled with Xenon)" << G4endl;
    }
  m_pMaterialKr = nist->FindOrBuildMaterial("trt::KrCO2O2");
  if (!m_pMaterialKr && verboseLevel>4)
    {
      G4cout << GetName() << " Could not find Kr material (Only OK if no TRT straws are filled with Krypton)" << G4endl;
    }
  m_pMaterialAr = nist->FindOrBuildMaterial("trt::ArCO2O2");
  if (!m_pMaterialAr && verboseLevel>4)
    {
      G4cout << GetName() << " Could not find Ar material (Only OK if no TRT straws are filled with Argon)" << G4endl;
    }
  if(!m_pMaterialXe && !m_pMaterialKr && !m_pMaterialAr)
    {
      G4ExceptionDescription description;
      description << "InitializeHitProcessing: Could not find Xe, Kr or Ar materials (Not OK!)";
      G4Exception("TRTSensitiveDetector", "NoTRTGasesFound", FatalException, description);
    }
 
  if(verboseLevel>4)
    {
      G4cout << GetName() << " InitializeHitProcessing() done" << G4endl;
    }
}

ProcessHits()

bool TRTSensitiveDetector::ProcessHits ( G4Step * pStep, G4TouchableHistory *  )

finaloverride

Definition at line 227 of file TRTSensitiveDetector.cxx.

{
  m_energyDeposit = pStep->GetTotalEnergyDeposit();
 
  G4Track* pTrack = pStep->GetTrack();
  G4ParticleDefinition* pParticleDefinition = pTrack->GetDefinition();
 
  // Skip particles which deposit no energy
  if ( m_energyDeposit == 0. && !m_hitsWithZeroEnergyDeposit )
    {
      if ( pParticleDefinition != G4Geantino::Definition() &&
           pParticleDefinition != G4ChargedGeantino::Definition() )
        {
          return false;
        }
    }
 
  // Skip electrons which originate from a photoelectric process.
  // These electrons have very low energy and even the PAI model will
  // give the wrong energy deposit.
  // Instead we count for a photon which undergoes a "phot" reaction
  // the full energy as deposited in the interaction point (see below)
  if(pTrack->GetCreatorProcess()==m_phot)
    {
      return false;
    }
 
  // Get kinetic energy of depositing particle
  m_kineticEnergy = pStep->GetPreStepPoint()->GetKineticEnergy();
 
  // If we are dealing with a photon undergoing a "phot" reaction, count
  // the photon kinetic energy as deposited energy in the point of
  // the reaction
 
  if ( pParticleDefinition==G4Gamma::GammaDefinition() &&
       pStep->GetPostStepPoint()->GetProcessDefinedStep()==m_phot )
    {
      m_energyDeposit = m_kineticEnergy;
      double current_energyThreshold         = 1E+99;
      double current_probabilityThreshold    = 2.0;
      double current_energyDepositCorrection = 0.0;
      G4Material *pPreStepMaterial = pStep->GetPreStepPoint()->GetMaterial();
      if      (pPreStepMaterial == m_pMaterialXe)
        {
          current_energyThreshold         = m_energyThreshold;
          current_probabilityThreshold    = m_probabilityThreshold;
          current_energyDepositCorrection = m_energyDepositCorrection;
        }
      else if (pPreStepMaterial == m_pMaterialKr)
        {
          current_energyThreshold         = m_energyThresholdKr;
          current_probabilityThreshold    = m_probabilityThresholdKr;
          current_energyDepositCorrection = m_energyDepositCorrectionKr;
        }
      else if (pPreStepMaterial == m_pMaterialAr)
        {
          current_energyThreshold         = m_energyThresholdAr;
          current_probabilityThreshold    = m_probabilityThresholdAr;
          current_energyDepositCorrection = m_energyDepositCorrectionAr;
        }
      else
        {
          G4ExceptionDescription description;
          description << "ProcessHits: Unknown prestep material";
          G4Exception("TRTSensitiveDetector", "UnknownGasFound", FatalException, description);
          return false; //The G4Exception call above should abort the job, but Coverity does not seem to pick this up.
        }
      // Correct for flourescence (a la Nevski):
      //  - For some percentage (15%) of photons with
      //    energy above threshold (4.9 keV) reduce deposited energy
      //    by correction (4.0 keV)
      //    (Different numbers for Ar and Kr)
      if ( m_energyDeposit > current_energyThreshold &&
           CLHEP::RandFlat::shoot() > current_probabilityThreshold )
        {
          m_energyDeposit -= current_energyDepositCorrection;
        }
    }
 
 
  // Particle code of depositing particle
  m_particleEncoding = pParticleDefinition->GetPDGEncoding();
 
  bool trackerHit = false;
 
  if ( std::fabs(pStep->GetPreStepPoint()->GetPosition().z()) < m_boundaryZ )
    {
      trackerHit = m_pProcessingOfBarrelHits->ProcessHit(pStep);
    }
  else
    {
      trackerHit = m_pProcessingOfEndCapHits->ProcessHit(pStep);
    }
 
  // TRTUncompressedHit appearently expects energyDeposit in keV.
  // Convert:
  m_energyDepositInKeV = m_energyDeposit/CLHEP::keV;
 
  // Create UncompressedHit
 
  if (trackerHit)
    {
      // Build the hit straight onto the vector
      m_HitColl->Emplace(m_hitID, m_partLink, m_particleEncoding,
                         (float) m_kineticEnergy, (float) m_energyDepositInKeV,
                         (float) m_preStepX, (float) m_preStepY, (float) m_preStepZ,
                         (float) m_postStepX, (float) m_postStepY, (float) m_postStepZ,
                         (float) m_globalTime );
    }
 
  return true;
}

Friends And Related Symbol Documentation

TRTProcessingOfBarrelHits

friend class TRTProcessingOfBarrelHits

friend

Definition at line 30 of file TRTSensitiveDetector.h.

TRTProcessingOfEndCapHits

friend class TRTProcessingOfEndCapHits

friend

Definition at line 31 of file TRTSensitiveDetector.h.

Member Data Documentation

m_boundaryZ

double TRTSensitiveDetector::m_boundaryZ

private

Definition at line 65 of file TRTSensitiveDetector.h.

m_energyDeposit

double TRTSensitiveDetector::m_energyDeposit

private

Definition at line 73 of file TRTSensitiveDetector.h.

m_energyDepositCorrection

double TRTSensitiveDetector::m_energyDepositCorrection

private

Definition at line 58 of file TRTSensitiveDetector.h.

m_energyDepositCorrectionAr

double TRTSensitiveDetector::m_energyDepositCorrectionAr

private

Definition at line 64 of file TRTSensitiveDetector.h.

m_energyDepositCorrectionKr

double TRTSensitiveDetector::m_energyDepositCorrectionKr

private

Definition at line 61 of file TRTSensitiveDetector.h.

m_energyDepositInKeV

double TRTSensitiveDetector::m_energyDepositInKeV

private

Definition at line 74 of file TRTSensitiveDetector.h.

m_energyThreshold

double TRTSensitiveDetector::m_energyThreshold

private

Definition at line 56 of file TRTSensitiveDetector.h.

m_energyThresholdAr

double TRTSensitiveDetector::m_energyThresholdAr

private

Definition at line 62 of file TRTSensitiveDetector.h.

m_energyThresholdKr

double TRTSensitiveDetector::m_energyThresholdKr

private

Definition at line 59 of file TRTSensitiveDetector.h.

m_g4UserEventInfo

AtlasG4EventUserInfo* TRTSensitiveDetector::m_g4UserEventInfo {nullptr}

private

Definition at line 87 of file TRTSensitiveDetector.h.

{nullptr};

m_globalTime

double TRTSensitiveDetector::m_globalTime

private

Definition at line 81 of file TRTSensitiveDetector.h.

m_HitColl

TRTUncompressedHitCollection* TRTSensitiveDetector::m_HitColl {nullptr}

private

Definition at line 86 of file TRTSensitiveDetector.h.

{nullptr}; //pUncompressedHitCollection;

m_HitCollName

std::string TRTSensitiveDetector::m_HitCollName

private

Other member variables.

Definition at line 85 of file TRTSensitiveDetector.h.

m_hitID

int TRTSensitiveDetector::m_hitID

private

Properties of current TRTUncompressedHit, set by TRTProcessingOfBarrelHits and TRTProcessingOfEndCapHits friend classes.

Definition at line 69 of file TRTSensitiveDetector.h.

m_hitsWithZeroEnergyDeposit

int TRTSensitiveDetector::m_hitsWithZeroEnergyDeposit

private

Definition at line 54 of file TRTSensitiveDetector.h.

m_kineticEnergy

double TRTSensitiveDetector::m_kineticEnergy

private

Definition at line 72 of file TRTSensitiveDetector.h.

m_particleEncoding

int TRTSensitiveDetector::m_particleEncoding

private

Definition at line 71 of file TRTSensitiveDetector.h.

m_partLink

HepMcParticleLink TRTSensitiveDetector::m_partLink

private

Definition at line 70 of file TRTSensitiveDetector.h.

m_phot

G4VProcess* TRTSensitiveDetector::m_phot

private

Definition at line 55 of file TRTSensitiveDetector.h.

m_pMaterialAr

G4Material* TRTSensitiveDetector::m_pMaterialAr

private

Definition at line 97 of file TRTSensitiveDetector.h.

m_pMaterialKr

G4Material* TRTSensitiveDetector::m_pMaterialKr

private

Definition at line 96 of file TRTSensitiveDetector.h.

m_pMaterialXe

G4Material* TRTSensitiveDetector::m_pMaterialXe

private

Definition at line 95 of file TRTSensitiveDetector.h.

m_postStepX

double TRTSensitiveDetector::m_postStepX

private

Definition at line 78 of file TRTSensitiveDetector.h.

m_postStepY

double TRTSensitiveDetector::m_postStepY

private

Definition at line 79 of file TRTSensitiveDetector.h.

m_postStepZ

double TRTSensitiveDetector::m_postStepZ

private

Definition at line 80 of file TRTSensitiveDetector.h.

m_pParameters

const TRTParameters* TRTSensitiveDetector::m_pParameters

private

Definition at line 89 of file TRTSensitiveDetector.h.

m_pProcessingOfBarrelHits

TRTProcessingOfBarrelHits* TRTSensitiveDetector::m_pProcessingOfBarrelHits

private

Definition at line 91 of file TRTSensitiveDetector.h.

m_pProcessingOfEndCapHits

TRTProcessingOfEndCapHits* TRTSensitiveDetector::m_pProcessingOfEndCapHits

private

Definition at line 92 of file TRTSensitiveDetector.h.

m_preStepX

double TRTSensitiveDetector::m_preStepX

private

Definition at line 75 of file TRTSensitiveDetector.h.

m_preStepY

double TRTSensitiveDetector::m_preStepY

private

Definition at line 76 of file TRTSensitiveDetector.h.

m_preStepZ

double TRTSensitiveDetector::m_preStepZ

private

Definition at line 77 of file TRTSensitiveDetector.h.

m_printMessages

int TRTSensitiveDetector::m_printMessages

private

Configuration paremeters.

Definition at line 53 of file TRTSensitiveDetector.h.

m_probabilityThreshold

double TRTSensitiveDetector::m_probabilityThreshold

private

Definition at line 57 of file TRTSensitiveDetector.h.

m_probabilityThresholdAr

double TRTSensitiveDetector::m_probabilityThresholdAr

private

Definition at line 63 of file TRTSensitiveDetector.h.

m_probabilityThresholdKr

double TRTSensitiveDetector::m_probabilityThresholdKr

private

Definition at line 60 of file TRTSensitiveDetector.h.

---

The documentation for this class was generated from the following files:

• TRTSensitiveDetector.h
• TRTSensitiveDetector.cxx