Skip to content

Reduction workflow for ess nmx files #146

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.

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

Open
wants to merge 14 commits into
base: main
Choose a base branch
from
Open

Reduction workflow for ess nmx files #146

wants to merge 14 commits into from

Conversation

YooSunYoung
Copy link
Member

This is a workflow for actual nexus files collected with our filewriter.

It also has a helper to ignore empty logs but I can't guarantee that it always works.
for example, if any of the transformation is empty and one of transformation is time dependent, then the whole transformation is time dependent, therefore we can't really decide the rotation matrix.

However, it's little likely to happen.

@YooSunYoung YooSunYoung requested a review from aaronfinke June 19, 2025 11:12
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@aaronfinke this is the whole workflow for the real nmx nexus files.

You can use similar command line like mcstas workflow after installing this branch with pip:

pip install -e .
essnmx-reduce \
  --input_file docs/user-guide/977695_00052796.hdf \
  --output_file scipp_out.h5 \
  --verbose \
  --detector_ids 0 \
  --chunk_size 1_000

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I didn't use sciline in this case or our generic workflow since it's a very simple workflow.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Getting the following error when trying to process one of Doro's files:

Traceback (most recent call last):
  File "/Users/aaronfinke/miniforge3/envs/scipp/bin/essnmx-reduce", line 8, in <module>
    sys.exit(main())
             ~~~~^^
  File "/Users/aaronfinke/essnmx/src/ess/nmx/executables.py", line 387, in main
    reduction(
    ~~~~~~~~~^
        input_file=input_file,
        ^^^^^^^^^^^^^^^^^^^^^^
    ...<8 lines>...
        logger=logger,
        ^^^^^^^^^^^^^^
    )
    ^
  File "/Users/aaronfinke/essnmx/src/ess/nmx/executables.py", line 287, in reduction
    toa_bin_edges = toa_bin_edges.to(unit=da.bins.coords['event_time_offset'].unit)
  File "/Users/aaronfinke/miniforge3/envs/scipp/lib/python3.13/site-packages/scipp/core/operations.py", line 293, in to
    raise ValueError("Must provide dtype or unit or both")
ValueError: Must provide dtype or unit or both

Copy link
Member Author

@YooSunYoung YooSunYoung Jun 26, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@aaronfinke
Hmm... strange... I tried all three files but it was okay.

I did find some bugs so I updated this branch yesterday though. Did you pull the changes?

Also, if you need to quickly have the 2d plot, here is the code snippet:

%matplotlib widget

import plopp as pp
import scippnexus as snx

with snx.File('/Users/sunyoungyoo/ESS/essnmx/testfile-20250625-192510.hdf') as f:
    dg = f['/entry/instrument/detector_panel_0/'][()]
    display(dg)
    display(dg['data'])
    da_2d = dg['data'].hist()
    da_3d = dg['data'].hist(event_time_offset=50)


display(pp.plot(da_2d, norm='log', title="2D Histogram of Detector Data"))
pp.slicer(
    da_3d,
    title="3D Histogram of Detector Data",
    norm='log',
    keep=['x_pixel_offset', 'y_pixel_offset'],
)

@@ -22,6 +22,73 @@
)


def _fallback_compute_positions(dg: sc.DataGroup) -> sc.DataGroup:
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is the hack we need to handle the empty nxlogs.

)


def calculate_number_of_chunks(detector_gr: snx.Group, *, chunk_size: int = 0) -> int:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We need to check how the filewriter is writing to HDF5. If it is writing data in chunks already, we should just use that. It's more efficient

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes we talked about implementing iter_chunk on scippnexus with our team.
So I'll apply it here once it's done.

Either way, we'll allow both since even the chunk might not fit in the memory for some reason...

@YooSunYoung
Copy link
Member Author

@aaronfinke I have tried this with the data that Doro gave me (/dmsc/scipp/nmx/cern_202506/testfile-20250625-192510.hdf)
and then found some bugs so fixed them...!

This one only has one detector so I didn't plot them in 3 D but indeed it'll be nice to be able to plot them in 3 D without Dials... So I'll prioritize #141 this one

@YooSunYoung
Copy link
Member Author

The error was because of this:

https://scipp.github.io/development/adr/0019-binned-data-unit-dtype-python-properties.html

I added the lower pin of scipp...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants