#include <LHESource.h>

Inheritance diagram for LHESource:

Public Member Functions
	LHESource (const edm::ParameterSet &params, const edm::InputSourceDescription &desc)

	~LHESource () override

Public Member Functions inherited from edm::ProducerSourceFromFiles
bool	noFiles () const override

	ProducerSourceFromFiles (ParameterSet const &pset, InputSourceDescription const &desc, bool realData)

	~ProducerSourceFromFiles () override

Public Member Functions inherited from edm::ProducerSourceBase
	ProducerSourceBase (ParameterSet const &pset, InputSourceDescription const &desc, bool realData)

	~ProducerSourceBase ()(false) override

Public Member Functions inherited from edm::IDGeneratorSourceBase< PuttableSourceBase >
EventNumber_t	event () const

unsigned int	eventCreationDelay () const

EventID const &	eventID () const

	IDGeneratorSourceBase (ParameterSet const &pset, InputSourceDescription const &desc, bool realData)

LuminosityBlockNumber_t	luminosityBlock () const

unsigned int	numberEventsInLumi () const

unsigned int	numberEventsInRun () const

unsigned int	numberEventsInThisLumi () const

unsigned int	numberEventsInThisRun () const

TimeValue_t	presentTime () const

RunNumber_t	run () const

unsigned int	timeBetweenEvents () const

	~IDGeneratorSourceBase ()(false) override

Public Member Functions inherited from edm::PuttableSourceBase
bool	hasAbilityToProduceInBeginLumis () const final

bool	hasAbilityToProduceInBeginRuns () const final

	PuttableSourceBase (ParameterSet const &, InputSourceDescription const &)

void	registerProducts () final
	Register any produced products. More...

Public Member Functions inherited from edm::InputSource
std::shared_ptr< ActivityRegistry >	actReg () const
	Accessor for Activity Registry. More...

std::shared_ptr< BranchIDListHelper const >	branchIDListHelper () const
	Accessors for branchIDListHelper. More...

std::shared_ptr< BranchIDListHelper > &	branchIDListHelper ()

void	closeFile (FileBlock *, bool cleaningUpAfterException)
	close current file More...

void	doBeginJob ()
	Called by framework at beginning of job. More...

void	doEndJob ()
	Called by framework at end of job. More...

ProcessingController::ForwardState	forwardState () const

bool	goToEvent (EventID const &eventID)

	InputSource (ParameterSet const &, InputSourceDescription const &)
	Constructor. More...

	InputSource (InputSource const &)=delete

void	issueReports (EventID const &eventID, StreamID streamID)
	issue an event report More...

LuminosityBlockNumber_t	luminosityBlock () const
	Accessor for current luminosity block number. More...

std::shared_ptr< LuminosityBlockAuxiliary >	luminosityBlockAuxiliary () const
	Called by the framework to merge or insert lumi in principal cache. More...

int	maxEvents () const

int	maxLuminosityBlocks () const

ModuleDescription const &	moduleDescription () const
	Accessor for 'module' description. More...

ItemType	nextItemType ()
	Advances the source to the next item. More...

InputSource &	operator= (InputSource const &)=delete

ProcessConfiguration const &	processConfiguration () const
	Accessor for Process Configuration. More...

std::string const &	processGUID () const
	Accessor for global process identifier. More...

ProcessHistoryRegistry const &	processHistoryRegistry () const
	Accessors for process history registry. More...

ProcessHistoryRegistry &	processHistoryRegistry ()

ProcessingMode	processingMode () const
	RunsLumisAndEvents (default), RunsAndLumis, or Runs. More...

std::shared_ptr< ProductRegistry const >	productRegistry () const
	Accessors for product registry. More...

std::shared_ptr< ProductRegistry > &	productRegistry ()

bool	randomAccess () const

void	readAndMergeLumi (LuminosityBlockPrincipal &lbp)
	Read next luminosity block (same as a prior lumi) More...

