edm::BMixingModule Class Reference

#include <BMixingModule.h>

Inheritance diagram for edm::BMixingModule:

Public Member Functions
virtual void	addPileups (const int bcr, EventPrincipal *ep, unsigned int eventId, unsigned int worker, const edm::EventSetup &c)
virtual void	addSignals (const edm::Event &e, const edm::EventSetup &c)
double	averageNumber () const
virtual void	beginLuminosityBlock (const edm::LuminosityBlock &l, const edm::EventSetup &setup) override
virtual void	beginRun (const edm::Run &r, const edm::EventSetup &setup) override
	BMixingModule (const edm::ParameterSet &ps)
virtual void	checkSignal (const edm::Event &e)
virtual void	createnewEDProduct ()
virtual void	doPileUp (edm::Event &e, const edm::EventSetup &c)
virtual void	endLuminosityBlock (const edm::LuminosityBlock &l, const edm::EventSetup &setup) override
virtual void	endRun (const edm::Run &r, const edm::EventSetup &setup) override
virtual void	finalizeEvent (edm::Event &event, const edm::EventSetup &setup)
virtual void	getEventStartInfo (edm::Event &e, const unsigned int source)
virtual void	initializeEvent (const edm::Event &event, const edm::EventSetup &setup)
bool	poisson () const
virtual void	produce (edm::Event &e1, const edm::EventSetup &c) override
virtual void	put (edm::Event &e, const edm::EventSetup &c)
virtual void	reload (const edm::EventSetup &setup)
virtual void	setBcrOffset ()
virtual void	setEventStartInfo (const unsigned int s)
virtual void	setSourceOffset (const unsigned int s)
virtual	~BMixingModule ()
Public Member Functions inherited from edm::one::EDProducer< edm::one::SharedResources, edm::one::WatchRuns, edm::one::WatchLuminosityBlocks >
	EDProducer ()=default
Public Member Functions inherited from edm::one::EDProducerBase
	EDProducerBase ()
ModuleDescription const &	moduleDescription () const
virtual	~EDProducerBase ()
Public Member Functions inherited from edm::ProducerBase
	ProducerBase ()
void	registerProducts (ProducerBase *, ProductRegistry *, ModuleDescription const &)
std::function< void(BranchDescription const &)>	registrationCallback () const
	used by the fwk to register list of products More...
virtual	~ProducerBase ()
Public Member Functions inherited from edm::EDConsumerBase
	EDConsumerBase ()
ProductHolderIndexAndSkipBit	indexFrom (EDGetToken, BranchType, TypeID const &) const
void	itemsMayGet (BranchType, std::vector< ProductHolderIndexAndSkipBit > &) const
void	itemsToGet (BranchType, std::vector< ProductHolderIndexAndSkipBit > &) const
std::vector < ProductHolderIndexAndSkipBit > const &	itemsToGetFromEvent () const
void	labelsForToken (EDGetToken iToken, Labels &oLabels) const
void	modulesDependentUpon (const std::string &iProcessName, std::vector< const char * > &oModuleLabels) const
bool	registeredToConsume (ProductHolderIndex, bool, BranchType) const
bool	registeredToConsumeMany (TypeID const &, BranchType) const
void	updateLookup (BranchType iBranchType, ProductHolderIndexHelper const &)
virtual	~EDConsumerBase ()

Protected Member Functions
virtual void	beginJob () override
void	dropUnwantedBranches (std::vector< std::string > const &wantedBranches)
virtual void	endJob () override
void	setupPileUpEvent (const edm::EventSetup &setup)
void	update (edm::EventSetup const &)
Protected Member Functions inherited from edm::ProducerBase
void	callWhenNewProductsRegistered (std::function< void(BranchDescription const &)> const &func)
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 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)

Protected Attributes
int	bunchSpace_
bool	checktof_
bool	doit_ [4]
unsigned int	eventId_
std::vector< std::shared_ptr < PileUp > >	inputSources_
int	maxBunch_
int	minBunch_
bool const	mixProdStep1_
bool const	mixProdStep2_
edm::ESWatcher< MixingRcd >	parameterWatcher_
bool	playback_
bool	readDB_
std::vector< std::string >	sourceNames_
std::vector< float >	TrueNumInteractions_
int	vertexOffset_

Static Protected Attributes
static const unsigned int	maxNbSources_ =4

