PeakShapeEllipsoid.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 "MantidDataObjects/PeakShapeBase.h"
#include "MantidDataObjects/PeakShapeEllipsoid_fwd.h"
#include "MantidKernel/Matrix.h"
#include "MantidKernel/V3D.h"
 
namespace Mantid {
namespace DataObjects {
 
class MANTID_DATAOBJECTS_DLL PeakShapeEllipsoid : public PeakShapeBase {
public:
  PeakShapeEllipsoid(const PeakEllipsoidFrame &directions, const PeakEllipsoidExtent &abcRadii,
                     const PeakEllipsoidExtent &abcRadiiBackgroundInner,
                     const PeakEllipsoidExtent &abcRadiiBackgroundOuter, Kernel::SpecialCoordinateSystem frame,
                     std::string algorithmName = std::string(), int algorithmVersion = -1,
                     const Mantid::Kernel::V3D &translation = {0.0, 0.0, 0.0});
  bool operator==(const PeakShapeEllipsoid &other) const;
  const PeakEllipsoidExtent &abcRadii() const;
  const PeakEllipsoidExtent &abcRadiiBackgroundInner() const;
  const PeakEllipsoidExtent &abcRadiiBackgroundOuter() const;
  const PeakEllipsoidFrame &directions() const;
  const Kernel::V3D &translation() const;
  PeakEllipsoidFrame getDirectionInSpecificFrame(Kernel::Matrix<double> &invertedGoniometerMatrix) const;
 
  std::string toJSON() const override;
  PeakShapeEllipsoid *clone() const override;
  std::string shapeName() const override;
 
  std::optional<double> radius(RadiusType type = RadiusType::Radius) const override;
  static const std::string ellipsoidShapeName();
 
private:
  PeakEllipsoidFrame m_directions;
  PeakEllipsoidExtent m_abc_radii;
  PeakEllipsoidExtent m_abc_radiiBackgroundInner;
  PeakEllipsoidExtent m_abc_radiiBackgroundOuter;
  Mantid::Kernel::V3D m_translation;
};
 
using PeakShapeEllipsoid_sptr = std::shared_ptr<PeakShapeEllipsoid>;
using PeakShapeEllipsoid_const_sptr = std::shared_ptr<const PeakShapeEllipsoid>;
 
} // namespace DataObjects
} // namespace Mantid