Shape3DWithOrientation.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_Shape3DWithOrientation__H__
#define __stir_Shape_Shape3DWithOrientation__H__

#include "stir/Shape/Shape3D.h"
#include "stir/numerics/MatrixFunction.h"

START_NAMESPACE_STIR
class Succeeded;

class Shape3DWithOrientation : public Shape3D
{
  typedef Shape3D base_type;

public:
  bool operator==(const Shape3DWithOrientation& s) const;
  void scale(const CartesianCoordinate3D<float>& scale3D) override;


  const Array<2, float>& get_direction_vectors() const { return _directions; }

  Succeeded set_direction_vectors(const Array<2, float>&);

#if 0
  // TODO non-sensical after non-uniform scale
  float get_angle_alpha() const;
  float get_angle_beta()  const;
  float get_angle_gamma() const;
#endif

protected:
  Shape3DWithOrientation();

#if 0
  /
  Shape3DWithOrientation(const CartesianCoordinate3D<float>& origin,
                         const float alpha,
                         const float beta,
                         const float gamma);
#endif
  Shape3DWithOrientation(const CartesianCoordinate3D<float>& origin, const Array<2, float>& directions = diagonal_matrix(3, 1.F));

#if 0
  void
    set_directions_from_Euler_angles(
                                     const float alpha,
                                     const float beta,
                                     const float gamma);
#endif


  float get_volume_of_unit_cell() const;

  CartesianCoordinate3D<float> transform_to_shape_coords(const CartesianCoordinate3D<float>&) const;


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

private:
#if 0
  // temporary variables to store values while parsing
  float alpha_in_degrees;
  float beta_in_degrees;
  float gamma_in_degrees;
#endif

  Array<2, float> _directions;
};

END_NAMESPACE_STIR

#endif