Additional Inherited Members
Public Types inherited from edm::one::EDProducerBase
typedef EDProducerBase	ModuleType
Public Types inherited from edm::ProducerBase
typedef ProductRegistryHelper::TypeLabelList	TypeLabelList
Static Public Member Functions inherited from edm::one::EDProducerBase
static const std::string &	baseType ()
static void	fillDescriptions (ConfigurationDescriptions &descriptions)
static void	prevalidate (ConfigurationDescriptions &descriptions)

Detailed Description

Definition at line 29 of file BMixingModule.h.

Constructor & Destructor Documentation

BMixingModule::BMixingModule ( const edm::ParameterSet &  ps )

explicit

standard constructor

Definition at line 166 of file BMixingModule.cc.

References edm::ParameterSet::exists(), edm::ParameterSet::getParameter(), edm::ParameterSet::getUntrackedParameter(), inputSources_, maxBunch_, maxNbSources_, minBunch_, playback_, readDB_, and sourceNames_.

                                                          :
    bunchSpace_(pset.getParameter<int>("bunchspace")),
    vertexOffset_(0),
    minBunch_((pset.getParameter<int>("minBunch")*25)/pset.getParameter<int>("bunchspace")),
    maxBunch_((pset.getParameter<int>("maxBunch")*25)/pset.getParameter<int>("bunchspace")),
    mixProdStep1_(pset.getParameter<bool>("mixProdStep1")),
    mixProdStep2_(pset.getParameter<bool>("mixProdStep2")),
    readDB_(false)
  {
    if (pset.exists("readDB"))      readDB_=pset.getParameter<bool>("readDB");

    playback_=pset.getUntrackedParameter<bool>("playback",false);

    if (playback_) {
      //this could be explicitely checked
      LogInfo("MixingModule") <<" ATTENTION:Mixing will be done in playback mode! \n"
                              <<" ATTENTION:Mixing Configuration must be the same as for the original mixing!";
    }

    // Just for debugging print out.
    sourceNames_.push_back("input");
    sourceNames_.push_back("cosmics");
    sourceNames_.push_back("beamhalo_plus");
    sourceNames_.push_back("beamhalo_minus");

    for (size_t makeIdx = 0; makeIdx < maxNbSources_; makeIdx++ ) {
      inputSources_.push_back(maybeMakePileUp(pset,sourceNames_[makeIdx],
                                              minBunch_,maxBunch_,playback_));
      if (inputSources_.back()) inputSources_.back()->input(makeIdx);
    }
  }

BMixingModule::~BMixingModule ( )

virtual

Default destructor

Definition at line 199 of file BMixingModule.cc.

{;}

Member Function Documentation

virtual void edm::BMixingModule::addPileups ( const int  bcr, EventPrincipal *  ep, unsigned int  eventId, unsigned int  worker, const edm::EventSetup &  c  )

inlinevirtual

Definition at line 64 of file BMixingModule.h.

{;}

virtual void edm::BMixingModule::addSignals ( const edm::Event &  e, const edm::EventSetup &  c  )

inlinevirtual

Reimplemented in edm::MixingModule, and edm::DataMixingModule.

Definition at line 63 of file BMixingModule.h.

Referenced by produce().

{;}

double edm::BMixingModule::averageNumber ( ) const

inline

Definition at line 57 of file BMixingModule.h.

References inputSources_.

{return inputSources_[0] ? inputSources_[0]->averageNumber() : 0.0; }

void BMixingModule::beginJob ( void  )

overrideprotectedvirtual

Reimplemented from edm::one::EDProducerBase.

Reimplemented in edm::MixingModule.

Definition at line 274 of file BMixingModule.cc.

References inputSources_, and maxNbSources_.

                               {
    for (size_t endIdx=0; endIdx<maxNbSources_; ++endIdx) {
      if(inputSources_[endIdx]) inputSources_[endIdx]->beginJob();
    }
  }

void BMixingModule::beginLuminosityBlock ( const edm::LuminosityBlock &  l, const edm::EventSetup &  setup  )

overridevirtual

Reimplemented in edm::DataMixingModule, and edm::MixingModule.

Definition at line 202 of file BMixingModule.cc.

References inputSources_, maxNbSources_, and update().

Referenced by edm::MixingModule::beginLuminosityBlock(), and edm::DataMixingModule::beginLuminosityBlock().

                                                                                                    {
    update(setup);
    for (size_t endIdx=0; endIdx<maxNbSources_; ++endIdx) {
      if(inputSources_[endIdx]) inputSources_[endIdx]->beginLuminosityBlock(lumi, setup);
    }
  }

void BMixingModule::beginRun ( const edm::Run &  r, const edm::EventSetup &  setup  )

