ExternalGeneratorFilter Class Reference

Inheritance diagram for ExternalGeneratorFilter:

Classes
class	ExternalGeneratorFilter

Public Member Functions
std::unique_ptr< externalgen::StreamCache >	beginStream (edm::StreamID) const final
	ExternalGeneratorFilter (edm::ParameterSet const &)
bool	filter (edm::StreamID, edm::Event &, edm::EventSetup const &) const final
std::shared_ptr< externalgen::LumiCache >	globalBeginLuminosityBlock (edm::LuminosityBlock const &, edm::EventSetup const &) const final
void	globalBeginLuminosityBlockProduce (edm::LuminosityBlock &, edm::EventSetup const &) const final
std::shared_ptr< GenLumiInfoProduct >	globalBeginLuminosityBlockSummary (edm::LuminosityBlock const &, edm::EventSetup const &) const final
std::shared_ptr< externalgen::RunCache >	globalBeginRun (edm::Run const &, edm::EventSetup const &) const final
void	globalEndLuminosityBlock (edm::LuminosityBlock const &, edm::EventSetup const &) const final
void	globalEndLuminosityBlockProduce (edm::LuminosityBlock &, edm::EventSetup const &, GenLumiInfoProduct const *) const final
void	globalEndLuminosityBlockSummary (edm::LuminosityBlock const &, edm::EventSetup const &, GenLumiInfoProduct *) const final
void	globalEndRun (edm::Run const &, edm::EventSetup const &) const final
void	globalEndRunProduce (edm::Run &, edm::EventSetup const &) const final
void	streamBeginLuminosityBlock (edm::StreamID, edm::LuminosityBlock const &, edm::EventSetup const &) const final
void	streamBeginRun (edm::StreamID, edm::Run const &, edm::EventSetup const &) const final
void	streamEndLuminosityBlock (edm::StreamID, edm::LuminosityBlock const &, edm::EventSetup const &) const final
void	streamEndLuminosityBlockSummary (edm::StreamID, edm::LuminosityBlock const &, edm::EventSetup const &, GenLumiInfoProduct *) const final
void	streamEndRun (edm::StreamID, edm::Run const &, edm::EventSetup const &) const final
Public Member Functions inherited from edm::global::EDFilter< edm::StreamCache< externalgen::StreamCache >, edm::RunCache< externalgen::RunCache >, edm::EndRunProducer, edm::LuminosityBlockCache< externalgen::LumiCache >, edm::LuminosityBlockSummaryCache< GenLumiInfoProduct >, edm::BeginLuminosityBlockProducer, edm::EndLuminosityBlockProducer >
	EDFilter ()=default
bool	hasAbilityToProduceInLumis () const final
bool	hasAbilityToProduceInRuns () const final
bool	wantsGlobalLuminosityBlocks () const final
bool	wantsGlobalRuns () const final
bool	wantsStreamLuminosityBlocks () const final
bool	wantsStreamRuns () const final
Public Member Functions inherited from edm::global::EDFilterBase
	EDFilterBase ()
ModuleDescription const &	moduleDescription () const
	~EDFilterBase () override
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
Public Member Functions inherited from edm::EDConsumerBase
std::vector< ConsumesInfo >	consumesInfo () const
void	convertCurrentProcessAlias (std::string const &processName)
	Convert "@currentProcess" in InputTag process names to the actual current process name. More...
	EDConsumerBase ()
	EDConsumerBase (EDConsumerBase const &)=delete
	EDConsumerBase (EDConsumerBase &&)=default
ESProxyIndex const *	esGetTokenIndices (edm::Transition iTrans) const
ProductResolverIndexAndSkipBit	indexFrom (EDGetToken, BranchType, TypeID const &) const
void	itemsMayGet (BranchType, std::vector< ProductResolverIndexAndSkipBit > &) const
void	itemsToGet (BranchType, std::vector< ProductResolverIndexAndSkipBit > &) const
std::vector< ProductResolverIndexAndSkipBit > const &	itemsToGetFrom (BranchType iType) const
void	labelsForToken (EDGetToken iToken, Labels &oLabels) const
void	modulesWhoseProductsAreConsumed (std::vector< ModuleDescription const * > &modules, ProductRegistry const &preg, std::map< std::string, ModuleDescription const * > const &labelsToDesc, std::string const &processName) const
EDConsumerBase const &	operator= (EDConsumerBase const &)=delete
EDConsumerBase &	operator= (EDConsumerBase &&)=default
bool	registeredToConsume (ProductResolverIndex, bool, BranchType) const
bool	registeredToConsumeMany (TypeID const &, BranchType) const
ProductResolverIndexAndSkipBit	uncheckedIndexFrom (EDGetToken) const
void	updateLookup (BranchType iBranchType, ProductResolverIndexHelper const &, bool iPrefetchMayGet)
void	updateLookup (eventsetup::ESRecordsToProxyIndices const &)
virtual	~EDConsumerBase () noexcept(false)

