Removed mGlobal* + created example for hybrid generator

Author: jackal1-66

Generators/include/Generators/GeneratorFromFile.h

@@ -102,8 +102,7 @@ class GeneratorFromO2Kine : public o2::eventgen::Generator
   unsigned int mRngSeed = 0;     //! randomizer seed, 0 for random value
   bool mRandomPhi = false;       //! whether we want to randomize the phi angle of the particles
   TGrid* mAlienInstance = nullptr; // a cached connection to TGrid (needed for Alien locations)
-  bool mGlobal = true;             // whether to use the global configuration
-  std::unique_ptr<O2KineGenConfig> mConfig; //! Local configuration of the generator
+  std::unique_ptr<O2KineGenConfig> mConfig; //! Configuration object
 
   std::unique_ptr<o2::dataformats::MCEventHeader> mOrigMCEventHeader; //! the MC event header of the original file
 

Generators/include/Generators/GeneratorPythia8.h

@@ -285,8 +285,7 @@ class GeneratorPythia8 : public Generator
   long mInitialRNGSeed = -1;   // initial seed for Pythia random number state;
                                // will be transported to Pythia in the Init function through the Pythia::readString("Random:seed") mechanism.
                                // Value of -1 means unitialized; 0 will be time-dependent and values >1 <= MAX_SEED concrete reproducible seeding
-  bool mGlobalParam = true;    // if true the use of the global parameters is foreseen, otherwise it means the parametric constructor has been called
-  std::unique_ptr<Pythia8GenConfig> mGenConfig; // local configuration
+  std::unique_ptr<Pythia8GenConfig> mGenConfig; // configuration object
 
   constexpr static long MAX_SEED = 900000000;
 

Generators/src/GeneratorFactory.cxx

