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

#include <SimpleMergeMcEventCollTool.h>

Inheritance diagram for SimpleMergeMcEventCollTool:

Collaboration diagram for SimpleMergeMcEventCollTool:

Public Member Functions
	SimpleMergeMcEventCollTool (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
	return false if not interested in certain xing times (in ns) implemented by default in PileUpToolBase as FirstXing<=bunchXing<=LastXing

Private Member Functions
StatusCode	saveHeavyIonInfo (const McEventCollection pMcEvtColl, McEventCollection outputMcEventCollection)
	Common methods.
StatusCode	processEvent (const McEventCollection pMcEvtColl, McEventCollection outputMcEventCollection, const int currentBkgEventIndex, int bunchCrossingTime, int pileupType)
void	printDetailsOfMergedMcEventCollection (McEventCollection *outputMcEventCollection) const

Private Attributes
ServiceHandle< PileUpMergeSvc >	m_pMergeSvc {this, "PileUpMergeSvc", "PileUpMergeSvc", ""}
StringProperty	m_truthCollOutputKey {this, "TruthCollOutputKey", "TruthEvent", "Name of output McEventCollection"}
McEventCollection *	m_outputMcEventCollection {}
StringProperty	m_truthCollInputKey {this, "TruthCollInputKey", "TruthEvent", ""}
BooleanProperty	m_overrideEventNumbers {this, "OverrideEventNumbers", false, ""}
BooleanProperty	m_onlySaveSignalTruth {this, "OnlySaveSignalTruth", false, "Just save the Signal GenEvent"}
bool	m_newevent {true}
unsigned int	m_nInputMcEventColls {0}
unsigned int	m_nBkgEventsReadSoFar {0}

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

$Id:

Author: jchap.nosp@m.man@.nosp@m.cern..nosp@m.ch

Definition at line 26 of file SimpleMergeMcEventCollTool.h.

Constructor & Destructor Documentation

◆ SimpleMergeMcEventCollTool()

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

Definition at line 12 of file SimpleMergeMcEventCollTool.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.

49{ return m_filterPassed; }

PileUpToolBase::m_filterPassed

bool m_filterPassed

Definition PileUpToolBase.h:60

◆ initialize()

StatusCode SimpleMergeMcEventCollTool::initialize ( )

finaloverridevirtual

Reimplemented from PileUpToolBase.

Definition at line 19 of file SimpleMergeMcEventCollTool.cxx.

{
  if(!m_pMergeSvc.empty())
    {
       ATH_CHECK(m_pMergeSvc.retrieve());
    }
  return StatusCode::SUCCESS;
}

◆ mergeEvent()

StatusCode SimpleMergeMcEventCollTool::mergeEvent ( const EventContext & ctx )

finaloverridevirtual

called at the end of the subevts loop.

Not (necessarily) able to access SubEvents

Definition at line 77 of file SimpleMergeMcEventCollTool.cxx.

{
  ATH_MSG_DEBUG( "mergeEvent()" );
  if(m_nBkgEventsReadSoFar+1<m_nInputMcEventColls)
    {
      ATH_MSG_WARNING( "mergeEvent: Expected " << m_nInputMcEventColls << " subevents, but only saw " << m_nBkgEventsReadSoFar+1 << "! The job will probably crash now..." );
      return StatusCode::FAILURE;
    }
  if(msgLvl(MSG::VERBOSE)) { this->printDetailsOfMergedMcEventCollection(m_outputMcEventCollection); }
  return StatusCode::SUCCESS;
}

◆ prepareEvent()

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

finaloverridevirtual

called before the subevts loop.

PileUpTools Approach.

Not (necessarily) able to access SubEvents

Definition at line 29 of file SimpleMergeMcEventCollTool.cxx.

{
  ATH_MSG_VERBOSE ( "prepareEvent()" );
  m_nBkgEventsReadSoFar = 0;
  m_newevent = true;
 
  //Check we are getting at least one event
  m_nInputMcEventColls = nInputEvents;
  if (0 == m_nInputMcEventColls)
     {
      ATH_MSG_ERROR("prepareEvent: TimedTruthList with key "
                    << m_truthCollInputKey << " is empty");
      return StatusCode::RECOVERABLE;
    }
  ATH_MSG_DEBUG( "prepareEvent: there are " << m_nInputMcEventColls << " subevents in this event.");
 
  m_outputMcEventCollection = nullptr;
  return StatusCode::SUCCESS;
}

◆ printDetailsOfMergedMcEventCollection()

void SimpleMergeMcEventCollTool::printDetailsOfMergedMcEventCollection ( McEventCollection * outputMcEventCollection ) const

private

Definition at line 189 of file SimpleMergeMcEventCollTool.cxx.

{
  if (outputMcEventCollection->empty()) { return; }
  DataVector<HepMC::GenEvent>::const_iterator outputEventItr(outputMcEventCollection->begin());
  const DataVector<HepMC::GenEvent>::const_iterator endOfEvents(outputMcEventCollection->end());
  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);
      HepMC::Print::line(of,*(*outputEventItr)); // verbose output
      of.close();
      ++outputEventItr;
    }
  ATH_MSG_INFO ( "$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$" );
  return;
}

