ConvertToYSpace.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2013 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/SpectrumInfo.h"
#include "MantidCurveFitting/DllConfig.h"
#include "MantidGeometry/IComponent.h"
#include "MantidGeometry/IDetector.h"
 
namespace Mantid {
class SpectrumDefinition;
 
namespace Kernel {
class V3D;
}
 
namespace Geometry {
class ComponentInfo;
class ParameterMap;
} // namespace Geometry
 
namespace CurveFitting {
namespace Algorithms {
 
struct DetectorParams {
  double l1;       
  double l2;       
  Kernel::V3D pos; 
  double theta;    
  double t0;       
  double efixed;   
};
 
class MANTID_CURVEFITTING_DLL ConvertToYSpace final : public API::Algorithm {
public:
  ConvertToYSpace();
 
  const std::string name() const override;
  const std::string summary() const override {
    return "Converts workspace in units of TOF to Y-space as defined in "
           "Compton scattering field";
  }
 
  int version() const override;
  const std::string category() const override;
 
  static DetectorParams getDetectorParameters(const API::MatrixWorkspace_const_sptr &ws, const size_t index);
  static double getComponentParameter(const Geometry::IComponent &det, const Geometry::ParameterMap &pmap,
                                      const std::string &name);
  static double getComponentParameter(const Geometry::ComponentInfo &componentInfo,
                                      const SpectrumDefinition &spectrumDefinition, const std::string &name);
  static void calculateY(double &yspace, double &qspace, double &ei, const double mass, const double tsec,
                         const double k1, const double v1, const DetectorParams &detpar);
 
private:
  void init() override;
  void exec() override;
 
  bool convert(const size_t index);
  void retrieveInputs();
  void createOutputWorkspace();
  void cacheInstrumentGeometry();
 
  API::MatrixWorkspace_sptr m_inputWS;
  double m_mass;
  double m_l1;
  Kernel::V3D m_samplePos;
 
  API::MatrixWorkspace_sptr m_outputWS;
  API::MatrixWorkspace_sptr m_qOutputWS;
};
 
} // namespace Algorithms
} // namespace CurveFitting
} // namespace Mantid