ConvertUnits.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2008 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/DistributedAlgorithm.h"
#include "MantidAlgorithms/DllConfig.h"
#include "MantidDataObjects/EventWorkspace.h"
#include "MantidKernel/Unit.h"
 
namespace Mantid {
namespace Algorithms {
class MANTID_ALGORITHMS_DLL ConvertUnits : public API::DistributedAlgorithm {
public:
  const std::string name() const override { return "ConvertUnits"; }
  const std::string summary() const override { return "Performs a unit change on the X values of a workspace"; }
 
  int version() const override { return 1; }
  const std::vector<std::string> seeAlso() const override {
    return {"ConvertAxisByFormula", "ConvertAxesToRealSpace", "ConvertSpectrumAxis", "ConvertToYSpace"};
  }
  const std::string category() const override { return "Transforms\\Units"; }
 
protected:
  void reverse(const API::MatrixWorkspace_sptr &WS);
 
  API::MatrixWorkspace_sptr removeUnphysicalBins(const API::MatrixWorkspace_const_sptr &workspace);
 
  const std::string workspaceMethodName() const override { return "convertUnits"; }
  const std::string workspaceMethodInputProperty() const override { return "InputWorkspace"; }
 
  // Overridden Algorithm methods
  void init() override;
  void exec() override;
 
  void setupMemberVariables(const API::MatrixWorkspace_const_sptr &inputWS);
  virtual void storeEModeOnWorkspace(API::MatrixWorkspace_sptr outputWS);
  API::MatrixWorkspace_sptr setupOutputWorkspace(const API::MatrixWorkspace_const_sptr &inputWS);
 
  API::MatrixWorkspace_sptr executeUnitConversion(const API::MatrixWorkspace_sptr &inputWS);
 
  API::MatrixWorkspace_sptr convertQuickly(const API::MatrixWorkspace_const_sptr &inputWS, const double &factor,
                                           const double &power);
 
  virtual API::MatrixWorkspace_sptr convertViaTOF(Kernel::Unit_const_sptr fromUnit,
                                                  API::MatrixWorkspace_const_sptr inputWS);
 
  // Calls Rebin as a Child Algorithm to align the bins of the output workspace
  API::MatrixWorkspace_sptr alignBins(const API::MatrixWorkspace_sptr &workspace);
  const std::vector<double> calculateRebinParams(const API::MatrixWorkspace_const_sptr &workspace) const;
 
  void putBackBinWidth(const API::MatrixWorkspace_sptr &outputWS);
 
  std::size_t m_numberOfSpectra{0}; 
  bool m_distribution{false};       
  bool m_inputEvents{false};           
  Kernel::Unit_const_sptr m_inputUnit; 
  Kernel::Unit_sptr m_outputUnit;      
};
 
} // namespace Algorithms
} // namespace Mantid