#include <TBECOuterModuleTool.h>

Inheritance diagram for TBECOuterModuleTool:

Collaboration diagram for TBECOuterModuleTool:

Public Member Functions
	TBECOuterModuleTool (const std::string &type, const std::string &name, const IInterface *parent)

virtual	~TBECOuterModuleTool ()

StatusCode	initializeCalculators () override final

StatusCode	initializeSD () override final

StatusCode	Gather () override final
	End of an athena event. More...

StatusCode	initialize () override final

void	setupHelpers (LArG4SimpleSD *) const
	Helper method to pass the ID helper pointers to the SDs. More...

void	setupHelpers (LArG4CalibSD *) const
	Overload of the above method for calib SDs. More...

virtual StatusCode	SetupEvent () override
	Beginning of an athena event. More...

Protected Member Functions
G4VSensitiveDetector *	makeSD () const override final

void	setupAllSDs (const std::map< G4VSensitiveDetector , std::vector< std::string > > &configuration) const
	Method actually doing the work to assign all of these SDs FIXME: this argument type is nasty: More...

bool	match (const char first, const char second) const
	Helper function for matching strings with wildcards. More...

StatusCode	assignSD (G4VSensitiveDetector *sd, const std::vector< std::string > &volumes) const
	Assign SD to a list of volumes. More...

G4VSensitiveDetector *	getSD ()
	Retrieve the current SD. More...

void	SetSensitiveDetector (G4LogicalVolume , G4VSensitiveDetector ) const
	Method stolen from G4VUserDetectorConstruction in G4 10.2. More...

Protected Attributes
G4bool	m_doPID
	Are we set up to run with PID hits? More...

std::string	m_timeBinType
	What time binning type for regular hits? More...

float	m_timeBinWidth
	What time bin width for regular hits? More...

G4bool	m_useFrozenShowers = false
	Is there going to be a fast simulation coming into this SD? More...

const LArEM_ID *	m_larEmID
	Pointers to the identifier helpers. More...

const LArFCAL_ID *	m_larFcalID

const LArHEC_ID *	m_larHecID

const CaloDM_ID *	m_caloDmID

Gaudi::Property< std::vector< std::string > >	m_volumeNames {this, "LogicalVolumeNames", {}}
	All the volumes to which this SD is assigned. More...

Gaudi::Property< std::vector< std::string > >	m_outputCollectionNames {this, "OutputCollectionNames", {}}
	Names of all output collections written out by this SD. More...

Gaudi::Property< bool >	m_noVolumes {this, "NoVolumes", false}
	This SensitiveDetector has no volumes associated with it. More...

Private Member Functions
void	setSD (G4VSensitiveDetector *)
	Set the current SD. More...

Static Private Member Functions
static bool	matchStrings (const char first, const char second)
	Match two strings with wildcard support. More...

Private Attributes
SG::WriteHandle< LArHitContainer >	m_HitColl_gapadj

SG::WriteHandle< LArHitContainer >	m_HitColl_gapold

SG::WriteHandle< LArHitContainer >	m_HitColl_gap_e

SG::WriteHandle< LArHitContainer >	m_HitColl_gap_s

SG::WriteHandle< LArHitContainer >	m_HitColl_gap_se

SG::WriteHandle< LArHitContainer >	m_HitColl_chcoll

SG::WriteHandle< LArHitContainer >	m_HitColl_ropt

ServiceHandle< ILArCalculatorSvc >	m_emecoutergadjcalc

ServiceHandle< ILArCalculatorSvc >	m_emecoutergadjoldcalc

ServiceHandle< ILArCalculatorSvc >	m_emecoutergadjecalc

ServiceHandle< ILArCalculatorSvc >	m_emecoutergadjscalc

ServiceHandle< ILArCalculatorSvc >	m_emecoutergadjsecalc

ServiceHandle< ILArCalculatorSvc >	m_emecouterchclcalc

ServiceHandle< ILArCalculatorSvc >	m_emecoutercalc

LArG4SimpleSD *	m_gapadjSD

LArG4SimpleSD *	m_gapoldSD

LArG4SimpleSD *	m_gap_eSD

LArG4SimpleSD *	m_gap_sSD

LArG4SimpleSD *	m_gap_seSD

LArG4SimpleSD *	m_chcollSD

LArG4SimpleSD *	m_roptSD

G4VSensitiveDetector *	m_SD {}
	The sensitive detector to which this thing corresponds. More...

