Show high level summary formula string in fit function toolbox

[Anders Markvardsen]

Muon group have requested a summary display of the fit function as a summary string.

For example if a user creates the product of a Gaussian and Lorentzian plus a FlatBackground they would like it displayed as

"Gaussian*Lorentzian+Flatbackground"

This is extra eye candy since this information is also displayed in the fit function property browser using ProductFunction and CompositeFunction.

This option should be optionally, and initially be just for the muon group fit function tab.

[Nick Draper]

bulk move to assigned at the into of the triage step

[Arturs Bekasovs]

Scientists consider it quite useful. Especially for the coming training courses.

[Arturs Bekasovs]

Refs #8030. Make it possible to set a tooltip for prop without value

Changeset: 3ed784aede698acea59280ef76b934062d6d6439

[Arturs Bekasovs]

Refs #8030. Set function tooltips to their high-level structure string

Changeset: 8a0cbe0a576ad7d2111ad0640f1b88004b5e9987

[Arturs Bekasovs]

Refs #8030. Fix function removal update

Changeset: 8dbd4ec2ad265b53f734d11811036d4da6176a34

[Arturs Bekasovs]

Tester:

It was decided to show the hight-level structure string in the tooltip of the main function item in the Fit Browser. This makes it not to draw too much attention, yet be easy enough to reach, if you need to make sure you're doing the right thing. This also means you can inspect the structure of every child function as well, not of the main one only.

First of all, please verify that tooltips for function parameters are working correctly, as I've had to do a bit of work around that area (see comment:4). Is should still display parameter description as a tooltip for parameter value field.

Then verify the actual change - if you hover the mouse over the main function item (the one with the arrow), the tooltip should appear describing the function in the following way:

• If it's a CompositeFunction or a ProductFunction:
  • If it's an empty, something like "Empty CompositeFunction" should shown
  • If it isn't empty, the proper high-level structure string should be shown, like the one in the ticket's description.
• If it any other type of composite function (e.g. Convolution) or a non-composite function, a function name is shown.

Check that these tooltips are properly updated when function are added/removed.

NB: As this option seems to be quite useful and not too noticeable, I've decided to implement it for the general Fit Browser and not for Muon one only. And as it is not being show all the time and you can get only if you need it, I've decided that it's pointless to make it optional. Please let me know if you disagree with that.

[Arturs Bekasovs]

I should use "+" for pure CompositeFunction, "*" for ProductFunction and use names for other derivatives of CompositeFunction. As currently e.g. Convolution will use "+" as well, which doesn't make sense.

[Arturs Bekasovs]

Refs #8030. Show structure of base CompositeFunction only

We don't need to display structure of it's derivates (e.g. Convolution), apart from ProductFunction.

Changeset: 554abb9264d7f3805367fca41d1d83dc5d927d48

[Arturs Bekasovs]

Testing description in comment:7 updated to reflect the last change.

[Anders Markvardsen]

Merge remote-tracking branch 'origin/feature/8030_fit_browser_high_level_formula'

Full changeset: ​b147a8c9c6538bc294679eec95e89f0a1cf7306a

[Anders Markvardsen]

Tested this on musr data on general and muon fit function toolbox

[Stuart Campbell]

This ticket has been transferred to github issue ​8875