Private Attributes
std::atomic< externalgen::StreamCache * >	availableForBeginLumi_
std::string const	config_
std::string const	extraConfig_
edm::EDPutTokenT< GenEventInfoProduct > const	genEventToken_
edm::EDPutTokenT< edm::HepMCProduct > const	hepMCToken_
std::atomic< unsigned int >	lastLumiIndex_ = 0
edm::EDPutTokenT< GenLumiInfoHeader > const	lumiHeaderToken_
edm::EDPutTokenT< GenLumiInfoProduct > const	lumiInfoToken_
edm::EDPutTokenT< GenRunInfoProduct > const	runInfoToken_
externalgen::StreamCache *	stream0Cache_ = 0
bool const	verbose_
unsigned int	waitTime_

Additional Inherited Members
Public Types inherited from edm::global::EDFilterBase
typedef EDFilterBase	ModuleType
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 Types inherited from edm::EDConsumerBase
typedef ProductLabels	Labels
Static Public Member Functions inherited from edm::global::EDFilterBase
static const std::string &	baseType ()
static void	fillDescriptions (ConfigurationDescriptions &descriptions)
static void	prevalidate (ConfigurationDescriptions &descriptions)
Protected Member Functions inherited from edm::EDConsumerBase
template<typename ProductType , BranchType B = InEvent>
EDGetTokenT< ProductType >	consumes (edm::InputTag const &tag)
EDGetToken	consumes (const TypeToGet &id, edm::InputTag const &tag)
template<BranchType B>
EDGetToken	consumes (TypeToGet const &id, edm::InputTag const &tag)
ConsumesCollector	consumesCollector ()
	Use a ConsumesCollector to gather consumes information from helper functions. More...
template<typename ProductType , BranchType B = InEvent>
void	consumesMany ()
void	consumesMany (const TypeToGet &id)
template<BranchType B>
void	consumesMany (const TypeToGet &id)
template<typename ESProduct , typename ESRecord , Transition Tr = Transition::Event>
auto	esConsumes ()
template<typename ESProduct , typename ESRecord , Transition Tr = Transition::Event>
auto	esConsumes (ESInputTag const &tag)
template<typename ProductType , BranchType B = InEvent>
EDGetTokenT< ProductType >	mayConsume (edm::InputTag const &tag)
EDGetToken	mayConsume (const TypeToGet &id, edm::InputTag const &tag)
template<BranchType B>
EDGetToken	mayConsume (const TypeToGet &id, edm::InputTag const &tag)

Detailed Description

Definition at line 168 of file ExternalGeneratorFilter.cc.

Constructor & Destructor Documentation

ExternalGeneratorFilter::ExternalGeneratorFilter

(

edm::ParameterSet const &

iPSet

)

Definition at line 229 of file ExternalGeneratorFilter.cc.

References config_, extraConfig_, genEventToken_, lumiHeaderToken_, lumiInfoToken_, runInfoToken_, AlCaHLTBitMon_QueryRunRegistry::string, verbose_, and waitTime_.

    : hepMCToken_{produces<edm::HepMCProduct>("unsmeared")},
      genEventToken_{produces<GenEventInfoProduct>()},
      runInfoToken_{produces<GenRunInfoProduct, edm::Transition::EndRun>()},
      lumiHeaderToken_{produces<GenLumiInfoHeader, edm::Transition::BeginLuminosityBlock>()},
      lumiInfoToken_{produces<GenLumiInfoProduct, edm::Transition::EndLuminosityBlock>()},
      config_{iPSet.getUntrackedParameter<std::string>("@python_config")},
      verbose_{iPSet.getUntrackedParameter<bool>("_external_process_verbose_")},
      waitTime_{iPSet.getUntrackedParameter<unsigned int>("_external_process_waitTime_")},
      extraConfig_{iPSet.getUntrackedParameter<std::string>("_external_process_extraConfig_")} {}