void	readAndMergeRun (RunPrincipal &rp)
	Read next run (same as a prior run) More...

void	readEvent (EventPrincipal &ep, StreamContext &)
	Read next event. More...

bool	readEvent (EventPrincipal &ep, EventID const &, StreamContext &)
	Read a specific event. More...

std::unique_ptr< FileBlock >	readFile ()
	Read next file. More...

void	readLuminosityBlock (LuminosityBlockPrincipal &lumiPrincipal, HistoryAppender &historyAppender)
	Read next luminosity block (new lumi) More...

std::shared_ptr< LuminosityBlockAuxiliary >	readLuminosityBlockAuxiliary ()
	Read next luminosity block Auxilary. More...

void	readRun (RunPrincipal &runPrincipal, HistoryAppender &historyAppender)
	Read next run (new run) More...

std::shared_ptr< RunAuxiliary >	readRunAuxiliary ()
	Read next run Auxiliary. More...

ProcessHistoryID const &	reducedProcessHistoryID () const

int	remainingEvents () const

int	remainingLuminosityBlocks () const

void	repeat ()
	Reset the remaining number of events/lumis to the maximum number. More...

std::pair< SharedResourcesAcquirer , std::recursive_mutex >	resourceSharedWithDelayedReader ()
	Returns nullptr if no resource shared between the Source and a DelayedReader. More...

ProcessingController::ReverseState	reverseState () const

void	rewind ()
	Begin again at the first event. More...

RunNumber_t	run () const
	Accessor for current run number. More...

std::shared_ptr< RunAuxiliary >	runAuxiliary () const
	Called by the framework to merge or insert run in principal cache. More...

void	setLuminosityBlockNumber_t (LuminosityBlockNumber_t lb)
	Set the luminosity block ID. More...

void	setRunNumber (RunNumber_t r)
	Set the run number. More...

void	skipEvents (int offset)

std::shared_ptr< ThinnedAssociationsHelper const >	thinnedAssociationsHelper () const
	Accessors for thinnedAssociationsHelper. More...

std::shared_ptr< ThinnedAssociationsHelper > &	thinnedAssociationsHelper ()

Timestamp const &	timestamp () const
	Accessor for the current time, as seen by the input source. More...

virtual	~InputSource () noexcept(false)
	Destructor. More...

Public Member Functions inherited from edm::ProducerBase
void	callWhenNewProductsRegistered (std::function< void(BranchDescription const &)> const &func)

std::vector< edm::ProductResolverIndex > const &	indiciesForPutProducts (BranchType iBranchType) const

	ProducerBase ()

std::vector< edm::ProductResolverIndex > const &	putTokenIndexToProductResolverIndex () const

void	registerProducts (ProducerBase , ProductRegistry , ModuleDescription const &)

std::function< void(BranchDescription const &)>	registrationCallback () const
	used by the fwk to register list of products More...

void	resolvePutIndicies (BranchType iBranchType, ModuleToResolverIndicies const &iIndicies, std::string const &moduleLabel)

	~ProducerBase () noexcept(false) override

Static Public Member Functions
static void	fillDescriptions (edm::ConfigurationDescriptions &descriptions)

Static Public Member Functions inherited from edm::ProducerSourceFromFiles
static void	fillDescription (ParameterSetDescription &desc)

Static Public Member Functions inherited from edm::IDGeneratorSourceBase< PuttableSourceBase >
static void	fillDescription (ParameterSetDescription &desc)

Static Public Member Functions inherited from edm::InputSource
static const std::string &	baseType ()

static void	fillDescription (ParameterSetDescription &desc)

static void	fillDescriptions (ConfigurationDescriptions &descriptions)

static void	prevalidate (ConfigurationDescriptions &)

Private Member Functions
void	endJob () override

void	fillRunInfoProduct (lhef::LHERunInfo const &, LHERunInfoProduct &)

void	nextEvent ()

void	produce (edm::Event &) override

void	putRunInfoProduct (edm::RunPrincipal &)

