feat: add support for the function 'getStructuringElement'

Author: martinbooth

cpp/FOCV_Function.cpp

@@ -1080,6 +1080,16 @@ jsi::Object FOCV_Function::invoke(jsi::Runtime& runtime, const jsi::Value* argum
 
         return FOCV_JsiObject::wrap(runtime, "mat", id);
       } break;
+      case hashString("getStructuringElement", 21): {
+        auto shape = args.asNumber(1);
+        auto ksize = args.asSizePtr(2);
+        auto anchor = args.asPointPtr(3);
+
+        cv::Mat result = cv::getStructuringElement(shape, *ksize, *anchor);
+        std::string id = FOCV_Storage::save(result);
+
+        return FOCV_JsiObject::wrap(runtime, "mat", id);
+      } break;
       case hashString("Laplacian", 9): {
         auto src = args.asMatPtr(1);
         auto dst = args.asMatPtr(2);

docs/pages/availablefunctions.md

@@ -1793,6 +1793,23 @@ invoke(
 ): Mat;
 ```
 
+### getStructuringElement
+
+Returns a structuring element of the specified size and shape for morphological operations.
+
+- shape Element shape that could be one of MorphShapes
+- ksize Size of the structuring element.
+- anchor Anchor position within the element. The default value means that the anchor is at the center. Note that only the shape of a cross-shaped element depends on the anchor position. In other cases the anchor just regulates how much the result of the morphological operation is shifted..
+
+```js
+invoke(
+  name: 'getGaussianKernel',
+    shape: MorphShapes,
+    ksize: Size,
+    anchor: Point
+): Mat;
+```
+
 ### Laplacian
 Calculates the Laplacian of an image.
 - name Function name.

src/functions/ImageProcessing/ImageFiltering.ts

@@ -1,6 +1,6 @@
 import type { BorderTypes } from '../../constants/Core';
 import type { DataTypes } from '../../constants/DataTypes';
-import type { MorphTypes } from '../../constants/ImageProcessing';
+import type { MorphShapes, MorphTypes } from '../../constants/ImageProcessing';
 import type { Mat, Point, Scalar, Size } from '../../objects/Objects';
 
 export type ImageFiltering = {
@@ -192,6 +192,19 @@ export type ImageFiltering = {
     ktype: DataTypes.CV_32F | DataTypes.CV_64F
   ): Mat;
 
+  /**
+   * Returns a structuring element of the specified size and shape for morphological operations.
+   * @param shape Element shape that could be one of MorphShapes
+   * @param ksize Size of the structuring element.
+   * @param anchor Anchor position within the element. The default value means that the anchor is at the center. Note that only the shape of a cross-shaped element depends on the anchor position. In other cases the anchor just regulates how much the result of the morphological operation is shifted.
+   */
+  invoke(
+    name: 'getStructuringElement',
+    shape: MorphShapes,
+    ksize: Size,
+    anchor: Point
+  ): Mat;
+
   /**
    * Calculates the Laplacian of an image.
    * @param name Function name.