Feat: add more comments to producer output

Author: ariedel-cern

PWGCF/Femto/Core/baseSelection.h

@@ -283,6 +283,11 @@ class BaseSelection
   /// \param comments Vector of comment strings, one per selection threshold.
   void addComments(int observableIndex, std::vector<std::string> const& comments) { mSelectionContainers.at(observableIndex).addComments(comments); }
 
+  /// \brief Attach the same comment to every selection threshold of a specific observable.
+  /// \param observableIndex Index of the observable.
+  /// \param comment Comment string applied to all thresholds.
+  void addComments(int observableIndex, std::string const& comment) { mSelectionContainers.at(observableIndex).addComments(comment); }
+
   [[nodiscard]] bool isPassThrough() const { return mPassThrough; }
 
   /// \brief Check whether all required and optional cuts are passed.

PWGCF/Femto/Core/cascadeBuilder.h

@@ -249,6 +249,7 @@ class CascadeSelection : public baseselection::BaseSelection<float, o2::analysis
     mLambdaMassMax = filter.massLambdaMax.value;
     mRequireTof = config.requireTof.value;
     mKeepTracksWithoutTof = config.keepTracksWithoutTof.value;
+    const std::string tofComment = "requireTof = " + std::to_string(mRequireTof) + "; keepTracksWithoutTof = " + std::to_string(mKeepTracksWithoutTof);
 
     if constexpr (modes::isEqual(cascadeType, modes::Cascade::kXi)) {
       mXiMassLowerLimit = filter.massXiMin.value;
@@ -258,6 +259,7 @@ class CascadeSelection : public baseselection::BaseSelection<float, o2::analysis
       mOmegaMassUpperLimit = filter.rejectMassOmegaMax.value;
       this->addSelection(kBachelorTpcPion, cascadeSelectionNames.at(kBachelorTpcPion), config.bachelorTpcPion.value, limits::kAbsUpperLimit, true, true, false);
       this->addSelection(kBachelorTofPion, cascadeSelectionNames.at(kBachelorTofPion), config.bachelorTofPion.value, limits::kAbsUpperLimit, mRequireTof, mRequireTof, false);
+      this->addComments(kBachelorTofPion, tofComment);
     }
     if constexpr (modes::isEqual(cascadeType, modes::Cascade::kOmega)) {
       mOmegaMassLowerLimit = filter.massOmegaMin.value;
@@ -267,12 +269,15 @@ class CascadeSelection : public baseselection::BaseSelection<float, o2::analysis
       mXiMassUpperLimit = filter.rejectMassXiMax.value;
       this->addSelection(kBachelorTpcKaon, cascadeSelectionNames.at(kBachelorTpcKaon), config.bachelorTpcKaon.value, limits::kAbsUpperLimit, true, true, false);
       this->addSelection(kBachelorTofKaon, cascadeSelectionNames.at(kBachelorTofKaon), config.bachelorTofKaon.value, limits::kAbsUpperLimit, mRequireTof, mRequireTof, false);
+      this->addComments(kBachelorTofKaon, tofComment);
     }
 
     this->addSelection(kPosDauTpc, cascadeSelectionNames.at(kPosDauTpc), config.posDauTpc.value, limits::kAbsUpperLimit, true, true, false);
     this->addSelection(kNegDauTpc, cascadeSelectionNames.at(kNegDauTpc), config.negDauTpc.value, limits::kAbsUpperLimit, true, true, false);
     this->addSelection(kPosDauTof, cascadeSelectionNames.at(kPosDauTof), config.posDauTof.value, limits::kAbsUpperLimit, mRequireTof, mRequireTof, false);
     this->addSelection(kNegDauTof, cascadeSelectionNames.at(kNegDauTof), config.negDauTof.value, limits::kAbsUpperLimit, mRequireTof, mRequireTof, false);