void	readEvent_ (edm::EventPrincipal &eventPrincipal) override

void	readLuminosityBlock_ (edm::LuminosityBlockPrincipal &lumiPrincipal) override

std::shared_ptr< edm::LuminosityBlockAuxiliary >	readLuminosityBlockAuxiliary_ () override

void	readRun_ (edm::RunPrincipal &runPrincipal) override

std::shared_ptr< edm::RunAuxiliary >	readRunAuxiliary_ () override

bool	setRunAndEventInfo (edm::EventID &, edm::TimeValue_t &, edm::EventAuxiliary::ExperimentType &) override

Private Attributes
edm::LHEProvenanceHelper	lheProvenanceHelper_

std::shared_ptr< lhef::LHEEvent >	partonLevel_

edm::ProcessHistoryID	phid_

std::unique_ptr< lhef::LHEReader >	reader_

std::shared_ptr< lhef::LHERunInfo >	runInfoLast_

std::unique_ptr< LHERunInfoProduct >	runInfoProductLast_

Additional Inherited Members
Public Types inherited from edm::InputSource
enum	ItemType { IsInvalid, IsStop, IsFile, IsRun, IsLumi, IsEvent, IsRepeat, IsSynchronize }

enum	ProcessingMode { Runs, RunsAndLumis, RunsLumisAndEvents }

Public Types inherited from edm::ProducerBase
using	ModuleToResolverIndicies = std::unordered_multimap< std::string, std::tuple< edm::TypeID const , const char , edm::ProductResolverIndex >>

typedef ProductRegistryHelper::TypeLabelList	TypeLabelList

Public Attributes inherited from edm::InputSource
signalslot::Signal< void(StreamContext const &, ModuleCallingContext const &)>	postEventReadFromSourceSignal_

signalslot::Signal< void(StreamContext const &, ModuleCallingContext const &)>	preEventReadFromSourceSignal_

Protected Member Functions inherited from edm::IDGeneratorSourceBase< PuttableSourceBase >
void	doReadEvent (EventPrincipal &eventPrincipal, F &&f)

Protected Member Functions inherited from edm::InputSource
void	decreaseRemainingEventsBy (int iSkipped)

bool	eventCached () const

bool	newLumi () const

bool	newRun () const

ProcessHistoryRegistry &	processHistoryRegistryForUpdate ()

ProductRegistry &	productRegistryUpdate ()

void	reset () const

void	resetEventCached ()

void	resetLuminosityBlockAuxiliary (bool isNewLumi=true) const

void	resetNewLumi ()

void	resetNewRun ()

void	resetRunAuxiliary (bool isNewRun=true) const

void	setEventCached ()
	Called by the framework to merge or ached() const {return eventCached_;}. More...

void	setLuminosityBlockAuxiliary (LuminosityBlockAuxiliary *lbp)

void	setNewLumi ()

void	setNewRun ()

void	setRunAuxiliary (RunAuxiliary *rp)

void	setTimestamp (Timestamp const &theTime)
	To set the current time, as seen by the input source. More...

ItemType	state () const

Protected Member Functions inherited from edm::ProducerBase
ProducesCollector	producesCollector ()

Detailed Description

Definition at line 33 of file LHESource.h.

Constructor & Destructor Documentation

LHESource::LHESource	(	const edm::ParameterSet &	params,
		const edm::InputSourceDescription &	desc
	)

explicit

Definition at line 35 of file LHESource.cc.

References edm::LHEProvenanceHelper::lheAugment(), edm::LHEProvenanceHelper::lheInit(), lheProvenanceHelper_, nextEvent(), phid_, and edm::InputSource::processHistoryRegistryForUpdate().

     : ProducerSourceFromFiles(params, desc, false),
       reader_(new LHEReader(fileNames(), params.getUntrackedParameter<unsigned int>("skipEvents", 0))),
       lheProvenanceHelper_(
           edm::TypeID(typeid(LHEEventProduct)), edm::TypeID(typeid(LHERunInfoProduct)), productRegistryUpdate()),
       phid_() {
   nextEvent();
   lheProvenanceHelper_.lheAugment(nullptr);
   // Initialize metadata, and save the process history ID for use every event.
   phid_ = lheProvenanceHelper_.lheInit(processHistoryRegistryForUpdate());
 
   // These calls are not wanted, because the principals are used for putting the products.
   //produces<LHEEventProduct>();
   //produces<LHERunInfoProduct, edm::InRun>();
 }

