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.

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

Remove frame unwrapping and WFM code #592

Merged
merged 6 commits into from
Jan 28, 2025
Merged

Remove frame unwrapping and WFM code #592

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
205f98c
remove unwrap code
nvaytet Jan 22, 2025
14a9ef7
remove unwrap and wfm tests
nvaytet Jan 22, 2025
f501efb
remove notebooks from docs
nvaytet Jan 22, 2025
e0610da
fix test in chopper-cascade notebook
nvaytet Jan 22, 2025
7112d1b
Merge branch 'main' into remove-unwrap
nvaytet Jan 23, 2025
4545e56
remove fakes
nvaytet Jan 28, 2025
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
9 changes: 4 additions & 5 deletions docs/user-guide/chopper/chopper-cascade.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,9 @@
"\n",
"## Overview\n",
"\n",
"For the purpose of [frame unwrapping](frame-unwrapping.ipynb) as well as techniques such as wavelength-frame multiplication (WFM), we need to compute bounds of neutron arrival times.\n",
"This can be computed from the source pulse structure, the chopper configuration, and the instrument geometry.\n",
"The [chopper_cascade module](https://scipp.github.io/scippneutron/generated/modules/scippneutron.tof.chopper_cascade.html) provides utilities for computing time and wavelength bounds of a neutron pulse (or sub-pulses) propagating through a chopper cascade.\n",
"This is useful for designing chopper systems, as well as predicting the data recorded when using techniques such as wavelength-frame multiplication (WFM).\n",
"\n",
"The [chopper_cascade module](https://scipp.github.io/scippneutron/generated/modules/scippneutron.tof.chopper_cascade.html) provides utilities for this purpose.\n",
"It is currently under development and not fully functional."
]
},
Expand All @@ -22,7 +21,7 @@
"## Example: WFM chopper cascade\n",
"\n",
"As an example, consider the WFM chopper cascade from [the tof package documentation](https://tof.readthedocs.io/en/stable/short-example.html).\n",
"The choppers are defined in the `fakes` module of the `tof` package:"
"The choppers are defined in Scippneutron's `fakes.tof` submodule:"
]
},
{
Expand Down Expand Up @@ -86,7 +85,7 @@
"source": [
"## Frame unwrapping\n",
"\n",
"For unwrapping frames, we need the bounds of the entire from, to determine times at which to cut.\n",
"For unwrapping frames, we need the bounds of the entire frame, to determine times at which to cut.\n",
"Since $L_2$ can be different for every detector, this cutting time is different for every detector.\n",
"We can compute the frame bounds at a common distance, e.g., the sample, and propagate the bounds to the detectors:"
]
Expand Down
Loading