implement tupling of vectors and factor out into new base class

Pr/PrKernel/dict/PrKernelDict.h

@@ -12,6 +12,7 @@
 #define DICT_PRKERNELDICT_H 1
 
 #include "PrKernel/IPrDebugTool.h"
+#include "PrKernel/IPrDebugTrackingTool.h"
 #include "PrKernel/IPrDebugUTTool.h"
 #include "PrKernel/IPrUTCounter.h"
 #include "PrKernel/IPrUTMagnetTool.h"

Pr/PrKernel/dict/PrKernelDict.xml

@@ -13,4 +13,5 @@
   <class name = "IPrDebugUTTool"  />
   <class name = "IPrUTCounter"    />
   <class name = "IPrUTMagnetTool" />
+  <class name = "IPrDebugTrackingTool" />
 </lcgdict>

Pr/PrKernel/include/PrKernel/IPrDebugTrackingTool.h

@@ -23,7 +23,7 @@ struct IPrDebugTrackingTool : extend_interfaces<IAlgTool> {
 
   DeclareInterfaceID( IPrDebugTrackingTool, 1, 0 );
 
-  using VariableDef = std::pair<std::string_view, std::variant<int, float, std::vector<float>>>;
+  using VariableDef = std::pair<std::string_view, std::variant<int, float, std::vector<int>, std::vector<float>>>;
 
   virtual int check( int = -1, int = -1, const std::vector<int>& = {} ) const = 0;
 

Pr/PrKernel/include/PrKernel/PrDebugTrackingToolBase.h

+/*****************************************************************************\
+* (c) Copyright 2022 CERN for the benefit of the LHCb Collaboration           *
+*                                                                             *
+* This software is distributed under the terms of the GNU General Public      *
+* Licence version 3 (GPL Version 3), copied verbatim in the file "COPYING".   *
+*                                                                             *
+* In applying this licence, 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.                                       *
+\*****************************************************************************/
+
+#pragma once
+
+#include "PrKernel/IPrDebugTrackingTool.h"
+
+#include "GaudiAlg/GaudiTupleTool.h"
+
+struct PrDebugTrackingToolBase : public extends<GaudiTupleTool, IPrDebugTrackingTool> {
+
+  // inherit standard constructors
+  using extends::extends;
+
+  /**
+   * @brief This is the default implementation for storing data in the tool interface.
+   *
+   * @param vars_and_values
+   * @param tuple_name
+   *
+   * @note Supports tupling of int, float, std::vector<int>, std::vector<float>. The vectors
+   * have an arbitrary size limit of 1024 entries.
+   */
+
+  virtual void storeData( LHCb::span<const VariableDef> vars_and_values, std::string_view tuple_name ) const override {
+
+    Tuple tuple = nTuple( std::string{tuple_name} );
+    for ( auto [name, value] : vars_and_values ) {
+      if ( std::holds_alternative<int>( value ) ) {
+        tuple->column( name, std::get<int>( value ) ).ignore();
+      } else if ( std::holds_alternative<float>( value ) ) {
+        tuple->column( name, std::get<float>( value ) ).ignore();
+      } else if ( std::holds_alternative<std::vector<int>>( value ) ) {
+        tuple->farray( name, std::get<std::vector<int>>( value ), std::string{name} + "_length", 1024 ).ignore();
+      } else {
+        tuple->farray( name, std::get<std::vector<float>>( value ), std::string{name} + "_length", 1024 ).ignore();
+      }
+    }
+    tuple->write().ignore();
+  }
+};

Pr/PrMCTools/src/PrMCDebugForwardTool.cpp

@@ -9,13 +9,12 @@
 * or submit itself to any jurisdiction.                                       *
 \*****************************************************************************/
 
-#include "PrKernel/IPrDebugTrackingTool.h"
+#include "PrKernel/PrDebugTrackingToolBase.h"
 
 #include <algorithm>
 #include <string>
 #include <vector>
 
-#include "GaudiAlg/GaudiTupleTool.h"
 #include "GaudiKernel/DataObjectHandle.h"
 
 #include "Event/LinksByKey.h"
@@ -28,15 +27,13 @@
 #include "Linker/LinkedTo.h"
 
 namespace LHCb::Pr::Forward {
-  struct PrMCDebugForwardTool : public extends<GaudiTupleTool, IPrDebugTrackingTool> {
+  struct PrMCDebugForwardTool : public PrDebugTrackingToolBase {
 
     // inherit standard constructors
-    using extends::extends;
+    using PrDebugTrackingToolBase::PrDebugTrackingToolBase;
 
     int check( int track_index = -1, int index = -1, const std::vector<int>& = {} ) const override;
 
-    void storeData( LHCb::span<const VariableDef>, std::string_view = "Tuple" ) const override;
-
   private:
     Gaudi::Property<float> m_matchFrac{this, "MatchFraction", 0.7};
 
@@ -51,22 +48,6 @@ namespace LHCb::Pr::Forward {
   // Declaration of the Tool Factory
   DECLARE_COMPONENT_WITH_ID( PrMCDebugForwardTool, "PrMCDebugForwardTool" )
 
-  //=============================================================================
-  void PrMCDebugForwardTool::storeData( LHCb::span<const VariableDef> vars_and_values,
-                                        std::string_view              tuple_name ) const {
-
-    Tuple tuple = nTuple( std::string{tuple_name} );
-    for ( auto [name, value] : vars_and_values ) {
-      if ( std::holds_alternative<int>( value ) ) {
-        tuple->column( name, std::get<int>( value ) ).ignore();
-      } else {
-        tuple->column( name, std::get<float>( value ) ).ignore();
-      }
-    }
-    tuple->write().ignore();
-  }
-
-  //=============================================================================
   int PrMCDebugForwardTool::check( int track_index, int, const std::vector<int>& scifi_indices ) const {
     assert( track_index >= 0 );
 

Pr/PrMCTools/src/PrMCDebugMatchToolNN.cpp

@@ -9,12 +9,11 @@
 * or submit itself to any jurisdiction.                                       *
 \*****************************************************************************/
 
-#include "PrKernel/IPrDebugTrackingTool.h"
+#include "PrKernel/PrDebugTrackingToolBase.h"
 
 #include <string>
 #include <vector>
 
-#include "GaudiAlg/GaudiTupleTool.h"
 #include "GaudiKernel/DataObjectHandle.h"
 
 #include "Event/LinksByKey.h"
@@ -25,15 +24,13 @@
 #include "Linker/LinkedTo.h"
 
 namespace LHCb::Pr::MatchNN {
-  struct PrMCDebugMatchToolNN : public extends<GaudiTupleTool, IPrDebugTrackingTool> {
+  struct PrMCDebugMatchToolNN : public PrDebugTrackingToolBase {
 
     // inherit standard constructors
-    using extends::extends;
+    using PrDebugTrackingToolBase::PrDebugTrackingToolBase;
 
     int check( int veloIndex = -1, int seedIndex = -1, const std::vector<int>& = {} ) const override;
 
-    void storeData( LHCb::span<const VariableDef>, std::string_view = "Tuple" ) const override;
-
   private:
     DataObjectReadHandle<LHCb::Tracks>      m_veloTracks{this, "VeloTracks", ""};
     DataObjectReadHandle<LHCb::Tracks>      m_seedTracks{this, "SeedTracks", ""};
@@ -46,22 +43,6 @@ namespace LHCb::Pr::MatchNN {
   // Declaration of the Tool Factory
   DECLARE_COMPONENT_WITH_ID( PrMCDebugMatchToolNN, "PrMCDebugMatchToolNN" )
 
-  //=============================================================================
-  void PrMCDebugMatchToolNN::storeData( LHCb::span<const VariableDef> vars_and_values,
-                                        std::string_view              tuple_name ) const {
-
-    Tuple tuple = nTuple( std::string{tuple_name} );
-    for ( auto [name, value] : vars_and_values ) {
-      if ( std::holds_alternative<int>( value ) ) {
-        tuple->column( name, std::get<int>( value ) ).ignore();
-      } else {
-        tuple->column( name, std::get<float>( value ) ).ignore();
-      }
-    }
-    tuple->write().ignore();
-  }
-
-  //=============================================================================
   int PrMCDebugMatchToolNN::check( int veloIndex, int seedIndex, const std::vector<int>& ) const {
     assert( veloIndex >= 0 && seedIndex >= 0 );
     std::vector<const LHCb::MCParticle*> velo_mcps{};