TBECInnerModuleTool Class Reference

#include <TBECInnerModuleTool.h>

Inheritance diagram for TBECInnerModuleTool:

Collaboration diagram for TBECInnerModuleTool:

Public Member Functions
	TBECInnerModuleTool (const std::string &type, const std::string &name, const IInterface *parent)
virtual	~TBECInnerModuleTool ()=default
virtual 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...
virtual StatusCode	SetupEvent (HitCollectionMap &) override
virtual StatusCode	Gather (HitCollectionMap &) override

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
Gaudi::Property< G4bool >	m_doPID {this, "ParticleID", false}
	Are we set up to run with PID hits? More...
Gaudi::Property< std::string >	m_timeBinType {this, "TimeBinType", "Default"}
	What time binning type for regular hits? More...
Gaudi::Property< float >	m_timeBinWidth {this, "TimeBinWidth", 2.5*CLHEP::ns}
	What time bin width for regular hits? More...
Gaudi::Property< G4bool >	m_useFrozenShowers {this, "UseFrozenShowers", false}
	Is there going to be a fast simulation coming into this SD? More...
const LArEM_ID *	m_larEmID {nullptr}
	Pointers to the identifier helpers. More...
const LArFCAL_ID *	m_larFcalID {nullptr}
const LArHEC_ID *	m_larHecID {nullptr}
const CaloDM_ID *	m_caloDmID {nullptr}
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
	Beginning of an athena event. More...
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_emecinnergadjcalc
ServiceHandle< ILArCalculatorSvc >	m_emecinnergadjoldcalc
ServiceHandle< ILArCalculatorSvc >	m_emecinnergadjecalc
ServiceHandle< ILArCalculatorSvc >	m_emecinnergadjscalc
ServiceHandle< ILArCalculatorSvc >	m_emecinnergadjsecalc
ServiceHandle< ILArCalculatorSvc >	m_emecinnerchclcalc
ServiceHandle< ILArCalculatorSvc >	m_emecinnercalc
LArG4SimpleSD *	m_gapadjSD {nullptr}
LArG4SimpleSD *	m_gapoldSD {nullptr}
LArG4SimpleSD *	m_gap_eSD {nullptr}
LArG4SimpleSD *	m_gap_sSD {nullptr}
LArG4SimpleSD *	m_gap_seSD {nullptr}
LArG4SimpleSD *	m_chcollSD {nullptr}
LArG4SimpleSD *	m_roptSD {nullptr}
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 TBECInnerModuleTool.h.

Constructor & Destructor Documentation

TBECInnerModuleTool()

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

~TBECInnerModuleTool()

virtual TBECInnerModuleTool::~TBECInnerModuleTool ( )

virtualdefault

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

StatusCode TBECInnerModuleTool::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.

Gather() [2/2]

virtual StatusCode SensitiveDetectorBase::Gather ( HitCollectionMap &  )

inlineoverridevirtualinherited

Reimplemented in TileGeoG4SDTool, TileGeoG4CalibSDTool, SctSensorSDTool, PixelSensorSDTool, SctSensor_CTBTool, BCMSensorSDTool, BLMSensorSDTool, 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 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()

virtual StatusCode TBECInnerModuleTool::initializeCalculators ( )

finaloverridevirtual

Reimplemented from LArG4SDTool.

initializeSD()

StatusCode TBECInnerModuleTool::initializeSD ( )

finaloverride

makeSD()

G4VSensitiveDetector* LArG4SDTool::makeSD ( ) const

inlinefinaloverrideprotectedinherited

Definition at line 54 of file LArG4SDTool.h.

