EllipsoidalCylinder.h

Go to the documentation of this file.

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

    SPDX-License-Identifier: Apache-2.0

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

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

START_NAMESPACE_STIR

class EllipsoidalCylinder : public RegisteredParsingObject<EllipsoidalCylinder, Shape3D, Shape3DWithOrientation>
{

public:
  static const char* const registered_name;

  EllipsoidalCylinder();


  EllipsoidalCylinder(const float length_z,
                      const float radius_y,
                      const float radius_x,
                      const CartesianCoordinate3D<float>& centre,
                      const Array<2, float>& direction_vectors = diagonal_matrix(3, 1.F));


  EllipsoidalCylinder(const float length_z,
                      const float radius_y,
                      const float radius_x,
                      const float theta_1,
                      const float theta_2,
                      const CartesianCoordinate3D<float>& centre,
                      const Array<2, float>& direction_vectors = diagonal_matrix(3, 1.F));

  Shape3D* clone() const override;


  bool operator==(const EllipsoidalCylinder& cylinder) const;

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

  float get_geometric_volume() const override;
#if 0
  float get_geometric_area() const;
#endif

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

  inline float get_length() const
  {
    return length;
  }
  inline float get_radius_x() const
  {
    return radius_x;
  }
  inline float get_radius_y() const
  {
    return radius_y;
  }
  // TODOXXX add theta_1,2
  void set_length(const float);
  void set_radius_x(const float);
  void set_radius_y(const float);

protected:
  float length;
  float radius_x;
  float radius_y;
  float theta_1;
  float theta_2;


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

END_NAMESPACE_STIR

#endif