edm::GeneratorFilter< HAD, DEC > Class Template Reference

#include <GeneratorFilter.h>

Inheritance diagram for edm::GeneratorFilter< HAD, DEC >:

Public Types
typedef DEC	Decayer
typedef HAD	Hadronizer
Public Types inherited from edm::one::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

Public Member Functions
void	beginLuminosityBlock (LuminosityBlock const &, EventSetup const &) override
void	beginLuminosityBlockProduce (LuminosityBlock &, EventSetup const &) override
void	endLuminosityBlock (LuminosityBlock const &, EventSetup const &) override
void	endLuminosityBlockProduce (LuminosityBlock &, EventSetup const &) override
void	endRunProduce (Run &, EventSetup const &) override
bool	filter (Event &e, EventSetup const &es) override
	GeneratorFilter (ParameterSet const &ps)
void	preallocThreads (unsigned int iThreads) override
	~GeneratorFilter () override
Public Member Functions inherited from edm::one::EDFilter< EndRunProducer, BeginLuminosityBlockProducer, EndLuminosityBlockProducer, one::WatchLuminosityBlocks, one::SharedResources >
	EDFilter ()=default
SerialTaskQueue *	globalLuminosityBlocksQueue () final
SerialTaskQueue *	globalRunsQueue () final
bool	hasAbilityToProduceInLumis () const final
bool	hasAbilityToProduceInRuns () const final
bool	wantsGlobalLuminosityBlocks () const final
bool	wantsGlobalRuns () const final
Public Member Functions inherited from edm::one::EDFilterBase
	EDFilterBase ()
ModuleDescription const &	moduleDescription () const
bool	wantsStreamLuminosityBlocks () const
bool	wantsStreamRuns () 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
Decayer *	decayer_
Hadronizer	hadronizer_
bool	initialized_ = false
unsigned int	nEventsInLumiBlock_
unsigned int	nThreads_ {1}

Additional Inherited Members
Static Public Member Functions inherited from edm::one::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

template<class HAD, class DEC>
class edm::GeneratorFilter< HAD, DEC >

Definition at line 40 of file GeneratorFilter.h.

Member Typedef Documentation

template<class HAD , class DEC >

typedef DEC edm::GeneratorFilter< HAD, DEC >::Decayer

Definition at line 48 of file GeneratorFilter.h.

template<class HAD , class DEC >

typedef HAD edm::GeneratorFilter< HAD, DEC >::Hadronizer

Definition at line 47 of file GeneratorFilter.h.

Constructor & Destructor Documentation

template<class HAD , class DEC >

edm::GeneratorFilter< HAD, DEC >::GeneratorFilter ( ParameterSet const &  ps )

explicit

Definition at line 78 of file GeneratorFilter.h.

References edm::GeneratorFilter< HAD, DEC >::decayer_, edm::ParameterSet::exists(), edm::ParameterSet::getParameter(), edm::GeneratorFilter< HAD, DEC >::hadronizer_, and edm::uniqueSharedResourceName().

                                                                  :
    EDFilter(),
    hadronizer_(ps),
    decayer_(nullptr),
    nEventsInLumiBlock_(0)
  {
    // TODO:
    // Put the list of types produced by the filters here.
    // The current design calls for:
    //   * GenRunInfoProduct
    //   * HepMCProduct
    //
    // other maybe added as needs be
    //

    std::vector<std::string> const& sharedResources = hadronizer_.sharedResources();
    for(auto const& resource : sharedResources) {
      usesResource(resource);
    }

    if ( ps.exists("ExternalDecays") )
    {
       //decayer_ = new gen::ExternalDecayDriver(ps.getParameter<ParameterSet>("ExternalDecays"));
       ParameterSet ps1 = ps.getParameter<ParameterSet>("ExternalDecays");
       decayer_ = new Decayer(ps1);

       std::vector<std::string> const& sharedResourcesDec = decayer_->sharedResources();
       for(auto const& resource : sharedResourcesDec) {
         usesResource(resource);
       }
    }
    
    // This handles the case where there are no shared resources, because you
    // have to declare something when the SharedResources template parameter was used.
    if(sharedResources.empty() && (!decayer_ || decayer_->sharedResources().empty())) {
      usesResource(edm::uniqueSharedResourceName());
    }

    produces<edm::HepMCProduct>("unsmeared");
    produces<GenEventInfoProduct>();
    produces<GenLumiInfoHeader, edm::Transition::BeginLuminosityBlock>();
    produces<GenLumiInfoProduct, edm::Transition::EndLuminosityBlock>();
    produces<GenRunInfoProduct, edm::Transition::EndRun>();
 
  }

