Skip to content

Commit b5dff6e

Browse files
committed
update user docs
1 parent 40971d2 commit b5dff6e

File tree

3 files changed

+9
-8
lines changed

3 files changed

+9
-8
lines changed

docs/images/final_rebin_button.png

15.8 KB
Loading

docs/images/final_rebin_global.png

-39.3 KB
Binary file not shown.

docs/user/binning.rst

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -40,28 +40,29 @@ The following options allow users to fine-tune binning behavior:
4040
**Entering the Bin Width**
4141

4242

43-
**Final Rebin** (Checkbox, Per-Run or Global)
44-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
43+
**Final Rebin** (Checkbox, Per-Run)
44+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
4545

4646
- **What It Does:** Controls whether the final reduced workspace (converted to Q-space) undergoes additional rebinning.
4747
- **How It Works:**
4848

4949
- When enabled, rebinning is performed using `Q Steps`, in units of 1/Å, as the bin width.
5050
- This option is **only available** if `Constant-Q Binning` is **disabled**.
5151
- If `Constant-Q Binning` is enabled, it **takes priority** over `Final Rebin`.
52-
- If `Final Rebin` is enabled **per-run**, the `Q Steps` values can be viewed and updated in the reduction data table under the `Q-Steps` column. If it is enabled globally, it takes priority over any per-run `Q Steps` values.
52+
- If `Final Rebin` is enabled for a run, the `Q Steps` values can be viewed and updated in the reduction data table under the `Q-Steps` column.
53+
- The button `Enable final rebin for runs` enables final rebin with the same `Q Steps` value for all runs in the active reduction data table.
5354

54-
- **How to Use It:** Check this box if you want to apply final rebinning.
55+
- **How to Use It:** Check this box if you want to apply final rebinning for the active run, or use the button to enable final rebin for all runs.
5556

5657
.. figure::
57-
../images/final_rebin_global.png
58-
:alt: Final Rebin Global
58+
../images/final_rebin_button.png
59+
:alt: Enable Final Rebin for All Runs
5960

60-
**Enabling Final Rebin Globally**
61+
**Enabling Final Rebin for All Runs in the Active Reduction Data Table**
6162

6263
.. figure::
6364
../images/final_rebin_per_run.png
64-
:alt: Final Rebin Per-Run
65+
:alt: Final Rebin Per-Run Checkbox
6566

6667
**Enabling Final Rebin Per-Run**
6768

0 commit comments

Comments
 (0)