Skip to content

Commit

Permalink
Refs #11680 Fix literal block issues in Fit docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Harry Jeffery committed May 5, 2015
1 parent 0082c98 commit cf3e6b3
Showing 1 changed file with 31 additions and 23 deletions.
54 changes: 31 additions & 23 deletions Code/Mantid/docs/source/algorithms/Fit-v1.rst
Expand Up @@ -105,7 +105,7 @@ the Function property. Each simple function definition must be separated
by a semicolon ';'. For example fitting two Gaussians on a linear
background might look like this::

Function: "name=LinearBackground, A0=0.3;
Function: "name=LinearBackground, A0=0.3;
name=Gaussian, PeakCentre=4.6, Height=10, Sigma=0.5;
name=Gaussian, PeakCentre=7.6, Height=8, Sigma=0.5"

Expand Down Expand Up @@ -205,10 +205,12 @@ Examples
This example shows a simple fit to a Gaussian function. The algorithm
properties are:

| ``InputWorkspace: Test``
| ``WorkspaceIndex: 0``
| ``Function: name=Gaussian, PeakCentre=4, Height=1.3, Sigma=0.5``
| ``Output: res``
::

InputWorkspace: Test
WorkspaceIndex: 0
Function: name=Gaussian, PeakCentre=4, Height=1.3, Sigma=0.5
Output: res

.. figure:: /images/GaussianFit.jpg
:alt: GaussianFit.jpg
Expand All @@ -219,11 +221,13 @@ properties are:

The next example shows a fit of the same data but with a tie.

| ``InputWorkspace: Test``
| ``WorkspaceIndex: 0``
| ``Function: name=Gaussian, PeakCentre=4, Height=1.3, Sigma=0.5``
| ``Ties: Sigma=Height/2``
| ``Output: res``
::

InputWorkspace: Test
WorkspaceIndex: 0
Function: name=Gaussian, PeakCentre=4, Height=1.3, Sigma=0.5
Ties: Sigma=Height/2
Output: res

.. figure:: /images/GaussianFit_Ties.jpg
:alt: GaussianFit_Ties.jpg
Expand All @@ -236,12 +240,14 @@ This example shows a fit of two overlapping Gaussians on a linear
background. Here we create a composite function with a LinearBackground
and two Gaussians:

| ``InputWorkspace: Test``
| ``WorkspaceIndex: 0``
| ``Function: name=LinearBackground,A0=1;``
| `` name=Gaussian,PeakCentre=4,Height=1.5, Sigma=0.5;``
| `` name=Gaussian,PeakCentre=6,Height=4, Sigma=0.5 ``
| ``Output: res``
::

InputWorkspace: Test
WorkspaceIndex: 0
Function: name=LinearBackground,A0=1;
name=Gaussian,PeakCentre=4,Height=1.5, Sigma=0.5;
name=Gaussian,PeakCentre=6,Height=4, Sigma=0.5
Output: res

.. figure:: /images/Gaussian2Fit.jpg
:alt: Gaussian2Fit.jpg
Expand All @@ -253,13 +259,15 @@ and two Gaussians:
This example repeats the previous one but with the Sigmas of the two
Gaussians tied:

| ``InputWorkspace: Test``
| ``WorkspaceIndex: 0``
| ``Function: name=LinearBackground,A0=1;``
| `` name=Gaussian,PeakCentre=4,Height=1.5, Sigma=0.5;``
| `` name=Gaussian,PeakCentre=6,Height=4, Sigma=0.5 ``
| ``Ties: f2.Sigma = f1.Sigma``
| ``Output: res``
::

InputWorkspace: Test
WorkspaceIndex: 0
Function: name=LinearBackground,A0=1;
name=Gaussian,PeakCentre=4,Height=1.5, Sigma=0.5;
name=Gaussian,PeakCentre=6,Height=4, Sigma=0.5
Ties: f2.Sigma = f1.Sigma
Output: res

.. figure:: /images/Gaussian2Fit_Ties.jpg
:alt: Gaussian2Fit_Ties.jpg
Expand Down

0 comments on commit cf3e6b3

Please sign in to comment.