PeakShapeSpherical.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 "MantidKernel/SpecialCoordinateSystem.h"
#include <boost/optional.hpp>
#include <string>
 
namespace Mantid {
namespace DataObjects {
 
class MANTID_DATAOBJECTS_DLL PeakShapeSpherical : public PeakShapeBase {
public:
  PeakShapeSpherical(const double &peakRadius, Kernel::SpecialCoordinateSystem frame,
                     std::string algorithmName = std::string(), int algorithmVersion = -1);
  PeakShapeSpherical(const double &peakRadius, const double &peakInnerRadius, const double &peakOuterRadius,
                     Kernel::SpecialCoordinateSystem frame, std::string algorithmName = std::string(),
                     int algorithmVersion = -1);
  std::string toJSON() const override;
  PeakShapeSpherical *clone() const override;
  std::string shapeName() const override;
  bool operator==(const PeakShapeSpherical &other) const;
  boost::optional<double> radius(RadiusType type = RadiusType::Radius) const override;
  boost::optional<double> backgroundOuterRadius() const;
  boost::optional<double> backgroundInnerRadius() const;
  static const std::string sphereShapeName();
 
private:
  double m_radius;
  boost::optional<double> m_backgroundInnerRadius;
  boost::optional<double> m_backgroundOuterRadius;
};
 
} // namespace DataObjects
} // namespace Mantid