Fixing overlapping labels in subplots from Fit Script Generator

[warunawickramasingha]

Description of work

There had been an overlap of subplots labels generated from the Fit Script Generator Interface and this PR is fixing that.

Fixes #37375.

To test:

1. Open the Mantid Workbench and run below script

from mantid.simpleapi import *
Load(Filename=r'irs26176_graphite002_red.nxs', OutputWorkspace='irs26176_red')

2. Select the Fit Script Generator
3. Click on Add Domain
4. Add a suitable workspace e.g. ‘irs26176_red’ from ISIS Training data
5. Add workspace Indices e.g. '0-4'
6. Right click on the Function Browser and add a Lorentzian function
7. Change the Amplitude parameter values to 1.5
8. Click Generate Script to Clipboard, and then paste into an empty python script window
9. Run the script to generate the plots
10. When the plot window is maximized, the labels should not overlap each other.

• Plots before the fix:
  

• Plots after the fix:
  

Note: Calling fig.tight_layout() before fig.subplots_adjust() could have fixed the issue. But it makes each sub plot looks smaller when the number of subplots are increased and hence it was not used.

---

Reviewer

Please comment on the points listed below (full description).
Your comments will be used as part of the gatekeeper process, so please comment clearly on what you have checked during your review. If changes are made to the PR during the review process then your final comment will be the most important for gatekeepers. In this comment you should make it clear why any earlier review is still valid, or confirm that all requested changes have been addressed.

Code Review

• Is the code of an acceptable quality?
• Does the code conform to the coding standards?
• Are the unit tests small and test the class in isolation?
• If there is GUI work does it follow the GUI standards?
• If there are changes in the release notes then do they describe the changes appropriately?
• Do the release notes conform to the release notes guide?

Functional Tests

• Do changes function as described? Add comments below that describe the tests performed?
• Do the changes handle unexpected situations, e.g. bad input?
• Has the relevant (user and developer) documentation been added/updated?

Does everything look good? Mark the review as Approve. A member of @mantidproject/gatekeepers will take care of it.

Gatekeeper

If you need to request changes to a PR then please add a comment and set the review status to "Request changes". This will stop the PR from showing up in the list for other gatekeepers.

[jhaigh0]

I think we could solve this in a more universal way.

It seems to me that the plot titles themselves could be shortened, they contain a lot of redundant information. So Output_Fitiris26176_red1_Workspace could really just be iris26176_red1. In fact, a better solution might be to label the data on the legends with iris26176_red1 rather than just Data.
Doing this will remove the need for subplot titles. I think also setting the layout as tight would be good to stop collisions at smaller scales, if you move the title information to the legends then there will be no issue of the plots becoming too small.

[warunawickramasingha]

I think we could solve this in a more universal way.

It seems to me that the plot titles themselves could be shortened, they contain a lot of redundant information. So Output_Fitiris26176_red1_Workspace could really just be iris26176_red1. In fact, a better solution might be to label the data on the legends with iris26176_red1 rather than just Data. Doing this will remove the need for subplot titles. I think also setting the layout as tight would be good to stop collisions at smaller scales, if you move the title information to the legends then there will be no issue of the plots becoming too small.

Thanks for the review @jhaigh0. I have applied the suggested change and just had a look how it would look like for an example when there are 6 plots with tight_layout. Unfortunately, it does not look good.

Instead, we can keep the titles replaced with the better legends as you've suggested and have fig.subplots_adjust(hspace=0, wspace=0.5) without doing tight_layout which will generate a plot like the one below.

unless you could suggest a different approach, I can apply this change if you are happy.

[jhaigh0]

@warunawickramasingha
You could try taking the legend out of the layout consideration, as we do in mantid internal plots.

legend = ax.legeng(args..)
legend.set_in_layout(false)

That way you should still be able to use tight layout