overridevirtual

Reimplemented in edm::DataMixingModule, and edm::MixingModule.

Definition at line 209 of file BMixingModule.cc.

References inputSources_, maxNbSources_, and update().

Referenced by edm::MixingModule::beginRun(), and edm::DataMixingModule::beginRun().

                                                                           {
    update(setup);
    for (size_t endIdx=0; endIdx<maxNbSources_; ++endIdx) {
      if(inputSources_[endIdx]) inputSources_[endIdx]->beginRun(run, setup);
    }
  }

void BMixingModule::checkSignal ( const edm::Event &  e )

virtual

Reimplemented in edm::MixingModule, and edm::DataMixingModule.

Definition at line 288 of file BMixingModule.cc.

References gather_cfg::cout.

Referenced by produce().

{std::cout << "BMixingModule::checkSignal must be overwritten!" << std::endl;}

void BMixingModule::createnewEDProduct ( )

virtual

Reimplemented in edm::MixingModule, and edm::DataMixingModule.

Definition at line 286 of file BMixingModule.cc.

References gather_cfg::cout.

Referenced by produce().

{std::cout << "BMixingModule::createnewEDProduct must be overwritten!" << std::endl;}

void BMixingModule::doPileUp ( edm::Event &  e, const edm::EventSetup &  c  )

virtual

Reimplemented in edm::MixingModule, and edm::DataMixingModule.

Definition at line 294 of file BMixingModule.cc.

References gather_cfg::cout.

Referenced by produce().

{std::cout << "BMixingModule::doPileUp must be overwritten!" << std::endl;}

void BMixingModule::dropUnwantedBranches ( std::vector< std::string > const &  wantedBranches )

protected

Definition at line 268 of file BMixingModule.cc.

References inputSources_, and maxNbSources_.

Referenced by edm::MixingModule::MixingModule().

                                                                                     {
    for (size_t dropIdx=0; dropIdx<maxNbSources_; ++dropIdx) {
      if(inputSources_[dropIdx]) inputSources_[dropIdx]->dropUnwantedBranches(wantedBranches);
    }
  }

void BMixingModule::endJob ( void  )

overrideprotectedvirtual

Reimplemented from edm::one::EDProducerBase.

Definition at line 280 of file BMixingModule.cc.

References inputSources_, and maxNbSources_.

                             {
    for (size_t endIdx=0; endIdx<maxNbSources_; ++endIdx) {
      if(inputSources_[endIdx]) inputSources_[endIdx]->endJob();
    }
  }

void BMixingModule::endLuminosityBlock ( const edm::LuminosityBlock &  l, const edm::EventSetup &  setup  )

overridevirtual

Reimplemented in edm::DataMixingModule, and edm::MixingModule.

Definition at line 216 of file BMixingModule.cc.

References inputSources_, and maxNbSources_.

Referenced by edm::MixingModule::endLuminosityBlock(), and edm::DataMixingModule::endLuminosityBlock().

                                                                                                  {
    for (size_t endIdx=0; endIdx<maxNbSources_; ++endIdx) {
      if(inputSources_[endIdx]) inputSources_[endIdx]->endLuminosityBlock(lumi, setup);
    }
  }

void BMixingModule::endRun ( const edm::Run &  r, const edm::EventSetup &  setup  )

overridevirtual

Reimplemented in edm::DataMixingModule, and edm::MixingModule.

Definition at line 222 of file BMixingModule.cc.

References inputSources_, and maxNbSources_.

Referenced by edm::MixingModule::endRun(), and edm::DataMixingModule::endRun().

                                                                         {
    for (size_t endIdx=0; endIdx<maxNbSources_; ++endIdx) {
      if(inputSources_[endIdx]) inputSources_[endIdx]->endRun(run, setup);
    }
  }

virtual void edm::BMixingModule::finalizeEvent ( edm::Event &  event, const edm::EventSetup &  setup  )

inlinevirtual

Reimplemented in edm::MixingModule.

Definition at line 43 of file BMixingModule.h.

Referenced by produce().

{}

virtual void edm::BMixingModule::getEventStartInfo ( edm::Event &  e, const unsigned int  source  )

inlinevirtual

Definition at line 70 of file BMixingModule.h.

{;} //to be set locally

virtual void edm::BMixingModule::initializeEvent ( const edm::Event &  event, const edm::EventSetup &  setup  )

inlinevirtual

Reimplemented in edm::MixingModule, and edm::DataMixingModule.

Definition at line 40 of file BMixingModule.h.

