Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 1 | /* |
Alex Gilday | c357c47 | 2018-03-21 13:54:09 +0000 | [diff] [blame] | 2 | * Copyright (c) 2016-2018 ARM Limited. |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 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_CLMAGNITUDEPHASEKERNEL_H__ |
| 25 | #define __ARM_COMPUTE_CLMAGNITUDEPHASEKERNEL_H__ |
| 26 | |
| 27 | #include "arm_compute/core/CL/ICLKernel.h" |
| 28 | #include "arm_compute/core/Types.h" |
| 29 | |
| 30 | namespace arm_compute |
| 31 | { |
| 32 | class ICLTensor; |
| 33 | |
| 34 | /** Template interface for the kernel to compute magnitude and phase. |
| 35 | * |
| 36 | */ |
| 37 | class CLMagnitudePhaseKernel : public ICLKernel |
| 38 | { |
| 39 | public: |
| 40 | /** Default constructor. */ |
| 41 | CLMagnitudePhaseKernel(); |
Alex Gilday | c357c47 | 2018-03-21 13:54:09 +0000 | [diff] [blame] | 42 | /** Prevent instances of this class from being copied (As this class contains pointers) */ |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 43 | CLMagnitudePhaseKernel(const CLMagnitudePhaseKernel &) = delete; |
Alex Gilday | c357c47 | 2018-03-21 13:54:09 +0000 | [diff] [blame] | 44 | /** Prevent instances of this class from being copied (As this class contains pointers) */ |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 45 | CLMagnitudePhaseKernel &operator=(const CLMagnitudePhaseKernel &) = delete; |
| 46 | /** Allow instances of this class to be moved */ |
| 47 | CLMagnitudePhaseKernel(CLMagnitudePhaseKernel &&) = default; |
| 48 | /** Allow instances of this class to be moved */ |
| 49 | CLMagnitudePhaseKernel &operator=(CLMagnitudePhaseKernel &&) = default; |
| 50 | /** Initialise the kernel's input, output. |
| 51 | * |
| 52 | * @note At least one of output1 or output2 must be set. |
| 53 | * |
| 54 | * @param[in] gx The input gradient X tensor. Data types supported: S16. |
| 55 | * @param[in] gy The input gradient Y tensor. Data types supported: S16. |
| 56 | * @param[out] magnitude (Optional) The output tensor - Magnitude. Data types supported: S16. |
| 57 | * @param[out] phase (Optional) The output tensor - Phase. Data types supported: U8. |
| 58 | * @param[in] mag_type (Optional) Magnitude calculation type. Default: L2NORM. |
| 59 | * @param[in] phase_type (Optional) Phase calculation type. Default: SIGNED. |
| 60 | */ |
| 61 | void configure(const ICLTensor *gx, const ICLTensor *gy, ICLTensor *magnitude, ICLTensor *phase, |
| 62 | MagnitudeType mag_type = MagnitudeType::L2NORM, PhaseType phase_type = PhaseType::SIGNED); |
| 63 | |
| 64 | // Inherited methods overridden: |
| 65 | void run(const Window &window, cl::CommandQueue &queue) override; |
| 66 | |
| 67 | private: |
| 68 | const ICLTensor *_gx; /**< Input gradient X. */ |
| 69 | const ICLTensor *_gy; /**< Input gradient Y. */ |
| 70 | ICLTensor *_magnitude; /**< Output - Magnitude. */ |
| 71 | ICLTensor *_phase; /**< Output - Phase. */ |
| 72 | bool _run_mag; /**< Calculate magnitude ? */ |
| 73 | bool _run_phase; /**< Calculate phase ? */ |
| 74 | }; |
Gian Marco Iodice | f670a0a | 2017-09-18 12:20:45 +0100 | [diff] [blame] | 75 | } // namespace arm_compute |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 76 | #endif /* __ARM_COMPUTE_CLMAGNITUDEPHASEKERNEL_H__ */ |