Compute Library
 21.02
GCNormalizePlanarYUVLayerKernel Class Reference

Interface for the NormalizePlanarYUV layer kernel. More...

#include <GCNormalizePlanarYUVLayerKernel.h>

Collaboration diagram for GCNormalizePlanarYUVLayerKernel:
[legend]

Public Member Functions

 GCNormalizePlanarYUVLayerKernel ()
 Constructor. More...
 
 GCNormalizePlanarYUVLayerKernel (const GCNormalizePlanarYUVLayerKernel &)=delete
 Prevent instances of this class from being copied (As this class contains pointers) More...
 
GCNormalizePlanarYUVLayerKerneloperator= (const GCNormalizePlanarYUVLayerKernel &)=delete
 Prevent instances of this class from being copied (As this class contains pointers) More...
 
 GCNormalizePlanarYUVLayerKernel (GCNormalizePlanarYUVLayerKernel &&)=default
 Default Move Constructor. More...
 
GCNormalizePlanarYUVLayerKerneloperator= (GCNormalizePlanarYUVLayerKernel &&)=default
 Default move assignment operator. More...
 
 ~GCNormalizePlanarYUVLayerKernel ()=default
 Default destructor. More...
 
void configure (const IGCTensor *input, IGCTensor *output, const IGCTensor *mean, const IGCTensor *std)
 Set the input and output tensors. More...
 
void run (const Window &window) override
 Enqueue the OpenGL ES shader to process the given window. More...
 
- Public Member Functions inherited from IGCKernel
 IGCKernel ()
 Constructor. More...
 
GCKernelkernel ()
 Returns a reference to the GLES kernel of this object. More...
 
void add_1D_tensor_argument (unsigned int &idx, const IGCTensor *tensor, const unsigned int binding_point, const Window &window)
 Add the passed 1D tensor's parameters to the object's kernel's arguments starting from the index idx. More...
 
void add_2D_tensor_argument (unsigned int &idx, const IGCTensor *tensor, const unsigned int binding_point, const Window &window)
 Add the passed 2D tensor's parameters to the object's kernel's arguments starting from the index idx. More...
 
void add_3D_tensor_argument (unsigned int &idx, const IGCTensor *tensor, const unsigned int binding_point, const Window &window)
 Add the passed 3D tensor's parameters to the object's kernel's arguments starting from the index idx. More...
 
unsigned int num_arguments_per_1D_tensor () const
 Returns the number of arguments enqueued per 1D tensor object. More...
 
unsigned int num_arguments_per_2D_tensor () const
 Returns the number of arguments enqueued per 2D tensor object. More...
 
unsigned int num_arguments_per_3D_tensor () const
 Returns the number of arguments enqueued per 3D tensor object. More...
 
void set_lws_hint (gles::NDRange &lws_hint)
 Set the Local-Workgroup-Size hint. More...
 
void set_target (GPUTarget target)
 Set the targeted GPU architecture. More...
 
GPUTarget get_target () const
 Get the targeted GPU architecture. More...
 
- Public Member Functions inherited from IKernel
 IKernel ()
 Constructor. More...
 
virtual ~IKernel ()=default
 Destructor. More...
 
virtual bool is_parallelisable () const
 Indicates whether or not the kernel is parallelisable. More...
 
virtual BorderSize border_size () const
 The size of the border for that kernel. More...
 
const Windowwindow () const
 The maximum window the kernel can be executed on. More...
 

Static Public Member Functions

static Status validate (const ITensorInfo *input, const ITensorInfo *output, const ITensorInfo *mean, const ITensorInfo *std)
 Static function to check if given info will lead to a valid configuration of GCNormalizePlanarYUVLayerKernel. More...
 

Detailed Description

Interface for the NormalizePlanarYUV layer kernel.

Definition at line 35 of file GCNormalizePlanarYUVLayerKernel.h.

Constructor & Destructor Documentation

◆ GCNormalizePlanarYUVLayerKernel() [1/3]

Constructor.

Definition at line 91 of file GCNormalizePlanarYUVLayerKernel.cpp.

92  : _input(nullptr), _output(nullptr), _mean(nullptr), _std(nullptr)
93 {
94 }

◆ GCNormalizePlanarYUVLayerKernel() [2/3]

Prevent instances of this class from being copied (As this class contains pointers)

◆ GCNormalizePlanarYUVLayerKernel() [3/3]

Default Move Constructor.

◆ ~GCNormalizePlanarYUVLayerKernel()

Default destructor.

Member Function Documentation

◆ configure()

void configure ( const IGCTensor input,
IGCTensor output,
const IGCTensor mean,
const IGCTensor std 
)

Set the input and output tensors.

Parameters
[in]inputSource tensor. 3 lower dimensions represent a single input with dimensions [width, height, channels]. Data types supported: F16.
[out]outputDestination tensor. Data type supported: same as input
[in]meanMean values tensor. 1 dimension with size equal to the number of input channels. Data types supported: same as input
[in]stdStandard deviation values tensor. 1 dimension with size equal to the feature maps [FM]. Data types supported: same as input