{ 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() [1/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 MuonWallSDTool, AFP_SensitiveDetectorTool, AFP_SiDSensitiveDetectorTool, AFP_TDSensitiveDetectorTool, CaloCellContainerSDTool, and ALFA_SensitiveDetectorTool.

Definition at line 70 of file SensitiveDetectorBase.h.

{ return StatusCode::SUCCESS; }

SetupEvent() [2/2]

virtual StatusCode SensitiveDetectorBase::SetupEvent ( HitCollectionMap &  )

inlineoverridevirtualinherited

Reimplemented in TileGeoG4SDTool, TileGeoG4CalibSDTool, SctSensorSDTool, PixelSensorSDTool, SctSensor_CTBTool, BCMSensorSDTool, BLMSensorSDTool, and TRTSensitiveDetectorTool.

Definition at line 71 of file SensitiveDetectorBase.h.

                                                            {
    return SetupEvent();
  }

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 {nullptr}

protectedinherited

Definition at line 74 of file LArG4SDTool.h.

m_chcollSD

LArG4SimpleSD* TBECInnerModuleTool::m_chcollSD {nullptr}

private

Definition at line 75 of file TBECInnerModuleTool.h.

m_doPID

Gaudi::Property<G4bool> LArG4SDTool::m_doPID {this, "ParticleID", false}

protectedinherited

Are we set up to run with PID hits?

Definition at line 57 of file LArG4SDTool.h.

m_emecinnercalc

ServiceHandle<ILArCalculatorSvc> TBECInnerModuleTool::m_emecinnercalc

private

Initial value:

{this, "EMECPosInnerWheelCalculator"
    , "EMECPosInnerWheelCalculator"}

Definition at line 66 of file TBECInnerModuleTool.h.

m_emecinnerchclcalc

ServiceHandle<ILArCalculatorSvc> TBECInnerModuleTool::m_emecinnerchclcalc

private

Initial value:

{this, "EMECPosInnerWheel_ECOR_CHCLCalculator"
    , "EMECPosInnerWheel_ECOR_CHCLCalculator"}

Definition at line 64 of file TBECInnerModuleTool.h.

m_emecinnergadjcalc

ServiceHandle<ILArCalculatorSvc> TBECInnerModuleTool::m_emecinnergadjcalc

private

Initial value:

{this, "EMECPosInnerWheel_ECOR_GADJCalculator"
    , "EMECPosInnerWheel_ECOR_GADJCalculator"}

Definition at line 54 of file TBECInnerModuleTool.h.

m_emecinnergadjecalc

ServiceHandle<ILArCalculatorSvc> TBECInnerModuleTool::m_emecinnergadjecalc

private

Initial value:

{this, "EMECPosInnerWheel_ECOR_GADJ_ECalculator"
    , "EMECPosInnerWheel_ECOR_GADJ_ECalculator"}

Definition at line 58 of file TBECInnerModuleTool.h.

m_emecinnergadjoldcalc

ServiceHandle<ILArCalculatorSvc> TBECInnerModuleTool::m_emecinnergadjoldcalc

private

Initial value:

{this, "EMECPosInnerWheel_ECOR_GADJ_OLDCalculator"
    , "EMECPosInnerWheel_ECOR_GADJ_OLDCalculator"}

Definition at line 56 of file TBECInnerModuleTool.h.

m_emecinnergadjscalc

ServiceHandle<ILArCalculatorSvc> TBECInnerModuleTool::m_emecinnergadjscalc

private

Initial value:

{this, "EMECPosInnerWheel_ECOR_GADJ_SCalculator"
    , "EMECPosInnerWheel_ECOR_GADJ_SCalculator"}

Definition at line 60 of file TBECInnerModuleTool.h.

m_emecinnergadjsecalc

ServiceHandle<ILArCalculatorSvc> TBECInnerModuleTool::m_emecinnergadjsecalc

private

Initial value:

{this, "EMECPosInnerWheel_ECOR_GADJ_SECalculator"
    , "EMECPosInnerWheel_ECOR_GADJ_SECalculator"}

Definition at line 62 of file TBECInnerModuleTool.h.

m_gap_eSD

LArG4SimpleSD* TBECInnerModuleTool::m_gap_eSD {nullptr}

private

Definition at line 72 of file TBECInnerModuleTool.h.

m_gap_seSD

LArG4SimpleSD* TBECInnerModuleTool::m_gap_seSD {nullptr}

private

Definition at line 74 of file TBECInnerModuleTool.h.

m_gap_sSD

LArG4SimpleSD* TBECInnerModuleTool::m_gap_sSD {nullptr}

private

Definition at line 73 of file TBECInnerModuleTool.h.

m_gapadjSD

LArG4SimpleSD* TBECInnerModuleTool::m_gapadjSD {nullptr}

private

Definition at line 70 of file TBECInnerModuleTool.h.

m_gapoldSD

LArG4SimpleSD* TBECInnerModuleTool::m_gapoldSD {nullptr}

private

Definition at line 71 of file TBECInnerModuleTool.h.

m_HitColl_chcoll

SG::WriteHandle<LArHitContainer> TBECInnerModuleTool::m_HitColl_chcoll

private

Definition at line 51 of file TBECInnerModuleTool.h.

m_HitColl_gap_e

SG::WriteHandle<LArHitContainer> TBECInnerModuleTool::m_HitColl_gap_e

private

Definition at line 48 of file TBECInnerModuleTool.h.

m_HitColl_gap_s

SG::WriteHandle<LArHitContainer> TBECInnerModuleTool::m_HitColl_gap_s

private

Definition at line 49 of file TBECInnerModuleTool.h.

m_HitColl_gap_se

SG::WriteHandle<LArHitContainer> TBECInnerModuleTool::m_HitColl_gap_se

private

Definition at line 50 of file TBECInnerModuleTool.h.

m_HitColl_gapadj

SG::WriteHandle<LArHitContainer> TBECInnerModuleTool::m_HitColl_gapadj

private

Beginning of an athena event.

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

Definition at line 46 of file TBECInnerModuleTool.h.

m_HitColl_gapold

SG::WriteHandle<LArHitContainer> TBECInnerModuleTool::m_HitColl_gapold

private

Definition at line 47 of file TBECInnerModuleTool.h.

m_HitColl_ropt

SG::WriteHandle<LArHitContainer> TBECInnerModuleTool::m_HitColl_ropt

private

Definition at line 52 of file TBECInnerModuleTool.h.

m_larEmID

const LArEM_ID* LArG4SDTool::m_larEmID {nullptr}

protectedinherited

Pointers to the identifier helpers.

Definition at line 71 of file LArG4SDTool.h.

m_larFcalID

const LArFCAL_ID* LArG4SDTool::m_larFcalID {nullptr}

protectedinherited

Definition at line 72 of file LArG4SDTool.h.

m_larHecID

const LArHEC_ID* LArG4SDTool::m_larHecID {nullptr}

protectedinherited

Definition at line 73 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 101 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 98 of file SensitiveDetectorBase.h.

m_roptSD

LArG4SimpleSD* TBECInnerModuleTool::m_roptSD {nullptr}

private

Definition at line 76 of file TBECInnerModuleTool.h.

m_SD

G4VSensitiveDetector* SensitiveDetectorBase::m_SD {}

privateinherited

The sensitive detector to which this thing corresponds.

Definition at line 125 of file SensitiveDetectorBase.h.

m_timeBinType

Gaudi::Property<std::string> LArG4SDTool::m_timeBinType {this, "TimeBinType", "Default"}

protectedinherited

What time binning type for regular hits?

Definition at line 59 of file LArG4SDTool.h.

m_timeBinWidth

Gaudi::Property<float> LArG4SDTool::m_timeBinWidth {this, "TimeBinWidth", 2.5*CLHEP::ns}

protectedinherited

What time bin width for regular hits?

Definition at line 61 of file LArG4SDTool.h.

m_useFrozenShowers

Gaudi::Property<G4bool> LArG4SDTool::m_useFrozenShowers {this, "UseFrozenShowers", false}

protectedinherited

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

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

---

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

• TBECInnerModuleTool.h