PileUpMergeSvc.icc

Go to the documentation of this file.

/* -*- C++ -*- */
 
/*
  Copyright (C) 2002-2023 CERN for the benefit of the ATLAS collaboration
*/
 
#include <algorithm>  /* make_pair */
#include <cassert>
#include <string>
 
#include "GaudiKernel/System.h"
#include "GaudiKernel/StatusCode.h"
 
#include "AthenaKernel/ITriggerTime.h"
#include "StoreGate/StoreGateSvc.h"
#include "AthenaKernel/ClassID_traits.h"
#include "AthenaBaseComps/AthMsgStreamMacros.h"
 
namespace {
  template <typename KEY>
  std::string mkHSKey(const KEY& k) {
    return "HS" + std::string(k);
  }
 
  template <class DATALINK, typename KEY>
  void fillLink(DATALINK& l, const KEY& k, IProxyDict* sg = 0) {
    l.toIdentifiedObject(k, sg);
    if (!l.isValid()) {
      l.toIdentifiedObject(mkHSKey(k), sg);
    }
  }
 
  struct NoKey {};
  //MsgStream& operator <<(MsgStream& os, const NoKey&) { os << "Default"; return os; }  
 
  template <class DATALINK> 
  void fillLink(DATALINK&, const NoKey&, IProxyDict*)
  { /*leave it in default state*/ }
 
  [[maybe_unused]] // suppress clang warning (false positive?)
  PileUpTimeEventIndex::PileUpType getOldPileUpType(const xAOD::EventInfo_v1::PileUpType &newType) {
    PileUpTimeEventIndex::PileUpType oldType = PileUpTimeEventIndex::Unknown;
    switch(newType) {
    case xAOD::EventInfo_v1::Signal :
      oldType = PileUpTimeEventIndex::Signal;
      break;
    case xAOD::EventInfo_v1::MinimumBias:
      oldType = PileUpTimeEventIndex::MinimumBias;
      break;
    case xAOD::EventInfo_v1::Cavern:
      oldType = PileUpTimeEventIndex::Cavern;
      break;
    case xAOD::EventInfo_v1::HaloGas:
      oldType = PileUpTimeEventIndex::HaloGas;
      break;
    case xAOD::EventInfo_v1::HighPtMinimumBias:
      oldType = PileUpTimeEventIndex::HighPtMinimumBias;
      break;
    case xAOD::EventInfo_v1::ZeroBias:
      oldType = PileUpTimeEventIndex::ZeroBias;
      break;
    default:
      break;
    }
    return oldType;
  }
}
 
///retrieve keyed DATA obj for the original event
template <typename KEY, typename DATA>
StatusCode 
PileUpMergeSvc::retrieveOriginal(const KEY& dataKey, const DATA*& data) {
  StatusCode sc(StatusCode::FAILURE);
  const xAOD::EventInfo* pEvent = getPileUpEvent(nullptr,m_EventInfoKeyName);
  if (pEvent) {
    // access the sub events DATA objects...
     if( pEvent->subEvents().size() ) {
        //here we assume that the original event is the first in pEvent list
        sc =  pEvent->subEvents()[0].ptr()->evtStore()->retrieve(data, dataKey);
        if (!sc) {
          sc =  pEvent->subEvents()[0].ptr()->evtStore()->retrieve(data, mkHSKey(dataKey));
        }
     }
  }
  return sc;
}
 
