FindSXPeaks.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2007 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 "MantidAPI/SpectrumInfo.h"
#include "MantidCrystal/DllConfig.h"
#include "MantidCrystal/FindSXPeaksHelper.h"
#include "MantidDataObjects/PeaksWorkspace.h"
 
#include <vector>
 
namespace Mantid {
namespace Crystal {
 
using peakvector = std::vector<FindSXPeaksHelper::SXPeak>;
 
class MANTID_CRYSTAL_DLL FindSXPeaks final : public API::Algorithm {
public:
  FindSXPeaks();
  const std::string name() const override { return "FindSXPeaks"; }
  const std::string summary() const override {
    return "Takes a 2D workspace as input and finds the highest intensity "
           "point in each 1D spectrum. This is used in particular for single "
           "crystal as a quick way to find strong peaks.";
  }
 
  int version() const override { return (1); }
  const std::vector<std::string> seeAlso() const override { return {"IndexSXPeaks"}; }
  const std::string category() const override { return "Crystal\\Peaks;Optimization\\PeakFinding"; }
 
  static const std::string strongestPeakStrategy;
  static const std::string allPeaksStrategy;
  static const std::string relativeResolutionStrategy;
  static const std::string absoluteResolutionPeaksStrategy;
 
private:
  // Overridden Algorithm methods
  void init() override;
  void exec() override;
  std::map<std::string, std::string> validateInputs() override;
 
  std::unique_ptr<FindSXPeaksHelper::BackgroundStrategy> getBackgroundStrategy() const;
 
  std::unique_ptr<FindSXPeaksHelper::PeakFindingStrategy>
  getPeakFindingStrategy(const FindSXPeaksHelper::BackgroundStrategy *backgroundStrategy,
                         const API::SpectrumInfo &spectrumInfo, const double minValue, const double maxValue,
                         const FindSXPeaksHelper::XAxisUnit tofUnits = FindSXPeaksHelper::XAxisUnit::TOF) const;
 
  std::unique_ptr<FindSXPeaksHelper::ReducePeakListStrategy>
  getReducePeakListStrategy(const FindSXPeaksHelper::CompareStrategy *compareStrategy) const;
 
  std::unique_ptr<FindSXPeaksHelper::CompareStrategy> getCompareStrategy() const;
 
  //
  void reducePeakList(const peakvector &, Mantid::API::Progress &progress);
 
  FindSXPeaksHelper::XAxisUnit getWorkspaceXAxisUnit(const Mantid::API::MatrixWorkspace_const_sptr &workspace) const;
 
  double m_MinRange;
  double m_MaxRange;
  size_t m_MinWsIndex;
  size_t m_MaxWsIndex;
  // The peaks workspace that contains the peaks information.
  Mantid::DataObjects::PeaksWorkspace_sptr m_peaks;
};
 
} // namespace Crystal
} // namespace Mantid