◆ processAllSubEvents()

StatusCode SimpleMergeMcEventCollTool::processAllSubEvents ( const EventContext & ctx )

finaloverridevirtual

return false if not interested in certain xing times (in ns) implemented by default in PileUpToolBase as FirstXing<=bunchXing<=LastXing

Algorithm Approach.

Reimplemented from PileUpToolBase.

Definition at line 90 of file SimpleMergeMcEventCollTool.cxx.

{
  ATH_MSG_VERBOSE ( "processAllSubEvents()" );
  SG::WriteHandle<McEventCollection> outputMcEventCollection(m_truthCollOutputKey.value());
  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));
 
  m_nBkgEventsReadSoFar=0;
  m_newevent = true;
 
  //Check we are getting at least one event
  m_nInputMcEventColls=truthList.size();
  if (0 == m_nInputMcEventColls)
    {
      ATH_MSG_ERROR("TimedTruthList with key " << m_truthCollInputKey << " is empty.");
      return StatusCode::RECOVERABLE;
    }
 
  ATH_MSG_DEBUG( "execute: there are " << m_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)
    {
      const PileUpTimeEventIndex& currentPileUpTimeEventIndex(timedTruthListIter->first); //time() , type()
      const McEventCollection *pBackgroundMcEvtColl(&*(timedTruthListIter->second));
      ATH_CHECK(this->processEvent(
                                   pBackgroundMcEvtColl,
                                   outputMcEventCollection.ptr(),
                                   currentPileUpTimeEventIndex.index(),
                                   static_cast<int>(currentPileUpTimeEventIndex.time()),
                                   static_cast<int>(currentPileUpTimeEventIndex.type())
                                   ));
      ++timedTruthListIter;
    } //timed colls
 
  if(msgLvl(MSG::VERBOSE)) { this->printDetailsOfMergedMcEventCollection(outputMcEventCollection.ptr()); }
  return StatusCode::SUCCESS;
}

◆ processBunchXing()

StatusCode SimpleMergeMcEventCollTool::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 49 of file SimpleMergeMcEventCollTool.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));
      ATH_MSG_DEBUG ("processBunchXing: SubEvt McEventCollection from StoreGate " << seStore.name() );
      if (!m_outputMcEventCollection) {
        m_outputMcEventCollection = new McEventCollection();
        ATH_CHECK(evtStore()->record(m_outputMcEventCollection, m_truthCollOutputKey));
      }
      ATH_CHECK(this->processEvent(
                                   pMEC,
                                   m_outputMcEventCollection,
                                   iEvt->index(),
                                   static_cast<int>(iEvt->time()),
                                   static_cast<int>(iEvt->type())
                                   ));
      ++iEvt;
    }
  return StatusCode::SUCCESS;
}

◆ processEvent()

StatusCode SimpleMergeMcEventCollTool::processEvent	(	const McEventCollection *	pMcEvtColl,
		McEventCollection *	outputMcEventCollection,
		const int	currentBkgEventIndex,
		int	bunchCrossingTime,
		int	pileupType )

private

Definition at line 152 of file SimpleMergeMcEventCollTool.cxx.

{
  ATH_MSG_VERBOSE ( "processEvent() Event Type: " << pileupType << ", BunchCrossingTime: " << bunchCrossingTime );
  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() || (m_onlySaveSignalTruth && !m_newevent) ) {
    ++m_nBkgEventsReadSoFar;
    return StatusCode::SUCCESS;
  }
 
  //GenEvt is there
 
  const HepMC::GenEvent& currentBackgroundEvent(**(pMcEvtColl->begin()));
  // FIXME no protection against multiple GenEvents having the same event number
  HepMC::GenEvent* copiedEvent = new HepMC::GenEvent(currentBackgroundEvent);
  if (m_overrideEventNumbers) {
    copiedEvent->set_event_number(currentBkgEventIndex);
  }
  HepMC::fillBarcodesAttribute(copiedEvent);
#ifdef HEPMC3
  copiedEvent->add_attribute("BunchCrossingTime",std::make_shared<HepMC3::IntAttribute>(bunchCrossingTime));
  copiedEvent->add_attribute("PileUpType",std::make_shared<HepMC3::IntAttribute>(pileupType));
