Renamed rebin parameter, addded usage example

Refs #10064
mantidproject · Sep 23, 2014 · 044c9b0 · 044c9b0
1 parent 4f986e7
commit 044c9b0
Show file tree

Hide file tree

Showing 2 changed files with 26 additions and 3 deletions.
diff --git a/...tid/Framework/PythonInterface/plugins/algorithms/WorkflowAlgorithms/IndirectResolution.py b/...tid/Framework/PythonInterface/plugins/algorithms/WorkflowAlgorithms/IndirectResolution.py
@@ -35,7 +35,7 @@ def PyInit(self):
         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 @@ def _setup(self):
 
         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
@@ -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::