Compute Library
 21.02
CLChannelCombine Class Reference

Basic function to run CLChannelCombineKernel to perform channel combination. More...

#include <CLChannelCombine.h>

Collaboration diagram for CLChannelCombine:
[legend]

Public Member Functions

void configure (const ICLTensor *plane0, const ICLTensor *plane1, const ICLTensor *plane2, const ICLTensor *plane3, ICLTensor *output)
 Initialize function's inputs and outputs. More...
 
void configure (const CLCompileContext &compile_context, const ICLTensor *plane0, const ICLTensor *plane1, const ICLTensor *plane2, const ICLTensor *plane3, ICLTensor *output)
 Initialize function's inputs and outputs. More...
 
void configure (const ICLImage *plane0, const ICLImage *plane1, const ICLImage *plane2, ICLMultiImage *output)
 Initialize function's inputs and outputs. More...
 
void configure (const CLCompileContext &compile_context, const ICLImage *plane0, const ICLImage *plane1, const ICLImage *plane2, ICLMultiImage *output)
 Initialize function's inputs and outputs. More...
 
- Public Member Functions inherited from ICLSimpleFunction
 ICLSimpleFunction (CLRuntimeContext *ctx=nullptr)
 Constructor. More...
 
 ICLSimpleFunction (const ICLSimpleFunction &)=delete
 Prevent instances of this class from being copied (As this class contains pointers) More...
 
 ICLSimpleFunction (ICLSimpleFunction &&)=default
 Default move constructor. More...
 
ICLSimpleFunctionoperator= (const ICLSimpleFunction &)=delete
 Prevent instances of this class from being copied (As this class contains pointers) More...
 
ICLSimpleFunctionoperator= (ICLSimpleFunction &&)=default
 Default move assignment operator. More...
 
 ~ICLSimpleFunction ()
 Default destructor. More...
 
void run () override final
 Run the kernels contained in the function. More...
 
- Public Member Functions inherited from IFunction
virtual ~IFunction ()=default
 Destructor. More...
 
virtual void prepare ()
 Prepare the function for executing. More...
 

Detailed Description

Basic function to run CLChannelCombineKernel to perform channel combination.

Deprecated:
This function is deprecated and is intended to be removed in 21.05 release

Definition at line 41 of file CLChannelCombine.h.

Member Function Documentation

◆ configure() [1/4]

void configure ( const ICLTensor plane0,
const ICLTensor plane1,
const ICLTensor plane2,
const ICLTensor plane3,
ICLTensor output 
)

Initialize function's inputs and outputs.

Parameters
[in]plane0The 2D plane that forms channel 0. Must be of U8 format.
[in]plane1The 2D plane that forms channel 1. Must be of U8 format.
[in]plane2The 2D plane that forms channel 2. Must be of U8 format.
[in]plane3The 2D plane that forms channel 3. Must be of U8 format.
[out]outputThe single planar output tensor.

Definition at line 32 of file CLChannelCombine.cpp.

References CLKernelLibrary::get().

Referenced by CLChannelCombine::configure().

33 {
34  configure(CLKernelLibrary::get().get_compile_context(), plane0, plane1, plane2, plane3, output);
35 }
void configure(const ICLTensor *plane0, const ICLTensor *plane1, const ICLTensor *plane2, const ICLTensor *plane3, ICLTensor *output)
Initialize function&#39;s inputs and outputs.
static CLKernelLibrary & get()
Access the KernelLibrary singleton.

◆ configure() [2/4]

void configure ( const CLCompileContext compile_context,
const ICLTensor plane0,
const ICLTensor plane1,
const ICLTensor plane2,
const ICLTensor plane3,
ICLTensor output 
)

Initialize function's inputs and outputs.

Parameters
[in]compile_contextThe compile context to be used.
[in]plane0The 2D plane that forms channel 0. Must be of U8 format.
[in]plane1The 2D plane that forms channel 1. Must be of U8 format.
[in]plane2The 2D plane that forms channel 2. Must be of U8 format.
[in]plane3The 2D plane that forms channel 3. Must be of U8 format.
[out]outputThe single planar output tensor.

Definition at line 37 of file CLChannelCombine.cpp.

38 {
39  auto k = std::make_unique<CLChannelCombineKernel>();
40  k->configure(compile_context, plane0, plane1, plane2, plane3, output);
41  _kernel = std::move(k);
42 }

◆ configure() [3/4]

void configure ( const ICLImage plane0,
const ICLImage plane1,
const ICLImage plane2,
ICLMultiImage output 
)

Initialize function's inputs and outputs.

Parameters
[in]plane0The 2D plane that forms channel 0. Must be of U8 format.
[in]plane1The 2D plane that forms channel 1. Must be of U8 format.
[in]plane2The 2D plane that forms channel 2. Must be of U8 format.
[out]outputThe multi planar output image.

Definition at line 44 of file CLChannelCombine.cpp.

References CLChannelCombine::configure(), and CLKernelLibrary::get().

45 {
46  configure(CLKernelLibrary::get().get_compile_context(), plane0, plane1, plane2, output);
47 }
void configure(const ICLTensor *plane0, const ICLTensor *plane1, const ICLTensor *plane2, const ICLTensor *plane3, ICLTensor *output)
Initialize function&#39;s inputs and outputs.
static CLKernelLibrary & get()
Access the KernelLibrary singleton.

◆ configure() [4/4]

void configure ( const CLCompileContext compile_context,
const ICLImage plane0,
const ICLImage plane1,
const ICLImage plane2,
ICLMultiImage output 
)

Initialize function's inputs and outputs.

Parameters
[in]compile_contextThe compile context to be used.
[in]plane0The 2D plane that forms channel 0. Must be of U8 format.
[in]plane1The 2D plane that forms channel 1. Must be of U8 format.
[in]plane2The 2D plane that forms channel 2. Must be of U8 format.
[out]outputThe multi planar output image.

Definition at line 49 of file CLChannelCombine.cpp.

50 {
51  auto k = std::make_unique<CLChannelCombineKernel>();
52  k->configure(compile_context, plane0, plane1, plane2, output);
53  _kernel = std::move(k);
54 }

The documentation for this class was generated from the following files: