Skip to content

Commit

Permalink
Document new options
Browse files Browse the repository at this point in the history
Refs #11561
  • Loading branch information
DanNixon committed May 7, 2015
1 parent 2431adf commit 16f9164
Showing 1 changed file with 30 additions and 0 deletions.
30 changes: 30 additions & 0 deletions Code/Mantid/docs/source/interfaces/Indirect_DataAnalysis.rst
Expand Up @@ -230,10 +230,25 @@ Plot Guess
When checked a curve will be created on the plot window based on the bitting
parameters.

Max Iterations
The maximum number of iterations that can be carried out by the fitting
algorithm (automatically increased when FABADA is enabled).

StartX & EndX
The range of :math:`x` over which the fitting will be applied (blue lines on
preview plot).

Use FABADA
Select to enable use of the :ref:`FABADA` minimizer when performing the fit.

Output Chain
Select to enable output of the FABADA chain when using FABADA as the fitting
minimizer.

Chain Length
Number of further steps carried out by fitting algorithm once parameters have
converged (see :ref:`FABADA` documentation)

Linear Background A0
The constant amplitude of the background (horizontal green line on the preview
plot).
Expand Down Expand Up @@ -350,10 +365,25 @@ Plot Guess
When checked a curve will be created on the plot window based on the bitting
parameters.

Max Iterations
The maximum number of iterations that can be carried out by the fitting
algorithm (automatically increased when FABADA is enabled).

StartX & EndX
The range of :math:`x` over which the fitting will be applied (blue lines on
preview plot).

Use FABADA
Select to enable use of the :ref:`FABADA` minimizer when performing the fit.

Output Chain
Select to enable output of the FABADA chain when using FABADA as the fitting
minimizer.

Chain Length
Number of further steps carried out by fitting algorithm once parameters have
converged (see :ref:`FABADA` documentation)

A0 & A1 (background)
The A0 and A1 parameters as they appear in the LinearBackground fir function,
depending on the Fit Type selected A1 may not be shown.
Expand Down

0 comments on commit 16f9164

Please sign in to comment.