ParametricDiscretisedDensity.h

Go to the documentation of this file.

//
//
#ifndef __stir_modelling_ParametricDiscretisedDensity_H__
#define __stir_modelling_ParametricDiscretisedDensity_H__
/*
    Copyright (C) 2006 - 2011, Hammersmith Imanet Ltd
    Copyright (C) 2019 - 2020, University College London
    This file is part of STIR.

    SPDX-License-Identifier: Apache-2.0

    See STIR/LICENSE.txt for details
*/
#include "stir/DiscretisedDensity.h"
#include "stir/NestedIterator.h"
// for ParametricVoxelsOnCartesianGrid typedef
#include "stir/VoxelsOnCartesianGrid.h"
#include "stir/modelling/KineticParameters.h"
START_NAMESPACE_STIR
template <typename DiscDensT>
class ParametricDiscretisedDensity;

class DynamicDiscretisedDensity;

template <typename DiscDensT>
struct Parametric2Single;

template <typename DiscDensT>
struct Parametric2Single<ParametricDiscretisedDensity<DiscDensT>>
{
  typedef typename Parametric2Single<DiscDensT>::type type;
};

template <int num_parameters, typename elemT>
struct Parametric2Single<VoxelsOnCartesianGrid<KineticParameters<num_parameters, elemT>>>
{
  typedef VoxelsOnCartesianGrid<elemT> type;
};


template <typename DiscDensT>
class ParametricDiscretisedDensity : public DiscDensT
{
private:
  //  typedef DiscretisedDensity<num_dimensions, KinParsT> base_type;
  typedef DiscDensT base_type;

public:

  typedef ParametricDiscretisedDensity hierarchy_base_type;

  typedef typename Parametric2Single<DiscDensT>::type SingleDiscretisedDensityType;

  typedef typename base_type::full_iterator full_densel_iterator;
  typedef typename base_type::const_full_iterator const_full_densel_iterator;

  typedef NestedIterator<full_densel_iterator, BeginEndFunction<full_densel_iterator>> full_iterator;
  typedef NestedIterator<const_full_densel_iterator, ConstBeginEndFunction<const_full_densel_iterator>> const_full_iterator;

  static ParametricDiscretisedDensity* read_from_file(const std::string& filename);

  static unsigned int get_num_params();

  ParametricDiscretisedDensity(const base_type& density)
      : base_type(density)
  {}


  ParametricDiscretisedDensity(const DynamicDiscretisedDensity& dyn_im);


  ParametricDiscretisedDensity(const SingleDiscretisedDensityType& im);

  // implementation works, although only for VoxelsOnCartesianGrid , but not needed for now
  // ParametricDiscretisedDensity(const VectorWithOffset<shared_ptr<SingleDiscretisedDensityType> > & densities);

  // implementation works, but not needed for now
  // void update_parametric_image(const VectorWithOffset<shared_ptr<SingleDiscretisedDensityType> > &  densities);

  void update_parametric_image(const SingleDiscretisedDensityType& single_density, const unsigned int param_num);

  full_iterator begin_all() { return full_iterator(base_type::begin_all(), base_type::end_all()); }

  const_full_iterator begin_all_const() const
  {
    return const_full_iterator(base_type::begin_all_const(), base_type::end_all_const());
  }

  full_iterator end_all() { return full_iterator(base_type::end_all(), base_type::end_all()); }

  const_full_iterator end_all_const() const
  {
    return const_full_iterator(base_type::end_all_const(), base_type::end_all_const());
  }

  const_full_iterator begin_all() const { return this->begin_all_const(); }

  const_full_iterator end_all() const { return this->end_all_const(); }

  full_densel_iterator begin_all_densel() { return base_type::begin_all(); }

  const_full_densel_iterator begin_all_densel_const() const { return base_type::begin_all_const(); }

  full_densel_iterator end_all_densel() { return base_type::end_all(); }

  const_full_densel_iterator end_all_densel_const() const { return base_type::end_all_const(); }

  const_full_densel_iterator begin_all_densel() const { return this->begin_all_densel_const(); }

  const_full_densel_iterator end_all_densel() const { return this->end_all_densel_const(); }

  ParametricDiscretisedDensity* get_empty_copy() const override;

  ParametricDiscretisedDensity* clone() const override;

  template <class KPFunctionObject>
  void construct_single_density_using_function(SingleDiscretisedDensityType& density, KPFunctionObject f) const;

  template <class KPFunctionObject>
  const SingleDiscretisedDensityType construct_single_density_using_function(KPFunctionObject f) const;


  void construct_single_density(SingleDiscretisedDensityType& density, const int i) const;

  const SingleDiscretisedDensityType construct_single_density(const int index) const;
#if 0 
  // can't be done really
  SingleDiscretisedDensityType &
    construct_single_density(const int index);
#endif

};

typedef VoxelsOnCartesianGrid<KineticParameters<2, float>> ParametricVoxelsOnCartesianGridBaseType;

typedef ParametricDiscretisedDensity<ParametricVoxelsOnCartesianGridBaseType> ParametricVoxelsOnCartesianGrid;

END_NAMESPACE_STIR
//#include "stir/modelling/ParametricDiscretisedDensity.inl"

#endif //__stir_modelling_ParametricDiscretisedDensity_H__