1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
|
/* 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_nearest_h__
#define __interp_nearest_h__
#include "datatype.h"
#include "image_helpers.h"
#include "types.h"
#include "interp/base.h"
namespace MR
{
namespace Interp
{
//! \addtogroup interp
// @{
//! This class provides access to the voxel intensities of an Image, using nearest-neighbour interpolation.
/*! Interpolation is only performed along the first 3 (spatial) axes.
* The (integer) position along the remaining axes should be set using the
* template Image class.
* The spatial coordinates can be set using the functions voxel(), image(),
* and scanner().
* For example:
* \code
* auto input = Image<float>::create (Argument[0]);
*
* // create an Interp::Nearest object using input as the parent data set:
* Interp::Nearest<decltype(input) > interp (input);
*
* // set the scanner-space position to [ 10.2 3.59 54.1 ]:
* interp.scanner (10.2, 3.59, 54.1);
*
* // get the value at this position:
* float value = interp.value();
* \endcode
*
* The template \a input class must be usable with this type of syntax:
* \code
* int xsize = input.size(0); // return the dimension
* int ysize = input.size(1); // along the x, y & z dimensions
* int zsize = input.size(2);
* float v[] = { input.spacing(0), input.spacing(1), input.spacing(2) }; // return voxel dimensions
* input.index(0) = 0; // these lines are used to
* input.index(1)--; // set the current position
* input.index(2)++; // within the data set
* float f = input.value();
* transform_type M = input.transform(); // a valid 4x4 transformation matrix
* \endcode
*/
template <class ImageType>
class Nearest : public Base<ImageType> { MEMALIGN(Nearest<ImageType>)
public:
using typename Base<ImageType>::value_type;
using Base<ImageType>::index;
using Base<ImageType>::out_of_bounds;
using Base<ImageType>::out_of_bounds_value;
Nearest (const ImageType& parent, value_type value_when_out_of_bounds = Base<ImageType>::default_out_of_bounds_value()) :
Base<ImageType> (parent, value_when_out_of_bounds) { }
//! Set the current position to <b>voxel space</b> position \a pos
/*! See file interp/base.h for details. */
template <class VectorType>
bool voxel (const VectorType& pos) {
Base<ImageType>::intravoxel_offset (pos);
if (out_of_bounds)
return false;
index(0) = std::round (pos[0]);
index(1) = std::round (pos[1]);
index(2) = std::round (pos[2]);
return true;
}
//! Set the current position to <b>image space</b> position \a pos
/*! See file interp/base.h for details. */
template <class VectorType>
FORCE_INLINE bool image (const VectorType& pos) {
return voxel (Transform::voxelsize.inverse() * pos.template cast<default_type>());
}
//! Set the current position to the <b>scanner space</b> position \a pos
/*! See file interp/base.h for details. */
template <class VectorType>
FORCE_INLINE bool scanner (const VectorType& pos) {
return voxel (Transform::scanner2voxel * pos.template cast<default_type>());
}
//! Read an interpolated image value from the current position.
/*! See file interp/base.h for details. */
FORCE_INLINE value_type value () const {
if (out_of_bounds)
return out_of_bounds_value;
return ImageType::value();
}
//! Read interpolated values from volumes along axis >= 3
/*! See file interp/base.h for details. */
Eigen::Matrix<value_type, Eigen::Dynamic, 1> row (size_t axis) {
assert (axis > 2);
assert (axis < ImageType::ndim());
if (out_of_bounds) {
Eigen::Matrix<value_type, Eigen::Dynamic, 1> out_of_bounds_row (ImageType::size(axis));
out_of_bounds_row.setOnes();
out_of_bounds_row *= out_of_bounds_value;
return out_of_bounds_row;
}
return ImageType::row(axis);
}
};
template <class ImageType, typename... Args>
inline Nearest<ImageType> make_nearest (const ImageType& parent, Args&&... args) {
return Nearest<ImageType> (parent, std::forward<Args> (args)...);
}
//! @}
}
}
#endif
|
