LArG4ShowerLibSvc.cxx

Go to the documentation of this file.

/*
  Copyright (C) 2002-2025 CERN for the benefit of the ATLAS collaboration
*/
 
#include "LArG4ShowerLibSvc.h"
 
// shower lib classes
#include "LArG4ShowerLib/ShowerLibList.h"
 
#include "PathResolver/PathResolver.h"
 
#include "AthenaKernel/Units.h"
 
#include <sstream>
#include "TFile.h"
#include "TTree.h"
#include "Randomize.hh"
 
namespace Units = Athena::Units;
 
LArG4ShowerLibSvc::LArG4ShowerLibSvc(const std::string& name,ISvcLocator* svc)
  : base_class(name,svc)
{ 
  /* 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;
}
 
StatusCode LArG4ShowerLibSvc::initialize()
{
  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;
}
 
StatusCode LArG4ShowerLibSvc::finalize()
{
 
  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;
}
 
/*
 * Returns library from internal map based on the particle. Returns nullptr if there
 * is no library for needed particle/detector.
 */
const ShowerLib::IShowerLib* LArG4ShowerLibSvc::getShowerLib(G4int particleCode, int detectorTag) const
{
  int location;
 
  location = detectorTag + particleCode;
 
  libmap::const_iterator iter = m_libraryMap.find(location);
  if (iter != m_libraryMap.end()) {
    return (*iter).second;
  }
 
  return nullptr;
}
 
bool
LArG4ShowerLibSvc::checkLibrary(G4int particleCode, int detectorTag)
{
  const ShowerLib::IShowerLib* library = getShowerLib(particleCode, detectorTag);
  if (library != nullptr) return true;
 
  return false;
}
 
/*
 * Returns a shower based on the particle. Return empty shower if there is no
 * appropriate showers in the libraries.
 */
 
#ifdef DEBUG_FrozenShowers
std::vector<EnergySpot>
LArG4ShowerLibSvc::getShower(const G4FastTrack& track, int detectorTag)
#else
std::vector<EnergySpot>
LArG4ShowerLibSvc::getShower(const G4FastTrack& track, int detectorTag) const
#endif
{
  // 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);
}
 
double
LArG4ShowerLibSvc::getContainmentZ(const G4FastTrack& track, int detectorTag)
{
  // 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());
}
 
double
LArG4ShowerLibSvc::getContainmentR(const G4FastTrack& track, int detectorTag)
{
  // 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());
}