Tool implementation that creates the Rpc sensitive detector. More...

#include <RpcSensitiveDetectorTool.h>

Inheritance diagram for MuonG4R4::RpcSensitiveDetectorTool:

Collaboration diagram for MuonG4R4::RpcSensitiveDetectorTool:

Public Member Functions
	~RpcSensitiveDetectorTool ()=default
	Default the destructor.
virtual StatusCode	initialize () override final
virtual StatusCode	SetupEvent (HitCollectionMap &hitCollections) override final
	Beginning of an athena event.
virtual StatusCode	SetupEvent () override
	Beginning of an athena event.
virtual StatusCode	Gather (HitCollectionMap &hitCollections) override final
	End of an athena event.
virtual StatusCode	Gather () override
	End of an athena event.
	SensitiveDetectorBase (const std::string &type, const std::string &name, const IInterface *parent)
	Use the standard AthAlgTool constructors.
StatusCode	initializeSD () override
	Setup an SD in the current thread.

Protected Member Functions
G4VSensitiveDetector *	makeSD () const override final
	Override the hook creating the sensitive detector to return a new RpcSensitiveDetector instance.
StatusCode	assignSD (std::unique_ptr< G4VSensitiveDetector > sd, const std::vector< std::string > &volumes) const
	Assign SD to a list of volumes.
G4VSensitiveDetector *	getSD ()
	Retrieve the current SD.
void	SetSensitiveDetector (G4LogicalVolume , G4VSensitiveDetector ) const
	Method stolen from G4VUserDetectorConstruction in G4 10.2.

Protected Attributes
const MuonGMR4::MuonDetectorManager *	m_detMgr {nullptr}
	The muon detector manager to retrieve the sensitive elements.
Gaudi::Property< std::string >	m_alignStoreKey {this, "AlignStoreKey", ""}
	: Key to the alignment / transform store per event.
Gaudi::Property< std::vector< std::string > >	m_volumeNames {this, "LogicalVolumeNames", {}}
	All the volumes to which this SD is assigned.
Gaudi::Property< std::vector< std::string > >	m_outputCollectionNames {this, "OutputCollectionNames", {}}
	Names of all output collections written out by this SD.
Gaudi::Property< bool >	m_noVolumes {this, "NoVolumes", false}
	This SensitiveDetector has no volumes associated with it.

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

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

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

Detailed Description

Tool implementation that creates the Rpc sensitive detector.

Definition at line 11 of file RpcSensitiveDetectorTool.h.

Constructor & Destructor Documentation

◆ ~RpcSensitiveDetectorTool()

MuonG4R4::RpcSensitiveDetectorTool::~RpcSensitiveDetectorTool ( )

default

Default the destructor.

Member Function Documentation

◆ assignSD()

StatusCode SensitiveDetectorBase::assignSD	(	std::unique_ptr< 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 64 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();
  auto sdPtr = sd.get();
  // SDManager is now the SD owner
  //for later use
  auto sdName = sd->GetName();
  sdMgr->AddNewDetector(sd.release());
 
  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, sdPtr);
        }
        
      }
      // 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 " << sdName << " 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() [1/2]

StatusCode MuonG4R4::MuonSensitiveDetectorTool::Gather ( HitCollectionMap & hitCollections )

finaloverridevirtualinherited

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.

Definition at line 20 of file MuonSensitiveDetectorTool.cxx.

                                                                                 {
        return hitCollections.Record<MuonSimHitsVec>(m_outputCollectionNames[0]);
    }

◆ Gather() [2/2]

virtual StatusCode SensitiveDetectorBase::Gather ( )

inlineoverridevirtualinherited

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 in AFP_SensitiveDetectorTool, AFP_SiDSensitiveDetectorTool, AFP_TDSensitiveDetectorTool, ALFA_SensitiveDetectorTool, CaloCellContainerSDTool, FCS_Param::FCS_StepInfoSDTool, MinBiasScintillatorSDTool, MuonWallSDTool, ZDC_FiberSDTool, and ZDC_G4CalibSDTool.

Definition at line 78 of file SensitiveDetectorBase.h.

78{ return StatusCode::SUCCESS; }

◆ 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 122 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 MuonG4R4::MuonSensitiveDetectorTool::initialize ( )

finaloverridevirtualinherited

Definition at line 10 of file MuonSensitiveDetectorTool.cxx.

                                                     {
        ATH_CHECK(SensitiveDetectorBase::initialize());
        ATH_CHECK(detStore()->retrieve(m_detMgr));
        return StatusCode::SUCCESS;
    }

◆ initializeSD()

StatusCode SensitiveDetectorBase::initializeSD ( )

overrideinherited

Setup an SD in the current thread.

Separate from the AthAlgTool initialize() method because it needs to be called once per worker thread in AthenaMT. Don't confuse this with the G4 SD method Initialize which is called at the beginning of every G4 event.

Definition at line 25 of file SensitiveDetectorBase.cxx.