Definition at line 96 of file GCNormalizePlanarYUVLayerKernel.cpp.

References ARM_COMPUTE_ERROR_ON_NULLPTR, ARM_COMPUTE_ERROR_THROW_ON, arm_compute::auto_init_if_empty(), ICloneable< T >::clone(), GCKernelLibrary::create_kernel(), GCKernelLibrary::get(), ITensor::info(), arm_compute::test::validation::input, arm_compute::support::cpp11::to_string(), and arm_compute::validate_arguments().

Referenced by GCNormalizePlanarYUVLayer::configure().

97 {
98  ARM_COMPUTE_ERROR_ON_NULLPTR(input, output, mean, std);
99 
100  // Output tensor auto initialization if not yet initialized
101  auto_init_if_empty(*output->info(), *input->info()->clone());
102 
103  // Perform validation step
104  ARM_COMPUTE_ERROR_THROW_ON(validate_arguments(input->info(), output->info(), mean->info(), std->info()));
105 
106  _input = input;
107  _output = output;
108  _mean = mean;
109  _std = std;
110 
111  // Set build options
112  std::set<std::string> build_opts;
113  build_opts.emplace(("#define LOCAL_SIZE_X " + support::cpp11::to_string(1)));
114  build_opts.emplace(("#define LOCAL_SIZE_Y " + support::cpp11::to_string(1)));
115  build_opts.emplace(("#define LOCAL_SIZE_Z " + support::cpp11::to_string(1)));
116 
117  // Create kernel
118  _kernel = static_cast<GCKernel>(GCKernelLibrary::get().create_kernel("normalize_planar_yuv_layer", build_opts));
119 
120  // Configure kernel window
121  auto win_config = validate_and_configure_window(input->info(), output->info(), mean->info(), std->info());
122  ARM_COMPUTE_ERROR_THROW_ON(std::get<0>(win_config));
123 
124  IGCKernel::configure(std::get<1>(win_config));
125 }
std::string to_string(T &&value)
Convert integer and float values to string.
#define ARM_COMPUTE_ERROR_THROW_ON(status)
Definition: Error.h:455
GCKernel class.
bool auto_init_if_empty(ITensorInfo &info, const TensorShape &shape, int num_channels, DataType data_type, QuantizationInfo quantization_info=QuantizationInfo())
Auto initialize the tensor info (shape, number of channels and data type) if the current assignment i...
virtual std::unique_ptr< T > clone() const =0
Provide a clone of the current object of class T.
virtual ITensorInfo * info() const =0
Interface to be implemented by the child class to return the tensor&#39;s metadata.
static GCKernelLibrary & get()
Get the static instance of GCKernelLibrary.
Status validate_arguments(const ITensorInfo *input, const ITensorInfo *bias, const ITensorInfo *output, const GEMMLowpOutputStageInfo *output_stage)
GCKernel create_kernel(const std::string &shader_name, const StringSet &build_options_set={}) const
Creates a kernel from the kernel library.
#define ARM_COMPUTE_ERROR_ON_NULLPTR(...)
Definition: Validate.h:161

◆ operator=() [1/2]

Prevent instances of this class from being copied (As this class contains pointers)

◆ operator=() [2/2]

Default move assignment operator.

◆ run()

void run ( const Window window)
overridevirtual

Enqueue the OpenGL ES shader to process the given window.

Parameters
[in]windowRegion on which to execute the kernel. (Must be a valid region of the window returned by window()).

Implements IGCKernel.

Definition at line 134 of file GCNormalizePlanarYUVLayerKernel.cpp.

References IGCKernel::add_1D_tensor_argument(), IGCKernel::add_3D_tensor_argument(), ARM_COMPUTE_ERROR_ON_INVALID_SUBWINDOW, ARM_COMPUTE_ERROR_ON_UNCONFIGURED_KERNEL, Window::DimX, arm_compute::enqueue(), Window::first_slice_window_1D(), Window::first_slice_window_3D(), ITensor::info(), IGCKernel::num_arguments_per_3D_tensor(), ITensorInfo::padding(), Window::set(), IGCTensor::set_needs_shifting(), Window::shift(), arm_compute::test::validation::reference::slice(), Window::slide_window_slice_3D(), and IKernel::window().

