feat+build: improve algorithm configuration; colored log output; improve dependency resolution

src/algorithms/clas12/event_builder_filter/EventBuilderFilter.cc

@@ -3,18 +3,27 @@
 namespace iguana::clas12 {
 
   EventBuilderFilter::EventBuilderFilter() : Algorithm("event_builder_filter") {
+
+    // define required banks
     m_requiredBanks = {
       "REC::Particle",
       "REC::Calorimeter"
     };
+
+    // set default configuration options
+    SetOption("pids", std::set<int>{11, 211});
   }
 
   void EventBuilderFilter::Start(bank_index_cache_t &index_cache) {
 
-    // set configuration
+    // set logger
+    // TODO: should be done by configuration
     m_log->SetLevel(Logger::Level::trace);
     m_log->Debug("START {}", m_name);
-    m_opt.pids = {11, 211, -211};
+
+    // cache options
+    CacheOption("pids", o_pids);
+    PrintOptions();
 
     // cache expected bank indices
     CacheBankIndex(index_cache, b_particle, "REC::Particle");
@@ -48,7 +57,7 @@ namespace iguana::clas12 {
 
 
   bool EventBuilderFilter::Filter(int pid) {
-    return m_opt.pids.find(pid) != m_opt.pids.end();
+    return o_pids.find(pid) != o_pids.end();
   }
 
 

src/algorithms/clas12/event_builder_filter/EventBuilderFilter.h

@@ -5,12 +5,6 @@
 
 namespace iguana::clas12 {
 
-  class EventBuilderFilterOptions {
-    public:
-      std::set<int> pids = {11, 211};
-  };
-
-
   class EventBuilderFilter : public Algorithm {
 
     public:
@@ -25,9 +19,13 @@ namespace iguana::clas12 {
       bool Filter(int pid);
 
     private:
-      EventBuilderFilterOptions m_opt;
+
+      /// `bank_vec_t` indices
       int b_particle, b_calo;
 
+      /// configuration options
+      std::set<int> o_pids;
+
   };
 
 }

src/services/Algorithm.cc

@@ -14,6 +14,26 @@ namespace iguana {
     Start(index_cache);
   }
 
+  void Algorithm::SetOption(std::string key, option_value_t val) {
+    m_opt[key] = val;
+  }
+
+  void Algorithm::PrintOptions(Logger::Level level) {
+    if(m_log->GetLevel() <= level) {
+      m_log->Print(level, Logger::Header("CONFIGURATION OPTIONS"));
+      std::string format_str = "{:>20} = {}   [{}]";
+      for(auto [key, val] : m_opt) {
+        if      (const auto valPtr(std::get_if<int>(&val));           valPtr) m_log->Print(level, format_str, key, *valPtr,                 "int");
+        else if (const auto valPtr(std::get_if<double>(&val));        valPtr) m_log->Print(level, format_str, key, *valPtr,                 "double");
+        else if (const auto valPtr(std::get_if<std::string>(&val));   valPtr) m_log->Print(level, format_str, key, *valPtr,                 "string");
+        else if (const auto valPtr(std::get_if<std::set<int>>(&val)); valPtr) m_log->Print(level, format_str, key, fmt::join(*valPtr,", "), "set<int>");
+        else
+          m_log->Error("option '{}' type has no printer defined in PrintOptions", key);
+      }
+      m_log->Print(level, Logger::Header(""));
+    }
+  }
+
   void Algorithm::CacheBankIndex(bank_index_cache_t index_cache, int &idx, std::string bankName) {
     try {
       idx = index_cache.at(bankName);

src/services/Algorithm.h

@@ -31,6 +31,15 @@ namespace iguana {
       /// Finalize an algorithm after all events are processed
       virtual void Stop() = 0;
 
+      /// Set an option specified by the user
+      /// @param key the name of the option
+      /// @param val the value to set
+      void SetOption(std::string key, option_value_t val);
+
+      /// Print all the options and their values for this algorithm
+      /// @param level the log level
+      void PrintOptions(Logger::Level level=Logger::debug);
+
     protected:
 
       /// Cache the index of a bank in a `bank_vec_t`; throws an exception if the bank is not found
@@ -39,6 +48,17 @@ namespace iguana {
       /// @param bankName the name of the bank
       void CacheBankIndex(bank_index_cache_t index_cache, int &idx, std::string bankName);
 
+      /// Cache an option specified by the user
+      /// @param key the name of the option
+      /// @param val reference to the value of the option
+      template <typename VALUE>
+        void CacheOption(std::string key, VALUE &val) {
+          if(auto it{m_opt.find(key)}; it != m_opt.end())
+            val = std::get<VALUE>(it->second);
+          else
+            m_log->Warn("unknown option '{}' in CacheOption", key);
+        }
+
       /// Get the pointer to a bank from a `bank_vec_t`; optionally checks if the bank name matches the expectation
       /// @param banks the `bank_vec_t` from which to get the specified bank
       /// @param idx the index of `banks` of the specified bank
@@ -81,5 +101,8 @@ namespace iguana {
 
       /// Logger
       std::shared_ptr<Logger> m_log;
+
+      /// Configuration options
+      options_t m_opt;
   };
 }

src/services/Logger.cc

@@ -23,7 +23,7 @@ namespace iguana {
   }
 
   std::string Logger::Header(std::string message, int width) {
-    return fmt::format("{:=^{}}", message, width);
+    return fmt::format("{:=^{}}", " " + message + " ", width);
   }
 
 }

src/services/TypeDefs.h

@@ -1,6 +1,8 @@
 #include <memory>
 #include <vector>
+#include <set>
 #include <unordered_map>
+#include <variant>
 
 #include <hipo4/bank.h>
 
@@ -15,4 +17,15 @@ namespace iguana {
   /// association between HIPO bank name and its index in a `bank_vec_t`
   using bank_index_cache_t = std::unordered_map<std::string, int>;
 
+  /// option value variant type
+  using option_value_t = std::variant<
+    int,
+    double,
+    std::string,
+    std::set<int>
+  >;
+
+  /// data structure to hold configuration options
+  using options_t = std::unordered_map<std::string, option_value_t>;
+
 }

src/tests/meson.build

@@ -4,7 +4,7 @@ foreach test_exe : [ 'run_banks', 'run_rows' ]
     test_exe + '.cc',
     include_directories: project_inc,
     dependencies:        [ fmt_dep, hipo_dep ],
-    link_with:           [ iguana_lib, algo_lib ],
+    link_with:           [ iguana_lib, algo_lib, services_lib ],
     install:             true,
     install_dir:         project_bin_install_dir,
     install_rpath:       project_bin_rpath,

src/tests/run_banks.cc

@@ -21,6 +21,7 @@ int main(int argc, char **argv) {
    */
   iguana::Iguana I;
   auto algo = I.algo_map.at(iguana::Iguana::clas12_EventBuilderFilter);
+  algo->SetOption("pids", std::set<int>{11, 211, -211});
   algo->Start();
 
   /////////////////////////////////////////////////////

src/tests/run_rows.cc

@@ -10,6 +10,7 @@ int main(int argc, char **argv) {
 
   // start the algorithm
   auto algo = std::make_shared<iguana::clas12::EventBuilderFilter>();
+  algo->SetOption("pids", std::set<int>{11, 211, -211});
   algo->Start();
 
   /////////////////////////////////////////////////////