From 6ff3b19ee6120edf015fad8caab2991faa3070af Mon Sep 17 00:00:00 2001 From: Anthony Barbier Date: Mon, 4 Sep 2017 18:44:23 +0100 Subject: COMPMID-344 Updated doxygen Change-Id: I32f7b84daa560e460b77216add529c8fa8b327ae --- arm_compute/core/CPP/CPPKernels.h | 32 ++++++++++ arm_compute/core/CPP/ICPPKernel.h | 53 ++++++++++++++++ arm_compute/core/CPP/ICPPSimpleKernel.h | 66 +++++++++++++++++++ .../core/CPP/kernels/CPPCornerCandidatesKernel.h | 74 ++++++++++++++++++++++ .../CPPDetectionWindowNonMaximaSuppressionKernel.h | 72 +++++++++++++++++++++ .../CPP/kernels/CPPSortEuclideanDistanceKernel.h | 70 ++++++++++++++++++++ 6 files changed, 367 insertions(+) create mode 100644 arm_compute/core/CPP/CPPKernels.h create mode 100644 arm_compute/core/CPP/ICPPKernel.h create mode 100644 arm_compute/core/CPP/ICPPSimpleKernel.h create mode 100644 arm_compute/core/CPP/kernels/CPPCornerCandidatesKernel.h create mode 100644 arm_compute/core/CPP/kernels/CPPDetectionWindowNonMaximaSuppressionKernel.h create mode 100644 arm_compute/core/CPP/kernels/CPPSortEuclideanDistanceKernel.h (limited to 'arm_compute/core/CPP') diff --git a/arm_compute/core/CPP/CPPKernels.h b/arm_compute/core/CPP/CPPKernels.h new file mode 100644 index 0000000000..1eabfa9437 --- /dev/null +++ b/arm_compute/core/CPP/CPPKernels.h @@ -0,0 +1,32 @@ +/* + * Copyright (c) 2017 ARM Limited. + * + * SPDX-License-Identifier: MIT + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to + * deal in the Software without restriction, including without limitation the + * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or + * sell copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + */ +#ifndef __ARM_COMPUTE_CPPKERNELS_H__ +#define __ARM_COMPUTE_CPPKERNELS_H__ + +/* Header regrouping all the CPP kernels */ +#include "arm_compute/core/CPP/kernels/CPPCornerCandidatesKernel.h" +#include "arm_compute/core/CPP/kernels/CPPDetectionWindowNonMaximaSuppressionKernel.h" +#include "arm_compute/core/CPP/kernels/CPPSortEuclideanDistanceKernel.h" + +#endif /* __ARM_COMPUTE_CPPKERNELS_H__ */ diff --git a/arm_compute/core/CPP/ICPPKernel.h b/arm_compute/core/CPP/ICPPKernel.h new file mode 100644 index 0000000000..99ae68f2e5 --- /dev/null +++ b/arm_compute/core/CPP/ICPPKernel.h @@ -0,0 +1,53 @@ +/* + * Copyright (c) 2016, 2017 ARM Limited. + * + * SPDX-License-Identifier: MIT + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to + * deal in the Software without restriction, including without limitation the + * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or + * sell copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + */ +#ifndef __ARM_COMPUTE_ICPPKERNEL_H__ +#define __ARM_COMPUTE_ICPPKERNEL_H__ + +#include "arm_compute/core/IKernel.h" + +namespace arm_compute +{ +class Window; + +/** Common interface for all kernels implemented in C++ */ +class ICPPKernel : public IKernel +{ +public: + /** Default destructor */ + virtual ~ICPPKernel() = default; + + /** 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 + * + * @note The width of the window has to be a multiple of num_elems_processed_per_iteration(). + * + * @param[in] window Region on which to execute the kernel. (Must be a region of the window returned by window()) + */ + virtual void run(const Window &window) = 0; +}; +} +#endif /*__ARM_COMPUTE_ICPPKERNEL_H__ */ diff --git a/arm_compute/core/CPP/ICPPSimpleKernel.h b/arm_compute/core/CPP/ICPPSimpleKernel.h new file mode 100644 index 0000000000..105de397a2 --- /dev/null +++ b/arm_compute/core/CPP/ICPPSimpleKernel.h @@ -0,0 +1,66 @@ +/* + * Copyright (c) 2017 ARM Limited. + * + * SPDX-License-Identifier: MIT + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to + * deal in the Software without restriction, including without limitation the + * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or + * sell copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + */ +#ifndef __ARM_COMPUTE_ICPPSIMPLEKERNEL_H__ +#define __ARM_COMPUTE_ICPPSIMPLEKERNEL_H__ + +#include "arm_compute/core/CPP/ICPPKernel.h" + +namespace arm_compute +{ +class ITensor; + +/** Interface for simple NEON kernels having 1 tensor input and 1 tensor output */ +class ICPPSimpleKernel : public ICPPKernel +{ +public: + /** Constructor */ + ICPPSimpleKernel(); + /** Prevent instances of this class from being copied (As this class contains pointers) */ + ICPPSimpleKernel(const ICPPSimpleKernel &) = delete; + /** Prevent instances of this class from being copied (As this class contains pointers) */ + ICPPSimpleKernel &operator=(const ICPPSimpleKernel &) = delete; + /** Allow instances of this class to be moved */ + ICPPSimpleKernel(ICPPSimpleKernel &&) = default; + /** Allow instances of this class to be moved */ + ICPPSimpleKernel &operator=(ICPPSimpleKernel &&) = default; + /** Default destructor */ + ~ICPPSimpleKernel() = default; + +protected: + /** Configure the kernel + * + * @param[in] input Source tensor. + * @param[out] output Destination tensor. + * @param[in] num_elems_processed_per_iteration Number of processed elements per iteration. + * @param[in] border_undefined (Optional) True if the border mode is undefined. False if it's replicate or constant. + * @param[in] border_size (Optional) Size of the border. + */ + void configure(const ITensor *input, ITensor *output, unsigned int num_elems_processed_per_iteration, bool border_undefined = false, const BorderSize &border_size = BorderSize()); + +protected: + const ITensor *_input; + ITensor *_output; +}; +} +#endif /*__ARM_COMPUTE_ICPPSIMPLEKERNEL_H__ */ diff --git a/arm_compute/core/CPP/kernels/CPPCornerCandidatesKernel.h b/arm_compute/core/CPP/kernels/CPPCornerCandidatesKernel.h new file mode 100644 index 0000000000..0866d4ee57 --- /dev/null +++ b/arm_compute/core/CPP/kernels/CPPCornerCandidatesKernel.h @@ -0,0 +1,74 @@ +/* + * Copyright (c) 2017 ARM Limited. + * + * SPDX-License-Identifier: MIT + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to + * deal in the Software without restriction, including without limitation the + * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or + * sell copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + */ +#ifndef __ARM_COMPUTE_CPPCORNERCANDIDATESKERNEL_H__ +#define __ARM_COMPUTE_CPPCORNERCANDIDATESKERNEL_H__ + +#include "arm_compute/core/IArray.h" +#include "arm_compute/core/NEON/INEKernel.h" + +#include +#include + +namespace arm_compute +{ +class ITensor; +using IImage = ITensor; + +/** CPP kernel to perform corner candidates + */ +class CPPCornerCandidatesKernel : public INEKernel +{ +public: + /** Default constructor */ + CPPCornerCandidatesKernel(); + /** Prevent instances of this class from being copied (As this class contains pointers) */ + CPPCornerCandidatesKernel(const CPPCornerCandidatesKernel &) = delete; + /** Prevent instances of this class from being copied (As this class contains pointers) */ + CPPCornerCandidatesKernel &operator=(const CPPCornerCandidatesKernel &) = delete; + /** Allow instances of this class to be moved */ + CPPCornerCandidatesKernel(CPPCornerCandidatesKernel &&) = default; + /** Allow instances of this class to be moved */ + CPPCornerCandidatesKernel &operator=(CPPCornerCandidatesKernel &&) = default; + /** Default destructor */ + ~CPPCornerCandidatesKernel() = default; + + /** Setup the kernel parameters + * + * @param[in] input Source image (harris score). Format supported F32 + * @param[out] output Destination array of InternalKeypoint + * @param[out] num_corner_candidates Number of corner candidates + */ + void configure(const IImage *input, InternalKeypoint *output, int32_t *num_corner_candidates); + + // Inherited methods overridden: + void run(const Window &window) override; + +private: + int32_t *_num_corner_candidates; /**< Number of corner candidates */ + std::mutex _corner_candidates_mutex; /**< Mutex to preventing race conditions */ + const IImage *_input; /**< Source image - Harris score */ + InternalKeypoint *_output; /**< Array of NEInternalKeypoint */ +}; +} //namespace arm_compute +#endif /* __ARM_COMPUTE_CPPCORNERCANDIDATESKERNEL_H__ */ diff --git a/arm_compute/core/CPP/kernels/CPPDetectionWindowNonMaximaSuppressionKernel.h b/arm_compute/core/CPP/kernels/CPPDetectionWindowNonMaximaSuppressionKernel.h new file mode 100644 index 0000000000..bcb3026959 --- /dev/null +++ b/arm_compute/core/CPP/kernels/CPPDetectionWindowNonMaximaSuppressionKernel.h @@ -0,0 +1,72 @@ +/* + * Copyright (c) 2017 ARM Limited. + * + * SPDX-License-Identifier: MIT + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to + * deal in the Software without restriction, including without limitation the + * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or + * sell copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + */ +#ifndef __ARM_COMPUTE_CPPDETECTIONWINDOWNONMAXIMASUPPRESSIONKERNEL_H__ +#define __ARM_COMPUTE_CPPDETECTIONWINDOWNONMAXIMASUPPRESSIONKERNEL_H__ + +#include "arm_compute/core/IArray.h" +#include "arm_compute/core/IHOG.h" +#include "arm_compute/core/NEON/INEKernel.h" +#include "arm_compute/core/Types.h" + +namespace arm_compute +{ +/** CPP kernel to perform in-place computation of euclidean distance on IDetectionWindowArray + * + * @note This kernel is meant to be used alongside HOG or other object detection algorithms to perform a non-maxima suppression on a + * IDetectionWindowArray + */ +class CPPDetectionWindowNonMaximaSuppressionKernel : public ICPPKernel +{ +public: + /** Default constructor */ + CPPDetectionWindowNonMaximaSuppressionKernel(); + /** Prevent instances of this class from being copied (As this class contains pointers) */ + CPPDetectionWindowNonMaximaSuppressionKernel(const CPPDetectionWindowNonMaximaSuppressionKernel &) = delete; + /** Prevent instances of this class from being copied (As this class contains pointers) */ + CPPDetectionWindowNonMaximaSuppressionKernel &operator=(const CPPDetectionWindowNonMaximaSuppressionKernel &) = delete; + /** Allow instances of this class to be moved */ + CPPDetectionWindowNonMaximaSuppressionKernel(CPPDetectionWindowNonMaximaSuppressionKernel &&) = default; + /** Allow instances of this class to be moved */ + CPPDetectionWindowNonMaximaSuppressionKernel &operator=(CPPDetectionWindowNonMaximaSuppressionKernel &&) = default; + /** Initialise the kernel's input, output and the euclidean minimum distance + * + * @attention: If @ref CLDetectionWindowArray is passed to the kernel, the map() and unmap() methods @ref CLDetectionWindowArray must be called respectively before and after + * the run() method of @ref CPPDetectionWindowNonMaximaSuppressionKernel + * + * @param[in, out] input_output Input/Output array of @ref DetectionWindow + * @param[in] min_distance Radial Euclidean distance for non-maxima suppression + */ + void configure(IDetectionWindowArray *input_output, float min_distance); + + // Inherited methods overridden: + void run(const Window &window) override; + bool is_parallelisable() const override; + +private: + IDetectionWindowArray *_input_output; + float _min_distance; +}; +} + +#endif /* __ARM_COMPUTE_CPPDETECTIONWINDOWNONMAXIMASUPPRESSIONKERNEL_H__ */ diff --git a/arm_compute/core/CPP/kernels/CPPSortEuclideanDistanceKernel.h b/arm_compute/core/CPP/kernels/CPPSortEuclideanDistanceKernel.h new file mode 100644 index 0000000000..b7a7d9ff9f --- /dev/null +++ b/arm_compute/core/CPP/kernels/CPPSortEuclideanDistanceKernel.h @@ -0,0 +1,70 @@ +/* + * Copyright (c) 2017 ARM Limited. + * + * SPDX-License-Identifier: MIT + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to + * deal in the Software without restriction, including without limitation the + * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or + * sell copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + */ +#ifndef __ARM_COMPUTE_CPPSORTEUCLIDEANDISTANCEKERNEL_H__ +#define __ARM_COMPUTE_CPPSORTEUCLIDEANDISTANCEKERNEL_H__ + +#include "arm_compute/core/CPP/ICPPKernel.h" +#include "arm_compute/core/IArray.h" + +#include +#include + +namespace arm_compute +{ +/** CPP kernel to perform sorting and euclidean distance */ +class CPPSortEuclideanDistanceKernel : public ICPPKernel +{ +public: + /** Default constructor */ + CPPSortEuclideanDistanceKernel(); + /** Prevent instances of this class from being copied (As this class contains pointers) */ + CPPSortEuclideanDistanceKernel(const CPPSortEuclideanDistanceKernel &) = delete; + /** Prevent instances of this class from being copied (As this class contains pointers) */ + CPPSortEuclideanDistanceKernel &operator=(const CPPSortEuclideanDistanceKernel &) = delete; + /** Allow instances of this class to be moved */ + CPPSortEuclideanDistanceKernel(CPPSortEuclideanDistanceKernel &&) = default; + /** Allow instances of this class to be moved */ + CPPSortEuclideanDistanceKernel &operator=(CPPSortEuclideanDistanceKernel &&) = default; + /** Initialise the kernel's source, destination and border mode. + * + * @param[in,out] in_out Input internal keypoints. Marked as out as the kernel writes 0 in the strength member. + * @param[out] output Output keypoints. + * @param[in] num_corner_candidates Pointer to the number of corner candidates in the input array + * @param[in] min_distance Radial Euclidean distance to use + */ + void configure(InternalKeypoint *in_out, IKeyPointArray *output, const int32_t *num_corner_candidates, float min_distance); + + // Inherited methods overridden: + void run(const Window &window) override; + bool is_parallelisable() const override; + +private: + const int32_t *_num_corner_candidates; /**< Number of corner candidates */ + float _min_distance; /**< Radial Euclidean distance */ + InternalKeypoint *_in_out; /**< Source array of InternalKeypoint */ + IKeyPointArray *_output; /**< Destination array of IKeyPointArray */ +}; + +} // namespace arm_compute +#endif /* __ARM_COMPUTE_CPPSORTEUCLIDEANDISTANCEKERNEL_H__ */ -- cgit v1.2.1