template<class HAD , class DEC >

edm::GeneratorFilter< HAD, DEC >::~GeneratorFilter ( )

override

Definition at line 125 of file GeneratorFilter.h.

References edm::GeneratorFilter< HAD, DEC >::decayer_.

  { if ( decayer_ ) delete decayer_;}

Member Function Documentation

template<class HAD , class DEC >

void edm::GeneratorFilter< HAD, DEC >::beginLuminosityBlock ( LuminosityBlock const &  lumi, EventSetup const &  es  )

override

Definition at line 238 of file GeneratorFilter.h.

  {}

template<class HAD , class DEC >

void edm::GeneratorFilter< HAD, DEC >::beginLuminosityBlockProduce ( LuminosityBlock &  lumi, EventSetup const &  es  )

override

Definition at line 243 of file GeneratorFilter.h.

References edm::errors::Configuration, edm::GeneratorFilter< HAD, DEC >::decayer_, Exception, genWeightsTable_cfi::genLumiInfoHeader, edm::GeneratorFilter< HAD, DEC >::hadronizer_, edm::LuminosityBlock::index(), edm::GeneratorFilter< HAD, DEC >::initialized_, eostools::move(), edm::GeneratorFilter< HAD, DEC >::nEventsInLumiBlock_, edm::GeneratorFilter< HAD, DEC >::nThreads_, and edm::LuminosityBlock::put().

  {
    nEventsInLumiBlock_ = 0;
    RandomEngineSentry<HAD> randomEngineSentry(&hadronizer_, lumi.index());
    RandomEngineSentry<DEC> randomEngineSentryDecay(decayer_, lumi.index());

    hadronizer_.randomizeIndex(lumi,randomEngineSentry.randomEngine());
    hadronizer_.generateLHE(lumi,randomEngineSentry.randomEngine(), nThreads_);
    
    if ( !hadronizer_.readSettings(0) )
       throw edm::Exception(errors::Configuration) 
     << "Failed to read settings for the hadronizer "
     << hadronizer_.classname() << " \n";
        
    if ( decayer_ )
    {
       decayer_->init(es);
       if ( !hadronizer_.declareStableParticles( decayer_->operatesOnParticles() ) )
          throw edm::Exception(errors::Configuration)
            << "Failed to declare stable particles in hadronizer "
            << hadronizer_.classname()
            << "\n";
       if ( !hadronizer_.declareSpecialSettings( decayer_->specialSettings() ) )
          throw edm::Exception(errors::Configuration)
            << "Failed to declare special settings in hadronizer "
            << hadronizer_.classname()
            << "\n";
    }

    if ( !hadronizer_.initializeForInternalPartons() )
       throw edm::Exception(errors::Configuration) 
     << "Failed to initialize hadronizer "
     << hadronizer_.classname()
     << " for internal parton generation\n";
         
    std::unique_ptr<GenLumiInfoHeader> genLumiInfoHeader(hadronizer_.getGenLumiInfoHeader());
    lumi.put(std::move(genLumiInfoHeader));
    initialized_ = true;
  }

template<class HAD , class DEC >

void edm::GeneratorFilter< HAD, DEC >::endLuminosityBlock ( LuminosityBlock const &  , EventSetup const &    )

override

Definition at line 285 of file GeneratorFilter.h.

References edm::GeneratorFilter< HAD, DEC >::hadronizer_.

  {
    hadronizer_.cleanLHE();
  }

template<class HAD , class DEC >

void edm::GeneratorFilter< HAD, DEC >::endLuminosityBlockProduce ( LuminosityBlock &  lumi, EventSetup const &    )

override

Definition at line 292 of file GeneratorFilter.h.

