DiscretisedDensityOnCartesianGrid.h

Go to the documentation of this file.

//
//
#ifndef __stir_DiscretisedDensityOnCartesianGrid_H__
#define __stir_DiscretisedDensityOnCartesianGrid_H__
/*
    Copyright (C) 2000- 2007, Hammersmith Imanet Ltd
    Copyright (C) 2000 PARAPET partners
    Copyright (C) 2018, University College London
    This file is part of STIR.

    SPDX-License-Identifier: Apache-2.0 AND License-ref-PARAPET-license

    See STIR/LICENSE.txt for details
 */
#include "stir/DiscretisedDensity.h"

START_NAMESPACE_STIR

template <int num_dimensions, typename elemT>
class DiscretisedDensityOnCartesianGrid : public DiscretisedDensity<num_dimensions, elemT>
{
private:
  typedef DiscretisedDensity<num_dimensions, elemT> base_type;

public:
  inline DiscretisedDensityOnCartesianGrid();

  inline DiscretisedDensityOnCartesianGrid(const IndexRange<num_dimensions>& range,
                                           const CartesianCoordinate3D<float>& origin,
                                           const BasicCoordinate<num_dimensions, float>& grid_spacing);

  inline DiscretisedDensityOnCartesianGrid(const shared_ptr<const ExamInfo>& exam_info_sptr,
                                           const IndexRange<num_dimensions>& range,
                                           const CartesianCoordinate3D<float>& origin,
                                           const BasicCoordinate<num_dimensions, float>& grid_spacing);

  inline const BasicCoordinate<num_dimensions, float>& get_grid_spacing() const;

  inline void set_grid_spacing(const BasicCoordinate<num_dimensions, float>& grid_spacing_v);

protected:
  inline bool actual_has_same_characteristics(DiscretisedDensity<num_dimensions, elemT> const&,
                                              std::string& explanation) const override;


  inline CartesianCoordinate3D<float>
  actual_get_relative_coordinates_for_indices(const BasicCoordinate<num_dimensions, float>& indices) const override;


  inline BasicCoordinate<num_dimensions, float>
  actual_get_index_coordinates_for_relative_coordinates(const CartesianCoordinate3D<float>& coords) const override;

private:
  BasicCoordinate<num_dimensions, float> grid_spacing;
};

END_NAMESPACE_STIR

#include "stir/DiscretisedDensityOnCartesianGrid.inl"
#endif