Member Function Documentation

std::unique_ptr< externalgen::StreamCache > ExternalGeneratorFilter::beginStream ( edm::StreamID  iID ) const

final

Definition at line 240 of file ExternalGeneratorFilter.cc.

References availableForBeginLumi_, utilities::cache(), looper::config, config_, extraConfig_, label, edm::global::EDFilterBase::moduleDescription(), edm::ModuleDescription::moduleLabel(), alignCSCRings::s, stream0Cache_, AlCaHLTBitMon_QueryRunRegistry::string, edm::StreamID::value(), verbose_, and waitTime_.

                                                                                                {
  auto const label = moduleDescription().moduleLabel();

  using namespace std::string_literals;

  std::string config = R"_(from FWCore.TestProcessor.TestProcess import *
process = TestProcess()
)_";
  config += "process."s + label + "=" + config_ + "\n";
  config += "process.moduleToTest(process."s + label + ")\n";
  config += R"_(
process.add_(cms.Service("InitRootHandlers", AbortOnSignal=cms.untracked.bool(False)))
  )_";
  if (not extraConfig_.empty()) {
    config += "\n";
    config += extraConfig_;
  }

  auto cache = std::make_unique<externalgen::StreamCache>(config, iID.value(), verbose_, waitTime_);
  if (iID.value() == 0) {
    stream0Cache_ = cache.get();

    availableForBeginLumi_ = stream0Cache_;
  }

  return cache;
}

bool ExternalGeneratorFilter::filter ( edm::StreamID  iID, edm::Event &  iEvent, edm::EventSetup const &    ) const

finalvirtual

Implements edm::global::EDFilterBase.

Definition at line 268 of file ExternalGeneratorFilter.cc.

References edm::Event::emplace(), edm::EventID::event(), relval_steps::gen(), genEventToken_, edm::RandomNumberGenerator::getEngine(), hepMCToken_, edm::EventBase::id(), and eostools::move().

                                                                                                  {
  auto value = streamCache(iID)->produce(iID, iEvent.id().event());

  edm::Service<edm::RandomNumberGenerator> gen;
  auto& engine = gen->getEngine(iID);
  //if (value.randomState_.state_[0] != CLHEP::engineIDulong<CLHEP::RanecuEngine>()) {
  //  engine.setSeed(value.randomState_.seed_, 0);
  //}
  engine.get(value.randomState_.state_);

  iEvent.emplace(hepMCToken_, std::move(value.hepmc_));
  iEvent.emplace(genEventToken_, std::move(value.eventInfo_));
  return value.keepEvent_;
}

std::shared_ptr< externalgen::LumiCache > ExternalGeneratorFilter::globalBeginLuminosityBlock ( edm::LuminosityBlock const &  iLumi, edm::EventSetup const &    ) const

final

Definition at line 317 of file ExternalGeneratorFilter.cc.

References relval_steps::gen(), edm::RandomNumberGenerator::getEngine(), edm::LuminosityBlock::index(), and alignCSCRings::s.

                                                                 {
  edm::Service<edm::RandomNumberGenerator> gen;
  auto& engine = gen->getEngine(iLumi.index());
  auto s = engine.put();
  return std::make_shared<externalgen::LumiCache>(s, engine.getSeed());
}

void ExternalGeneratorFilter::globalBeginLuminosityBlockProduce ( edm::LuminosityBlock &  iLuminosityBlock, edm::EventSetup const &    ) const

final

Definition at line 300 of file ExternalGeneratorFilter.cc.

