Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update ISIS Reflectometry GUI manual testing instructions #37206

Merged
merged 3 commits into from May 2, 2024
Merged

Update ISIS Reflectometry GUI manual testing instructions #37206

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
09e0ef7
Clarify which polarization correction combo boxes are being referred …
rbauststfc Apr 24, 2024
c5f9197
Clarify save tab manual testing instructions
rbauststfc Apr 24, 2024
792b963
Update preview tab manual testing instructions
rbauststfc Apr 24, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
36 changes: 20 additions & 16 deletions dev-docs/source/Testing/ReflectometryGUI/ReflectometryGUITests.rst
View file
Open in desktop
Expand Up @@ -93,11 +93,13 @@ Polarisation Corrections
Polarisation corrections settings are under the ``Experiment Settings`` tab in the interface. These should only work with ``CRISP``, ``POLREF`` or ``OFFSPEC``.

- In the Runs tab set the instrument to ``INTER``.
- On the ``Experiment Settings`` tab, the Polarisation corrections combo box should be greyed out.
- Change the instrument to ``OFFSPEC`` and it should now be enabled. Select ``Parameter File``. The corrections combo should still be disabled.
- Switch to ``Workspace``. The ``Polarization Efficiencies`` combo box should become enabled and show a list of all loaded workspaces.
- Switch to ``FilePath``. ``Polarization Efficiencies`` should now appear as a line edit. It should appear red for invalid paths and white for valid paths on your system.
- Switch back to the ``ParameterFile`` setting.
- On the ``Experiment Settings`` tab, the ``Polarisation Corrections`` combo box should be greyed out.
- Go back to the Runs tab and set the instrument to ``OFFSPEC``.
- Back on the ``Experiment Settings`` tab, the ``Polarisation Corrections`` combo box should now be enabled and the ``Polarization Efficiencies`` combo box should be disabled.
- Select ``Parameter File`` from the ``Polarisation Corrections`` combo box. The ``Polarization Efficiencies`` combo box should still be disabled.
- Switch to ``Workspace`` from the ``Polarisation Corrections`` combo box. The ``Polarization Efficiencies`` combo box should become enabled and show a list of all loaded workspaces.
- Switch to ``FilePath`` from the ``Polarisation Corrections`` combo box. ``Polarization Efficiencies`` should now appear as a line edit. It should appear red for invalid paths and white for valid paths on your system.
- Switch back to the ``ParameterFile`` setting from the ``Polarisation Corrections`` combo box.
- Back on the ``Runs`` tab, delete all rows in the table (this can be done by pressing ``Ctrl-A`` and then ``Delete``).
- Note that this will leave an empty row. In that row enter run number ``44956`` and angle ``0.4``.
- Check you can process the row and it turns green.
Expand Down Expand Up @@ -157,8 +159,8 @@ Saving a batch
- Close and re-open the interface. Note that you should *not* be prompted about discarding unsaved changes.
- Load your saved batch file and check that the items you changed are restored.

Export as ASCII
---------------
Save tab
--------

- Load a batch file and process it, if you have not already.
- Go to the Save tab and hit Refresh. The workspaces list will contain all of the workspaces in the ADS.
Expand All @@ -176,16 +178,16 @@ Export as ASCII

