PhysicsAnalysis/POOLRootAccess/src/TEvent.cxx

Go to the documentation of this file.

/*
  Copyright (C) 2002-2026 CERN for the benefit of the ATLAS collaboration
*/
 
#include "POOLRootAccess/TEvent.h"
 
#include "AthenaKernel/ICollectionSize.h"
 
#include "GaudiKernel/IEventProcessor.h"
 
#include "TString.h"
#include "TObjArray.h"
#include "TObjString.h"
#include "TSystem.h"
#include "TFile.h"
#include "TChain.h"
 
#include "AthAnalysisBaseComps/AthAnalysisHelper.h"
#include "StoreGateBindings/StoreGatePyExt.h"
 
namespace Gaudi {
  IAppMgrUI* Init() {
    return AAH::initGaudi("POOLRootAccess/basic.opts");
  }
}
 
namespace POOL {
 
IAppMgrUI* Init( const char* options ) {
  return AAH::initGaudi(options); //see AthAnalysisHelper
}
 
TEvent::~TEvent() {
  //need to destroy my storegate, selector, and loop
  if(m_evtLoop.isSet()) {
    m_evtLoop.release().ignore();
  }
  if(m_evtSelect.isSet()) {
    m_evtSelect.release().ignore();
  }
  if(m_evtStore.isSet()) {
    m_evtStore.release().ignore();
  }
}
 
TEvent::TEvent(const std::string& name ) : TEvent( kPOOLAccess , name ) { }
 
TEvent::TEvent(EReadMode mode, const std::string& name) : 
   m_evtProcessor (nullptr),
   m_incSvc("IncidentSvc","TEvent"+name),
   m_joSvc("JobOptionsSvc","TEvent"+name),
   m_evtLoop("AthenaEventLoopMgr/"+name+"_EventLoopMgr","TEvent"+name),
   m_evtSelect("EventSelectorAthenaPool/"+name+"_EventSelector","TEvent"+name),
   m_evtStore("StoreGateSvc/"+name,"TEvent"+name),
   m_inputMetaStore("InputMetaDataStore","TEvent"+name) /*fixme, when reading multiple files at once?*/ {
 
   Gaudi::Init();
 
   //SEEMS TO CAUSE INITIALIZE LOOP if(name=="StoreGateSvc") m_evtSelect.setName("EventSelector"); //use default selector name if we use default storegate
 
   //FIXME: Should protect against attempt to mix POOL with nonPOOL
   if(mode==kPOOLAccess) {
     //add AthenaPoolCnvSvc to the EventPersistencySvc (ideally the selector should add this itself!!)
     ServiceHandle<IService> epSvc("EventPersistencySvc","TEvent"+name);
     AAH::setProperty( epSvc , "CnvServices" , "['AthenaPoolCnvSvc']" ).ignore(); //FIXME: perhaps should append rather than overwrite
     //add the AthenaPoolAddressProviderSvc to ProxyProviderSvc
     ServiceHandle<IService> ppSvc("ProxyProviderSvc","TEvent"+name);
     AAH::setProperty( ppSvc , "ProviderNames", "['MetaDataSvc', 'AthenaPoolAddressProviderSvc']" ).ignore();
   } else if(mode==kTreeAccess) {
     //switch selector type to Athena::RootNtupleEventSelector
     m_evtSelect.setTypeAndName("Athena::RootNtupleEventSelector/"+m_evtSelect.name());
     //also default to 'CollectionTree' as the tree to read
     this->setEvtSelProperty("TupleName","CollectionTree");
   } else {
     //switch selector type to xAODEventSelector:
     m_evtSelect.setTypeAndName("Athena::xAODEventSelector/"+m_evtSelect.name());
   }
 
   //check if a SelectorType has been specified in the joSvc 
   //should retire this code at some point (hangover from basicxAOD.opts)
   if (m_joSvc->has("TEvent.EventSelectorType")) {
     m_evtSelect.setTypeAndName(m_joSvc->get("TEvent.EventSelectorType") + "/" + m_evtSelect.name());
   }
 
   AAH::setProperty( m_evtLoop , "ClearStorePolicy", "BeginEvent" ).ignore();    //for interactive use of storegate
   AAH::setProperty( m_evtLoop , "EvtSel", m_evtSelect.typeAndName() ).ignore(); //connect loop to selector
   AAH::setProperty( m_evtLoop , "EvtStore", m_evtStore.typeAndName() ).ignore();//connect loop to store
   AAH::setProperty( m_evtLoop , "EventPrintoutInterval", 0 ).ignore(); //disable printout (speeds up loop)
 
   AAH::setProperty(m_evtStore, "PruneIncidents", true).ignore();
 
   if(m_evtSelect.type()=="Athena::xAODEventSelector") {
     AAH::setProperty( m_evtSelect , "ReadMetaDataWithPool" , true).ignore(); //uses hybrid xAOD reading by default
     AAH::setProperty( m_evtSelect , "AccessMode" , int(mode) ).ignore(); //sets the mode
     AAH::setProperty( m_evtSelect , "EvtStore" , m_evtStore.typeAndName() ).ignore();
     //FIXME ... cant get dual event stores working :-(
     //AAH::setProperty( m_evtSelect , "ProxyProviderSvc" , "ProxyProviderSvc/" + name + "_ProxyProviderSvc" );
     //AAH::setProperty( m_evtStore , "ProxyProviderSvc", "ProxyProviderSvc/" + name + "_ProxyProviderSvc" );
   }
 
   //set outputlevels to WARNING 
   AAH::setProperty( m_evtLoop, "OutputLevel", 4 ).ignore();
   AAH::setProperty( m_evtSelect, "OutputLevel", 4 ).ignore();
   //AAH::setProperty( m_evtStore, "OutputLevel", 4 ).ignore();
 
   //suppress messages below WARNING too
   //do this here to stop some pre initialize INFO messages from showing
   ServiceHandle<IProperty> messageSvc("MessageSvc","");
   std::vector<std::string> p;
   Gaudi::Parsers::parse(p,messageSvc->getProperty("setWarning").toString()).ignore();
   p.push_back( m_evtLoop.name() );
   p.push_back( m_evtSelect.name() );
   p.push_back( m_evtStore.name() );
   messageSvc->setProperty(  StringArrayProperty( "setWarning" , p ) ).ignore();
   
   //also push this into the joboptionsvc so that if a reinit happens then these settings are remembered 
   //m_joSvc->addPropertyToCatalogue( "MessageSvc", StringArrayProperty( "setWarning", p ) );
   
}
 
 
void TEvent::setActive() {
    m_evtStore->makeCurrent();
}
 
long TEvent::getEntries() {
   if(m_size>=0) return m_size;
   if(!m_evtLoop.isSet()) { if(m_evtLoop.retrieve().isFailure()) return 0; }
   if (ICollectionSize* isize = dynamic_cast<ICollectionSize*>(&*m_evtLoop)) {
     return isize->size();
   }
   return 0;
}
 
StatusCode TEvent::readFrom( TFile* file ) {
   if(file==0 || file->IsZombie()) return StatusCode::FAILURE;
   return readFrom( file->GetName() );
}
 
StatusCode TEvent::readFrom( const char* file ) {
   if(m_curEntry >= 0) {
      std::cout << "Unable to change file after already reading" << std::endl;
      return StatusCode::FAILURE;
   }
   std::vector<std::string> myFiles;
   //see if contains wildcard
   //separate by comma
   TString sFileIn(file);
   std::unique_ptr<TObjArray> sFiles(sFileIn.Tokenize(","));
   std::unique_ptr<TIterator> itr(sFiles->MakeIterator());
   TObject* obj;
   while( (obj = itr->Next()) ) {
     TString sFile(static_cast<TObjString*>(obj)->String());
     if(sFile.Contains('*')) {
      std::unique_ptr<TObjArray> theFiles(gSystem->GetFromPipe(("ls " + std::string(file)).c_str()).Tokenize("\n"));
      for(int i=0;i<theFiles->GetEntries();i++) {
         //std::cout << "Adding " << dynamic_cast<TObjString*>(theFiles->At(i))->String().Data() << std::endl;
        if (TObjString* objstr = dynamic_cast<TObjString*>(theFiles->At(i))) {
          myFiles.push_back(gSystem->ExpandPathName(objstr->String().Data()));
        }
      }
     } else {
       myFiles.push_back( gSystem->ExpandPathName(sFile.Data()) );
     }
   }
 
   return AAH::setProperty( m_evtSelect , "InputCollections" , myFiles );
}
 
StatusCode TEvent::readFrom(TChain* files) {
 
  //add all files to the property list by giving a comma separated list of files
  std::string sfiles;
  std::unique_ptr<TIterator> itr(files->GetListOfFiles()->MakeIterator());
  TObject* obj;
  bool hasFile(false);
  while( (obj = itr->Next()) ) {
    if(hasFile) sfiles += ",";
    sfiles += obj->GetTitle();
    hasFile=true;
  }
  //std::cout << sfiles << std::endl;
  return readFrom(sfiles.c_str());
 
}
 
int TEvent::getEntry( long entry ) {
   if(!m_evtLoop.isSet()) { if(m_evtLoop.retrieve().isFailure()) return -1; }
   if(entry==0 || entry != m_curEntry+1) {
     //need to seek on first read or if not reading next event
     if (m_evtLoop->seek(entry).isFailure()) return -1;
   }
   //ensure our storegate is the active store
   setActive();
   if (m_evtProcessor == nullptr) {
     m_evtProcessor = dynamic_cast<IEventProcessor*>(&*m_evtLoop);
   }
   if (!m_evtProcessor){
     std::cout << "m_evtProcessor is still nullptr" << std::endl;
     return -1;
   }
   StatusCode out = m_evtProcessor->nextEvent(entry+1);
   m_curEntry = entry;
 
   if (m_listenerState == UNCHECKED) {
     std::vector<IIncidentListener*> l;
     m_incSvc->getListeners (l, "BeginEvent");
     m_listenerState = l.empty() ? NO_LISTENERS : HAVE_LISTENERS;
   }
 
   if (m_listenerState == HAVE_LISTENERS) {
     m_incSvc->fireIncident(Incident("BeginEvent",IncidentType::BeginEvent));
   }
   return (out.isSuccess()) ? 0 : -1;
}
 
  //python bindings
 
  PyObject* TEvent::retrieve( PyObject* tp, PyObject* pykey )
 {
   return AthenaInternal::retrieveObjectFromStore( &*evtStore() , tp, pykey );
 }
 
  PyObject* TEvent::get_item( PyObject* pykey ){
    return AthenaInternal::py_sg_getitem( &*evtStore() , pykey );
  }
  PyObject* TEvent::contains( PyObject* tp, PyObject* pykey ) {
    return AthenaInternal::py_sg_contains( &*evtStore() , tp,  pykey );
  }
  PyObject* TEvent::retrieveMetaInput(PyObject* tp, PyObject* pykey) {
    if(!m_evtLoop.isSet()) { if(m_evtLoop.retrieve().isFailure()) return 0; }
    return AthenaInternal::retrieveObjectFromStore( &*inputMetaStore() , tp, pykey );
  }
  PyObject* TEvent::record  (PyObject* obj, PyObject* pykey,bool allowMods,bool resetOnly,bool noHist) {
    return AthenaInternal::recordObjectToStore( &*evtStore() , obj, pykey,allowMods,resetOnly,noHist );
  }
 
 
 
} //end of POOL namespace