/// retrieve keyed DATA objs for all sub-events and attach a time to them
template <typename KEY, typename TIMEDDATA>
StatusCode
PileUpMergeSvc::retrieveSubEvtsData(const KEY &dataKey, // orig evt key
                                    TIMEDDATA &timedData,
                                    unsigned int &numberOfSimHits) {
  numberOfSimHits = 0;
  typedef typename TIMEDDATA::value_type value_type; // pair<time_t,DataLink..
  typedef typename value_type::second_type DataLink_t;
  typedef typename DataLink_t::value_type data_t;
  // the tdefs above in practice check that TIMEDDATA is what we want
  // FIXME we still have to check we are dealing with a sequence:
  //   boost::function_requires < boost::SequenceConcept<TIMEDDATA> > ();
  const xAOD::EventInfo* pEvent = getPileUpEvent(nullptr,m_EventInfoKeyName);
 
    ATH_MSG_DEBUG ( "retrieveSubEvtsData: object of type "
              << System::typeinfoName(typeid(data_t)) << " with key "
              << dataKey<< " ei="<<pEvent  );
 
  if (pEvent) {
    if(pEvent->subEvents().size()==0) {
       ATH_MSG_DEBUG ( "no subEvents for xAOD::EventInfo '"<<m_EventInfoKeyName<<"'" ); 
 
       DataLink_t dLink;
       fillLink(dLink, dataKey);
       if (dLink.isValid()) {
          timedData.push_back(std::make_pair(0, dLink));
       }
       return StatusCode::SUCCESS;
    }
    // access the sub events DATA objects...
    for (const xAOD::EventInfo::SubEvent &subEv : pEvent->subEvents()) {
      // skip if dobj not active for this xing
      // FIXME      if (!isLive<data_t>(dataKey, int(iEvt->time()))) {
      // FIXME turning the double iEvt->time() is fraught with peril. Luckily
      // FIXME it just works, but we should have the beam xing in iEvt
      if (!isLive(ClassID_traits<data_t>::ID(), dataKey, int(subEv.time()))) {
#ifndef NDEBUG
        ATH_MSG_VERBOSE("retrieveSubEvtsData: object of type "
                        << System::typeinfoName(typeid(data_t)) << " with key "
                        << dataKey << " OUT OF XING RANGE: SKIPPING ");
#endif
      } else {
        subEv.ptr()->evtStore()->makeCurrent();
        StoreGateSvc *pSubEvtSG = subEv.ptr()->evtStore();
        DataLink_t dLink;
        fillLink(dLink, dataKey, pSubEvtSG);
        double sigTime(0.0);
        unsigned int evtIndex(0);
        if (dLink.isValid()) {
          if (m_returnTimedData.value()) {
            sigTime = subEv.time();
            if (!m_pITriggerTime.empty())
              sigTime -= m_pITriggerTime->time();
            evtIndex = subEv.index();
          }
          value_type tData(PileUpTimeEventIndex(int(sigTime), evtIndex,
                                                getOldPileUpType(subEv.type())),
                           dLink);
          numberOfSimHits += tData.second->size();
          timedData.push_back(tData);
          ATH_MSG_DEBUG("added entry from store "
                        << pSubEvtSG->name() << " for object of type "
                        << System::typeinfoName(typeid(data_t))
                        << "\n with key " << dataKey);
        }
#ifndef NDEBUG
        if (msg().level() <= MSG::VERBOSE) {
          msg() << MSG::VERBOSE << "SubEvt EventInfo : "
                << " event: " << subEv.ptr()->eventNumber()
                << " run: " << subEv.ptr()->runNumber();
          if (m_returnTimedData.value()) {
            msg() << " time offset: " << sigTime
                  << " event index: " << evtIndex;
          }
          msg() << endmsg;
        }
#endif
      }
    }
    // reset active store pointer to default event store FIXME DANGEROUS
    p_overStore->makeCurrent();
  } else {
    ATH_MSG_DEBUG("default PileUpEventInfo not found, trying any EventInfo");
    // check for EventInfo with any key name
    pEvent = getPileUpEvent(
        dynamic_cast<StoreGateSvc *>(SG::CurrentEventStore::store()), "");
    if (pEvent) {
      DataLink_t dLink;
      fillLink(dLink, dataKey);
      if (dLink.isValid()) {
        timedData.push_back(std::make_pair(0, dLink));
      }
    } else {
      ATH_MSG_FATAL("no EventInfo object found!");
      return StatusCode::FAILURE;
    }
  }
  return StatusCode::SUCCESS;
}
 
