Skip to content

[PWGCF] Fixes in femto framework #17007

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ariedel-cern merged 9 commits into from
Jul 10, 2026
Merged

[PWGCF] Fixes in femto framework #17007

Show file tree
Hide file tree
Changes from 8 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
c4d1e20
Feat: add multiplicity estimation for mc only case
ariedel-cern Jul 9, 2026
da2c876
Feat: add histograms for filters
ariedel-cern Jul 10, 2026
0c78a63
Feat: update cutculator
ariedel-cern Jul 10, 2026
85c6436
Please consider the following formatting changes
alibuild Jul 10, 2026
56e0f93
Merge pull request #23 from alibuild/alibot-cleanup-17007
ariedel-cern Jul 10, 2026
2c6903f
Fix: fix linter error
ariedel-cern Jul 10, 2026
626ae19
Fix: fix linter error
ariedel-cern Jul 10, 2026
a91217e
Feat: silence import error
ariedel-cern Jul 10, 2026
aeed455
Fix: fix includes
ariedel-cern Jul 10, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
146 changes: 119 additions & 27 deletions PWGCF/Femto/Core/baseSelection.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,11 @@
#include <ios>
#include <sstream>
#include <string>
#include <string_view>
#include <utility>
#include <vector>

namespace o2::analysis::femto
namespace o2::analysis::femto::baseselection
{

/// \class BaseSelection
Expand All @@ -54,6 +56,11 @@ class BaseSelection
/// \brief Destructor
virtual ~BaseSelection() = default;

void init(bool passThrough)
{
mPassThrough = passThrough;
}

/// \brief Add a static-value based selection for a specific observable.
/// \param observableIndex Index of the observable.
/// \param selectionName Name of the selection.
Expand All @@ -75,9 +82,14 @@ class BaseSelection
LOG(fatal) << "Observable is not valid. Observable (index) has to be smaller than " << NumObservables;
}
// init selection container for selection at given index
mSelectionContainers.at(observableIndex) = SelectionContainer<T, BitmaskType>(selectionName, selectionValues, limitType, skipMostPermissiveBit, isMinimalCut, isOptionalCut);

init(observableIndex);
mSelectionContainers.at(observableIndex) = selectioncontainer::SelectionContainer<T, BitmaskType>(selectionName,
selectionValues,
limitType,
mPassThrough ? false : skipMostPermissiveBit,
mPassThrough ? false : isMinimalCut,
mPassThrough ? false : isOptionalCut);

addSelection(observableIndex);
}

/// \brief Add a function-based selection for a specific observable.
Expand All @@ -103,9 +115,15 @@ class BaseSelection
if (static_cast<std::size_t>(observableIndex) >= NumObservables) {
LOG(fatal) << "Observable is not valid. Observable (index) has to be smaller than " << NumObservables;
}
mSelectionContainers.at(observableIndex) = SelectionContainer<T, BitmaskType>(selectionName, lowerLimit, upperLimit, functions, limitType, skipMostPermissiveBit, isMinimalCut, isOptionalCut);

init(observableIndex);
mSelectionContainers.at(observableIndex) = selectioncontainer::SelectionContainer<T, BitmaskType>(selectionName,
lowerLimit,
upperLimit,
functions,
limitType,
mPassThrough ? false : skipMostPermissiveBit,
mPassThrough ? false : isMinimalCut,
mPassThrough ? false : isOptionalCut);
addSelection(observableIndex);
}

/// \brief Add a static-value based selection for a specific observable.
Expand All @@ -128,9 +146,13 @@ class BaseSelection
LOG(fatal) << "Observable is not valid. Observable (index) has to be smaller than " << NumObservables;
}
// init selection container for selection at given index
mSelectionContainers.at(observableIndex) = SelectionContainer<T, BitmaskType>(selectionName, selectionRanges, skipMostPermissiveBit, isMinimalCut, isOptionalCut);
mSelectionContainers.at(observableIndex) = selectioncontainer::SelectionContainer<T, BitmaskType>(selectionName,
selectionRanges,
mPassThrough ? false : skipMostPermissiveBit,
mPassThrough ? false : isMinimalCut,
mPassThrough ? false : isOptionalCut);

init(observableIndex);
addSelection(observableIndex);
}

