ConvertSpectrumAxis.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2009 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 "MantidAlgorithms/DllConfig.h"
#include "MantidGeometry/IDetector.h"
 
namespace Mantid {
namespace Algorithms {
class MANTID_ALGORITHMS_DLL ConvertSpectrumAxis 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 some other unit, which will normally be some physical "
           "value about the instrument such as 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 (1); }
  const std::string category() const override { return "Transforms\\Units;Transforms\\Axes"; }
 
private:
  void init() override;
  void exec() override;
  double getEfixed(const Mantid::Geometry::IDetector &detector, const API::MatrixWorkspace_const_sptr &inputWS,
                   int emode) const;
};
 
} // namespace Algorithms
} // namespace Mantid