Tidy up how FitPage parameter table reflects array distributions #1839
Labels
Defect
Bug or undesirable behaviour
Enhancement
Feature requests and/or general improvements
Good First Issue
Issues that are appropriate for newbies
Milestone
When polydispersity is enabled in a model, selected parameters can take on distributions of values. Array distributions (basically a simple file of weight values as a function of the chosen parameter, such as a radius) allow the User greater flexibility over the form of the distribution to be applied than simply using the built-in dispersity functions (Gaussian, Lognormal, etc), without the complexity of custom-defined distribution functions which require some coding.
The caveat is that, unlike the built-in or custom distributions, array distributions are utilised 'as supplied'; sasmodels does not shift or scale the distribution, meaning it cannot be fit/optimised. This is stated in the help docs. However, this is not reflected in the FitPage.
The unobservant User could easily miss that the parameter using an array distribution is not changing and, worse, believe that that parameter displayed actually has some meaning. It does not! This needs rectifying.
Discussions with @butlerpd and @pkienzle have suggested two options:
the quick fix would be to simply clear any values and 'grey out' the parameter that is using an array distribution.
a better fix would be to return some meaningful value characterising the chosen array distribution to the parameter table (though it would not be a fittable parameter for the reason above); the mean of the distribution would be one such parameter.
On this latter point @pkienzle comments:
The help docs for array distributions would also need updating to reflect any change made in the process of dealing with this issue.
The text was updated successfully, but these errors were encountered: