Add generateHistogram() to IEventWorkspace.h

refs #5285
mantidproject · May 10, 2012 · 213d412 · 213d412
1 parent 53a879a
commit 213d412
Show file tree

Hide file tree

Showing 4 changed files with 7 additions and 1 deletion.
diff --git a/Code/Mantid/Framework/API/inc/MantidAPI/IEventWorkspace.h b/Code/Mantid/Framework/API/inc/MantidAPI/IEventWorkspace.h
@@ -45,6 +45,10 @@ namespace API
     virtual double getTofMax() const = 0;
     virtual EventType getEventType() const = 0;
     virtual IEventList * getEventListPtr(const std::size_t workspace_index) = 0;
+    virtual void generateHistogram(const std::size_t index, 
+                                   const MantidVec& X, MantidVec& Y, MantidVec& E, 
+                                   bool skipError = false) const = 0;
+
     virtual void clearMRU() const = 0;
   };
 

diff --git a/Code/Mantid/Framework/DataObjects/inc/MantidDataObjects/EventWorkspace.h b/Code/Mantid/Framework/DataObjects/inc/MantidDataObjects/EventWorkspace.h
@@ -125,6 +125,7 @@ class DLLExport EventWorkspace : public API::IEventWorkspace
   // Get a pointer to the x data at the given workspace index
   Kernel::cow_ptr<MantidVec> refX(const std::size_t) const;
 
+  /// Generate a new histogram from specified event list at the given index.
   void generateHistogram(const std::size_t index, const MantidVec& X, MantidVec& Y, MantidVec& E, bool skipError = false) const;
 
   //------------------------------------------------------------

diff --git a/Code/Mantid/Framework/DataObjects/inc/MantidDataObjects/Workspace2D.h b/Code/Mantid/Framework/DataObjects/inc/MantidDataObjects/Workspace2D.h
@@ -80,6 +80,7 @@ class DLLExport Workspace2D : public API::MatrixWorkspace
   /// Return the underlying ISpectrum ptr (const version) at the given workspace index.
   virtual const Mantid::API::ISpectrum * getSpectrum(const size_t index) const;
 
+  /// Generate a new histogram by rebinning the existing histogram. 
   void generateHistogram(const std::size_t index, const MantidVec& X, MantidVec& Y, MantidVec& E, bool skipError = false) const;
 
   /** sets the monitorWorkspace indexlist

diff --git a/Code/Mantid/Framework/DataObjects/src/Workspace2D.cpp b/Code/Mantid/Framework/DataObjects/src/Workspace2D.cpp
@@ -124,7 +124,7 @@ namespace Mantid
 
 
     //---------------------------------------------------------------------------
-    /** Rebin a particulare spectrum to a new histogram bin boundaries.
+    /** Rebin a particular spectrum to a new histogram bin boundaries.
      *
      * @param index :: workspace index to generate
      * @param X :: input X vector of the bin boundaries.