CMS 3D CMS Logo

 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Pages
List of all members | Public Member Functions | Private Member Functions | Private Attributes
edm::PileUp Class Reference

#include <PileUp.h>

Public Member Functions

double averageNumber () const
 
void beginJob ()
 
void beginLuminosityBlock (const edm::LuminosityBlock &lumi, const edm::EventSetup &setup)
 
void beginRun (const edm::Run &run, const edm::EventSetup &setup)
 
void CalculatePileup (int MinBunch, int MaxBunch, std::vector< int > &PileupSelection, std::vector< float > &TrueNumInteractions, StreamID const &)
 
bool doPileUp (int BX)
 
void dropUnwantedBranches (std::vector< std::string > const &wantedBranches)
 
void endJob ()
 
void endLuminosityBlock (const edm::LuminosityBlock &lumi, const edm::EventSetup &setup)
 
void endRun (const edm::Run &run, const edm::EventSetup &setup)
 
const unsigned int & input () const
 
void input (unsigned int s)
 
 PileUp (ParameterSet const &pset, std::string sourcename, double averageNumber, TH1F *const histo, const bool playback)
 
template<typename T >
void playPileUp (const std::vector< edm::EventID > &ids, T eventOperator)
 
bool poisson () const
 
template<typename T >
void readPileUp (edm::EventID const &signal, std::vector< edm::EventID > &ids, T eventOperator, const int NumPU, StreamID const &)
 
void reload (const edm::EventSetup &setup)
 
void setupPileUpEvent (const edm::EventSetup &setup)
 
 ~PileUp ()
 

Private Member Functions

std::unique_ptr
< CLHEP::RandPoisson > const & 
poissonDistr_OOT (StreamID const &streamID)
 
std::unique_ptr
< CLHEP::RandPoissonQ > const & 
poissonDistribution (StreamID const &streamID)
 
CLHEP::HepRandomEngine * randomEngine (StreamID const &streamID)
 

Private Attributes

double averageNumber_
 
std::unique_ptr< EventPrincipaleventPrincipal_
 
bool fixed_
 
bool fixed_OOT_
 
TH1F * h1f
 
TH1F * histo_
 
bool histoDistribution_
 
TH1F * hprobFunction
 
std::unique_ptr
< VectorInputSource > const 
input_
 
unsigned int inputType_
 
int const intAverage_
 
int intFixed_ITPU_
 
int intFixed_OOT_
 
std::shared_ptr
< LuminosityBlockPrincipal
lumiPrincipal_
 
bool manage_OOT_
 
int maxBunch_cosmics_
 
int minBunch_cosmics_
 
bool none_
 
bool playback_
 
bool poisson_
 
bool poisson_OOT_
 
TFile * probFileHisto
 
bool probFunctionDistribution_
 
std::shared_ptr
< ProcessConfiguration
processConfiguration_
 
std::shared_ptr< ProductRegistryproductRegistry_
 
std::unique_ptr
< SecondaryEventProvider
provider_
 
bool PU_Study_
 
std::vector
< CLHEP::HepRandomEngine * > 
randomEngines_
 
std::shared_ptr< RunPrincipalrunPrincipal_
 
bool samelumi_
 
int seed_
 
bool sequential_
 
std::string Source_type_
 
std::string Study_type_
 
std::string type_
 
std::vector< std::unique_ptr
< CLHEP::RandPoisson > > 
vPoissonDistr_OOT_
 
std::vector< std::unique_ptr
< CLHEP::RandPoissonQ > > 
vPoissonDistribution_
 

Detailed Description

Definition at line 30 of file PileUp.h.

Constructor & Destructor Documentation

edm::PileUp::PileUp ( ParameterSet const &  pset,
std::string  sourcename,
double  averageNumber,
TH1F *const  histo,
const bool  playback 
)
explicit

Definition at line 33 of file PileUp.cc.

References dqmPostProcessing_online::DB, edm::ParameterSet::emptyParameterSetID(), eventPrincipal_, edm::hlt::Exception, edm::ParameterSet::exists(), edm::ParameterSet::existsAs(), fixed_, fixed_OOT_, edm::ParameterSet::getParameter(), edm::ParameterSet::getUntrackedParameter(), histoDistribution_, input_, intFixed_ITPU_, intFixed_OOT_, edm::Service< T >::isAvailable(), manage_OOT_, maxBunch_cosmics_, minBunch_cosmics_, edm::RandomNumberGenerator::mySeed(), none_, poisson_, poisson_OOT_, probFunctionDistribution_, processConfiguration_, productRegistry_, provider_, PU_Study_, seed_, Source_type_, AlCaHLTBitMon_QueryRunRegistry::string, Study_type_, and type_.

