FindSXPeaksHelper.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2018 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/SpectrumInfo.h"
#include "MantidCrystal/DllConfig.h"
#include "MantidHistogramData/HistogramE.h"
#include "MantidHistogramData/HistogramX.h"
#include "MantidHistogramData/HistogramY.h"
#include "MantidKernel/EmptyValues.h"
 
#include <iterator>
#include <optional>
#include <vector>
 
namespace Mantid {
namespace Kernel {
class ProgressBase;
}
} // namespace Mantid
 
namespace Mantid {
namespace Crystal {
namespace FindSXPeaksHelper {
 
enum class XAxisUnit { TOF, DSPACING };
 
/* ------------------------------------------------------------------------------------------
 * Single Crystal peak representation
 * ------------------------------------------------------------------------------------------
 */
struct MANTID_CRYSTAL_DLL SXPeak {
public:
  SXPeak(double t, double phi, double intensity, const std::vector<int> &spectral, const size_t wsIndex,
         const Mantid::API::SpectrumInfo &spectrumInfo);
 
  bool compare(const SXPeak &rhs, double tolerance) const;
 
  bool compare(const SXPeak &rhs, const double xTolerance, const double phiTolerance, const double thetaTolerance,
               const XAxisUnit tofUnits = XAxisUnit::TOF) const;
 
  Mantid::Kernel::V3D getQ() const;
 
  SXPeak &operator+=(const SXPeak &rhs);
 
  void reduce();
 
  friend std::ostream &operator<<(std::ostream &os, const SXPeak &rhs) {
    os << rhs.m_tof << "," << rhs.m_twoTheta << "," << rhs.m_phi << "," << rhs.m_intensity << "\n";
    os << " Spectra";
    std::copy(rhs.m_spectra.begin(), rhs.m_spectra.end(), std::ostream_iterator<int>(os, ","));
    return os;
  }
 
  const double &getIntensity() const;
 
  detid_t getDetectorId() const;
 
  const std::vector<int> &getPeakSpectras() const;
 
private:
  double m_tof;
  double m_dSpacing;
  double m_twoTheta;
  double m_phi;
  double m_intensity;
  std::vector<int> m_spectra;
  double m_LTotal;
  size_t m_wsIndex;
  detid_t m_detId;
  int m_nPixels;
  Kernel::V3D m_unitWaveVector;
  std::string m_qConvention;
};
 
using yIt = Mantid::HistogramData::HistogramY::const_iterator;
using Bound = HistogramData::HistogramX::const_iterator;
using BoundsIterator = std::pair<Bound, Bound>;
using PeakList = std::optional<std::vector<SXPeak>>;
 
class PeakContainer {
public:
  PeakContainer(const HistogramData::HistogramY &y);
  void startRecord(yIt item);
  void stopRecord(yIt item);
  void record(yIt item);
  size_t getNumberOfPointsInPeak() const;
  yIt getMaxIterator() const;
  double getStartingSignal() const;
 
private:
  const HistogramData::HistogramY &m_y;
  size_t m_startIndex;
  size_t m_stopIndex;
  size_t m_maxIndex;
  double m_maxSignal = -1.;
};
 
/* ------------------------------------------------------------------------------------------
 * Background strategy
 * ------------------------------------------------------------------------------------------
 */
struct MANTID_CRYSTAL_DLL BackgroundStrategy {
  virtual ~BackgroundStrategy() = default;
  virtual bool isBelowBackground(const double intensity, const HistogramData::HistogramY &y) const = 0;
};
 
struct MANTID_CRYSTAL_DLL AbsoluteBackgroundStrategy : public BackgroundStrategy {
  AbsoluteBackgroundStrategy(const double background);
  bool isBelowBackground(const double intensity, const HistogramData::HistogramY &) const override;
 
private:
  double m_background = 0.;
};
 
struct MANTID_CRYSTAL_DLL PerSpectrumBackgroundStrategy : public BackgroundStrategy {
  PerSpectrumBackgroundStrategy(const double backgroundMultiplier);
  bool isBelowBackground(const double intensity, const HistogramData::HistogramY &y) const override;
 
private:
  double m_backgroundMultiplier = 1.;
};
 
/* ------------------------------------------------------------------------------------------
 * Peak Finding Strategy
 * ------------------------------------------------------------------------------------------
 */
class MANTID_CRYSTAL_DLL PeakFindingStrategy {
public:
  PeakFindingStrategy(const BackgroundStrategy *backgroundStrategy, const API::SpectrumInfo &spectrumInfo,
                      const double minValue = EMPTY_DBL(), const double maxValue = EMPTY_DBL(),
                      const XAxisUnit units = XAxisUnit::TOF);
  virtual ~PeakFindingStrategy() = default;
  PeakList findSXPeaks(const HistogramData::HistogramX &x, const HistogramData::HistogramY &y,
                       const HistogramData::HistogramE &e, const int workspaceIndex) const;
  void setMinNBinsPerPeak(int minBinsPerPeak);
 
protected:
  void filterPeaksForMinBins(std::vector<std::unique_ptr<PeakContainer>> &inputPeakList) const;
 
