Use factory function instead

Author: gagnonlg

Plugins/FastJet/include/Acts/Plugins/FastJet/TrackJets.hpp

@@ -18,9 +18,21 @@
 
 namespace Acts::FastJet {
 
+/// Default jet definition: Anti-kt with a radius of 0.4
+const fastjet::JetDefinition DefaultJetDefinition =
+    fastjet::JetDefinition(fastjet::antikt_algorithm, 0.4);
+
 template <typename TrackContainer>
 class TrackJetSequence {
  public:
+  /// Factory function to create a sequence of track jets
+  ///
+  /// @param tracks the input tracks
+  /// @jetDef the jet definition to use, defaults to "DefaultJetDefinition"
+  static TrackJetSequence<TrackContainer> create(
+      TrackContainer& tracks,
+      fastjet::JetDefinition jetDef = DefaultJetDefinition);
+
   /// Get all the track jets passing the pT & eta cuts
   ///
   /// @param ptMin the minimum jet pT in GeV
@@ -40,32 +52,19 @@ class TrackJetSequence {
   std::vector<typename TrackContainer::TrackProxy> tracksInJet(
       const fastjet::PseudoJet& jet, std::optional<float> coreR = {});
 
-  /// Main constructor, but using the "makeTrackJets" function is recommended
+ private:
+  /// Main constructor. Users should call "TrackJetSequence::create" instead
   ///
   /// @param clusterSeq the fastjet::ClusterSequence object
   /// @param inputTracks the input tracks that make up the sequence
   TrackJetSequence(fastjet::ClusterSequence clusterSeq,
                    TrackContainer& inputTracks)
       : m_clusterSeq{std::move(clusterSeq)}, m_inputTracks{inputTracks} {}
 
- private:
   fastjet::ClusterSequence m_clusterSeq;
   TrackContainer& m_inputTracks;
 };
 
-/// Default jet definition: Anti-kt with a radius of 0.4
-const fastjet::JetDefinition DefaultJetDefinition =
-    fastjet::JetDefinition(fastjet::antikt_algorithm, 0.4);
-
-/// Create a sequence of track jets
-///
-/// @param tracks the input tracks
-/// @jetDef the jet definition to use, defaults to "DefaultJetDefinition"
-template <typename TrackContainer>
-TrackJetSequence<TrackContainer> makeTrackJets(
-    TrackContainer& tracks,
-    fastjet::JetDefinition jetDef = DefaultJetDefinition);
-
 }  // namespace Acts::FastJet
 
 #include "TrackJets.ipp"

Plugins/FastJet/include/Acts/Plugins/FastJet/TrackJets.ipp

@@ -9,8 +9,10 @@
 #include "Acts/Definitions/Algebra.hpp"
 #include "Acts/Definitions/Common.hpp"
 
+namespace Acts::FastJet {
+
 template <typename TrackContainer>
-Acts::FastJet::TrackJetSequence<TrackContainer> Acts::FastJet::makeTrackJets(
+TrackJetSequence<TrackContainer> TrackJetSequence<TrackContainer>::create(
     TrackContainer& tracks, fastjet::JetDefinition jetDef) {
   std::vector<fastjet::PseudoJet> inputs;
 
@@ -34,17 +36,16 @@ Acts::FastJet::TrackJetSequence<TrackContainer> Acts::FastJet::makeTrackJets(
 }
 
 template <typename TrackContainer>
-std::vector<fastjet::PseudoJet>
-Acts::FastJet::TrackJetSequence<TrackContainer>::jets(float ptMin,
-                                                      float etaMax) {
+std::vector<fastjet::PseudoJet> TrackJetSequence<TrackContainer>::jets(
+    float ptMin, float etaMax) {
   fastjet::Selector sel_eta = fastjet::SelectorAbsEtaMax(etaMax);
   return sel_eta(m_clusterSeq.inclusive_jets(ptMin));
 }
 
 template <typename TrackContainer>
 std::vector<typename TrackContainer::TrackProxy>
-Acts::FastJet::TrackJetSequence<TrackContainer>::tracksInJet(
-    const fastjet::PseudoJet& jet, std::optional<float> coreR) {
+TrackJetSequence<TrackContainer>::tracksInJet(const fastjet::PseudoJet& jet,
+                                              std::optional<float> coreR) {
   fastjet::Selector sel = fastjet::SelectorIdentity();
   if (coreR.has_value()) {
     sel = fastjet::SelectorCircle(coreR.value());
@@ -58,3 +59,5 @@ Acts::FastJet::TrackJetSequence<TrackContainer>::tracksInJet(
 
   return tracks;
 }
+
+}  // namespace Acts::FastJet

Tests/UnitTests/Plugins/FastJet/TrackJetsTests.cpp

@@ -57,7 +57,8 @@ BOOST_AUTO_TEST_CASE(SingleTrack) {
   TrackContainer tracks;
   tracks.insert(Track(100, 0, 0));
 
-  Acts::FastJet::TrackJetSequence jetSeq = Acts::FastJet::makeTrackJets(tracks);
+  Acts::FastJet::TrackJetSequence jetSeq =
+      Acts::FastJet::TrackJetSequence<TrackContainer>::create(tracks);
   std::vector<fastjet::PseudoJet> jets = jetSeq.jets();
 
   BOOST_CHECK_EQUAL(jets.size(), 1);
@@ -74,7 +75,8 @@ BOOST_AUTO_TEST_CASE(TwoTracksTwoJets) {
   tracks.insert(Track(100, 0, 0.0));
   tracks.insert(Track(100, 0, M_PI));
 
-  Acts::FastJet::TrackJetSequence jetSeq = Acts::FastJet::makeTrackJets(tracks);
+  Acts::FastJet::TrackJetSequence jetSeq =
+      Acts::FastJet::TrackJetSequence<TrackContainer>::create(tracks);
   std::vector<fastjet::PseudoJet> jets = jetSeq.jets();
 
   BOOST_CHECK_EQUAL(jets.size(), 2);
@@ -96,7 +98,8 @@ BOOST_AUTO_TEST_CASE(TwoTracksOneJet) {
   tracks.insert(Track(100, 0, 0.0));
   tracks.insert(Track(100, 0, 0.2));
 
-  Acts::FastJet::TrackJetSequence jetSeq = Acts::FastJet::makeTrackJets(tracks);
+  Acts::FastJet::TrackJetSequence jetSeq =
+      Acts::FastJet::TrackJetSequence<TrackContainer>::create(tracks);
   std::vector<fastjet::PseudoJet> jets = jetSeq.jets();
 
   BOOST_CHECK_EQUAL(jets.size(), 1);
@@ -118,7 +121,8 @@ BOOST_AUTO_TEST_CASE(TracksInJetCore) {
   tracks.insert(Track(10, 0.2, 0));
   tracks.insert(Track(10, -0.2, 0));
 
-  Acts::FastJet::TrackJetSequence jetSeq = Acts::FastJet::makeTrackJets(tracks);
+  Acts::FastJet::TrackJetSequence jetSeq =
+      Acts::FastJet::TrackJetSequence<TrackContainer>::create(tracks);
   std::vector<fastjet::PseudoJet> jets = jetSeq.jets();
 
   BOOST_REQUIRE_EQUAL(jets.size(), 1);