Detailed Description

This implementation has issues in multi-threading and so cannot be used in an MT job. Migration discussion ongoing in ATLASSIM-2606.

Definition at line 23 of file TBECOuterModuleTool.h.

Constructor & Destructor Documentation

◆ TBECOuterModuleTool()

TBECOuterModuleTool::TBECOuterModuleTool	(	const std::string &	type,
		const std::string &	name,
		const IInterface *	parent
	)

◆ ~TBECOuterModuleTool()

virtual TBECOuterModuleTool::~TBECOuterModuleTool ( )

inlinevirtual

Definition at line 30 of file TBECOuterModuleTool.h.

30 {}

Member Function Documentation

◆ assignSD()

StatusCode SensitiveDetectorBase::assignSD	(	G4VSensitiveDetector *	sd,
		const std::vector< std::string > &	volumes
	)		const

protectedinherited

Assign SD to a list of volumes.

This method supports wild card matching

Definition at line 69 of file SensitiveDetectorBase.cxx.

 {
   // Propagate verbosity setting to the SD
   if(msgLvl(MSG::VERBOSE)) sd->SetVerboseLevel(10);
   else if(msgLvl(MSG::DEBUG)) sd->SetVerboseLevel(5);
  
   // Add the sensitive detector to the SD manager in G4 for SDs,
   // even if it has no volumes associated to it.
   auto sdMgr = G4SDManager::GetSDMpointer();
   sdMgr->AddNewDetector(sd);
  
   if(!volumes.empty()) {
     bool gotOne = false;
     auto logicalVolumeStore = G4LogicalVolumeStore::GetInstance();
     for(const auto& volumeName : volumes) {
       // Keep track of how many volumes we find with this name string.
       // We allow for multiple matches.
       int numFound = 0;
  
       // Find volumes with this name
       for(auto* logVol : *logicalVolumeStore) {
  
         ATH_MSG_VERBOSE("Check whether "<<logVol->GetName()<<" belongs to the set of sensitive detectors "<<volumeName);
         if( matchStrings( volumeName.data(), logVol->GetName() ) ){
           ++numFound;
           SetSensitiveDetector(logVol, sd);
         }
         
       }
       // Warn if no volumes were found
       if(numFound == 0) {
         ATH_MSG_WARNING("Volume " << volumeName <<
                         " not found in G4LogicalVolumeStore.");
       }
       else {
         ATH_MSG_VERBOSE("Found " << numFound << " copies of LV " << volumeName <<
                         "; SD " << sd->GetName() << " assigned.");
         gotOne = true;
       }
  
     }
  
     // Abort if we have failed to assign any volume
     if(!gotOne) {
       ATH_MSG_ERROR( "Failed to assign *any* volume to SD " << name() <<
                      " and expected at least one. Size of the volume store "<<G4LogicalVolumeStore::GetInstance()->size() );
       return StatusCode::FAILURE;
     }
   }
  
   return StatusCode::SUCCESS;
 }

◆ Gather()

StatusCode TBECOuterModuleTool::Gather ( )

finaloverridevirtual

End of an athena event.

Store the output collection in SG at this point. If we are using a WriteHandle, then this can be empty!

Reimplemented from SensitiveDetectorBase.

◆ getSD()

G4VSensitiveDetector * SensitiveDetectorBase::getSD ( )

protectedinherited

Retrieve the current SD.

In AthenaMT, this means the thread-local SD. Otherwise, it is simply the single SD.

Definition at line 123 of file SensitiveDetectorBase.cxx.

 {
 #ifdef G4MULTITHREADED
   // Get current thread-ID
   const auto tid = std::this_thread::get_id();
   // Retrieve it from the SD map
   auto sdPair = m_sdThreadMap.find(tid);
   if(sdPair == m_sdThreadMap.end()) return nullptr;
   return sdPair->second;
 #else
   return m_SD;
 #endif
 }

◆ initialize()

StatusCode LArG4SDTool::initialize ( )

finaloverrideinherited

◆ initializeCalculators()

StatusCode TBECOuterModuleTool::initializeCalculators ( )

finaloverridevirtual

Reimplemented from LArG4SDTool.

◆ initializeSD()

StatusCode TBECOuterModuleTool::initializeSD ( )

finaloverride

◆ makeSD()

G4VSensitiveDetector* LArG4SDTool::makeSD ( ) const

inlinefinaloverrideprotectedinherited

