Skip to content
Snippets Groups Projects
Commit 586adf21 authored by Gemma Guest's avatar Gemma Guest
Browse files

Update settings tabs text and screenshots

Re #26282
parent a3ec6406
No related branches found
No related tags found
No related merge requests found
docs/source/images/ISISReflectometryInterface/event_handling_tab.png

26.6 KiB

docs/source/images/ISISReflectometryInterface/experiment_settings_tab.png

57.2 KiB

docs/source/images/ISISReflectometryInterface/processing_table.png

82.5 KiB | W: | H:

docs/source/images/ISISReflectometryInterface/processing_table.png

226 KiB | W: | H:

docs/source/images/ISISReflectometryInterface/processing_table.png
docs/source/images/ISISReflectometryInterface/processing_table.png
docs/source/images/ISISReflectometryInterface/processing_table.png
docs/source/images/ISISReflectometryInterface/processing_table.png
  • 2-up
  • Swipe
  • Onion skin
docs/source/images/ISISReflectometryInterface/row_highlighting.png

106 KiB

docs/source/images/ISISReflectometryInterface/runs_tab_processing.png

183 KiB | W: | H:

docs/source/images/ISISReflectometryInterface/runs_tab_processing.png

180 KiB | W: | H:

docs/source/images/ISISReflectometryInterface/runs_tab_processing.png
docs/source/images/ISISReflectometryInterface/runs_tab_processing.png
docs/source/images/ISISReflectometryInterface/runs_tab_processing.png
docs/source/images/ISISReflectometryInterface/runs_tab_processing.png
  • 2-up
  • Swipe
  • Onion skin
docs/source/images/ISISReflectometryPolref_event_handling_tab.png

30.5 KiB

docs/source/images/ISISReflectometryPolref_settings_tab.png

40.3 KiB