#endif
   outputMcEventCollection->push_back(copiedEvent);
  ATH_CHECK(this->saveHeavyIonInfo(pMcEvtColl, outputMcEventCollection));
   m_newevent = false;
  ++m_nBkgEventsReadSoFar;
  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.

51{ m_filterPassed=true; }

◆ saveHeavyIonInfo()

StatusCode SimpleMergeMcEventCollTool::saveHeavyIonInfo	(	const McEventCollection *	pMcEvtColl,
		McEventCollection *	outputMcEventCollection )

private

Common methods.

Definition at line 136 of file SimpleMergeMcEventCollTool.cxx.

{
  if (outputMcEventCollection->at(0)->heavy_ion()) return StatusCode::SUCCESS;
  if (pMcEvtColl->at(0)->heavy_ion())
    {
//It should be clarified if we want to get a copy or the content
#ifdef HEPMC3
     HepMC::GenHeavyIonPtr hinew=std::make_shared<HepMC::GenHeavyIon>(*(pMcEvtColl->at(0)->heavy_ion()));
     outputMcEventCollection->at(0)->set_heavy_ion(std::move(hinew));
#else
      outputMcEventCollection->at(0)->set_heavy_ion(*(pMcEvtColl->at(0)->heavy_ion()));
#endif
    }
  return StatusCode::SUCCESS;
}

◆ 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.

60{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.

54 {this, "FirstXing", -999,

55 "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.

56 {this, "LastXing", 999,

57 "Last bunch-crossing in which det is live"};

◆ m_nBkgEventsReadSoFar

unsigned int SimpleMergeMcEventCollTool::m_nBkgEventsReadSoFar {0}

private

Definition at line 72 of file SimpleMergeMcEventCollTool.h.

72{0};

◆ m_newevent

bool SimpleMergeMcEventCollTool::m_newevent {true}

private

Definition at line 68 of file SimpleMergeMcEventCollTool.h.

68{true};

◆ m_nInputMcEventColls

unsigned int SimpleMergeMcEventCollTool::m_nInputMcEventColls {0}

private

Definition at line 70 of file SimpleMergeMcEventCollTool.h.

70{0};

◆ m_onlySaveSignalTruth

BooleanProperty SimpleMergeMcEventCollTool::m_onlySaveSignalTruth {this, "OnlySaveSignalTruth", false, "Just save the Signal GenEvent"}

private

Definition at line 66 of file SimpleMergeMcEventCollTool.h.

66{this, "OnlySaveSignalTruth", false, "Just save the Signal GenEvent"};

◆ m_outputMcEventCollection

McEventCollection* SimpleMergeMcEventCollTool::m_outputMcEventCollection {}

private

Definition at line 60 of file SimpleMergeMcEventCollTool.h.

60{};

◆ m_overrideEventNumbers

BooleanProperty SimpleMergeMcEventCollTool::m_overrideEventNumbers {this, "OverrideEventNumbers", false, ""}

private

Definition at line 64 of file SimpleMergeMcEventCollTool.h.

64{this, "OverrideEventNumbers", false, ""};

◆ m_pMergeSvc

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

private

Definition at line 58 of file SimpleMergeMcEventCollTool.h.

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

◆ m_truthCollInputKey

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

private

Definition at line 62 of file SimpleMergeMcEventCollTool.h.

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

◆ m_truthCollOutputKey

StringProperty SimpleMergeMcEventCollTool::m_truthCollOutputKey {this, "TruthCollOutputKey", "TruthEvent", "Name of output McEventCollection"}

private

Definition at line 59 of file SimpleMergeMcEventCollTool.h.

59{this, "TruthCollOutputKey", "TruthEvent", "Name of output McEventCollection"};

◆ 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.

58 {this, "VetoPileUpTruthLinks", true,

59 "Ignore links to suppressed pile-up truth"};

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

Public Member Functions

Private Member Functions

Private Attributes

structors and AlgTool implementation

Detailed Description

Constructor & Destructor Documentation

◆ SimpleMergeMcEventCollTool()

Member Function Documentation

◆ filterPassed()

◆ initialize()

◆ mergeEvent()

◆ prepareEvent()

◆ printDetailsOfMergedMcEventCollection()

◆ processAllSubEvents()

◆ processBunchXing()

◆ processEvent()

◆ resetFilter()

◆ saveHeavyIonInfo()

◆ toProcess()

Member Data Documentation

◆ m_filterPassed

◆ m_firstXing

◆ m_lastXing

◆ m_nBkgEventsReadSoFar

◆ m_newevent

◆ m_nInputMcEventColls

◆ m_onlySaveSignalTruth

◆ m_outputMcEventCollection

◆ m_overrideEventNumbers

◆ m_pMergeSvc

◆ m_truthCollInputKey

◆ m_truthCollOutputKey

◆ m_vetoPileUpTruthLinks