LHESource::~LHESource ( )

override

Definition at line 51 of file LHESource.cc.

51 {}

Member Function Documentation

void LHESource::endJob ( void )

overrideprivatevirtual

Reimplemented from edm::InputSource.

Definition at line 53 of file LHESource.cc.

References reader_.

53 { reader_.reset(); }

LHESource::reader_

std::unique_ptr< lhef::LHEReader > reader_

Definition: LHESource.h:55

void LHESource::fillDescriptions ( edm::ConfigurationDescriptions & descriptions )

static

Definition at line 186 of file LHESource.cc.

References edm::ConfigurationDescriptions::add(), edm::ParameterSetDescription::addUntracked(), DEFINE_FWK_INPUT_SOURCE, edm::ProducerSourceFromFiles::fillDescription(), edm::ParameterSetDescription::setComment(), and mitigatedMETSequence_cff::U.

                                                                            {
   edm::ParameterSetDescription desc;
   desc.setComment("A source which reads LHE files.");
   edm::ProducerSourceFromFiles::fillDescription(desc);
   desc.addUntracked<unsigned int>("skipEvents", 0U)->setComment("Skip the first 'skipEvents' events.");
   descriptions.add("source", desc);
 }

void LHESource::fillRunInfoProduct	(	lhef::LHERunInfo const &	iInfo,
		LHERunInfoProduct &	oProduct
	)

private

Definition at line 94 of file LHESource.cc.

References LHERunInfoProduct::addComment(), LHERunInfoProduct::addHeader(), HltBtagPostValidation_cff::c, lhef::LHERunInfo::getComments(), lhef::LHERunInfo::getHeaders(), and h.

Referenced by nextEvent().

                                                                                            {
   for (auto const& h : iInfo.getHeaders()) {
     oProduct.addHeader(h);
   }
   for (auto const& c : iInfo.getComments()) {
     oProduct.addComment(c);
   }
 }

void LHESource::nextEvent ( )

private

Definition at line 55 of file LHESource.cc.

References fillRunInfoProduct(), edm::FromFiles::incrementFileIndex(), edm::LHEProvenanceHelper::lheAugment(), edm::LHEProvenanceHelper::lheInit(), lheProvenanceHelper_, lhe2HepMCConverter_cff::LHERunInfoProduct, eostools::move(), partonLevel_, phid_, edm::InputSource::processHistoryRegistryForUpdate(), reader_, edm::InputSource::resetRunAuxiliary(), runInfoLast_, and runInfoProductLast_.

Referenced by LHESource(), and setRunAndEventInfo().

                           {
   if (partonLevel_) {
     return;
   }
 
   bool newFileOpened;
   do {
     newFileOpened = false;
     partonLevel_ = reader_->next(&newFileOpened);
     if (newFileOpened) {
       incrementFileIndex();
     }
   } while (newFileOpened && !partonLevel_);
 
   if (!partonLevel_) {
     return;
   }
 
   auto runInfoThis = partonLevel_->getRunInfo();
   if (runInfoThis != runInfoLast_) {
     runInfoLast_ = runInfoThis;
     std::unique_ptr<LHERunInfoProduct> product(new LHERunInfoProduct(*runInfoThis->getHEPRUP()));
     fillRunInfoProduct(*runInfoThis, *product);
 
     if (runInfoProductLast_) {
       if (!runInfoProductLast_->mergeProduct(*product)) {
         //cannot be merged so must start new Run
         runInfoProductLast_ = std::move(product);
         lheProvenanceHelper_.lheAugment(runInfoThis.get());
         // Initialize metadata, and save the process history ID for use every event.
         phid_ = lheProvenanceHelper_.lheInit(processHistoryRegistryForUpdate());
         resetRunAuxiliary();
       }
     } else {
       runInfoProductLast_ = std::move(product);
     }
   }
 }