@@ -69,7 +69,16 @@ void GeneratorFactory::setPrimaryGenerator(o2::conf::SimConfig const& conf, Fair
 
 #ifdef GENERATORS_WITH_PYTHIA8
   auto makePythia8Gen = [](std::string& config) {
-    auto gen = new o2::eventgen::GeneratorPythia8();
+    auto& singleton = GeneratorPythia8Param::Instance();
+    auto pars = o2::eventgen::Pythia8GenConfig {
+      .config = config.size() > 0 ? config : singleton.config,
+      .hooksFileName = singleton.hooksFileName,
+      .hooksFuncName = singleton.hooksFuncName,
+      .includePartonEvent = singleton.includePartonEvent,
+      .particleFilter = singleton.particleFilter,
+      .verbose = singleton.verbose,
+    };
+    auto gen = new o2::eventgen::GeneratorPythia8(pars);
     if (!config.empty()) {
       LOG(info) << "Setting \'Pythia8\' base configuration: " << config << std::endl;
       gen->setConfig(config); // assign config; will be executed in Init function
@@ -143,12 +152,22 @@ void GeneratorFactory::setPrimaryGenerator(o2::conf::SimConfig const& conf, Fair
     LOG(info) << "using external kinematics";
   } else if (genconfig.compare("extkinO2") == 0) {
     // external kinematics from previous O2 output
-    auto name1 = GeneratorFromO2KineParam::Instance().fileName;
+    auto& singleton = GeneratorFromO2KineParam::Instance();
+    auto name1 = singleton.fileName;
     auto name2 = conf.getExtKinematicsFileName();
-    auto extGen = new o2::eventgen::GeneratorFromO2Kine(name1.size() > 0 ? name1.c_str() : name2.c_str());
+    auto pars = O2KineGenConfig{
+      .skipNonTrackable = singleton.skipNonTrackable,
+      .continueMode = singleton.continueMode,
+      .roundRobin = singleton.roundRobin,
+      .randomize = singleton.randomize,
+      .rngseed = singleton.rngseed,
+      .randomphi = singleton.randomphi,
+      .fileName = name1.size() > 0 ? name1.c_str() : name2.c_str()
+    };
+    auto extGen = new o2::eventgen::GeneratorFromO2Kine(pars);
     extGen->SetStartEvent(conf.getStartEvent());
     primGen->AddGenerator(extGen);
-    if (GeneratorFromO2KineParam::Instance().continueMode) {
+    if (pars.continueMode) {
       auto o2PrimGen = dynamic_cast<o2::eventgen::PrimaryGenerator*>(primGen);
       if (o2PrimGen) {
         o2PrimGen->setApplyVertex(false);

Generators/src/GeneratorFromFile.cxx

@@ -209,7 +209,6 @@ GeneratorFromO2Kine::GeneratorFromO2Kine(const char* name)
 
 GeneratorFromO2Kine::GeneratorFromO2Kine(O2KineGenConfig const& pars) : GeneratorFromO2Kine(pars.fileName.c_str())
 {
-  mGlobal = false;
   mConfig = std::make_unique<O2KineGenConfig>(pars);
 }
 
@@ -218,24 +217,13 @@ bool GeneratorFromO2Kine::Init()
 
   // read and set params
 
-  if (mGlobal) {
-    auto& param = GeneratorFromO2KineParam::Instance();
-    LOG(info) << "Init \'FromO2Kine\' generator with following parameters";
-    LOG(info) << param;
-    mSkipNonTrackable = param.skipNonTrackable;
-    mContinueMode = param.continueMode;
-    mRoundRobin = param.roundRobin;
-    mRandomize = param.randomize;
-    mRngSeed = param.rngseed;
-    mRandomPhi = param.randomphi;
-  } else {
-    mSkipNonTrackable = mConfig->skipNonTrackable;
-    mContinueMode = mConfig->continueMode;
-    mRoundRobin = mConfig->roundRobin;
-    mRandomize = mConfig->randomize;
-    mRngSeed = mConfig->rngseed;
-    mRandomPhi = mConfig->randomphi;
-  }
+  LOG(info) << "Init \'FromO2Kine\' generator";
+  mSkipNonTrackable = mConfig->skipNonTrackable;
+  mContinueMode = mConfig->continueMode;
+  mRoundRobin = mConfig->roundRobin;
+  mRandomize = mConfig->randomize;
+  mRngSeed = mConfig->rngseed;
+  mRandomPhi = mConfig->randomphi;
   if (mRandomize) {
     gRandom->SetSeed(mRngSeed);
   }

Generators/src/GeneratorHybrid.cxx

@@ -62,7 +62,8 @@ GeneratorHybrid::GeneratorHybrid(const std::string& inputgens)
       } else if (gen.compare(0, 7, "pythia8") == 0) {
         // Check if mConfigs[index] contains pythia8_ and a number
         if (mConfigs[index].compare("") == 0) {
-          gens.push_back(std::make_unique<o2::eventgen::GeneratorPythia8>());
+          auto pars = Pythia8GenConfig();
+          gens.push_back(std::make_unique<o2::eventgen::GeneratorPythia8>(pars));
         } else {
           // Get the index of pythia8 configuration
           int confPythia8Index = std::stoi(mConfigs[index].substr(8));
@@ -137,16 +138,18 @@ Bool_t GeneratorHybrid::generateEvent()
     mIndex = gRandom->Integer(mGens.size());
   } else {
     while (mFractions[mCurrentFraction] == 0 || mseqCounter == mFractions[mCurrentFraction]) {
-      if (mFractions[mCurrentFraction] != 0)
+      if (mFractions[mCurrentFraction] != 0) {
         mseqCounter = 0;
+      }
       mCurrentFraction = (mCurrentFraction + 1) % mFractions.size();
     }
     mIndex = mCurrentFraction;
   }
-  if (mConfigs[mIndex].compare("") == 0)
+  if (mConfigs[mIndex].compare("") == 0) {
     LOG(info) << "GeneratorHybrid: generating event with generator " << mGens[mIndex];
-  else
+  } else {
     LOG(info) << "GeneratorHybrid: generating event with generator " << mConfigs[mIndex];
+  }
   gens[mIndex]->clearParticles(); // clear container of this class
   gens[mIndex]->generateEvent();
   // notify the sub event generator
@@ -246,8 +249,9 @@ Bool_t GeneratorHybrid::parseJSON(const std::string& path)
         if (name == "boxgen" || name == "pythia8" || name == "extkinO2" || name == "external" || name == "hepmc") {
           LOG(fatal) << "No configuration provided for generator " << name;
           return false;
-        } else
+        } else {
           mConfigs.push_back("");
+        }
       }
     }
   }

Generators/src/GeneratorPythia8.cxx

@@ -80,7 +80,6 @@ GeneratorPythia8::GeneratorPythia8(Pythia8GenConfig const& pars) : Generator("AL
   setConfig(pars.config);
   setHooksFileName(pars.hooksFileName);
   setHooksFuncName(pars.hooksFuncName);
-  mGlobalParam = false;
 }
 
 /*****************************************************************/
@@ -579,11 +578,7 @@ void GeneratorPythia8::pruneEvent(Pythia8::Event& event, Select select)
       }
     }
   }
