Compute Library
 21.02
NEMedian3x3Kernel Class Reference

Kernel to perform a median filter on a tensor. More...

#include <NEMedian3x3Kernel.h>

Collaboration diagram for NEMedian3x3Kernel:
[legend]

Public Member Functions

const char * name () const override
 Name of the kernel. More...
 
 NEMedian3x3Kernel ()=default
 Default constructor. More...
 
 NEMedian3x3Kernel (const NEMedian3x3Kernel &)=delete
 Prevent instances of this class from being copied (As this class contains pointers) More...
 
NEMedian3x3Kerneloperator= (const NEMedian3x3Kernel &)=delete
 Prevent instances of this class from being copied (As this class contains pointers) More...
 
 NEMedian3x3Kernel (NEMedian3x3Kernel &&)=default
 Allow instances of this class to be moved. More...
 
NEMedian3x3Kerneloperator= (NEMedian3x3Kernel &&)=default
 Allow instances of this class to be moved. More...
 
 ~NEMedian3x3Kernel ()=default
 Default destructor. More...
 
void configure (const ITensor *input, ITensor *output, bool border_undefined)
 Set the source, destination and border mode of the kernel. More...
 
void run (const Window &window, const ThreadInfo &info) override
 Execute the kernel on the passed window. More...
 
BorderSize border_size () const override
 The size of the border for that kernel. More...
 
- Public Member Functions inherited from ICPPSimpleKernel
 ICPPSimpleKernel ()
 Constructor. More...
 
 ICPPSimpleKernel (const ICPPSimpleKernel &)=delete
 Prevent instances of this class from being copied (As this class contains pointers) More...
 
ICPPSimpleKerneloperator= (const ICPPSimpleKernel &)=delete
 Prevent instances of this class from being copied (As this class contains pointers) More...
 
 ICPPSimpleKernel (ICPPSimpleKernel &&)=default
 Allow instances of this class to be moved. More...
 
ICPPSimpleKerneloperator= (ICPPSimpleKernel &&)=default
 Allow instances of this class to be moved. More...
 
 ~ICPPSimpleKernel ()=default
 Default destructor. More...
 
- Public Member Functions inherited from ICPPKernel
virtual ~ICPPKernel ()=default
 Default destructor. More...
 
virtual void run_nd (const Window &window, const ThreadInfo &info, const Window &thread_locator)
 legacy compatibility layer for implemantions which do not support thread_locator In these cases we simply narrow the interface down the legacy version More...
 
virtual void run_op (ITensorPack &tensors, const Window &window, const ThreadInfo &info)
 Execute the kernel on the passed window. 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...
 
const Windowwindow () const
 The maximum window the kernel can be executed on. More...
 

Detailed Description

Kernel to perform a median filter on a tensor.

Definition at line 34 of file NEMedian3x3Kernel.h.

Constructor & Destructor Documentation

◆ NEMedian3x3Kernel() [1/3]

NEMedian3x3Kernel ( )
default

Default constructor.

Referenced by NEMedian3x3Kernel::name().

◆ NEMedian3x3Kernel() [2/3]

NEMedian3x3Kernel ( const NEMedian3x3Kernel )
delete

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

◆ NEMedian3x3Kernel() [3/3]

Allow instances of this class to be moved.

◆ ~NEMedian3x3Kernel()

~NEMedian3x3Kernel ( )
default

Default destructor.

Referenced by NEMedian3x3Kernel::name().

Member Function Documentation

◆ border_size()

BorderSize border_size ( ) const
overridevirtual

The size of the border for that kernel.

Returns
The width in number of elements of the border.

Reimplemented from IKernel.

Definition at line 51 of file NEMedian3x3Kernel.cpp.

Referenced by NEMedian3x3Kernel::configure(), and NEMedian3x3Kernel::name().

52 {
53  return BorderSize(1);
54 }
Container for 2D border size.
Definition: Types.h:273

◆ configure()

void configure ( const ITensor input,
ITensor output,
bool  border_undefined 
)

Set the source, destination and border mode of the kernel.

Parameters
[in]inputSource tensor. Data type supported: U8
[out]outputDestination tensor. Data type supported: U8
[in]border_undefinedTrue if the border mode is undefined. False if it's replicate or constant.

Definition at line 56 of file NEMedian3x3Kernel.cpp.

References NEMedian3x3Kernel::border_size(), arm_compute::calculate_max_window(), ITensor::info(), arm_compute::test::validation::input, BorderSize::left, num_elems_processed_per_iteration, BorderSize::top, arm_compute::update_window_and_padding(), and ITensorInfo::valid_region().

Referenced by NEMedian3x3Kernel::name().

57 {
58  _input = input;
59  _output = output;
60 
61  // Configure kernel window
62  constexpr unsigned int num_elems_processed_per_iteration = 8;
63  constexpr unsigned int num_elems_read_per_iteration = 16;
64  constexpr unsigned int num_elems_written_per_iteration = 8;
65  constexpr unsigned int num_rows_read_per_iteration = 3;
66 
67  Window win = calculate_max_window(*input->info(), Steps(num_elems_processed_per_iteration), border_undefined, border_size());
68  AccessWindowHorizontal output_access(output->info(), 0, num_elems_written_per_iteration);
69 
71  AccessWindowRectangle(input->info(), -border_size().left, -border_size().top, num_elems_read_per_iteration, num_rows_read_per_iteration),
72  output_access);
73 
74  output_access.set_valid_region(win, input->info()->valid_region(), border_undefined, border_size());
75 
76  INEKernel::configure(win);
77 }
unsigned int top
top of the border
Definition: Types.h:375
Window calculate_max_window(const ValidRegion &valid_region, const Steps &steps, bool skip_border, BorderSize border_size)
BorderSize border_size() const override
The size of the border for that kernel.
virtual ValidRegion valid_region() const =0
Valid region of the tensor.
Implementation of a rectangular access pattern.
bool update_window_and_padding(Window &win, Ts &&... patterns)
Update window and padding size for each of the access patterns.
Definition: WindowHelpers.h:46
Class to describe a number of elements in each dimension.
Definition: Steps.h:40
Implementation of a row access pattern.
virtual ITensorInfo * info() const =0
Interface to be implemented by the child class to return the tensor&#39;s metadata.
unsigned int left
left of the border
Definition: Types.h:378
unsigned int num_elems_processed_per_iteration
Describe a multidimensional execution window.
Definition: Window.h:39

