Compute Library
 19.08
Helpers.cpp
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2016-2018 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  */
25 
26 using namespace arm_compute;
27 
28 Window arm_compute::calculate_max_window(const ValidRegion &valid_region, const Steps &steps, bool skip_border, BorderSize border_size)
29 {
30  if(!skip_border)
31  {
32  border_size = BorderSize(0);
33  }
34 
35  const Coordinates &anchor = valid_region.anchor;
37 
38  Window window;
39 
40  window.set(0, Window::Dimension(
41  // Skip the border left of the image
42  anchor[0] + border_size.left,
43  // Skip the border right of the image
44  // Make sure the window width is a multiple of the step size
45  anchor[0] + border_size.left + ceil_to_multiple(std::max(0, static_cast<int>(shape[0]) - static_cast<int>(border_size.left) - static_cast<int>(border_size.right)), steps[0]),
46  steps[0]));
47 
48  size_t n = 1;
49 
50  if(anchor.num_dimensions() > 1)
51  {
52  window.set(1, Window::Dimension(
53  // Skip the border above the image
54  anchor[1] + border_size.top,
55  // Skip the border below the image
56  anchor[1] + border_size.top + ceil_to_multiple(std::max(0, static_cast<int>(shape[1]) - static_cast<int>(border_size.top) - static_cast<int>(border_size.bottom)), steps[1]),
57  steps[1]));
58 
59  ++n;
60  }
61 
62  if(anchor.num_dimensions() > 2)
63  {
64  window.set(2, Window::Dimension(anchor[2], std::max<size_t>(1, shape[2]), steps[2]));
65 
66  ++n;
67  }
68 
69  for(; n < anchor.num_dimensions(); ++n)
70  {
71  window.set(n, Window::Dimension(anchor[n], std::max<size_t>(1, shape[n])));
72  }
73 
74  for(; n < Coordinates::num_max_dimensions; ++n)
75  {
76  window.set(n, Window::Dimension(0, 1));
77  }
78 
79  return window;
80 }
81 
83 {
84  const Coordinates &anchor = valid_region.anchor;
86 
87  Window window;
88 
89  window.set(0, Window::Dimension(
90  // move the anchor to the start from the border
91  anchor[0] - border_size.left,
92  // move the anchor to include the right end border
93  // Make sure the window width is a multiple of the step size
94  anchor[0] - border_size.left + ceil_to_multiple(shape[0] + border_size.left + border_size.right, steps[0]),
95  steps[0]));
96 
97  size_t n = 1;
98 
99  if(anchor.num_dimensions() > 1)
100  {
101  window.set(1, Window::Dimension(
102  // Include the border above the image
103  anchor[1] - border_size.top,
104  // Include the border below the image
105  anchor[1] - border_size.top + ceil_to_multiple(shape[1] + border_size.top + border_size.bottom, steps[1]),
106  steps[1]));
107 
108  ++n;
109  }
110 
111  if(anchor.num_dimensions() > 2)
112  {
113  window.set(2, Window::Dimension(0, std::max<size_t>(1, shape[n]), steps[2]));
114 
115  ++n;
116  }
117 
118  for(; n < anchor.num_dimensions(); ++n)
119  {
120  window.set(n, Window::Dimension(anchor[n], std::max<size_t>(1, shape[n])));
121  }
122 
123  for(; n < Coordinates::num_max_dimensions; ++n)
124  {
125  window.set(n, Window::Dimension(0, 1));
126  }
127 
128  return window;
129 }
130 
132 {
133  if(skip_border)
134  {
135  border_size.top = 0;
136  border_size.bottom = 0;
137  }
138  else
139  {
140  border_size.left = 0;
141  border_size.right = 0;
142  }
143 
144  const Coordinates &anchor = valid_region.anchor;
146 
147  Window window;
148 
149  window.set(0, Window::Dimension(
150  // Skip the border left of the image
151  anchor[0] + border_size.left,
152  // Skip the border right of the image
153  // Make sure the window width is a multiple of the step size
154  anchor[0] + border_size.left + ceil_to_multiple(std::max(0, static_cast<int>(shape[0]) - static_cast<int>(border_size.left) - static_cast<int>(border_size.right)), steps[0]),
155  steps[0]));
156 
157  size_t n = 1;
158 
159  if(anchor.num_dimensions() > 1)
160  {
161  window.set(1, Window::Dimension(
162  // Skip the border above the image
163  anchor[1] - border_size.top,
164  // Skip the border below the image
165  anchor[1] + shape[1] + border_size.bottom,
166  1));
167 
168  ++n;
169  }
170 
171  for(; n < anchor.num_dimensions(); ++n)
172  {
173  window.set(n, Window::Dimension(anchor[n], std::max<size_t>(1, shape[n])));
174  }
175 
176  for(; n < Coordinates::num_max_dimensions; ++n)
177  {
178  window.set(n, Window::Dimension(0, 1));
179  }
180 
181  return window;
182 }
183 
185  InterpolationPolicy interpolate_policy, SamplingPolicy sampling_policy, bool border_undefined)
186 {
190 
191  const float scale_x = static_cast<float>(dst_shape[idx_width]) / src_info.tensor_shape()[idx_width];
192  const float scale_y = static_cast<float>(dst_shape[idx_height]) / src_info.tensor_shape()[idx_height];
193  const float sampling_point = (sampling_policy == SamplingPolicy::CENTER) ? 0.5f : 0.0f;
194 
195  // Get input's valid region start and end points
196  const int valid_start_in_x = src_info.valid_region().anchor[idx_width];
197  const int valid_start_in_y = src_info.valid_region().anchor[idx_height];
198  const int valid_end_in_x = src_info.valid_region().anchor[idx_width] + src_info.valid_region().shape[idx_width];
199  const int valid_end_in_y = src_info.valid_region().anchor[idx_height] + src_info.valid_region().shape[idx_height];
200 
201  // Initialize output's valid region start and end points
202  auto valid_start_out_x = static_cast<int>(valid_start_in_x * scale_x);
203  auto valid_start_out_y = static_cast<int>(valid_start_in_y * scale_y);
204  auto valid_end_out_x = std::min<int>(std::ceil(valid_end_in_x * scale_x), dst_shape[idx_width]);
205  auto valid_end_out_y = std::min<int>(std::ceil(valid_end_in_y * scale_y), dst_shape[idx_height]);
206 
207  // Handle valid points in case of the bi-linear interpolation
208  if(border_undefined)
209  {
210  switch(interpolate_policy)
211  {
213  {
214  // (start_out + sampling_point) >= (start_in * scale)
215  // start_out = ceil((start_in * scale) - sampling_point)
216  valid_start_out_x = std::ceil(valid_start_in_x * scale_x - sampling_point);
217  valid_start_out_y = std::ceil(valid_start_in_y * scale_y - sampling_point);
218 
219  // (end_out - 1 + sampling_point) < (end_in * scale)
220  // end_out = ceil((end_in * scale) - sampling_point); // <-- ceil(x - 1) strictly less
221  valid_end_out_x = std::ceil(valid_end_in_x * scale_x - sampling_point);
222  valid_end_out_y = std::ceil(valid_end_in_y * scale_y - sampling_point);
223  break;
224  }
226  {
227  // (start_out + sampling_point) >= ((start_in + sampling_point) * scale)
228  // start_out = ceil(((start_in + sampling_point) * scale) - sampling_point)
229  valid_start_out_x = std::ceil((valid_start_in_x + sampling_point) * scale_x - sampling_point);
230  valid_start_out_y = std::ceil((valid_start_in_y + sampling_point) * scale_y - sampling_point);
231 
232  // (end_out - 1 + sampling_point) <= ((end_in - 1 + sampling_point) * scale)
233  // end_out = floor(((end_in - 1 + sampling_point) * scale) - sampling_point + 1)
234  valid_end_out_x = std::floor((valid_end_in_x - 1.f + sampling_point) * scale_x - sampling_point + 1.f);
235  valid_end_out_y = std::floor((valid_end_in_y - 1.f + sampling_point) * scale_y - sampling_point + 1.f);
236  break;
237  }
239  break;
240  default:
241  {
242  ARM_COMPUTE_ERROR("Invalid InterpolationPolicy");
243  break;
244  }
245  }
246  }
247 
248  // Setup output valid region
250 
251  valid_region.anchor.set(idx_width, std::max(0, valid_start_out_x));
252  valid_region.anchor.set(idx_height, std::max(0, valid_start_out_y));
253 
254  valid_region.shape.set(idx_width, std::min<size_t>(valid_end_out_x - valid_start_out_x, dst_shape[idx_width]));
255  valid_region.shape.set(idx_height, std::min<size_t>(valid_end_out_y - valid_start_out_y, dst_shape[idx_height]));
256 
257  return valid_region;
258 }
#define ARM_COMPUTE_ERROR(...)
Print the given message then throw an std::runtime_error.
Definition: Error.h:261
unsigned int top
top of the border
Definition: Types.h:339
InterpolationPolicy
Interpolation method.
Definition: Types.h:356
Shape of a tensor.
Definition: TensorShape.h:39
const DataLayout data_layout
Definition: Im2Col.cpp:146
TensorShape shape
Shape of the valid region.
Definition: Types.h:247
Container for 2D border size.
Definition: Types.h:259
ValidRegion valid_region() const override
Valid region of the tensor.
Definition: TensorInfo.h:285
DataLayout data_layout() const override
Get the data layout of the tensor.
Definition: TensorInfo.h:297
Output values are defined by bilinear interpolation between the pixels.
Store the tensor's metadata.
Definition: ITensorInfo.h:40
Describe one of the image's dimensions with a start, end and step.
Definition: Window.h:75
unsigned int bottom
bottom of the border
Definition: Types.h:341
Output values are defined to match the source pixel whose center is nearest to the sample position.
void set(size_t dimension, T value)
Accessor to set the value of one of the dimensions.
Definition: Dimensions.h:74
Window calculate_max_window(const ValidRegion &valid_region, const Steps &steps=Steps(), bool skip_border=false, BorderSize border_size=BorderSize())
Calculate the maximum window for a given tensor shape and border setting.
Definition: Helpers.cpp:28
Copyright (c) 2017-2018 ARM Limited.
Samples are taken at pixel center.
Window calculate_max_enlarged_window(const ValidRegion &valid_region, const Steps &steps=Steps(), BorderSize border_size=BorderSize())
Calculate the maximum window for a given tensor shape and border setting.
Definition: Helpers.cpp:82
auto ceil_to_multiple(S value, T divisor) -> decltype(((value+divisor - 1)/divisor) *divisor)
Computes the smallest number larger or equal to value that is a multiple of divisor.
Definition: Utils.h:66
Class to describe a number of elements in each dimension.
Definition: Steps.h:40
Coordinates of an item.
Definition: Coordinates.h:37
void set(size_t dimension, const Dimension &dim)
Set the values of a given dimension.
Definition: Window.inl:48
unsigned int left
left of the border
Definition: Types.h:342
unsigned int right
right of the border
Definition: Types.h:340
Output values are determined by averaging the source pixels whose areas fall under the area of the de...
TensorInfo src_info(src_shape, 1, data_type)
ValidRegion calculate_valid_region_scale(const ITensorInfo &src_info, const TensorShape &dst_shape, InterpolationPolicy interpolate_policy, SamplingPolicy sampling_policy, bool border_undefined)
Helper function to calculate the Valid Region for Scale.
Definition: Helpers.cpp:184
unsigned int num_dimensions() const
Returns the effective dimensionality of the tensor.
Definition: Dimensions.h:122
TensorShape & set(size_t dimension, size_t value, bool apply_dim_correction=true)
Accessor to set the value of one of the dimensions.
Definition: TensorShape.h:78
Container for valid region of a window.
Definition: Types.h:174
size_t get_data_layout_dimension_index(const DataLayout data_layout, const DataLayoutDimension data_layout_dimension)
Get the index of the given dimension.
Definition: Helpers.inl:326
const TensorShape & tensor_shape() const override
Size for each dimension of the tensor.
Definition: TensorInfo.h:252
static constexpr size_t num_max_dimensions
Number of dimensions the tensor has.
Definition: Dimensions.h:45
DataLayout
[DataLayout enum definition]
Definition: Types.h:114
Describe a multidimensional execution window.
Definition: Window.h:39
Window calculate_max_window_horizontal(const ValidRegion &valid_region, const Steps &steps=Steps(), bool skip_border=false, BorderSize border_size=BorderSize())
Calculate the maximum window used by a horizontal kernel for a given tensor shape and border setting.
Definition: Helpers.cpp:131
Coordinates anchor
Anchor for the start of the valid region.
Definition: Types.h:246
SamplingPolicy
Available Sampling Policies.
Definition: Types.h:96