base.h

Go to the documentation of this file.

/* Copyright (c) 2008-2022 the MRtrix3 contributors.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * Covered Software is provided under this License on an "as is"
 * basis, without warranty of any kind, either expressed, implied, or
 * statutory, including, without limitation, warranties that the
 * Covered Software is free of defects, merchantable, fit for a
 * particular purpose or non-infringing.
 * See the Mozilla Public License v. 2.0 for more details.
 *
 * For more details, see http://www.mrtrix.org/.
 */
 
#ifndef __interp_base_h__
#define __interp_base_h__
 
#include "image_helpers.h"
#include "transform.h"
 
 
namespace MR
{
 
  class Header;
 
  namespace Interp
  {
 
    // @{
 
 
    template <class ImageType> class Base : public ImageType, public Transform
    { MEMALIGN(Base<ImageType>)
      public:
        using image_type = ImageType;
        using value_type = typename ImageType::value_type;
 
        Base (const ImageType& parent, value_type value_when_out_of_bounds = default_out_of_bounds_value()) :
            ImageType (parent),
            Transform (parent),
            out_of_bounds_value (value_when_out_of_bounds),
            bounds { parent.size(0) - 0.5, parent.size(1) - 0.5, parent.size(2) - 0.5 },
            out_of_bounds (true) { }
 
 
 
 
 
 
 
 
        // Value to return when the position is outside the bounds of the image volume
        const value_type out_of_bounds_value;
 
        static inline value_type default_out_of_bounds_value () {
          return std::numeric_limits<value_type>::quiet_NaN();
        }
 
 
        bool operator! () const { return out_of_bounds; }
 
 
 
      protected:
        default_type bounds[3];
        bool out_of_bounds;
 
 
        // Some helper functions
        template <class VectorType>
        bool set_out_of_bounds (const VectorType& pos) {
          return ((out_of_bounds = (pos[0] <= -0.5 || pos[0] >= bounds[0] ||
                                    pos[1] <= -0.5 || pos[1] >= bounds[1] ||
                                    pos[2] <= -0.5 || pos[2] >= bounds[2])));
        }
 
        void set_out_of_bounds (const bool value) {
          out_of_bounds = value;
        }
 
        template <class VectorType>
        Eigen::Vector3d intravoxel_offset (const VectorType& pos) {
          if (set_out_of_bounds (pos))
            return Eigen::Vector3d (NaN, NaN, NaN);
          return Eigen::Vector3d (pos[0]-std::floor (pos[0]), pos[1]-std::floor (pos[1]), pos[2]-std::floor (pos[2]));
        }
 
    };
 
 
 
 
  }
}
 
#endif