Add FastJet plugin algorithms to jet reconstruction (#1378)

### Briefly, what does this PR introduce?

This PR adds Centauro FastJet contributed algorithm

### What kind of change does this PR introduce?
- [ ] Bug fix (issue #__)
- [ X ] New feature (issue #__)
- [ ] Documentation update
- [ ] Other: __

### Please check if this PR fulfills the following:
- [ ] Tests for the changes have been added
- [ ] Documentation has been added / updated
- [ ] Changes have been communicated to collaborators

### Does this PR introduce breaking changes? What changes might users
need to make to their code?

No 

### Does this PR change default behavior?

It does change the default behavior of the reconstruction in the
generated and reconstructed Centauro jets will be created.

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Dmitry Kalinkin <[email protected]>
Co-authored-by: Derek M Anderson <[email protected]>

Author: 4 people

cmake/FindFastJetContrib.cmake

@@ -0,0 +1,25 @@
+# * Locate FastJetContrib library Defines:
+#
+# FJCONTRIB_FOUND FJCONTRIB_INCLUDE_DIR FJCONTRIB_INCLUDE_DIRS (not cached)
+# FJCONTRIB_LIBRARY FJCONTRIB_LIBRARIES (not cached) FJCONTRIB_LIBRARY_DIRS (not
+# cached)
+
+find_path(FJCONTRIB_INCLUDE_DIR fastjet/contrib/Centauro.hh
+          HINTS $ENV{FASTJET_ROOT}/include ${FASTJET_ROOT_DIR}/include)
+
+find_library(
+  FJCONTRIB_LIBRARY
+  NAMES fastjetcontribfragile
+  HINTS $ENV{FASTJET_ROOT}/lib ${FASTJET_ROOT_DIR}/lib)
+
+# handle the QUIETLY and REQUIRED arguments and set FJCONTRIB_FOUND to TRUE if
+# all listed variables are TRUE
+include(FindPackageHandleStandardArgs)
+find_package_handle_standard_args(FastJetContrib DEFAULT_MSG
+                                  FJCONTRIB_INCLUDE_DIR FJCONTRIB_LIBRARY)
+
+mark_as_advanced(FJCONTRIB_FOUND FJCONTRIB_INCLUDE_DIR FJCONTRIB_LIBRARY)
+
+set(FJCONTRIB_INCLUDE_DIRS ${FJCONTRIB_INCLUDE_DIR})
+set(FJCONTRIB_LIBRARIES ${FJCONTRIB_LIBRARY})
+get_filename_component(FJCONTRIB_LIBRARY_DIRS ${FJCONTRIB_LIBRARY} PATH)

cmake/FindFastJetTools.cmake

@@ -0,0 +1,25 @@
+# * Locate FastJet Tools library Defines:
+#
+# FJTOOLS_FOUND FJTOOLS_INCLUDE_DIR FJTOOLS_INCLUDE_DIRS (not cached)
+# FJTOOLS_LIBRARY FJTOOLS_LIBRARIES (not cached) FJTOOLS_LIBRARY_DIRS (not
+# cached)
+
+find_path(FJTOOLS_INCLUDE_DIR fastjet/tools/BackgroundEstimatorBase.hh
+          HINTS $ENV{FASTJET_ROOT}/include ${FASTJET_ROOT_DIR}/include)
+
+find_library(
+  FJTOOLS_LIBRARY
+  NAMES fastjettools
+  HINTS $ENV{FASTJET_ROOT}/lib ${FASTJET_ROOT_DIR}/lib)
+
+# handle the QUIETLY and REQUIRED arguments and set FJTOOLS_FOUND to TRUE if all
+# listed variables are TRUE
+include(FindPackageHandleStandardArgs)
+find_package_handle_standard_args(FastJetTools DEFAULT_MSG FJTOOLS_INCLUDE_DIR
+                                  FJTOOLS_LIBRARY)
+
+mark_as_advanced(FJTOOLS_FOUND FJTOOLS_INCLUDE_DIR FJTOOLS_LIBRARY)
+
+set(FJTOOLS_INCLUDE_DIRS ${FJTOOLS_INCLUDE_DIR})
+set(FJTOOLS_LIBRARIES ${FJTOOLS_LIBRARY})
+get_filename_component(FJTOOLS_LIBRARY_DIRS ${FJTOOLS_LIBRARY} PATH)

cmake/jana_plugin.cmake

@@ -384,6 +384,38 @@ macro(plugin_add_fastjet _name)
 
 endmacro()
 
+# Adds FastJetTools for a plugin
+macro(plugin_add_fastjettools _name)
+
+  if(NOT FJTOOLS_FOUND)
+    find_package(FastJetTools REQUIRED)
+  endif()
+
+  # Add include directories
+  plugin_include_directories(${PLUGIN_NAME} SYSTEM PUBLIC
+                             ${FJTOOLS_INCLUDE_DIRS})
+
+  # Add libraries
+  plugin_link_libraries(${PLUGIN_NAME} ${FJTOOLS_LIBRARIES})
+
+endmacro()
+
+# Adds FastJetContrib for a plugin
+macro(plugin_add_fastjetcontrib _name)
+
+  if(NOT FJCONTRIB_FOUND)
+    find_package(FastJetContrib REQUIRED)
+  endif()
+
+  # Add include directories
+  plugin_include_directories(${PLUGIN_NAME} SYSTEM PUBLIC
+                             ${FJCONTRIB_INCLUDE_DIRS})
+
+  # Add libraries
+  plugin_link_libraries(${PLUGIN_NAME} ${FJCONTRIB_LIBRARIES})
+
+endmacro()
+
 # Adds ONNX Runtime for a plugin
 macro(plugin_add_onnxruntime _name)
 

src/algorithms/reco/CMakeLists.txt

@@ -16,6 +16,8 @@ plugin_add_dd4hep(${PLUGIN_NAME})
 plugin_add_cern_root(${PLUGIN_NAME})
 plugin_add_event_model(${PLUGIN_NAME})
 plugin_add_fastjet(${PLUGIN_NAME})
+plugin_add_fastjetcontrib(${PLUGIN_NAME})
+plugin_add_fastjettools(${PLUGIN_NAME})
 
 # The macro grabs sources as *.cc *.cpp *.c and headers as *.h *.hh *.hpp Then
 # correctly sets sources for ${_name}_plugin and ${_name}_library targets Adds

src/algorithms/reco/JetReconstruction.cc

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: LGPL-3.0-or-later
-// Copyright (C) 2024 Derek Anderson, Zhongling Ji, Dmitry Kalinkin
+// Copyright (C) 2024 Derek Anderson, Zhongling Ji, Dmitry Kalinkin, John Lajoie
 
 // class definition
 #include "JetReconstruction.h"
@@ -12,6 +12,7 @@
 #include <fastjet/GhostedAreaSpec.hh>
 // for fastjet objects
 #include <fastjet/PseudoJet.hh>
+#include <fastjet/contrib/Centauro.hh>
 #include <fmt/core.h>
 #include <gsl/pointers>
 #include <stdexcept>
@@ -55,6 +56,20 @@ namespace eicrecon {
     // Choose jet definition based on no. of parameters
     switch (m_mapJetAlgo[m_cfg.jetAlgo]) {
 
+      // contributed algorithms
+      case JetAlgorithm::plugin_algorithm:
+
+        // expand to other algorithms as required
+        if(m_cfg.jetContribAlgo == "Centauro"){
+          m_jet_plugin = std::make_unique<contrib::CentauroPlugin>(m_cfg.rJet);
+          m_jet_def = std::make_unique<JetDefinition>(m_jet_plugin.get());
+        }
+        else {
+          m_log->error(" Unknown contributed FastJet algorithm \"{}\" specified!", m_cfg.jetContribAlgo);
+          throw JException("Invalid contributed FastJet algorithm");
+        }
+        break;
+
       // 0 parameter algorithms
       case JetAlgorithm::ee_kt_algorithm:
         m_jet_def = std::make_unique<JetDefinition>(m_mapJetAlgo[m_cfg.jetAlgo], m_mapRecombScheme[m_cfg.recombScheme]);

src/algorithms/reco/JetReconstruction.h

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: LGPL-3.0-or-later
-// Copyright (C) 2024 Derek Anderson, Zhongling Ji, Dmitry Kalinkin
+// Copyright (C) 2024 Derek Anderson, Zhongling Ji, Dmitry Kalinkin, John Lajoie
 
 #pragma once
 
@@ -60,6 +60,7 @@ namespace eicrecon {
       // fastjet components
       std::unique_ptr<fastjet::JetDefinition> m_jet_def;
       std::unique_ptr<fastjet::AreaDefinition> m_area_def;
+      std::unique_ptr<fastjet::JetDefinition::Plugin> m_jet_plugin;
 
       // maps of user input onto fastjet options
       std::map<std::string, fastjet::JetAlgorithm> m_mapJetAlgo = {

src/algorithms/reco/JetReconstructionConfig.h

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: LGPL-3.0-or-later
-// Copyright (C) 2023 Derek Anderson, Zhongling Ji
+// Copyright (C) 2023 Derek Anderson, Zhongling Ji, John Lajoie
 
 #pragma once
 
@@ -21,6 +21,7 @@ namespace eicrecon {
     std::string jetAlgo        = "antikt_algorithm";  // jet finding algorithm
     std::string recombScheme   = "E_scheme";          // particle recombination scheme
     std::string areaType       = "active_area";       // type of area calculated
+    std::string jetContribAlgo = "Centauro";          // contributed algorithm name
 
   };
 

src/global/reco/reco.cc

@@ -305,5 +305,37 @@ void InitPlugin(JApplication *app) {
     ));
 #endif
 
+    app->Add(new JOmniFactoryGeneratorT<TransformBreitFrame_factory>(
+            "GeneratedBreitFrameParticles",
+            {"MCParticles","InclusiveKinematicsElectron","GeneratedParticles"},
+            {"GeneratedBreitFrameParticles"},
+            {},
+            app
+    ));
+
+    app->Add(new JOmniFactoryGeneratorT<JetReconstruction_factory<edm4eic::ReconstructedParticle>>(
+            "GeneratedCentauroJets",
+            {"GeneratedBreitFrameParticles"},
+            {"GeneratedCentauroJets"},
+            {
+             .rJet = 0.8,
+             .jetAlgo = "plugin_algorithm",
+             .jetContribAlgo = "Centauro"
+            },
+            app
+    ));
+
+    app->Add(new JOmniFactoryGeneratorT<JetReconstruction_factory<edm4eic::ReconstructedParticle>>(
+            "ReconstructedCentauroJets",
+            {"ReconstructedBreitFrameParticles"},
+            {"ReconstructedCentauroJets"},
+            {
+             .rJet = 0.8,
+             .jetAlgo = "plugin_algorithm",
+             .jetContribAlgo = "Centauro"
+            },
+            app
+    ));
+
 }
 } // extern "C"

src/services/io/podio/JEventProcessorPODIO.cc

@@ -161,6 +161,7 @@ JEventProcessorPODIO::JEventProcessorPODIO() {
 
             // Reconstructed data
             "GeneratedParticles",
+            "GeneratedBreitFrameParticles",
             "ReconstructedParticles",
             "ReconstructedParticleAssociations",
             "ReconstructedChargedParticles",
@@ -188,8 +189,10 @@ JEventProcessorPODIO::JEventProcessorPODIO() {
             "InclusiveKinematicsTruth",
             "GeneratedJets",
             "GeneratedChargedJets",
+            "GeneratedCentauroJets",
             "ReconstructedJets",
             "ReconstructedChargedJets",
+            "ReconstructedCentauroJets",
             "ReconstructedElectrons",
             "ScatteredElectronsTruth",
             "ScatteredElectronsEMinusPz",