/// \brief Add a boolean-based selection for a specific observable.
Expand All @@ -144,23 +166,28 @@ class BaseSelection
std::string const& selectionName,
int mode)
{
if (mPassThrough) {
mSelectionContainers.at(observableIndex) = selectioncontainer::SelectionContainer<T, BitmaskType>(selectionName, std::vector<T>{1}, limits::LimitType::kEqual, false, false, false);
return;
}

switch (mode) {
case -1: // cut is optional and we store a bit for it
mSelectionContainers.at(observableIndex) = SelectionContainer<T, BitmaskType>(selectionName, std::vector<T>{1}, limits::LimitType::kEqual, false, false, true);
mSelectionContainers.at(observableIndex) = selectioncontainer::SelectionContainer<T, BitmaskType>(selectionName, std::vector<T>{1}, limits::LimitType::kEqual, false, false, true);
break;
case 0: // cut is disabled; initialize with empty vector so evaluation bails out early
mSelectionContainers.at(observableIndex) = SelectionContainer<T, BitmaskType>(selectionName, std::vector<T>{}, limits::LimitType::kEqual, false, false, false);
mSelectionContainers.at(observableIndex) = selectioncontainer::SelectionContainer<T, BitmaskType>(selectionName, std::vector<T>{}, limits::LimitType::kEqual, false, false, false);
break;
case 1: // mandatory cut; only one threshold so the most permissive bit is skipped and no extra bit is stored
mSelectionContainers.at(observableIndex) = SelectionContainer<T, BitmaskType>(selectionName, std::vector<T>{1}, limits::LimitType::kEqual, true, true, false);
mSelectionContainers.at(observableIndex) = selectioncontainer::SelectionContainer<T, BitmaskType>(selectionName, std::vector<T>{1}, limits::LimitType::kEqual, true, true, false);
break;
case 2: // pass through mode; cut is neither minimal nor optional and we store all bits
mSelectionContainers.at(observableIndex) = SelectionContainer<T, BitmaskType>(selectionName, std::vector<T>{1}, limits::LimitType::kEqual, false, false, false);
mSelectionContainers.at(observableIndex) = selectioncontainer::SelectionContainer<T, BitmaskType>(selectionName, std::vector<T>{1}, limits::LimitType::kEqual, false, false, false);
break;
default:
LOG(fatal) << "Invalid switch for boolean selection";
}
init(observableIndex);
addSelection(observableIndex);
}

/// \brief Update the limits of a function-based selection for a specific observable.
Expand Down Expand Up @@ -255,10 +282,15 @@ 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); }

[[nodiscard]] bool isPassThrough() const { return mPassThrough; }

