CMS 3D CMS Logo

List of all members | Public Member Functions | Protected Attributes | Private Attributes
gen::Py8InterfaceBase Class Referenceabstract

#include <Py8InterfaceBase.h>

Inheritance diagram for gen::Py8InterfaceBase:
gen::BaseHadronizer gen::Py8GunBase Pythia8Hadronizer gen::Py8EGun gen::Py8JetGun gen::Py8MassGun gen::Py8PtAndDxyGun gen::Py8PtAndLxyGun gen::Py8PtExpGun gen::Py8PtGun gen::Py8PtotGun

Public Member Functions

virtual const char * classname () const =0
 
bool decay ()
 
bool declareSpecialSettings (const std::vector< std::string > &)
 
bool declareStableParticles (const std::vector< int > &)
 
virtual void finalizeEvent ()=0
 
virtual bool generatePartonsAndHadronize ()=0
 
virtual bool initializeForInternalPartons ()=0
 
void makeTmpSLHA (const std::string &)
 
void p8SetRandomEngine (CLHEP::HepRandomEngine *v)
 
 Py8InterfaceBase (edm::ParameterSet const &ps)
 
P8RndmEnginerandomEngine ()
 
bool readSettings (int)
 
virtual void statistics ()
 
 ~Py8InterfaceBase () override
 
- Public Member Functions inherited from gen::BaseHadronizer
 BaseHadronizer (edm::ParameterSet const &ps)
 
void cleanLHE ()
 
void generateLHE (edm::LuminosityBlock const &lumi, CLHEP::HepRandomEngine *rengine, unsigned int ncpu)
 
edm::EventgetEDMEvent () const
 
std::unique_ptr< HepMC::GenEventgetGenEvent ()
 
std::unique_ptr< HepMC3::GenEvent > getGenEvent3 ()
 
std::unique_ptr< GenEventInfoProductgetGenEventInfo ()
 
std::unique_ptr< GenEventInfoProduct3getGenEventInfo3 ()
 
virtual std::unique_ptr< GenLumiInfoHeadergetGenLumiInfoHeader () const
 
GenRunInfoProductgetGenRunInfo ()
 
std::unique_ptr< lhef::LHEEventgetLHEEvent ()
 
const std::shared_ptr< lhef::LHERunInfo > & getLHERunInfo () const
 
unsigned int getVHepMC ()
 
const std::string & gridpackPath () const
 
int randomIndex () const
 
const std::string & randomInitConfigDescription () const
 
void randomizeIndex (edm::LuminosityBlock const &lumi, CLHEP::HepRandomEngine *rengine)
 
void resetEvent (std::unique_ptr< HepMC::GenEvent > event)
 
void resetEvent3 (std::unique_ptr< HepMC3::GenEvent > event3)
 
void resetEventInfo (std::unique_ptr< GenEventInfoProduct > eventInfo)
 
void resetEventInfo3 (std::unique_ptr< GenEventInfoProduct3 > eventInfo)
 
virtual bool select (HepMC::GenEvent *) const
 
void setEDMEvent (edm::Event &event)
 
void setLHEEvent (std::unique_ptr< lhef::LHEEvent > event)
 
void setLHERunInfo (std::unique_ptr< lhef::LHERunInfo > runInfo)
 
void setRandomEngine (CLHEP::HepRandomEngine *v)
 
std::vector< std::string > const & sharedResources () const
 
virtual ~BaseHadronizer () noexcept(false)
 

Protected Attributes

HepMC::IO_AsciiParticles * ascii_io
 
std::shared_ptr< Pythia8::EvtGenDecays > evtgenDecays
 
std::string evtgenDecFile
 
std::string evtgenPdlFile
 
std::vector< std::string > evtgenUserFiles
 
std::unique_ptr< Pythia8::Pythia > fDecayer
 
std::unique_ptr< Pythia8::Pythia > fMasterGen
 
edm::ParameterSet fParameters
 
unsigned int maxEventsToPrint
 
bool pythiaHepMCVerbosity
 
bool pythiaHepMCVerbosityParticles
 
unsigned int pythiaPylistVerbosity
 
std::string slhafile_
 
HepMC::Pythia8ToHepMC toHepMC
 
bool useEvtGen
 
