MuonG4R4::MuonSensitiveDetectorTool Class Reference

Baseline MuonSensitive detector tool to store the sim hits. More...

#include <MuonSensitiveDetectorTool.h>

Inheritance diagram for MuonG4R4::MuonSensitiveDetectorTool:

Collaboration diagram for MuonG4R4::MuonSensitiveDetectorTool:

Public Member Functions
	~MuonSensitiveDetectorTool ()=default
	Default the destructor.
virtual StatusCode	initialize () override final
virtual StatusCode	SetupEvent (HitCollectionMap &hitCollections) override final
	Beginning of an athena event.
virtual StatusCode	Gather (HitCollectionMap &hitCollections) override final
	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
StatusCode	assignSD (std::unique_ptr< G4VSensitiveDetector > sd, const std::vector< std::string > &volumes) const
	Assign SD to a list of volumes.
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.

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

Detailed Description

Baseline MuonSensitive detector tool to store the sim hits.

The individual implementations need to inherit from this tool. The tool takes care to write the SimHit container into the G4 HitCollection and to retrieve the detector manager and to initialize the alignment key pointing to the alignment store with all local -> global transformations of each sensitive volume

Definition at line 23 of file MuonSensitiveDetectorTool.h.

Constructor & Destructor Documentation

~MuonSensitiveDetectorTool()

MuonG4R4::MuonSensitiveDetectorTool::~MuonSensitiveDetectorTool ( )

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 55 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()

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

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.

Definition at line 20 of file MuonSensitiveDetectorTool.cxx.

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

initialize()

StatusCode MuonG4R4::MuonSensitiveDetectorTool::initialize ( )

finaloverridevirtual

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 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;
    }
  // 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;
}

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 115 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 )

Use the standard AthAlgTool constructors.

Definition at line 44 of file SensitiveDetectorBase.cxx.

  : base_class(type,name,parent)
{
}

SetSensitiveDetector()

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

protectedinherited

Method stolen from G4VUserDetectorConstruction in G4 10.2.

Definition at line 142 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()

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

finaloverridevirtual

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

Member Data Documentation

m_alignStoreKey

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

protected

: Key to the alignment / transform store per event.

Definition at line 40 of file MuonSensitiveDetectorTool.h.

{this, "AlignStoreKey", ""};

m_detMgr

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

protected

The muon detector manager to retrieve the sensitive elements.

Definition at line 38 of file MuonSensitiveDetectorTool.h.

{nullptr};

m_noVolumes

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

protectedinherited

This SensitiveDetector has no volumes associated with it.

Definition at line 83 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 80 of file SensitiveDetectorBase.h.

{this, "OutputCollectionNames", {}};

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

{this, "LogicalVolumeNames", {}};

---

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

• MuonSensitiveDetectorTool.h
• MuonSensitiveDetectorTool.cxx