33  :
34  type_(pset.getParameter<std::string>("type")),
35  Source_type_(sourcename),
37  intAverage_(static_cast<int>(averageNumber)),
38  histo_(histo),
39  histoDistribution_(type_ == "histo"),
40  probFunctionDistribution_(type_ == "probFunction"),
41  poisson_(type_ == "poisson"),
42  fixed_(type_ == "fixed"),
43  none_(type_ == "none"),
45  input_(VectorInputSourceFactory::get()->makeVectorInputSource(pset, InputSourceDescription(
46  ModuleDescription(),
48  std::make_shared<BranchIDListHelper>(),
49  std::make_shared<ThinnedAssociationsHelper>(),
50  std::make_shared<ActivityRegistry>(),
51  -1, -1, -1,
52  PreallocationConfiguration()
53  )).release()),
54  processConfiguration_(new ProcessConfiguration(std::string("@MIXING"), getReleaseVersion(), getPassID())),
57  runPrincipal_(),
58  provider_(),
63  sequential_(pset.getUntrackedParameter<bool>("sequential", false)),
64  samelumi_(pset.getUntrackedParameter<bool>("sameLumiBlock", false)),
65  seed_(0) {
66 
67  // Use the empty parameter set for the parameter set ID of our "@MIXING" process.
69 
70  if(pset.existsAs<std::vector<ParameterSet> >("producers", true)) {
71  std::vector<ParameterSet> producers = pset.getParameter<std::vector<ParameterSet> >("producers");
72  provider_.reset(new SecondaryEventProvider(producers, *productRegistry_, processConfiguration_));
73  }
74 
75  productRegistry_->setFrozen();
76 
77  // A modified HistoryAppender must be used for unscheduled processing.
78  eventPrincipal_.reset(new EventPrincipal(input_->productRegistry(),
79  input_->branchIDListHelper(),
80  input_->thinnedAssociationsHelper(),
82  nullptr));
83 
84  if (pset.exists("nbPileupEvents")) {
85  seed_=pset.getParameter<edm::ParameterSet>("nbPileupEvents").getUntrackedParameter<int>("seed",0);
86  }
87 
88  bool DB=type_=="readDB";
89 
91  if (!rng.isAvailable()) {
92  throw cms::Exception("Configuration")
93  << "PileUp requires the RandomNumberGeneratorService\n"
94  "which is not present in the configuration file. You must add the service\n"
95  "in the configuration file or remove the modules that require it.";
96  }
97 
98  // Get seed for the case when using user histogram or probability function
99  // RANDOM_NUMBER_ERROR
100  // Random number should be generated by the engines from the
101  // RandomNumberGeneratorService. This appears to use the global
102  // engine in ROOT. This is not thread safe unless the module using
103  // it is a one module and declares a shared resource and all
104  // other modules using it also declare the same shared resource.
105  // This also breaks replay.
107  if(seed_ !=0) {
108  gRandom->SetSeed(seed_);
109  LogInfo("MixingModule") << " Change seed for " << type_ << " mode. The seed is set to " << seed_;
110  }
111  else {
112  gRandom->SetSeed(rng->mySeed());
113  }
114  }
115 
117  throw cms::Exception("Illegal parameter value","PileUp::PileUp(ParameterSet const& pset)")
118  << "'type' parameter (a string) has a value of '" << type_ << "'.\n"
119  << "Legal values are 'poisson', 'fixed', or 'none'\n";
120  }
121 
122  if (!DB){
123  manage_OOT_ = pset.getUntrackedParameter<bool>("manage_OOT", false);
124 
125  // Check for string describing special processing. Add these here for individual cases
126 
127  PU_Study_ = false;
128  Study_type_ = "";
129 
130  Study_type_ = pset.getUntrackedParameter<std::string>("Special_Pileup_Studies", "");
131 
132  if(Study_type_ == "Fixed_ITPU_Vary_OOTPU") {
133 
134  PU_Study_ = true;
135  intFixed_ITPU_ = pset.getUntrackedParameter<int>("intFixed_ITPU", 0);
136 
137  }
138 
139  if(manage_OOT_) { // figure out what the parameters are
140 
141  // if (playback_) throw cms::Exception("Illegal parameter clash","PileUp::PileUp(ParameterSet const& pset)")
142  // << " manage_OOT option not allowed with playback ";
143 
144  std::string OOT_type = pset.getUntrackedParameter<std::string>("OOT_type");
145 
146  if(OOT_type == "Poisson" || OOT_type == "poisson") {
147  poisson_OOT_ = true;
148  }
149  else if(OOT_type == "Fixed" || OOT_type == "fixed") {
150  fixed_OOT_ = true;
151  // read back the fixed number requested out-of-time
152  intFixed_OOT_ = pset.getUntrackedParameter<int>("intFixed_OOT", -1);
153  if(intFixed_OOT_ < 0) {
154  throw cms::Exception("Illegal parameter value","PileUp::PileUp(ParameterSet const& pset)")
155  << " Fixed out-of-time pileup requested, but no fixed value given ";
156  }
157  }
158  else {
159  throw cms::Exception("Illegal parameter value","PileUp::PileUp(ParameterSet const& pset)")
160  << "'OOT_type' parameter (a string) has a value of '" << OOT_type << "'.\n"
161  << "Legal values are 'poisson' or 'fixed'\n";
162  }
163  edm::LogInfo("MixingModule") <<" Out-of-time pileup will be generated with a " << OOT_type << " distribution. " ;
164  }
165  }
166 
167  if(Source_type_ == "cosmics") { // allow for some extra flexibility for mixing
168  minBunch_cosmics_ = pset.getUntrackedParameter<int>("minBunch_cosmics", -1000);
169  maxBunch_cosmics_ = pset.getUntrackedParameter<int>("maxBunch_cosmics", 1000);
170  }
171 
172 
173 
174  } // end of constructor
bool manage_OOT_
Definition: PileUp.h:93
std::string getPassID()
Definition: GetPassID.h:8
std::unique_ptr< SecondaryEventProvider > provider_
Definition: PileUp.h:113
std::shared_ptr< ProcessConfiguration > processConfiguration_
Definition: PileUp.h:109
TH1F * histo_
Definition: PileUp.h:87
bool fixed_
Definition: PileUp.h:91
std::vector< CLHEP::HepRandomEngine * > randomEngines_
Definition: PileUp.h:116
int const intAverage_
Definition: PileUp.h:86
bool probFunctionDistribution_
Definition: PileUp.h:89
int maxBunch_cosmics_
Definition: PileUp.h:105
std::string Study_type_
Definition: PileUp.h:98
bool histoDistribution_
Definition: PileUp.h:88
bool poisson_
Definition: PileUp.h:90
double averageNumber() const
Definition: PileUp.h:41
bool playback_
Definition: PileUp.h:123
virtual std::uint32_t mySeed() const =0
std::vector< std::unique_ptr< CLHEP::RandPoissonQ > > vPoissonDistribution_
Definition: PileUp.h:114
bool samelumi_
Definition: PileUp.h:129
std::unique_ptr< VectorInputSource > const input_
Definition: PileUp.h:108
bool poisson_OOT_
Definition: PileUp.h:94
bool isAvailable() const
Definition: Service.h:46
int intFixed_ITPU_
Definition: PileUp.h:102
bool PU_Study_
Definition: PileUp.h:97
bool fixed_OOT_
Definition: PileUp.h:95
int minBunch_cosmics_
Definition: PileUp.h:104
std::string getReleaseVersion()
std::shared_ptr< LuminosityBlockPrincipal > lumiPrincipal_
Definition: PileUp.h:111
std::string type_
Definition: PileUp.h:83
std::shared_ptr< ProductRegistry > productRegistry_
Definition: PileUp.h:107
bool sequential_
Definition: PileUp.h:126
std::string Source_type_
Definition: PileUp.h:84
int seed_
Definition: PileUp.h:132
bool none_
Definition: PileUp.h:92
tuple playback
Definition: Playback_cff.py:20
std::vector< std::unique_ptr< CLHEP::RandPoisson > > vPoissonDistr_OOT_
Definition: PileUp.h:115
int intFixed_OOT_
Definition: PileUp.h:101
std::unique_ptr< EventPrincipal > eventPrincipal_
Definition: PileUp.h:110
std::shared_ptr< RunPrincipal > runPrincipal_
Definition: PileUp.h:112
static VectorInputSourceFactory const * get()
static ParameterSetID emptyParameterSetID()
double averageNumber_
Definition: PileUp.h:85
edm::PileUp::~PileUp ( )

