NumCpp  2.11.0
A Templatized Header Only C++ Implementation of the Python NumPy Library
rankFilter.hpp
Go to the documentation of this file.
1 #pragma once
29 
30 #include <string>
31 
33 #include "NumCpp/Core/Shape.hpp"
34 #include "NumCpp/Core/Slice.hpp"
35 #include "NumCpp/Core/Types.hpp"
38 #include "NumCpp/NdArray.hpp"
39 
40 namespace nc::filter
41 {
42  //============================================================================
43  // Method Description:
56  template<typename dtype>
58  uint32 inSize,
59  uint32 inRank,
60  Boundary inBoundaryType = Boundary::REFLECT,
61  dtype inConstantValue = 0)
62  {
63  if (inRank >= utils::sqr(inSize))
64  {
65  THROW_INVALID_ARGUMENT_ERROR("rank not within filter footprint size.");
66  }
67 
68  NdArray<dtype> arrayWithBoundary =
69  boundary::addBoundary2d(inImageArray, inBoundaryType, inSize, inConstantValue);
70  NdArray<dtype> output(inImageArray.shape());
71 
72  const Shape inShape = inImageArray.shape();
73  const uint32 boundarySize = inSize / 2; // integer division
74  const uint32 endPointRow = boundarySize + inShape.rows;
75  const uint32 endPointCol = boundarySize + inShape.cols;
76 
77  for (uint32 row = boundarySize; row < endPointRow; ++row)
78  {
79  for (uint32 col = boundarySize; col < endPointCol; ++col)
80  {
81  NdArray<dtype> window = arrayWithBoundary(Slice(row - boundarySize, row + boundarySize + 1),
82  Slice(col - boundarySize, col + boundarySize + 1));
83 
84  output(row - boundarySize, col - boundarySize) = sort(window)[inRank];
85  }
86  }
87 
88  return output;
89  }
90 } // 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:138
const Shape & shape() const noexcept
Definition: NdArrayCore.hpp:4464
A Shape Class for NdArrays.
Definition: Core/Shape.hpp:41
uint32 rows
Definition: Core/Shape.hpp:44
uint32 cols
Definition: Core/Shape.hpp:45
A Class for slicing into NdArrays.
Definition: Slice.hpp:45
NdArray< dtype > addBoundary2d(const NdArray< dtype > &inImage, Boundary inBoundaryType, uint32 inKernalSize, dtype inConstantValue=0)
Definition: addBoundary2d.hpp:56
Definition: addBoundary1d.hpp:44
NdArray< dtype > rankFilter(const NdArray< dtype > &inImageArray, uint32 inSize, uint32 inRank, Boundary inBoundaryType=Boundary::REFLECT, dtype inConstantValue=0)
Definition: rankFilter.hpp:57
Boundary
Boundary condition to apply to the image filter.
Definition: Boundary.hpp:36
constexpr dtype sqr(dtype inValue) noexcept
Definition: sqr.hpp:42
NdArray< dtype > sort(const NdArray< dtype > &inArray, Axis inAxis=Axis::NONE)
Definition: sort.hpp:46
std::uint32_t uint32
Definition: Types.hpp:40