Change the test with histograms to be a transformer instead of a producer

Author: jmcarcell

test/k4FWCoreTest/CMakeLists.txt

@@ -129,7 +129,7 @@ add_test_with_env(FunctionalProducerRuntimeCollections options/ExampleFunctional
 add_test_with_env(FunctionalTransformerRuntimeCollections options/ExampleFunctionalTransformerRuntimeCollections.py)
 add_test_with_env(FunctionalTransformerRuntimeEmpty options/ExampleFunctionalTransformerRuntimeEmpty.py)
 add_test_with_env(FunctionalTransformerRuntimeCollectionsMultiple options/ExampleFunctionalTransformerRuntimeCollectionsMultiple.py)
-add_test_with_env(FunctionalProducerHist options/ExampleFunctionalProducerHist.py)
+add_test_with_env(FunctionalTransformerHist options/ExampleFunctionalTransformerHist.py)
 
 add_test(NAME FunctionalCheckFiles COMMAND python3 ${CMAKE_CURRENT_LIST_DIR}/options/CheckOutputFiles.py)
 set_tests_properties(FunctionalCheckFiles PROPERTIES DEPENDS "FunctionalFile;FunctionalMTFile;FunctionalMultipleFile;FunctionalOutputCommands;FunctionalProducerAbsolutePath;FunctionalTransformerRuntimeEmpty;FunctionalMix;FunctionalMixIOSvc;FunctionalProducerHist")

test/k4FWCoreTest/options/CheckOutputFiles.py

@@ -120,12 +120,12 @@ def check_collections(filename, names):
     mix_collections,
 )
 
-f = ROOT.TFile.Open("functional_producer_hist.root")
+f = ROOT.TFile.Open("functional_transformer_hist.root")
 for i in range(2):
     if (
         str(f.GetListOfKeys()[i])
-        != f"Name: ExampleFunctionalProducer{i+1} Title: ExampleFunctionalProducer{i+1}"
+        != f"Name: ExampleFunctionalTransformerHist{i+1} Title: ExampleFunctionalTransformerHist{i+1}"
     ):
         raise RuntimeError(
-            "Directory structure does not match expected for functional_producer_hist.root"
+            "Directory structure does not match expected for functional_transformer_hist.root"
         )

test/k4FWCoreTest/options/ExampleFunctionalProducerHist.py renamed to test/k4FWCoreTest/options/ExampleFunctionalTransformerHist.py

@@ -20,14 +20,14 @@
 # This is an example using two producers that create histograms and persist them to a ROOT file
 
 from Gaudi.Configuration import INFO
-from Configurables import ExampleFunctionalProducerHist
+from Configurables import ExampleFunctionalProducer, ExampleFunctionalTransformerHist
 from k4FWCore import ApplicationMgr
 from Configurables import RootHistSvc
 from Configurables import Gaudi__Histograming__Sink__Root as RootHistoSink
 from Configurables import HiveWhiteBoard, HiveSlimEventLoopMgr, AvalancheSchedulerSvc
 
 # Multithreaded also works fine with histograms
-multithreaded = True
+multithreaded = False
 threads = 2
 slots = 3
 if multithreaded:
@@ -46,20 +46,33 @@
     scheduler.ShowControlFlow = True
 
 
-producer1 = ExampleFunctionalProducerHist(
-    "ExampleFunctionalProducer1", OutputCollection=["dummy1"]
+producer1 = ExampleFunctionalProducer(
+    "ExampleFunctionalProducer1", OutputCollection=["MCParticles1"]
 )
-producer2 = ExampleFunctionalProducerHist(
-    "ExampleFunctionalProducer2", OutputCollection=["dummy2"]
+producer2 = ExampleFunctionalProducer(
+    "ExampleFunctionalProducer2", OutputCollection=["MCParticles2"]
+)
+
+transformer1 = ExampleFunctionalTransformerHist(
+    "ExampleFunctionalTransformerHist1",
+    InputCollection=["MCParticles1"],
+    OutputCollection=["dummy1"],
+)
+
+transformer2 = ExampleFunctionalTransformerHist(
+    "ExampleFunctionalTransformerHist2",
+    InputCollection=["MCParticles2"],
+    OutputCollection=["dummy2"],
+    FirstParticle=False,
 )
 
 hist = RootHistSvc("HistogramPersistencySvc")
 root_hist_svc = RootHistoSink("RootHistoSink")
-root_hist_svc.FileName = "functional_producer_hist.root"
+root_hist_svc.FileName = "functional_transformer_hist.root"
 
 
 app = ApplicationMgr(
-    TopAlg=[producer1, producer2],
+    TopAlg=[producer1, producer2, transformer1, transformer2],
     EvtSel="NONE",
     EvtMax=10,
     ExtSvc=[root_hist_svc] + ([whiteboard] if multithreaded else []),

test/k4FWCoreTest/src/components/ExampleFunctionalProducerHist.cpp renamed to test/k4FWCoreTest/src/components/ExampleFunctionalTransformerHist.cpp

@@ -19,31 +19,33 @@
 
 #include "edm4hep/MCParticleCollection.h"
 
-#include "k4FWCore/Producer.h"
+#include "k4FWCore/Transformer.h"
 
 #include "Gaudi/Accumulators/RootHistogram.h"
-#include "GaudiKernel/RndmGenerators.h"
 
 #include <string>
 
-struct ExampleFunctionalProducerHist final : k4FWCore::Producer<edm4hep::MCParticleCollection()> {
-  // The pair in KeyValues can be changed from python and it corresponds
-  // to the name of the output collection
-  ExampleFunctionalProducerHist(const std::string& name, ISvcLocator* svcLoc)
-      : Producer(name, svcLoc, {}, KeyValues("OutputCollection", {"MCParticles"})) {}
+struct ExampleFunctionalTransformerHist final
+    : k4FWCore::Transformer<edm4hep::MCParticleCollection(const edm4hep::MCParticleCollection& input)> {
+  // The pairs in KeyValues can be changed from python and they correspond
+  // to the name of the input and output collections respectively
+  ExampleFunctionalTransformerHist(const std::string& name, ISvcLocator* svcLoc)
+      : Transformer(name, svcLoc, KeyValues("InputCollection", {"MCParticles"}),
+                    KeyValues("OutputCollection", {"MCParticles"})) {}
 
   // This is the function that will be called to produce the data
-  edm4hep::MCParticleCollection operator()() const override {
-    // Not thread-safe!
-    Rndm::Numbers rndu(randSvc(), Rndm::Flat(0, 1));
-    ++m_histograms[rndu()];
-    // Return an empty collection since we don't care about the collection for this example
+  edm4hep::MCParticleCollection operator()(const edm4hep::MCParticleCollection& input) const override {
+    // Fill the histogram with the energy of one particle
+    ++m_histograms[input[0 + !m_firstParticle.value()].getEnergy()];
+    // Return an empty collection since we don't care about the collection
     return {};
   }
 
 private:
   // This is the histogram that will be filled, 1 is the number of dimensions of the histogram (1D)
-  mutable Gaudi::Accumulators::RootHistogram<1> m_histograms{this, "Histogram Name", "Histogram Title", {100, 0, 1.}};
+  mutable Gaudi::Accumulators::RootHistogram<1> m_histograms{this, "Histogram Name", "Histogram Title", {100, 0, 10.}};
+
+  Gaudi::Property<bool> m_firstParticle{this, "FirstParticle", true};
 };
 
-DECLARE_COMPONENT(ExampleFunctionalProducerHist)
+DECLARE_COMPONENT(ExampleFunctionalTransformerHist)