NumCpp  2.11.0
A Templatized Header Only C++ Implementation of the Python NumPy Library
convolve.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/Functions/dot.hpp"
40 #include "NumCpp/NdArray.hpp"
41 #include "NumCpp/Utils/sqr.hpp"
42 
43 namespace nc::filter
44 {
45  //============================================================================
46  // Method Description:
59  template<typename dtype>
60  NdArray<dtype> convolve(const NdArray<dtype>& inImageArray,
61  uint32 inSize,
62  const NdArray<dtype>& inWeights,
63  Boundary inBoundaryType = Boundary::REFLECT,
64  dtype inConstantValue = 0)
65  {
66  if (inWeights.size() != utils::sqr(inSize))
67  {
68  THROW_INVALID_ARGUMENT_ERROR("input weights do no match input kernal size.");
69  }
70 
71  NdArray<dtype> arrayWithBoundary =
72  boundary::addBoundary2d(inImageArray, inBoundaryType, inSize, inConstantValue);
73  NdArray<dtype> output(inImageArray.shape());
74 
75  NdArray<dtype> weightsFlat = rot90(inWeights, 2).flatten();
76  const Shape inShape = inImageArray.shape();
77  const uint32 boundarySize = inSize / 2; // integer division
78  const uint32 endPointRow = boundarySize + inShape.rows;
79  const uint32 endPointCol = boundarySize + inShape.cols;
80 
81  for (uint32 row = boundarySize; row < endPointRow; ++row)
82  {
83  for (uint32 col = boundarySize; col < endPointCol; ++col)
84  {
85  NdArray<dtype> window = arrayWithBoundary(Slice(row - boundarySize, row + boundarySize + 1),
86  Slice(col - boundarySize, col + boundarySize + 1))
87  .flatten();
88 
89  output(row - boundarySize, col - boundarySize) = dot(window, weightsFlat).item();
90  }
91  }
92 
93  return output;
94  }
95 } // 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
size_type size() const noexcept
Definition: NdArrayCore.hpp:4477
self_type flatten() const
Definition: NdArrayCore.hpp:2800
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 > convolve(const NdArray< dtype > &inImageArray, uint32 inSize, const NdArray< dtype > &inWeights, Boundary inBoundaryType=Boundary::REFLECT, dtype inConstantValue=0)
Definition: convolve.hpp:60
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 > dot(const NdArray< dtype > &inArray1, const NdArray< dtype > &inArray2)
Definition: dot.hpp:47
NdArray< dtype > rot90(const NdArray< dtype > &inArray, uint8 inK=1)
Definition: rot90.hpp:50
std::uint32_t uint32
Definition: Types.hpp:40