Toggle shuttercount

[JackEAllen]

Issue

Closes #2230

Description

Add a description of the changes made.

Modify Spectrum Viewer to add toggle interface for ShutterCount normalisation correction and warning icon when ShutterCount correction is toggled on, ShutterCount stacks are not loaded.

Testing

Describe the tests that were used to verify your changes.

• Manually tested on both Windows and Ubuntu
• Updated Unit tests and verified tests pass
• Update GUI screenshot tests

Acceptance Criteria

How should the reviewer test your changes?

• New Screenshot baselines for the spectrum viewer look okay
• Load the following from a ToF dataset into Mantid Imaging:
  • Sample stack
  • Open beam stack
  • Spectra file
• Open the spectrum viewer window
• Resize the default ROI to something smaller and centralised on the sample you loaded in.
• Verify that the ShutterCount checkbox is disabled and that you cannot enable ShutterCount correction.
• Apply normalisation - verify that the ShutterCount checkbox only becomes active once a valid stack has been selected.
• Apply ShutterCount correction and verify a warning Icon appears to warn that you "Need 2 selected stacks".
• Un-check ShutterCount correction and verify that the error icon is removed from window
• re-check ShutterCount correction and verify warning icon appears
• From the main window, load ShutterCounts for sample stack then check that the warning has changed to ""Need 2 different stacks" and then load the ShutterCounts for the open beam stacks "File>Load ShutterCounts file for stack..."
• Verify that the error icon is removed from the spectrum viewer window now that both ShutterCount stacks are loaded.
• Notice how the spectrum scale changes accordingly when toggling ShutterCount correction on and off.

Documentation

How have you changed the documentation to reflect your changes? All changes should be noted in the appropriate file in docs/release_notes

docs/release_notes/next/feature-2230-ShutterCount_Correction_CheckBox

[JackEAllen]

This PR changes the spectrum viewer GUI and therefore I have updated the screenshot test baselines

[coveralls]

coverage: 73.171% (-0.1%) from 73.286%
when pulling ed3c260 on toggle_shuttercount
into 7af6d74 on main.

[coveralls]

coverage: 73.157% (-0.1%) from 73.286%
when pulling 73047cd on toggle_shuttercount
into 7af6d74 on main.

[samtygier-stfc]

A small thing if its easy to fix.

• With a dataset that does not have shutter counts
• Open spectrum viewer, check "Normalise to open beam" and set norm stack
• Check "ShutterCount Correction", the error should now be displayed
• Change the Norm stack to the sample, this should the error for the norm to open beam, hides the shuttercount error, disables the shuttercount checkbox.
• Change the Norm stack back to the open beam
• Now the shutter count check box is enabled and checked, but not showing the error message.

The fix might be to uncheck the shuttercount check box when it is disabled.

[coveralls]

coverage: 73.161% (-0.1%) from 73.286%
when pulling 916851f on toggle_shuttercount
into 7af6d74 on main.

[JackEAllen]

A small thing if its easy to fix.

• With a dataset that does not have shutter counts
• Open spectrum viewer, check "Normalise to open beam" and set norm stack
• Check "ShutterCount Correction", the error should now be displayed
• Change the Norm stack to the sample, this should the error for the norm to open beam, hides the shuttercount error, disables the shuttercount checkbox.
• Change the Norm stack back to the open beam
• Now the shutter count check box is enabled and checked, but not showing the error message.

The fix might be to uncheck the shuttercount check box when it is disabled.

Thanks for noticing this one, yeah, easy to fix, just uncheck if disabled within handle_button_enabled

[coveralls]

coverage: 73.156% (-0.1%) from 73.286%
when pulling 63e838c on toggle_shuttercount
into 7af6d74 on main.

[samtygier-stfc]

Looking good. I've gone through steps on the issue plus some extra playing around.

[JackEAllen]

Looking good. I've gone through steps on the issue plus some extra playing around.

Thanks for the thorough review 👍