SetSpecialCoordinates.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/IMDWorkspace.h"
#include "MantidCrystal/DllConfig.h"
#include <string>
#include <vector>
 
namespace Mantid {
namespace Crystal {
 
class MANTID_CRYSTAL_DLL SetSpecialCoordinates final : public API::Algorithm {
public:
  SetSpecialCoordinates();
 
  const std::string name() const override;
  const std::string summary() const override { return "Set or overwrite any Q3D special coordinates."; }
 
  int version() const override;
  const std::vector<std::string> seeAlso() const override { return {"ConvertToMD", "ConvertToDiffractionMDWorkspace"}; }
  const std::string category() const override;
 
private:
  void init() override;
  void exec() override;
  std::vector<std::string> m_specialCoordinatesNames;
  using SpecialCoordinatesNameMap = std::map<std::string, Mantid::Kernel::SpecialCoordinateSystem>;
  SpecialCoordinatesNameMap m_specialCoordinatesMap;
  static const std::string QLabOption();
  static const std::string QSampleOption();
  static const std::string HKLOption();
  bool writeCoordinatesToMDEventWorkspace(const Mantid::API::Workspace_sptr &inWS,
                                          Mantid::Kernel::SpecialCoordinateSystem coordinateSystem);
  bool writeCoordinatesToMDHistoWorkspace(const Mantid::API::Workspace_sptr &inWS,
                                          Mantid::Kernel::SpecialCoordinateSystem coordinateSystem);
  bool writeCoordinatesToPeaksWorkspace(const Mantid::API::Workspace_sptr &inWS,
                                        Mantid::Kernel::SpecialCoordinateSystem coordinateSystem);
};
 
} // namespace Crystal
} // namespace Mantid