Skip to content

Commit

Permalink
Add Stepscan flowchart re #9726
Browse files Browse the repository at this point in the history
Signed-off-by: Karl Palmen <karl.palmen@stfc.ac.uk>
  • Loading branch information
KarlPalmen committed Apr 28, 2015
1 parent 3965880 commit b9f2f7a
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 1 deletion.
13 changes: 12 additions & 1 deletion Code/Mantid/docs/source/algorithms/StepScan-v1.rst
Expand Up @@ -12,7 +12,6 @@ Description
This algorithm is for producing rocking curves from alignment scan runs.
It is for use only with ADARA-style SNS datasets as it requires the
'scan\_index' log variable.

The algorithm optionally uses the :ref:`algm-MaskDetectors`
and/or :ref:`algm-FilterByXValue` algorithms to restrict the
region of data included. **N.B. If these options are used, then this
Expand All @@ -22,5 +21,17 @@ The :ref:`algm-SumEventsByLogValue` algorithm is then
called, with 'scan\_index' as the log to sum against. The row of the
resulting table pertaining to scan\_index=0 (which indicates 'not a scan
point') is then removed.

Before then it will call other algorithms as shown in the flowchart,
if the relevent inputs have been set.
:ref:`algm-MaskDetectors` will be called if a MaskWorkspace is supplied.
If either Xmin or Xmax or both are supplied,
then :ref:`algm-FilterByXValue` algorithm is run to restrict the
region of data included and if RangeUnit is not TOF,
:ref:`algm-ConvertUnits` is run beforehand.

If necessary, the imput workspace is cloned, to save it from being modified.

.. image:: ../images/StepScanWorkflow.png

.. categories::
1 change: 1 addition & 0 deletions Code/Mantid/docs/source/diagrams/StepScanWorkflow.xml
@@ -0,0 +1 @@
<mxfile userAgent="Mozilla/5.0 (compatible; MSIE 9.0; Windows NT 6.1; WOW64; Trident/5.0; SLCC2; .NET CLR 2.0.50727; .NET CLR 3.5.30729; .NET CLR 3.0.30729; Media Center PC 6.0; InfoPath.3; .NET4.0C; .NET4.0E)" type="device"><diagram>3Zldb9o8FMc/DZcPAhzeLtf0ZZNWrVq1lV09shITrDoxcgyFffrayTGJ43RNm4BKuUDk2HGO//75+JzQQ368uxF4vbrlIWG90SDc9dBlbzSao5n61oZ9bvBm49wQCRrmpmFhuKd/CRgHYN3QkKRWR8k5k3RtGwOeJCSQlm3Jmf2INY7M8IXhPsDMtT7QUK5y62w0KexfCY1W5jHDyTxvSeXejBGSJd4w+V9mUm26OcZmrGxW6EoJJjhXw+hf8c4nTItmBMmnfv1C68FJQRJw5N83gBNbzDbg47dkvZHK9MDFY7rGAXFmkUrBHw8iKJcv0hVe68Z4F+mF7i8ZfwpWWMh+KtX3/0PVZ0kZ8znjIhsEXauP77vuwgy2REgCnGQmcP+G8JhIsVddoBUNABqAaAojPBWLNBwDMKvSAk1heTCwEh1GLuRSP0CxevWQo57PeNJOsbXgAUmVU1XFfF9r1oViwIRRTLHqSmb6WJKBrY1kQ9jzJc0cuUgSfhGCP6mrgOE0pYFWzNLQU5YXpUj5Rihuy4CT0NrdrjaCMCzp1t7sdROFW+84VU8tNJ29oKkZQu2DiEi4qyLXwY1GCpqVKSl4i9PHSyJVjOMiPTP6EDohfQd329LXBD2IDqdGD6GKUB2i5x4XGr1zOSrM0WCE8mrI82rIm3RBnntWNCNPTVfsF8o0MBd/9EV/PJ4awx0RVDlEtF66V1X1RnESuuWw2JHm5ASbBx+BYNi65SObJxqhXwmVHz922rmOZ2gtE2yy4zLBXgfJjnl2C4L7Y4vhZvw2C7YGGYtfuPUz8QvlRmkRfuIkIpreDx5953b09ZCncHDoHRwr/k7fRW8j9GBNPjt6buZ+TZnatRf7xe/MdvTg6cBWszaNg+fY0/HodOETxugm9axw9TqjcJ/FaLag3SNZSfDH1cS9OyRNplvS9H4TX22VEunF/juPzoHL0RRSQ9BrUpOWqlcYLpWHWNnqFUanFdGbsYSYUsYyX9SzxtItk35spHqtdsJCqV2oHNpITs3ZXQ6UqAbJeRdEtq+U3pVn1r8per3Kr0k8cwDOGmG3TlrENPng3M5hDY0+ZoQStlOIOGVqURevgt3qaBHj3ZkJZoB6RTBTdrYSzK1kGifkb96jGc3H34/VQqXD/diifHmzWhnKZxS91GXxj1nevfi/EV09Aw==</diagram></mxfile>
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit b9f2f7a

Please sign in to comment.