Add a test producing histograms

Author: jmcarcell

test/k4FWCoreTest/CMakeLists.txt

@@ -129,6 +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(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")

test/k4FWCoreTest/options/ExampleFunctionalProducerHist.py

@@ -0,0 +1,79 @@
+#
+# Copyright (c) 2014-2024 Key4hep-Project.
+#
+# This file is part of Key4hep.
+# See https://key4hep.github.io/key4hep-doc/ for further info.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+# 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 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
+threads = 2
+slots = 3
+if multithreaded:
+    whiteboard = HiveWhiteBoard(
+        "EventDataSvc",
+        EventSlots=slots,
+        ForceLeaves=True,
+    )
+    slimeventloopmgr = HiveSlimEventLoopMgr(
+        "HiveSlimEventLoopMgr", SchedulerName="AvalancheSchedulerSvc", OutputLevel=INFO
+    )
+
+    scheduler = AvalancheSchedulerSvc(ThreadPoolSize=threads, OutputLevel=INFO)
+    scheduler.ShowDataDependencies = True
+    scheduler.ShowDataFlow = True
+    scheduler.ShowControlFlow = True
+
+
+producer1 = ExampleFunctionalProducerHist(
+    "ExampleFunctionalProducer1", OutputCollection=["dummy1"]
+)
+producer2 = ExampleFunctionalProducerHist(
+    "ExampleFunctionalProducer2", OutputCollection=["dummy2"]
+)
+
+hist = RootHistSvc("HistogramPersistencySvc")
+root_hist_svc = RootHistoSink("RootHistoSink")
+root_hist_svc.FileName = "functional_producer_hist.root"
+
+
+if not multithreaded:
+    app = ApplicationMgr(
+        TopAlg=[producer1, producer2],
+        EvtSel="NONE",
+        EvtMax=10,
+        ExtSvc=[root_hist_svc] + ([whiteboard] if multithreaded else []),
+        OutputLevel=INFO,
+        HistogramPersistency="ROOT",
+    )
+else:
+    app = ApplicationMgr(
+        TopAlg=[producer1, producer2],
+        EvtSel="NONE",
+        EvtMax=10,
+        ExtSvc=[root_hist_svc] + ([whiteboard] if multithreaded else []),
+        OutputLevel=INFO,
+        HistogramPersistency="ROOT",
+        EventLoop=slimeventloopmgr,
+    )

test/k4FWCoreTest/src/components/ExampleFunctionalProducerHist.cpp

@@ -0,0 +1,49 @@
+/*
+ * Copyright (c) 2014-2024 Key4hep-Project.
+ *
+ * This file is part of Key4hep.
+ * See https://key4hep.github.io/key4hep-doc/ for further info.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#include "edm4hep/MCParticleCollection.h"
+
+#include "k4FWCore/Producer.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"})) {}
+
+  // 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
+    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.}};
+};
+
+DECLARE_COMPONENT(ExampleFunctionalProducerHist)