Definition at line 52 of file LArG4SDTool.h.

52 { return nullptr; }

◆ match()

bool LArG4SDTool::match	(	const char *	first,
		const char *	second
	)		const

protectedinherited

Helper function for matching strings with wildcards.

◆ matchStrings()

bool SensitiveDetectorBase::matchStrings	(	const char *	first,
		const char *	second
	)

staticprivateinherited

Match two strings with wildcard support.

Compares two strings character by character with optional * wildcard in the first argument

Definition at line 150 of file SensitiveDetectorBase.cxx.

 {
   // If we reach at the end of both strings, we are done
   if (*first == '\0' && *second == '\0')
     return true;
  
   // If there are consecutive '*' present in the first string
   // advance to the next character
   if(*first == '*' && *(first + 1) == '*')
     return matchStrings(first + 1, second);
  
   // Make sure that the characters after '*' are present in second string.
   if (*first == '*' && *(first + 1) != '\0' && *second == '\0')
     return false;
  
   // If the current characters of both strings match
   if (*first == *second)
     return matchStrings(first + 1, second + 1);
  
   // If there is *, then there are two possibilities
   // a) We consider current character of second string
   // b) We ignore current character of second string.
   if (*first == '*')
     return matchStrings(first + 1, second) || matchStrings(first, second + 1);
   return false;
 }

◆ setSD()

void SensitiveDetectorBase::setSD ( G4VSensitiveDetector * sd )

privateinherited

Set the current SD.

In hive, this gets assigned as the thread-local SD.

Definition at line 137 of file SensitiveDetectorBase.cxx.

 {
 #ifdef G4MULTITHREADED
   const auto tid = std::this_thread::get_id();
   ATH_MSG_DEBUG("Creating and registering SD " << sd << " in thread " << tid);
   m_sdThreadMap.insert( std::make_pair(tid, sd) );
 #else
   m_SD = sd;
 #endif
 }

◆ SetSensitiveDetector()

void SensitiveDetectorBase::SetSensitiveDetector	(	G4LogicalVolume *	logVol,
		G4VSensitiveDetector *	aSD
	)		const

protectedinherited

Method stolen from G4VUserDetectorConstruction in G4 10.2.

Definition at line 177 of file SensitiveDetectorBase.cxx.

 {
   // New Logic: allow for "multiple" SDs being attached to a single LV.
   // To do that we use a special proxy SD called G4MultiSensitiveDetector
  
   // Get existing SD if already set and check if it is of the special type
   G4VSensitiveDetector* originalSD = logVol->GetSensitiveDetector();
   if ( originalSD == nullptr )
     {
       logVol->SetSensitiveDetector(aSD);
     }
   else
     {
       G4MultiSensitiveDetector* msd = dynamic_cast<G4MultiSensitiveDetector*>(originalSD);
       if ( msd != nullptr )
         {
           msd->AddSD(aSD);
         }
       else
         {
           // Construct a unique name using the volume address
           std::stringstream ss;
           ss << static_cast<const void*>(logVol);
           const G4String msdname = "/MultiSD_" + logVol->GetName() + ss.str();
           //ATH_MSG_INFO("MultiSD name: " << msdname);
           msd = new G4MultiSensitiveDetector(msdname);
           // We need to register the proxy to have correct handling of IDs
           G4SDManager::GetSDMpointer()->AddNewDetector(msd);
           msd->AddSD(originalSD);
           msd->AddSD(aSD);
           logVol->SetSensitiveDetector(msd);
         }
     }
 }

◆ setupAllSDs()

void LArG4SDTool::setupAllSDs ( const std::map< G4VSensitiveDetector *, std::vector< std::string > * > & configuration ) const

protectedinherited

Method actually doing the work to assign all of these SDs FIXME: this argument type is nasty:

non-const ptr to list of strings

◆ SetupEvent()

virtual StatusCode SensitiveDetectorBase::SetupEvent ( )

inlineoverridevirtualinherited

Beginning of an athena event.

This is where collection initialization should happen. If we are using a WriteHandle, then this could be empty.

Reimplemented in MuonWallSDTool, AFP_SensitiveDetectorTool, AFP_SiDSensitiveDetectorTool, AFP_TDSensitiveDetectorTool, CaloCellContainerSDTool, and ALFA_SensitiveDetectorTool.

Definition at line 62 of file SensitiveDetectorBase.h.

62 { return StatusCode::SUCCESS; }