References edm::GeneratorFilter< HAD, DEC >::decayer_, GenRunInfoProduct::XSec::error(), edm::GeneratorFilter< HAD, DEC >::hadronizer_, GenRunInfoProduct::internalXSec(), eostools::move(), edm::GeneratorFilter< HAD, DEC >::nEventsInLumiBlock_, edm::LuminosityBlock::put(), GenLumiInfoProduct::ProcessInfo::setAccepted(), GenLumiInfoProduct::ProcessInfo::setAcceptedBr(), GenLumiInfoProduct::ProcessInfo::setKilled(), GenLumiInfoProduct::ProcessInfo::setLheXSec(), GenLumiInfoProduct::ProcessInfo::setNPassNeg(), GenLumiInfoProduct::ProcessInfo::setNPassPos(), GenLumiInfoProduct::ProcessInfo::setNTotalNeg(), GenLumiInfoProduct::ProcessInfo::setNTotalPos(), GenLumiInfoProduct::ProcessInfo::setProcess(), GenLumiInfoProduct::ProcessInfo::setSelected(), GenLumiInfoProduct::ProcessInfo::setTried(), groupFilesInBlocks::temp, and GenRunInfoProduct::XSec::value().

  {
    hadronizer_.statistics();    
    if ( decayer_ ) decayer_->statistics();

    GenRunInfoProduct genRunInfo = GenRunInfoProduct(hadronizer_.getGenRunInfo());
    std::vector<GenLumiInfoProduct::ProcessInfo> GenLumiProcess;
    const GenRunInfoProduct::XSec& xsec = genRunInfo.internalXSec();
    GenLumiInfoProduct::ProcessInfo temp;      
    temp.setProcess(0);
    temp.setLheXSec(xsec.value(), xsec.error()); // Pythia gives error of -1
    temp.setNPassPos(nEventsInLumiBlock_);
    temp.setNPassNeg(0);
    temp.setNTotalPos(nEventsInLumiBlock_);
    temp.setNTotalNeg(0);
    temp.setTried(nEventsInLumiBlock_, nEventsInLumiBlock_, nEventsInLumiBlock_);
    temp.setSelected(nEventsInLumiBlock_, nEventsInLumiBlock_, nEventsInLumiBlock_);
    temp.setKilled(nEventsInLumiBlock_, nEventsInLumiBlock_, nEventsInLumiBlock_);
    temp.setAccepted(0,-1,-1);
    temp.setAcceptedBr(0,-1,-1);
    GenLumiProcess.push_back(temp);

    std::unique_ptr<GenLumiInfoProduct> genLumiInfo(new GenLumiInfoProduct());
    genLumiInfo->setHEPIDWTUP(-1);
    genLumiInfo->setProcessInfo( GenLumiProcess );
        
    lumi.put(std::move(genLumiInfo));

    nEventsInLumiBlock_ = 0;

  }

template<class HAD , class DEC >

void edm::GeneratorFilter< HAD, DEC >::endRunProduce ( Run &  r, EventSetup const &    )

override

Definition at line 219 of file GeneratorFilter.h.

References edm::GeneratorFilter< HAD, DEC >::decayer_, edm::GeneratorFilter< HAD, DEC >::hadronizer_, edm::GeneratorFilter< HAD, DEC >::initialized_, eostools::move(), and edm::Run::put().

  {
    // If relevant, record the integrated luminosity for this run
    // here.  To do so, we would need a standard function to invoke on
    // the contained hadronizer that would report the integrated
    // luminosity.

    if(initialized_) {
      hadronizer_.statistics();
    
      if ( decayer_ ) decayer_->statistics();
    }
    
    std::unique_ptr<GenRunInfoProduct> griproduct(new GenRunInfoProduct(hadronizer_.getGenRunInfo()));
    r.put(std::move(griproduct));
  }

template<class HAD , class DEC >

bool edm::GeneratorFilter< HAD, DEC >::filter ( Event &  e, EventSetup const &  es  )

overridevirtual

Implements edm::one::EDFilterBase.

Definition at line 136 of file GeneratorFilter.h.