+    this->addComments(kPosDauTof, tofComment);
+    this->addComments(kNegDauTof, tofComment);
 
     this->addSelection(kCascadeCpaMin, cascadeSelectionNames.at(kCascadeCpaMin), filter.ptMin.value, filter.ptMax.value, config.cascadeCpaMin.value, limits::kLowerFunctionLimit, true, true, false);
     this->addSelection(kCascadePaMax, cascadeSelectionNames.at(kCascadePaMax), filter.ptMin.value, filter.ptMax.value, config.cascadePaMax.value, limits::kUpperFunctionLimit, true, true, false);

PWGCF/Femto/Core/charmHadronBuilder.h

@@ -177,6 +177,7 @@ enum CharmHadronFilters {
   kEtaMax,
   kPhiMin,
   kPhiMax,
+  kUseYCut,
   kYMin,
   kYMax,
   kMassMin,
@@ -198,6 +199,7 @@ const std::unordered_map<CharmHadronFilters, std::string> charmHadronFilterNames
   {kEtaMax, "Maximum eta"},
   {kPhiMin, "Minimum phi"},
   {kPhiMax, "Maximum phi"},
+  {kUseYCut, "Use rapidity cut instead of eta cut"},
   {kYMin, "Minimum rapidity"},
   {kYMax, "Maximum rapidity"},
   {kMassMin, "Minimum invariant mass"},
@@ -266,6 +268,7 @@ class CharmHadronSelection : public baseselection::BaseSelection<float, o2::anal
         {charmHadronFilterNames.at(kEtaMax), mEtaMax},
         {charmHadronFilterNames.at(kPhiMin), mPhiMin},
         {charmHadronFilterNames.at(kPhiMax), mPhiMax},
+        {charmHadronFilterNames.at(kUseYCut), static_cast<float>(mUseYCut)},
         {charmHadronFilterNames.at(kYMin), mYMin},
         {charmHadronFilterNames.at(kYMax), mYMax},
         {charmHadronFilterNames.at(kMassMin), mMassMin},

PWGCF/Femto/Core/collisionBuilder.h

@@ -262,6 +262,7 @@ class CollisionSelection : public baseselection::BaseSelection<float, o2::analys
 
     this->addSelection(kSel8, collisionSelectionNames.at(kSel8), config.sel8.value);
     this->addSelection(kRctFlags, collisionSelectionNames.at(kRctFlags), config.rctFlags.value);
+    this->addComments(kRctFlags, "label = " + confRct.label.value + "; useZdc = " + std::to_string(confRct.useZdc.value) + "; treatLimitedAcceptanceAsBad = " + std::to_string(confRct.treatLimitedAcceptanceAsBad.value));
     this->addSelection(kNoSameBunchPileUp, collisionSelectionNames.at(kNoSameBunchPileUp), config.noSameBunchPileup.value);
     this->addSelection(kIsVertexItsTpc, collisionSelectionNames.at(kIsVertexItsTpc), config.isVertexItsTpc.value);
     this->addSelection(kIsGoodZvtxFt0VsPv, collisionSelectionNames.at(kIsGoodZvtxFt0VsPv), config.isGoodZvtxFt0VsPv.value);

PWGCF/Femto/Core/kinkBuilder.h

@@ -245,6 +245,7 @@ class KinkSelection : public baseselection::BaseSelection<float, o2::analysis::f
       mKeepTracksWithoutTof = config.keepTracksWithoutTof.value;
       this->addSelection(kChaDaughTpcProton, kinkSelectionNames.at(kChaDaughTpcProton), config.chaDauTpcProton.value, limits::kAbsUpperLimit, true, true, false);
       this->addSelection(kChaDaughTofProton, kinkSelectionNames.at(kChaDaughTofProton), config.chaDauTofProton.value, limits::kAbsUpperLimit, true, config.requireTof.value, false);
+      this->addComments(kChaDaughTofProton, "requireTof = " + std::to_string(config.requireTof.value) + "; keepTracksWithoutTof = " + std::to_string(mKeepTracksWithoutTof));
     }
 
     this->addSelection(kKinkTopoDcaMax, kinkSelectionNames.at(kKinkTopoDcaMax), config.kinkTopoDcaMax.value, limits::kUpperLimit, true, true, false);

