DEPRECATED AND WILL BE REMOVED. More...

#include <LArG4H62004EMECSDTool.h>

Inheritance diagram for LArG4H62004EMECSDTool:

Collaboration diagram for LArG4H62004EMECSDTool:

Public Member Functions
	LArG4H62004EMECSDTool (const std::string &type, const std::string &name, const IInterface *parent)
virtual	~LArG4H62004EMECSDTool ()=default
StatusCode	initializeSD () override final
StatusCode	Gather () override final
	End of an athena event.
StatusCode	initialize () override final
void	setupHelpers (LArG4SimpleSD *) const
	Helper method to pass the ID helper pointers to the SDs.
void	setupHelpers (LArG4CalibSD *) const
	Overload of the above method for calib SDs.
virtual StatusCode	SetupEvent () override
	Beginning of an athena event.
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:
bool	match (const char first, const char second) const
	Helper function for matching strings with wildcards.
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< G4bool >	m_doPID {this, "ParticleID", false}
	Are we set up to run with PID hits?
Gaudi::Property< std::string >	m_timeBinType {this, "TimeBinType", "Default"}
	What time binning type for regular hits?
Gaudi::Property< float >	m_timeBinWidth {this, "TimeBinWidth", 2.5*CLHEP::ns}
	What time bin width for regular hits?
Gaudi::Property< G4bool >	m_useFrozenShowers {this, "UseFrozenShowers", false}
	Is there going to be a fast simulation coming into this SD?
const LArEM_ID *	m_larEmID {nullptr}
	Pointers to the identifier helpers.
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.
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
StatusCode	initializeCalculators () override final
	Beginning of an athena event.
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
SG::WriteHandle< LArHitContainer >	m_HitColl
ServiceHandle< ILArCalculatorSvc >	m_calculator {this, "Calculator", "EMECPosInnerWheel_ECOR_GADJCalculator"}
LArG4SimpleSD *	m_emecSD {nullptr}
G4VSensitiveDetector *	m_SD {}
	The sensitive detector to which this thing corresponds.

Detailed Description

DEPRECATED AND WILL BE REMOVED.

Please see LArG4::H62004EMECSDTool instead.

Definition at line 22 of file LArG4H62004EMECSDTool.h.

Constructor & Destructor Documentation

◆ LArG4H62004EMECSDTool()

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

◆ ~LArG4H62004EMECSDTool()

virtual LArG4H62004EMECSDTool::~LArG4H62004EMECSDTool ( )

virtualdefault

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 LArG4H62004EMECSDTool::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 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
}

◆ initialize()

StatusCode LArG4SDTool::initialize ( )

finaloverrideinherited

◆ initializeCalculators()

StatusCode LArG4H62004EMECSDTool::initializeCalculators ( )

finaloverrideprivatevirtual

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

◆ initializeSD()

StatusCode LArG4H62004EMECSDTool::initializeSD ( )

finaloverride

◆ makeSD()

G4VSensitiveDetector * LArG4SDTool::makeSD ( ) const

inlinefinaloverrideprotectedinherited

Definition at line 54 of file LArG4SDTool.h.

54{ 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 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);
        }
    }
}

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

Definition at line 70 of file SensitiveDetectorBase.h.

70{ 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();
  }

◆ 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_calculator

ServiceHandle<ILArCalculatorSvc> LArG4H62004EMECSDTool::m_calculator {this, "Calculator", "EMECPosInnerWheel_ECOR_GADJCalculator"}

private

Definition at line 46 of file LArG4H62004EMECSDTool.h.

46{this, "Calculator", "EMECPosInnerWheel_ECOR_GADJCalculator"};

◆ m_caloDmID

const CaloDM_ID* LArG4SDTool::m_caloDmID {nullptr}

protectedinherited

Definition at line 74 of file LArG4SDTool.h.

74{nullptr};

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

57{this, "ParticleID", false};

◆ m_emecSD

LArG4SimpleSD* LArG4H62004EMECSDTool::m_emecSD {nullptr}

private

Definition at line 47 of file LArG4H62004EMECSDTool.h.

47{nullptr};

◆ m_HitColl

SG::WriteHandle<LArHitContainer> LArG4H62004EMECSDTool::m_HitColl

private

Definition at line 45 of file LArG4H62004EMECSDTool.h.

◆ m_larEmID

const LArEM_ID* LArG4SDTool::m_larEmID {nullptr}

protectedinherited

Pointers to the identifier helpers.

Definition at line 71 of file LArG4SDTool.h.

71{nullptr};

◆ m_larFcalID

const LArFCAL_ID* LArG4SDTool::m_larFcalID {nullptr}

protectedinherited

Definition at line 72 of file LArG4SDTool.h.

72{nullptr};

◆ m_larHecID

const LArHEC_ID* LArG4SDTool::m_larHecID {nullptr}

protectedinherited

Definition at line 73 of file LArG4SDTool.h.

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

59{this, "TimeBinType", "Default"};

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

61{this, "TimeBinWidth", 2.5*CLHEP::ns};

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

63{this, "UseFrozenShowers", false};

◆ 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 file:

LArG4H62004EMECSDTool.h

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Static Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ LArG4H62004EMECSDTool()

◆ ~LArG4H62004EMECSDTool()

Member Function Documentation

◆ assignSD()

◆ Gather() [1/2]

◆ Gather() [2/2]

◆ getSD()

◆ initialize()

◆ initializeCalculators()

◆ initializeSD()

◆ makeSD()

◆ match()

◆ matchStrings()

◆ setSD()

◆ SetSensitiveDetector()

◆ setupAllSDs()

◆ SetupEvent() [1/2]

◆ SetupEvent() [2/2]

◆ setupHelpers() [1/2]

◆ setupHelpers() [2/2]

Member Data Documentation

◆ m_calculator

◆ m_caloDmID

◆ m_doPID

◆ m_emecSD

◆ m_HitColl

◆ m_larEmID

◆ m_larFcalID

◆ m_larHecID

◆ m_noVolumes

◆ m_outputCollectionNames

◆ m_SD

◆ m_timeBinType

◆ m_timeBinWidth

◆ m_useFrozenShowers

◆ m_volumeNames