NewMergeMcEventCollTool Class Reference

a PileUpTool to merge MC truth collection in the overlay store More...

#include <NewMergeMcEventCollTool.h>

Inheritance diagram for NewMergeMcEventCollTool:

Collaboration diagram for NewMergeMcEventCollTool:

Public Member Functions
	NewMergeMcEventCollTool (const std::string &type, const std::string &name, const IInterface *parent)
virtual StatusCode	initialize () override final
virtual StatusCode	prepareEvent (const EventContext &ctx, unsigned int nInputEvents) override final
	called before the subevts loop.
virtual StatusCode	mergeEvent (const EventContext &ctx) override final
	called at the end of the subevts loop.
virtual StatusCode	processBunchXing (int, SubEventIterator bSubEvents, SubEventIterator eSubEvents) override final
	called for each active bunch-crossing to process current SubEvents bunchXing is in ns
virtual StatusCode	processAllSubEvents (const EventContext &ctx) override final
	Algorithm Approach.

Private Member Functions
StatusCode	processEvent (const McEventCollection *pMcEvtColl, McEventCollection *outputMcEventCollection, int pileupType, long timeOffset=0)
void	printDetailsOfMergedMcEventCollection (McEventCollection *outputMcEventCollection) const

Private Attributes
ServiceHandle< PileUpMergeSvc >	m_pMergeSvc {this, "PileUpMergeSvc", "PileUpMergeSvc", ""}
StringProperty	m_truthCollInputKey {this,"TruthCollInputKey", "TruthEvent", ""}
Gaudi::Property< int >	m_pileUpType {this, "PileUpType", -1, ""}
SG::WriteHandle< McEventCollection >	m_outputMcEventCollection {}
SG::WriteHandleKey< McEventCollection >	m_truthCollOutputKey {this, "TruthCollOutputKey","TruthEvent",""}

structors and AlgTool implementation
virtual bool	toProcess (int bunchXing) const override
	the method this base class helps implementing
virtual bool	filterPassed () const override
	dummy implementation of passing filter
virtual void	resetFilter () override
	dummy implementation of filter reset
Gaudi::Property< int >	m_firstXing
Gaudi::Property< int >	m_lastXing
Gaudi::Property< int >	m_vetoPileUpTruthLinks
bool	m_filterPassed {true}

Detailed Description

a PileUpTool to merge MC truth collection in the overlay store

Definition at line 24 of file NewMergeMcEventCollTool.h.

Constructor & Destructor Documentation

NewMergeMcEventCollTool()

NewMergeMcEventCollTool::NewMergeMcEventCollTool	(	const std::string &	type,
		const std::string &	name,
		const IInterface *	parent )

Definition at line 8 of file NewMergeMcEventCollTool.cxx.

                                                                           :
  PileUpToolBase(type, name, parent)
{
}

Member Function Documentation

filterPassed()

virtual bool PileUpToolBase::filterPassed ( ) const

inlineoverridevirtualinherited

dummy implementation of passing filter

Definition at line 49 of file PileUpToolBase.h.

{ return m_filterPassed; }

initialize()

StatusCode NewMergeMcEventCollTool::initialize ( )

finaloverridevirtual

Reimplemented from PileUpToolBase.

Definition at line 15 of file NewMergeMcEventCollTool.cxx.

{
  ATH_CHECK(m_pMergeSvc.retrieve());
 
  ATH_CHECK( m_truthCollOutputKey.initialize() );
  return StatusCode::SUCCESS;
}

mergeEvent()

StatusCode NewMergeMcEventCollTool::mergeEvent ( const EventContext & ctx )

finaloverridevirtual

called at the end of the subevts loop.

Not (necessarily) able to access SubEvents

Definition at line 72 of file NewMergeMcEventCollTool.cxx.

{
  ATH_MSG_VERBOSE(  this->name()<<"::mergeEvent()" );
  if(msgLvl(MSG::VERBOSE)) { this->printDetailsOfMergedMcEventCollection(m_outputMcEventCollection.ptr()); }
  return StatusCode::SUCCESS;
}

prepareEvent()

StatusCode NewMergeMcEventCollTool::prepareEvent ( const EventContext & ctx, unsigned int nInputEvents )

finaloverridevirtual

