refs #10384 Cloned Rebin to RemoveBackground and copied

BackgroundHelper there

Code/Mantid/Framework/Algorithms/inc/MantidAlgorithms/RemoveBackground.h

@@ -0,0 +1,122 @@
+#ifndef MANTID_ALGORITHMS_REBIN_H_
+#define MANTID_ALGORITHMS_REBIN_H_
+
+//----------------------------------------------------------------------
+// Includes
+//----------------------------------------------------------------------
+#include "MantidAPI/Algorithm.h"
+#include "MantidAlgorithms/BackgroundHelper.h"
+
+namespace Mantid
+{
+  namespace Algorithms
+  {
+    /** Performs removal of constant (and possibly non-constant after simple modification) background calculated in TOF units
+    from a matrix workspace, expressed in units, different from TOF.
+
+    @date 26/10/2014
+
+
+    Copyright © 2008-9 ISIS Rutherford Appleton Laboratory & NScD Oak Ridge National Laboratory
+
+    This file is part of Mantid.
+
+    Mantid is free software; you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation; either version 3 of the License, or
+    (at your option) any later version.
+
+    Mantid is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+    File change history is stored at: <https://github.com/mantidproject/mantid>
+    Code Documentation is available at: <http://doxygen.mantidproject.org>
+    */
+
+    class DLLExport RemoveBackground : public API::Algorithm
+    {
+    public:
+      /// Default constructor
+      RemoveBackground() : API::Algorithm(),m_BackgroundHelper() {};
+      /// Destructor
+      virtual ~RemoveBackground(){};
+      /// Algorithm's name for identification overriding a virtual method
+      virtual const std::string name() const { return "RemoveBackground";}
+      ///Summary of algorithms purpose
+      virtual const std::string summary() const {return "Removes background (constant for now) calculated in TOF units "
+        "from a matrix workspace, expressed in units, different from TOF";}
+
+      /// Algorithm's version for identification overriding a virtual method
+      virtual int version() const { return 1;}
+      /// Algorithm's category for identification overriding a virtual method
+      virtual const std::string category() const { return "Transforms\\RemoveBackground";}
+
+    protected:
+
+      // Overridden Algorithm methods
+      void init();
+      virtual void exec();
+
+
+    private:
+      // method to check if removing background is requested and possible 
+      API::MatrixWorkspace_const_sptr  checkRemoveBackgroundParameters(const API::MatrixWorkspace_sptr &inputWS,int &eMode, bool PreserveEvents);
+      // class responsible for background removal
+      BackgroundHelper m_BackgroundHelper;
+    protected: // for testing
+      /**Class actually performing background removal from a workspace spectra */
+      class BackgroundHelper
+      {
+      public:
+        BackgroundHelper();
+        ~BackgroundHelper();
+        void initialize(const API::MatrixWorkspace_const_sptr &bkgWS,const API::MatrixWorkspace_sptr &sourceWS,int emode,int nTreads=1);
+
+        void removeBackground(int hist,const MantidVec &XValues,MantidVec &y_data,MantidVec &e_data,int tread_num=0)const;
+
+      private:
+        //vector of pointers to the units conversion class for the working workspace;
+        std::vector<Kernel::Unit *> m_WSUnit;
+
+        // shared pointer to the workspace containing background
+        API::MatrixWorkspace_const_sptr m_bgWs;
+        // shared pointer to the workspace where background should be removed
+        API::MatrixWorkspace_const_sptr m_wkWS;
+
+        // if the background workspace is single value workspace
+        bool m_singleValueBackground;
+        // average number of counts at background for first spectra of a background workspace
+        double m_NBg;
+        // time interval for measuring the background
+        double m_dtBg;
+        // Squared error of the background for first spectra of a background workspace
+        //double m_ErrSq;
+        // energy conversion mode
+        int m_Emode;
+        // source-sample distance
+        double m_L1;
+        // incident for direct or analysis for indirect energy for units conversion
+        double m_Efix;
+        // shared pointer to the sample
+        Geometry::IComponent_const_sptr m_Sample;
+
+        // get Ei attached to direct or indirect instrument workspace
+        double getEi(const API::MatrixWorkspace_const_sptr &inputWS)const;
+        // the procedure user to delete existing unit converter pointers
+        void deleteUnitsConverters();
+      };
+
+
+    };
+
+
+
+  } // namespace Algorithms
+} // namespace Mantid
+
+#endif /*MANTID_ALGORITHMS_REBIN_H_*/