135 {
138 
139  _kernel.use();
140 
141  _output->set_needs_shifting(true);
142 
144 
145  Window slice_in;
146  //slice_in.use_tensor_dimensions(_mean->info()->tensor_shape());
147  slice_in = window.first_slice_window_1D();
148  slice_in.set(Window::DimX, Window::Dimension(0, 0, 0));
149 
150  unsigned int idx = 2 * num_arguments_per_3D_tensor();
151  add_1D_tensor_argument(idx, _mean, 3, slice_in);
152  add_1D_tensor_argument(idx, _std, 4, slice_in);
153 
154  slice_in = window.first_slice_window_3D();
155 
156  slice.shift(Window::DimX, -(_output->info()->padding()).left);
157 
158  do
159  {
160  idx = 0;
161  add_3D_tensor_argument(idx, _input, 1, slice_in);
162  add_3D_tensor_argument(idx, _output, 2, slice);
163 
164  _kernel.update_shader_params();
165 
166  enqueue(*this, slice);
167  }
168  while(window.slide_window_slice_3D(slice) && window.slide_window_slice_3D(slice_in));
169 }
const Window & window() const
The maximum window the kernel can be executed on.
Definition: IKernel.cpp:28
void add_3D_tensor_argument(unsigned int &idx, const IGCTensor *tensor, const unsigned int binding_point, const Window &window)
Add the passed 3D tensor&#39;s parameters to the object&#39;s kernel&#39;s arguments starting from the index idx...
Definition: IGCKernel.cpp:132
void enqueue(IGCKernel &kernel, const Window &window, const gles::NDRange &lws=gles::NDRange(1U, 1U, 1U))
Add the kernel to the command queue with the given window.
Definition: IGCKernel.cpp:41
void shift(size_t dimension, int shift_value)
Shift the values of a given dimension by the given shift_value.
Definition: Window.inl:133
Describe one of the image&#39;s dimensions with a start, end and step.
Definition: Window.h:77
unsigned int num_arguments_per_3D_tensor() const
Returns the number of arguments enqueued per 3D tensor object.
Definition: IGCKernel.cpp:147
static constexpr size_t DimX
Alias for dimension 0 also known as X dimension.
Definition: Window.h:43
void set_needs_shifting(bool needs_shifting)
Set the flag indicating whether or not a tensor needs shifting.
Definition: IGCTensor.cpp:61
virtual ITensorInfo * info() const =0
Interface to be implemented by the child class to return the tensor&#39;s metadata.
void set(size_t dimension, const Dimension &dim)
Set the values of a given dimension.
Definition: Window.inl:49
virtual PaddingSize padding() const =0
Padding of tensor.
bool slide_window_slice_3D(Window &slice) const
Slide the passed 3D window slice.
Definition: Window.h:335
#define ARM_COMPUTE_ERROR_ON_UNCONFIGURED_KERNEL(k)
Definition: Validate.h:941
Window first_slice_window_3D() const
First 3D slice of the window.
Definition: Window.h:291
Describe a multidimensional execution window.
Definition: Window.h:39
void add_1D_tensor_argument(unsigned int &idx, const IGCTensor *tensor, const unsigned int binding_point, const Window &window)
Add the passed 1D tensor&#39;s parameters to the object&#39;s kernel&#39;s arguments starting from the index idx...
Definition: IGCKernel.cpp:122
#define ARM_COMPUTE_ERROR_ON_INVALID_SUBWINDOW(f, s)
Definition: Validate.h:205
Window first_slice_window_1D() const
First 1D slice of the window.
Definition: Window.h:275
SimpleTensor< T > slice(const SimpleTensor< T > &src, Coordinates starts, Coordinates ends)

◆ validate()

Status validate ( const ITensorInfo input,
const ITensorInfo output,
const ITensorInfo mean,
const ITensorInfo std 
)
static

Static function to check if given info will lead to a valid configuration of GCNormalizePlanarYUVLayerKernel.

Parameters
[in]inputSource tensor info. 3 lower dimensions represent a single input with dimensions [width, height, channels]. Data types supported: F16.
[out]outputDestination tensor info. Data type supported: same as input
[in]meanMean values tensor info. 1 dimension with size equal to the number of input channels. Data types supported: same as input
[in]stdStandard deviation values tensor info. 1 dimension with size equal to the number of input channels. Data types supported: same as input
Returns
a status

Definition at line 127 of file GCNormalizePlanarYUVLayerKernel.cpp.

References ARM_COMPUTE_RETURN_ON_ERROR, ICloneable< T >::clone(), and arm_compute::validate_arguments().

Referenced by GCNormalizePlanarYUVLayer::validate().

128 {
129  ARM_COMPUTE_RETURN_ON_ERROR(validate_arguments(input, output, mean, std));
130  ARM_COMPUTE_RETURN_ON_ERROR(std::get<0>(validate_and_configure_window(input->clone().get(), output->clone().get(), mean->clone().get(), std->clone().get())));
131  return Status{};
132 }
#define ARM_COMPUTE_RETURN_ON_ERROR(status)
Checks if a status contains an error and returns it.
Definition: Error.h:204
Status class.
Definition: Error.h:52
virtual std::unique_ptr< T > clone() const =0
Provide a clone of the current object of class T.
Status validate_arguments(const ITensorInfo *input, const ITensorInfo *bias, const ITensorInfo *output, const GEMMLowpOutputStageInfo *output_stage)

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