From 904768cf1b95e6acbc97222c6133f6beb8e8d562 Mon Sep 17 00:00:00 2001 From: Nick Draper Date: Wed, 18 Jun 2014 16:45:38 +0100 Subject: [PATCH] re #9590 done all of them --- .../algorithms/CreatePSDBleedMask-v1.rst | 1 + .../DetectorEfficiencyVariation-v1.rst | 26 +++++++++++++++++++ .../FindCenterOfMassPosition-v1.rst | 2 ++ .../FindCenterOfMassPosition-v2.rst | 2 ++ 4 files changed, 31 insertions(+) diff --git a/Code/Mantid/docs/source/algorithms/CreatePSDBleedMask-v1.rst b/Code/Mantid/docs/source/algorithms/CreatePSDBleedMask-v1.rst index 2306e4d266ec..2631f3103b89 100644 --- a/Code/Mantid/docs/source/algorithms/CreatePSDBleedMask-v1.rst +++ b/Code/Mantid/docs/source/algorithms/CreatePSDBleedMask-v1.rst @@ -20,6 +20,7 @@ Restrictions on the input workspace ################################### - The workspace must contain either raw counts or counts/us. + Usage ----- diff --git a/Code/Mantid/docs/source/algorithms/DetectorEfficiencyVariation-v1.rst b/Code/Mantid/docs/source/algorithms/DetectorEfficiencyVariation-v1.rst index 39982a0ef158..3868f0069d25 100644 --- a/Code/Mantid/docs/source/algorithms/DetectorEfficiencyVariation-v1.rst +++ b/Code/Mantid/docs/source/algorithms/DetectorEfficiencyVariation-v1.rst @@ -35,4 +35,30 @@ Child algorithms used Uses the :ref:`algm-Integration` algorithm to sum the spectra. +Usage +----- + +**Example:** + +.. testcode:: ExDetEffVariation + + import numpy as np + + wsBase=CreateSampleWorkspace() + ws=CreateSampleWorkspace() + noisyY = np.array(ws.readY(0)) + noisyY[0]=1e20 + ws.setY(50,noisyY) + + (wsOut, numFailures) = DetectorEfficiencyVariation(WhiteBeamBase='wsBase', WhiteBeamCompare='ws') + + print "%i spectra has been masked in wsOut" % numFailures + +Output: + +.. testoutput:: ExDetEffVariation + + 1 spectra has been masked in wsOut + + .. categories:: diff --git a/Code/Mantid/docs/source/algorithms/FindCenterOfMassPosition-v1.rst b/Code/Mantid/docs/source/algorithms/FindCenterOfMassPosition-v1.rst index 44c6fdcbcbf5..8cb533a7818f 100644 --- a/Code/Mantid/docs/source/algorithms/FindCenterOfMassPosition-v1.rst +++ b/Code/Mantid/docs/source/algorithms/FindCenterOfMassPosition-v1.rst @@ -13,6 +13,8 @@ If the *Output* property is set, the beam center will be placed in a table workspace. Otherwise, the result is placed in an ArrayProperty named *CenterOfMass*. +This algoirthm is not intended for use directly, it is part of the SNS SANS reduction workflow. + See `SANS Reduction `__ documentation for details. diff --git a/Code/Mantid/docs/source/algorithms/FindCenterOfMassPosition-v2.rst b/Code/Mantid/docs/source/algorithms/FindCenterOfMassPosition-v2.rst index 79a21e2bd0c1..09d8dbc9e278 100644 --- a/Code/Mantid/docs/source/algorithms/FindCenterOfMassPosition-v2.rst +++ b/Code/Mantid/docs/source/algorithms/FindCenterOfMassPosition-v2.rst @@ -13,6 +13,8 @@ If the *Output* property is set, the beam centre will be placed in a table workspace. Otherwise, the result is placed in an ArrayProperty named *CenterOfMass*. +This algoirthm is not intended for use directly, it is part of the SNS SANS reduction workflow. + See `SANS Reduction `__ documentation for details.