◆ setupHelpers() [1/2]

void LArG4SDTool::setupHelpers ( LArG4CalibSD * ) const

inherited

Overload of the above method for calib SDs.

◆ setupHelpers() [2/2]

void LArG4SDTool::setupHelpers ( LArG4SimpleSD * ) const

inherited

Helper method to pass the ID helper pointers to the SDs.

Member Data Documentation

◆ m_caloDmID

const CaloDM_ID* LArG4SDTool::m_caloDmID

protectedinherited

Definition at line 72 of file LArG4SDTool.h.

◆ m_chcollSD

LArG4SimpleSD* TBECOuterModuleTool::m_chcollSD

private

Definition at line 64 of file TBECOuterModuleTool.h.

◆ m_doPID

G4bool LArG4SDTool::m_doPID

protectedinherited

Are we set up to run with PID hits?

Definition at line 55 of file LArG4SDTool.h.

◆ m_emecoutercalc

ServiceHandle<ILArCalculatorSvc> TBECOuterModuleTool::m_emecoutercalc

private

Definition at line 56 of file TBECOuterModuleTool.h.

◆ m_emecouterchclcalc

ServiceHandle<ILArCalculatorSvc> TBECOuterModuleTool::m_emecouterchclcalc

private

Definition at line 55 of file TBECOuterModuleTool.h.

◆ m_emecoutergadjcalc

ServiceHandle<ILArCalculatorSvc> TBECOuterModuleTool::m_emecoutergadjcalc

private

Definition at line 50 of file TBECOuterModuleTool.h.

◆ m_emecoutergadjecalc

ServiceHandle<ILArCalculatorSvc> TBECOuterModuleTool::m_emecoutergadjecalc

private

Definition at line 52 of file TBECOuterModuleTool.h.

◆ m_emecoutergadjoldcalc

ServiceHandle<ILArCalculatorSvc> TBECOuterModuleTool::m_emecoutergadjoldcalc

private

Definition at line 51 of file TBECOuterModuleTool.h.

◆ m_emecoutergadjscalc

ServiceHandle<ILArCalculatorSvc> TBECOuterModuleTool::m_emecoutergadjscalc

private

Definition at line 53 of file TBECOuterModuleTool.h.

◆ m_emecoutergadjsecalc

ServiceHandle<ILArCalculatorSvc> TBECOuterModuleTool::m_emecoutergadjsecalc

private

Definition at line 54 of file TBECOuterModuleTool.h.

◆ m_gap_eSD

LArG4SimpleSD* TBECOuterModuleTool::m_gap_eSD

private

Definition at line 61 of file TBECOuterModuleTool.h.

◆ m_gap_seSD

LArG4SimpleSD* TBECOuterModuleTool::m_gap_seSD

private

Definition at line 63 of file TBECOuterModuleTool.h.

◆ m_gap_sSD

LArG4SimpleSD* TBECOuterModuleTool::m_gap_sSD

private

Definition at line 62 of file TBECOuterModuleTool.h.

◆ m_gapadjSD

LArG4SimpleSD* TBECOuterModuleTool::m_gapadjSD

private

Definition at line 59 of file TBECOuterModuleTool.h.

◆ m_gapoldSD

LArG4SimpleSD* TBECOuterModuleTool::m_gapoldSD

private

Definition at line 60 of file TBECOuterModuleTool.h.

◆ m_HitColl_chcoll

SG::WriteHandle<LArHitContainer> TBECOuterModuleTool::m_HitColl_chcoll

private

Definition at line 47 of file TBECOuterModuleTool.h.

◆ m_HitColl_gap_e

SG::WriteHandle<LArHitContainer> TBECOuterModuleTool::m_HitColl_gap_e

private

Definition at line 44 of file TBECOuterModuleTool.h.

◆ m_HitColl_gap_s

SG::WriteHandle<LArHitContainer> TBECOuterModuleTool::m_HitColl_gap_s

private

Definition at line 45 of file TBECOuterModuleTool.h.

◆ m_HitColl_gap_se

SG::WriteHandle<LArHitContainer> TBECOuterModuleTool::m_HitColl_gap_se

private

Definition at line 46 of file TBECOuterModuleTool.h.

◆ m_HitColl_gapadj

SG::WriteHandle<LArHitContainer> TBECOuterModuleTool::m_HitColl_gapadj

private

Definition at line 42 of file TBECOuterModuleTool.h.

◆ m_HitColl_gapold

