NR filter and edit cuts and selections logic by cfuselli · Pull Request #372 · XENONnT/fuse

cfuselli · 2026-01-29T10:57:04Z

This pull request makes several significant improvements and refactors to the microphysics simulation plugins, with a focus on standardizing data dependencies, expanding the available selection and cut plugins, and improving modularity for future extensions. The main changes include switching plugin dependencies from interactions_in_roi to clustered_interactions, adding a new NR (nuclear recoil) cut plugin and simulation class, and ensuring new fields (quanta_fields, electric_fields) are included in relevant summaries and outputs.

Refactoring and Standardization of Plugin Dependencies:

Updated multiple plugins (ElectricField, NestYields, BBFYields) to depend on clustered_interactions instead of interactions_in_roi, and changed their data_kind accordingly for consistency and future extensibility. [1] [2] [3] [4] [5] [6] [7]

Enhancements to Selection and Cut Plugins:

Added a new NRCut plugin that filters the microphysics summary for valid nuclear recoil (NR) events, with configurable parameters for photon/electron yields and S1/S2 area thresholds.
Introduced a new NRSimulation class that applies the NR cut, expanding the simulation capabilities for NR event studies.

Expansion of Data Fields in Summaries:

Updated the SelectionMerger plugin and related simulation classes to include quanta_fields and electric_fields in their summaries, ensuring downstream analyses have access to these quantities. [1] [2] [3]

General Plugin Improvements and Exports:

Added strax.exporter() and @export decorators to several plugins and files to improve discoverability and modularity, making it easier to extend or reuse these plugins. [1] [2]

Other Notable Changes:

Changed the output provided by the SelectionMerger plugin from interactions_in_roi to microphysics_summary, and renamed the output of MicroPhysicsSummary to microphysics_summary_AHA for clarity and consistency. [1] [2]

for more information, see https://pre-commit.ci

* Update HISTORY.md for version 1.6.1 changes * Bump version from 1.6.0 to 1.6.1 * Bump version to 1.6.1 * Bump version from 1.6.0 to 1.6.1 * Update PyPI publish action to use specific release * Upgrade pypa/gh-action-pypi-publish version Updated the version of the pypa/gh-action-pypi-publish action to v1.13.0. * Update PyPI publish action version

* Add elife to cs2 corrections * Update condition for cs2 and alt_cs2 assignment

* Bump version: 1.6.1 → 1.6.2 * Update HISTORY.md for version 1.6.2 * Update HISTORY.md to remove changelog link Removed the full changelog link from the HISTORY.md file.

Co-authored-by: Carlo Fuselli <cfuselli@nikhef.nl>