Referenced by produce().

{}

bool edm::BMixingModule::poisson ( ) const

inline

Definition at line 59 of file BMixingModule.h.

References inputSources_.

{return inputSources_[0] ? inputSources_[0]->poisson() : 0.0 ;}

void BMixingModule::produce ( edm::Event &  e1, const edm::EventSetup &  c  )

overridevirtual

Cumulates the pileup events onto this event

Implements edm::one::EDProducerBase.

Definition at line 238 of file BMixingModule.cc.

References addSignals(), checkSignal(), createnewEDProduct(), doPileUp(), finalizeEvent(), initializeEvent(), mixProdStep1_, and put().

                                                                     { 
    // Check if the signal is present in the root file 
    // for all the objects we want to mix
    checkSignal(e);
    
    // Create EDProduct
    createnewEDProduct();

    initializeEvent(e, setup);

    // Add signals
    if (!mixProdStep1_){ 
      addSignals(e,setup);
    }

    doPileUp(e, setup);

    // Includes putting digi products into the edm::Event.
    finalizeEvent(e, setup);

    // Put output into event (here only playback info)
    put(e,setup);
  }

virtual void edm::BMixingModule::put ( edm::Event &  e, const edm::EventSetup &  c  )

inlinevirtual

Reimplemented in edm::MixingModule, and edm::DataMixingModule.

Definition at line 67 of file BMixingModule.h.

Referenced by produce().

{;}

virtual void edm::BMixingModule::reload ( const edm::EventSetup &  setup )

inlinevirtual

Reimplemented in edm::MixingModule.

Definition at line 52 of file BMixingModule.h.

Referenced by update().

{};

void BMixingModule::setBcrOffset ( )

virtual

Definition at line 290 of file BMixingModule.cc.

References gather_cfg::cout.

{std::cout << "BMixingModule::setBcrOffset must be overwritten!" << std::endl;} //FIXME: LogWarning

virtual void edm::BMixingModule::setEventStartInfo ( const unsigned int  s )

inlinevirtual

Definition at line 69 of file BMixingModule.h.

{;} //to be set in CF

void BMixingModule::setSourceOffset ( const unsigned int  s )

virtual

Definition at line 292 of file BMixingModule.cc.

References gather_cfg::cout.

{std::cout << "BMixingModule::setSourceOffset must be overwritten!" << std::endl;}

void BMixingModule::setupPileUpEvent ( const edm::EventSetup &  setup )

protected

Definition at line 262 of file BMixingModule.cc.

References inputSources_, and maxNbSources_.

Referenced by edm::DataMixingModule::pileWorker().

                                                                 {
    for (size_t dropIdx=0; dropIdx<maxNbSources_; ++dropIdx) {
      if(inputSources_[dropIdx]) inputSources_[dropIdx]->setupPileUpEvent(setup);
    }
  }

void BMixingModule::update ( edm::EventSetup const &  setup )

protected

Definition at line 228 of file BMixingModule.cc.

References edm::ESWatcher< T >::check(), inputSources_, maxNbSources_, parameterWatcher_, readDB_, and reload().

Referenced by progressbar.ProgressBar::__next__(), relval_steps.Matrix::__setitem__(), relval_steps.Steps::__setitem__(), Vispa.Gui.VispaWidget.VispaWidget::autosize(), beginLuminosityBlock(), beginRun(), Vispa.Views.LineDecayView.LineDecayContainer::createObject(), Vispa.Views.LineDecayView.LineDecayContainer::deselectAllObjects(), Vispa.Gui.VispaWidgetOwner.VispaWidgetOwner::deselectAllWidgets(), Vispa.Gui.VispaWidget.VispaWidget::enableAutosizing(), progressbar.ProgressBar::finish(), Vispa.Gui.MenuWidget.MenuWidget::leaveEvent(), Vispa.Gui.VispaWidgetOwner.VispaWidgetOwner::mouseMoveEvent(), Vispa.Gui.MenuWidget.MenuWidget::mouseMoveEvent(), Vispa.Views.LineDecayView.LineDecayContainer::mouseMoveEvent(), Vispa.Gui.VispaWidgetOwner.VispaWidgetOwner::mouseReleaseEvent(), Vispa.Views.LineDecayView.LineDecayContainer::objectMoved(), relval_steps.Steps::overwrite(), Vispa.Views.LineDecayView.LineDecayContainer::removeObject(), Vispa.Gui.ConnectableWidget.ConnectableWidget::removePorts(), Vispa.Gui.FindDialog.FindDialog::reset(), Vispa.Gui.PortConnection.PointToPointConnection::select(), Vispa.Gui.VispaWidget.VispaWidget::select(), Vispa.Views.LineDecayView.LineDecayContainer::select(), Vispa.Gui.VispaWidget.VispaWidget::setText(), Vispa.Gui.VispaWidget.VispaWidget::setTitle(), Vispa.Gui.ZoomableWidget.ZoomableWidget::setZoom(), Vispa.Views.LineDecayView.LineDecayContainer::setZoom(), and Vispa.Gui.PortConnection.PointToPointConnection::updateConnection().

                                                       {
    if (readDB_ && parameterWatcher_.check(setup)){
      for (size_t makeIdx = 0; makeIdx < maxNbSources_; makeIdx++ ) {
    if (inputSources_[makeIdx]) inputSources_[makeIdx]->reload(setup);
      }
      reload(setup);
    }
  }