References availableForBeginLumi_, edm::LuminosityBlock::emplace(), relval_steps::gen(), edm::RandomNumberGenerator::getEngine(), edm::LuminosityBlock::index(), lastLumiIndex_, lumiHeaderToken_, edm::LuminosityBlockBase::luminosityBlock(), eostools::move(), and findQualityFiles::v.

                                                                                            {
  while (not availableForBeginLumi_.load()) {
  }

  auto v = availableForBeginLumi_.load()->beginLumiProduce(
      iLuminosityBlock.luminosityBlock(), luminosityBlockCache(iLuminosityBlock.index())->randomState_);

  edm::Service<edm::RandomNumberGenerator> gen;
  auto& engine = gen->getEngine(iLuminosityBlock.index());
  engine.get(v.randomState_.state_);

  iLuminosityBlock.emplace(lumiHeaderToken_, std::move(v.header_));

  lastLumiIndex_.store(iLuminosityBlock.index());
}

std::shared_ptr< GenLumiInfoProduct > ExternalGeneratorFilter::globalBeginLuminosityBlockSummary ( edm::LuminosityBlock const &  , edm::EventSetup const &    ) const

final

Definition at line 325 of file ExternalGeneratorFilter.cc.

                                                           {
  return std::make_shared<GenLumiInfoProduct>();
}

std::shared_ptr< externalgen::RunCache > ExternalGeneratorFilter::globalBeginRun ( edm::Run const &  , edm::EventSetup const &    ) const

final

Definition at line 283 of file ExternalGeneratorFilter.cc.

                                                                                                           {
  return std::make_shared<externalgen::RunCache>();
}

void ExternalGeneratorFilter::globalEndLuminosityBlock ( edm::LuminosityBlock const &  , edm::EventSetup const &    ) const

inlinefinal

Definition at line 198 of file ExternalGeneratorFilter.cc.

{}

void ExternalGeneratorFilter::globalEndLuminosityBlockProduce ( edm::LuminosityBlock &  iLuminosityBlock, edm::EventSetup const &  , GenLumiInfoProduct const *  iProduct  ) const

final

Definition at line 358 of file ExternalGeneratorFilter.cc.

References DEFINE_FWK_MODULE, edm::LuminosityBlock::emplace(), lumiInfoToken_, and eostools::move().

                                                                                                        {
  iLuminosityBlock.emplace(lumiInfoToken_, std::move(*iProduct));
}

void ExternalGeneratorFilter::globalEndLuminosityBlockSummary ( edm::LuminosityBlock const &  , edm::EventSetup const &  , GenLumiInfoProduct *    ) const

inlinefinal

Definition at line 199 of file ExternalGeneratorFilter.cc.

                                                                        {}

void ExternalGeneratorFilter::globalEndRun ( edm::Run const &  , edm::EventSetup const &    ) const

inlinefinal

Definition at line 184 of file ExternalGeneratorFilter.cc.

{}

void ExternalGeneratorFilter::globalEndRunProduce ( edm::Run &  iRun, edm::EventSetup const &    ) const

final

Definition at line 296 of file ExternalGeneratorFilter.cc.

References edm::Run::emplace(), edm::Run::index(), eostools::move(), and runInfoToken_.

                                                                                          {
  iRun.emplace(runInfoToken_, std::move(runCache(iRun.index())->runInfo_));
}

void ExternalGeneratorFilter::streamBeginLuminosityBlock ( edm::StreamID  iID, edm::LuminosityBlock const &  iLuminosityBlock, edm::EventSetup const &    ) const

final

Definition at line 330 of file ExternalGeneratorFilter.cc.

References availableForBeginLumi_, utilities::cache(), edm::LuminosityBlock::index(), and edm::LuminosityBlockBase::run().

                                                                                     {
  auto cache = streamCache(iID);
  if (cache != availableForBeginLumi_.load()) {
    (void)cache->beginLumiProduce(iLuminosityBlock.run(), luminosityBlockCache(iLuminosityBlock.index())->randomState_);
  } else {
    availableForBeginLumi_ = nullptr;
  }
}

void ExternalGeneratorFilter::streamBeginRun ( edm::StreamID  iID, edm::Run const &  iRun, edm::EventSetup const &    ) const

final

Definition at line 288 of file ExternalGeneratorFilter.cc.

{}

void ExternalGeneratorFilter::streamEndLuminosityBlock ( edm::StreamID  iID, edm::LuminosityBlock const &  iLuminosityBlock, edm::EventSetup const &    ) const

final

Definition at line 341 of file ExternalGeneratorFilter.cc.

                                                                                   {}

