Compute Library
 21.05
Utils.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2017-2021 Arm Limited.
3  *
4  * SPDX-License-Identifier: MIT
5  *
6  * Permission is hereby granted, free of charge, to any person obtaining a copy
7  * of this software and associated documentation files (the "Software"), to
8  * deal in the Software without restriction, including without limitation the
9  * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
10  * sell copies of the Software, and to permit persons to whom the Software is
11  * furnished to do so, subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be included in all
14  * copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22  * SOFTWARE.
23  */
24 #ifndef ARM_COMPUTE_TEST_VALIDATION_UTILS_H
25 #define ARM_COMPUTE_TEST_VALIDATION_UTILS_H
26 
27 #include "arm_compute/core/Types.h"
28 #include "tests/Globals.h"
29 #include "tests/Types.h"
30 
31 #include <array>
32 #include <random>
33 #include <type_traits>
34 #include <utility>
35 #include <vector>
36 
37 namespace arm_compute
38 {
39 namespace test
40 {
41 namespace validation
42 {
43 /** Checks if a pixel has valid coordinates
44  *
45  * @param x X coordinate
46  * @param y Y coordinate
47  * @param width Width of the image
48  * @param height Height of the image
49  * @param border_size Border size
50  *
51  * @return True if pixel is valid else false
52  */
53 inline bool is_valid_pixel_index(int x, int y, int width, int height, int border_size)
54 {
55  return ((x >= -border_size) && (y >= -border_size) && (x < (width + border_size)) && (y < height + border_size));
56 }
57 
58 #pragma GCC diagnostic push
59 #pragma GCC diagnostic ignored "-Wstrict-overflow"
60 
61 // Return a tensor element at a specified coordinate with different border modes
62 template <typename T>
63 T tensor_elem_at(const SimpleTensor<T> &src, Coordinates coord, BorderMode border_mode, T constant_border_value)
64 {
65  const int x = coord.x();
66  const int y = coord.y();
67  const int z = coord.z();
68  const int width = src.shape().x();
69  const int height = src.shape().y();
70  const int depth = src.shape().z();
71 
72  // If coordinates beyond range of tensor's width or height
73  if(x < 0 || y < 0 || z < 0 || x >= width || y >= height || z >= depth)
74  {
75  if(border_mode == BorderMode::REPLICATE)
76  {
77  coord.set(0, std::max(0, std::min(x, width - 1)));
78  coord.set(1, std::max(0, std::min(y, height - 1)));
79  }
80  else
81  {
82  return constant_border_value;
83  }
84  }
85 
86  return src[coord2index(src.shape(), coord)];
87 }
88 
89 #pragma GCC diagnostic pop
90 
91 template <typename T>
92 T bilinear_policy(const SimpleTensor<T> &in, Coordinates id, float xn, float yn, BorderMode border_mode, T constant_border_value);
93 
94 /* Apply 2D spatial filter on a single element of @p in at coordinates @p coord
95  *
96  * - filter sizes have to be odd number
97  * - Row major order of filter assumed
98  * - TO_ZERO rounding policy assumed
99  * - SATURATE convert policy assumed
100  */
101 template <typename T, typename U, typename V>
102 void apply_2d_spatial_filter(Coordinates coord, const SimpleTensor<T> &src, SimpleTensor<U> &dst, const TensorShape &filter_shape, const V *filter_itr, double scale, BorderMode border_mode,
103  T constant_border_value = T(0))
104 {
105  double val = 0.;
106  const int x = coord.x();
107  const int y = coord.y();
108  for(int j = y - static_cast<int>(filter_shape[1] / 2); j <= y + static_cast<int>(filter_shape[1] / 2); ++j)
109  {
110  for(int i = x - static_cast<int>(filter_shape[0] / 2); i <= x + static_cast<int>(filter_shape[0] / 2); ++i)
111  {
112  coord.set(0, i);
113  coord.set(1, j);
114  val += static_cast<double>(*filter_itr) * tensor_elem_at(src, coord, border_mode, constant_border_value);
115  ++filter_itr;
116  }
117  }
118  coord.set(0, x);
119  coord.set(1, y);
120  dst[coord2index(src.shape(), coord)] = saturate_cast<U>(support::cpp11::trunc(val * scale));
121 }
122 
123 RawTensor transpose(const RawTensor &src, int chunk_width = 1);
124 
125 bool valid_bilinear_policy(float xn, float yn, int width, int height, BorderMode border_mode);
126 } // namespace validation
127 } // namespace test
128 } // namespace arm_compute
129 #endif /* ARM_COMPUTE_TEST_VALIDATION_UTILS_H */
BorderMode
Methods available to handle borders.
Definition: Types.h:259
void set(size_t dimension, T value, bool increase_dim_unit=true)
Accessor to set the value of one of the dimensions.
Definition: Dimensions.h:76
T tensor_elem_at(const SimpleTensor< T > &src, Coordinates coord, BorderMode border_mode, T constant_border_value)
Definition: Utils.h:63
T trunc(T value)
Truncate floating-point value.
Subclass of SimpleTensor using uint8_t as value type.
Definition: RawTensor.h:38
Shape of a tensor.
Definition: TensorShape.h:39
void apply_2d_spatial_filter(Coordinates coord, const SimpleTensor< T > &src, SimpleTensor< U > &dst, const TensorShape &filter_shape, const V *filter_itr, double scale, BorderMode border_mode, T constant_border_value=T(0))
Definition: Utils.h:102
bool is_valid_pixel_index(int x, int y, int width, int height, int border_size)
Checks if a pixel has valid coordinates.
Definition: Utils.h:53
SimpleTensor< float > src
Definition: DFT.cpp:155
Copyright (c) 2017-2021 Arm Limited.
int coord2index(const TensorShape &shape, const Coordinates &coord)
Linearise the given coordinate.
Definition: Utils.h:387
RawTensor transpose(const RawTensor &src, int chunk_width)
Definition: Utils.cpp:70
T x() const
Alias to access the size of the first dimension.
Definition: Dimensions.h:87
T z() const
Alias to access the size of the third dimension.
Definition: Dimensions.h:97
Coordinates of an item.
Definition: Coordinates.h:37
T bilinear_policy(const SimpleTensor< T > &in, Coordinates id, float xn, float yn, BorderMode border_mode, T constant_border_value)
Definition: Utils.cpp:36
Simple tensor object that stores elements in a consecutive chunk of memory.
Definition: SimpleTensor.h:58
Pixels outside the image are assumed to have the same value as the closest image pixel.
bool valid_bilinear_policy(float xn, float yn, int width, int height, BorderMode border_mode)
Definition: Utils.cpp:99
T y() const
Alias to access the size of the second dimension.
Definition: Dimensions.h:92