External trigger configuration moved to configurable params

Author: preghenella

Common/SimConfig/include/SimConfig/SimConfig.h

@@ -29,8 +29,6 @@ struct SimConfigData {
   std::string mExtKinFileName;               // file name of external kinematics file (needed for ext kinematics generator)
   std::string mExtGenFileName;               // file name containing the external generator configuration
   std::string mExtGenFuncName;               // function call to retrieve the external generator configuration
-  std::string mExtTrgFileName;               // file name containing the external trigger configuration
-  std::string mExtTrgFuncName;               // function call to retrieve the external trigger configuration
   std::string mEmbedIntoFileName;            // filename containing the reference events to be used for the embedding
   unsigned int mStartEvent;                  // index of first event to be taken
   float mBMax;                               // maximum for impact parameter sampling
@@ -102,8 +100,6 @@ class SimConfig
   std::string getExtKinematicsFileName() const { return mConfigData.mExtKinFileName; }
   std::string getExtGeneratorFileName() const { return mConfigData.mExtGenFileName; }
   std::string getExtGeneratorFuncName() const { return mConfigData.mExtGenFuncName; }
-  std::string getExtTriggerFileName() const { return mConfigData.mExtTrgFileName; }
-  std::string getExtTriggerFuncName() const { return mConfigData.mExtTrgFuncName; }
   std::string getEmbedIntoFileName() const { return mConfigData.mEmbedIntoFileName; }
   unsigned int getStartEvent() const { return mConfigData.mStartEvent; }
   float getBMax() const { return mConfigData.mBMax; }

Common/SimConfig/src/SimConfig.cxx

@@ -35,10 +35,6 @@ void SimConfig::initOptions(boost::program_options::options_description& options
     "name of .C file with definition of external event generator")(
     "extGenFunc", bpo::value<std::string>()->default_value(""),
     "function call to load the definition of external event generator")(
-    "extTrgFile", bpo::value<std::string>()->default_value("exttrg.C"),
-    "name of .C file with definition of external event generator trigger")(
-    "extTrgFunc", bpo::value<std::string>()->default_value(""),
-    "function call to load the definition of external event generator trigger")(
     "embedIntoFile", bpo::value<std::string>()->default_value(""),
     "filename containing the reference events to be used for the embedding")(
     "bMax,b", bpo::value<float>()->default_value(0.), "maximum value for impact parameter sampling (when applicable)")(
@@ -100,8 +96,6 @@ bool SimConfig::resetFromParsedMap(boost::program_options::variables_map const&
   mConfigData.mExtKinFileName = vm["extKinFile"].as<std::string>();
   mConfigData.mExtGenFileName = vm["extGenFile"].as<std::string>();
   mConfigData.mExtGenFuncName = vm["extGenFunc"].as<std::string>();
-  mConfigData.mExtTrgFileName = vm["extTrgFile"].as<std::string>();
-  mConfigData.mExtTrgFuncName = vm["extTrgFunc"].as<std::string>();
   mConfigData.mEmbedIntoFileName = vm["embedIntoFile"].as<std::string>();
   mConfigData.mStartEvent = vm["startEvent"].as<unsigned int>();
   mConfigData.mBMax = vm["bMax"].as<float>();

Generators/CMakeLists.txt

@@ -29,6 +29,7 @@ o2_add_library(Generators
                        src/PDG.cxx
                        src/PrimaryGenerator.cxx
                        src/InteractionDiamondParam.cxx
+                       src/TriggerExternalParam.cxx
                        src/TriggerParticleParam.cxx
                        src/BoxGunParam.cxx
 		       src/QEDGenParam.cxx
@@ -68,6 +69,7 @@ set(headers
     include/Generators/PDG.h
     include/Generators/PrimaryGenerator.h
     include/Generators/InteractionDiamondParam.h
+    include/Generators/TriggerExternalParam.h
     include/Generators/TriggerParticleParam.h
     include/Generators/ConfigurationMacroHelper.h
     include/Generators/BoxGunParam.h

Generators/include/Generators/TriggerExternalParam.h

@@ -0,0 +1,38 @@
+// Copyright CERN and copyright holders of ALICE O2. This software is
+// distributed under the terms of the GNU General Public License v3 (GPL
+// Version 3), copied verbatim in the file "COPYING".
+//
+// See http://alice-o2.web.cern.ch/license for full licensing information.
+//
+// In applying this license CERN does not waive the privileges and immunities
+// granted to it by virtue of its status as an Intergovernmental Organization
+// or submit itself to any jurisdiction.
+
+/// \author R+Preghenella - September 2020
+
+#ifndef ALICEO2_EVENTGEN_TRIGGEREXTERNALPARAM_H_
+#define ALICEO2_EVENTGEN_TRIGGEREXTERNALPARAM_H_
+
+#include "CommonUtils/ConfigurableParam.h"
+#include "CommonUtils/ConfigurableParamHelper.h"
+
+namespace o2
+{
+namespace eventgen
+{
+
+/**
+ ** a parameter class/struct to keep the settings of
+ ** the event-generator external trigger and
+ ** allow the user to modify them 
+ **/
+struct TriggerExternalParam : public o2::conf::ConfigurableParamHelper<TriggerExternalParam> {
+  std::string fileName = "";
+  std::string funcName = "";
+  O2ParamDef(TriggerExternalParam, "TriggerExternal");
+};
+
+} // end namespace eventgen
+} // end namespace o2
+
+#endif // ALICEO2_EVENTGEN_TRIGGEREXTERNALPARAM_H_

Generators/share/external/trigger_mpi.C

@@ -1,7 +1,6 @@
 // MPI trigger
 //
-//   usage: o2sim --trigger external --extTrgFile trigger_mpi.C
-// options:                          --extTrgFunc "trigger_mpi()"
+//   usage: o2sim --trigger external --configKeyValues 'TriggerExternal.fileName=trigger_mpi.C;TriggerExternal.funcName="trigger_mpi()"'
 //
 
 /// \author R+Preghenella - February 2020

Generators/share/external/trigger_multiplicity.C

@@ -1,7 +1,6 @@
 // multiplicity trigger
 //
-//   usage: o2sim --trigger external --extTrgFile trigger_multiplicity.C
-// options:                          --extTrgFunc "trigger_multiplicity(-0.8, 0.8, 100)"
+//   usage: o2sim --trigger external --configKeyValues 'TriggerExternal.fileName=trigger_multiplicity.C;TriggerExternal.funcName="trigger_multiplicity(-0.8, 0.8, 100)"'
 //
 
 /// \author R+Preghenella - February 2020

Generators/src/GeneratorFactory.cxx

@@ -32,6 +32,7 @@
 #endif
 #include <Generators/BoxGunParam.h>
 #include <Generators/TriggerParticle.h>
+#include <Generators/TriggerExternalParam.h>
 #include <Generators/TriggerParticleParam.h>
 #include "Generators/ConfigurationMacroHelper.h"
 
@@ -227,8 +228,11 @@ void GeneratorFactory::setPrimaryGenerator(o2::conf::SimConfig const& conf, Fair
     trigger = TriggerParticle(TriggerParticleParam::Instance());
   } else if (trgconfig.compare("external") == 0) {
     // external trigger via configuration macro
-    auto external_trigger_filename = conf.getExtTriggerFileName();
-    auto external_trigger_func = conf.getExtTriggerFuncName();
+    auto& params = TriggerExternalParam::Instance();
+    LOG(INFO) << "Setting up external trigger with following parameters";
+    LOG(INFO) << params;
+    auto external_trigger_filename = params.fileName;
+    auto external_trigger_func = params.funcName;
     trigger = GetFromMacro<o2::eventgen::Trigger>(external_trigger_filename, external_trigger_func, "o2::eventgen::Trigger", "trigger");
     if (!trigger) {
       LOG(INFO) << "Trying to retrieve a \'o2::eventgen::DeepTrigger\' type" << std::endl;

Generators/src/GeneratorsLinkDef.h

@@ -52,6 +52,8 @@
 #pragma link C++ enum o2::eventgen::EVertexDistribution;
 #pragma link C++ class o2::eventgen::InteractionDiamondParam + ;
 #pragma link C++ class o2::conf::ConfigurableParamHelper < o2::eventgen::InteractionDiamondParam > +;
+#pragma link C++ class o2::eventgen::TriggerExternalParam + ;
+#pragma link C++ class o2::conf::ConfigurableParamHelper < o2::eventgen::TriggerExternalParam> + ;
 #pragma link C++ class o2::eventgen::TriggerParticleParam + ;
 #pragma link C++ class o2::conf::ConfigurableParamHelper < o2::eventgen::TriggerParticleParam > +;
 #pragma link C++ class o2::eventgen::BoxGunParam + ;

Generators/src/TriggerExternalParam.cxx

@@ -0,0 +1,14 @@
+// Copyright CERN and copyright holders of ALICE O2. This software is
+// distributed under the terms of the GNU General Public License v3 (GPL
+// Version 3), copied verbatim in the file "COPYING".
+//
+// See http://alice-o2.web.cern.ch/license for full licensing information.
+//
+// In applying this license CERN does not waive the privileges and immunities
+// granted to it by virtue of its status as an Intergovernmental Organization
+// or submit itself to any jurisdiction.
+
+/// \author R+Preghenella - September 2020
+
+#include "Generators/TriggerExternalParam.h"
+O2ParamImpl(o2::eventgen::TriggerExternalParam);

doc/DetectorSimulation.md

@@ -187,7 +187,7 @@ o2-sim -g pythia8 -t particle --configKeyValues "TriggerParticle.pdg=333;Trigger
 Custom triggers can also be constructed by the user to provide unlimited flexibility in the trigger needs.
 An external trigger function can be specified via command line arguments
 ```
-o2-sim -g pythia8 -t external --extTrgFile path_to_trigger_macro.C --extTrgFunc "the_function(some, parameters)"
+o2-sim -g pythia8 -t external --configKeyValues 'TriggerExternal.fileName=path_to_trigger_macro.C;TriggerExternal.funcName="the_function(some, parameters)"'
 ```
 The function must comply with a simple protocol and return a lambda function defined as follows
 ```
@@ -205,7 +205,7 @@ To allow users to define triggers that go beyond the particle stack generated by
 This allows the user to go deep into the core of the event generator, whenever this is possible.
 For this reason, this is called a 'DeepTrigger'. A 'DeepTrigger' is attached to the simulation in the same way as a normal trigger
 ```
-o2-sim -g pythia8 -t external --extTrgFile path_to_deep_trigger_macro.C --extTrgFunc "the_deep_function(some, parameters)"
+o2-sim -g pythia8 -t external --configKeyValues 'TriggerExternal.fileName=path_to_deep_trigger_macro.C;TriggerExternal.funcName="the_deep_function(some, parameters)"'
 ```
 In this case the function must comply with a similar, but different protocol than before and return a lambda function defined as follows
 ``` o2::eventgen::DeepTrigger the_deep_function()
@@ -227,8 +227,7 @@ Deep triggers is just a name to a new functionality that allows the user to defi
 Here is an example of a deep trigger implementation in Pythia8.
 
 ```
-//   usage: o2sim --trigger external --extTrgFile trigger_mpi.C
-// options:                          --extTrgFunc "trigger_mpi()"
+//   usage: o2sim --trigger external --configKeyValues 'TriggerExternal.fileName=trigger_mpi.C;TriggerExternal.funcName="trigger_mpi()"'
 
 #include "Generators/Trigger.h"
 #include "Pythia8/Pythia.h"
@@ -294,8 +293,7 @@ Pythia8::UserHooks*
 A new Pythia6 interface is provided via GeneratorPythia6. This complies with the o2::eventgen::Generator protocol, and hence the user is allowed to use all the trigger functionalities. The class can also be used for DeepTriggers as this modified macro shows.
 
 ```
-//   usage: o2sim --trigger external --extTrgFile trigger_mpi.C
-// options:                          --extTrgFunc "trigger_mpi()"
+//   usage: o2sim --trigger external --configKeyValues "TriggerExternal.fileName=trigger_mpi.C;TriggerExternal.funcName="trigger_mpi()"'
 
 #include "Generators/Trigger.h"
 #include "Pythia8/Pythia.h"