edm::PileUp Class Reference

#include <PileUp.h>

Public Types
typedef VectorInputSource::EventPrincipalVector	EventPrincipalVector

Public Member Functions
double	averageNumber () const
bool	doPileup ()
void	dropUnwantedBranches (std::vector< std::string > const &wantedBranches)
void	endJob ()
	PileUp (ParameterSet const &pset, int const minb, int const maxb, double averageNumber, TH1F *const histo, const bool playback)
bool	poisson () const
void	readPileUp (std::vector< EventPrincipalVector > &result, std::vector< std::vector< edm::EventID > > &ids)
	~PileUp ()

Private Attributes
double const	averageNumber_
bool const	fixed_
bool	fixed_OOT_
TH1F *	h1f
TH1F *const	histo_
bool const	histoDistribution_
TH1F *	hprobFunction
VectorInputSource *const	input_
int const	intAverage_
int	intFixed_OOT_
bool	manage_OOT_
int const	maxBunch_
int const	minBunch_
bool const	none_
bool	playback_
bool const	poisson_
bool	poisson_OOT_
CLHEP::RandPoisson *	poissonDistr_OOT_
CLHEP::RandPoissonQ *	poissonDistribution_
TFile *	probFileHisto
bool const	probFunctionDistribution_
int	seed_
bool	sequential_
std::string const	type_

Detailed Description

Definition at line 22 of file PileUp.h.

Member Typedef Documentation

typedef VectorInputSource::EventPrincipalVector edm::PileUp::EventPrincipalVector

Definition at line 24 of file PileUp.h.

Constructor & Destructor Documentation

edm::PileUp::PileUp ( ParameterSet const &  pset, int const  minb, int const  maxb, double  averageNumber, TH1F *const  histo, const bool  playback  )

explicit

Definition at line 22 of file PileUp.cc.

References averageNumber_, edm::hlt::Exception, fixed_, fixed_OOT_, edm::RandomNumberGenerator::getEngine(), edm::ParameterSet::getUntrackedParameter(), histoDistribution_, intFixed_OOT_, edm::Service< T >::isAvailable(), manage_OOT_, none_, playback_, poisson_, poisson_OOT_, poissonDistr_OOT_, poissonDistribution_, probFunctionDistribution_, seed_, and type_.

                                                                                                                                        :
    type_(pset.getParameter<std::string>("type")),
    minBunch_(minb),
    maxBunch_(maxb),
    averageNumber_(averageNumber),
    intAverage_(static_cast<int>(averageNumber)),
    histo_(histo),
    histoDistribution_(type_ == "histo"),
    probFunctionDistribution_(type_ == "probFunction"),
    poisson_(type_ == "poisson"),
    fixed_(type_ == "fixed"),
    none_(type_ == "none"),
    input_(VectorInputSourceFactory::get()->makeVectorInputSource(pset, InputSourceDescription()).release()),
    poissonDistribution_(0),
    playback_(playback),
    sequential_(pset.getUntrackedParameter<bool>("sequential", false)),
    seed_(pset.getParameter<edm::ParameterSet>("nbPileupEvents").getUntrackedParameter<int>("seed",1234))
   {

    
    edm::Service<edm::RandomNumberGenerator> rng;
    if (!rng.isAvailable()) {
      throw cms::Exception("Configuration")
    << "PileUp requires the RandomNumberGeneratorService\n"
    "which is not present in the configuration file.  You must add the service\n"
    "in the configuration file or remove the modules that require it.";
    }
    
    CLHEP::HepRandomEngine& engine = rng->getEngine();
    poissonDistribution_ = new CLHEP::RandPoissonQ(engine, averageNumber_);
    
    // Get seed for the case when using user histogram or probability function
    if (histoDistribution_ || probFunctionDistribution_){ 
      gRandom->SetSeed(seed_);
      LogInfo("MixingModule") << " Change seed for " << type_ << " mode. The seed is set to " << seed_;
    } 
     
        
    if (!(histoDistribution_ || probFunctionDistribution_ || poisson_ || fixed_ || none_)) {
      throw cms::Exception("Illegal parameter value","PileUp::PileUp(ParameterSet const& pset)")
        << "'type' parameter (a string) has a value of '" << type_ << "'.\n"
        << "Legal values are 'poisson', 'fixed', or 'none'\n";
    }

    manage_OOT_ = pset.getUntrackedParameter<bool>("manage_OOT", false);

    if(manage_OOT_) { // figure out what the parameters are

      if (playback_) throw cms::Exception("Illegal parameter clash","PileUp::PileUp(ParameterSet const& pset)")
    << " manage_OOT option not allowed with playback ";

      std::string OOT_type = pset.getUntrackedParameter<std::string>("OOT_type");

      if(OOT_type == "Poisson" || OOT_type == "poisson") {
    poisson_OOT_ = true;
    poissonDistr_OOT_ = new CLHEP::RandPoisson(engine);
      }
      else if(OOT_type == "Fixed" || OOT_type == "fixed") {
    fixed_OOT_ = true;
    // read back the fixed number requested out-of-time
    intFixed_OOT_ = pset.getUntrackedParameter<int>("intFixed_OOT", -1);
    if(intFixed_OOT_ < 0) {
      throw cms::Exception("Illegal parameter value","PileUp::PileUp(ParameterSet const& pset)") 
        << " Fixed out-of-time pileup requested, but no fixed value given ";
    }
      }
      else {
    throw cms::Exception("Illegal parameter value","PileUp::PileUp(ParameterSet const& pset)")
      << "'OOT_type' parameter (a string) has a value of '" << OOT_type << "'.\n"
      << "Legal values are 'poisson' or 'fixed'\n";
      }
      edm::LogInfo("MixingModule") <<" Out-of-time pileup will be generated with a " << OOT_type << " distribution. " ;
    }
    
  }