Definition at line 325 of file PileUp.cc.

325  {
326  }

Member Function Documentation

double edm::PileUp::averageNumber ( ) const
inline

Definition at line 41 of file PileUp.h.

References averageNumber_.

Referenced by reload().

41 {return averageNumber_;}
double averageNumber_
Definition: PileUp.h:85
void edm::PileUp::beginJob ( void  )

Definition at line 180 of file PileUp.cc.

References input_, productRegistry_, and provider_.

180  {
181  input_->doBeginJob();
182  if (provider_.get() != nullptr) {
183  provider_->beginJob(*productRegistry_);
184  }
185  }
std::unique_ptr< SecondaryEventProvider > provider_
Definition: PileUp.h:113
std::unique_ptr< VectorInputSource > const input_
Definition: PileUp.h:108
std::shared_ptr< ProductRegistry > productRegistry_
Definition: PileUp.h:107
void edm::PileUp::beginLuminosityBlock ( const edm::LuminosityBlock lumi,
const edm::EventSetup setup 
)

Definition at line 201 of file PileUp.cc.

References printConversionInfo::aux, edm::LuminosityBlock::luminosityBlockAuxiliary(), lumiPrincipal_, edm::LuminosityBlock::moduleCallingContext(), processConfiguration_, productRegistry_, provider_, and runPrincipal_.

201  {
202  if (provider_.get() != nullptr) {
203  auto aux = std::make_shared<LuminosityBlockAuxiliary>(lumi.luminosityBlockAuxiliary());
204  lumiPrincipal_.reset(new LuminosityBlockPrincipal(aux, productRegistry_, *processConfiguration_, nullptr, 0));
205  lumiPrincipal_->setRunPrincipal(runPrincipal_);
206  provider_->beginLuminosityBlock(*lumiPrincipal_, setup, lumi.moduleCallingContext());
207  }
208  }
std::unique_ptr< SecondaryEventProvider > provider_
Definition: PileUp.h:113
std::shared_ptr< ProcessConfiguration > processConfiguration_
Definition: PileUp.h:109
ModuleCallingContext const * moduleCallingContext() const
std::shared_ptr< LuminosityBlockPrincipal > lumiPrincipal_
Definition: PileUp.h:111
LuminosityBlockAuxiliary const & luminosityBlockAuxiliary() const
std::shared_ptr< ProductRegistry > productRegistry_
Definition: PileUp.h:107
std::shared_ptr< RunPrincipal > runPrincipal_
Definition: PileUp.h:112
void edm::PileUp::beginRun ( const edm::Run run,
const edm::EventSetup setup 
)

Definition at line 194 of file PileUp.cc.

References printConversionInfo::aux, edm::Run::moduleCallingContext(), processConfiguration_, productRegistry_, provider_, edm::Run::runAuxiliary(), and runPrincipal_.

