Class for shower library service. More...

#include <LArG4ShowerLibSvc.h>

Inheritance diagram for LArG4ShowerLibSvc:

Collaboration diagram for LArG4ShowerLibSvc:

Public Member Functions
	LArG4ShowerLibSvc (const std::string &name, ISvcLocator *svc)

virtual	~LArG4ShowerLibSvc ()

virtual StatusCode	initialize ()

virtual StatusCode	finalize ()

virtual bool	checkLibrary (G4int particleCode, int detectorTag)

virtual std::vector< EnergySpot >	getShower (const G4FastTrack &track, int detectorTag) const
	return list of energy depositions for given track (interface implementation) More...

virtual double	getContainmentZ (const G4FastTrack &track, int detectorTag)

virtual double	getContainmentR (const G4FastTrack &track, int detectorTag)

Private Types
typedef std::map< int, const ShowerLib::IShowerLib * >	libmap

typedef std::map< const ShowerLib::IShowerLib , ShowerLib::ShowerLibStatistics >	statmap

Private Member Functions
const ShowerLib::IShowerLib *	getShowerLib (G4int particleCode, int detectorTag) const
	get shower library from StoreGate by track (using current volume name) More...

Private Attributes
libmap	m_libraryMap
	mapping StoreGate key to handle in StoreGate More...

statmap	m_statisticsMap

std::map< int, std::string >	m_locations

std::map< std::string, int >	m_detmap

StringArrayProperty	m_fileNameList
	property, list of library files More...

Detailed Description

Class for shower library service.

   Converts tracks into a list of energy deposits 
   using frozen shower libraries.

Author: Wolfgang Ehrenfeld, University of Hamburg, Germany; Sasha Glazov, DESY Hamburg, Germany

Version

Id: LArG4ShowerLibSvc.h 576157 2013-12-18 16:57:49Z gsedov

Definition at line 41 of file LArG4ShowerLibSvc.h.

Member Typedef Documentation

◆ libmap

typedef std::map<int, const ShowerLib::IShowerLib*> LArG4ShowerLibSvc::libmap

private

Definition at line 68 of file LArG4ShowerLibSvc.h.

◆ statmap

typedef std::map<const ShowerLib::IShowerLib*, ShowerLib::ShowerLibStatistics*> LArG4ShowerLibSvc::statmap

private

Definition at line 70 of file LArG4ShowerLibSvc.h.

Constructor & Destructor Documentation

◆ LArG4ShowerLibSvc()

LArG4ShowerLibSvc::LArG4ShowerLibSvc	(	const std::string &	name,
		ISvcLocator *	svc
	)

Definition at line 22 of file LArG4ShowerLibSvc.cxx.

   : base_class(name,svc)
   , m_fileNameList()
 {
   declareProperty( "FileNameList",    m_fileNameList,   "List of filenames for direct reading" );
   
   /* BE SURE THIS ONE IS THE SAME AS IN LArG4FastSimSvc!!! */
   enum DETECTOR {EMB=100000,EMEC=200000,FCAL1=300000,FCAL2=400000,FCAL3=500000,HECLOC=600000,HEC=700000};
  
   m_detmap["EMB"]=EMB;
   m_detmap["EMEC"]=EMEC;
   m_detmap["FCAL1"]=FCAL1;
   m_detmap["FCAL2"]=FCAL2;
   m_detmap["FCAL3"]=FCAL3;
   m_detmap["HECLOC"]=HECLOC;
   m_detmap["HEC"]=HEC;
 }

◆ ~LArG4ShowerLibSvc()

LArG4ShowerLibSvc::~LArG4ShowerLibSvc ( )

virtual

Definition at line 40 of file LArG4ShowerLibSvc.cxx.

41 {

42 }

Member Function Documentation

◆ checkLibrary()

bool LArG4ShowerLibSvc::checkLibrary	(	G4int	particleCode,
		int	detectorTag
	)

virtual

Definition at line 167 of file LArG4ShowerLibSvc.cxx.

 {
   const ShowerLib::IShowerLib* library = getShowerLib(particleCode, detectorTag);
   if (library != nullptr) return true;
  
   return false;
 }

◆ finalize()

StatusCode LArG4ShowerLibSvc::finalize ( )

virtual

Definition at line 127 of file LArG4ShowerLibSvc.cxx.

 {
  
   ATH_MSG_INFO("Finalizing shower library service.");
  
   libmap::const_iterator iter;
  
   for (iter = m_libraryMap.begin(); iter != m_libraryMap.end(); ++iter) {
     ATH_MSG_INFO("Found ShowerLib at location " << m_locations[(*iter).first]);
     ATH_MSG_INFO(std::endl << (*iter).second->statistics());
     if (m_statisticsMap.find((*iter).second) != m_statisticsMap.end())
       ATH_MSG_INFO(m_statisticsMap.find((*iter).second)->second->statistics());
     else
       ATH_MSG_INFO("No statistics available for this kind of library");
     // delete the library:
     delete (*iter).second ;
   }
  
   return StatusCode::SUCCESS;
 }

