Compute Library
 21.02
neoncl_scale_median_gaussian.cpp
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2016-2021 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_CL /* Needed by Utils.cpp to handle OpenCL exceptions properly */
25 #error "This example needs to be built with -DARM_COMPUTE_CL"
26 #endif /* ARM_COMPUTE_CL */
27 
28 #include "arm_compute/core/Types.h"
33 #include "utils/ImageLoader.h"
34 #include "utils/Utils.h"
35 
36 using namespace arm_compute;
37 using namespace utils;
38 
39 /** Example demonstrating how to use both CL and Neon functions in the same pipeline
40  *
41  * @param[in] argc Number of arguments
42  * @param[in] argv Arguments ( [optional] Path to PPM image to process )
43  */
44 class NEONCLScaleMedianGaussianExample : public Example
45 {
46 public:
47  bool do_setup(int argc, char **argv) override
48  {
49  /** [Neon / OpenCL Interop] */
50  PPMLoader ppm;
51 
53 
54  if(argc < 2)
55  {
56  // Print help
57  std::cout << "Usage: ./build/cl_convolution [input_image.ppm]\n\n";
58  std::cout << "No input_image provided, creating a dummy 640x480 image\n";
59  // Create an empty grayscale 640x480 image
60  src.allocator()->init(TensorInfo(640, 480, Format::U8));
61  }
62  else
63  {
64  ppm.open(argv[1]);
66  }
67 
68  TensorInfo scale_median_info(TensorInfo(src.info()->dimension(0) / 2, src.info()->dimension(1) / 2, Format::U8));
69 
70  // Configure the temporary and destination images
71  scale_median.allocator()->init(scale_median_info);
72  median_gauss.allocator()->init(scale_median_info);
73  dst.allocator()->init(scale_median_info);
74 
76  median.configure(&scale_median, &median_gauss, BorderMode::REPLICATE);
77  gauss.configure(&median_gauss, &dst, BorderMode::REPLICATE);
78 
79  // Allocate all the images
80  src.allocator()->allocate();
81  scale_median.allocator()->allocate();
82  median_gauss.allocator()->allocate();
83  dst.allocator()->allocate();
84 
85  // Fill the input image with the content of the PPM image if a filename was provided:
86  if(ppm.is_open())
87  {
88  ppm.fill_image(src);
89  const std::string output_filename = std::string(argv[1]) + "_out.ppm";
90  }
91  /** [Neon / OpenCL Interop] */
92 
93  return true;
94  }
95  void do_run() override
96  {
97  // Enqueue and flush the OpenCL kernel:
98  scale.run();
99 
100  // Do a blocking map of the input and output buffers of the Neon function:
101  scale_median.map();
102  median_gauss.map();
103 
104  // Run the Neon function:
105  median.run();
106 
107  // Unmap the output buffer before it's used again by OpenCL:
108  scale_median.unmap();
109  median_gauss.unmap();
110 
111  // Run the final OpenCL function:
112  gauss.run();
113 
114  // Make sure all the OpenCL jobs are done executing:
116  }
117  void do_teardown() override
118  {
119  // Save the result to file:
120  if(!output_filename.empty())
121  {
122  save_to_ppm(dst, output_filename); // save_to_ppm maps and unmaps the image to store as PPM
123  }
124  }
125 
126 private:
127  CLImage src{}, scale_median{}, median_gauss{}, dst{};
128  CLScale scale{};
129  NEMedian3x3 median{};
130  CLGaussian5x5 gauss{};
131  std::string output_filename{};
132 };
133 
134 /** Main program for neon/cl scale median gaussian test
135  *
136  * @param[in] argc Number of arguments
137  * @param[in] argv Arguments ( [optional] Path to PPM image to process )
138  */
139 int main(int argc, char **argv)
140 {
141  return utils::run_example<NEONCLScaleMedianGaussianExample>(argc, argv);
142 }
int main(int argc, char **argv)
Main program for neon/cl scale median gaussian test.
void save_to_ppm(T &tensor, const std::string &ppm_filename)
Template helper function to save a tensor image to a PPM file.
Definition: Utils.h:547
void run() override final
Run the kernels contained in the function.
static CLScheduler & get()
Access the scheduler singleton.
void open(const std::string &filename) override
Open an image file and reads its metadata (Width, height)
Definition: ImageLoader.h:381
1 channel, 1 U8 per channel
Output values are defined to match the source pixel whose center is nearest to the sample position...
Includes all the Neon functions at once.
SimpleTensor< float > src
Definition: DFT.cpp:155
Basic function to run CLScaleKernel.
Definition: CLScale.h:44
Copyright (c) 2017-2021 Arm Limited.
bool is_open() override
Return true if the image file is currently open.
Definition: ImageLoader.h:377
Interface to enqueue OpenCL kernels and get/set the OpenCL CommandQueue and ICLTuner.
Abstract Example class.
Definition: Utils.h:78
void configure(ITensor *input, ITensor *output, const ScaleKernelInfo &info)
Initialize the function&#39;s source, destination, interpolation type and border_mode.
Definition: NEScale.cpp:104
void fill_image(T &image)
Fill an image with the content of the currently open image file.
Definition: ImageLoader.h:177
void sync()
Blocks until all commands in the associated command queue have finished.
Definition: CLScheduler.cpp:72
Basic function to execute gaussian filter 5x5.
Definition: CLGaussian5x5.h:53
Pixels outside the image are assumed to have the same value as the closest image pixel.
Store the tensor&#39;s metadata.
Definition: TensorInfo.h:45
void default_init(ICLTuner *cl_tuner=nullptr, CLGEMMHeuristicsHandle *gemm_h=nullptr)
Initialises the context and command queue used by the scheduler to default values and sets a default ...
void init_image(T &image, Format format)
Initialise an image&#39;s metadata with the dimensions of the image file currently open.
Definition: ImageLoader.h:161
PPM Image loader concrete implementation.
Definition: ImageLoader.h:367
Basic function to execute median filter.
Definition: NEMedian3x3.h:44
Basic implementation of the OpenCL tensor interface.
Definition: CLTensor.h:41