FilterPeaks.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2012 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/Algorithm.h"
#include "MantidAPI/IPeaksWorkspace.h"
#include "MantidCrystal/DllConfig.h"
 
namespace Mantid {
namespace Crystal {
 
class MANTID_CRYSTAL_DLL FilterPeaks final : public API::Algorithm {
public:
  const std::string name() const override;
  const std::string summary() const override {
    return "Filters the peaks in a peaks workspace based upon the valur of a "
           "chosen variable.";
  }
 
  int version() const override;
  const std::vector<std::string> seeAlso() const override { return {"CreatePeaksWorkspace"}; }
  const std::string category() const override;
 
private:
  using FilterFunction = std::function<double(const Geometry::IPeak &)>;
  using FilterFunctionStr = std::function<std::string(const Geometry::IPeak &)>;
 
  void init() override;
  void exec() override;
 
  FilterFunction getFilterVariableFunction(const std::string &filterVariable) const;
 
  template <typename Comparator>
  void filterPeaks(const Mantid::API::IPeaksWorkspace &inputWS, Mantid::API::IPeaksWorkspace &filteredWS,
                   const FilterFunction &filterFunction, const double filterValue) {
    Comparator operatorFunc;
    for (int i = 0; i < inputWS.getNumberPeaks(); ++i) {
      const Geometry::IPeak &currentPeak = inputWS.getPeak(i);
      const auto currentValue = filterFunction(currentPeak);
 
      if (operatorFunc(currentValue, filterValue))
        filteredWS.addPeak(currentPeak);
    }
  }
 
  template <typename Comparator>
  void filterPeaksStr(const Mantid::API::IPeaksWorkspace &inputWS, Mantid::API::IPeaksWorkspace &filteredWS,
                      const FilterFunctionStr &filterFunction, const std::string &filterValue) {
    Comparator operatorFunc;
    for (int i = 0; i < inputWS.getNumberPeaks(); ++i) {
      const Geometry::IPeak &currentPeak = inputWS.getPeak(i);
      const auto currentValue = filterFunction(currentPeak);
 
      if (operatorFunc(currentValue, filterValue))
        filteredWS.addPeak(currentPeak);
    }
  }
};
 
} // namespace Crystal
} // namespace Mantid