StripVanadiumPeaks.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2008 ISIS Rutherford Appleton Laboratory UKRI,
//   NScD Oak Ridge National Laboratory, European Spallation Source,
//   Institut Laue - Langevin & CSNS, Institute of High Energy Physics, CAS
// SPDX - License - Identifier: GPL - 3.0 +
/*
 * StripVanadiumPeaks.h
 *
 *  Created on: Sep 10, 2010
 *      Author: janik
 */
 
#pragma once
 
//----------------------------------------------------------------------
// Includes
//----------------------------------------------------------------------
#include "MantidAPI/Algorithm.h"
#include "MantidAPI/ITableWorkspace_fwd.h"
#include "MantidAlgorithms/DllConfig.h"
 
namespace Mantid {
namespace Algorithms {
class MANTID_ALGORITHMS_DLL StripVanadiumPeaks final : public API::Algorithm {
public:
  StripVanadiumPeaks();
  const std::string name() const override { return "StripVanadiumPeaks"; }
  const std::string summary() const override {
    return "This algorithm removes peaks (at vanadium d-spacing positions by "
           "default) out of a background by linearly interpolating over the "
           "expected peak positions.";
  }
 
  int version() const override { return (1); }
  const std::string category() const override {
    return "CorrectionFunctions\\PeakCorrections;Optimization\\PeakFinding;"
           "Diffraction\\Corrections";
  }
 
private:
  void init() override;
  void exec() override;
};
 
} // namespace Algorithms
} // namespace Mantid