void ExternalGeneratorFilter::streamEndLuminosityBlockSummary ( edm::StreamID  iID, edm::LuminosityBlock const &  iLuminosityBlock, edm::EventSetup const &  , GenLumiInfoProduct *  iProduct  ) const

final

Definition at line 345 of file ExternalGeneratorFilter.cc.

References availableForBeginLumi_, edm::LuminosityBlock::index(), lastLumiIndex_, GenLumiInfoProduct::mergeProduct(), and edm::LuminosityBlockBase::run().

                                                                                                  {
  iProduct->mergeProduct(*streamCache(iID)->endLumiProduce(iLuminosityBlock.run()));

  if (lastLumiIndex_ == iLuminosityBlock.index()) {
    externalgen::StreamCache* expected = nullptr;

    availableForBeginLumi_.compare_exchange_strong(expected, streamCache(iID));
  }
}

void ExternalGeneratorFilter::streamEndRun ( edm::StreamID  iID, edm::Run const &  iRun, edm::EventSetup const &    ) const

final

Definition at line 289 of file ExternalGeneratorFilter.cc.

References edm::Run::index(), edm::RunBase::run(), and edm::StreamID::value().

                                                                                                          {
  if (iID.value() == 0) {
    runCache(iRun.index())->runInfo_ = *streamCache(iID)->endRunProduce(iRun.run());
  } else {
    (void)streamCache(iID)->endRunProduce(iRun.run());
  }
}

Member Data Documentation

std::atomic<externalgen::StreamCache*> ExternalGeneratorFilter::availableForBeginLumi_

mutableprivate

Definition at line 223 of file ExternalGeneratorFilter.cc.

Referenced by beginStream(), globalBeginLuminosityBlockProduce(), streamBeginLuminosityBlock(), and streamEndLuminosityBlockSummary().

std::string const ExternalGeneratorFilter::config_

private

Definition at line 213 of file ExternalGeneratorFilter.cc.

Referenced by beginStream(), and ExternalGeneratorFilter().

std::string const ExternalGeneratorFilter::extraConfig_

private

Definition at line 216 of file ExternalGeneratorFilter.cc.

Referenced by beginStream(), and ExternalGeneratorFilter().

edm::EDPutTokenT<GenEventInfoProduct> const ExternalGeneratorFilter::genEventToken_

private

Definition at line 208 of file ExternalGeneratorFilter.cc.

Referenced by ExternalGeneratorFilter(), and filter().

edm::EDPutTokenT<edm::HepMCProduct> const ExternalGeneratorFilter::hepMCToken_

private

Definition at line 207 of file ExternalGeneratorFilter.cc.

Referenced by filter().

std::atomic<unsigned int> ExternalGeneratorFilter::lastLumiIndex_ = 0

mutableprivate

Definition at line 226 of file ExternalGeneratorFilter.cc.

Referenced by globalBeginLuminosityBlockProduce(), and streamEndLuminosityBlockSummary().

edm::EDPutTokenT<GenLumiInfoHeader> const ExternalGeneratorFilter::lumiHeaderToken_

private

Definition at line 210 of file ExternalGeneratorFilter.cc.

Referenced by ExternalGeneratorFilter(), and globalBeginLuminosityBlockProduce().

edm::EDPutTokenT<GenLumiInfoProduct> const ExternalGeneratorFilter::lumiInfoToken_

private

Definition at line 211 of file ExternalGeneratorFilter.cc.

Referenced by ExternalGeneratorFilter(), and globalEndLuminosityBlockProduce().

edm::EDPutTokenT<GenRunInfoProduct> const ExternalGeneratorFilter::runInfoToken_

private

Definition at line 209 of file ExternalGeneratorFilter.cc.

Referenced by ExternalGeneratorFilter(), and globalEndRunProduce().

externalgen::StreamCache* ExternalGeneratorFilter::stream0Cache_ = 0

mutableprivate

Definition at line 220 of file ExternalGeneratorFilter.cc.

Referenced by beginStream().

bool const ExternalGeneratorFilter::verbose_

private

Definition at line 214 of file ExternalGeneratorFilter.cc.

Referenced by beginStream(), and ExternalGeneratorFilter().

unsigned int ExternalGeneratorFilter::waitTime_

private

Definition at line 215 of file ExternalGeneratorFilter.cc.

Referenced by beginStream(), and ExternalGeneratorFilter().