Skip to content
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

Rename tof coordinate to toa #59

Merged
merged 8 commits into from
Oct 10, 2024
Merged

Rename tof coordinate to toa #59

merged 8 commits into from
Oct 10, 2024

Conversation

nvaytet
Copy link
Member

@nvaytet nvaytet commented Oct 10, 2024

The time-of-arrival of a neutron at the detector is commonly named time-of-flight or tof.

This name is however misleading because it is not necessarily the time the neutron spent in-flight,
since that also depends on the birth time of the neutron.

Only the arrival time is known at a neutron beamline,
and there is thus an inherent uncertainty in the birth time as neutrons can originate from any part of the pulse.
This is especially true at long-pulse neutron sources such as ESS.

We rename tof to toa in this PR to remove confusion around the definition of time-of-flight.
We keep the tofs properties and tof coordinate, and add deprecation warnings when they are accessed.

@nvaytet nvaytet requested a review from jokasimr October 10, 2024 11:23
Copy link

@jokasimr jokasimr left a comment

Choose a reason for hiding this comment

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

Looks good to me!

@nvaytet nvaytet merged commit fd6d152 into main Oct 10, 2024
3 checks passed
@nvaytet nvaytet deleted the toa branch October 10, 2024 14:27
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