◆ getContainmentR()

double LArG4ShowerLibSvc::getContainmentR	(	const G4FastTrack &	track,
		int	detectorTag
	)

virtual

Definition at line 257 of file LArG4ShowerLibSvc.cxx.

 {
   // get shower lib from the map
   const ShowerLib::IShowerLib* library = getShowerLib(track.GetPrimaryTrack()->GetDefinition()->GetPDGEncoding(), detectorTag);
  
   if (library == nullptr) {
     return 0.0;
   }
  
   return library->getContainmentR(track.GetPrimaryTrack());
 }

◆ getContainmentZ()

double LArG4ShowerLibSvc::getContainmentZ	(	const G4FastTrack &	track,
		int	detectorTag
	)

virtual

Definition at line 244 of file LArG4ShowerLibSvc.cxx.

 {
   // get shower lib from the map
   const ShowerLib::IShowerLib* library = getShowerLib(track.GetPrimaryTrack()->GetDefinition()->GetPDGEncoding(), detectorTag);
  
   if (library == nullptr) {
     return 0.0;
   }
  
   return library->getContainmentZ(track.GetPrimaryTrack());
 }

◆ getShower()

std::vector< EnergySpot > LArG4ShowerLibSvc::getShower	(	const G4FastTrack &	track,
		int	detectorTag
	)		const

virtual

return list of energy depositions for given track (interface implementation)

Definition at line 185 of file LArG4ShowerLibSvc.cxx.

 {
   // get shower lib from the map
   const ShowerLib::IShowerLib* library = getShowerLib(track.GetPrimaryTrack()->GetDefinition()->GetPDGEncoding(), detectorTag);
  
   if (library == nullptr) {
     // no library in map
     ATH_MSG_ERROR("No library for location: " << detectorTag << "/" << track.GetPrimaryTrack()->GetDefinition()->GetPDGEncoding());
     return std::vector<EnergySpot>();
   }
  
   // starting point of the shower:
   G4ThreeVector PositionShower = track.GetPrimaryTrack()->GetPosition();
  
   // get a shower from the library
   int randomShift = 0;
   randomShift = (int)(CLHEP::RandGaussZiggurat::shoot(G4Random::getTheEngine(), 0., 2.5)+0.5);
  
 #ifdef DEBUG_FrozenShowers
   std::vector<EnergySpot>* shower = library->getShower(track.GetPrimaryTrack(), m_statisticsMap[library], randomShift);
 #else
   std::vector<EnergySpot>* shower = library->getShower(track.GetPrimaryTrack(), nullptr, randomShift);
 #endif
  
  
   if (shower == nullptr) {
     return std::vector<EnergySpot>();
   }
  
   // axis of the shower, in global reference frame:
   G4ThreeVector DirectionShower = track.GetPrimaryTrack()->GetMomentumDirection();
  
   // time of the track (as in LArBarrelCalculator.cc)
   G4double tof = track.GetPrimaryTrack()->GetGlobalTime() / Units::ns;
   G4double time = tof - ( track.GetPrimaryTrack()->GetPosition().mag()/Units::c_light ) / Units::ns;
  
   std::vector<EnergySpot>::iterator hit;
  
   // Create energy spots
   for (hit = shower->begin(); hit != shower->end(); ++hit) {
     G4ThreeVector hitpos = (*hit).GetPosition();
     hitpos.rotateUz(DirectionShower); // rotate the hit to the needed direction
     (*hit).SetPosition(hitpos+PositionShower);
     (*hit).SetTime((*hit).GetTime() + time);
   }
  
   if (msgSvc()->outputLevel(name()) <= MSG::VERBOSE) {
     ATH_MSG_VERBOSE("Prepared " << shower->size() << " EnergySpot");
     for (std::vector<EnergySpot>::const_iterator iter = shower->begin(); iter != shower->end(); ++iter) {
       ATH_MSG_VERBOSE("EnergySpot: " << iter->GetPosition().x() << " " << iter->GetPosition().y() << " " << iter->GetPosition().z()
                       << " " << iter->GetEnergy() << " " << iter->GetTime());
     }
   }
  
   return *std::unique_ptr< std::vector<EnergySpot> >(shower);
 }

◆ getShowerLib()

const ShowerLib::IShowerLib * LArG4ShowerLibSvc::getShowerLib	(	G4int	particleCode,
		int	detectorTag
	)		const

private

get shower library from StoreGate by track (using current volume name)

Definition at line 152 of file LArG4ShowerLibSvc.cxx.

 {
   int location;
  
   location = detectorTag + particleCode;
  
   libmap::const_iterator iter = m_libraryMap.find(location);
   if (iter != m_libraryMap.end()) {
     return (*iter).second;
   }
  
   return nullptr;
 }

◆ initialize()

