Skip to content

Commit

Permalink
Document options for minimizer string
Browse files Browse the repository at this point in the history
Refs #11651
  • Loading branch information
DanNixon committed May 1, 2015
1 parent ed5a4c3 commit 9e5f0f8
Showing 1 changed file with 23 additions and 4 deletions.
27 changes: 23 additions & 4 deletions Code/Mantid/docs/source/algorithms/PlotPeakByLogValue-v1.rst
Expand Up @@ -53,7 +53,7 @@ Output workspace format
:alt: PlotPeakByLogValue_Output.png

PlotPeakByLogValue\_Output.png

In this example a group of three Matrix workspaces were fitted with a
:ref:`Gaussian <func-Gaussian>` on a linear background.

Expand All @@ -64,19 +64,38 @@ columns with parameter values and fitting errors. If a parameter was
fixed or tied the error will be zero. Here is an example of the output
workspace:

Minimizer setup
###############

It is possible to supply a fully configured minimizer via the Minimizer
property, this can also include several flags that are used to indicate the
workspace name and spectrum index that has been fitted (useful for fitting using
a minimizer that output workspaces (i.e. FABADA)).

The possible flags are:

:code:`$wsname`
The name of the workspace being fitted

:code:`$wsindex`
The index of the spectrum being fitted

:code:`$basename`
A convinience flag for :code:`$wsname_$wsindex` (the same format the fit
result and parameter output takes)

Usage
-----

**Example - fitting a single spectrum of in a workspace:**
**Example - fitting a single spectrum of in a workspace:**

.. testcode:: ExPlotPeakByLogValueSimple

ws = CreateSampleWorkspace()
function = "name=Gaussian,Height=10.0041,PeakCentre=10098.6,Sigma=48.8581;name=FlatBackground,A0=0.3"
peaks = PlotPeakByLogValue(ws, function, Spectrum=1)

**Example - sequentially fitting a workspace:**
**Example - sequentially fitting a workspace:**

.. testcode:: ExPlotPeakByLogValueSeq

Expand All @@ -101,7 +120,7 @@ Usage
Output:

.. testoutput:: ExPlotPeakByLogValueSeq

True

.. categories::

0 comments on commit 9e5f0f8

Please sign in to comment.