Skip to content

Add link to NXevent_data in LoadEventNexus algorithm docs #37829

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
merged 1 commit into from
Aug 20, 2024
Merged

Add link to NXevent_data in LoadEventNexus algorithm docs #37829

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
11 changes: 5 additions & 6 deletions docs/source/algorithms/LoadEventNexus-v1.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,11 @@
Description
-----------

The LoadEventNeXus algorithm loads data from an EventNexus file into an
:ref:`EventWorkspace <EventWorkspace>`. The histogram bin
boundaries depend on the setting of NumberOfBins, which by default will be the whole range of time of flight able to hold all events (in all
pixels) split into NumberOfBins linear bins, and will have their :ref:`units <Unit Factory>` set to time-of-flight.
Since it is an :ref:`EventWorkspace <EventWorkspace>`, it can be rebinned
to finer bins with no loss of data.
The LoadEventNeXus algorithm loads data from an `EventNexus file <https://manual.nexusformat.org/classes/base_classes/NXevent_data.html>`_ into an :ref:`EventWorkspace <EventWorkspace>`.
The histogram bin boundaries depend on the setting of NumberOfBins,
which by default will be the whole range of time of flight able to hold all events (in all pixels) split into NumberOfBins linear bins,
and will have their :ref:`units <Unit Factory>` set to time-of-flight.
Since it is an :ref:`EventWorkspace <EventWorkspace>`, it can be rebinned to finer bins with no loss of data.

Child algorithms used
#####################
Expand Down