…G4 (#361) * Modified load_root_file for supporting multiple primary positions in G4 root files. * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Add elife to cs2 corrections (#368) * Add elife to cs2 corrections * Update condition for cs2 and alt_cs2 assignment * Release 1.6.2 (#369) * Bump version: 1.6.1 → 1.6.2 * Update HISTORY.md for version 1.6.2 * Update HISTORY.md to remove changelog link Removed the full changelog link from the HISTORY.md file. * Fix root input to accept both 1D primary per event and 2D * bump plugin version --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Saad el Morabit <selmorab@nikhef.nl> Co-authored-by: Carlo Fuselli <cfuselli@nikhef.nl> Co-authored-by: Minghao Liu <mhliu0001@sina.com>

* Added NR yields, updated defaut yields treatment * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Fix typo * Update test simulation config from sr1_dev to sr2_dev * Update simulation config file for microphysics context * env var in tests * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * fix precommit * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Carlo Fuselli <cfuselli@nikhef.nl>

* Make NR flag more flexible * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * bump plugin version * fix precommit --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Carlo Fuselli <cfuselli@nikhef.nl>

for more information, see https://pre-commit.ci

Copilot

Pull request overview

This pull request performs a comprehensive renaming of data kinds and function arguments from interactions_in_roi/delayed_interactions_in_roi to microphysics_summary/delayed_microphysics_summary across the fuse detector physics simulation framework. Additionally, it introduces significant architectural changes to the data pipeline, including moving yields calculation earlier in the processing chain and adding a new NR (Nuclear Recoil) event filtering capability.

Changes:

Renamed interactions_in_roi to microphysics_summary and delayed_interactions_in_roi to delayed_microphysics_summary throughout all plugins, function signatures, and data_kind declarations
Restructured the microphysics pipeline so that yields and electric field calculations occur on clustered_interactions (before selection cuts) rather than after ROI filtering
Added NRCut plugin for filtering nuclear recoil events based on expected signal characteristics
Added NRSimulation selection merger class that combines volume selection with NR-specific cuts

Reviewed changes

Copilot reviewed 23 out of 23 changed files in this pull request and generated 6 comments.

Show a summary per file

File	Description
`fuse/plugins/truth_information/surviving_clusters.py`	Updated data_kind and renamed compute method parameter from `interactions_in_roi` to `microphysics_summary`
`fuse/plugins/truth_information/peak_truth.py`	Updated compute method signature and internal variable references to use `microphysics_summary`
`fuse/plugins/truth_information/event_truth.py`	Updated compute method signature to use `microphysics_summary` parameter
`fuse/plugins/truth_information/cluster_tagging.py`	Updated data_kind and all method signatures and internal references
`fuse/plugins/micro_physics/yields.py`	Changed dependency from `interactions_in_roi` to `clustered_interactions`, moving yields calculation earlier in pipeline
`fuse/plugins/micro_physics/microphysics_summary.py`	Updated depends_on reference (contains critical bug - circular dependency)
`fuse/plugins/micro_physics/electric_field.py`	Changed to depend on and process `clustered_interactions` instead of `interactions_in_roi`
`fuse/plugins/micro_physics/cuts_and_selections/physics_cases.py`	Added new NRCut plugin with filter logic for nuclear recoil events
`fuse/plugins/micro_physics/cuts_and_selections/detector_volumes.py`	Added export decorator for VolumeSelection class
`fuse/plugins/micro_physics/cuts_and_selections/apply_selections.py`	Updated SelectionMerger to provide `microphysics_summary` and added NRSimulation class
`fuse/plugins/detector_physics/secondary_scintillation.py`	Updated data_kind mapping and compute method signature
`fuse/plugins/detector_physics/s1_photon_propagation.py`	Updated compute method parameter name
`fuse/plugins/detector_physics/s1_photon_hits.py`	Updated data_kind and compute method signature with all internal references
`fuse/plugins/detector_physics/electron_propagation.py`	Updated compute method signature and all position/field references
`fuse/plugins/detector_physics/electron_drift.py`	Updated data_kind and compute method with all internal variable references
`fuse/plugins/detector_physics/delayed_electrons/photo_ionization_electrons.py`	Updated data_kind, documentation, and compute method signature
`fuse/plugins/detector_physics/delayed_electrons/delayed_electrons_secondary_scintillation.py`	Updated data_kind mapping and method signatures
`fuse/plugins/detector_physics/delayed_electrons/delayed_electrons_s1photonhits.py`	Updated data_kind and compute method
`fuse/plugins/detector_physics/delayed_electrons/delayed_electrons_propagation.py`	Updated compute method signatures to pass renamed parameter to parent
`fuse/plugins/detector_physics/delayed_electrons/delayed_electrons_merger.py`	Updated data_kind for all merger plugins
`fuse/plugins/detector_physics/delayed_electrons/delayed_electrons_drift.py`	Updated data_kind and compute method signature
`fuse/plugins/detector_physics/csv_input.py`	Updated data_kind assignment
`fuse/common.py`	Updated color map key from `interactions_in_roi` to `microphysics_summary`

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

fuse/plugins/micro_physics/cuts_and_selections/physics_cases.py

fuse/plugins/micro_physics/yields.py

fuse/plugins/micro_physics/microphysics_summary.py

fuse/plugins/micro_physics/cuts_and_selections/physics_cases.py

This reverts commit 390a861.

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Copilot

Pull request overview

Copilot reviewed 8 out of 8 changed files in this pull request and generated 2 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-01-29T13:52:07Z

fuse/plugins/micro_physics/cuts_and_selections/physics_cases.py

+    for event_i in event_ids:
+        start_index = vertex_i
+        max_photons = 0
+        max_electrons = 0
+        prompt_photons = 0
+        number_of_nr_interactions = 0
+        start_time = mps["time"][vertex_i]
+
+        for vertex_i in range(start_index, len(mps)):
+            vertex = mps[vertex_i]
+
+            _is_a_new_event = event_i < vertex["eventid"]
+            if _is_a_new_event:
+                # Next event starts break for loop and check next event
+                break


The filter_events function assumes that all vertices with the same eventid are contiguous in the input array (lines 150-156). However, the clustered_interactions data is sorted by time (as seen in merge_cluster.py and merge_lineage.py), not by eventid. If interactions from different events have overlapping times, they may not be grouped by eventid, causing this function to process events incorrectly. Consider either: 1) sorting the input by eventid before processing, or 2) documenting the assumption that events are time-separated, or 3) using a different algorithm that doesn't assume contiguous event groups (e.g., processing all vertices and building event-based masks separately).