Member Data Documentation

int edm::BMixingModule::bunchSpace_

protected

Definition at line 78 of file BMixingModule.h.

Referenced by edm::MixingModule::doPileUp(), edm::MixingModule::MixingModule(), edm::MixingModule::pileAllWorkers(), and edm::MixingModule::reload().

bool edm::BMixingModule::checktof_

protected

Definition at line 80 of file BMixingModule.h.

bool edm::BMixingModule::doit_[4]

protected

Definition at line 90 of file BMixingModule.h.

unsigned int edm::BMixingModule::eventId_

protected

Definition at line 93 of file BMixingModule.h.

std::vector<std::shared_ptr<PileUp> > edm::BMixingModule::inputSources_

protected

Definition at line 96 of file BMixingModule.h.

Referenced by averageNumber(), beginJob(), beginLuminosityBlock(), beginRun(), BMixingModule(), edm::DataMixingModule::doPileUp(), edm::MixingModule::doPileUp(), dropUnwantedBranches(), endJob(), endLuminosityBlock(), endRun(), poisson(), setupPileUpEvent(), and update().

int edm::BMixingModule::maxBunch_

protected

Definition at line 82 of file BMixingModule.h.

Referenced by BMixingModule(), edm::MixingModule::createnewEDProduct(), edm::DataMixingModule::doPileUp(), edm::MixingModule::doPileUp(), edm::MixingModule::MixingModule(), and edm::MixingModule::reload().

const unsigned int BMixingModule::maxNbSources_ =4

staticprotected

Definition at line 88 of file BMixingModule.h.

Referenced by beginJob(), beginLuminosityBlock(), beginRun(), BMixingModule(), edm::MixingModule::createnewEDProduct(), edm::DataMixingModule::doPileUp(), edm::MixingModule::doPileUp(), dropUnwantedBranches(), endJob(), endLuminosityBlock(), endRun(), edm::MixingModule::MixingModule(), setupPileUpEvent(), and update().

int edm::BMixingModule::minBunch_

protected

Definition at line 81 of file BMixingModule.h.

Referenced by BMixingModule(), edm::MixingModule::createnewEDProduct(), edm::DataMixingModule::doPileUp(), edm::MixingModule::doPileUp(), edm::MixingModule::MixingModule(), and edm::MixingModule::reload().

bool const edm::BMixingModule::mixProdStep1_

protected

Definition at line 83 of file BMixingModule.h.

Referenced by produce().

bool const edm::BMixingModule::mixProdStep2_

protected

Definition at line 84 of file BMixingModule.h.

edm::ESWatcher<MixingRcd> edm::BMixingModule::parameterWatcher_

protected

Definition at line 99 of file BMixingModule.h.

Referenced by update().

bool edm::BMixingModule::playback_

protected

Definition at line 87 of file BMixingModule.h.

Referenced by BMixingModule(), edm::MixingModule::doPileUp(), and edm::MixingModule::MixingModule().

bool edm::BMixingModule::readDB_

protected

Definition at line 86 of file BMixingModule.h.

Referenced by BMixingModule(), and update().

std::vector<std::string> edm::BMixingModule::sourceNames_

protected

Definition at line 89 of file BMixingModule.h.

Referenced by BMixingModule().

std::vector< float > edm::BMixingModule::TrueNumInteractions_

protected

Definition at line 91 of file BMixingModule.h.

Referenced by edm::DataMixingModule::doPileUp(), and edm::MixingModule::doPileUp().

int edm::BMixingModule::vertexOffset_

protected

Definition at line 79 of file BMixingModule.h.