- Protected Attributes inherited from gen::BaseHadronizer
unsigned int ivhepmc = 2
 
std::string lheFile_
 
int randomIndex_
 

Private Attributes

std::shared_ptr< P8RndmEnginep8RndmEngine_
 

Additional Inherited Members

- Protected Member Functions inherited from gen::BaseHadronizer
std::unique_ptr< HepMC::GenEvent > & event ()
 
std::unique_ptr< HepMC3::GenEvent > & event3 ()
 
std::unique_ptr< GenEventInfoProduct > & eventInfo ()
 
std::unique_ptr< GenEventInfoProduct3 > & eventInfo3 ()
 
lhef::LHEEventlheEvent ()
 
lhef::LHERunInfolheRunInfo ()
 
GenRunInfoProductrunInfo ()
 

Detailed Description

Definition at line 27 of file Py8InterfaceBase.h.

Constructor & Destructor Documentation

◆ Py8InterfaceBase()

gen::Py8InterfaceBase::Py8InterfaceBase ( edm::ParameterSet const &  ps)

Definition at line 19 of file Py8InterfaceBase.cc.

References ascii_io, web.browse_db::env, evtgenDecFile, evtgenPdlFile, evtgenUserFiles, Exception, edm::ParameterSet::exists(), ztee::fd, fParameters, edm::FileInPath::fullPath(), edm::ParameterSet::getParameter(), edm::ParameterSet::getUntrackedParameter(), mps_fire::i, maxEventsToPrint, MillePedeFileConverter_cfg::out, p8RndmEngine_, pythiaHepMCVerbosity, pythiaHepMCVerbosityParticles, pythiaPylistVerbosity, AlCaHLTBitMon_QueryRunRegistry::string, useEvtGen, and writeEcalDQMStatus::write.

20  : BaseHadronizer(ps), useEvtGen(false), evtgenDecays(nullptr) {
21  fParameters = ps;
22 
23  pythiaPylistVerbosity = ps.getUntrackedParameter<int>("pythiaPylistVerbosity", 0);
24  pythiaHepMCVerbosity = ps.getUntrackedParameter<bool>("pythiaHepMCVerbosity", false);
25  pythiaHepMCVerbosityParticles = ps.getUntrackedParameter<bool>("pythiaHepMCVerbosityParticles", false);
26  maxEventsToPrint = ps.getUntrackedParameter<int>("maxEventsToPrint", 0);
27  p8RndmEngine_ = std::make_shared<P8RndmEngine>();
28 
30  ascii_io = new HepMC::IO_AsciiParticles("cout", std::ios::out);
31 
32  if (ps.exists("useEvtGenPlugin")) {
33  useEvtGen = true;
34  auto env = std::getenv("EVTGENDATA");
35  if (not env) {
36  throw cms::Exception("EvtGenMissingEnv") << "The environment variable EVTGENDATA must be defined";
37  }
38  string evtgenpath(env);
39  evtgenDecFile = evtgenpath + string("/DECAY_2010.DEC");
40  evtgenPdlFile = evtgenpath + string("/evt.pdl");
41 
42  if (ps.exists("evtgenDecFile")) {
43  edm::FileInPath decay_table(ps.getParameter<std::string>("evtgenDecFile"));
44  evtgenDecFile = decay_table.fullPath();
45  }
46 
47  if (ps.exists("evtgenPdlFile")) {
48  edm::FileInPath pdt(ps.getParameter<std::string>("evtgenPdlFile"));
49  evtgenPdlFile = pdt.fullPath();
50  }
51 
52  if (ps.exists("evtgenUserFile")) {
53  std::vector<std::string> user_decays = ps.getParameter<std::vector<std::string> >("evtgenUserFile");
54  for (unsigned int i = 0; i < user_decays.size(); i++) {
55  edm::FileInPath user_decay(user_decays.at(i));
56  evtgenUserFiles.push_back(user_decay.fullPath());
57  }
58  //evtgenUserFiles = ps.getParameter< std::vector<std::string> >("evtgenUserFile");
59  }
60 
61  if (ps.exists("evtgenUserFileEmbedded")) {
62  std::vector<std::string> user_decay_lines =
63  ps.getParameter<std::vector<std::string> >("evtgenUserFileEmbedded");
64  char tempslhaname[] = "pythia8evtgenXXXXXX";
65  int fd = mkstemp(tempslhaname);
66 
67  for (unsigned int i = 0; i < user_decay_lines.size(); i++) {
68  user_decay_lines.at(i) += "\n";
69  write(fd, user_decay_lines.at(i).c_str(), user_decay_lines.at(i).size());
70  }
71  close(fd);
72  evtgenUserFiles.push_back(std::string(tempslhaname));
73  }
74  }
75  }
std::shared_ptr< P8RndmEngine > p8RndmEngine_
std::shared_ptr< Pythia8::EvtGenDecays > evtgenDecays
HepMC::IO_AsciiParticles * ascii_io
BaseHadronizer(edm::ParameterSet const &ps)
std::vector< std::string > evtgenUserFiles
unsigned int pythiaPylistVerbosity
unsigned int maxEventsToPrint
edm::ParameterSet fParameters
fd
Definition: ztee.py:136

