Compute Library
 21.02
CLDerivative Class Reference

Basic function to execute first order derivative operator. More...

#include <CLDerivative.h>

Collaboration diagram for CLDerivative:
[legend]

Public Member Functions

void configure (ICLTensor *input, ICLTensor *output_x, ICLTensor *output_y, BorderMode border_mode, uint8_t constant_border_value=0)
 Initialise the function's source, destinations and border mode. More...
 
void configure (const CLCompileContext &compile_context, ICLTensor *input, ICLTensor *output_x, ICLTensor *output_y, BorderMode border_mode, uint8_t constant_border_value=0)
 Initialise the function's source, destinations and border mode. 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 execute first order derivative operator.

This function calls the following CL kernels:

  1. CLFillBorderKernel (executed if border_mode == CONSTANT or border_mode == REPLICATE)
  2. CLDerivativeKernel
Deprecated:
This function is deprecated and is intended to be removed in 21.05 release

Definition at line 45 of file CLDerivative.h.

Member Function Documentation

◆ configure() [1/2]

void configure ( ICLTensor input,
ICLTensor output_x,
ICLTensor output_y,
BorderMode  border_mode,
uint8_t  constant_border_value = 0 
)

Initialise the function's source, destinations and border mode.

Note
At least one of output_x or output_y must be not NULL.
Parameters
[in,out]inputSource tensor. Data types supported: U8. (Written to only for border_mode != UNDEFINED)
[out]output_x(optional) Destination tensor. Derivative along the X direction. Data types supported: S16.
[out]output_y(optional) Destination tensor. Derivative along the Y direction. Data types supported: S16.
[in]border_modeBorder mode to use
[in]constant_border_value(Optional) Constant value to use for borders if border_mode is set to CONSTANT.

Definition at line 34 of file CLDerivative.cpp.

References CLKernelLibrary::get().

Referenced by CLHOGGradient::configure().

35 {
36  configure(CLKernelLibrary::get().get_compile_context(), input, output_x, output_y, border_mode, constant_border_value);
37 }
static CLKernelLibrary & get()
Access the KernelLibrary singleton.
void configure(ICLTensor *input, ICLTensor *output_x, ICLTensor *output_y, BorderMode border_mode, uint8_t constant_border_value=0)
Initialise the function&#39;s source, destinations and border mode.

◆ configure() [2/2]

void configure ( const CLCompileContext compile_context,
ICLTensor input,
ICLTensor output_x,
ICLTensor output_y,
BorderMode  border_mode,
uint8_t  constant_border_value = 0 
)

Initialise the function's source, destinations and border mode.

Note
At least one of output_x or output_y must be not NULL.
Parameters
[in]compile_contextThe compile context to be used.
[in,out]inputSource tensor. Data types supported: U8. (Written to only for border_mode != UNDEFINED)
[out]output_x(optional) Destination tensor. Derivative along the X direction. Data types supported: S16.
[out]output_y(optional) Destination tensor. Derivative along the Y direction. Data types supported: S16.
[in]border_modeBorder mode to use
[in]constant_border_value(Optional) Constant value to use for borders if border_mode is set to CONSTANT.

Definition at line 39 of file CLDerivative.cpp.

References arm_compute::UNDEFINED.

40 {
41  auto k = std::make_unique<CLDerivativeKernel>();
42  k->configure(compile_context, input, output_x, output_y, border_mode == BorderMode::UNDEFINED);
43  _kernel = std::move(k);
44  _border_handler->configure(compile_context, input, BorderSize(1), border_mode, PixelValue(constant_border_value));
45 }
Class describing the value of a pixel for any image format.
Definition: PixelValue.h:34
Container for 2D border size.
Definition: Types.h:273
Borders are left undefined.

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