194  {
195  if (provider_.get() != nullptr) {
196  auto aux = std::make_shared<RunAuxiliary>(run.runAuxiliary());
197  runPrincipal_.reset(new RunPrincipal(aux, productRegistry_, *processConfiguration_, nullptr, 0));
198  provider_->beginRun(*runPrincipal_, setup, run.moduleCallingContext());
199  }
200  }
std::unique_ptr< SecondaryEventProvider > provider_
Definition: PileUp.h:113
std::shared_ptr< ProcessConfiguration > processConfiguration_
Definition: PileUp.h:109
RunAuxiliary const & runAuxiliary() const
Definition: Run.h:55
std::shared_ptr< ProductRegistry > productRegistry_
Definition: PileUp.h:107
ModuleCallingContext const * moduleCallingContext() const
Definition: Run.h:143
std::shared_ptr< RunPrincipal > runPrincipal_
Definition: PileUp.h:112
void edm::PileUp::CalculatePileup ( int  MinBunch,
int  MaxBunch,
std::vector< int > &  PileupSelection,
std::vector< float > &  TrueNumInteractions,
StreamID const &  streamID 
)

Definition at line 374 of file PileUp.cc.

References averageNumber_, fixed_, histo_, histoDistribution_, intAverage_, intFixed_ITPU_, intFixed_OOT_, manage_OOT_, none_, poisson_, poisson_OOT_, poissonDistr_OOT(), poissonDistribution(), probFunctionDistribution_, PU_Study_, and Study_type_.

374  {
375 
376  // if we are managing the distribution of out-of-time pileup separately, select the distribution for bunch
377  // crossing zero first, save it for later.
378 
379  int nzero_crossing = -1;
380  double Fnzero_crossing = -1;
381 
382  if(manage_OOT_) {
383  if (none_){
384  nzero_crossing = 0;
385  }else if (poisson_){
386  nzero_crossing = poissonDistribution(streamID)->fire() ;
387  }else if (fixed_){
388  nzero_crossing = intAverage_ ;
390  // RANDOM_NUMBER_ERROR
391  // Random number should be generated by the engines from the
392  // RandomNumberGeneratorService. This appears to use the global
393  // engine in ROOT. This is not thread safe unless the module using
394  // it is a one module and declares a shared resource and all
395  // other modules using it also declare the same shared resource.
396  // This also breaks replay.
397  double d = histo_->GetRandom();
398  //n = (int) floor(d + 0.5); // incorrect for bins with integer edges
399  Fnzero_crossing = d;
400  nzero_crossing = int(d);
401  }
402 
403  }
404 
405  for(int bx = MinBunch; bx < MaxBunch+1; ++bx) {
406 
407  if(manage_OOT_) {
408  if(bx==0 && !poisson_OOT_) {
409  PileupSelection.push_back(nzero_crossing) ;
410  TrueNumInteractions.push_back( nzero_crossing );
411  }
412  else{
413  if(poisson_OOT_) {
414  if(PU_Study_ && (Study_type_ == "Fixed_ITPU_Vary_OOTPU" ) && bx==0 ) {
415  PileupSelection.push_back(intFixed_ITPU_) ;
416  }
417  else{
418  PileupSelection.push_back(poissonDistr_OOT(streamID)->fire(Fnzero_crossing)) ;
419  }
420  TrueNumInteractions.push_back( Fnzero_crossing );
421  }
422  else {
423  PileupSelection.push_back(intFixed_OOT_) ;
424  TrueNumInteractions.push_back( intFixed_OOT_ );
425  }
426  }
427  }
428  else {
429  if (none_){
430  PileupSelection.push_back(0);
431  TrueNumInteractions.push_back( 0. );
432  }else if (poisson_){
433  PileupSelection.push_back(poissonDistribution(streamID)->fire());
434  TrueNumInteractions.push_back( averageNumber_ );
435  }else if (fixed_){
436  PileupSelection.push_back(intAverage_);
437  TrueNumInteractions.push_back( intAverage_ );
439  // RANDOM_NUMBER_ERROR
440  // Random number should be generated by the engines from the
441  // RandomNumberGeneratorService. This appears to use the global
442  // engine in ROOT. This is not thread safe unless the module using
443  // it is a one module and declares a shared resource and all
444  // other modules using it also declare the same shared resource.
445  // This also breaks replay.
446  double d = histo_->GetRandom();
447  PileupSelection.push_back(int(d));
448  TrueNumInteractions.push_back( d );
449  }
450  }
451 
452  }
453  }
bool manage_OOT_
Definition: PileUp.h:93
TH1F * histo_
Definition: PileUp.h:87
bool fixed_
Definition: PileUp.h:91
int const intAverage_
Definition: PileUp.h:86
bool probFunctionDistribution_
Definition: PileUp.h:89
std::string Study_type_
Definition: PileUp.h:98
bool histoDistribution_
Definition: PileUp.h:88
bool poisson_
Definition: PileUp.h:90
bool poisson_OOT_
Definition: PileUp.h:94
int intFixed_ITPU_
Definition: PileUp.h:102
std::unique_ptr< CLHEP::RandPoissonQ > const & poissonDistribution(StreamID const &streamID)
Definition: PileUp.cc:328
bool PU_Study_
Definition: PileUp.h:97
std::unique_ptr< CLHEP::RandPoisson > const & poissonDistr_OOT(StreamID const &streamID)
Definition: PileUp.cc:343
bool none_
Definition: PileUp.h:92
int intFixed_OOT_
Definition: PileUp.h:101
double averageNumber_
Definition: PileUp.h:85
bool edm::PileUp::doPileUp ( int  BX)
inline

Definition at line 43 of file PileUp.h.

References averageNumber_, maxBunch_cosmics_, minBunch_cosmics_, none_, and Source_type_.