◆ ~Py8InterfaceBase()

gen::Py8InterfaceBase::~Py8InterfaceBase ( )
inlineoverride

Definition at line 30 of file Py8InterfaceBase.h.

30 {}

Member Function Documentation

◆ classname()

virtual const char* gen::Py8InterfaceBase::classname ( ) const
pure virtual

◆ decay()

bool gen::Py8InterfaceBase::decay ( )
inline

Definition at line 33 of file Py8InterfaceBase.h.

33 { return true; } // NOT used - let's call it "design imperfection"

◆ declareSpecialSettings()

bool gen::Py8InterfaceBase::declareSpecialSettings ( const std::vector< std::string > &  settings)

Definition at line 224 of file Py8InterfaceBase.cc.

References fDecayer, spr::find(), fMasterGen, and AlCaHLTBitMon_QueryRunRegistry::string.

224  {
225  for (unsigned int iss = 0; iss < settings.size(); iss++) {
226  if (settings[iss].find("QED-brem-off") != std::string::npos) {
227  fMasterGen->readString("TimeShower:QEDshowerByL=off");
228  } else {
229  size_t fnd1 = settings[iss].find("Pythia8:");
230  if (fnd1 != std::string::npos) {
231  std::string value = settings[iss].substr(fnd1 + 8);
232  fDecayer->readString(value);
233  }
234  }
235  }
236  return true;
237  }
std::unique_ptr< Pythia8::Pythia > fDecayer
void find(edm::Handle< EcalRecHitCollection > &hits, DetId thisDet, std::vector< EcalRecHitCollection::const_iterator > &hit, bool debug=false)
Definition: FindCaloHit.cc:19
Definition: value.py:1
std::unique_ptr< Pythia8::Pythia > fMasterGen

◆ declareStableParticles()

bool gen::Py8InterfaceBase::declareStableParticles ( const std::vector< int > &  pdgIds)

Definition at line 197 of file Py8InterfaceBase.cc.

References fMasterGen, mps_fire::i, and CosmicGenFilterHelix_cfi::pdgIds.

197  {
198  for (size_t i = 0; i < pdgIds.size(); i++) {
199  // FIXME: need to double check if PID's are the same in Py6 & Py8,
200  // because the HepPDT translation tool is actually for **Py6**
201  //
202  // well, actually it looks like Py8 operates in PDT id's rather than Py6's
203  //
204  // int PyID = HepPID::translatePDTtoPythia( pdgIds[i] );
205  int PyID = pdgIds[i];
206  std::ostringstream pyCard;
207  pyCard << PyID << ":mayDecay=false";
208 
209  if (fMasterGen->particleData.isParticle(PyID)) {
210  fMasterGen->readString(pyCard.str());
211  } else {
212  edm::LogWarning("DataNotUnderstood") << "Pythia8 does not "
213  << "recognize particle id = " << PyID << std::endl;
214  }
215  // alternative:
216  // set the 2nd input argument warn=false
217  // - this way Py8 will NOT print warnings about unknown particle code(s)
218  // fMasterPtr->readString( pyCard.str(), false )
219  }
220 
221  return true;
222  }
std::unique_ptr< Pythia8::Pythia > fMasterGen
Log< level::Warning, false > LogWarning

