Ellipsoid.h

Go to the documentation of this file.

//
//
/*
    Copyright (C) 2000- 2007, Hammersmith Imanet Ltd
    This file is part of STIR.

    SPDX-License-Identifier: Apache-2.0

    See STIR/LICENSE.txt for details
*/
#ifndef __stir_Shape_Ellipsoid_h__
#define __stir_Shape_Ellipsoid_h__

#include "stir/RegisteredParsingObject.h"
#include "stir/Shape/Shape3DWithOrientation.h"

START_NAMESPACE_STIR

class Ellipsoid : public RegisteredParsingObject<Ellipsoid, Shape3D, Shape3DWithOrientation>
{
public:
  static const char* const registered_name;

  Ellipsoid();
  Ellipsoid(const CartesianCoordinate3D<float>& radii,
            const CartesianCoordinate3D<float>& centre,
            const Array<2, float>& direction_vectors = diagonal_matrix(3, 1.F));
  float get_geometric_volume() const override;
#if 0
  float get_geometric_area() const;
#endif

  bool is_inside_shape(const CartesianCoordinate3D<float>& coord) const override;

  Shape3D* clone() const override;


  bool operator==(const Ellipsoid&) const;

  bool operator==(const Shape3D& shape) const override;

  inline float get_radius_x() const
  {
    return radii.x();
  }
  inline float get_radius_y() const
  {
    return radii.y();
  }
  inline float get_radius_z() const
  {
    return radii.z();
  }
  inline CartesianCoordinate3D<float> get_radii() const
  {
    return radii;
  }
  void set_radii(const CartesianCoordinate3D<float>& new_radii);

protected:
  CartesianCoordinate3D<float> radii;


  void set_defaults() override;
  void initialise_keymap() override;
  bool post_processing() override;
};

END_NAMESPACE_STIR

#endif