edm::PileUp::~PileUp

(

)

Definition at line 98 of file PileUp.cc.

References poissonDistribution_.

                  {
    delete poissonDistribution_;
  }

Member Function Documentation

double edm::PileUp::averageNumber ( ) const

inline

Definition at line 30 of file PileUp.h.

References averageNumber_.

{return averageNumber_;}

bool edm::PileUp::doPileup ( )

inline

Definition at line 32 of file PileUp.h.

References averageNumber_, and none_.

{return none_ ? false :  averageNumber_>0.;}

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

inline

Definition at line 33 of file PileUp.h.

References edm::VectorInputSource::dropUnwantedBranches(), and input_.

                                                                          {
      input_->dropUnwantedBranches(wantedBranches);
    }

void edm::PileUp::endJob ( void  )

inline

Definition at line 36 of file PileUp.h.

References edm::InputSource::doEndJob(), and input_.

                   {
      input_->doEndJob();
    }

bool edm::PileUp::poisson ( ) const

inline

Definition at line 31 of file PileUp.h.

References poisson_.

{return poisson_;}

void edm::PileUp::readPileUp	(	std::vector< EventPrincipalVector > &	result,
		std::vector< std::vector< edm::EventID > > &	ids
	)

Definition at line 103 of file PileUp.cc.

References filterCSVwithJSON::copy, dbtoweb::file, fixed_, histo_, histoDistribution_, i, input_, intAverage_, intFixed_OOT_, j, LogDebug, manage_OOT_, maxBunch_, minBunch_, n, nint(), none_, playback_, poisson_, poisson_OOT_, poissonDistr_OOT_, poissonDistribution_, probFunctionDistribution_, edm::VectorInputSource::readManyRandom(), edm::VectorInputSource::readManySequential(), edm::VectorInputSource::readManySpecified(), sequential_, and findQualityFiles::size.

                                                                                                    {

    // set up vector of event counts for each bunch crossing ahead of time, so that we can
    // allow for an arbitrary distribution for out-of-time vs. in-time pileup

    std::vector<int> nint;

    // if we are managing the distribution of out-of-time pileup separately, select the distribution for bunch
    // crossing zero first, save it for later.

    int nzero_crossing = -1;

    if(manage_OOT_) {
      if (none_){
    nzero_crossing = 0;
      }else if (poisson_){
    nzero_crossing =  poissonDistribution_->fire() ;
      }else if (fixed_){
    nzero_crossing =  intAverage_ ;
      }else if (histoDistribution_ || probFunctionDistribution_){
    double d = histo_->GetRandom();
    //n = (int) floor(d + 0.5);  // incorrect for bins with integer edges
    nzero_crossing =  int(d);
      }
    }
            
    for (int i = minBunch_; i <= maxBunch_; ++i) {
      
      if (playback_){
    nint.push_back( ids[i-minBunch_].size() );
      //} else if (sequential_) {  // just read many sequentially... why specify?
      // For now, the use case for sequential read reads only one event at a time.
      // nint.push_back( 1 );
      } 
      else if(manage_OOT_) {
    if(i==0 && !poisson_OOT_) nint.push_back(nzero_crossing);
    else{
      if(poisson_OOT_) {
        nint.push_back( poissonDistr_OOT_->fire(float(nzero_crossing)) );
      }
      else {
        nint.push_back( intFixed_OOT_ );
      }   
    }
      } 
      else {    
    if (none_){
      nint.push_back(0);
    }else if (poisson_){
      nint.push_back( poissonDistribution_->fire() );
    }else if (fixed_){
      nint.push_back( intAverage_ );
    }else if (histoDistribution_ || probFunctionDistribution_){
      double d = histo_->GetRandom();
      //n = (int) floor(d + 0.5);  // incorrect for bins with integer edges
      nint.push_back( int(d) );
    }

      }
    }

    int n=0;
      
    for (int i = minBunch_; i <= maxBunch_; ++i) {
      EventPrincipalVector eventVector;

      n = nint[i-minBunch_];

      eventVector.reserve(n);
      while (n > 0) {
        EventPrincipalVector oneResult;
        oneResult.reserve(n);
    std::vector<edm::EventID> oneResultPlayback;
    oneResultPlayback.reserve(n);
    if (playback_)   {
      input_->readManySpecified(ids[i-minBunch_],oneResult);  // playback
    } else if (sequential_) {
      unsigned int file;
      input_->readManySequential(n, oneResult, file);  // sequential
      for (int j=0;j<(int)oneResult.size();j++){
        oneResultPlayback.push_back(oneResult[j]->id());
      }
      ids[i-minBunch_] = oneResultPlayback;
    } else  {
      unsigned int file;   //FIXME: need unsigned filenr?
      input_->readManyRandom(n, oneResult,file);     //no playback
      for (int j=0;j<(int)oneResult.size();j++){
        oneResultPlayback.push_back(oneResult[j]->id());
      }
      ids[i-minBunch_] = oneResultPlayback;
    }
        LogDebug("readPileup") << "READ: " << oneResult.size();
        std::copy(oneResult.begin(), oneResult.end(), std::back_inserter(eventVector));
    n -= oneResult.size();
      }
      result.push_back(eventVector);
    }
  }