-  int verbose;
-  if (mGlobalParam)
-    verbose = GeneratorPythia8Param::Instance().verbose;
-  else
-    verbose = mGenConfig->verbose;
+  int verbose = mGenConfig->verbose;
   if (verbose) {
     LOG(info) << "Pythia event was pruned from " << event.size()
               << " to " << pruned.size() << " particles";
@@ -597,11 +592,7 @@ void GeneratorPythia8::initUserFilterCallback()
 {
   mUserFilterFcn = [](Pythia8::Particle const&) -> bool { return true; };
 
-  std::string filter;
-  if (mGlobalParam)
-    filter = GeneratorPythia8Param::Instance().particleFilter;
-  else
-    filter = mGenConfig->particleFilter;
+  std::string filter = mGenConfig->particleFilter;
   if (filter.size() > 0) {
     LOG(info) << "Initializing the callback for user-based particle pruning " << filter;
     auto expandedFileName = o2::utils::expandShellVarsInFileName(filter);
@@ -630,11 +621,7 @@ Bool_t
   // event record in the AOD.
 
   std::function<bool(const Pythia8::Particle&)> partonSelect = [](const Pythia8::Particle&) { return true; };
-  bool includeParton;
-  if (mGlobalParam)
-    includeParton = GeneratorPythia8Param::Instance().includePartonEvent;
-  else
-    includeParton = mGenConfig->includePartonEvent;
+  bool includeParton = mGenConfig->includePartonEvent;
   if (not includeParton) {
 
     // Select pythia particles

run/SimExamples/Hybrid/README.md

@@ -0,0 +1,18 @@
+<!-- doxy
+\page refrunSimExamplesHybrid Example Hybrid
+/doxy -->
+
+The usage of the Hybrid generator with the o2-sim is presented in this short manual.
+All the other generators are implemented as sub-generators and they can be called thanks to a
+JSON file, fed to o2-sim via the GeneratorHybrid.configFile parameter.
+
+The example can be run automatically using the runo2sim.sh script, which contains most of the 
+available generators in O2. The JSON template can be generated using the ${O2DPG_ROOT}/MC/bin/o2_hybrid_gen.py script. To use this example the user can simply copy the entire Hybrid example folder and execute the script after giving it execution permissions (`chmod +x runo2sim.sh`).
+
+# Files description
+
+- **runo2sim.sh** &rarr; allows to use the hybrid generator example
+- **hybridconfig.json** &rarr; example JSON file for the hybrid generator configuration
+- **example.optns** &rarr; options file to be used in EPOS4 implemented as subgenerator in this example (the .optns must be available in the current working directory)
+- **evtpool.root** &rarr; cached events to be used with the extkinO2 generator
+- **epos4.hepmc** &rarr; EPOS4 events stored as hepmc file