References edm::GeneratorFilter< HAD, DEC >::decayer_, edm::EventID::event(), event(), particlelevel_cff::genEventInfo, edm::GeneratorFilter< HAD, DEC >::hadronizer_, edm::EventBase::id(), eostools::move(), edm::GeneratorFilter< HAD, DEC >::nEventsInLumiBlock_, edm::Event::put(), edm::Event::streamID(), and protons_cff::t.

  {
    RandomEngineSentry<HAD> randomEngineSentry(&hadronizer_, ev.streamID());
    RandomEngineSentry<DEC> randomEngineSentryDecay(decayer_, ev.streamID());

    //added for selecting/filtering gen events, in the case of hadronizer+externalDecayer
      
    bool passEvtGenSelector = false;
    std::unique_ptr<HepMC::GenEvent> event(nullptr);
   
    while(!passEvtGenSelector)
      {
    event.reset();
    hadronizer_.setEDMEvent(ev);
    
    if ( !hadronizer_.generatePartonsAndHadronize() ) return false;
    
    //  this is "fake" stuff
    // in principle, decays are done as part of full event generation,
    // except for particles that are marked as to be kept stable
    // but we currently keep in it the design, because we might want
    // to use such feature for other applications
    //
    if ( !hadronizer_.decay() ) return false;
    
    event = hadronizer_.getGenEvent();
    if ( !event.get() ) return false; 
    
    // The external decay driver is being added to the system,
    // it should be called here
    //
    if ( decayer_ ) 
    {
           auto t = decayer_->decay( event.get() );
           if(t != event.get()) {
             event.reset(t);
           }
    }
    if ( !event.get() ) return false;
    
    passEvtGenSelector = hadronizer_.select( event.get() );
    
      }
    // check and perform if there're any unstable particles after 
    // running external decay packages
    //
    // fisrt of all, put back modified event tree (after external decay)
    //
    hadronizer_.resetEvent( std::move(event) );
    
    //
    // now run residual decays
    //
    if ( !hadronizer_.residualDecay() ) return false;
        
    hadronizer_.finalizeEvent();
    
    event =  hadronizer_.getGenEvent();
    if ( !event.get() ) return false;
    
    event->set_event_number( ev.id().event() );
    
    //
    // tutto bene - finally, form up EDM products !
    //
    auto genEventInfo = hadronizer_.getGenEventInfo();
    if (!genEventInfo.get())
      { 
    // create GenEventInfoProduct from HepMC event in case hadronizer didn't provide one
    genEventInfo.reset(new GenEventInfoProduct(event.get()));
      }
      
    ev.put(std::move(genEventInfo));
   
    std::unique_ptr<HepMCProduct> bare_product(new HepMCProduct());
    bare_product->addHepMCData( event.release() );
    ev.put(std::move(bare_product), "unsmeared");
    nEventsInLumiBlock_ ++;
    return true;
  }

template<class HAD , class DEC >

void edm::GeneratorFilter< HAD, DEC >::preallocThreads ( unsigned int  iThreads )

overridevirtual

Reimplemented from edm::one::EDFilterBase.

Definition at line 130 of file GeneratorFilter.h.

References edm::GeneratorFilter< HAD, DEC >::nThreads_.

                                                                  {
    nThreads_ = iThreads;
  }

Member Data Documentation

template<class HAD , class DEC >

Decayer* edm::GeneratorFilter< HAD, DEC >::decayer_

private

Definition at line 67 of file GeneratorFilter.h.

Referenced by edm::GeneratorFilter< HAD, DEC >::beginLuminosityBlockProduce(), edm::GeneratorFilter< HAD, DEC >::endLuminosityBlockProduce(), edm::GeneratorFilter< HAD, DEC >::endRunProduce(), edm::GeneratorFilter< HAD, DEC >::filter(), edm::GeneratorFilter< HAD, DEC >::GeneratorFilter(), and edm::GeneratorFilter< HAD, DEC >::~GeneratorFilter().

template<class HAD , class DEC >

Hadronizer edm::GeneratorFilter< HAD, DEC >::hadronizer_

private

Definition at line 65 of file GeneratorFilter.h.

Referenced by edm::GeneratorFilter< HAD, DEC >::beginLuminosityBlockProduce(), edm::GeneratorFilter< HAD, DEC >::endLuminosityBlock(), edm::GeneratorFilter< HAD, DEC >::endLuminosityBlockProduce(), edm::GeneratorFilter< HAD, DEC >::endRunProduce(), edm::GeneratorFilter< HAD, DEC >::filter(), and edm::GeneratorFilter< HAD, DEC >::GeneratorFilter().

template<class HAD , class DEC >

bool edm::GeneratorFilter< HAD, DEC >::initialized_ = false

private

Definition at line 70 of file GeneratorFilter.h.

Referenced by edm::GeneratorFilter< HAD, DEC >::beginLuminosityBlockProduce(), and edm::GeneratorFilter< HAD, DEC >::endRunProduce().

template<class HAD , class DEC >

unsigned int edm::GeneratorFilter< HAD, DEC >::nEventsInLumiBlock_

private

Definition at line 68 of file GeneratorFilter.h.

Referenced by edm::GeneratorFilter< HAD, DEC >::beginLuminosityBlockProduce(), edm::GeneratorFilter< HAD, DEC >::endLuminosityBlockProduce(), and edm::GeneratorFilter< HAD, DEC >::filter().

template<class HAD , class DEC >

unsigned int edm::GeneratorFilter< HAD, DEC >::nThreads_ {1}

private

Definition at line 69 of file GeneratorFilter.h.

Referenced by edm::GeneratorFilter< HAD, DEC >::beginLuminosityBlockProduce(), and edm::GeneratorFilter< HAD, DEC >::preallocThreads().