xref: /aosp_15_r20/external/ComputeLibrary/arm_compute/runtime/NEON/functions/NECropResize.h (revision c217d954acce2dbc11938adb493fc0abd69584f3)
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_NEON_CROP_RESIZE_H
25 #define ARM_COMPUTE_NEON_CROP_RESIZE_H
26 
27 #include "arm_compute/runtime/NEON/functions/NEScale.h"
28 
29 #include <memory>
30 
31 namespace arm_compute
32 {
33 // Forward Declarations
34 class Tensor;
35 class ITensor;
36 class NECropKernel;
37 
38 /** Function to perform cropping and resizing */
39 class NECropResize : public IFunction
40 {
41 public:
42     /** Default constructor */
43     NECropResize();
44     /** Prevent instances of this class from being copied (As this class contains pointers) */
45     NECropResize(const NECropResize &) = delete;
46     /** Prevent instances of this class from being copied (As this class contains pointers) */
47     NECropResize &operator=(const NECropResize &) = delete;
48     /** Allow instances of this class to be moved */
49     NECropResize(NECropResize &&) = default;
50     /** Allow instances of this class to be moved */
51     NECropResize &operator=(NECropResize &&) = default;
52     /** Default destructor */
53     ~NECropResize();
54 
55     /** Configure kernel
56      *
57      * Valid data layouts:
58      * - NHWC
59      *
60      * Valid data type configurations:
61      * |src0     |src1     |src2   |dst      |
62      * |:--------|:--------|:------|:--------|
63      * |All      |F32      |F32    |F32      |
64      *
65      * @note Supported tensor rank: up to 4
66      * @note Box indices may be outside of the bounds, in which case @p extrapolation_value is used.
67      * @note Start and end indices of boxes are inclusive.
68      *
69      * @param[in]  input               Source tensor containing N batches of 3D images to be cropped. Data type supported: U8/U16/S16/U32/S32/F16/F32
70      * @param[in]  boxes               Tensor containing the boxes used to crop the images. Data type supported: F32
71      * @param[in]  box_ind             One dimensional tensor containing the batch index of the 3D image in @p input that the corresponding
72      *                                 box in @p boxes will be applied to. Data type supported: F32
73      * @param[out] output              Destination tensor containing a cropped and resized image for each box in @p boxes. Data type supported: F32
74      * @param[in]  crop_size           The dimensions that each cropped image will be resized to.
75      * @param[in]  method              The policy to be used when resizing image. Default is bilinear.
76      * @param[in]  extrapolation_value Value to be used for values outside of the image for cropping and resizing. Default is 0.
77      */
78     void configure(const ITensor *input, const ITensor *boxes, const ITensor *box_ind, ITensor *output, Coordinates2D crop_size,
79                    InterpolationPolicy method = InterpolationPolicy::BILINEAR, float extrapolation_value = 0);
80 
81     /** Static function to check if given info will lead to a valid configuration of @ref NESlice
82      *
83      * @note Supported tensor rank: up to 4
84      * @note Box indices may be outside of the bounds, in which case @p extrapolation_value is used.
85      * @note Start and end indices of boxes are inclusive.
86      *
87      * @param[in] input               Source tensor containing N batches of 3D images to be cropped. Data type supported: U8/U16/S16/U32/S32/F16/F32
88      * @param[in] boxes               Tensor info for the tensor containing the boxes used to crop the images. Data type supported: F32
89      * @param[in] box_ind             Tensor info for the one dimensional tensor containing the batch index of the 3D image in @p input
90      *                                that the corresponding box in @p boxes will be applied to. Data type supported: F32
91      * @param[in] output              Tensor info for the destination tensor containing a cropped and resized image for each box in @p boxes.
92      *                                Data type supported: F32
93      * @param[in] crop_size           The dimensions that each cropped image will be resized to.
94      * @param[in] method              The policy to be used when resizing image. Default is bilinear.
95      * @param[in] extrapolation_value Value to be used for values outside of the image for cropping and resizing. Default is 0.
96      *
97      * @return A status
98      */
99     static Status validate(const ITensorInfo *input, const ITensorInfo *boxes, const ITensorInfo *box_ind, const ITensorInfo *output,
100                            Coordinates2D crop_size, InterpolationPolicy method, float extrapolation_value);
101 
102     void run() override;
103 
104     ITensor            *_output;
105     size_t              _num_boxes;
106     InterpolationPolicy _method;
107     float               _extrapolation_value;
108 
109     std::vector<std::unique_ptr<NECropKernel>> _crop;
110     std::vector<std::unique_ptr<NEScale>>      _scale;
111     std::vector<std::unique_ptr<Tensor>>       _crop_results;
112     std::vector<std::unique_ptr<Tensor>>       _scaled_results;
113 };
114 } // namespace arm_compute
115 #endif /* ARM_COMPUTE_NEON_CROP_RESIZE_H */
116