{
  ATH_MSG_VERBOSE( name() << "::initializeSD()" );
 
  // Sanity check for volume configuration problems.
  // It would be better to have a more robust solution for this.
  if(m_volumeNames.empty() != m_noVolumes) {
    ATH_MSG_ERROR("Initializing SD from " << name() << ", NoVolumes = "
                  << (m_noVolumes? "true" : "false") << ", but LogicalVolumeNames = "
                  << m_volumeNames.value());
    return StatusCode::FAILURE;
  }
 
  // Make sure SD isn't already registered
  if(getSD())
    {
      ATH_MSG_ERROR("Trying to create a SD which already exists!");
      return StatusCode::FAILURE;
    }
 
  // Make the SD stored by this tool
  auto sd = std::unique_ptr<G4VSensitiveDetector>(makeSD());
  if(!sd)
    {
      ATH_MSG_ERROR("Failed to create SD!");
      return StatusCode::FAILURE;
    }
  setSD(sd.get());
 
  // Assign the SD to our list of volumes
  ATH_CHECK( assignSD( std::move(sd), m_volumeNames.value() ) );
 
  ATH_MSG_DEBUG( "Initialized and added SD " << name() );
  return StatusCode::SUCCESS;
}

◆ makeSD()

G4VSensitiveDetector * MuonG4R4::RpcSensitiveDetectorTool::makeSD ( ) const

finaloverrideprotected

Override the hook creating the sensitive detector to return a new RpcSensitiveDetector instance.

Definition at line 9 of file RpcSensitiveDetectorTool.cxx.

                                                             {
  return new RpcSensitiveDetector(name(), m_outputCollectionNames[0], m_alignStoreKey, m_detMgr);
}

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

◆ SensitiveDetectorBase()

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

inherited

Use the standard AthAlgTool constructors.

Definition at line 55 of file SensitiveDetectorBase.cxx.

  : base_class(type,name,parent)
{
}

◆ setSD()

void SensitiveDetectorBase::setSD ( G4VSensitiveDetector * sd )

privateinherited

Set the current SD.

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

Definition at line 136 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 176 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();
          msd = new G4MultiSensitiveDetector(std::move(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);
        }
    }
}

◆ SetupEvent() [1/2]

StatusCode MuonG4R4::MuonSensitiveDetectorTool::SetupEvent ( HitCollectionMap & hitCollections )

finaloverridevirtualinherited

Beginning of an athena event.

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

Reimplemented from SensitiveDetectorBase.

Definition at line 15 of file MuonSensitiveDetectorTool.cxx.

                                                                                     {
        hitCollections.Emplace<MuonSimHitsVec>(m_outputCollectionNames[0]);
 
        return StatusCode::SUCCESS;
    }

◆ SetupEvent() [2/2]

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 AFP_SensitiveDetectorTool, AFP_SiDSensitiveDetectorTool, AFP_TDSensitiveDetectorTool, ALFA_SensitiveDetectorTool, CaloCellContainerSDTool, and MuonWallSDTool.

Definition at line 70 of file SensitiveDetectorBase.h.

70{ return StatusCode::SUCCESS; }

Member Data Documentation

◆ m_alignStoreKey

Gaudi::Property<std::string> MuonG4R4::MuonSensitiveDetectorTool::m_alignStoreKey {this, "AlignStoreKey", ""}

protectedinherited

: Key to the alignment / transform store per event.

Definition at line 40 of file MuonSensitiveDetectorTool.h.

40{this, "AlignStoreKey", ""};

◆ m_detMgr

const MuonGMR4::MuonDetectorManager* MuonG4R4::MuonSensitiveDetectorTool::m_detMgr {nullptr}

protectedinherited

The muon detector manager to retrieve the sensitive elements.

Definition at line 38 of file MuonSensitiveDetectorTool.h.

38{nullptr};

◆ m_noVolumes

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

protectedinherited

This SensitiveDetector has no volumes associated with it.

Definition at line 101 of file SensitiveDetectorBase.h.

101{this, "NoVolumes", false};

◆ 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 98 of file SensitiveDetectorBase.h.

98{this, "OutputCollectionNames", {}};

◆ m_SD

G4VSensitiveDetector* SensitiveDetectorBase::m_SD {}

privateinherited

The sensitive detector to which this thing corresponds.

Definition at line 125 of file SensitiveDetectorBase.h.

125{};

◆ 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 96 of file SensitiveDetectorBase.h.

96{this, "LogicalVolumeNames", {}};

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

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Static Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ~RpcSensitiveDetectorTool()

Member Function Documentation

◆ assignSD()

◆ Gather() [1/2]

◆ Gather() [2/2]

◆ getSD()

◆ initialize()

◆ initializeSD()

◆ makeSD()

◆ matchStrings()

◆ SensitiveDetectorBase()

◆ setSD()

◆ SetSensitiveDetector()

◆ SetupEvent() [1/2]

◆ SetupEvent() [2/2]

Member Data Documentation

◆ m_alignStoreKey

◆ m_detMgr

◆ m_noVolumes

◆ m_outputCollectionNames

◆ m_SD

◆ m_volumeNames