  BoundsIterator getBounds(const HistogramData::HistogramX &x) const;
  double calculatePhi(size_t workspaceIndex) const;
  double getXValue(const HistogramData::HistogramX &x, const size_t peakLocation) const;
  double convertToTOF(const double xValue, const size_t workspaceIndex) const;
  virtual PeakList dofindSXPeaks(const HistogramData::HistogramX &x, const HistogramData::HistogramY &y,
                                 const HistogramData::HistogramE &e, Bound low, Bound high,
                                 const int workspaceIndex) const = 0;
  PeakList convertToSXPeaks(const HistogramData::HistogramX &x, const HistogramData::HistogramY &y,
                            const std::vector<std::unique_ptr<PeakContainer>> &peaks, const int workspaceIndex) const;
 
  const BackgroundStrategy *m_backgroundStrategy;
  const double m_minValue = EMPTY_DBL();
  const double m_maxValue = EMPTY_DBL();
  const API::SpectrumInfo &m_spectrumInfo;
  const XAxisUnit m_units;
  int m_minNBinsPerPeak = EMPTY_INT();
};
 
class MANTID_CRYSTAL_DLL StrongestPeaksStrategy : public PeakFindingStrategy {
public:
  StrongestPeaksStrategy(const BackgroundStrategy *backgroundStrategy, const API::SpectrumInfo &spectrumInfo,
                         const double minValue = EMPTY_DBL(), const double maxValue = EMPTY_DBL(),
                         const XAxisUnit units = XAxisUnit::TOF);
  PeakList dofindSXPeaks(const HistogramData::HistogramX &x, const HistogramData::HistogramY &y,
                         [[maybe_unused]] const HistogramData::HistogramE &e, Bound low, Bound high,
                         const int workspaceIndex) const override;
};
 
class MANTID_CRYSTAL_DLL AllPeaksStrategy : public PeakFindingStrategy {
public:
  AllPeaksStrategy(const BackgroundStrategy *backgroundStrategy, const API::SpectrumInfo &spectrumInfo,
                   const double minValue = EMPTY_DBL(), const double maxValue = EMPTY_DBL(),
                   const XAxisUnit units = XAxisUnit::TOF);
  PeakList dofindSXPeaks(const HistogramData::HistogramX &x, const HistogramData::HistogramY &y,
                         [[maybe_unused]] const HistogramData::HistogramE &e, Bound low, Bound high,
                         const int workspaceIndex) const override;
 
private:
  std::vector<std::unique_ptr<PeakContainer>>
  getAllPeaks(const HistogramData::HistogramX &x, const HistogramData::HistogramY &y, Bound low, Bound high,
              const Mantid::Crystal::FindSXPeaksHelper::BackgroundStrategy *backgroundStrategy) const;
};
 
#define NSIGMA_COMPARISON_THRESHOLD 1e-10
 
class MANTID_CRYSTAL_DLL NSigmaPeaksStrategy : public PeakFindingStrategy {
public:
  NSigmaPeaksStrategy(const API::SpectrumInfo &spectrumInfo, const double nsigma = EMPTY_DBL(),
                      const double minValue = EMPTY_DBL(), const double maxValue = EMPTY_DBL(),
                      const XAxisUnit units = XAxisUnit::TOF);
  PeakList dofindSXPeaks(const HistogramData::HistogramX &x, const HistogramData::HistogramY &y,
                         const HistogramData::HistogramE &e, Bound low, Bound high,
                         const int workspaceIndex) const override;
 
private:
  std::vector<std::unique_ptr<PeakContainer>> getAllNSigmaPeaks(const HistogramData::HistogramX &x,
                                                                const HistogramData::HistogramY &y,
                                                                const HistogramData::HistogramE &e, Bound low,
                                                                Bound high) const;
  const double m_nsigma;
};
 
/* ------------------------------------------------------------------------------------------
 * Comparison Strategy
 * ------------------------------------------------------------------------------------------
 */
class MANTID_CRYSTAL_DLL CompareStrategy {
public:
  virtual ~CompareStrategy() = default;
  virtual bool compare(const SXPeak &lhs, const SXPeak &rhs) const = 0;
};
 
class MANTID_CRYSTAL_DLL RelativeCompareStrategy : public CompareStrategy {
public:
  RelativeCompareStrategy(const double resolution);
  bool compare(const SXPeak &lhs, const SXPeak &rhs) const override;
 
private:
  const double m_resolution;
};
 
class MANTID_CRYSTAL_DLL AbsoluteCompareStrategy : public CompareStrategy {
public:
  AbsoluteCompareStrategy(const double tofResolution, const double phiResolution, const double twoThetaResolution,
                          const XAxisUnit units = XAxisUnit::TOF);
  bool compare(const SXPeak &lhs, const SXPeak &rhs) const override;
 
private:
  const double m_xUnitResolution;
  double m_phiResolution;
  double m_twoThetaResolution;
  const XAxisUnit m_units;
};
 
/* ------------------------------------------------------------------------------------------
 * PeakListReduction Strategy
 * ------------------------------------------------------------------------------------------
 */
class MANTID_CRYSTAL_DLL ReducePeakListStrategy {
public:
  ReducePeakListStrategy(const CompareStrategy *compareStrategy);
  virtual ~ReducePeakListStrategy() = default;
  virtual std::vector<SXPeak> reduce(const std::vector<SXPeak> &peaks,
                                     Mantid::Kernel::ProgressBase &progress) const = 0;
 