void LHESource::produce ( edm::Event & )

inlineoverrideprivatevirtual

Implements edm::ProducerSourceBase.

Definition at line 46 of file LHESource.h.

46 {}

void LHESource::putRunInfoProduct ( edm::RunPrincipal & iRunPrincipal )

private

Definition at line 115 of file LHESource.cc.

References lheProvenanceHelper_, eostools::move(), edm::RunPrincipal::put(), runInfoProductLast_, and edm::LHEProvenanceHelper::runProductBranchDescription_.

Referenced by readRun_().

                                                                 {
   if (runInfoProductLast_) {
     auto product = std::make_unique<LHERunInfoProduct>(*runInfoProductLast_);
     std::unique_ptr<edm::WrapperBase> rdp(new edm::Wrapper<LHERunInfoProduct>(std::move(product)));
     iRunPrincipal.put(lheProvenanceHelper_.runProductBranchDescription_, std::move(rdp));
   }
 }

void LHESource::readEvent_ ( edm::EventPrincipal & eventPrincipal )

overrideprivatevirtual

Reimplemented from edm::ProducerSourceBase.

Definition at line 136 of file LHESource.cc.

References LHEEventProduct::addComment(), LHEEventProduct::addWeight(), printConversionInfo::aux, edm::InputSource::eventCached(), edm::IDGeneratorSourceBase< PuttableSourceBase >::eventID(), edm::LHEProvenanceHelper::eventProductBranchDescription_, edm::LHEProvenanceHelper::eventProductProvenance_, edm::EventPrincipal::fillEventPrincipal(), lhe2HepMCConverter_cff::LHEEventProduct, lheProvenanceHelper_, eostools::move(), partonLevel_, phid_, edm::IDGeneratorSourceBase< PuttableSourceBase >::presentTime(), edm::InputSource::processGUID(), edm::InputSource::processHistoryRegistryForUpdate(), edm::InputSource::processingMode(), edm::EventPrincipal::put(), edm::InputSource::resetEventCached(), edm::InputSource::RunsLumisAndEvents, and edm::EventAuxiliary::setProcessHistoryID().

                                                             {
   assert(eventCached() || processingMode() != RunsLumisAndEvents);
   edm::EventAuxiliary aux(eventID(), processGUID(), edm::Timestamp(presentTime()), false);
   aux.setProcessHistoryID(phid_);
   eventPrincipal.fillEventPrincipal(aux, processHistoryRegistryForUpdate());
 
   std::unique_ptr<LHEEventProduct> product(
       new LHEEventProduct(*partonLevel_->getHEPEUP(), partonLevel_->originalXWGTUP()));
   if (partonLevel_->getPDF()) {
     product->setPDF(*partonLevel_->getPDF());
   }
   std::for_each(partonLevel_->weights().begin(),
                 partonLevel_->weights().end(),
                 boost::bind(&LHEEventProduct::addWeight, product.get(), _1));
   product->setScales(partonLevel_->scales());
   product->setNpLO(partonLevel_->npLO());
   product->setNpNLO(partonLevel_->npNLO());
   std::for_each(partonLevel_->getComments().begin(),
                 partonLevel_->getComments().end(),
                 boost::bind(&LHEEventProduct::addComment, product.get(), _1));
 
   std::unique_ptr<edm::WrapperBase> edp(new edm::Wrapper<LHEEventProduct>(std::move(product)));
   eventPrincipal.put(lheProvenanceHelper_.eventProductBranchDescription_,
                      std::move(edp),
                      lheProvenanceHelper_.eventProductProvenance_);
 
   partonLevel_.reset();
 
   resetEventCached();
 }

