FFTSmooth2.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 +
#pragma once
 
#include "MantidAPI/MatrixWorkspace_fwd.h"
#include "MantidAPI/ParallelAlgorithm.h"
#include "MantidAlgorithms/DllConfig.h"
 
namespace Mantid {
namespace Algorithms {
class MANTID_ALGORITHMS_DLL FFTSmooth2 : public API::ParallelAlgorithm {
public:
  const std::string name() const override { return "FFTSmooth"; }
  const std::string summary() const override { return "Performs smoothing of a spectrum using various filters."; }
 
  int version() const override { return 2; }
  const std::vector<std::string> seeAlso() const override { return {"FFT", "WienerSmooth"}; }
  const std::string category() const override { return "Arithmetic\\FFT;Transforms\\Smoothing"; }
 
private:
  // Overridden Algorithm methods
  void init() override;
  void exec() override;
 
  // Smoothing by zeroing.
  void zero(int n, API::MatrixWorkspace_sptr &unfilteredWS, API::MatrixWorkspace_sptr &filteredWS);
  // Smoothing using Butterworth filter of any positive order.
  void Butterworth(int n, int order, API::MatrixWorkspace_sptr &unfilteredWS, API::MatrixWorkspace_sptr &filteredWS);
};
 
} // namespace Algorithms
} // namespace Mantid