/// \brief Check whether all required and optional cuts are passed.
/// \return True if all minimal cuts pass and, if optional cuts are present, at least one of them passes.
[[nodiscard]] bool passesAllRequiredSelections() const
{
if (mPassThrough) {
return true;
}
if (mHasMinimalSelection && !mHasOptionalSelection) {
return mPassesMinimalSelections;
}
Expand Down Expand Up @@ -363,7 +395,6 @@ class BaseSelection
LOG(info) << " Selections:";

for (std::size_t j = 0; j < container.getNSelections(); ++j) {

std::stringstream line;
std::string sel = container.getValueAsString(j);
std::string comment = container.getComment(j);
Expand Down Expand Up @@ -392,9 +423,12 @@ class BaseSelection
/// \tparam HistName Name of the histogram to create in the registry.
/// \param registry Pointer to the histogram registry.
template <auto& HistName>
void setupContainers(o2::framework::HistogramRegistry* registry)
void setupSelectionHistogram(o2::framework::HistogramRegistry* registry)
{
mHistRegistry = registry;
if (!mHistRegistry) {
mHistRegistry = registry;
}

// create histogram with one bin per selection, plus two summary bins (all analyzed, all passed)
int nBins = mNSelection + 2;
mHistRegistry->add(HistName, "; Selection Bits; Entries", o2::framework::HistType::kTH1F, {{nBins, -0.5, nBins - 0.5}});
Expand All @@ -418,8 +452,64 @@ class BaseSelection
mHistRegistry->get<TH1>(HIST(HistName))->GetXaxis()->SetBinLabel(mNSelection + 2, "All passed");
}

/// \brief Setup a histogram tracking how many candidates pass each individual filter bound.
/// \tparam FilterHistName Name of the histogram (must be unique in registry).
/// \param registry Pointer to the histogram registry.
/// \param filters Ordered list of (name, value) pairs, one per filter bound. The position in
/// this vector must match the caller's filter enum values (e.g. filters[kPtMin]
/// describes the kPtMin bound), since that's what fillFilter() indexes into.
template <auto& FilterHistName>
void setupFilterHistogram(o2::framework::HistogramRegistry* registry,
std::vector<std::pair<std::string, T>> const& filters)
{
if (!mHistRegistry) {
mHistRegistry = registry;
}

mNFilters = filters.size();
// two extra bins: "All analyzed" and "All passed", mirroring setupContainers()
registry->add(FilterHistName, "; Filter; Entries", o2::framework::HistType::kTH1F,
{{static_cast<int>(mNFilters) + 2, -0.5, static_cast<double>(mNFilters) + 1.5}});

auto* axis = registry->get<TH1>(HIST(FilterHistName))->GetXaxis();
for (std::size_t i = 0; i < mNFilters; ++i) {
std::ostringstream label;
label << "FilterName" << selectioncontainer::ValueDelimiter << filters[i].first << selectioncontainer::SectionDelimiter
<< "FilterValue" << selectioncontainer::ValueDelimiter << filters[i].second;
axis->SetBinLabel(static_cast<int>(i) + 1, label.str().c_str());
}
axis->SetBinLabel(static_cast<int>(mNFilters) + 1, "All analyzed");
axis->SetBinLabel(static_cast<int>(mNFilters) + 2, "All passed");
}

/// \brief Fill one bin of the filter histogram if the corresponding filter bound was passed.
/// \tparam FilterHistName Name of the histogram (same one passed to setupFilterHistogram).
/// \param filterIndex Index of the filter bound (an enum value from the caller's filter enum).
/// \param passed Whether the candidate passed this specific filter bound.
template <auto& FilterHistName>
void fillFilter(int filterIndex, bool passed) const
{
if (passed) {
mHistRegistry->fill(HIST(FilterHistName), filterIndex);
}
}

/// \brief Fill the two summary bins of the filter histogram: called once per candidate,
/// after all individual filter bounds have been checked.
/// \tparam FilterHistName Name of the histogram (same one passed to setupFilterHistogram).
/// \param passedAll Whether the candidate passed every configured filter bound.
template <auto& FilterHistName>
void fillFilterSummary(bool passedAll) const

{
mHistRegistry->fill(HIST(FilterHistName), static_cast<double>(mNFilters));
if (passedAll || mPassThrough) {
mHistRegistry->fill(HIST(FilterHistName), static_cast<double>(mNFilters) + 1);
}
}

protected:
void init(int observableIndex)
void addSelection(int observableIndex)
{
// check if any selections are configured
if (mSelectionContainers.at(observableIndex).isEmpty()) {
Expand All @@ -445,15 +535,17 @@ class BaseSelection
}

o2::framework::HistogramRegistry* mHistRegistry = nullptr;
std::array<SelectionContainer<T, BitmaskType>, NumObservables> mSelectionContainers = {}; ///< Array of selection containers, one per observable
std::bitset<sizeof(BitmaskType) * CHAR_BIT> mFinalBitmask = {}; ///< Assembled bitmask combining all observable selections
std::size_t mNSelectionBits = 0; ///< Number of bits occupied in the bitmask (excludes skipped most-permissive bits)
std::size_t mNSelection = 0; ///< Total number of configured selection thresholds across all observables
bool mHasMinimalSelection = false; ///< True if at least one observable has a mandatory (minimal) cut configured
bool mPassesMinimalSelections = true; ///< True if all mandatory (minimal) cuts have been passed so far
bool mHasOptionalSelection = false; ///< True if at least one observable has an optional cut configured
bool mPassesOptionalSelections = false; ///< True if at least one optional cut has been passed
std::array<selectioncontainer::SelectionContainer<T, BitmaskType>, NumObservables> mSelectionContainers = {}; ///< Array of selection containers, one per observable
std::bitset<sizeof(BitmaskType) * CHAR_BIT> mFinalBitmask = {}; ///< Assembled bitmask combining all observable selections
std::size_t mNSelectionBits = 0; ///< Number of bits occupied in the bitmask (excludes skipped most-permissive bits)
std::size_t mNSelection = 0; ///< Total number of configured selection thresholds across all observables
std::size_t mNFilters = 0; ///< Total number of configured (pre)filter
bool mHasMinimalSelection = false; ///< True if at least one observable has a mandatory (minimal) cut configured
bool mPassesMinimalSelections = true; ///< True if all mandatory (minimal) cuts have been passed so far
bool mHasOptionalSelection = false; ///< True if at least one observable has an optional cut configured
bool mPassesOptionalSelections = false; ///< True if at least one optional cut has been passed
bool mPassThrough = false;
};
} // namespace o2::analysis::femto
} // namespace o2::analysis::femto::baseselection

#endif // PWGCF_FEMTO_CORE_BASESELECTION_H_
Loading
Loading