Member Data Documentation

double const edm::PileUp::averageNumber_

private

Definition at line 44 of file PileUp.h.

Referenced by averageNumber(), doPileup(), and PileUp().

bool const edm::PileUp::fixed_

private

Definition at line 50 of file PileUp.h.

Referenced by PileUp(), and readPileUp().

bool edm::PileUp::fixed_OOT_

private

Definition at line 54 of file PileUp.h.

Referenced by PileUp().

TH1F* edm::PileUp::h1f

private

Definition at line 62 of file PileUp.h.

TH1F* const edm::PileUp::histo_

private

Definition at line 46 of file PileUp.h.

Referenced by readPileUp().

bool const edm::PileUp::histoDistribution_

private

Definition at line 47 of file PileUp.h.

Referenced by PileUp(), and readPileUp().

TH1F* edm::PileUp::hprobFunction

private

Definition at line 63 of file PileUp.h.

VectorInputSource* const edm::PileUp::input_

private

Definition at line 57 of file PileUp.h.

Referenced by dropUnwantedBranches(), endJob(), and readPileUp().

int const edm::PileUp::intAverage_

private

Definition at line 45 of file PileUp.h.

Referenced by readPileUp().

int edm::PileUp::intFixed_OOT_

private

Definition at line 55 of file PileUp.h.

Referenced by PileUp(), and readPileUp().

bool edm::PileUp::manage_OOT_

private

Definition at line 52 of file PileUp.h.

Referenced by PileUp(), and readPileUp().

int const edm::PileUp::maxBunch_

private

Definition at line 43 of file PileUp.h.

Referenced by readPileUp().

int const edm::PileUp::minBunch_

private

Definition at line 42 of file PileUp.h.

Referenced by readPileUp().

bool const edm::PileUp::none_

private

Definition at line 51 of file PileUp.h.

Referenced by doPileup(), PileUp(), and readPileUp().

bool edm::PileUp::playback_

private

Definition at line 67 of file PileUp.h.

Referenced by PileUp(), and readPileUp().

bool const edm::PileUp::poisson_

private

Definition at line 49 of file PileUp.h.

Referenced by PileUp(), poisson(), and readPileUp().

bool edm::PileUp::poisson_OOT_

private

Definition at line 53 of file PileUp.h.

Referenced by PileUp(), and readPileUp().

CLHEP::RandPoisson* edm::PileUp::poissonDistr_OOT_

private

Definition at line 59 of file PileUp.h.

Referenced by PileUp(), and readPileUp().

CLHEP::RandPoissonQ* edm::PileUp::poissonDistribution_

private

Definition at line 58 of file PileUp.h.

Referenced by PileUp(), readPileUp(), and ~PileUp().

TFile* edm::PileUp::probFileHisto

private

Definition at line 64 of file PileUp.h.

bool const edm::PileUp::probFunctionDistribution_

private

Definition at line 48 of file PileUp.h.

Referenced by PileUp(), and readPileUp().

int edm::PileUp::seed_

private

Definition at line 73 of file PileUp.h.

Referenced by PileUp().

bool edm::PileUp::sequential_

private

Definition at line 70 of file PileUp.h.

Referenced by readPileUp().

std::string const edm::PileUp::type_

private

Definition at line 41 of file PileUp.h.

Referenced by Modules.Service::_placeImpl(), Modules.ESSource::_placeImpl(), Modules.ESProducer::_placeImpl(), Modules.ESPrefer::copy(), Mixins._TypedParameterizable::dumpPython(), Modules.ESPrefer::dumpPythonAs(), Modules.Service::insertInto(), RandomRunSource.RandomRunSource::insertInto(), Mixins._TypedParameterizable::insertInto(), Modules.ESSource::moduleLabel_(), Modules.ESProducer::moduleLabel_(), Modules.ESSource::nameInProcessDesc_(), Modules.ESProducer::nameInProcessDesc_(), Modules.ESPrefer::nameInProcessDesc_(), and PileUp().