Skip to content

Commit

Permalink
Fix more docs sphinx errors.
Browse files Browse the repository at this point in the history
Refs #9749
  • Loading branch information
martyngigg committed Jun 25, 2014
1 parent 6a6fb17 commit 42db01a
Show file tree
Hide file tree
Showing 5 changed files with 21 additions and 28 deletions.
9 changes: 0 additions & 9 deletions Code/Mantid/docs/source/algorithms/RadiusSum-v1.rst
Expand Up @@ -16,16 +16,12 @@ Workspace2D where the position of the pixels are not associated to
detector positions, but it is derived from the Axes.

.. figure:: /images/ExecuteRadiusSum.png
:alt: 800px

800px
The image below shows a visual interpretation for the inputs of the
algorithm

.. figure:: /images/RadiusSumInputs.png
:alt: 300px

300px
The Algorithm create **NumBins** rings around the **Centre** point each
one with :math:`width = BinSize` for
:math:`BinSize=\frac{MaxRadius-MinRadius}{NumBins}`.
Expand All @@ -38,16 +34,11 @@ below, shows what does this means. An ideal solution for RadiusSum is
the left image, while the right image is what is current implemented.

.. figure:: /images/RadiusSumSolutions.png
:alt: 300px

300px
Although the images were applied to an image
`Workspace2D <http://www.mantidproject.org/Workspace2D>`_, the image below shows that it is possible
to apply this algorithm to Workspaces attached to instruments.

.. figure:: /images/RadiusSumInstrument.png
:alt: 800 px

800 px

.. categories::
Expand Up @@ -52,6 +52,7 @@ Usage

print ("bank 1 was scaled and is now %.2f by %.2f" % (bank1.xsize(), bank1.ysize()))
print ("bank 2 was not scaled and remains %.2f by %.2f" % (bank2.xsize(), bank2.ysize()))

Output:

.. testoutput:: ExScaleBank1
Expand Down
1 change: 1 addition & 0 deletions Code/Mantid/docs/source/algorithms/RetrieveRunInfo-v1.rst
Expand Up @@ -22,6 +22,7 @@ result table.

Output workspace generated by inspecting runs 12218-12229 and having
the default instrument set to TOSCA.

Limitations
-----------

Expand Down
10 changes: 5 additions & 5 deletions Code/Mantid/docs/source/algorithms/SaveGSASInstrumentFile-v1.rst
Expand Up @@ -42,9 +42,9 @@ There are several places in this algorithm that can set the value of
:math:`2\theta`. From the highest priority, here is the list how
:math:`2\theta` is set up.

| ``1. Algorithms' input property "TwoTheta";``
| ``2. Either input TableWorkspace or input Fullprof resolution (.irf) file;``
| ``3. Hard coded default "TwoTheta" of a certain instrument.``
1. Algorithms' input property ``TwoTheta``;
2. Either input TableWorkspace or input Fullprof resolution (.irf) file;
3. Hard coded default "TwoTheta" of a certain instrument.

Set up :math:`L_1`
##################
Expand All @@ -53,8 +53,8 @@ There are 2 places in this algorithm that can set the value of
:math:`L_1`. From the highest priority, here is the list how
:math:`2\theta` is set up.

| ``1. Algorithms' input property "L1"; ``
| ``2. Hard coded default "TwoTheta" of a certain instrument.``
1. Algorithms' input property ``L1``;
2. Hard coded default "TwoTheta" of a certain instrument.

Calculation of :math:`L_2`
##########################
Expand Down
28 changes: 14 additions & 14 deletions Code/Mantid/docs/source/algorithms/SaveMask-v1.rst
Expand Up @@ -18,25 +18,25 @@ file. This algorithm has previously been renamed from SaveDetectorMasks.
There are two types of mask workspace that can serve as input.

1. `MaskWorkspace <http://www.mantidproject.org/MaskWorkspace>`__
####################################
##################################################################

In this case, :ref:`algm-SaveMask` will read Y values to determine
which detectors are masked;

2. A non-\ `MaskWorkspace <http://www.mantidproject.org/MaskWorkspace>`__ `MatrixWorkspace <http://www.mantidproject.org/MatrixWorkspace>`__ containing `Instrument <http://www.mantidproject.org/Instrument>`__
#########################################################################################################################
################################################################################################################################################################################################################

In this case, :ref:`algm-SaveMask` will scan through all detectors to
determine which are masked.

Definition of Mask
------------------

If a pixel is **masked**, it means that the data from this pixel won't be used.
In the masking workspace (i.e., `SpecialWorkspace2D <http://www.mantidproject.org/SpecialWorkspace2D>`__), the corresponding value is 1. 
If a pixel is **masked**, it means that the data from this pixel won't be used.
In the masking workspace (i.e., `SpecialWorkspace2D <http://www.mantidproject.org/SpecialWorkspace2D>`__), the corresponding value is 1.

If a pixel is **NOT masked**, it means that the data from this pixel will be used.  ``
In the masking workspace (i.e., `SpecialWorkspace2D <http://www.mantidproject.org/SpecialWorkspace2D>`__), the corresponding value is 0.
If a pixel is **NOT masked**, it means that the data from this pixel will be used. ``
In the masking workspace (i.e., `SpecialWorkspace2D <http://www.mantidproject.org/SpecialWorkspace2D>`__), the corresponding value is 0.

XML File Format
---------------
Expand All @@ -45,13 +45,13 @@ Example 1:

.. code-block:: xml
<?xml version="1.0" encoding="UTF-8" ?>
<detector-masking">
<group">
<detids>3,34-44,47</detids>
<component>bank123</component>
<component>bank124</component>
</group>
</detector-masking>
<?xml version="1.0" encoding="UTF-8" ?>
<detector-masking">
<group">
<detids>3,34-44,47</detids>
<component>bank123</component>
<component>bank124</component>
</group>
</detector-masking>
.. categories::

0 comments on commit 42db01a

Please sign in to comment.