Shape3D.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_Shape3D_h__
#define __stir_Shape_Shape3D_h__

#include "stir/RegisteredObject.h"
#include "stir/ParsingObject.h"
#include "stir/CartesianCoordinate3D.h"

START_NAMESPACE_STIR

template <typename elemT>
class VoxelsOnCartesianGrid;

class Shape3D : public RegisteredObject<Shape3D>
{
public:
  ~Shape3D() override {}


  virtual inline bool operator==(const Shape3D&) const = 0;

  inline bool operator!=(const Shape3D&) const;

  virtual float get_voxel_weight(const CartesianCoordinate3D<float>& voxel_centre,
                                 const CartesianCoordinate3D<float>& voxel_size,
                                 const CartesianCoordinate3D<int>& num_samples) const;


  virtual bool is_inside_shape(const CartesianCoordinate3D<float>& coord) const = 0;


  virtual void translate(const CartesianCoordinate3D<float>& direction);

  virtual void scale(const CartesianCoordinate3D<float>& scale3D) = 0;

  inline void scale_around_origin(const CartesianCoordinate3D<float>& scale3D);

  virtual void construct_volume(VoxelsOnCartesianGrid<float>& image, const CartesianCoordinate3D<int>& num_samples) const;
  // virtual void construct_slice(PixelsOnCartesianGrid<float> &plane, const CartesianCoordinate3D<int>& num_samples) const;


  virtual float get_geometric_volume() const;
#if 0

  virtual float get_geometric_area() const;
#endif

  // TODO get_bounding_box() const;

  inline CartesianCoordinate3D<float> get_origin() const;
  virtual void set_origin(const CartesianCoordinate3D<float>&);

  virtual Shape3D* clone() const = 0;

  // need to overload this to avoid ambiguity between Object::parameter_info and ParsingObject::parameter_info()
  std::string parameter_info() override;

protected:
  inline Shape3D();
  inline explicit Shape3D(const CartesianCoordinate3D<float>& origin);


  void set_defaults() override;
  void initialise_keymap() override;
private:
  CartesianCoordinate3D<float> origin;
};

END_NAMESPACE_STIR

#include "stir/Shape/Shape3D.inl"

#endif