void LHESource::readLuminosityBlock_ ( edm::LuminosityBlockPrincipal & lumiPrincipal )

overrideprivatevirtual

Reimplemented from edm::InputSource.

Definition at line 110 of file LHESource.cc.

References edm::LuminosityBlockPrincipal::fillLuminosityBlockPrincipal(), edm::InputSource::luminosityBlockAuxiliary(), phid_, and edm::InputSource::processHistoryRegistryForUpdate().

                                                                                {
   luminosityBlockAuxiliary()->setProcessHistoryID(phid_);
   lumiPrincipal.fillLuminosityBlockPrincipal(processHistoryRegistryForUpdate());
 }

std::shared_ptr< edm::LuminosityBlockAuxiliary > LHESource::readLuminosityBlockAuxiliary_ ( )

overrideprivatevirtual

Implements edm::InputSource.

Definition at line 175 of file LHESource.cc.

References printConversionInfo::aux, edm::IDGeneratorSourceBase< PuttableSourceBase >::eventID(), edm::Timestamp::invalidTimestamp(), edm::EventID::luminosityBlock(), phid_, edm::IDGeneratorSourceBase< PuttableSourceBase >::presentTime(), edm::InputSource::processingMode(), edm::InputSource::resetNewLumi(), edm::EventID::run(), and edm::InputSource::Runs.

                                                                                     {
   if (processingMode() == Runs)
     return std::shared_ptr<edm::LuminosityBlockAuxiliary>();
   edm::Timestamp ts = edm::Timestamp(presentTime());
   resetNewLumi();
   auto aux = std::make_shared<edm::LuminosityBlockAuxiliary>(
       eventID().run(), eventID().luminosityBlock(), ts, edm::Timestamp::invalidTimestamp());
   aux->setProcessHistoryID(phid_);
   return aux;
 }

void LHESource::readRun_ ( edm::RunPrincipal & runPrincipal )

overrideprivatevirtual

Reimplemented from edm::InputSource.

Definition at line 103 of file LHESource.cc.

References edm::RunPrincipal::fillRunPrincipal(), phid_, edm::InputSource::processHistoryRegistryForUpdate(), putRunInfoProduct(), and edm::InputSource::runAuxiliary().

                                                       {
   runAuxiliary()->setProcessHistoryID(phid_);
   runPrincipal.fillRunPrincipal(processHistoryRegistryForUpdate());
 
   putRunInfoProduct(runPrincipal);
 }

std::shared_ptr< edm::RunAuxiliary > LHESource::readRunAuxiliary_ ( )

overrideprivatevirtual

Implements edm::InputSource.

Definition at line 167 of file LHESource.cc.

References printConversionInfo::aux, edm::IDGeneratorSourceBase< PuttableSourceBase >::eventID(), edm::Timestamp::invalidTimestamp(), phid_, edm::IDGeneratorSourceBase< PuttableSourceBase >::presentTime(), edm::InputSource::resetNewRun(), and edm::EventID::run().

                                                             {
   edm::Timestamp ts = edm::Timestamp(presentTime());
   resetNewRun();
   auto aux = std::make_shared<edm::RunAuxiliary>(eventID().run(), ts, edm::Timestamp::invalidTimestamp());
   aux->setProcessHistoryID(phid_);
   return aux;
 }

bool LHESource::setRunAndEventInfo	(	edm::EventID &	,
		edm::TimeValue_t &	,
		edm::EventAuxiliary::ExperimentType &
	)

overrideprivatevirtual

Implements edm::IDGeneratorSourceBase< PuttableSourceBase >.

Definition at line 123 of file LHESource.cc.

References nextEvent(), and partonLevel_.

                                                                                                  {
   nextEvent();
   if (!partonLevel_) {
     // We just finished an input file. See if there is another.
     nextEvent();
     if (!partonLevel_) {
       // No more input files.
       return false;
     }
   }
   return true;
 }