Compute Library
 21.02
NEMagnitudePhaseKernel.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2016-2020 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_NEMAGNITUDEPHASEKERNEL_H
25 #define ARM_COMPUTE_NEMAGNITUDEPHASEKERNEL_H
26 
27 #include "arm_compute/core/Types.h"
29 
30 namespace arm_compute
31 {
32 class ITensor;
33 
34 /** Template interface for the kernel to compute magnitude and phase */
35 template <MagnitudeType mag_type, PhaseType phase_type>
37 {
38 public:
39  const char *name() const override
40  {
41  return "NEMagnitudePhaseKernel";
42  }
43  /** Default constructor */
45  /** Prevent instances of this class from being copied (As this class contains pointers) */
47  /** Default move constructor */
49  /** Prevent instances of this class from being copied (As this class contains pointers) */
51  /** Default move assignment operator */
53  /** Destructor */
54  ~NEMagnitudePhaseKernel() = default;
55 
56  /** Initialise the kernel's input, output.
57  *
58  * @note At least one of out1 or out2 must be set
59  *
60  * @param[in] gx Gradient X tensor. Data type supported: S16.
61  * @param[in] gy Gradient Y tensor. Data type supported: S16.
62  * @param[out] magnitude (Optional) The output tensor - Magnitude. Data type supported: S16.
63  * @param[out] phase (Optional) The output tensor - Phase. Data type supported: U8.
64  */
65  void configure(const ITensor *gx, const ITensor *gy, ITensor *magnitude, ITensor *phase);
66 
67  // Inherited methods overridden:
68  void run(const Window &window, const ThreadInfo &info) override;
69 
70 private:
71  /** Function to perform magnitude on the given window
72  *
73  * @param[in] window Region on which to execute the kernel
74  */
75  void magnitude(const Window &window);
76  /** Function to perform phase on the given window
77  *
78  * @param[in] window Region on which to execute the kernel
79  */
80  void phase(const Window &window);
81  /** Function to perform magnitude and phase on the given window
82  *
83  * @param[in] window Region on which to execute the kernel
84  */
85  void magnitude_phase(const Window &window);
86 
87 private:
88  /** Common signature for all the specialised MagnitudePhase functions
89  *
90  * @param[in] window Region on which to execute the kernel.
91  */
92  using MagnitudePhaseFunctionPtr = void (NEMagnitudePhaseKernel::*)(const Window &window);
93  /** MagnitudePhase function to use for the particular formats passed to configure() */
94  MagnitudePhaseFunctionPtr _func;
95  const ITensor *_gx; /**< Input gradient X */
96  const ITensor *_gy; /**< Input gradient Y */
97  ITensor *_magnitude; /**< Output - Magnitude */
98  ITensor *_phase; /**< Output - Phase */
99 };
100 } // namespace arm_compute
101 #endif /* ARM_COMPUTE_NEMAGNITUDEPHASEKERNEL_H */
const Window & window() const
The maximum window the kernel can be executed on.
Definition: IKernel.cpp:28
const char * name() const override
Name of the kernel.
Common interface for all kernels implemented in C++.
Definition: ICPPKernel.h:38
NEMagnitudePhaseKernel & operator=(const NEMagnitudePhaseKernel &)=delete
Prevent instances of this class from being copied (As this class contains pointers) ...
Template interface for the kernel to compute magnitude and phase.
Interface for Neon tensor.
Definition: ITensor.h:36
Copyright (c) 2017-2021 Arm Limited.
ScaleKernelInfo info(interpolation_policy, default_border_mode, PixelValue(), sampling_policy, false)
void run(const Window &window, const ThreadInfo &info) override
Execute the kernel on the passed window.
~NEMagnitudePhaseKernel()=default
Destructor.
Information about executing thread and CPU.
Definition: CPPTypes.h:235
void configure(const ITensor *gx, const ITensor *gy, ITensor *magnitude, ITensor *phase)
Initialise the kernel&#39;s input, output.
Describe a multidimensional execution window.
Definition: Window.h:39