From 4bc9dd1c15c988ee467c122ca2bc8591fdbe0cdc Mon Sep 17 00:00:00 2001
From: Shahroz Ahmed <shahroz.ahmed@stfc.ac.uk>
Date: Wed, 2 Dec 2015 14:44:57 +0000
Subject: [PATCH] engg diff doc updated with all new focus features
refs #14623
---
.../interfaces/Engineering_Diffraction.rst | 35 +++++++++++++++++--
1 file changed, 32 insertions(+), 3 deletions(-)
diff --git a/docs/source/interfaces/Engineering_Diffraction.rst b/docs/source/interfaces/Engineering_Diffraction.rst
index 6c1c9f97e8d..46b13a4ea3d 100644
--- a/docs/source/interfaces/Engineering_Diffraction.rst
+++ b/docs/source/interfaces/Engineering_Diffraction.rst
@@ -29,6 +29,9 @@ Instrument
Close
Close the interface
+RB Number
+ To enable the GUI specify a RB Number
+
Calibration
-----------
@@ -55,8 +58,11 @@ Calibration sample #
Focus
-----
-Here it is possible to focus run files, provided a run number or run
-file. The focusing process uses the algorithm :ref:`EnggFocus
+Here it is possible to focus run files, by providing a run number or a
+range of run number to enable multi-run focusing, along with that the
+user may also select the files with the help of Browse button.
+
+The focusing process uses the algorithm :ref:`EnggFocus
<algm-EnggFocus>`. In the documentation of the algorithm you can find
the details on how the input runs are focused.
@@ -73,7 +79,7 @@ Three focusing alternatives are provided:
2. Cropped focusing, where several spectra or ranges of spectra can
be specified, as a list separated by commas.
3. Texture focusing, where the *texture* group of detectors is given
- in a Detector Gropuing File.
+ in a Detector Grouping File.
Depending on the alternative chosen, the focusing operation will
include different banks and/or combinations of spectra (detectors). In
@@ -89,6 +95,10 @@ for normal focusing, *_cropped* for cropped focusing, and
*_texture_bank_1, _texture_bank_2*, and so on for texture focusing
(using the bank IDs given in the detector grouping file).
+Cropped focusing and Texture focusing have been disabled by default to
+declutter the interface, but each section can be enabled simply by
+ticking the check-box next to Focus Cropped and Focus Texture.
+
For texture focusing, the detector grouping file is a text (csv) file
with one line per bank. Each line must contain at least two numeric
fields, where the first one specifies the bank ID, and the second and
@@ -100,6 +110,25 @@ numbers. For example::
2, 100, 102, 107
3, 300, 310, 320-329, 350-370
+When a focus run process is being carried out, Focus Stop button will
+be enabled. Focus Stop button will allow the user to abort once the
+current focus run process has been completed. Inside the *Result Log*
+a warning message will be displayed with last successful run and total
+number of focus runs that could not be processed.
+
+Run-Number
+^^^^^^^^^^
+The run provided to focus can be for example 228061-228063, this will
+run all the files within the given range as long as the file
+directories are included in the
+`User Directories <http://www.mantidproject.org/SplittersWorkspace>`_.
+The user may also provide an input of 228061-3 or 228061, 228062,
+2280623 which should work the same way.
+
+If a red star sign is displayed next to the Browse Button, it is mostly
+likely because the file specified has not been found. Error message
+can be viewed by hovering over the red star sign.
+
Output
^^^^^^
--
GitLab