CountHepMC.cxx

Go to the documentation of this file.

/*
  Copyright (C) 2002-2025 CERN for the benefit of the ATLAS collaboration
*/
 
#ifndef XAOD_ANALYSIS
 
#include "EvgenProdTools/CountHepMC.h"
#include "GaudiKernel/IEventProcessor.h"
#include "GaudiKernel/IAlgManager.h"
#include "GaudiKernel/IOpaqueAddress.h"
#include "GaudiKernel/IProperty.h"
#include "GaudiKernel/ClassID.h"
#include "GaudiKernel/IClassIDSvc.h"
#include "GaudiKernel/IIncidentSvc.h"
#include "GaudiKernel/ConcurrencyFlags.h"
#include "AthenaKernel/errorcheck.h"
#include "EventInfo/EventInfo.h"
#include "EventInfo/EventID.h"
#include "EventInfo/EventType.h"
#include "xAODEventInfo/EventAuxInfo.h"
#include "StoreGate/ReadDecorHandle.h"
#include "AthenaInterprocess/Incidents.h"
#include "IOVDbDataModel/IOVMetaDataContainer.h"
#include "IOVDbDataModel/IOVPayloadContainer.h"
#include "AthenaPoolUtilities/CondAttrListCollection.h"
#include <cmath>
#include <cassert>
#include <string>
 
CountHepMC::CountHepMC(const std::string& name, ISvcLocator* pSvcLocator) :
  GenBase(name, pSvcLocator)
{
  declareProperty("RequestedOutput", m_nCount=5000);
  declareProperty("FirstEvent",      m_firstEv=1);
  declareProperty("CorrectHepMC",    m_corHepMC=false);
  declareProperty("CorrectEventID",  m_corEvtID=false);
  declareProperty("CorrectRunNumber", m_corRunNumber=false);
  declareProperty("NewRunNumber",    m_newRunNumber=999999);
  declareProperty("CopyRunNumber",   m_copyRunNumber=true);
  declareProperty("inputKeyName", m_inputKeyName = "GEN_EVENT");
}
 
StatusCode CountHepMC::initialize()
{
  ATH_CHECK(GenBase::initialize());
 
  if(m_corRunNumber) ATH_CHECK(m_metaDataStore.retrieve());
 
  if(m_corEvtID || m_corRunNumber) {
    ATH_CHECK(m_inputEvtInfoKey.initialize());
    ATH_CHECK(m_outputEvtInfoKey.initialize());
    if(!m_mcWeightsKey.empty()) ATH_CHECK(m_mcWeightsKey.initialize());
  }
 
  if(Gaudi::Concurrency::ConcurrencyFlags::numProcs()>0) {
    ServiceHandle<IIncidentSvc> incidentSvc("IncidentSvc",name());
    ATH_CHECK(incidentSvc.retrieve());
    incidentSvc->addListener(this, AthenaInterprocess::UpdateAfterFork::type());
  }
 
  return StatusCode::SUCCESS;
}
 
