SofQCommon.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/Algorithm.h"
#include "MantidAPI/MatrixWorkspace_fwd.h"
#include "MantidAlgorithms/DllConfig.h"
#include "MantidGeometry/IDetector.h"
// Routines used by all SofQW algorithms intended to provide united
// user interface to all SofQ algorihtms.
namespace Mantid {
namespace Geometry {
class ComponentInfo;
}
namespace Algorithms {
 
struct MANTID_ALGORITHMS_DLL SofQCommon {
 
  int m_emode;
  bool m_efixedGiven;
  double m_efixed;
 
  // Constructor
  SofQCommon() : m_emode(0), m_efixedGiven(false), m_efixed(0.0) {}
  // init the class parameters, defined above
  void initCachedValues(const API::MatrixWorkspace &workspace, API::Algorithm const *hostAlgorithm);
 
  double getEFixed(const Geometry::IDetector &det) const;
  double getEFixed(const Geometry::ComponentInfo &componentInfo, const size_t componentIndex) const;
 
  double q(const double deltaE, const double twoTheta, const Geometry::IDetector *det) const;
  double q(const double deltaE, const double twoTheta, const double efixed) const;
 
  std::pair<double, double> qBinHints(const API::MatrixWorkspace &ws, const double minE, const double maxE) const;
 
private:
  double directQ(const double deltaE, const double twoTheta) const;
  double indirectQ(const double deltaE, const double twoTheta, const Geometry::IDetector *det) const;
  static double indirectQFromEFixed(const double deltaE, const double twoTheta, const double efixed);
  std::pair<double, double> qBinHintsDirect(const API::MatrixWorkspace &ws, const double minE, const double maxE) const;
  std::pair<double, double> qBinHintsIndirect(const API::MatrixWorkspace &ws, const double minE,
                                              const double maxE) const;
};
} // namespace Algorithms
} // namespace Mantid