Compute Library
 21.05
ClCrop.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 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_CL_COPY_H
25 #define ARM_COMPUTE_CL_COPY_H
26 
30 
31 namespace arm_compute
32 {
33 namespace opencl
34 {
35 /** Basic function to run @ref kernels::ClCropKernel */
36 class ClCrop : public IClOperator
37 {
38 public:
39  /** Constructor */
40  ClCrop() = default;
41  /** Initialise the function's source and destination.
42  *
43  * @note Supported tensor rank: up to 4
44  *
45  * @param[in] compile_context The compile context to be used.
46  * @param[in] src Source tensor info. Data type supported: All. Data layouts supported: NHWC.
47  * @param[out] dst Destination tensor info. Data type supported: F32
48  * @param[in] start Coordinates of where to start cropping the image.
49  * @param[in] end Coordinates of where to end cropping the image.
50  * @param[in] batch_index Fourth dimension index of the 3D image to crop in @p src.
51  * @param[in] extrapolation_value Value to be used for values outside of the image. Default is 0.
52  * @param[in] dst_window Output window to be used in case cropped image is being copied into a tensor. Default is nullptr.
53  */
54  void configure(const CLCompileContext &compile_context, const ITensorInfo *src, ITensorInfo *dst, Coordinates2D start, Coordinates2D end, uint32_t batch_index, float extrapolation_value = 0,
55  Window *dst_window = nullptr);
56 
57  /** Static function to check if given info will lead to a valid configuration of @ref kernels::ClCropKernel
58  *
59  * @note Supported tensor rank: up to 4
60  *
61  * @param[in] src Source tensor info. Data type supported: All. Data layouts supported: NHWC.
62  * @param[in] 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  static Status validate(const ITensorInfo *src, const ITensorInfo *dst, Coordinates2D start, Coordinates2D end, uint32_t batch_index, float extrapolation_value = 0,
70  Window *dst_window = nullptr);
71 };
72 } // namespace opencl
73 } // namespace arm_compute
74 #endif /* ARM_COMPUTE_CL_COPY_H */
void configure(const CLCompileContext &compile_context, const ITensorInfo *src, ITensorInfo *dst, Coordinates2D start, Coordinates2D end, uint32_t batch_index, float extrapolation_value=0, Window *dst_window=nullptr)
Initialise the function's source and destination.
Definition: ClCrop.cpp:33
Store the tensor's metadata.
Definition: ITensorInfo.h:40
Basic function to run kernels::ClCropKernel.
Definition: ClCrop.h:36
Status class.
Definition: Error.h:52
SimpleTensor< float > src
Definition: DFT.cpp:155
Copyright (c) 2017-2021 Arm Limited.
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 kernels::ClCropKernel.
Definition: ClCrop.cpp:41
void end(TokenStream &in, bool &valid)
Definition: MLGOParser.cpp:290
ClCrop()=default
Constructor.
CLCompileContext class.
Coordinate type.
Definition: Types.h:416
Basic interface for functions which have a single async CL kernel.
Definition: ICLOperator.h:41
Describe a multidimensional execution window.
Definition: Window.h:39