DiscretisedShape3D.h

Go to the documentation of this file.

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

    SPDX-License-Identifier: Apache-2.0

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

#include "stir/RegisteredParsingObject.h"
#include "stir/Shape/Shape3D.h"
#include "stir/shared_ptr.h"
#include "stir/error.h"

START_NAMESPACE_STIR

template <int num_dimensions, typename elemT>
class DiscretisedDensity;

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

  DiscretisedShape3D();


  DiscretisedShape3D(const VoxelsOnCartesianGrid<float>& image);


  DiscretisedShape3D(const shared_ptr<const DiscretisedDensity<3, float>>& density_sptr);


  bool operator==(const Shape3D&) const override
  {
    error("DiscretisedShape3D::operator== not implemented. Sorry");
    return false;
  }

  void set_origin(const CartesianCoordinate3D<float>&) override;


  void scale(const CartesianCoordinate3D<float>& scale3D) override
  {
    error("TODO: DiscretisedShape3D::scale not implemented. Sorry.");
  }


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


  float get_voxel_weight(const CartesianCoordinate3D<float>& coord,
                         const CartesianCoordinate3D<float>& voxel_size,
                         const CartesianCoordinate3D<int>& num_samples) const override;


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

  Shape3D* clone() const override;

  DiscretisedDensity<3, float>& get_discretised_density();

  const DiscretisedDensity<3, float>& get_discretised_density() const;

  int get_label_index() const;
  void set_label_index(int label_index);

private:
  int _label_index;
  shared_ptr<DiscretisedDensity<3, float>> density_sptr;

  inline const VoxelsOnCartesianGrid<float>& image() const;
  // inline VoxelsOnCartesianGrid<float>& image();


  void set_defaults() override;
  void initialise_keymap() override;

  bool post_processing() override;
  std::string filename;
};

END_NAMESPACE_STIR

#include "stir/Shape/DiscretisedShape3D.inl"

#endif