diff --git a/Code/Mantid/docs/source/algorithms/MuonLoad-v1.rst b/Code/Mantid/docs/source/algorithms/MuonLoad-v1.rst index 3fa577e5b3d1f597496d1499ca3b4d86e6c60332..cdec33d965eae7cae2e625e2d414b0656d964bae 100644 --- a/Code/Mantid/docs/source/algorithms/MuonLoad-v1.rst +++ b/Code/Mantid/docs/source/algorithms/MuonLoad-v1.rst @@ -18,17 +18,51 @@ Specifically: #. Apply dead time correction #. Group the workspace #. Offset, crop and rebin the workspace -#. If the loaded data is multi-period - apply the specified operation to - specified periods to get a single data set. #. Use :ref:`algm-MuonCalculateAsymmetry` to get the resulting workspace. Workflow ######## -.. figure:: /images/MuonWorkflow.png - :alt: MuonWorkflow.png +.. image:: ../images/MuonWorkflow.png - MuonWorkflow.png +Usage +----- + +.. include:: ../usagedata-note.txt + +.. note:: + + For more extensive usage examples on result type / period options please refer to the + :ref:`algm-MuonCalculateAsymmetry` documentation. + + For example of applying custom dead times, please refer to :ref:`algm-ApplyDeadTimeCorr` + documentation. + + For example of applying custom grouping, please refer to :ref:`algm-MuonGroupDetectors` + documentation. + +**Example - Integrated pair asymmetry for MUSR run:** + +.. testcode:: ExPairAsymmetry + + output = MuonLoad(Filename = 'MUSR0015189.nxs', + TimeZero = 0.55, + Xmin = 0.11, + Xmax = 12, + OutputType = "PairAsymmetry", + PairFirstIndex = 0, + PairSecondIndex = 1, + Alpha = 1.0) + + output_int = Integration(output) + + print 'Integrated asymmetry for the run: {:.3f}'.format(output_int.readY(0)[0]) + +Output: + +.. testoutput:: ExPairAsymmetry + + Integrated asymmetry for the run: 106.326 .. categories:: diff --git a/Code/Mantid/docs/source/images/MuonWorkflow.png b/Code/Mantid/docs/source/images/MuonWorkflow.png new file mode 100644 index 0000000000000000000000000000000000000000..a994cd3a3d291d7bc8e89de6b763c3ffda1a5f3b Binary files /dev/null and b/Code/Mantid/docs/source/images/MuonWorkflow.png differ