• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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_CLCHANNELCOMBINE_H
25 #define ARM_COMPUTE_CLCHANNELCOMBINE_H
26 
27 #include "arm_compute/runtime/CL/ICLSimpleFunction.h"
28 
29 namespace arm_compute
30 {
31 class CLCompileContext;
32 class ICLMultiImage;
33 class ICLTensor;
34 using ICLImage = ICLTensor;
35 
36 /** Basic function to run @ref CLChannelCombineKernel to perform channel combination.
37  *
38  * @deprecated This function is deprecated and is intended to be removed in 21.05 release
39  *
40 */
41 class CLChannelCombine : public ICLSimpleFunction
42 {
43 public:
44     /** Initialize function's inputs and outputs.
45      *
46      * @param[in]  plane0 The 2D plane that forms channel 0. Must be of U8 format.
47      * @param[in]  plane1 The 2D plane that forms channel 1. Must be of U8 format.
48      * @param[in]  plane2 The 2D plane that forms channel 2. Must be of U8 format.
49      * @param[in]  plane3 The 2D plane that forms channel 3. Must be of U8 format.
50      * @param[out] output The single planar output tensor.
51      */
52     void configure(const ICLTensor *plane0, const ICLTensor *plane1, const ICLTensor *plane2, const ICLTensor *plane3, ICLTensor *output);
53     /** Initialize function's inputs and outputs.
54      *
55      * @param[in]  compile_context The compile context to be used.
56      * @param[in]  plane0          The 2D plane that forms channel 0. Must be of U8 format.
57      * @param[in]  plane1          The 2D plane that forms channel 1. Must be of U8 format.
58      * @param[in]  plane2          The 2D plane that forms channel 2. Must be of U8 format.
59      * @param[in]  plane3          The 2D plane that forms channel 3. Must be of U8 format.
60      * @param[out] output          The single planar output tensor.
61      */
62     void configure(const CLCompileContext &compile_context, const ICLTensor *plane0, const ICLTensor *plane1, const ICLTensor *plane2, const ICLTensor *plane3, ICLTensor *output);
63     /** Initialize function's inputs and outputs.
64      *
65      * @param[in]  plane0 The 2D plane that forms channel 0. Must be of U8 format.
66      * @param[in]  plane1 The 2D plane that forms channel 1. Must be of U8 format.
67      * @param[in]  plane2 The 2D plane that forms channel 2. Must be of U8 format.
68      * @param[out] output The multi planar output image.
69      */
70     void configure(const ICLImage *plane0, const ICLImage *plane1, const ICLImage *plane2, ICLMultiImage *output);
71     /** Initialize function's inputs and outputs.
72      *
73      * @param[in]  compile_context The compile context to be used.
74      * @param[in]  plane0          The 2D plane that forms channel 0. Must be of U8 format.
75      * @param[in]  plane1          The 2D plane that forms channel 1. Must be of U8 format.
76      * @param[in]  plane2          The 2D plane that forms channel 2. Must be of U8 format.
77      * @param[out] output          The multi planar output image.
78      */
79     void configure(const CLCompileContext &compile_context, const ICLImage *plane0, const ICLImage *plane1, const ICLImage *plane2, ICLMultiImage *output);
80 };
81 }
82 #endif /*ARM_COMPUTE_CLCHANNELCOMBINE_H*/
83