◆ name()

◆ operator=() [1/2]

NEMedian3x3Kernel& operator= ( const NEMedian3x3Kernel )
delete

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

Referenced by NEMedian3x3Kernel::name().

◆ operator=() [2/2]

NEMedian3x3Kernel& operator= ( NEMedian3x3Kernel &&  )
default

Allow instances of this class to be moved.

◆ run()

void run ( const Window window,
const ThreadInfo info 
)
overridevirtual

Execute the kernel on the passed window.

Warning
If is_parallelisable() returns false then the passed window must be equal to window()
Note
The window has to be a region within the window returned by the window() method
The width of the window has to be a multiple of num_elems_processed_per_iteration().
Parameters
[in]windowRegion on which to execute the kernel. (Must be a region of the window returned by window())
[in]infoInfo about executing thread and CPU.

Reimplemented from ICPPKernel.

Definition at line 79 of file NEMedian3x3Kernel.cpp.

References ARM_COMPUTE_ERROR_ON_INVALID_SUBWINDOW, ARM_COMPUTE_ERROR_ON_UNCONFIGURED_KERNEL, ARM_COMPUTE_UNUSED, arm_compute::execute_window_loop(), arm_compute::test::validation::input, Iterator::offset(), Iterator::ptr(), and IKernel::window().

Referenced by NEMedian3x3Kernel::name().

80 {
81  ARM_COMPUTE_UNUSED(info);
84 
85  const unsigned char *input_bot_ptr = _input->ptr_to_element(Coordinates(-1, -1));
86  const unsigned char *input_mid_ptr = _input->ptr_to_element(Coordinates(-1, 0));
87  const unsigned char *input_top_ptr = _input->ptr_to_element(Coordinates(-1, +1));
88 
89  Iterator input(_input, window);
90  Iterator output(_output, window);
91 
92  execute_window_loop(window, [&](const Coordinates &)
93  {
94  const uint8x16_t top_data = vld1q_u8(input_top_ptr + input.offset());
95  const uint8x16_t mid_data = vld1q_u8(input_mid_ptr + input.offset());
96  const uint8x16_t bot_data = vld1q_u8(input_bot_ptr + input.offset());
97 
98  uint8x8_t p0 = vget_low_u8(top_data);
99  uint8x8_t p1 = vext_u8(vget_low_u8(top_data), vget_high_u8(top_data), 1);
100  uint8x8_t p2 = vext_u8(vget_low_u8(top_data), vget_high_u8(top_data), 2);
101  uint8x8_t p3 = vget_low_u8(mid_data);
102  uint8x8_t p4 = vext_u8(vget_low_u8(mid_data), vget_high_u8(mid_data), 1);
103  uint8x8_t p5 = vext_u8(vget_low_u8(mid_data), vget_high_u8(mid_data), 2);
104  uint8x8_t p6 = vget_low_u8(bot_data);
105  uint8x8_t p7 = vext_u8(vget_low_u8(bot_data), vget_high_u8(bot_data), 1);
106  uint8x8_t p8 = vext_u8(vget_low_u8(bot_data), vget_high_u8(bot_data), 2);
107 
108  sort(p1, p2);
109  sort(p4, p5);
110  sort(p7, p8);
111 
112  sort(p0, p1);
113  sort(p3, p4);
114  sort(p6, p7);
115 
116  sort(p1, p2);
117  sort(p4, p5);
118  sort(p7, p8);
119 
120  sort(p0, p3);
121  sort(p5, p8);
122  sort(p4, p7);
123 
124  sort(p3, p6);
125  sort(p1, p4);
126  sort(p2, p5);
127 
128  sort(p4, p7);
129  sort(p4, p2);
130  sort(p6, p4);
131 
132  sort(p4, p2);
133 
134  vst1_u8(output.ptr(), p4);
135  },
136  input, output);
137 }
const Window & window() const
The maximum window the kernel can be executed on.
Definition: IKernel.cpp:28
#define ARM_COMPUTE_UNUSED(...)
To avoid unused variables warnings.
Definition: Error.h:152
Coordinates of an item.
Definition: Coordinates.h:37
#define ARM_COMPUTE_ERROR_ON_UNCONFIGURED_KERNEL(k)
Definition: Validate.h:941
void execute_window_loop(const Window &w, L &&lambda_function, Ts &&... iterators)
Iterate through the passed window, automatically adjusting the iterators and calling the lambda_funct...
Definition: Helpers.inl:77
Iterator updated by execute_window_loop for each window element.
Definition: Helpers.h:46
#define ARM_COMPUTE_ERROR_ON_INVALID_SUBWINDOW(f, s)
Definition: Validate.h:205

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