Add usage to ConvertFromDistribution. Refs #9585.

mantidproject · Jun 5, 2014 · 4ab3117 · 4ab3117
1 parent a91c737
commit 4ab3117
Show file tree

Hide file tree

Showing 2 changed files with 33 additions and 8 deletions.
diff --git a/Code/Mantid/Framework/Algorithms/inc/MantidAlgorithms/ConvertFromDistribution.h b/Code/Mantid/Framework/Algorithms/inc/MantidAlgorithms/ConvertFromDistribution.h
@@ -49,16 +49,14 @@ class DLLExport ConvertFromDistribution : public API::Algorithm
   virtual ~ConvertFromDistribution() {}
   /// Algorithm's name
   virtual const std::string name() const { return "ConvertFromDistribution"; }
-    ///Summary of algorithms purpose
-    virtual const std::string summary() const {return "Converts a histogram workspace from a distribution i.e. multiplies by the bin width.";}
-
+  /// Summary of algorithms purpose
+  virtual const std::string summary() const { return "Converts a histogram workspace from a distribution i.e. multiplies by the bin width."; }
   /// Algorithm's version
   virtual int version() const { return (1); }
   /// Algorithm's category for identification
   virtual const std::string category() const { return "Transforms\\Distribution"; }
 
 private:
-
   /// Initialisation code
   void init();
   ///Execution code

diff --git a/Code/Mantid/docs/source/algorithms/ConvertFromDistribution-v1.rst b/Code/Mantid/docs/source/algorithms/ConvertFromDistribution-v1.rst
@@ -9,13 +9,40 @@
 Description
 -----------
 
-Converts a histogram workspace from a distribution i.e. multiplies by
-the bin width to take out the bin width dependency.
+Converts a histogram workspace from a distribution i.e. multiplies by the bin width to take out the bin width dependency.
+This algorithm is often used with :ref:`ConvertToDistribution <algm-ConvertToDistribution-v1>`.
 
 Restrictions on the input workspace
 ###################################
 
-The workspace to convert must contain histogram data which is flagged as
-being a distribution.
+The workspace to convert must contain histogram data which is flagged as being a distribution.
+
+Usage
+-----
+
+**Example - converting a workspace to and from a distribution**
+
+.. testcode:: ConvertFromDistribution
+
+    # By default it is not a distribution.
+    ws_multi = CreateSampleWorkspace("Histogram", "Multiple Peaks")
+
+    # Convert to a distribution for demonstration purposes.
+    # If your data is already distributed then this is not required.
+    ConvertToDistribution(ws_multi)
+
+    print "Is the workspace a distribution? " + str(ws_multi.isDistribution())
+
+    # Convert back to the initial workspace state.
+    ConvertFromDistribution(ws_multi)
+
+    print "Is the workspace a distribution? " + str(ws_multi.isDistribution())
+
+Output:
+
+.. testoutput:: ConvertFromDistribution
+
+    Is the workspace a distribution? True
+    Is the workspace a distribution? False
 
 .. categories::