called before the subevts loop.

PileUpTools Approach.

Not (necessarily) able to access SubEvents

Definition at line 24 of file NewMergeMcEventCollTool.cxx.

{
  ATH_MSG_VERBOSE( this->name()<<"::prepareEvent()" );
 
  //Check we are getting at least one event
  if (0 == nInputEvents) {
    ATH_MSG_ERROR("prepareEvent: TimedTruthList with key "
                  << m_truthCollInputKey.value() << " is empty");
    return StatusCode::RECOVERABLE;
  }
  ATH_MSG_VERBOSE(  this->name()<<"::prepareEvent: there are " << nInputEvents << " subevents in this event.");
 
  if (!m_outputMcEventCollection.isValid()) {
    // Would be nice to avoid having the WriteHandle as a member
    // variable, but this is the only way to allow multiple function
    // calls to add information to the version of the
    // McEventCollection in the output StoreGate
    m_outputMcEventCollection = SG::makeHandle(m_truthCollOutputKey, ctx);
    ATH_CHECK(m_outputMcEventCollection.record(std::make_unique<McEventCollection>()));
  }
  else {
    ATH_MSG_ERROR("WriteHandle already valid??");
    return StatusCode::FAILURE;
  }
 
  return StatusCode::SUCCESS;
}

printDetailsOfMergedMcEventCollection()

void NewMergeMcEventCollTool::printDetailsOfMergedMcEventCollection ( McEventCollection * outputMcEventCollection ) const

private

Definition at line 153 of file NewMergeMcEventCollTool.cxx.

{
  DataVector<HepMC::GenEvent>::const_iterator outputEventItr(outputMcEventCollection->begin());
  const DataVector<HepMC::GenEvent>::const_iterator endOfEvents(outputMcEventCollection->end());
  ATH_MSG_INFO ( "$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$" );
  ATH_MSG_INFO ( "pileUpType: " << m_pileUpType);
  ATH_MSG_INFO ( "$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$" );
  ATH_MSG_INFO ( "Current OUTPUT GenEvent: " );
  while(outputEventItr!=endOfEvents) {
    const int signal_process_id(HepMC::signal_process_id((*outputEventItr)));
    const int event_number((*outputEventItr)->event_number());
    ATH_MSG_INFO ( "GenEvent #"<<event_number<<", signal_process_id="<<signal_process_id<</*", category="<<event->second<<*/", number of Vertices="<<(*outputEventItr)->vertices_size() );
    char fname[80];
    sprintf(fname,"%s.event%d.txt",m_truthCollInputKey.value().c_str(),event_number);
    std::ofstream of(fname);
    const HepMC::GenEvent *evt=(*outputEventItr);
    HepMC::Print::line(of,*evt); // verbose output
    of.close();
    ++outputEventItr;
  }
  ATH_MSG_INFO ( "$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$" );
  return;
}

processAllSubEvents()

StatusCode NewMergeMcEventCollTool::processAllSubEvents ( const EventContext & ctx )

finaloverridevirtual

Algorithm Approach.

Reimplemented from PileUpToolBase.

Definition at line 80 of file NewMergeMcEventCollTool.cxx.

{
  ATH_MSG_VERBOSE ( this->name()<<"::processAllSubEvents()" );
  SG::WriteHandle<McEventCollection> outputMcEventCollection(m_truthCollOutputKey, ctx);
  ATH_CHECK(outputMcEventCollection.record(std::make_unique<McEventCollection>()));
 
  //first get the list of McEventCollections
  typedef PileUpMergeSvc::TimedList<McEventCollection>::type TimedTruthList;
  TimedTruthList truthList;
  ATH_CHECK(m_pMergeSvc->retrieveSubEvtsData(m_truthCollInputKey.value(), truthList));
 
  //Check we are getting at least one event
  const unsigned int nInputMcEventColls=truthList.size();
  if (0 == nInputMcEventColls) {
    ATH_MSG_WARNING("TimedTruthList with key " << m_truthCollInputKey.value() << " is empty.");
    return StatusCode::SUCCESS;
  }
 
  ATH_MSG_DEBUG( "execute: there are " << nInputMcEventColls << " subevents in this event.");
  //TODO can we make this into an auto for loop?
  TimedTruthList::iterator timedTruthListIter(truthList.begin()), endOfTimedTruthList(truthList.end());
  //loop over the McEventCollections (each one assumed to containing exactly one GenEvent) of the various input events
  while (timedTruthListIter != endOfTimedTruthList) {
    ATH_MSG_VERBOSE( this->name()<<"::processBunchXing: SubEvt McEventCollection of PileUpType " << timedTruthListIter->first.type() );
    if(m_pileUpType==timedTruthListIter->first.type()) {
      const McEventCollection *pBackgroundMcEvtColl(&*(timedTruthListIter->second));
      ATH_CHECK(this->processEvent(pBackgroundMcEvtColl, outputMcEventCollection.ptr(), static_cast<int>(timedTruthListIter->first.type()), timedTruthListIter->first.time()));
    }
    ++timedTruthListIter;
  } //timed colls
 
  if(msgLvl(MSG::VERBOSE)) { this->printDetailsOfMergedMcEventCollection(outputMcEventCollection.ptr()); }
  return StatusCode::SUCCESS;
}

