DEPRECATED AND WILL BE REMOVED. More...

#include <LArG4H62004FCALSDTool.h>

Inheritance diagram for LArG4H62004FCALSDTool:

Collaboration diagram for LArG4H62004FCALSDTool:

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

virtual	~LArG4H62004FCALSDTool ()

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
StatusCode	initializeCalculators () override final

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

ServiceHandle< ILArCalculatorSvc >	m_fcal1calc

ServiceHandle< ILArCalculatorSvc >	m_fcal2calc

ServiceHandle< ILArCalculatorSvc >	m_fcalcoldcalc

LArG4SimpleSD *	m_fcal1SD

LArG4SimpleSD *	m_fcal2SD

LArG4SimpleSD *	m_fcalColdSD

std::vector< std::string >	m_fcal1Volumes

std::vector< std::string >	m_fcal2Volumes

std::vector< std::string >	m_fcalColdVolumes

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

Detailed Description

DEPRECATED AND WILL BE REMOVED.

Please see LArG4::H62004FCALSDTool instead.

Definition at line 21 of file LArG4H62004FCALSDTool.h.

Constructor & Destructor Documentation

◆ LArG4H62004FCALSDTool()

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

◆ ~LArG4H62004FCALSDTool()

virtual LArG4H62004FCALSDTool::~LArG4H62004FCALSDTool ( )

inlinevirtual

Definition at line 28 of file LArG4H62004FCALSDTool.h.

28 {}

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 LArG4H62004FCALSDTool::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 LArG4H62004FCALSDTool::initializeCalculators ( )

finaloverrideprivatevirtual

Reimplemented from LArG4SDTool.

◆ initializeSD()

StatusCode LArG4H62004FCALSDTool::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_doPID

G4bool LArG4SDTool::m_doPID

protectedinherited

Are we set up to run with PID hits?

Definition at line 55 of file LArG4SDTool.h.

◆ m_fcal1calc

ServiceHandle<ILArCalculatorSvc> LArG4H62004FCALSDTool::m_fcal1calc

private

Definition at line 42 of file LArG4H62004FCALSDTool.h.

◆ m_fcal1SD

LArG4SimpleSD* LArG4H62004FCALSDTool::m_fcal1SD

private

Definition at line 46 of file LArG4H62004FCALSDTool.h.

◆ m_fcal1Volumes

std::vector<std::string> LArG4H62004FCALSDTool::m_fcal1Volumes

private

Definition at line 49 of file LArG4H62004FCALSDTool.h.

◆ m_fcal2calc

ServiceHandle<ILArCalculatorSvc> LArG4H62004FCALSDTool::m_fcal2calc

private

Definition at line 43 of file LArG4H62004FCALSDTool.h.

◆ m_fcal2SD

LArG4SimpleSD* LArG4H62004FCALSDTool::m_fcal2SD

private

Definition at line 47 of file LArG4H62004FCALSDTool.h.

◆ m_fcal2Volumes

std::vector<std::string> LArG4H62004FCALSDTool::m_fcal2Volumes

private

Definition at line 50 of file LArG4H62004FCALSDTool.h.

◆ m_fcalcoldcalc

ServiceHandle<ILArCalculatorSvc> LArG4H62004FCALSDTool::m_fcalcoldcalc

private

Definition at line 44 of file LArG4H62004FCALSDTool.h.

◆ m_fcalColdSD

LArG4SimpleSD* LArG4H62004FCALSDTool::m_fcalColdSD

private

Definition at line 48 of file LArG4H62004FCALSDTool.h.

◆ m_fcalColdVolumes

std::vector<std::string> LArG4H62004FCALSDTool::m_fcalColdVolumes

private

Definition at line 51 of file LArG4H62004FCALSDTool.h.

◆ m_HitColl

SG::WriteHandle<LArHitContainer> LArG4H62004FCALSDTool::m_HitColl

private

Definition at line 40 of file LArG4H62004FCALSDTool.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_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:

LArG4H62004FCALSDTool.h

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Static Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ LArG4H62004FCALSDTool()

◆ ~LArG4H62004FCALSDTool()

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_doPID

◆ m_fcal1calc

◆ m_fcal1SD

◆ m_fcal1Volumes

◆ m_fcal2calc

◆ m_fcal2SD

◆ m_fcal2Volumes

◆ m_fcalcoldcalc

◆ m_fcalColdSD

◆ m_fcalColdVolumes

◆ m_HitColl

◆ m_larEmID

◆ m_larFcalID

◆ m_larHecID

◆ m_noVolumes

◆ m_outputCollectionNames

◆ m_SD

◆ m_timeBinType

◆ m_timeBinWidth

◆ m_useFrozenShowers

◆ m_volumeNames