43  {
44  if(Source_type_ != "cosmics") {
45  return none_ ? false : averageNumber_>0.;
46  }
47  else {
48  return ( BX >= minBunch_cosmics_ && BX <= maxBunch_cosmics_);
49  }
50  }
int maxBunch_cosmics_
Definition: PileUp.h:105
int minBunch_cosmics_
Definition: PileUp.h:104
std::string Source_type_
Definition: PileUp.h:84
bool none_
Definition: PileUp.h:92
double averageNumber_
Definition: PileUp.h:85
void edm::PileUp::dropUnwantedBranches ( std::vector< std::string > const &  wantedBranches)
inline

Definition at line 51 of file PileUp.h.

References input_.

51  {
52  input_->dropUnwantedBranches(wantedBranches);
53  }
std::unique_ptr< VectorInputSource > const input_
Definition: PileUp.h:108
void edm::PileUp::endJob ( void  )

Definition at line 187 of file PileUp.cc.

References input_, and provider_.

187  {
188  if (provider_.get() != nullptr) {
189  provider_->endJob();
190  }
191  input_->doEndJob();
192  }
std::unique_ptr< SecondaryEventProvider > provider_
Definition: PileUp.h:113
std::unique_ptr< VectorInputSource > const input_
Definition: PileUp.h:108
void edm::PileUp::endLuminosityBlock ( const edm::LuminosityBlock lumi,
const edm::EventSetup setup 
)

Definition at line 215 of file PileUp.cc.

References lumiPrincipal_, edm::LuminosityBlock::moduleCallingContext(), and provider_.

215  {
216  if (provider_.get() != nullptr) {
217  provider_->endLuminosityBlock(*lumiPrincipal_, setup, lumi.moduleCallingContext());
218  }
219  }
std::unique_ptr< SecondaryEventProvider > provider_
Definition: PileUp.h:113
ModuleCallingContext const * moduleCallingContext() const
std::shared_ptr< LuminosityBlockPrincipal > lumiPrincipal_
Definition: PileUp.h:111
void edm::PileUp::endRun ( const edm::Run run,
const edm::EventSetup setup 
)

Definition at line 210 of file PileUp.cc.

References edm::Run::moduleCallingContext(), provider_, and runPrincipal_.

210  {
211  if (provider_.get() != nullptr) {
212  provider_->endRun(*runPrincipal_, setup, run.moduleCallingContext());
213  }
214  }
std::unique_ptr< SecondaryEventProvider > provider_
Definition: PileUp.h:113
ModuleCallingContext const * moduleCallingContext() const
Definition: Run.h:143
std::shared_ptr< RunPrincipal > runPrincipal_
Definition: PileUp.h:112
const unsigned int& edm::PileUp::input ( ) const
inline

Definition at line 73 of file PileUp.h.

References inputType_.

73 {return inputType_;}
unsigned int inputType_
Definition: PileUp.h:82
void edm::PileUp::input ( unsigned int  s)
inline

Definition at line 74 of file PileUp.h.

References inputType_, and alignCSCRings::s.

74 {inputType_=s;}
unsigned int inputType_
Definition: PileUp.h:82
template<typename T >
void edm::PileUp::playPileUp ( const std::vector< edm::EventID > &  ids,
T  eventOperator 
)

Definition at line 210 of file PileUp.h.

References eventPrincipal_, and input_.

210  {
211  //TrueNumInteractions.push_back( ids.size() ) ;
212  PassEventID<T> recorder(eventOperator);
213  input_->loopSpecified(*eventPrincipal_,ids,recorder);
214  }
std::unique_ptr< VectorInputSource > const input_
Definition: PileUp.h:108
std::unique_ptr< EventPrincipal > eventPrincipal_
Definition: PileUp.h:110
bool edm::PileUp::poisson ( ) const
inline

Definition at line 42 of file PileUp.h.

References poisson_.

42 {return poisson_;}
bool poisson_
Definition: PileUp.h:90
std::unique_ptr< CLHEP::RandPoisson > const & edm::PileUp::poissonDistr_OOT ( StreamID const &  streamID)
private

Definition at line 343 of file PileUp.cc.

References cmsHarvester::index, randomEngine(), edm::StreamID::value(), and vPoissonDistr_OOT_.

Referenced by CalculatePileup().

343  {
344  unsigned int index = streamID.value();
345  if(index >= vPoissonDistr_OOT_.size()) {
346  // This resizing is not thread safe and only works because
347  // this is used by a "one" type module
348  vPoissonDistr_OOT_.resize(index + 1);
349  }
350  std::unique_ptr<CLHEP::RandPoisson>& ptr = vPoissonDistr_OOT_[index];
351  if(!ptr) {
352  CLHEP::HepRandomEngine& engine = *randomEngine(streamID);
353  ptr.reset(new CLHEP::RandPoisson(engine));
354  }
355  return ptr;
356  }
CLHEP::HepRandomEngine * randomEngine(StreamID const &streamID)
Definition: PileUp.cc:358
std::vector< std::unique_ptr< CLHEP::RandPoisson > > vPoissonDistr_OOT_
Definition: PileUp.h:115
std::unique_ptr< CLHEP::RandPoissonQ > const & edm::PileUp::poissonDistribution ( StreamID const &  streamID)
private

Definition at line 328 of file PileUp.cc.

References averageNumber_, cmsHarvester::index, randomEngine(), edm::StreamID::value(), and vPoissonDistribution_.

Referenced by CalculatePileup().

