Projection.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/DllConfig.h"
#include "MantidAPI/ITableWorkspace_fwd.h"
#include "MantidKernel/V3D.h"
 
#include <stdexcept>
 
#include <memory>
 
namespace Mantid {
namespace API {
 
enum ProjectionUnit {
  RLU,    // r.l.u
  INV_ANG // inverse angstroms
};
 
class MANTID_API_DLL Projection {
public:
  Projection();
  Projection(const Kernel::V3D &u, const Kernel::V3D &v);
  Projection(const Kernel::V3D &u, const Kernel::V3D &v, const Kernel::V3D &w);
  Projection(const ITableWorkspace &ws);
  virtual ~Projection() = default;
  double getOffset(size_t nd);
  Kernel::V3D getAxis(size_t nd);
  ProjectionUnit getUnit(size_t nd);
  void setOffset(size_t nd, double offset);
  void setAxis(size_t nd, const Kernel::V3D &axis);
  void setUnit(size_t nd, ProjectionUnit unit);
 
  Kernel::V3D &U() { return m_dimensions[0]; }
  Kernel::V3D &V() { return m_dimensions[1]; }
  Kernel::V3D &W() { return m_dimensions[2]; }
 
protected:
  Kernel::V3D m_dimensions[3];
  double m_offsets[3];
  ProjectionUnit m_units[3];
};
 
using Projection_sptr = std::shared_ptr<Projection>;
 
} // namespace API
} // namespace Mantid