Skip to content
Snippets Groups Projects
StripVanadiumPeaks2.h 2.2 KiB
Newer Older
#ifndef MANTID_ALGORITHMS_STRIPVANADIUMPEAKS2_H_
#define MANTID_ALGORITHMS_STRIPVANADIUMPEAKS2_H_
#include "MantidKernel/System.h"
#include "MantidAPI/Algorithm.h"

namespace Mantid {
namespace Algorithms {
/** StripVanadiumPeaks2
  @author Wenduo Zhou
  @date 2011-10-07
  Copyright © 2011 ISIS Rutherford Appleton Laboratory, NScD Oak Ridge
  National Laboratory & European Spallation Source
  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 StripVanadiumPeaks2 : public API::Algorithm {
public:
  StripVanadiumPeaks2();
  ~StripVanadiumPeaks2();
  /// Algorithm's name for identification overriding a virtual method
  virtual const std::string name() const { return "StripVanadiumPeaks"; }
  /// Algorithm's version for identification overriding a virtual method
  virtual int version() const { return 2; }
  /// Algorithm's category for identification
  virtual const std::string category() const {
    return "CorrectionFunctions\\PeakCorrections;Optimization\\PeakFinding;Diffraction\\Corrections";
  }
  /// Summary of algorithms purpose
  virtual const std::string summary() const {
    return "This algorithm removes peaks (at vanadium d-spacing positions by "
           "default)"
           " out of a background by linearly/quadratically interpolating over "
           "the expected peak positions. ";
  }
private:
  void init();
  void exec();
};

} // namespace Algorithms
} // namespace Mantid

#endif /* MANTID_ALGORITHMS_STRIPVANADIUMPEAKS2_H_ */