processBunchXing()

StatusCode NewMergeMcEventCollTool::processBunchXing ( int , SubEventIterator bSubEvents, SubEventIterator eSubEvents )

finaloverridevirtual

called for each active bunch-crossing to process current SubEvents bunchXing is in ns

Reimplemented from PileUpToolBase.

Definition at line 52 of file NewMergeMcEventCollTool.cxx.

{
  SubEventIterator iEvt(bSubEvents);
  //loop over the McEventCollections (each one assumed to containing exactly one GenEvent) of the various input events
  while (iEvt != eSubEvents){
    StoreGateSvc& seStore(*iEvt->ptr()->evtStore());
    const McEventCollection *pMEC(nullptr);
    ATH_CHECK(seStore.retrieve(pMEC, m_truthCollInputKey.value()));
    ATH_MSG_VERBOSE( this->name()<<"::processBunchXing: SubEvt McEventCollection from StoreGate " << seStore.name() << " of PileUpType " << iEvt->type() );
    if(m_pileUpType==iEvt->type()) {
      ATH_CHECK(this->processEvent(pMEC, m_outputMcEventCollection.ptr(),
                                   static_cast<int>(iEvt->type()), iEvt->time()));
    }
    ++iEvt;
  }
  return StatusCode::SUCCESS;
}

processEvent()

StatusCode NewMergeMcEventCollTool::processEvent ( const McEventCollection * pMcEvtColl, McEventCollection * outputMcEventCollection, int pileupType, long timeOffset = 0 )

private

Definition at line 115 of file NewMergeMcEventCollTool.cxx.

{
  ATH_MSG_VERBOSE(  this->name()<<"::processEvent() Event Type: " << pileupType );
  if (!outputMcEventCollection) {
    ATH_MSG_ERROR( this->name()<<"::processEvent() was passed an null output McEventCollection pointer." );
    return StatusCode::FAILURE;
  }
  if (!pMcEvtColl) {
    ATH_MSG_ERROR( this->name()<<"::processEvent() was passed an null input McEventCollection pointer." );
    return StatusCode::FAILURE;
  }
  if (!pMcEvtColl->empty()) {
    for (unsigned int iEv=0; iEv<pMcEvtColl->size(); iEv++) {
      const HepMC::GenEvent& c_evt(*((*pMcEvtColl)[iEv]));
#ifdef HEPMC3
      HepMC::GenEvent * evt = new HepMC::GenEvent(c_evt);
      HepMC::fillBarcodesAttribute(evt);
      const int bunchCrossingTime=static_cast<int>(timeOffset);
      evt->add_attribute("BunchCrossingTime",std::make_shared<HepMC3::IntAttribute>(bunchCrossingTime));
      evt->add_attribute("PileUpType",std::make_shared<HepMC3::IntAttribute>(pileupType));
      for (const auto&  itVer:  evt->vertices()) {
        HepMC::FourVector newPos(itVer->position().x(),itVer->position().y(),itVer->position().z(),itVer->position().t()+timeOffset);
        itVer->set_position(newPos);
      }
      outputMcEventCollection->push_back(evt);
#else
      HepMC::GenEvent * evt = new HepMC::GenEvent(c_evt);
      for (HepMC::GenEvent::vertex_iterator itVer=evt->vertices_begin(); itVer!=evt->vertices_end(); ++itVer) {
        HepMC::FourVector newPos((*itVer)->position().x(),(*itVer)->position().y(),(*itVer)->position().z(),(*itVer)->position().t()+timeOffset);
        (*itVer)->set_position(newPos);
      }
      outputMcEventCollection->push_back(evt);
#endif
    }
  }
  return StatusCode::SUCCESS;
}