///retrieve keyed DATA objs for subset of sub-events
template <typename KEY, typename TIMEDDATA>
StatusCode 
PileUpMergeSvc::retrieveSubSetEvtData(const KEY& dataKey, //orig evt key
                      TIMEDDATA& timedData, int bunchXing,
                      SubEventIterator bSubEvents, SubEventIterator eSubEvents)
{
  typedef typename TIMEDDATA::value_type value_type;  //pair<time_t,DataLink..
  typedef typename value_type::second_type DataLink_t;
 
  SubEventIterator iEvt = bSubEvents;
  for (; iEvt != eSubEvents; ++iEvt) {
 
    StoreGateSvc &seStore = *iEvt->ptr()->evtStore();
    ATH_MSG_VERBOSE("SubEvt StoreGate " << seStore.name() << " :"
            << " bunch crossing : " << bunchXing
            << " time offset : " << iEvt->time()
            << " event number : " <<
            iEvt->ptr()->eventNumber()
            << " run number : " <<
            iEvt->ptr()->runNumber());
 
    DataLink_t dLink;
    fillLink(dLink, dataKey, iEvt->ptr()->evtStore());
    if (dLink.isValid()) {
 
      double sigTime(0.0);
      unsigned int evtIndex(0);
 
      if (m_returnTimedData.value()) {
    sigTime=iEvt->time();
    evtIndex = iEvt->index();
      }
 
      value_type tData(PileUpTimeEventIndex(int(sigTime),evtIndex), dLink);
      timedData.push_back(tData);
 
    } else {
 
      ATH_MSG_FATAL("Could not retrieve hit collection from: " << seStore.name() << " with key: " << dataKey);
      return StatusCode::FAILURE;
 
    }
  }
 
  return StatusCode::SUCCESS;
 
}
 
///retrieve keyed DATA objs for single sub-event (un-timed)
template <typename KEY, typename DATA>
StatusCode
PileUpMergeSvc::retrieveSingleSubEvtData(const KEY& dataKey, const DATA*& data, int bunchXing, SubEventIterator iEvt){
 
  ATH_MSG_VERBOSE("In PileUpMergeSvc::retrieveSingleSubEvtData evt="<<*iEvt->ptr()<<" SG="<<iEvt->ptr()->evtStore());
  StoreGateSvc &seStore = *iEvt->ptr()->evtStore();
  ATH_MSG_VERBOSE("SubEvt StoreGate " << seStore.name() << " :"
          << " bunch crossing : " << bunchXing
          << " time offset : " << iEvt->time()
          << " event number : " <<
          iEvt->ptr()->eventNumber()
          << " run number : " <<
          iEvt->ptr()->runNumber());
 
  StatusCode sc = seStore.retrieve(data, dataKey);
  if (!sc) {
    sc = seStore.retrieve(data, mkHSKey(dataKey));
  }
  return sc;
 
}
 
