Skip to content

Commit

Permalink
Corrected problems in docs. refs #9577
Browse files Browse the repository at this point in the history
Added xml code-block back.
Corrected mask text.
  • Loading branch information
stuartcampbell committed Jun 10, 2014
1 parent 853be3d commit 8c9efe2
Showing 1 changed file with 17 additions and 18 deletions.
35 changes: 17 additions & 18 deletions Code/Mantid/docs/source/algorithms/SaveMask-v1.rst
Expand Up @@ -10,21 +10,20 @@ Description
-----------

This algorithm is used to save the masking from a workspace to an XML
file. This algorithm has previously been renamed from
`SaveDetectorMasks <SaveDetectorMasks>`__.
file. This algorithm has previously been renamed from SaveDetectorMasks.

2 Types of Mask Workspace
-------------------------

There are two types of mask workspace that can serve as input.

1. `MaskWorkspace <MaskWorkspace>`__
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 <MaskWorkspace>`__ `MatrixWorkspace <MatrixWorkspace>`__ containing `Instrument <Instrument>`__
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
Expand All @@ -33,26 +32,26 @@ 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`` <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`` <SpecialWorkspace2D>`__\ ``), the corresponding value is 0.``
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.

XML File Format
---------------

Example 1:

.. raw:: html

<?xml version="1.0" encoding="UTF-8" ?>
.. code-block:: xml
| `` ``\
| ``  ``\
| ``   ``\ \ ``3,34-44,47``\
| ``   ``\ \ ``bank123``\
| ``   ``\ \ ``bank124``\
| ``  ``\
| `` ``\
<?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 8c9efe2

Please sign in to comment.