  void setMinNSpectraPerPeak(int minSpectrasForPeak);
  void setMaxNSpectraPerPeak(int maxSpectrasForPeak);
 
protected:
  const CompareStrategy *m_compareStrategy;
  int m_minNSpectraPerPeak = EMPTY_INT();
  int m_maxNSpectraPerPeak = EMPTY_INT();
};
 
class MANTID_CRYSTAL_DLL SimpleReduceStrategy : public ReducePeakListStrategy {
public:
  SimpleReduceStrategy(const CompareStrategy *compareStrategy);
  std::vector<SXPeak> reduce(const std::vector<SXPeak> &peaks, Mantid::Kernel::ProgressBase &progress) const override;
 
private:
  void reducePeaksFromNumberOfSpectras(std::vector<SXPeak> &inputPeaks) const;
};
 
class MANTID_CRYSTAL_DLL FindMaxReduceStrategy : public ReducePeakListStrategy {
public:
  FindMaxReduceStrategy(const CompareStrategy *compareStrategy);
  std::vector<SXPeak> reduce(const std::vector<SXPeak> &peaks, Mantid::Kernel::ProgressBase &progress) const override;
 
private:
  std::vector<std::vector<SXPeak *>> getPeakGroups(const std::vector<SXPeak> &peakList,
                                                   Mantid::Kernel::ProgressBase &progress) const;
  std::vector<SXPeak> getFinalPeaks(const std::vector<std::vector<SXPeak *>> &peakGroups) const;
};
 
} // namespace FindSXPeaksHelper
} // namespace Crystal
} // namespace Mantid