ConvertSpectrumAxis2.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2015 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 "MantidAlgorithms/DllConfig.h"
#include "MantidGeometry/IDetector.h"
 
namespace Mantid {
namespace Geometry {
class DetectorInfo;
}
namespace API {
class MatrixWorkspace;
}
namespace Algorithms {
class MANTID_ALGORITHMS_DLL ConvertSpectrumAxis2 final : public API::Algorithm {
public:
  const std::string name() const override { return "ConvertSpectrumAxis"; }
  const std::string summary() const override {
    return "Converts the axis of a Workspace2D which normally holds spectrum "
           "numbers to one of Q, Q^2 or theta.  'Note': After running this "
           "algorithm, some features will be unavailable on the workspace as "
           "it will have lost all connection to the instrument. This includes "
           "things like the 3D Instrument Display.";
  }
 
  int version() const override { return (2); }
  const std::vector<std::string> seeAlso() const override { return {"ConvertAxesToRealSpace", "ConvertUnits"}; }
  const std::string category() const override { return "Transforms\\Units;Transforms\\Axes"; }
 
private:
  void init() override;
  void exec() override;
  void createThetaMap(API::Progress &progress, const std::string &targetUnit, API::MatrixWorkspace_sptr &inputWS);
  double inPlaneTwoTheta(const size_t index, const API::MatrixWorkspace_sptr &inputWS) const;
  double signedInPlaneTwoTheta(const size_t index, const API::MatrixWorkspace_sptr &inputWS) const;
  void createElasticQMap(API::Progress &progress, const std::string &targetUnit, API::MatrixWorkspace_sptr &inputWS);
  API::MatrixWorkspace_sptr createOutputWorkspace(API::Progress &progress, const std::string &targetUnit,
                                                  API::MatrixWorkspace_sptr &inputWS);
 
  std::multimap<double, size_t> m_indexMap;
 
  std::vector<double> m_axis;
 
  bool m_toOrder;
 
  void emplaceIndexMap(double value, size_t wsIndex);
 
  double getEfixed(const size_t detectorIndex, const Mantid::Geometry::DetectorInfo &detectorInfo,
                   const API::MatrixWorkspace &inputWS, const int emode) const;
};
 
} // namespace Algorithms
} // namespace Mantid