◆ finalizeEvent()

virtual void gen::Py8InterfaceBase::finalizeEvent ( )
pure virtual

Implemented in Pythia8Hadronizer, and gen::Py8GunBase.

◆ generatePartonsAndHadronize()

virtual bool gen::Py8InterfaceBase::generatePartonsAndHadronize ( )
pure virtual

◆ initializeForInternalPartons()

virtual bool gen::Py8InterfaceBase::initializeForInternalPartons ( )
pure virtual

Implemented in Pythia8Hadronizer, and gen::Py8GunBase.

◆ makeTmpSLHA()

void gen::Py8InterfaceBase::makeTmpSLHA ( const std::string &  slhatable)

Definition at line 185 of file Py8InterfaceBase.cc.

References ztee::fd, fMasterGen, slhafile_, and writeEcalDQMStatus::write.

Referenced by readSettings().

185  {
186  char tempslhaname[] = "pythia8SLHAtableXXXXXX";
187  int fd = mkstemp(tempslhaname);
188  write(fd, slhatable.c_str(), slhatable.size());
189  close(fd);
190 
191  slhafile_ = tempslhaname;
192 
193  fMasterGen->settings.mode("SLHA:readFrom", 2);
194  fMasterGen->settings.word("SLHA:file", slhafile_);
195  }
std::unique_ptr< Pythia8::Pythia > fMasterGen
fd
Definition: ztee.py:136

◆ p8SetRandomEngine()

void gen::Py8InterfaceBase::p8SetRandomEngine ( CLHEP::HepRandomEngine *  v)
inline

Definition at line 43 of file Py8InterfaceBase.h.

References p8RndmEngine_, and gen::v.

Referenced by gen::Py8GunBase::setRandomEngine().

43 { p8RndmEngine_->setRandomEngine(v); }
std::shared_ptr< P8RndmEngine > p8RndmEngine_
double v[5][pyjets_maxn]

◆ randomEngine()

P8RndmEngine& gen::Py8InterfaceBase::randomEngine ( )
inline

◆ readSettings()

bool gen::Py8InterfaceBase::readSettings ( int  )

Definition at line 77 of file Py8InterfaceBase.cc.

References gen::ParameterCollector::begin(), gen::ParameterCollector::end(), edm::ParameterSet::exists(), validate-o2o-wbm::f1, fDecayer, fMasterGen, fParameters, get, edm::ParameterSet::getParameter(), edm::ParameterSet::getUntrackedParameter(), mps_splice::line, makeTmpSLHA(), p8RndmEngine_, plotBeamSpotDB::printBanner, gen::BaseHadronizer::randomIndex(), SQLiteCheck_cfg::reader, slhafile_, and AlCaHLTBitMon_QueryRunRegistry::string.

