Compute Library
 20.02.1
CLScale.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2016-2020 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_CLSCALE_H
25 #define ARM_COMPUTE_CLSCALE_H
26 
27 #include "arm_compute/core/Types.h"
29 
30 #include <cstdint>
31 
32 namespace arm_compute
33 {
34 class ICLTensor;
35 
36 /** Basic function to run @ref CLScaleKernel */
37 class CLScale : public ICLSimpleFunction
38 {
39 public:
40  /** Initialize the function's source, destination, interpolation type and border_mode.
41  *
42  * @param[in,out] input Source tensor. Data types supported: U8/QASYMM8/QASYMM8_SIGNED/S16/F16/F32. (Written to only for @p border_mode != UNDEFINED)
43  * @param[out] output Destination tensor. Data types supported: Same as @p input
44  * All but the lowest two dimensions must be the same size as in the input tensor, i.e. scaling is only performed within the XY-plane.
45  * @param[in] policy The interpolation type.
46  * @param[in] border_mode Strategy to use for borders.
47  * @param[in] constant_border_value (Optional) Constant value to use for borders if border_mode is set to CONSTANT.
48  * @param[in] sampling_policy (Optional) Sampling policy used by the interpolation. Defaults to @ref SamplingPolicy::CENTER
49  * @param[in] use_padding (Optional) Is padding in use or not. Defaults to true.
50  * @param[in] align_corners (Optional) Align corners of input and output, only affecting bilinear policy with TOP_LEFT sampling policy. Defaults to false.
51  */
53  SamplingPolicy sampling_policy = SamplingPolicy::CENTER, bool use_padding = true, bool align_corners = false);
54 
55  /** Static function to check if given info will lead to a valid configuration of @ref CLScale
56  *
57  * @param[in] input Source tensor info. Data types supported: U8/QASYMM8/QASYMM8_SIGNED/S16/F16/F32.
58  * @param[in] output Output tensor info. Data type supported: Same as @p input
59  * All but the lowest two dimensions must be the same size as in the input tensor, i.e. scaling is only performed within the XY-plane.
60  * @param[in] policy The interpolation type.
61  * @param[in] border_mode Strategy to use for borders.
62  * @param[in] constant_border_value (Optional) Constant value to use for borders if border_mode is set to CONSTANT.
63  * @param[in] sampling_policy (Optional) Sampling policy used by the interpolation. Defaults to @ref SamplingPolicy::CENTER
64  * @param[in] use_padding (Optional) Is padding in use or not. Defaults to true.
65  * @param[in] align_corners (Optional) Align corners of input and output, only affecting bilinear policy with TOP_LEFT sampling policy. Defaults to false.
66  *
67  * @return a status
68  */
69  static Status validate(const ITensorInfo *input, const ITensorInfo *output, InterpolationPolicy policy, BorderMode border_mode, PixelValue constant_border_value = PixelValue(),
70  SamplingPolicy sampling_policy = SamplingPolicy::CENTER, bool use_padding = true, bool align_corners = false);
71 };
72 }
73 #endif /*ARM_COMPUTE_CLSCALE_H */
BorderMode
Methods available to handle borders.
Definition: Types.h:261
Class describing the value of a pixel for any image format.
Definition: PixelValue.h:34
InterpolationPolicy
Interpolation method.
Definition: Types.h:366
void configure(ICLTensor *input, ICLTensor *output, InterpolationPolicy policy, BorderMode border_mode, PixelValue constant_border_value=PixelValue(), SamplingPolicy sampling_policy=SamplingPolicy::CENTER, bool use_padding=true, bool align_corners=false)
Initialize the function's source, destination, interpolation type and border_mode.
Definition: CLScale.cpp:35
static Status validate(const ITensorInfo *input, const ITensorInfo *output, InterpolationPolicy policy, BorderMode border_mode, PixelValue constant_border_value=PixelValue(), SamplingPolicy sampling_policy=SamplingPolicy::CENTER, bool use_padding=true, bool align_corners=false)
Static function to check if given info will lead to a valid configuration of CLScale.
Definition: CLScale.cpp:56
Store the tensor's metadata.
Definition: ITensorInfo.h:40
Status class.
Definition: Error.h:52
Basic function to run CLScaleKernel.
Definition: CLScale.h:37
Copyright (c) 2017-2020 ARM Limited.
Samples are taken at pixel center.
Basic interface for functions which have a single OpenCL kernel.
Interface for OpenCL tensor.
Definition: ICLTensor.h:42
SamplingPolicy
Available Sampling Policies.
Definition: Types.h:99