328  {
329  unsigned int index = streamID.value();
330  if(index >= vPoissonDistribution_.size()) {
331  // This resizing is not thread safe and only works because
332  // this is used by a "one" type module
333  vPoissonDistribution_.resize(index + 1);
334  }
335  std::unique_ptr<CLHEP::RandPoissonQ>& ptr = vPoissonDistribution_[index];
336  if(!ptr) {
337  CLHEP::HepRandomEngine& engine = *randomEngine(streamID);
338  ptr.reset(new CLHEP::RandPoissonQ(engine, averageNumber_));
339  }
340  return ptr;
341  }
std::vector< std::unique_ptr< CLHEP::RandPoissonQ > > vPoissonDistribution_
Definition: PileUp.h:114
CLHEP::HepRandomEngine * randomEngine(StreamID const &streamID)
Definition: PileUp.cc:358
double averageNumber_
Definition: PileUp.h:85
CLHEP::HepRandomEngine * edm::PileUp::randomEngine ( StreamID const &  streamID)
private

Definition at line 358 of file PileUp.cc.

References cmsHarvester::index, randomEngines_, and edm::StreamID::value().

Referenced by poissonDistr_OOT(), poissonDistribution(), and readPileUp().

358  {
359  unsigned int index = streamID.value();
360  if(index >= randomEngines_.size()) {
361  // This resizing is not thread safe and only works because
362  // this is used by a "one" type module
363  randomEngines_.resize(index + 1, nullptr);
364  }
365  CLHEP::HepRandomEngine* ptr = randomEngines_[index];
366  if(!ptr) {
368  ptr = &rng->getEngine(streamID);
369  randomEngines_[index] = ptr;
370  }
371  return ptr;
372  }
std::vector< CLHEP::HepRandomEngine * > randomEngines_
Definition: PileUp.h:116
template<typename T >
void edm::PileUp::readPileUp ( edm::EventID const &  signal,
std::vector< edm::EventID > &  ids,
T  eventOperator,
const int  pileEventCnt,
StreamID const &  streamID 
)

Generates events from a VectorInputSource. This function decides which method of VectorInputSource to call: sequential, random, or pre-specified. The ids are either ids to read or ids to store while reading. eventOperator has a type that matches the eventOperator in VectorInputSource::loopRandom.

The "signal" event is optionally used to restrict the secondary events used for pileup and mixing.

Definition at line 181 of file PileUp.h.

References eventPrincipal_, input_, fjr2json::lumi, edm::EventID::luminosityBlock(), randomEngine(), SiPixelLorentzAngle_cfi::read, edm::EventID::run(), samelumi_, and sequential_.

182  {
183 
184  // One reason PileUp is responsible for recording event IDs is
185  // that it is the one that knows how many events will be read.
186  ids.reserve(pileEventCnt);
187  RecordEventID<T> recorder(ids,eventOperator);
188  int read;
189  if (samelumi_) {
190  const edm::LuminosityBlockID lumi(signal.run(), signal.luminosityBlock());
191  if (sequential_)
192  read = input_->loopSequentialWithID(*eventPrincipal_, lumi, pileEventCnt, recorder);
193  else
194  read = input_->loopRandomWithID(*eventPrincipal_, lumi, pileEventCnt, recorder, randomEngine(streamID));
195  } else {
196  if (sequential_) {
197  read = input_->loopSequential(*eventPrincipal_, pileEventCnt, recorder);
198  } else {
199  read = input_->loopRandom(*eventPrincipal_, pileEventCnt, recorder, randomEngine(streamID));
200  }
201  }
202  if (read != pileEventCnt)
203  edm::LogWarning("PileUp") << "Could not read enough pileup events: only " << read << " out of " << pileEventCnt << " requested.";
204  }
tuple lumi
Definition: fjr2json.py:35
bool samelumi_
Definition: PileUp.h:129
std::unique_ptr< VectorInputSource > const input_
Definition: PileUp.h:108
bool sequential_
Definition: PileUp.h:126
CLHEP::HepRandomEngine * randomEngine(StreamID const &streamID)
Definition: PileUp.cc:358
std::unique_ptr< EventPrincipal > eventPrincipal_
Definition: PileUp.h:110
void edm::PileUp::reload ( const edm::EventSetup setup)

Definition at line 230 of file PileUp.cc.

References MixingInputConfig::averageNumber(), averageNumber(), averageNumber_, HDQMDatabaseProducer::config, alignCSCRings::e, edm::hlt::Exception, fixed_, fixed_OOT_, MixingInputConfig::fixedOutOfTime(), edm::EventSetup::get(), histo_, histoDistribution_, i, inputType_, intFixed_OOT_, j, LogDebug, manage_OOT_, none_, MixingInputConfig::outOfTime(), poisson_, poisson_OOT_, probFunctionDistribution_, MixingInputConfig::probFunctionVariable(), MixingInputConfig::probValue(), MixingInputConfig::type(), type_, vPoissonDistribution_, SiStripMonitorClusterAlca_cfi::xmax, and SiStripMonitorClusterAlca_cfi::xmin.

