Skip to content
Snippets Groups Projects
Commit 11e88889 authored by Shahroz Ahmed's avatar Shahroz Ahmed
Browse files

engineering diffraction documentation updated - new preview section

refs #15765
parent f17a57ad
No related branches found
No related tags found
No related merge requests found
...@@ -290,6 +290,8 @@ Focused Run #: ...@@ -290,6 +290,8 @@ Focused Run #:
directory can be set in the :ref:`setting-Engineering_Diffraction-ref` directory can be set in the :ref:`setting-Engineering_Diffraction-ref`
tab under the *Focusing settings* section. tab under the *Focusing settings* section.
.. _ExpectedPeaks-Engineering_Diffraction-ref:
Peaks: Peaks:
A list of dSpacing values to be translated into TOF to find expected A list of dSpacing values to be translated into TOF to find expected
peaks. These peaks can be manually written or imported by selecting a peaks. These peaks can be manually written or imported by selecting a
...@@ -304,6 +306,9 @@ tab plots the focused workspace in the background in black, whereas the ...@@ -304,6 +306,9 @@ tab plots the focused workspace in the background in black, whereas the
expected peaks plotted in various colours over lapping the focused expected peaks plotted in various colours over lapping the focused
workspace peaks. workspace peaks.
Within the :ref:`Preview-Engineering_Diffraction-ref` section user is
able to zoom-in or zoom-out as well as select, add and save peaks.
The interface will also generate workspaces that can be inspected in the The interface will also generate workspaces that can be inspected in the
workspaces window: workspaces window:
...@@ -314,6 +319,29 @@ workspaces window: ...@@ -314,6 +319,29 @@ workspaces window:
3. The *engggui_fitting_single_peaks* workspace within each workspace 3. The *engggui_fitting_single_peaks* workspace within each workspace
index representing individual expected peak. index representing individual expected peak.
.. _Preview-Engineering_Diffraction-ref:
Preview
^^^^^^^
Once the fitting process has completed and the you are able to view a
focused workspace with listed expected peaks on the data plot, Select
Peak button should should also be enabled.
By clicking Select Peak button the peak picker tool can be activated.
To select a peak simply hold *Shift* key and left-click on the graph
near the peak's center.
To get help selecting the center of the peak, you may set the peak
width by left-click and drag horizontally, while holding *Ctrl* key
as well. User may also zoom-in to the graph by holding left-click
and dragging on the plot, whereas zoom-out by simple left-click on
the plot.
When user is satisfied with the center position of the peak, you may
add the selected peak to :ref:`ExpectedPeaks-Engineering_Diffraction-ref`
list by clicking Add Peak button. User may rerun Fit process with
the new selected peaks or save the peaks list as *CSV* file by clicking
Save Peak List button.
.. _setting-Engineering_Diffraction-ref: .. _setting-Engineering_Diffraction-ref:
Settings Settings
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment