AFP_SiDSensitiveDetectorTool Class Reference

#include <AFP_SiDSensitiveDetectorTool.h>

Inheritance diagram for AFP_SiDSensitiveDetectorTool:

Collaboration diagram for AFP_SiDSensitiveDetectorTool:

Public Member Functions
	AFP_SiDSensitiveDetectorTool (const std::string &type, const std::string &name, const IInterface *parent)
	~AFP_SiDSensitiveDetectorTool ()
StatusCode	SetupEvent () override final
	Beginning of an athena event.
StatusCode	Gather () override final
	End of an athena event.
StatusCode	initializeSD () override
	Setup an SD in the current thread.
virtual StatusCode	SetupEvent (HitCollectionMap &) override
virtual StatusCode	Gather (HitCollectionMap &) override

Protected Member Functions
G4VSensitiveDetector *	makeSD () const override final
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
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

Definition at line 16 of file AFP_SiDSensitiveDetectorTool.h.

Constructor & Destructor Documentation

AFP_SiDSensitiveDetectorTool()

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

Definition at line 14 of file AFP_SiDSensitiveDetectorTool.cxx.

  : SensitiveDetectorBase(type,name,parent)
{
}

~AFP_SiDSensitiveDetectorTool()

AFP_SiDSensitiveDetectorTool::~AFP_SiDSensitiveDetectorTool ( )

inline

Definition at line 23 of file AFP_SiDSensitiveDetectorTool.h.

{}

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
  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 " << 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() [1/2]

StatusCode AFP_SiDSensitiveDetectorTool::Gather ( )

finaloverridevirtual

End of an athena event.

Reimplemented from SensitiveDetectorBase.

Definition at line 44 of file AFP_SiDSensitiveDetectorTool.cxx.

{
  ATH_MSG_VERBOSE( "AFP_SiDSensitiveDetectorTool::Gather()" );
  if(!getSD())
    {
      ATH_MSG_ERROR ("Gather: AFP_SiDSensitiveDetector never created!");
      return StatusCode::FAILURE;
    }
  else
    {
      AFP_SiDSensitiveDetector *localSD = dynamic_cast<AFP_SiDSensitiveDetector*>(getSD());
      if(!localSD)
        {
          ATH_MSG_ERROR ("Gather: Failed to cast m_SD into AFP_SiDSensitiveDetector.");
          return StatusCode::FAILURE;
        }
      localSD->EndOfAthenaEvent();
    }
  return StatusCode::SUCCESS;
}

Gather() [2/2]

virtual StatusCode SensitiveDetectorBase::Gather ( HitCollectionMap & )

inlineoverridevirtualinherited

Reimplemented in BCMSensorSDTool, BLMSensorSDTool, CSCSensitiveDetectorCosmicsTool, CSCSensitiveDetectorTool, GenericMuonSensitiveDetectorTool, MDTSensitiveDetectorCosmicsTool, MDTSensitiveDetectorTool, MicromegasSensitiveDetectorTool, PixelSensorSDTool, RPCSensitiveDetectorCosmicsTool, RPCSensitiveDetectorTool, SctSensor_CTBTool, SctSensorSDTool, sTGCSensitiveDetectorTool, TGCSensitiveDetectorCosmicsTool, TGCSensitiveDetectorTool, TileGeoG4CalibSDTool, TileGeoG4SDTool, and TRTSensitiveDetectorTool.

Definition at line 79 of file SensitiveDetectorBase.h.

                                                        {
    return Gather();
  };

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 120 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
}

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 * AFP_SiDSensitiveDetectorTool::makeSD ( ) const

finaloverrideprotected

Definition at line 67 of file AFP_SiDSensitiveDetectorTool.cxx.

{
  ATH_MSG_DEBUG( "Initializing SD" );
  // Create a fresh SD
  return new AFP_SiDSensitiveDetector(name(), m_outputCollectionNames[0]);
}

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 147 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 134 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 174 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 AFP_SiDSensitiveDetectorTool::SetupEvent ( )

finaloverridevirtual

Beginning of an athena event.

This is where collection initialization should happen.

Reimplemented from SensitiveDetectorBase.

Definition at line 21 of file AFP_SiDSensitiveDetectorTool.cxx.

{
  ATH_MSG_VERBOSE( "AFP_SiDSensitiveDetectorTool::SetupEvent()" );
  if(!getSD())
    {
      ATH_MSG_ERROR ("SetupEvent: AFP_SiDSensitiveDetector never created!");
      return StatusCode::FAILURE;
    }
  else
    {
      AFP_SiDSensitiveDetector *localSD = dynamic_cast<AFP_SiDSensitiveDetector*>(getSD());
      if(!localSD)
        {
          ATH_MSG_ERROR ("SetupEvent: Failed to cast m_SD into AFP_SiDSensitiveDetector.");
          return StatusCode::FAILURE;
        }
      localSD->StartOfAthenaEvent();
    }
  return StatusCode::SUCCESS;
}

SetupEvent() [2/2]

virtual StatusCode SensitiveDetectorBase::SetupEvent ( HitCollectionMap & )

inlineoverridevirtualinherited

Reimplemented in BCMSensorSDTool, BLMSensorSDTool, CSCSensitiveDetectorCosmicsTool, CSCSensitiveDetectorTool, GenericMuonSensitiveDetectorTool, MDTSensitiveDetectorCosmicsTool, MDTSensitiveDetectorTool, MicromegasSensitiveDetectorTool, PixelSensorSDTool, RPCSensitiveDetectorCosmicsTool, RPCSensitiveDetectorTool, SctSensor_CTBTool, SctSensorSDTool, sTGCSensitiveDetectorTool, TGCSensitiveDetectorCosmicsTool, TGCSensitiveDetectorTool, TileGeoG4CalibSDTool, TileGeoG4SDTool, and TRTSensitiveDetectorTool.

Definition at line 71 of file SensitiveDetectorBase.h.

                                                            {
    return SetupEvent();
  }

Member Data Documentation

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.

{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.

{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.

{};

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.

{this, "LogicalVolumeNames", {}};

---

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

• AFP_SiDSensitiveDetectorTool.h
• AFP_SiDSensitiveDetectorTool.cxx