230  {
231  //get the required parameters from DB.
233  setup.get<MixingRcd>().get(configM);
234 
235  const MixingInputConfig & config=configM->config(inputType_);
236 
237  //get the type
238  type_=config.type();
239  //set booleans
240  histoDistribution_=type_ == "histo";
241  probFunctionDistribution_=type_ == "probFunction";
242  poisson_=type_ == "poisson";
243  fixed_=type_ == "fixed";
244  none_=type_ == "none";
245 
246  if (histoDistribution_) edm::LogError("MisConfiguration")<<"type histo cannot be reloaded from DB, yet";
247 
248  if (fixed_){
250  }
251  else if (poisson_)
252  {
253  averageNumber_=config.averageNumber();
254  for(auto & distribution : vPoissonDistribution_) {
255  if(distribution) {
256  distribution.reset(new CLHEP::RandPoissonQ(distribution->engine(), averageNumber_));
257  }
258  }
259  }
260  else if (probFunctionDistribution_)
261  {
262  //need to reload the histogram from DB
263  const std::vector<int> & dataProbFunctionVar = config.probFunctionVariable();
264  std::vector<double> dataProb = config.probValue();
265 
266  int varSize = (int) dataProbFunctionVar.size();
267  int probSize = (int) dataProb.size();
268 
269  if ((dataProbFunctionVar[0] != 0) || (dataProbFunctionVar[varSize - 1] != (varSize - 1)))
270  throw cms::Exception("BadProbFunction") << "Please, check the variables of the probability function! The first variable should be 0 and the difference between two variables should be 1." << std::endl;
271 
272  // Complete the vector containing the probability function data
273  // with the values "0"
274  if (probSize < varSize){
275  edm::LogWarning("MixingModule") << " The probability function data will be completed with " <<(varSize - probSize) <<" values 0.";
276 
277  for (int i=0; i<(varSize - probSize); i++) dataProb.push_back(0);
278 
279  probSize = dataProb.size();
280  edm::LogInfo("MixingModule") << " The number of the P(x) data set after adding the values 0 is " << probSize;
281  }
282 
283  // Create an histogram with the data from the probability function provided by the user
284  int xmin = (int) dataProbFunctionVar[0];
285  int xmax = (int) dataProbFunctionVar[varSize-1]+1; // need upper edge to be one beyond last value
286  int numBins = varSize;
287 
288  edm::LogInfo("MixingModule") << "An histogram will be created with " << numBins << " bins in the range ("<< xmin << "," << xmax << ")." << std::endl;
289 
290  if (histo_) delete histo_;
291  histo_ = new TH1F("h","Histo from the user's probability function",numBins,xmin,xmax);
292 
293  LogDebug("MixingModule") << "Filling histogram with the following data:" << std::endl;
294 
295  for (int j=0; j < numBins ; j++){
296  LogDebug("MixingModule") << " x = " << dataProbFunctionVar[j ]<< " P(x) = " << dataProb[j];
297  histo_->Fill(dataProbFunctionVar[j]+0.5,dataProb[j]); // assuming integer values for the bins, fill bin centers, not edges
298  }
299 
300  // Check if the histogram is normalized
301  if ( ((histo_->Integral() - 1) > 1.0e-02) && ((histo_->Integral() - 1) < -1.0e-02)){
302  throw cms::Exception("BadProbFunction") << "The probability function should be normalized!!! " << std::endl;
303  }
304  averageNumber_=histo_->GetMean();
305  }
306 
307  int oot=config.outOfTime();
308  manage_OOT_=false;
309  if (oot==1)
310  {
311  manage_OOT_=true;
312  poisson_OOT_ = false;
313  fixed_OOT_ = true;
314  intFixed_OOT_=config.fixedOutOfTime();
315  }
316  else if (oot==2)
317  {
318  manage_OOT_=true;
319  poisson_OOT_ = true;
320  fixed_OOT_ = false;
321  }
322 
323 
324  }
#define LogDebug(id)
bool manage_OOT_
Definition: PileUp.h:93
int i
Definition: DBlmapReader.cc:9
unsigned int inputType_
Definition: PileUp.h:82
const int fixedOutOfTime() const
TH1F * histo_
Definition: PileUp.h:87
bool fixed_
Definition: PileUp.h:91
const std::vector< double > & probValue() const
const double averageNumber() const
bool probFunctionDistribution_
Definition: PileUp.h:89
bool histoDistribution_
Definition: PileUp.h:88
bool poisson_
Definition: PileUp.h:90
double averageNumber() const
Definition: PileUp.h:41
const int outOfTime() const
std::vector< std::unique_ptr< CLHEP::RandPoissonQ > > vPoissonDistribution_
Definition: PileUp.h:114
bool poisson_OOT_
Definition: PileUp.h:94
int j
Definition: DBlmapReader.cc:9
bool fixed_OOT_
Definition: PileUp.h:95
std::string type_
Definition: PileUp.h:83
const T & get() const
Definition: EventSetup.h:55
const std::vector< int > & probFunctionVariable() const
bool none_
Definition: PileUp.h:92
int intFixed_OOT_
Definition: PileUp.h:101
std::string type() const
double averageNumber_
Definition: PileUp.h:85
void edm::PileUp::setupPileUpEvent ( const edm::EventSetup setup)

Definition at line 221 of file PileUp.cc.

References eventPrincipal_, lumiPrincipal_, and provider_.

221  {
222  if (provider_.get() != nullptr) {
223  // note: run and lumi numbers must be modified to match lumiPrincipal_
224  eventPrincipal_->setLuminosityBlockPrincipal(lumiPrincipal_);
225  eventPrincipal_->setRunAndLumiNumber(lumiPrincipal_->run(), lumiPrincipal_->luminosityBlock());
226  provider_->setupPileUpEvent(*eventPrincipal_, setup);
227  }
228  }
std::unique_ptr< SecondaryEventProvider > provider_
Definition: PileUp.h:113
std::shared_ptr< LuminosityBlockPrincipal > lumiPrincipal_
Definition: PileUp.h:111
std::unique_ptr< EventPrincipal > eventPrincipal_
Definition: PileUp.h:110

Member Data Documentation

double edm::PileUp::averageNumber_
private

Definition at line 85 of file PileUp.h.

Referenced by averageNumber(), CalculatePileup(), doPileUp(), poissonDistribution(), and reload().