PWGCF/Femto/Core/photonBuilder.h

@@ -40,6 +40,7 @@
 
 #include <algorithm>
 #include <array>
+#include <limits>
 #include <string>
 #include <unordered_map>
 #include <vector>
@@ -179,7 +180,9 @@ class PhotonSelection : public baseselection::BaseSelection<float, datatypes::Ph
     this->addSelection(kV0RadiusMax, photonSelectionNames.at(kV0RadiusMax), config.v0RadiusMax.value, limits::kUpperLimit, true, true, false);
     this->addSelection(kDauAbsEtaMax, photonSelectionNames.at(kDauAbsEtaMax), config.dauAbsEtaMax.value, limits::kAbsUpperLimit, true, true, false);
     this->addSelection(kPosDauTpcNSigmaEl, photonSelectionNames.at(kPosDauTpcNSigmaEl), config.dauTpcNSigmaElAbsMax.value, limits::kAbsUpperLimit, true, true, false);
+    this->addComments(kPosDauTpcNSigmaEl, "keepDaughtersWithoutTpc = " + std::to_string(mKeepDaughtersWithoutTpc));
     this->addSelection(kNegDauTpcNSigmaEl, photonSelectionNames.at(kNegDauTpcNSigmaEl), config.dauTpcNSigmaElAbsMax.value, limits::kAbsUpperLimit, true, true, false);
+    this->addComments(kNegDauTpcNSigmaEl, "keepDaughtersWithoutTpc = " + std::to_string(mKeepDaughtersWithoutTpc));
 
     this->setupSelectionHistogram<SelectionHistName>(registry);
     this->template setupFilterHistogram<FilterHistName>(
@@ -213,12 +216,17 @@ class PhotonSelection : public baseselection::BaseSelection<float, datatypes::Ph
     this->evaluateObservable(kDauAbsEtaMax, *std::max_element(etaAbsDaughters.begin(), etaAbsDaughters.end()));
 
     // TPC electron PID: evaluate only when a TPC signal is available, matching
-    // EMPhotonFilter::isSelectedSecondary(), which never rejects a daughter without TPC
+    // EMPhotonFilter::isSelectedSecondary(), which never rejects a daughter without TPC.
+    // If keepDaughtersWithoutTpc is false, feed a value that fails every limit instead of
+    // skipping evaluation entirely, so this (always mandatory) cut correctly rejects the
+    // candidate instead of silently letting it through
     auto evaluateDaughterTpcEl = [this](PhotonSels bit, bool hasTpc, float tpcNSigmaEl) {
       if (hasTpc) {
         this->evaluateObservable(bit, tpcNSigmaEl);
       } else if (mKeepDaughtersWithoutTpc) {
         this->evaluateObservable(bit, 0.f);
+      } else {
+        this->evaluateObservable(bit, std::numeric_limits<float>::max());
       }
     };
     evaluateDaughterTpcEl(kPosDauTpcNSigmaEl, posDaughter.hasTPC(), posDaughter.tpcNSigmaEl());

PWGCF/Femto/Core/selectionContainer.h

@@ -236,6 +236,13 @@ class SelectionContainer
     mComments = comments;
   }
 
+  /// \brief Attach the same comment to every threshold of this selection.
+  /// \param comment Comment string applied to all thresholds.
+  void addComments(std::string const& comment)
+  {
+    mComments = std::vector<std::string>(getNSelections(), comment);
+  }
+
   /// \brief Get comments attached to the selection thresholds.
   /// \return Vector of comment strings.
   [[nodiscard]] std::string getComment(int selectionIndex) const