fuse/plugins/micro_physics/cuts_and_selections/physics_cases.py

Copilot · 2026-01-29T13:55:55Z

@cfuselli I've opened a new pull request, #373, to work on those changes. Once the pull request is ready, I'll request review from you.

… vertex (#373) * Initial plan * Fix slice index bug to include last vertex when NR ROI check fails Co-authored-by: cfuselli <62354392+cfuselli@users.noreply.github.com> * Use explicit boolean flag for better code clarity Co-authored-by: cfuselli <62354392+cfuselli@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: cfuselli <62354392+cfuselli@users.noreply.github.com>

for more information, see https://pre-commit.ci

WenzDaniel and others added 24 commits October 21, 2025 02:34

Micro clustering for NR sims

55f839b

[pre-commit.ci] auto fixes from pre-commit.com hooks

6701903

for more information, see https://pre-commit.ci

fit into selections logic

2598503

[pre-commit.ci] auto fixes from pre-commit.com hooks

45e535e

for more information, see https://pre-commit.ci

no export

4e4ae9f

add selection

7c36ad3

[pre-commit.ci] auto fixes from pre-commit.com hooks

f6d0e20

for more information, see https://pre-commit.ci

Be compatible with XENONnT/straxen#1626 (#363)

847d516

Minor fix on #363 (#364)

bc3113a

Add elife to cs2 corrections (#368)

5e8b3d5

* Add elife to cs2 corrections * Update condition for cs2 and alt_cs2 assignment

Release 1.6.2 (#369)

42241e5

* Bump version: 1.6.1 → 1.6.2 * Update HISTORY.md for version 1.6.2 * Update HISTORY.md to remove changelog link Removed the full changelog link from the HISTORY.md file.

Add noise offset (#370)

c729f0e

Add cut name to volume selection CutPlugin (#366)

949610c

Co-authored-by: Carlo Fuselli <cfuselli@nikhef.nl>

total refactoring but it works..

9e1deb9

total refactoring but it works..

a8359d6

[pre-commit.ci] auto fixes from pre-commit.com hooks

b0395c8

for more information, see https://pre-commit.ci

make microsummary kind interactions in roi

16ffa25

make microsummary kind interactions in roi

2821f6e

get rid of all interactions in roi

390a861

[pre-commit.ci] auto fixes from pre-commit.com hooks

76df1b6

for more information, see https://pre-commit.ci

cfuselli changed the title ~~Fit NR filter into cuts and selections logic~~ NR filter and edit cuts and selections logic Jan 29, 2026

cfuselli changed the base branch from nr_micro_clustering to main January 29, 2026 13:29

Merge branch 'main' into nr_micro_clustering_carlo

3cebb5e

cfuselli requested a review from Copilot January 29, 2026 13:30

Copilot started reviewing on behalf of cfuselli January 29, 2026 13:30 View session

Copilot AI reviewed Jan 29, 2026

View reviewed changes

cfuselli and others added 5 commits January 29, 2026 07:38

Revert "get rid of all interactions in roi"

f124840

This reverts commit 390a861.

Update fuse/plugins/micro_physics/cuts_and_selections/physics_cases.py

83a86cc

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

replace microphysics summary completely

ab2c841

Update fuse/plugins/micro_physics/cuts_and_selections/physics_cases.py

d919cf7

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Update fuse/plugins/micro_physics/cuts_and_selections/physics_cases.py

8018d03

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

cfuselli requested a review from Copilot January 29, 2026 13:46

Copilot started reviewing on behalf of cfuselli January 29, 2026 13:46 View session

Copilot AI reviewed Jan 29, 2026

View reviewed changes

Copilot AI mentioned this pull request Jan 29, 2026

Fix slice index bug in NR ROI filter that excluded last event's final vertex #373

Merged

5 tasks

cfuselli and others added 4 commits January 29, 2026 08:29

safe binomial

84b4549

[pre-commit.ci] auto fixes from pre-commit.com hooks

fc06597

for more information, see https://pre-commit.ci

the last binomial

998e650

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

NR filter and edit cuts and selections logic#372

NR filter and edit cuts and selections logic#372
cfuselli wants to merge 34 commits intomainfrom
nr_micro_clustering_carlo

cfuselli commented Jan 29, 2026 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Jan 29, 2026

Uh oh!

Uh oh!

Copilot AI commented Jan 29, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

Conversation

cfuselli commented Jan 29, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI Jan 29, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Copilot AI commented Jan 29, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

cfuselli commented Jan 29, 2026 •

edited

Loading