...@@ -196,7 +196,7 @@ second set in the processing table in another batch, and update the settings in ...@@ -196,7 +196,7 @@ second set in the processing table in another batch, and update the settings in
each batch accordingly. The interface will use the settings from the relevant each batch accordingly. The interface will use the settings from the relevant
batch to reduce runs in that batch's processing table. batch to reduce runs in that batch's processing table.
Menu bar Menu Bar
~~~~~~~~ ~~~~~~~~
The main menu currently just contains options for managing batches via the The main menu currently just contains options for managing batches via the
...@@ -208,7 +208,7 @@ The main menu currently just contains options for managing batches via the ...@@ -208,7 +208,7 @@ The main menu currently just contains options for managing batches via the
| New | Add a new Batch tab | | New | Add a new Batch tab |
+------------------+----------------------------------------------------------+ +------------------+----------------------------------------------------------+
Runs tab Runs Tab
~~~~~~~~ ~~~~~~~~
This section describes the different elements in the *Runs* tab. This section describes the different elements in the *Runs* tab.
...@@ -249,7 +249,7 @@ selection it will show the percentage of that selection that is complete. ...@@ -249,7 +249,7 @@ selection it will show the percentage of that selection that is complete.
.. figure:: /images/ISISReflectometryInterface/processing_table.png .. figure:: /images/ISISReflectometryInterface/processing_table.png
:class: screenshot :class: screenshot
:width: 700px :width: 800px
:align: center :align: center
:alt: The processing table :alt: The processing table
...@@ -500,7 +500,7 @@ behaviour of this is as follows: ...@@ -500,7 +500,7 @@ behaviour of this is as follows:
in the format, ``123+124+125``. in the format, ``123+124+125``.
- Rows within a group will be sorted by angle. - Rows within a group will be sorted by angle.
Failed transfers Failed Transfers
================ ================
When transferring a run from the Search table to the Processing table there may When transferring a run from the Search table to the Processing table there may
...@@ -618,27 +618,29 @@ Live data monitoring has the following requirements: ...@@ -618,27 +618,29 @@ Live data monitoring has the following requirements:
- The instrument must be on IBEX or have additional processes installed to supply the EPICS values. If it does not, you will get an error that live values could not be found for `Theta` and the slits. - The instrument must be on IBEX or have additional processes installed to supply the EPICS values. If it does not, you will get an error that live values could not be found for `Theta` and the slits.
Event Handling tab Event Handling Tab
~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~
.. figure:: /images/ISISReflectometryPolref_event_handling_tab.png .. figure:: /images/ISISReflectometryInterface/event_handling_tab.png
:alt: Showing view of the settings tab. :class: screenshot
:width: 700px
:align: center
:alt: The event handling tab
*The event handling tab*
The *Event Handling* tab can be used to analyze event workspaces. It contains four text boxes for The ``Event Handling`` tab can be used to analyze event workspaces. It contains four text boxes for
specifying uniform even, uniform, custom and log value slicing respectively. Each of these slicing specifying uniform even, uniform, custom and log value slicing respectively. Each of these slicing
options are exclusive, no more than one can be applied. If the text box for the selected slicing options are exclusive, no more than one can be applied. If the text box for the selected slicing
method is empty no event analysis will be performed, runs will be loaded using method is empty no event analysis will be performed, runs will be loaded using
:ref:`LoadISISNexus <algm-LoadISISNexus>` and analyzed as histogram workspaces. When this text box :ref:`LoadISISNexus <algm-LoadISISNexus>` and analyzed as histogram workspaces. When this text box
is not empty, runs will be loaded using :ref:`LoadEventNexus <algm-LoadEventNexus>` and the is not empty, runs will be loaded using :ref:`LoadEventNexus <algm-LoadEventNexus>` and the
interface will try to parse the user input to obtain a set of start and stop values. These define interface will try to parse the user input to obtain a set of start and stop values. These define
different time slices that will be passed on to an appropriate filtering algorithm different time slices that will be passed on to the filtering algorithms
(:ref:`FilterByTime <algm-FilterByTime>` for uniform even, uniform and custom slicing, (:ref:`GenerateEventsFilter <algm-GenerateEventsFilter>` and :ref:`FilterEvents <algm-FilterEvents>`). Each time slice will be
:ref:`FilterByLogValue <algm-FilterByLogValue>` for log value slicing). Each time slice will be
normalized by the total proton charge and reduced as described in the previous section. Note that, normalized by the total proton charge and reduced as described in the previous section. Note that,
if any of the runs in a group could not be loaded as an event workspace, the interface will load if any of the runs in a group could not be loaded as an event workspace, you will get an error message
the runs within that group as histogram workspaces and no event analysis will be performed for that and the reduction will not be performed.
group. A warning message will be shown when the reduction is complete indicating that some groups
could not be processed as event data.
The four slicing options are described in more detail below: The four slicing options are described in more detail below:
...@@ -664,51 +666,67 @@ The four slicing options are described in more detail below: ...@@ -664,51 +666,67 @@ The four slicing options are described in more detail below:
``200`` seconds after the start of the run, and the second one starting at ``200`` seconds ``200`` seconds after the start of the run, and the second one starting at ``200`` seconds
and ending at ``300`` seconds. and ending at ``300`` seconds.
- **LogValue** - Like custom slicing this takes a list of comma-separated numbers and are parsed - **LogValue** - This takes a single value which is the log value interval, and also the log name
in the same manner as shown above. The values however indicate the minimum and maximum values of
the logs we wish to filter rather than times. In addition, this takes a second entry 'Log Name'
which is the name of the log we wish to filter the run for. For example, given a run and entries which is the name of the log we wish to filter the run for. For example, given a run and entries
of ``100, 200, 300`` and ``proton_charge`` for slicing values and log name respectively, we would of ``100`` and ``proton_charge`` for slicing values and log name respectively, we would
produce two slices - the first containing all log values between ``100`` and ``200`` seconds, the produce a number of slices each with interval ``100``.
second containing all log values between ``200`` and ``300`` seconds.
Workspaces will be named with a suffix providing information about the slice, e.g
Workspaces will be named according to the index of the slice, e.g ``IvsQ_13460_slice_0``, ``IvsQ_13460_slice_1``, etc. ``IvsQ_13460_slice_50_75``, ``IvsQ_13460_slice_75_100``, etc.
Settings tab Experiment and Instrument Settings Tabs
~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. figure:: /images/ISISReflectometryPolref_settings_tab.png .. figure:: /images/ISISReflectometryInterface/experiment_settings_tab.png
:alt: Showing view of the settings tab. :class: screenshot
:width: 700px
The *Settings* tab can be used to specify options for the reduction and post-processing. :align: center
These options are used by the interface to provide argument values for the pre-processing, :alt: The experiment settings tab
processing and post-processing algorithms. Each of these respectively refer to the
following algorithms: *The experiment Settings tab*
- :ref:`CreateTransmissionWorkspaceAuto <algm-CreateTransmissionWorkspaceAuto>` The ``Experiment Settings`` and ``Instrument Settings`` tabs can be used to
(applied to **Transmission Run(s)**). specify options for the reduction and post-processing releting to a specific
- :ref:`ReflectometryReductionOneAuto <algm-ReflectometryReductionOneAuto>`, main reduction algorithm. experiment. The Experiment settings are variables that are mostly set by the
- :ref:`Stitch1DMany <algm-Stitch1DMany>` (note that at least a bin width must be user, whereas the ``Instrument Settings`` are variables relating to the
specified for this algorithm to run successfully, for instance *Params="-0.03"*). instrument used to perform the reduction. Both are populated with default
values for the current instrument. The ``Restore Defaults`` button allows you
Note that when conflicting options are specified for the reduction, i.e. different to revert the settings to the default values for the instrument.
values for the same property are specified via the *Settings* tab and the **Options**
column in the *Runs* tab, the latter will prevail. Therefore, the **ReflectometryReductionOneAuto** The majority of these options are used by the interface to provide argument
settings should be used to specify global options that will be applied to all the values for the pre-processing and reduction steps, which are handled by the
rows in the table, whereas the **Options** column will only be applicable to the algorithm: :ref:`ReflectometryISISLoadAndProcess
specific row for which those options are defined. <algm-ReflectometryISISLoadAndProcess>`
The *Settings* tab is split into two sections, **Experiment settings** and **Instrument The exception is ``Output Stitch Params``, which is used for the final
settings**. The former refers to variables set mostly by the user, while the latter stitching done by the algorithm :ref:`Stitch1DMany <algm-Stitch1DMany>`. Note
refers to variables set by the instrument used to perform the reduction. Both have however that if a bin width is not provided, for instance ``Params="-0.03"``,
a **Get Defaults** button that fills some of the variables with default values. then ``-dQ/Q`` will be used, if specified; otherwise a default value will be
For experiment settings, these are pulled from the **ReflectometryReductionOneAuto** calculated from the slits, if possible.
algorithm whereas for instrument settings, they are pulled from the current instrument
being used in the run. The **Experiment Settings** tab allows some options to be specified on a
per-angle basis, that is, to specify defaults that will apply only to runs with
If either the *Experiment* or the *Instrument* settings sections are unchecked, this will disable a specific angle. Note that matching angles are searched for within a tolerance
all the of the entries for each respective section. In addition, the reduction will not make use of of ``0.01``. In the per-angle defaults table, you can also specify a "wildcard"
the values from any of the disabled entries. row, which will apply to all runs that don't also have a matching angle - just
leave the angle blank to create a wildcard row. Only one wildcard row may
exist.
.. figure:: /images/ISISReflectometryInterface/workflow_settings.png
:class: screenshot
:width: 800px
:align: center
:alt: The per-angle defaults table
*The per-angle defaults table*
Note that when conflicting options are specified for the reduction,
i.e. different values for the same property are specified via one of the
settings tabs and the cells in the *Runs* tab, the latter will take
precedence. Therefore, the Settings tabs should be used to specify
global options that will be applied to all the rows in the table, whereas the
row values will only be applicable to the specific row for which those options
are defined.
Save ASCII tab Save ASCII tab
~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~
......
...@@ -127,7 +127,7 @@ Additional keyboard shortcuts have been added to aid navigation/editing in the r ...@@ -127,7 +127,7 @@ Additional keyboard shortcuts have been added to aid navigation/editing in the r
Processing and highlighting Processing and highlighting
^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. figure:: ../../images/ISISReflectometryInterface/row_highlighting.png .. figure:: ../../images/ISISReflectometryInterface/processing_table.png
:class: screenshot :class: screenshot
:width: 650px :width: 650px
:align: center :align: center
......
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