Interpreting existing gui actions

[Owen Arnold]

Actions following #10303

• Process without truncating the decimal places. For display, display at 3 dp. Add an option to change the number of dps reported.
• Don't use magic numbers ​​https://github.com/mantidproject/mantid/blob/master/Code/Mantid/scripts/Interface/ui/reflectometer/refl_gui.py#L988-989. But do put a comment in all parameter files for the instruments POLREF, INTER, SURF, CRISP where LambdaMin, LambdaMax occur to indicate that these are hard limits, and will not be adjusted in software.
• Regarding ​https://github.com/mantidproject/mantid/blob/master/Code/Mantid/scripts/Interface/ui/reflectometer/refl_gui.py#L765 we should have NO magic qmax range for the last angle.
• Output workspaces SHOULD keep the new name format IvsQ_{run_number}

All these changes should apply to the new reflectometry GUI. Do not retrospectively fix the old gui.

[Owen Arnold]

(In #10303) All actions agreed and answered. Ticket created #10347. No code changes.

[Harry Jeffery]

Option for rounding/truncating requires #10237 to be in place first.

[Harry Jeffery]

Refs #10347 Use declarative bindings in options dialog

Instead of manually having to load/save options to/from widgets in QtReflOptionsDialog, we now load/save options using a map binding options to widgets. It may seem overkill for just one option, but when we have fifteen to twenty it'll greatly simplify our life.

It could be expanded in future to build the bindings from widget properties in the UI file, so new options need not even touch QtReflOptionsDialog's code.

Changeset: 750be02b6236777d0f2844e42825ada770acb893

[Harry Jeffery]

Refs #10347 Add rounding options

Users may now individually specify what level of rounding is applied to the angle, qmin, qmax, and resolution columns.

Changeset: 59e9d1f09b18fbea29a837e8288305af25415e60

[Harry Jeffery]

Refs #10347 Add option for warning when discarding changes

Changeset: 265487c8894d3d3ea356823b9b2adf4ac6bd4bc1

[Harry Jeffery]

Refs #10347 Automatically bind options to widgets

Use the reflOptionName property on a widget to specify the option its value should control.

Changeset: b384245252303224b054806cf829998b31574cef

[Harry Jeffery]

Refs #10347 Remove "Apply" button from options dialog

It has no advantage over the "Ok" button. The dialog forces itself to remain in the foreground, so nothing can happen between the user hitting "Apply" and closing the dialog. We may as well be tidy and remove it.

Changeset: b86b82205a8e48ce9053f064db44ef6571611e61

[Harry Jeffery]

Refs #10347 Correct unit tests

Now that we are not rounding by default, the expected values for unit testing need to be updated.

Changeset: 4344828ad5937d7b1343f4211d6fa69741183ce8

[Harry Jeffery]

Refs #10347 Use TS_ASSERT_DELTA

Changeset: fe12e9463c1e233c0f29ea358f28c0603f9a90ef

[Harry Jeffery]

Testing

• Try out the updated options dialog
  • Check the rounding options work
  • Check the options are all loaded/saved correctly
• Verify unit tests are passing

[Harry Jeffery]

Merge branch 'master' into feature/10347_refl_interpret_existing_actions

Refs #10347

Conflicts:

Code/Mantid/MantidQt/CustomInterfaces/src/ReflMainViewPresenter.cpp Code/Mantid/MantidQt/CustomInterfaces/test/ReflMainViewPresenterTest.h

Changeset: f8fc6bff8960370d71934525961b890449d10234

[Federico M Pouzols]

All looks fine. I verified that:

• options persist between dialog runs and MantidPlot runs (and spin boxes' values are saved regardless of whether their checked on/off)

• the rounding works well, (very convenient!) and multiple runs with different digit settings produce the same results

• tests pass

• output workspaces are named IvsQ_{run_number}

• other errors that a lousy user (me) could make are handled gracefully

• the code looks sound and well organized. The options map binding will keep the code tidy and potentially save a lot of hassle in the future

---

One minor point that could be checked later, as the refl gui grows: the rounding options (QSpinBoxes) accept values in the range [0,99] but I understand that in practice Mantid algorithms work in double precision, so 15-16 digits would be the very maximum. Also, that's what you see in the end no matter how high you set the rounding options. The spin boxes max property could be set accordingly.

Another minor point: I understand the number of options may grow a lot. Users tend to get lost after modifying too many options. At some point it may become convenient to add a 'restore default options'.

[Harry Jeffery]

Merge branch 'master' into feature/10347_refl_interpret_existing_actions

Refs #10347

Conflicts:

Code/Mantid/MantidQt/CustomInterfaces/src/ReflMainViewPresenter.cpp Code/Mantid/MantidQt/CustomInterfaces/test/ReflMainViewPresenterTest.h

Full changeset: ​f8fc6bff8960370d71934525961b890449d10234

[Federico Montesino Pouzols]

Merge remote-tracking branch 'origin/feature/10347_refl_interpret_existing_actions'

Full changeset: ​923f69300554dfb498411c0aeae71201673ed18f

[Stuart Campbell]

This ticket has been transferred to github issue ​11189