std::unique_ptr<EventPrincipal> edm::PileUp::eventPrincipal_
private

Definition at line 110 of file PileUp.h.

Referenced by PileUp(), playPileUp(), readPileUp(), and setupPileUpEvent().

bool edm::PileUp::fixed_
private

Definition at line 91 of file PileUp.h.

Referenced by CalculatePileup(), PileUp(), and reload().

bool edm::PileUp::fixed_OOT_
private

Definition at line 95 of file PileUp.h.

Referenced by PileUp(), and reload().

TH1F* edm::PileUp::h1f
private

Definition at line 118 of file PileUp.h.

TH1F* edm::PileUp::histo_
private

Definition at line 87 of file PileUp.h.

Referenced by CalculatePileup(), and reload().

bool edm::PileUp::histoDistribution_
private

Definition at line 88 of file PileUp.h.

Referenced by CalculatePileup(), PileUp(), and reload().

TH1F* edm::PileUp::hprobFunction
private

Definition at line 119 of file PileUp.h.

std::unique_ptr<VectorInputSource> const edm::PileUp::input_
private

Definition at line 108 of file PileUp.h.

Referenced by beginJob(), dropUnwantedBranches(), endJob(), PileUp(), playPileUp(), and readPileUp().

unsigned int edm::PileUp::inputType_
private

Definition at line 82 of file PileUp.h.

Referenced by input(), and reload().

int const edm::PileUp::intAverage_
private

Definition at line 86 of file PileUp.h.

Referenced by CalculatePileup().

int edm::PileUp::intFixed_ITPU_
private

Definition at line 102 of file PileUp.h.

Referenced by CalculatePileup(), and PileUp().

int edm::PileUp::intFixed_OOT_
private

Definition at line 101 of file PileUp.h.

Referenced by CalculatePileup(), PileUp(), and reload().

std::shared_ptr<LuminosityBlockPrincipal> edm::PileUp::lumiPrincipal_
private

Definition at line 111 of file PileUp.h.

Referenced by beginLuminosityBlock(), endLuminosityBlock(), and setupPileUpEvent().

bool edm::PileUp::manage_OOT_
private

Definition at line 93 of file PileUp.h.

Referenced by CalculatePileup(), PileUp(), and reload().

int edm::PileUp::maxBunch_cosmics_
private

Definition at line 105 of file PileUp.h.

Referenced by doPileUp(), and PileUp().

int edm::PileUp::minBunch_cosmics_
private

Definition at line 104 of file PileUp.h.

Referenced by doPileUp(), and PileUp().

bool edm::PileUp::none_
private

Definition at line 92 of file PileUp.h.

Referenced by CalculatePileup(), doPileUp(), PileUp(), and reload().

bool edm::PileUp::playback_
private

Definition at line 123 of file PileUp.h.

bool edm::PileUp::poisson_
private

Definition at line 90 of file PileUp.h.

Referenced by CalculatePileup(), PileUp(), poisson(), and reload().

bool edm::PileUp::poisson_OOT_
private

Definition at line 94 of file PileUp.h.

Referenced by CalculatePileup(), PileUp(), and reload().

TFile* edm::PileUp::probFileHisto
private

Definition at line 120 of file PileUp.h.

bool edm::PileUp::probFunctionDistribution_
private

Definition at line 89 of file PileUp.h.

Referenced by CalculatePileup(), PileUp(), and reload().

std::shared_ptr<ProcessConfiguration> edm::PileUp::processConfiguration_
private

Definition at line 109 of file PileUp.h.

Referenced by beginLuminosityBlock(), beginRun(), and PileUp().

std::shared_ptr<ProductRegistry> edm::PileUp::productRegistry_
private

Definition at line 107 of file PileUp.h.

Referenced by beginJob(), beginLuminosityBlock(), beginRun(), and PileUp().

std::unique_ptr<SecondaryEventProvider> edm::PileUp::provider_
private
bool edm::PileUp::PU_Study_
private

Definition at line 97 of file PileUp.h.

Referenced by CalculatePileup(), and PileUp().

std::vector<CLHEP::HepRandomEngine*> edm::PileUp::randomEngines_
private

Definition at line 116 of file PileUp.h.

Referenced by randomEngine().

std::shared_ptr<RunPrincipal> edm::PileUp::runPrincipal_
private

Definition at line 112 of file PileUp.h.

Referenced by beginLuminosityBlock(), beginRun(), and endRun().

bool edm::PileUp::samelumi_
private

Definition at line 129 of file PileUp.h.

Referenced by readPileUp().

int edm::PileUp::seed_
private

Definition at line 132 of file PileUp.h.

Referenced by PileUp().

bool edm::PileUp::sequential_
private

Definition at line 126 of file PileUp.h.

Referenced by readPileUp().

std::string edm::PileUp::Source_type_
private

Definition at line 84 of file PileUp.h.

Referenced by doPileUp(), and PileUp().

std::string edm::PileUp::Study_type_
private

Definition at line 98 of file PileUp.h.

Referenced by CalculatePileup(), and PileUp().

std::string edm::PileUp::type_
private
std::vector<std::unique_ptr<CLHEP::RandPoisson> > edm::PileUp::vPoissonDistr_OOT_
private

Definition at line 115 of file PileUp.h.

Referenced by poissonDistr_OOT().

std::vector<std::unique_ptr<CLHEP::RandPoissonQ> > edm::PileUp::vPoissonDistribution_
private

Definition at line 114 of file PileUp.h.

Referenced by poissonDistribution(), and reload().