NumCpp  2.16.1
A Templatized Header Only C++ Implementation of the Python NumPy Library
rankFilter1d.hpp
Go to the documentation of this file.
1
28#pragma once
29
30#include "NumCpp/Core/Slice.hpp"
31#include "NumCpp/Core/Types.hpp"
35#include "NumCpp/NdArray.hpp"
36
37namespace nc::filter
38{
39 //============================================================================
40 // Method Description:
53 template<typename dtype>
55 uint32 inSize,
56 uint8 inRank,
57 Boundary inBoundaryType = Boundary::REFLECT,
58 dtype inConstantValue = 0)
59 {
60 if (inRank >= inSize)
61 {
62 THROW_INVALID_ARGUMENT_ERROR("rank not within filter footprint size.");
63 }
64
65 NdArray<dtype> arrayWithBoundary =
66 boundary::addBoundary1d(inImageArray, inBoundaryType, inSize, inConstantValue);
67 NdArray<dtype> output(1, inImageArray.size());
68
69 const uint32 boundarySize = inSize / 2; // integer division
70 const uint32 endPoint = boundarySize + inImageArray.size();
71
72 for (uint32 i = boundarySize; i < endPoint; ++i)
73 {
74 NdArray<dtype> window = arrayWithBoundary[Slice(i - boundarySize, i + boundarySize + 1)];
75
76 output[i - boundarySize] = sort(window)[inRank];
77 }
78
79 return output;
80 }
81} // namespace nc::filter
#define THROW_INVALID_ARGUMENT_ERROR(msg)
Definition: Error.hpp:37
Holds 1D and 2D arrays, the main work horse of the NumCpp library.
Definition: NdArrayCore.hpp:139
size_type size() const noexcept
Definition: NdArrayCore.hpp:4604
A Class for slicing into NdArrays.
Definition: Slice.hpp:45
NdArray< dtype > addBoundary1d(const NdArray< dtype > &inImage, Boundary inBoundaryType, uint32 inKernalSize, dtype inConstantValue=0)
Definition: addBoundary1d.hpp:56
Definition: addBoundary1d.hpp:44
NdArray< dtype > rankFilter1d(const NdArray< dtype > &inImageArray, uint32 inSize, uint8 inRank, Boundary inBoundaryType=Boundary::REFLECT, dtype inConstantValue=0)
Definition: rankFilter1d.hpp:54
Boundary
Boundary condition to apply to the image filter.
Definition: Boundary.hpp:36
NdArray< dtype > sort(const NdArray< dtype > &inArray, Axis inAxis=Axis::NONE)
Definition: sort.hpp:46
std::uint8_t uint8
Definition: Types.hpp:42
std::uint32_t uint32
Definition: Types.hpp:40