DrILL interface¶

Interface overview¶

The DrILL main window is composed of different parts:

spreadsheet like table (1)

This is the main part of the DrILL interface. Generally one row represents one sample measured at one or more distances (SANS) or angles (Reflectometry). There is no limit on the number of the different configurations. It is used to provide filenames and options to the reduction algorithm.

tool buttons (2)

In two different places. At the top of the table, these buttons facilitate the table filling and provide the instrument and acquisition mode selections. At the bottom, they are linked to the processing actions.

menu bar (3)

Most of the actions are accessible through this menu bar.

A global settings dialog is also accessible through the menu or its dedicated tool button. This dialog contains more options for the reduction algorithm.

Data reduction algorithm¶

The underlying data reduction algorithm depends on the experimental technique. Its selection is triggered when one has selected the instrument and the acquisition mode.

To get further information on the currently supported algorithms:

• SANS: SANSILLAutoProcess
• Reflectometry: ReflectometryILLAutoProcess

Global settings¶

Global settings are grouped in a dedicated dialog. This dialog is accessible in the DrILL menu (File -> Settings) or with the dedicated tool button. This dialog is dynamically linked to the selected algorithm, therefore to the instrument and acquisition mode. It contains a set of options that will be used for all the samples.

When opening the dialog for the first time, the settings are set to their default value (see the corresponding algorithm documentation). After modifying the settings, one can save or discard them with the usual three buttons ‘ok’, ‘apply’ or ‘cancel’.

Each time a setting is changed in the dialog, its value is checked. A wrong value will turn red the corresponding field. A tooltip explaining the error is displayed when the mouse is over that red field. A single red field prevents the settings from being saved.

Table filling¶

When selecting the instrument and the acquisition mode, the table is updated with the needed column headers. To obtain information about a column, a tooltip is displayed when moving the mouse over the corresponding header.

Each cell can be edited manually or filled programmatically by using some of the tool buttons.

cut-copy-paste

Cell or row contents can be copied/cut and then pasted in other cells. These actions are accessible through the dedicated button, the menu or the usual keyboard shortcuts. Copying or cutting a single cell and pasting it in several cells will repeat the value.

increment fill

An automatic filling mechanism facilitates the filling of the table by incrementing/decrementing the numors over selected cells. To do so, the user has to select several cells that he wants to fill, choose an increment value and press the fill tool button. The value in the first cell (the one with the lowest row and column index) will be incremented and written in the following ones.

For all algorithms, the last column of the table is always labelled CustomOptions. It makes it possible to override a global parameter for the current row only. It should contain a semicolon separated list of key value pairs. For example, one can set SampleThickness=0.2;ThetaDependant=False and override the global values of these parameters for that specific row.

When filling the table, all parameters (including the custom options) are checked for validity. When a value is not valid, the cell turns red and a tooltip (visible when the mouse moves over the cell) explains the error. A single red cell prevent the processing of the concerned row.

Processing¶

Processing control is made through the menu (Process) or the tool buttons at the bottom of the table. One can start the processing (of selected or all row(s)) or abort a running processing.

During processing, the table is in read-only mode. The active row(s) turn yellow, the processed ones turn green and the row(s) for which the processing failed turn red. The progress bar is also updated.

At the end of the processing, if any error occurs, a popup lists the concerned row(s). To get further information about the errors, one has to look into the Mantid logs.

Import and export as Rundex file¶

Rundex file (*.mrd) is a human readable text file that represents the state of the interface in JSON format. By using the appropriate tool button or the menu bar (File -> Save… or Load…) one can export or import a Rundex file.

When saving, the global settings, all the samples and some of the visual setup are exported in the rundex file. Symmetrically, the load action imports all these data in the current DrILL session.

Category: Interfaces