77  {
78  //Pythia 8's default value for first argument to constructor
79  const string xmlDir = "../share/Pythia8/xmldoc";
80  bool printBanner = true;
81  if (fParameters.exists("printBanner")) {
82  printBanner = fParameters.getUntrackedParameter<bool>("printBanner");
83  }
84  if (!fMasterGen.get())
85  fMasterGen = std::make_unique<Pythia>(xmlDir, printBanner);
86  fDecayer = std::make_unique<Pythia>(xmlDir, printBanner);
87 
88  //add settings for resonance decay filter
89  fMasterGen->settings.addFlag("BiasedTauDecayer:filter", false);
90  fMasterGen->settings.addFlag("BiasedTauDecayer:eDecays", true);
91  fMasterGen->settings.addFlag("BiasedTauDecayer:muDecays", true);
92 
93  //add settings for resonance decay filter
94  fMasterGen->settings.addFlag("ResonanceDecayFilter:filter", false);
95  fMasterGen->settings.addFlag("ResonanceDecayFilter:exclusive", false);
96  fMasterGen->settings.addFlag("ResonanceDecayFilter:eMuAsEquivalent", false);
97  fMasterGen->settings.addFlag("ResonanceDecayFilter:eMuTauAsEquivalent", false);
98  fMasterGen->settings.addFlag("ResonanceDecayFilter:allNuAsEquivalent", false);
99  fMasterGen->settings.addFlag("ResonanceDecayFilter:udscAsEquivalent", false);
100  fMasterGen->settings.addFlag("ResonanceDecayFilter:udscbAsEquivalent", false);
101  fMasterGen->settings.addFlag("ResonanceDecayFilter:wzAsEquivalent", false);
102  fMasterGen->settings.addMVec("ResonanceDecayFilter:mothers", std::vector<int>(), false, false, 0, 0);
103  fMasterGen->settings.addMVec("ResonanceDecayFilter:daughters", std::vector<int>(), false, false, 0, 0);
104 
105  //add settings for PT filter
106  fMasterGen->settings.addFlag("PTFilter:filter", false);
107  fMasterGen->settings.addMode("PTFilter:quarkToFilter", 5, true, true, 3, 6);
108  fMasterGen->settings.addParm("PTFilter:scaleToFilter", 0.4, true, true, 0.0, 10.);
109  fMasterGen->settings.addParm("PTFilter:quarkRapidity", 10.0, true, true, 0.0, 10.);
110  fMasterGen->settings.addParm("PTFilter:quarkPt", -.1, true, true, -.1, 100.);
111 
112  //add settings for RecoilToTop tool
113  fMasterGen->settings.addFlag("TopRecoilHook:doTopRecoilIn", false);
114  fMasterGen->settings.addFlag("TopRecoilHook:useOldDipoleIn", false);
115  fMasterGen->settings.addFlag("TopRecoilHook:doListIn", false);
116 
117  //add settings for powheg resonance scale calculation
118  fMasterGen->settings.addFlag("POWHEGres:calcScales", false);
119  fMasterGen->settings.addFlag("POWHEG:bb4l", false);
120  fMasterGen->settings.addFlag("POWHEG:bb4l:FSREmission:veto", false);
121  fMasterGen->settings.addFlag("POWHEG:bb4l:FSREmission:vetoQED", false);
122  fMasterGen->settings.addFlag("POWHEG:bb4l:DEBUG", false);
123  fMasterGen->settings.addFlag("POWHEG:bb4l:ScaleResonance:veto", false);
124  fMasterGen->settings.addFlag("POWHEG:bb4l:FSREmission:vetoDipoleFrame", false);
125  fMasterGen->settings.addFlag("POWHEG:bb4l:FSREmission:pTpythiaVeto", false);
126  fMasterGen->settings.addParm("POWHEG:bb4l:pTminVeto", 10.0, true, true, 0.0, 10.);
127  fMasterGen->settings.addFlag("POWHEG:bb4l:vetoAllRadtypes", false);
128 
129  fMasterGen->setRndmEnginePtr(p8RndmEngine_);
130  fDecayer->setRndmEnginePtr(p8RndmEngine_);
131 
132  fMasterGen->readString("Next:numberShowEvent = 0");
133  fDecayer->readString("Next:numberShowEvent = 0");
134 
135  edm::ParameterSet currentParameters;
136  if (randomIndex() >= 0) {
137  std::vector<edm::ParameterSet> randomizedParameters =
138  fParameters.getParameter<std::vector<edm::ParameterSet> >("RandomizedParameters");
139  currentParameters = randomizedParameters[randomIndex()];
140  } else {
141  currentParameters = fParameters;
142  }
143 
144  ParameterCollector pCollector = currentParameters.getParameter<edm::ParameterSet>("PythiaParameters");
145 
146  for (ParameterCollector::const_iterator line = pCollector.begin(); line != pCollector.end(); ++line) {
147  if (line->find("Random:") != std::string::npos)
148  throw cms::Exception("PythiaError") << "Attempted to set random number "
149  "using Pythia commands. Please use "
150  "the RandomNumberGeneratorService."
151  << std::endl;
152 
153  if (!fMasterGen->readString(*line))
154  throw cms::Exception("PythiaError") << "Pythia 8 did not accept \"" << *line << "\"." << std::endl;
155 
156  if (line->find("ParticleDecays:") != std::string::npos) {
157  if (!fDecayer->readString(*line))
158  throw cms::Exception("PythiaError") << "Pythia 8 Decayer did not accept \"" << *line << "\"." << std::endl;
159  }
160  }
161 
162  slhafile_.clear();
163 
164  if (currentParameters.exists("SLHAFileForPythia8")) {
165  std::string slhafilenameshort = currentParameters.getParameter<std::string>("SLHAFileForPythia8");
166  edm::FileInPath f1(slhafilenameshort);
167 
168  fMasterGen->settings.mode("SLHA:readFrom", 2);
169  fMasterGen->settings.word("SLHA:file", f1.fullPath());
170  } else if (currentParameters.exists("SLHATableForPythia8")) {
171  std::string slhatable = currentParameters.getParameter<std::string>("SLHATableForPythia8");
172 
173  makeTmpSLHA(slhatable);
174  } else if (currentParameters.exists("SLHATreeForPythia8")) {
175  auto slhaReaderParams = currentParameters.getParameter<edm::ParameterSet>("SLHATreeForPythia8");
176  std::unique_ptr<SLHAReaderBase> reader =
177  SLHAReaderFactory::get()->create(slhaReaderParams.getParameter<std::string>("name"), slhaReaderParams);
178 
179  makeTmpSLHA(reader->getSLHA(currentParameters.getParameter<std::string>("ConfigDescription")));
180  }
181 
182  return true;
183  }
T getParameter(std::string const &) const
Definition: ParameterSet.h:307
std::shared_ptr< P8RndmEngine > p8RndmEngine_
std::unique_ptr< Pythia8::Pythia > fDecayer
void makeTmpSLHA(const std::string &)
bool exists(std::string const &parameterName) const
checks if a parameter exists
T getUntrackedParameter(std::string const &, T const &) const
int randomIndex() const
std::unique_ptr< Pythia8::Pythia > fMasterGen
#define get
edm::ParameterSet fParameters

