Renamings and documentation fixes

Author: Marcello Di Costanzo

ALICE3/ML/alice3-mlresponse3prong.h ALICE3/ML/Alice3MlResponse3Prong.hALICE3/ML/alice3-mlresponse3prong.h renamed to ALICE3/ML/Alice3MlResponse3Prong.h

@@ -9,12 +9,12 @@
 // granted to it by virtue of its status as an Intergovernmental Organization
 // or submit itself to any jurisdiction.
 
-/// \file alice3-mlresponse3prong.h
-/// \brief Class to compute the ML response for Lc+ → p K- π+ analysis selections
+/// \file Alice3MlRResponse3Prong.h
+/// \brief Class to compute the ML response for HF 3-prong candidates
 /// \author Marcello Di Costanzo <marcello.di.costanzo@cern.ch>, Polytechnic University of Turin and INFN Turin
 
-#ifndef ALICE3_ML_ALICE3_MLRESPONSE3PRONG_H_
-#define ALICE3_ML_ALICE3_MLRESPONSE3PRONG_H_
+#ifndef ALICE3_MLRESPONSE3PRONG_H_
+#define ALICE3_MLRESPONSE3PRONG_H_
 
 #include "PWGHF/DataModel/CandidateReconstructionTables.h"
 
@@ -109,10 +109,8 @@ class Alice3MlResponse3Prong : public MlResponse<TypeOutputScore>
   virtual ~Alice3MlResponse3Prong() = default;
 
   /// Method to get the input features vector needed for ML inference
-  /// \param candidate is the Lc candidate
-  /// \param prong0 is the candidate's prong0
-  /// \param prong1 is the candidate's prong1
-  /// \param prong2 is the candidate's prong2
+  /// \tparam T1 type of the 3-prong candidate
+  /// \param candidate is the 3-prong candidate
   /// \return inputFeatures vector
   template <typename T1>
   std::vector<float> getInputFeatures(T1 const& candidate)
@@ -224,7 +222,5 @@ class Alice3MlResponse3Prong : public MlResponse<TypeOutputScore>
 
 #undef FILL_MAP_3PRONG
 #undef CHECK_AND_FILL_ML_ALICE3
-#undef CHECK_AND_FILL_ML_ALICE3_HFHELPER
-#undef CHECK_AND_FILL_ML_ALICE3_OBJECT_SIGNED
 
-#endif  // ALICE3_ML_ALICE3_MLRESPONSE3PRONG_H_
+#endif  // ALICE3_MLRESPONSE3PRONG_H_

ALICE3/TableProducer/CMakeLists.txt

@@ -46,12 +46,12 @@ o2physics_add_dpl_workflow(alice3-correlatorddbar
                     PUBLIC_LINK_LIBRARIES O2Physics::AnalysisCore O2::DCAFitter
                     COMPONENT_NAME Analysis)
 