/// retrieve keyed DATA objs for all sub-events and attach a time to them
template <typename KEY, typename TIMEDDATA>
StatusCode
PileUpMergeSvc::retrieveSubEvtsData(const KEY &dataKey, // orig evt key
                                    TIMEDDATA &timedData) {
  typedef typename TIMEDDATA::value_type value_type; // pair<time_t,DataLink..
  typedef typename value_type::second_type DataLink_t;
  typedef typename DataLink_t::value_type data_t;
  // the tdefs above in practice check that TIMEDDATA is what we want
  // FIXME we still have to check we are dealing with a sequence:
  //   boost::function_requires < boost::SequenceConcept<TIMEDDATA> > ();
  const xAOD::EventInfo* pEvent = getPileUpEvent(nullptr,m_EventInfoKeyName);
 
  ATH_MSG_DEBUG ( "retrieveSubEvtsData: object of type "
                  << System::typeinfoName(typeid(data_t)) << " with key "
                  << dataKey<< " ei="<<pEvent  );
 
  if (pEvent) {
    if(pEvent->subEvents().size()==0) {
       ATH_MSG_DEBUG ( "no subEvents for xAOD::EventInfo '"<<m_EventInfoKeyName<<"'" );
 
       DataLink_t dLink;
       fillLink(dLink, dataKey);
       if (dLink.isValid()) {
          timedData.push_back(std::make_pair(0, dLink));
       }
       return StatusCode::SUCCESS;
    }
 
    // access the sub events DATA objects...
    for (const xAOD::EventInfo::SubEvent &subEv : pEvent->subEvents()) {
      // skip if dobj not active for this xing
      // FIXME      if (!isLive<data_t>(dataKey, int(iEvt->time()))) {
      // FIXME turning the double iEvt->time() is fraught with peril. Luckily
      // FIXME it just works, but we should have the beam xing in iEvt
      if (!isLive(ClassID_traits<data_t>::ID(), dataKey, int(subEv.time()))) {
#ifndef NDEBUG
        ATH_MSG_VERBOSE("retrieveSubEvtsData: object of type "
                        << System::typeinfoName(typeid(data_t)) << " with key "
                        << dataKey << " OUT OF XING RANGE: SKIPPING ");
#endif
      } else {
        subEv.ptr()->evtStore()->makeCurrent();
        StoreGateSvc *pSubEvtSG = subEv.ptr()->evtStore();
        DataLink_t dLink;
        fillLink(dLink, dataKey, pSubEvtSG);
        double sigTime(0.0);
        unsigned int evtIndex(0);
        if (dLink.isValid()) {
          if (m_returnTimedData.value()) {
            sigTime = subEv.time();
            if (!m_pITriggerTime.empty())
              sigTime -= m_pITriggerTime->time();
            evtIndex = subEv.index();
          }
          value_type tData(PileUpTimeEventIndex(int(sigTime), evtIndex,
                                                getOldPileUpType(subEv.type())),
                           dLink);
          timedData.push_back(tData);
          ATH_MSG_DEBUG("added entry from store "
                        << pSubEvtSG->name() << " for object of type "
                        << System::typeinfoName(typeid(data_t))
                        << "\n with key " << dataKey);
        }
#ifndef NDEBUG
        if (msg().level() <= MSG::VERBOSE) {
          msg() << MSG::VERBOSE << "SubEvt EventInfo : "
                << " event: " << subEv.ptr()->eventNumber()
                << " run: " << subEv.ptr()->runNumber();
          if (m_returnTimedData.value()) {
            msg() << " time offset: " << sigTime
                  << " event index: " << evtIndex;
          }
          msg() << endmsg;
        }
#endif
      }
    }
    // reset active store pointer to default event store FIXME DANGEROUS
    p_overStore->makeCurrent();
  } else {
    ATH_MSG_DEBUG("default PileUpEventInfo not found, trying any EventInfo");
    // check for EventInfo with any key name
    pEvent = getPileUpEvent(
        dynamic_cast<StoreGateSvc *>(SG::CurrentEventStore::store()), "");
    if (pEvent) {
      DataLink_t dLink;
      fillLink(dLink, dataKey);
      if (dLink.isValid()) {
        timedData.push_back(std::make_pair(0, dLink));
      }
    } else {
      ATH_MSG_FATAL("no EventInfo object found!");
      return StatusCode::FAILURE;
    }
  }
  return StatusCode::SUCCESS;
}
 
// ///retrieve default DATA objs for all sub-events and attach a time to them
// template <typename TIMEDDATA>
// StatusCode 
// PileUpMergeSvc::retrieveSubEvtsData(TIMEDDATA& timedData)
// {
//   return retrieveSubEvtsData(NoKey(), timedData);
// }
 
 
template <typename DATA, typename KEY>
bool
PileUpMergeSvc::isLive(const KEY& dataKey, int iXing) {
  return isLive(ClassID_traits<DATA>::ID(), std::string(dataKey), iXing);
}