From 2eeb0f621e90f3485e861d53a9c50f4e28a61a95 Mon Sep 17 00:00:00 2001
From: Simon Heybrock <simon.heybrock@esss.se>
Date: Fri, 17 Nov 2017 14:08:16 +0100
Subject: [PATCH] Re #21181. Add MaskSpectra Sphinx documentation.

---
 docs/source/algorithms/MaskSpectra-v1.rst | 38 +++++++++++++++++++++++
 1 file changed, 38 insertions(+)
 create mode 100644 docs/source/algorithms/MaskSpectra-v1.rst

diff --git a/docs/source/algorithms/MaskSpectra-v1.rst b/docs/source/algorithms/MaskSpectra-v1.rst
new file mode 100644
index 00000000000..d8a5b19e532
--- /dev/null
+++ b/docs/source/algorithms/MaskSpectra-v1.rst
@@ -0,0 +1,38 @@
+
+.. algorithm::
+
+.. summary::
+
+.. alias::
+
+.. properties::
+
+Description
+-----------
+
+Mask (zero) spectra and the underlying detectors in a workspace.
+If a spectrum corresponds to more than one detector, all detectors are masked.
+
+Usage
+-----
+
+**Example - MaskSpectra**
+
+.. testcode:: MaskSpectraExample
+
+  ws = CreateWorkspace(OutputWorkspace='ws', DataX='1,1', DataY='2,2', NSpec=2)
+  masked = MaskSpectra(InputWorkspace=ws, InputWorkspaceIndexType='WorkspaceIndex', InputWorkspaceIndexSet='1')
+  print(ws.readY(0), masked.readY(0))
+  print(ws.readY(1), masked.readY(1))
+
+Output:
+
+.. testoutput:: MaskSpectraExample
+
+  (array([ 2.]), array([ 2.]))
+  (array([ 2.]), array([ 0.]))
+
+.. categories::
+
+.. sourcelink::
+
-- 
GitLab