Compute Library
 21.05
ClCropKernel.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2019-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_CLCROPKERNEL_H
25 #define ARM_COMPUTE_CLCROPKERNEL_H
26 
27 #include "src/core/common/Macros.h"
30 
31 namespace arm_compute
32 {
33 namespace opencl
34 {
35 namespace kernels
36 {
37 /** OpenCL kernel to perform a copy between two tensors */
38 class ClCropKernel : public IClKernel
39 {
40 public:
41  ClCropKernel() = default;
43  /** Configure kernel
44  *
45  * @note Supported tensor rank: up to 4
46  *
47  * @param[in] src Source tensor info. Data type supported: All. Data layouts supported: NHWC.
48  * @param[out] dst Destination tensor info. Data type supported: F32
49  * @param[in] start Coordinates of where to start cropping the image.
50  * @param[in] end Coordinates of where to end cropping the image.
51  * @param[in] batch_index Fourth dimension index of the 3D image to crop in @p src.
52  * @param[in] extrapolation_value Value to be used for values outside of the image. Default is 0.
53  * @param[in] dst_window Output window to be used in case cropped image is being copied into a tensor. Default is nullptr.
54  */
55  void configure(const ITensorInfo *src, ITensorInfo *dst, Coordinates2D start, Coordinates2D end, uint32_t batch_index, float extrapolation_value = 0, Window *dst_window = nullptr);
56  /** Configure kernel
57  *
58  * @note Supported tensor rank: up to 4
59  *
60  * @param[in] compile_context The compile context to be used.
61  * @param[in] src Source tensor info. Data type supported: All. Data layouts supported: NHWC.
62  * @param[out] dst Destination tensor info. Data type supported: F32
63  * @param[in] start Coordinates of where to start cropping the image.
64  * @param[in] end Coordinates of where to end cropping the image.
65  * @param[in] batch_index Fourth dimension index of the 3D image to crop in @p src.
66  * @param[in] extrapolation_value Value to be used for values outside of the image. Default is 0.
67  * @param[in] dst_window Output window to be used in case cropped image is being copied into a tensor. Default is nullptr.
68  */
69  void configure(const CLCompileContext &compile_context, const ITensorInfo *src, ITensorInfo *dst, Coordinates2D start, Coordinates2D end, uint32_t batch_index, float extrapolation_value = 0,
70  Window *dst_window = nullptr);
71 
72  /** Static function to check if given info will lead to a valid configuration of @ref CLStridedSliceKernel
73  *
74  * @note Supported tensor rank: up to 4
75  *
76  * @param[in] src Source tensor info. Data type supported: All. Data layouts supported: NHWC.
77  * @param[in] dst Destination tensor info. Data type supported: F32
78  * @param[in] start Coordinates of where to start cropping the image.
79  * @param[in] end Coordinates of where to end cropping the image.
80  * @param[in] batch_index Fourth dimension index of the 3D image to crop in @p src.
81  * @param[in] extrapolation_value Value to be used for values outside of the image. Default is 0.
82  * @param[in] dst_window Output window to be used in case cropped image is being copied into a tensor. Default is nullptr.
83  */
84  static Status validate(const ITensorInfo *src, const ITensorInfo *dst, Coordinates2D start, Coordinates2D end, uint32_t batch_index, float extrapolation_value = 0,
85  Window *dst_window = nullptr);
86 
87  // Inherited methods overridden:
88  void run_op(ITensorPack &tensors, const Window &window, cl::CommandQueue &queue) override;
89 
90 private:
91  Coordinates2D _start{};
92  uint32_t _batch_index{};
93  float _extrapolation_value{};
94 };
95 } // namespace kernels
96 } // namespace opencl
97 } // namespace arm_compute
98 #endif /*ARM_COMPUTE_CLCROPKERNEL_H */
const Window & window() const
The maximum window the kernel can be executed on.
Definition: IKernel.cpp:28
void configure(const ITensorInfo *src, ITensorInfo *dst, Coordinates2D start, Coordinates2D end, uint32_t batch_index, float extrapolation_value=0, Window *dst_window=nullptr)
Configure kernel.
OpenCL kernel to perform a copy between two tensors.
Definition: ClCropKernel.h:38
Store the tensor's metadata.
Definition: ITensorInfo.h:40
Status class.
Definition: Error.h:52
Common interface for all the OpenCL kernels.
Definition: ICLKernel.h:46
SimpleTensor< float > src
Definition: DFT.cpp:155
Copyright (c) 2017-2021 Arm Limited.
void end(TokenStream &in, bool &valid)
Definition: MLGOParser.cpp:290
CLCompileContext class.
Coordinate type.
Definition: Types.h:416
Tensor packing service.
Definition: ITensorPack.h:37
static Status validate(const ITensorInfo *src, const ITensorInfo *dst, Coordinates2D start, Coordinates2D end, uint32_t batch_index, float extrapolation_value=0, Window *dst_window=nullptr)
Static function to check if given info will lead to a valid configuration of CLStridedSliceKernel.
void run_op(ITensorPack &tensors, const Window &window, cl::CommandQueue &queue) override
Enqueue the OpenCL kernel to process the given window on the passed OpenCL command queue.
Describe a multidimensional execution window.
Definition: Window.h:39