StatusCode LArG4ShowerLibSvc::initialize ( )

virtual

Definition at line 44 of file LArG4ShowerLibSvc.cxx.

 {
   ATH_MSG_INFO("Initializing");
  
   std::vector<std::string> ignoredLibraryFiles{};
   // iterate through filenames in list
   for (const std::string& fileName : m_fileNameList) {
     std::string resolvedFilename = PathResolverFindCalibFile(fileName);
     if (resolvedFilename.empty()) {
       ATH_MSG_WARNING("Could not resolve input filename " << (fileName) << ". Ignoring!");
       ignoredLibraryFiles.push_back(fileName);
       continue;
     } else {
       ATH_MSG_INFO("Resolving input filename to " << resolvedFilename);
     }
  
     TFile rootfile(resolvedFilename.c_str(),"READ");
  
     if (rootfile.IsZombie()) {
       ATH_MSG_WARNING("File " << resolvedFilename << " is not a valid ROOT file");
       ignoredLibraryFiles.push_back(fileName);
       continue;
     }
  
     const ShowerLib::IShowerLib* library = nullptr;
  
     // trying to create a library out of provided file
     library = ShowerLib::iterateTTree(&rootfile);
  
     // if no library can be created based on the file nullptr is returned
     if (library == nullptr) {
       ATH_MSG_WARNING("File " << resolvedFilename << " is not a valid library file");
       ignoredLibraryFiles.push_back(fileName);
       continue;
     }
  
     if (m_detmap.find(library->detector()) == m_detmap.end()) {
       ATH_MSG_WARNING("Library " << resolvedFilename << " is produced for unknown detector: " << library->detector());
       ignoredLibraryFiles.push_back(fileName);
       delete library;
       continue;
     }
  
     std::stringstream location;
     location << library->detector() << "/" << library->particle_id();
     int key = m_detmap.find(library->detector())->second + library->particle_id();
  
     // put the library into map
     m_libraryMap[key] = library;
     m_locations[key] = location.str();
  
     ATH_MSG_DEBUG("Filename: " << resolvedFilename.c_str());
     ATH_MSG_DEBUG("Location: " << location.str());
     ATH_MSG_DEBUG("Release: " << library->release().c_str());
     ATH_MSG_DEBUG("Geant ver: " << library->geantVersion().c_str());
     ATH_MSG_DEBUG("Phys list: " << library->physicsList().c_str());
   }
  
   // no point in the service with no libraries
   if (m_libraryMap.empty()) {
     ATH_MSG_ERROR("No library files found. Please check the configuration of this job.");
     return StatusCode::FAILURE;
   }
   // some of the configured library files did not work
   if (!ignoredLibraryFiles.empty() ) {
     for (const std::string& fileName : ignoredLibraryFiles) {
       ATH_MSG_ERROR("Failed to create a library from filename: " << (fileName));
     }
     ATH_MSG_ERROR("Some library filenames were invalid. Please check the configuration of this job.");
     return StatusCode::FAILURE;
   }
   ATH_MSG_INFO("List of loaded libraries:");
   for (const auto& m : m_libraryMap) {
     ATH_MSG_INFO("      " << m_locations[m.first] << ": " << m.second->comment());
 #ifdef DEBUG_FrozenShowers
     m_statisticsMap[m.second] = m.second->createStatistics();
 #endif
   }
   ATH_MSG_INFO("Shower library successfully initialized.");
  
   return StatusCode::SUCCESS;
 }

Member Data Documentation

◆ m_detmap

std::map<std::string,int> LArG4ShowerLibSvc::m_detmap

private

Definition at line 73 of file LArG4ShowerLibSvc.h.

◆ m_fileNameList

StringArrayProperty LArG4ShowerLibSvc::m_fileNameList

private

property, list of library files

Definition at line 75 of file LArG4ShowerLibSvc.h.

◆ m_libraryMap

libmap LArG4ShowerLibSvc::m_libraryMap

private

mapping StoreGate key to handle in StoreGate

Definition at line 69 of file LArG4ShowerLibSvc.h.

◆ m_locations

std::map<int,std::string> LArG4ShowerLibSvc::m_locations

private

Definition at line 72 of file LArG4ShowerLibSvc.h.

◆ m_statisticsMap

statmap LArG4ShowerLibSvc::m_statisticsMap

private

Definition at line 71 of file LArG4ShowerLibSvc.h.

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

Public Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ libmap

◆ statmap

Constructor & Destructor Documentation

◆ LArG4ShowerLibSvc()

◆ ~LArG4ShowerLibSvc()

Member Function Documentation

◆ checkLibrary()

◆ finalize()

◆ getContainmentR()

◆ getContainmentZ()

◆ getShower()

◆ getShowerLib()

◆ initialize()

Member Data Documentation

◆ m_detmap

◆ m_fileNameList

◆ m_libraryMap

◆ m_locations

◆ m_statisticsMap