BSplinesRegularGrid.h

Go to the documentation of this file.

/*
  Copyright (C) 2005 - 2009-10-27, Hammersmith Imanet Ltd
  Copyright (C) 2013, University College London
  This file is part of STIR.

  SPDX-License-Identifier: Apache-2.0

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

#include "stir/Array.h"
#include "stir/BasicCoordinate.h"
#include "stir/numerics/BSplines.h"
START_NAMESPACE_STIR

namespace BSpline
{

template <int num_dimensions, typename out_elemT, typename in_elemT = out_elemT, typename constantsT = in_elemT>
class BSplinesRegularGrid
{

public:
  // only there for tests
  Array<num_dimensions, out_elemT> get_coefficients() const { return this->_coeffs; }

  inline explicit BSplinesRegularGrid(const Array<num_dimensions, in_elemT>& input, const BSplineType& this_type = cubic)
  {
    this->set_private_values(this_type);
    this->set_coef(input);
  }

  inline BSplinesRegularGrid(const Array<num_dimensions, in_elemT>& input,
                             const BasicCoordinate<num_dimensions, BSplineType>& this_type)
  {
    this->set_private_values(this_type);
    this->set_coef(input);
  }


  inline explicit BSplinesRegularGrid(const BSplineType& this_type = cubic) { this->set_private_values(this_type); }


  inline explicit BSplinesRegularGrid(const BasicCoordinate<num_dimensions, BSplineType>& this_type)
  {
    this->set_private_values(this_type);
  }

  inline ~BSplinesRegularGrid();


  inline void set_coef(const Array<num_dimensions, in_elemT>& input);


  inline const out_elemT operator()(const BasicCoordinate<num_dimensions, pos_type>& relative_positions) const;


  inline const BasicCoordinate<num_dimensions, out_elemT>
  gradient(const BasicCoordinate<num_dimensions, pos_type>& relative_positions) const;

private:
  // variables that store numbers for the spline type
  // TODO these coefficients and the spline type could/should be integrated into 1 class
  BasicCoordinate<num_dimensions, BSplineType> _spline_types;
  BasicCoordinate<num_dimensions, constantsT> _z1s;
  BasicCoordinate<num_dimensions, constantsT> _z2s;
  BasicCoordinate<num_dimensions, constantsT> _lambdas;
  Array<num_dimensions, out_elemT> _coeffs;

  inline void set_private_values(const BasicCoordinate<num_dimensions, BSplineType>& this_type);
  inline void set_private_values(const BSplineType& this_type);
};

} // namespace BSpline

END_NAMESPACE_STIR

#include "stir/numerics/BSplinesRegularGrid.inl"

#endif