- Try changing the separator to spaces or tabs and check that the 3 or 4 columns of numbers are separated using that separator.
- Change the dropdown to ``ORSO Ascii (*.ort)``. The ``Header`` checkbox, separators and parameter settings are not applicable so they should be greyed out.
- Untick ``Q resolution`` and click Save. You should get a header at the top starting with ``ORSO reflectivity data file``. There should be 3 columns of numbers with headings ``Qz``, ``R`` and ``sR``.
- Untick ``Q resolution`` and click Save. Open the ``.ort`` file that should have been created in your specified save directory. You should get a header at the top starting with ``ORSO reflectivity data file``. There should be 3 columns of numbers with headings ``Qz``, ``R`` and ``sR``.
- Tick ``Q resolution`` and re-save. The file should now contain 4 columns of numbers with headings ``Qz``, ``R``, ``sR`` and ``sQz``.
- Change the dropdown to ``3 column (*.dat)``. The settings should remain greyed out and the ``Q resolution`` checkbox should also be greyed out as it is not applicable. Click save and you should get 3 columns of numbers separated by tabs (including a leading tab). At the top there is an integer indicating the number of lines in the data.
- Change the dropdown to ``ANSTO, MotoFit, 4 Column (*.txt)``. The settings remain greyed out. Click save and you should get 4 columns of numbers separated by tabs (with no leading tab).
- Change the dropdown to ``ILL Cosmos (*.mft)``. The settings remain greyed out apart from the parameters which should now be enabled. Click save and you should get 3 columns of numbers padded by spaces (including leading spaces). There should be a header starting ``MFT`` which includes any parameters you selected, the same as the Custom format.
- Change the dropdown to ``3 column (*.dat)``. The settings should remain greyed out and the ``Q resolution`` checkbox should also be greyed out as it is not applicable. Click Save to create the ``.dat`` file. You should get 3 columns of numbers separated by tabs (including a leading tab). At the top there is an integer indicating the number of lines in the data.
- Change the dropdown to ``ANSTO, MotoFit, 4 Column (*.txt)``. The settings remain greyed out. Click Save to create the ``.txt`` file. You should get 4 columns of numbers separated by tabs (with no leading tab).
- Change the dropdown to ``ILL Cosmos (*.mft)``. The settings remain greyed out apart from the parameters which should now be enabled. Click Save to create the ``.mft`` file. You should get 3 columns of numbers padded by spaces (including leading spaces). There should be a header starting ``MFT`` which includes any parameters you selected, the same as the Custom format.

- Try entering a non-existent or invalid save path and then try to Save. You should get an error saying that the path is invalid.

Preview tab
---------------
-----------

- Go to the Reduction Preview tab.
- Type ``INTER45455`` into the ``Run`` input. Set the ``Angle`` to ``1`` and click ``Load``. The instrument view plot should display the data on a detector with four banks. Note, with this dataset, we expect an error "Detector with ID..." to be thrown at this stage.
Expand All @@ -198,17 +200,19 @@ Preview tab
- Click the drop-down on the rectangle select button and select ``Transmission``. Draw a transmission region onto the slice viewer plot. Then, in the same way, add one or more ``Background`` regions. The reduction should be re-run each time a region is added:

- You should see the tab quickly disable and re-enable.
- Another run of ``ReflectometryReductionOneAuto`` will be logged in the Messages bar.
- Another run of ``ReflectometryISISLoadAndProcess`` will be logged in the Messages bar.
- The 1D plot should update (although this is usually only noticeable when changes are made to the Signal region).

- Check that moving and resizing regions triggers a re-run of the reduction.
- Check that you can delete one of the Background regions by selecting it and pressing delete on your keyboard.
- Check that you can delete one of the Background regions by selecting it and pressing the ``Delete`` key on your keyboard.
- Click the ``Apply`` button at the bottom right of the tab. The selected regions of interest should be populated in the lookup table on the Experiment Settings tab.
- Back on the Reduction Preview tab, click the export button above the top left of the 1D plot. This should export a workspace called ``preview_reduced_ws`` to the ADS.
- Right-click the workspace and select ``Show History``:

- View the history for ``ReflectometryReductionOneAuto`` and check that the inputs for ``ProcessingInstructions``, ``BackgroundProcessingInstructions`` and ``TransmissionProcessingInstructions`` correspond to the ranges of spectra you selected.
- View the history for ``ReflectometryISISSumBanks`` and check that the input for ``ROIDetectorIDs`` matches the range of detector IDs you selected.
- In the Algorithms list, expand ``ReflectometryISISLoadAndProcess``.
- Click on ``ReflectometryReductionOneAuto`` and check in the right hand pane that the inputs for ``ProcessingInstructions``, ``BackgroundProcessingInstructions`` and ``TransmissionProcessingInstructions`` correspond to the ranges of spectra you selected.
- Expand ``ReflectometryReductionOneAuto``.
- Click on ``ReflectometryISISSumBanks`` and check that the input for ``ROIDetectorIDs`` matches the range of detector IDs you selected.

- Back in the Reflectometry interface, go to the Runs tab. In the Process Runs table on the right-hand panel of the tab, enter Run ``INTER45455`` and Angle ``1`` into the first child row. Click Process.
- Compare plots of the ``preview_reduced_ws`` (from the Preview reduction) with ``IvsQ_binned_45455`` (from the batch reduction). They should be the same.
Expand Down