SG::WriteHandle<LArHitContainer> TBECOuterModuleTool::m_HitColl_gapold

private

Definition at line 43 of file TBECOuterModuleTool.h.

◆ m_HitColl_ropt

SG::WriteHandle<LArHitContainer> TBECOuterModuleTool::m_HitColl_ropt

private

Definition at line 48 of file TBECOuterModuleTool.h.

◆ m_larEmID

const LArEM_ID* LArG4SDTool::m_larEmID

protectedinherited

Pointers to the identifier helpers.

Definition at line 69 of file LArG4SDTool.h.

◆ m_larFcalID

const LArFCAL_ID* LArG4SDTool::m_larFcalID

protectedinherited

Definition at line 70 of file LArG4SDTool.h.

◆ m_larHecID

const LArHEC_ID* LArG4SDTool::m_larHecID

protectedinherited

Definition at line 71 of file LArG4SDTool.h.

◆ m_noVolumes

Gaudi::Property<bool> SensitiveDetectorBase::m_noVolumes {this, "NoVolumes", false}

protectedinherited

This SensitiveDetector has no volumes associated with it.

Definition at line 87 of file SensitiveDetectorBase.h.

◆ m_outputCollectionNames

Gaudi::Property<std::vector<std::string> > SensitiveDetectorBase::m_outputCollectionNames {this, "OutputCollectionNames", {}}

protectedinherited

Names of all output collections written out by this SD.

Definition at line 84 of file SensitiveDetectorBase.h.

◆ m_roptSD

LArG4SimpleSD* TBECOuterModuleTool::m_roptSD

private

Definition at line 65 of file TBECOuterModuleTool.h.

◆ m_SD

G4VSensitiveDetector* SensitiveDetectorBase::m_SD {}

privateinherited

The sensitive detector to which this thing corresponds.

Definition at line 111 of file SensitiveDetectorBase.h.

◆ m_timeBinType

std::string LArG4SDTool::m_timeBinType

protectedinherited

What time binning type for regular hits?

Definition at line 57 of file LArG4SDTool.h.

◆ m_timeBinWidth

float LArG4SDTool::m_timeBinWidth

protectedinherited

What time bin width for regular hits?

Definition at line 59 of file LArG4SDTool.h.

◆ m_useFrozenShowers

G4bool LArG4SDTool::m_useFrozenShowers = false

protectedinherited

Is there going to be a fast simulation coming into this SD?

Definition at line 61 of file LArG4SDTool.h.

◆ m_volumeNames

Gaudi::Property<std::vector<std::string> > SensitiveDetectorBase::m_volumeNames {this, "LogicalVolumeNames", {}}

protectedinherited

All the volumes to which this SD is assigned.

Definition at line 82 of file SensitiveDetectorBase.h.

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

TBECOuterModuleTool.h

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Static Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ TBECOuterModuleTool()

◆ ~TBECOuterModuleTool()

Member Function Documentation

◆ assignSD()

◆ Gather()

◆ getSD()

◆ initialize()

◆ initializeCalculators()

◆ initializeSD()

◆ makeSD()

◆ match()

◆ matchStrings()

◆ setSD()

◆ SetSensitiveDetector()

◆ setupAllSDs()

◆ SetupEvent()

◆ setupHelpers() [1/2]

◆ setupHelpers() [2/2]

Member Data Documentation

◆ m_caloDmID

◆ m_chcollSD

◆ m_doPID

◆ m_emecoutercalc

◆ m_emecouterchclcalc

◆ m_emecoutergadjcalc

◆ m_emecoutergadjecalc

◆ m_emecoutergadjoldcalc

◆ m_emecoutergadjscalc

◆ m_emecoutergadjsecalc

◆ m_gap_eSD

◆ m_gap_seSD

◆ m_gap_sSD

◆ m_gapadjSD

◆ m_gapoldSD

◆ m_HitColl_chcoll

◆ m_HitColl_gap_e

◆ m_HitColl_gap_s

◆ m_HitColl_gap_se

◆ m_HitColl_gapadj

◆ m_HitColl_gapold

◆ m_HitColl_ropt

◆ m_larEmID

◆ m_larFcalID

◆ m_larHecID

◆ m_noVolumes

◆ m_outputCollectionNames

◆ m_roptSD

◆ m_SD

◆ m_timeBinType

◆ m_timeBinWidth

◆ m_useFrozenShowers

◆ m_volumeNames