-o2physics_add_dpl_workflow(alice3-selector-3prong
-                    SOURCES alice3-selector3prong.cxx
+o2physics_add_dpl_workflow(alice3-hf-selector-3prong
+                    SOURCES alice3HfSelector3Prong.cxx
                     PUBLIC_LINK_LIBRARIES O2Physics::AnalysisCore O2::DCAFitter O2Physics::MLCore
                     COMPONENT_NAME Analysis)
 
-o2physics_add_dpl_workflow(alice3-tree-creator-3prong
-                    SOURCES alice3-treecreator3prong.cxx
-                    PUBLIC_LINK_LIBRARIES O2Physics::AnalysisCore O2::DCAFitter O2Physics::MLCore
+o2physics_add_dpl_workflow(alice3-hf-tree-creator-3prong
+                    SOURCES alice3HfTreeCreator3Prong.cxx
+                    PUBLIC_LINK_LIBRARIES O2Physics::AnalysisCore O2::DCAFitter
                     COMPONENT_NAME Analysis)

…/TableProducer/alice3-selector3prong.cxx …TableProducer/alice3HfSelector3Prong.cxxALICE3/TableProducer/alice3-selector3prong.cxx renamed to ALICE3/TableProducer/alice3HfSelector3Prong.cxx ALICE3/TableProducer/alice3-selector3prong.cxx renamed to ALICE3/TableProducer/alice3HfSelector3Prong.cxx

@@ -9,13 +9,13 @@
 // granted to it by virtue of its status as an Intergovernmental Organization
 // or submit itself to any jurisdiction.
 
-/// \file candSelectorLc.cxx
-/// \brief Λc± → p± K∓ π± selection task
+/// \file alice3HfSelector3prong.cxx
+/// \brief 3-prong candidates selection task
 ///
 /// \author Marcello Di Costanzo <marcello.di.costanzo@cern.ch>, Polytechnic University of Turin and INFN Turin
 
 #include "ALICE3/Utils/utilsHfAlice3.h"
-#include "ALICE3/Utils/utilsSelections.h"
+#include "ALICE3/Utils/utilsSelectionsAlice3.h"
 #include "PWGHF/Core/SelectorCuts.h"
 #include "PWGHF/DataModel/CandidateReconstructionTables.h"
 #include "PWGHF/DataModel/CandidateSelectionTables.h"
@@ -25,7 +25,7 @@
 #include "ALICE3/DataModel/OTFRICH.h"
 #include "ALICE3/DataModel/OTFTOF.h"
 #include "ALICE3/DataModel/RICH.h"
-#include "ALICE3/ML/alice3-mlresponse3prong.h"
+#include "ALICE3/ML/Alice3MlResponse3Prong.h"
 #include "Common/Core/TrackSelectorPID.h"
 #include "Common/DataModel/PIDResponseCombined.h"
 
@@ -150,7 +150,9 @@ struct Alice3Selector3Prong {
   }
 
   /// Conjugate-independent topological cuts
+  /// \tparam T is candidate type
   /// \param cand is cand
+  /// \param candPt is candidate pT
   /// \return true if cand passes all cuts
   template <typename T>
   bool selectionTopol(const T& cand, float candPt)
@@ -206,6 +208,13 @@ struct Alice3Selector3Prong {
     return true;
   }
 
+  /// Candidate mass selection
+  /// \tparam CharmHad is the charm hadron type
+  /// \tparam SwapHypo indicates whether to swap mass hypothesis or not
+  /// \tparam TCandidate is candidate type
+  /// \param ptBin is candidate pT bin
+  /// \param cand is candidate
+  /// \return true if candidate passes mass selection
   template <CharmHadAlice3 CharmHad, bool SwapHypo, typename TCandidate>
   bool selectionCandidateMass(int const ptBin, const TCandidate& cand)
   {
@@ -219,6 +228,7 @@ struct Alice3Selector3Prong {
   }
 
   /// Single-track dca_xy and dca_z cuts
+  /// \tparam T1 is candidate type
   /// \param cand is the Lc cand
   /// \return true if all the prongs pass the selections
   template <typename T1>
@@ -230,9 +240,10 @@ struct Alice3Selector3Prong {
   }
 
   /// Apply PID selection
-  /// \param pidTrack0 is the PID status of proton cand track
-  /// \param pidTrack1 is the PID status of kaon cand track
-  /// \param pidTrack2 is the PID status of pion cand track
+  /// \tparam CharmHad is charm hadron type
+  /// \tparam TCand is candidate type
+  /// \param cand is candidate
+  /// \param pidMask is bitmask to be configured
   template <CharmHadAlice3 CharmHad, typename TCand>
   void configurePidMask(const TCand& cand, uint32_t& pidMask)
   {
@@ -275,8 +286,9 @@ struct Alice3Selector3Prong {
   }
 
   /// \brief function to apply Lc selections
-  /// \param cands Lc cand table
-  /// \param tracks track table
+  /// \tparam CharmHad is charm hadron type
+  /// \tparam CandType is candidate type
+  /// \param cands are 3-prong candidates
   template <CharmHadAlice3 CharmHad, typename CandType>
   void runSelect3Prong(CandType const& cands)
   {

…bleProducer/alice3-treecreator3prong.cxx …leProducer/alice3HfTreeCreator3Prong.cxxALICE3/TableProducer/alice3-treecreator3prong.cxx renamed to ALICE3/TableProducer/alice3HfTreeCreator3Prong.cxx ALICE3/TableProducer/alice3-treecreator3prong.cxx renamed to ALICE3/TableProducer/alice3HfTreeCreator3Prong.cxx

@@ -9,10 +9,9 @@
 // granted to it by virtue of its status as an Intergovernmental Organization
 // or submit itself to any jurisdiction.
 
-/// \file treeCreatorDplusToPiKPi.cxx
-/// \brief Writer of D+ → π+ K- π+ cands in the form of flat tables to be stored in TTrees.
+/// \file alice3HfTreeCreator3Prong.cxx
+/// \brief Writer of 3-prong candidates in the form of flat tables to be stored in TTrees.
 ///        Intended for debug, local optimization of analysis on small samples or ML training.
-///        In this file are defined and filled the output tables
 ///
 /// \author Marcello Di Costanzo <marcello.di.costanzo@cern.ch>, Turin Polytechnic University and INFN Turin
 
@@ -309,33 +308,24 @@ struct Alice3TreeCreator3Prong {
   template <typename TCand>
   void reserveTables(size_t nCands, const TCand& cand)
   {
-    if (fillTables.fillCandVtxInfo) {
+    if (fillTables.fillCandVtxInfo)
       rowCandVtxs.reserve(nCands);
-    }
-    if (fillTables.fillCandTopoInfo) {
+    if (fillTables.fillCandTopoInfo)
       rowCandTopos.reserve(nCands);
-    }
-    if (fillTables.fillDaugTopoInfo) {
+    if (fillTables.fillDaugTopoInfo)
       rowDaugTopos.reserve(nCands);
-    }
-    if (fillTables.fillMlScoreInfo) {
+    if (fillTables.fillMlScoreInfo)
       rowCandMls.reserve(nCands);
-    }
-    if (fillTables.fillCandKineInfo) {
+    if (fillTables.fillCandKineInfo)
       rowCandKine3Ps.reserve(nCands);
-    }
-    if (fillTables.fillCandGenKineInfo) {
+    if (fillTables.fillCandGenKineInfo)
       rowCand3PGen.reserve(nCands);
-    }
-    if (fillTables.fillDaugKineInfo) {
+    if (fillTables.fillDaugKineInfo)
       rowDaugMoms.reserve(nCands);
-    }
-    if (fillTables.fillMcMatchRecoInfo) {
+    if (fillTables.fillMcMatchRecoInfo)
       rowCand3PMcMatchRec.reserve(nCands);
-    }
-    if (fillTables.fillMcMatchGenInfo) {
+    if (fillTables.fillMcMatchGenInfo)
       rowCand3PMcMatchGen.reserve(nCands);
-    }
     // PID tables
     if (fillTables.fillPid) {
       if constexpr (requires { cand.nSigTrkPi0(); })
@@ -361,6 +351,7 @@ struct Alice3TreeCreator3Prong {
 
   /// Fill reconstructed candidate tables
   /// \tparam CharmHadAlice3: charm hadron type
+  /// \tparam IsSwapMassHypo: whether to swap mass hypothesis or not
   /// \tparam T: candidate type
   /// \param cand: candidate to be used to fill the tables
   template <CharmHadAlice3 CharmHad, bool IsSwapMassHypo, typename T>
@@ -468,6 +459,7 @@ struct Alice3TreeCreator3Prong {
 
   /// Function to fill both reco and gen tables
   /// from any candidate collection
+  /// \tparam CharmHad Type of 3prong particle
   /// \tparam TCandsRec Type of reconstructed candidates collection
   /// \tparam TCandsGen Type of generated candidates collection
   /// \param candsRec Reconstructed candidates collection

ALICE3/Tasks/CMakeLists.txt

@@ -64,8 +64,8 @@ o2physics_add_dpl_workflow(alice3-multicharm
                     PUBLIC_LINK_LIBRARIES O2Physics::AnalysisCore O2Physics::MLCore
                     COMPONENT_NAME Analysis)
 
-o2physics_add_dpl_workflow(alice3-task-3prong
-                    SOURCES alice3-task3prong.cxx
+o2physics_add_dpl_workflow(alice3-hf-task-3prong
+                    SOURCES alice3HfTask3Prong.cxx
                     PUBLIC_LINK_LIBRARIES O2Physics::AnalysisCore O2Physics::SGCutParHolder O2Physics::MLCore
                     COMPONENT_NAME Analysis)
 

ALICE3/Tasks/alice3-task3prong.cxx ALICE3/Tasks/alice3HfTask3Prong.cxxALICE3/Tasks/alice3-task3prong.cxx renamed to ALICE3/Tasks/alice3HfTask3Prong.cxx

@@ -9,13 +9,13 @@
 // granted to it by virtue of its status as an Intergovernmental Organization
 // or submit itself to any jurisdiction.
 
-/// \file alice3-task3prong.cxx
+/// \file alice3HfTask3Prong.cxx
 /// \brief 3-prong candidates analysis task for ALICE 3 simulation studies
 /// \author Marcello Di Costanzo <marcello.di.costanzo@cern.ch>, Polytechnic University of Turin and INFN Turin
 
 #include "PWGHF/Core/DecayChannels.h"
 #include "ALICE3/Utils/utilsHfAlice3.h"
-#include "ALICE3/Utils/utilsSelections.h"
+#include "ALICE3/Utils/utilsSelectionsAlice3.h"
 #include "PWGHF/DataModel/CandidateSelectionTables.h"
 
 #include "ALICE3/DataModel/A3DecayFinderTables.h"
@@ -49,7 +49,7 @@
 #include <numeric>
 #include <string>
 #include <string_view>
-#include <vector> // std::vector
+#include <vector>
 
 using namespace o2;
 using namespace o2::analysis;

ALICE3/Utils/utilsSelections.h ALICE3/Utils/utilsSelectionsAlice3.hALICE3/Utils/utilsSelections.h renamed to ALICE3/Utils/utilsSelectionsAlice3.h

@@ -9,7 +9,7 @@
 // granted to it by virtue of its status as an Intergovernmental Organization
 // or submit itself to any jurisdiction.
 
-/// \file utilsSelections.h
+/// \file utilsSelectionsAlice3s.h
 /// \brief Default pT bins and cut arrays for selections in ALICE3 performance analysis tasks
 ///
 /// \author Marcello Di Costanzo <marcello.di.costanzo@cern.ch>, Polytechnic University of Turin and INFN Turin