resetFilter()

virtual void PileUpToolBase::resetFilter ( )

inlineoverridevirtualinherited

dummy implementation of filter reset

Reimplemented in MergeTruthJetsTool.

Definition at line 51 of file PileUpToolBase.h.

{ m_filterPassed=true; }

toProcess()

virtual bool PileUpToolBase::toProcess ( int bunchXing ) const

inlineoverridevirtualinherited

the method this base class helps implementing

Reimplemented in MergeHijingParsTool, and MergeTrackRecordCollTool.

Definition at line 32 of file PileUpToolBase.h.

                                                       {
    //closed interval [m_firstXing,m_lastXing]
    return !((m_firstXing > bunchXing) || (bunchXing > m_lastXing));
  }

Member Data Documentation

m_filterPassed

bool PileUpToolBase::m_filterPassed {true}

protectedinherited

Definition at line 60 of file PileUpToolBase.h.

{true}; 

m_firstXing

Gaudi::Property<int> PileUpToolBase::m_firstXing

protectedinherited

Initial value:

{this, "FirstXing", -999,
      "First bunch-crossing in which det is live"}

Definition at line 54 of file PileUpToolBase.h.

                                {this, "FirstXing", -999,
      "First bunch-crossing in which det is live"};

m_lastXing

Gaudi::Property<int> PileUpToolBase::m_lastXing

protectedinherited

Initial value:

{this, "LastXing", 999,
      "Last bunch-crossing in which det is live"}

Definition at line 56 of file PileUpToolBase.h.

                                {this, "LastXing", 999,
      "Last bunch-crossing in which det is live"};

m_outputMcEventCollection

SG::WriteHandle<McEventCollection> NewMergeMcEventCollTool::m_outputMcEventCollection {}

private

Definition at line 57 of file NewMergeMcEventCollTool.h.

{};

m_pileUpType

Gaudi::Property<int> NewMergeMcEventCollTool::m_pileUpType {this, "PileUpType", -1, ""}

private

Definition at line 55 of file NewMergeMcEventCollTool.h.

{this, "PileUpType", -1, ""}; // initialise to PileUpTimeEventIndex::PileUpType::Unknown

m_pMergeSvc

ServiceHandle<PileUpMergeSvc> NewMergeMcEventCollTool::m_pMergeSvc {this, "PileUpMergeSvc", "PileUpMergeSvc", ""}

private

Definition at line 51 of file NewMergeMcEventCollTool.h.

{this, "PileUpMergeSvc", "PileUpMergeSvc", ""};

m_truthCollInputKey

StringProperty NewMergeMcEventCollTool::m_truthCollInputKey {this,"TruthCollInputKey", "TruthEvent", ""}

private

Definition at line 53 of file NewMergeMcEventCollTool.h.

{this,"TruthCollInputKey", "TruthEvent", ""};

m_truthCollOutputKey

SG::WriteHandleKey<McEventCollection> NewMergeMcEventCollTool::m_truthCollOutputKey {this, "TruthCollOutputKey","TruthEvent",""}

private

Definition at line 59 of file NewMergeMcEventCollTool.h.

{this, "TruthCollOutputKey","TruthEvent",""};

m_vetoPileUpTruthLinks

Gaudi::Property<int> PileUpToolBase::m_vetoPileUpTruthLinks

protectedinherited

Initial value:

{this, "VetoPileUpTruthLinks", true,
      "Ignore links to suppressed pile-up truth"}

Definition at line 58 of file PileUpToolBase.h.

                                           {this, "VetoPileUpTruthLinks", true,
      "Ignore links to suppressed pile-up truth"};

---

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

• NewMergeMcEventCollTool.h
• NewMergeMcEventCollTool.cxx