PaddingAndApodization.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
 
//----------------------------------------------------------------------
// Includes
//----------------------------------------------------------------------
#include "MantidAPI/Algorithm.h"
#include "MantidAlgorithms/DllConfig.h"
#include "MantidHistogramData/Histogram.h"
#include "MantidKernel/cow_ptr.h"
 
namespace Mantid {
namespace Algorithms {
class MANTID_ALGORITHMS_DLL PaddingAndApodization final : public API::Algorithm {
public:
  const std::string name() const override { return "PaddingAndApodization"; }
  const std::string summary() const override {
    return "This algorithm applies apodization and/or padding to input data.";
  }
 
  int version() const override { return 1; }
  const std::string category() const override { return "Arithmetic\\FFT"; }
 
private:
  // Overridden Algorithm methods
  void init() override;
  void exec() override;
  using fptr = double (*)(const double, const double);
  fptr getApodizationFunction(const std::string &method);
  HistogramData::Histogram applyApodizationFunction(const HistogramData::Histogram &histogram,
                                                    const double decayConstant, fptr function);
  HistogramData::Histogram addPadding(const HistogramData::Histogram &histogram, const int padding);
};
 
} // namespace Algorithms
} // namespace Mantid