◆ statistics()

void gen::Py8InterfaceBase::statistics ( )
virtual

Reimplemented in Pythia8Hadronizer, and gen::Py8GunBase.

Definition at line 239 of file Py8InterfaceBase.cc.

References fMasterGen.

239  {
240  fMasterGen->stat();
241  return;
242  }
std::unique_ptr< Pythia8::Pythia > fMasterGen

Member Data Documentation

◆ ascii_io

HepMC::IO_AsciiParticles* gen::Py8InterfaceBase::ascii_io
protected

◆ evtgenDecays

std::shared_ptr<Pythia8::EvtGenDecays> gen::Py8InterfaceBase::evtgenDecays
protected

◆ evtgenDecFile

std::string gen::Py8InterfaceBase::evtgenDecFile
protected

◆ evtgenPdlFile

std::string gen::Py8InterfaceBase::evtgenPdlFile
protected

◆ evtgenUserFiles

std::vector<std::string> gen::Py8InterfaceBase::evtgenUserFiles
protected

◆ fDecayer

std::unique_ptr<Pythia8::Pythia> gen::Py8InterfaceBase::fDecayer
protected

◆ fMasterGen

std::unique_ptr<Pythia8::Pythia> gen::Py8InterfaceBase::fMasterGen
protected

◆ fParameters

edm::ParameterSet gen::Py8InterfaceBase::fParameters
protected

Definition at line 51 of file Py8InterfaceBase.h.

Referenced by Py8InterfaceBase(), and readSettings().

◆ maxEventsToPrint

unsigned int gen::Py8InterfaceBase::maxEventsToPrint
protected

◆ p8RndmEngine_

std::shared_ptr<P8RndmEngine> gen::Py8InterfaceBase::p8RndmEngine_
private

Definition at line 70 of file Py8InterfaceBase.h.

Referenced by p8SetRandomEngine(), Py8InterfaceBase(), randomEngine(), and readSettings().

◆ pythiaHepMCVerbosity

bool gen::Py8InterfaceBase::pythiaHepMCVerbosity
protected

◆ pythiaHepMCVerbosityParticles

bool gen::Py8InterfaceBase::pythiaHepMCVerbosityParticles
protected

◆ pythiaPylistVerbosity

unsigned int gen::Py8InterfaceBase::pythiaPylistVerbosity
protected

◆ slhafile_

std::string gen::Py8InterfaceBase::slhafile_
protected

◆ toHepMC

HepMC::Pythia8ToHepMC gen::Py8InterfaceBase::toHepMC
protected

◆ useEvtGen

bool gen::Py8InterfaceBase::useEvtGen
protected