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_CROP_H 25 #define ARM_COMPUTE_CL_CROP_H 26 27 #include "arm_compute/core/Window.h" 28 #include "src/gpu/cl/ClCompileContext.h" 29 #include "src/gpu/cl/IClOperator.h" 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 /** Initialise the function's source and destination. 40 * 41 * @note Supported tensor rank: up to 4 42 * 43 * @param[in] compile_context The compile context to be used. 44 * @param[in] src Source tensor info. Data type supported: All. Data layouts supported: NHWC. 45 * @param[out] dst Destination tensor info. Data type supported: F32 46 * @param[in] start Coordinates of where to start cropping the image. 47 * @param[in] end Coordinates of where to end cropping the image. 48 * @param[in] batch_index Fourth dimension index of the 3D image to crop in @p src. 49 * @param[in] extrapolation_value Value to be used for values outside of the image. Default is 0. 50 * @param[in] dst_window Output window to be used in case cropped image is being copied into a tensor. Default is nullptr. 51 */ 52 void configure(const CLCompileContext &compile_context, const ITensorInfo *src, ITensorInfo *dst, Coordinates2D start, Coordinates2D end, uint32_t batch_index, float extrapolation_value = 0, 53 Window *dst_window = nullptr); 54 /** Static function to check if given info will lead to a valid configuration 55 * 56 * Similar to @ref ClCrop::configure() 57 * 58 * @return a status 59 */ 60 static Status validate(const ITensorInfo *src, const ITensorInfo *dst, Coordinates2D start, Coordinates2D end, uint32_t batch_index, float extrapolation_value = 0, 61 Window *dst_window = nullptr); 62 }; 63 } // namespace opencl 64 } // namespace arm_compute 65 #endif /* ARM_COMPUTE_CL_CROP_H */ 66