From 044c9b0896236eef60e0ffe3a8f4f364ce295375 Mon Sep 17 00:00:00 2001
From: Dan Nixon <dan@dan-nixon.com>
Date: Tue, 23 Sep 2014 11:20:44 +0100
Subject: [PATCH] Renamed rebin parameter, addded usage example
Refs #10064
---
.../WorkflowAlgorithms/IndirectResolution.py | 4 +--
.../algorithms/IndirectResolution-v1.rst | 25 ++++++++++++++++++-
2 files changed, 26 insertions(+), 3 deletions(-)
diff --git a/Code/Mantid/Framework/PythonInterface/plugins/algorithms/WorkflowAlgorithms/IndirectResolution.py b/Code/Mantid/Framework/PythonInterface/plugins/algorithms/WorkflowAlgorithms/IndirectResolution.py
index 424dbca9ec0..075626bedb3 100644
--- a/Code/Mantid/Framework/PythonInterface/plugins/algorithms/WorkflowAlgorithms/IndirectResolution.py
+++ b/Code/Mantid/Framework/PythonInterface/plugins/algorithms/WorkflowAlgorithms/IndirectResolution.py
@@ -35,7 +35,7 @@ class IndirectResolution(DataProcessorAlgorithm):
self.declareProperty(FloatArrayProperty(name='BackgroundRange', values=[0, 0]),
doc='')
- self.declareProperty(name='RebinString', defaultValue='', doc='')
+ self.declareProperty(name='RebinParam', defaultValue='', doc='')
self.declareProperty(name='ScaleFactor', defaultValue=1.0, doc='')
self.declareProperty(name='Res', defaultValue=True, doc='')
@@ -107,7 +107,7 @@ class IndirectResolution(DataProcessorAlgorithm):
self._detector_range = self.getProperty('DetectorRange').value
self._background = self.getProperty('BackgroundRange').value
- self._rebin_string = self.getProperty('RebinString').value
+ self._rebin_string = self.getProperty('RebinParam').value
self._scale_factor = self.getProperty('ScaleFactor').value
self._res = self.getProperty('Res').value
diff --git a/Code/Mantid/docs/source/algorithms/IndirectResolution-v1.rst b/Code/Mantid/docs/source/algorithms/IndirectResolution-v1.rst
index 425434ff27e..026223e9160 100644
--- a/Code/Mantid/docs/source/algorithms/IndirectResolution-v1.rst
+++ b/Code/Mantid/docs/source/algorithms/IndirectResolution-v1.rst
@@ -9,8 +9,31 @@
Description
-----------
-TODO
+Creates a resolution workspace for an inelastic indirect sample run.
See `Indirect:Calibration <http://www.mantidproject.org/Indirect:Calibration>`_.
+Usage
+-----
+
+**Example - Running IndirectResolution.**
+
+.. testcode:: ExIndirectResolutionSimple
+
+ resolution = IndirectResolution(InputFiles='IRS38633.raw',
+ Instrument='IRIS',
+ Analyser='graphite',
+ Reflection='002',
+ DetectorRange=[3, 53],
+ BackgroundRange=[-0.16, -0.14],
+ RebinParam='-0.175,0.002,0.175')
+
+ print mtd.doesExist('resolution')
+
+Output:
+
+.. testoutput:: ExIndirectResolutionSimple
+
+ True
+
.. categories::
--
GitLab