StatusCode CountHepMC::execute() {
 
  m_nPass++;
  ATH_MSG_DEBUG("Current count = " << m_nPass);
  ATH_MSG_DEBUG("Options for HepMC event number, EvtID event number, EvtID run number = " << m_corHepMC << ", " << m_corEvtID << ", " << m_corRunNumber );
  // Fix the event number
  long long int newnum = m_nPass + m_firstEv - 1;
  if (newnum<=0){
    ATH_MSG_ERROR("Event number must be positive-definite; " << newnum << " is not allowed");
    return StatusCode::FAILURE;
  }
 
#ifndef HEPMC3
   constexpr long long int max32 = std::pow(2, 31) - 1;
   if (newnum >= max32) {
      ATH_MSG_ERROR("Event number " << newnum << " exceeds 32bit limit. In HepMC2 it is not allowed.");
      return StatusCode::FAILURE;
  }
#else
// Temporary solution to suppress the Warnings from HepMC3 printed for every event. 
// Will be removed when generators authors fix the way they fill the x-section or when we switch to a new HepMC3 version , where the printout is limited.
   if (m_nPass == 100) {
      ATH_MSG_INFO("After " << m_nPass << " events we switch off HepMC3 warnings to avoid blowing up logs.");
      HepMC3::Setup::set_print_warnings(false);
      }
#endif
 
  if (m_corHepMC) {
    std::string   key = m_inputKeyName;
    // retrieve event from Transient Store (Storegate)
    const McEventCollection* oldmcEvtColl=0;
    if (evtStore()->retrieve(oldmcEvtColl, key).isSuccess()){
      McEventCollection* newmcEvtColl = new McEventCollection(*oldmcEvtColl);
      McEventCollection::iterator evt = newmcEvtColl->begin();
      HepMC::GenEvent* hepMC = *evt;
      HepMC::set_ll_event_number(hepMC, newnum);
      CHECK(evtStore()->overwrite( newmcEvtColl, key));
    }
    else{
      ATH_MSG_ERROR("No McEventCollection object found");
      return StatusCode::SUCCESS;
    }
  }
 
  xAOD::EventInfo* outputEvtInfo{nullptr};
  int inpRunNumber{-1};
  if(m_corEvtID||m_corRunNumber||m_copyRunNumber) {
    SG::ReadHandle<xAOD::EventInfo> inputEvtInfoHandle(m_inputEvtInfoKey);
    SG::WriteHandle<xAOD::EventInfo> outputEvtInfoHandle(m_outputEvtInfoKey);
    ATH_CHECK(outputEvtInfoHandle.record(std::make_unique<xAOD::EventInfo>(), std::make_unique<xAOD::EventAuxInfo>()));
 
    outputEvtInfo = outputEvtInfoHandle.ptr();
    *outputEvtInfo = *inputEvtInfoHandle;
 
    // This is sometimes marked as a decoration in the source, meaning
    // it won't get copied by the assignment above.  Make sure it
    // gets copied.
    outputEvtInfo->setMCEventWeights (inputEvtInfoHandle->mcEventWeights());
 
    inpRunNumber = inputEvtInfoHandle->runNumber();
    if(!m_mcWeightsKey.empty()) {
      SG::ReadDecorHandle<xAOD::EventInfo,std::vector<float>> mcWeights(m_mcWeightsKey);
      outputEvtInfo->setMCEventWeights(mcWeights(0));
    }
  }
 
  if (m_corEvtID) {
    // Change the EventID in the eventinfo header
    const EventInfo* pInputEvt(nullptr);
    if (evtStore()->retrieve(pInputEvt).isSuccess()) {
      assert(pInputEvt);
      EventID* eventID = const_cast<EventID*>(pInputEvt->event_ID());
      eventID->set_event_number(newnum);
      ATH_MSG_DEBUG("Set new event number in event_ID");
    } else {
      ATH_MSG_ERROR("No EventInfo object found");
      return StatusCode::SUCCESS;
    }
 
    outputEvtInfo->setEventNumber(newnum);
  }
 
 
  // Copy generation run number into mc channel number
  if (m_copyRunNumber) {
    // Legacy Event Info
    const EventInfo* pInputEvt(nullptr);
    if (evtStore()->retrieve(pInputEvt).isSuccess()) {
      assert(pInputEvt);
 
      unsigned int run_number = pInputEvt->event_ID()->run_number();
 
      EventType* eventType = const_cast<EventType*>(pInputEvt->event_type());
      eventType->set_mc_channel_number(run_number);
      eventType->set_mc_event_number  (newnum);
 
      ATH_MSG_DEBUG("Copied run number into mc channel number: " << run_number);
    } else {
      ATH_MSG_ERROR("No EventInfo object found");
      return StatusCode::FAILURE;
    }
 
    // xAOD::EventInfo
    outputEvtInfo->setMCChannelNumber(inpRunNumber);
    outputEvtInfo->setMCEventNumber(newnum);
    outputEvtInfo->setEventNumber(newnum);
  }
 
 
  if (m_corRunNumber) {
    // Change the EventID in the eventinfo header
    const EventInfo* pInputEvt(nullptr);
    unsigned int oldRunNumber = 0;
    if (evtStore()->retrieve(pInputEvt).isSuccess()) {
      assert(pInputEvt);
      EventID* eventID = const_cast<EventID*>(pInputEvt->event_ID());
      oldRunNumber = eventID->run_number();
      eventID->set_run_number(m_newRunNumber);
      ATH_MSG_DEBUG("Set new run number in event_ID " << m_newRunNumber);
 
      // also set the MC channel number
      EventType* event_type = const_cast<EventType*>(pInputEvt->event_type());
      event_type->set_mc_channel_number(m_newRunNumber);
      ATH_MSG_DEBUG("Set new MC channel number " << event_type->mc_channel_number());
    } else {
      ATH_MSG_ERROR("No EventInfo object found");
      return StatusCode::SUCCESS;
    }
 
    oldRunNumber = outputEvtInfo->runNumber();
    outputEvtInfo->setRunNumber(m_newRunNumber);
    outputEvtInfo->setMCChannelNumber(m_newRunNumber);
 
    {
      // change the channel number where /Generation/Parameters are found
      auto newChannelNumber =
    static_cast< CondAttrListCollection::ChanNum >(m_newRunNumber);
      auto oldChannelNumber =
    static_cast< CondAttrListCollection::ChanNum >(oldRunNumber);
 
      const char* key = "/Generation/Parameters";
      const IOVMetaDataContainer * iovContainer = nullptr;
      if (m_metaDataStore->retrieve(iovContainer, key).isSuccess()
          && iovContainer) {
        // get a hold of the payload
        const IOVPayloadContainer * payloadContainer =
            iovContainer->payloadContainer();
 
        // Grab the attribute list
        for (CondAttrListCollection* collection : *payloadContainer) {
          for(unsigned int index = 0; index < collection->size(); ++index) {
            if (collection->chanNum(index) != oldChannelNumber) {
              ATH_MSG_INFO("Not updating \"" << key << "\" on channel number "
                           << collection->chanNum(index));
              continue;
            }
 
            if (collection->fixChanNum(oldChannelNumber, newChannelNumber))
              ATH_MSG_INFO("Updated \"" << key << "\" channel number from "
                           << oldChannelNumber << " to " << newChannelNumber);
            else
              ATH_MSG_ERROR("Channel number update from " << oldChannelNumber
                            << " to " << newChannelNumber << " on \"" << key
                            << "\" FAILED");
          }
        }
 
        {
          // Update the MC channel number in the "/TagInfo"
          const char* key = "/TagInfo";
          const IOVMetaDataContainer * iovContainer = nullptr;
          if (m_metaDataStore->retrieve(iovContainer, key).isSuccess()
              && iovContainer) {
            // get a hold of the payload
            const IOVPayloadContainer * payloadContainer =
              iovContainer->payloadContainer();
 
            // Grab the attribute list
            for (CondAttrListCollection* collection : *payloadContainer) {
              for (auto pair : *collection) {
                // pair is a pair of Channel number and AttributeList
                if (pair.second.exists("mc_channel_number")) {
                  try {
                    pair.second["mc_channel_number"].setValue(
                      std::to_string(m_newRunNumber));
                    ATH_MSG_INFO("Updated \"" << key << "\" mc_channel_number"
                                 << " to " << m_newRunNumber);
                  } catch (std::exception&) {
                    try {
                      pair.second["mc_channel_number"].setValue(m_newRunNumber);
                      ATH_MSG_INFO("Updated \"" << key << "\" mc_channel_number"
                                   << " to " << m_newRunNumber);
                    } catch (std::exception&) {
                      ATH_MSG_ERROR("mc_channel_number update from to "
                                    << m_newRunNumber << " on \"" << key
                                    << "\" FAILED");
                    }
                  }
                }
              }
            }
          }
        }
      } else {
        ATH_MSG_INFO("Could not retrieve \"" << key << "\" from MetaDataStore");
      }
    }
  }
 
 
  if (m_nPass == m_nCount) {
    ATH_MSG_INFO("Stopping the event processing...." << m_nPass << "/" << m_nCount);
    // Try the MP ELM first
    SmartIF<IEventProcessor> apm(serviceLocator()->service("AthMpEvtLoopMgr", /*createIf*/false));
    if(apm) {
      ATH_CHECK(apm->stopRun());
    }
    else {
      apm = serviceLocator()->service("AthenaEventLoopMgr", /*createIf*/false);
      if (apm) {
        ATH_CHECK(apm->stopRun());
      }
      else {
        ATH_MSG_WARNING("No EventLoop Manager found ");
      }
    }
  }
 
  return StatusCode::SUCCESS;
}
 
 
StatusCode CountHepMC::finalize() {
  ATH_MSG_INFO("Events passing all checks and written = " << m_nPass);
  return StatusCode::SUCCESS;
}
 
void CountHepMC::handle(const Incident& inc) {
  using AfterForkInc = AthenaInterprocess::UpdateAfterFork;
  if(inc.type()==AfterForkInc::type()) {
    int nProcs= Gaudi::Concurrency::ConcurrencyFlags::numProcs();
    const AfterForkInc* afInc = dynamic_cast<const AfterForkInc*>(&inc);
    if(afInc) {
      int rem = m_nCount%nProcs;
      m_nCount = m_nCount/nProcs
    + (afInc->workerID() <= rem-1 ? 1 : 0);
    }
    else {
      ATH_MSG_ERROR("Failed to dyn-cast the incident to UpdateAfterFork!");
      throw std::runtime_error("Wrong incident type handled by CountHepMC");
    }
  }
}
 
#endif