@techstark/opencv-js 4.10.0-release.1 → 4.12.0-release.1

package/src/types/opencv/QRCodeDetectorAruco.ts

@@ -0,0 +1,139 @@
+import type {
+  bool,
+  float,
+  InputArray,
+  OutputArray,
+  OutputArrayOfArrays,
+} from "./_types";
+
+/**
+ * Parameters for QRCodeDetectorAruco
+ */
+export declare class QRCodeDetectorAruco_Params {
+  public minModuleSizeInPyramid: float;
+  public maxRotation: float;
+  public maxModuleSizeMismatch: float;
+  public maxTimingPatternMismatch: float;
+  public maxPenalties: float;
+  public maxColorsMismatch: float;
+  public scaleTimingPatternScore: float;
+
+  public constructor();
+
+  /**
+   * Releases the object
+   */
+  public delete(): void;
+}
+
+/**
+ * QR Code detection and decoding class using Aruco-based detection.
+ *
+ * This class implements QR code detection and decoding functionality using
+ * Aruco marker detection techniques for improved robustness.
+ *
+ * Source:
+ * [opencv2/objdetect.hpp](https://github.com/opencv/opencv/tree/master/modules/objdetect/include/opencv2/objdetect.hpp).
+ */
+export declare class QRCodeDetectorAruco {
+  /**
+   * QRCodeDetectorAruco constructor
+   */
+  public constructor();
+
+  /**
+   * QRCodeDetectorAruco constructor with parameters
+   *
+   * @param params QRCodeDetectorAruco parameters
+   */
+  public constructor(params: QRCodeDetectorAruco_Params);
+
+  /**
+   * Detects QR code in image and returns the quadrangle containing the code.
+   *
+   * @param img grayscale or color (BGR) image containing (or not) QR code.
+   * @param points Output vector of vertices of the minimum-area quadrangle containing the code.
+   */
+  public detect(img: InputArray, points: OutputArray): bool;
+
+  /**
+   * Decodes QR code in image once it's found by the detect() method.
+   *
+   * @param img grayscale or color (BGR) image containing QR code.
+   * @param points Quadrangle vertices found by detect() method (or some other algorithm).
+   * @param straight_qrcode The optional output image containing rectified and binarized QR code
+   */
+  public decode(
+    img: InputArray,
+    points: InputArray,
+    straight_qrcode?: OutputArray,
+  ): String;
+
+  /**
+   * Both detects and decodes QR code
+   *
+   * @param img grayscale or color (BGR) image containing QR code.
+   * @param points optional output array of vertices of the found QR code quadrangle. Will be empty if not found.
+   * @param straight_qrcode The optional output image containing rectified and binarized QR code
+   */
+  public detectAndDecode(
+    img: InputArray,
+    points?: OutputArray,
+    straight_qrcode?: OutputArray,
+  ): String;
+
+  /**
+   * Detects QR codes in image and returns the vector of the quadrangles containing the codes.
+   *
+   * @param img grayscale or color (BGR) image containing (or not) QR codes.
+   * @param points Output vector of vector of vertices of the minimum-area quadrangle containing the codes.
+   */
+  public detectMulti(img: InputArray, points: OutputArrayOfArrays): bool;
+
+  /**
+   * Decodes QR codes in image once it's found by the detectMulti() method.
+   *
+   * @param img grayscale or color (BGR) image containing QR codes.
+   * @param points vector of Quadrangle vertices found by detectMulti() method (or some other algorithm).
+   * @param decoded_info UTF8-encoded output vector of String or empty vector of String if the codes cannot be decoded.
+   * @param straight_qrcode The optional output vector of images containing rectified and binarized QR codes
+   */
+  public decodeMulti(
+    img: InputArray,
+    points: InputArray,
+    decoded_info: any,
+    straight_qrcode?: OutputArrayOfArrays,
+  ): bool;
+
+  /**
+   * Both detects and decodes QR codes
+   *
+   * @param img grayscale or color (BGR) image containing QR codes.
+   * @param decoded_info UTF8-encoded output vector of String or empty vector of String if the codes cannot be decoded.
+   * @param points optional output vector of vertices of the found QR code quadrangles. Will be empty if not found.
+   * @param straight_qrcode The optional output vector of images containing rectified and binarized QR codes
+   */
+  public detectAndDecodeMulti(
+    img: InputArray,
+    decoded_info: any,
+    points?: OutputArrayOfArrays,
+    straight_qrcode?: OutputArrayOfArrays,
+  ): bool;
+
+  /**
+   * Get detector parameters
+   */
+  public getDetectorParameters(): QRCodeDetectorAruco_Params;
+
+  /**
+   * Set detector parameters
+   *
+   * @param params QRCodeDetectorAruco parameters
+   */
+  public setDetectorParameters(params: QRCodeDetectorAruco_Params): void;
+
+  /**
+   * Releases the object
+   */
+  public delete(): void;
+}

package/src/types/opencv/RotatedRect.ts

@@ -58,15 +58,14 @@ export declare class RotatedRect {
    */
   public constructor(point1: Point2f, point2: Point2f, point3: Point2f);
 
-  public boundingRect(): Rect;
+  public static boundingRect(rect: RotatedRect): Rect;
 
-  public boundingRect2f(): Rect_;
+  public static boundingRect2f(rect: RotatedRect): Rect;
 
   /**
-   *   returns 4 vertices of the rectangle
-   *
-   * @param pts The points array for storing rectangle vertices. The order is bottomLeft, topLeft,
-   * topRight, bottomRight.
+    returns 4 vertices of the rectangle
+   * @param rect The rotated rectangle
+   * @returns Array of 4 points in order: bottomLeft, topLeft, topRight, bottomRight
    */
-  public points(pts: Point2f): Point2f;
+  public static points(rect: RotatedRect): Point2f[];
 }

package/src/types/opencv/_hacks.ts

@@ -84,12 +84,12 @@ export declare class MinMaxLoc {
 export declare function exceptionFromPtr(err: number): any;
 export declare function onRuntimeInitialized(): any;
 export declare function FS_createDataFile(
-  arg0: string,
-  path: string,
+  parent: string,
+  name: string,
   data: Uint8Array,
-  arg3: boolean,
-  arg4: boolean,
-  arg5: boolean,
+  canRead: boolean,
+  canWrite: boolean,
+  canOwn: boolean,
 ): any;
 
 import { Algorithm, type LineTypes, Mat, type NormTypes, RotatedRect } from ".";

package/src/types/opencv/_types.ts

@@ -19,6 +19,7 @@ export * from "./fisheye";
 export * from "./FlannBasedMatcher";
 export * from "./HOGDescriptor";
 export * from "./imgproc_color_conversions";
+export * from "./imgproc_colormap";
 export * from "./imgproc_draw";
 export * from "./imgproc_feature";
 export * from "./imgproc_filter";

package/src/types/opencv/imgproc_colormap.ts

@@ -0,0 +1,60 @@
+import type { InputArray, int, OutputArray } from "./_types";
+
+/*
+ * # Colormap Transformations
+ *
+ */
+
+/**
+ * Applies a colormap on a given image.
+ *
+ * @param src The source image, which should be grayscale. Should be 8-bit, 16-bit, or floating-point.
+ * @param dst The result is the colored image.
+ * @param colormap The colormap to apply.
+ */
+export declare function applyColorMap(
+  src: InputArray,
+  dst: OutputArray,
+  colormap: int,
+): void;
+
+/**
+ * Applies a user colormap on a given image.
+ *
+ * @param src The source image, which should be grayscale. Should be 8-bit, 16-bit, or floating-point.
+ * @param dst The result is the colored image.
+ * @param userColor The colormap to apply of type CV_8UC1 or CV_8UC3 and size 256.
+ */
+export declare function applyColorMap(
+  src: InputArray,
+  dst: OutputArray,
+  userColor: InputArray,
+): void;
+
+/**
+ * Colormap types used by the applyColorMap function.
+ */
+export type ColormapTypes = any;
+
+export declare const COLORMAP_AUTUMN: ColormapTypes; // initializer: = 0
+export declare const COLORMAP_BONE: ColormapTypes; // initializer: = 1
+export declare const COLORMAP_JET: ColormapTypes; // initializer: = 2
+export declare const COLORMAP_WINTER: ColormapTypes; // initializer: = 3
+export declare const COLORMAP_RAINBOW: ColormapTypes; // initializer: = 4
+export declare const COLORMAP_OCEAN: ColormapTypes; // initializer: = 5
+export declare const COLORMAP_SUMMER: ColormapTypes; // initializer: = 6
+export declare const COLORMAP_SPRING: ColormapTypes; // initializer: = 7
+export declare const COLORMAP_COOL: ColormapTypes; // initializer: = 8
+export declare const COLORMAP_HSV: ColormapTypes; // initializer: = 9
+export declare const COLORMAP_PINK: ColormapTypes; // initializer: = 10
+export declare const COLORMAP_HOT: ColormapTypes; // initializer: = 11
+export declare const COLORMAP_PARULA: ColormapTypes; // initializer: = 12
+export declare const COLORMAP_MAGMA: ColormapTypes; // initializer: = 13
+export declare const COLORMAP_INFERNO: ColormapTypes; // initializer: = 14
+export declare const COLORMAP_PLASMA: ColormapTypes; // initializer: = 15
+export declare const COLORMAP_VIRIDIS: ColormapTypes; // initializer: = 16
+export declare const COLORMAP_CIVIDIS: ColormapTypes; // initializer: = 17
+export declare const COLORMAP_TWILIGHT: ColormapTypes; // initializer: = 18
+export declare const COLORMAP_TWILIGHT_SHIFTED: ColormapTypes; // initializer: = 19
+export declare const COLORMAP_TURBO: ColormapTypes; // initializer: = 20
+export declare const COLORMAP_DEEPGREEN: ColormapTypes; // initializer: = 21

package/src/types/opencv/imgproc_shape.ts

@@ -65,9 +65,9 @@ export declare function boundingRect(array: InputArray): Rect;
  *
  * @param box The input rotated rectangle. It may be the output of
  *
- * @param points The output array of four vertices of rectangles.
+ * @returns An array of four vertices of the rectangle (Point2f[])
  */
-export declare function boxPoints(box: RotatedRect, points: OutputArray): void;
+export declare function boxPoints(box: RotatedRect): Point2f[];
 
 /**
  * image with 4 or 8 way connectivity - returns N, the total number of labels [0, N-1] where 0
@@ -533,9 +533,7 @@ export declare function minAreaRect(points: InputArray): RotatedRect;
  *
  * @param points Input vector of 2D points, stored in std::vector<> or Mat
  */
-export declare function minEnclosingCircle(
-  points: InputArray,
-): Circle;
+export declare function minEnclosingCircle(points: InputArray): Circle;
 
 /**
  * The function finds a triangle of minimum area enclosing the given set of 2D points and returns its

package/src/types/opencv/objdetect.ts

@@ -101,3 +101,9 @@ export declare const CASCADE_SCALE_IMAGE: any; // initializer: = 2
 export declare const CASCADE_FIND_BIGGEST_OBJECT: any; // initializer: = 4
 
 export declare const CASCADE_DO_ROUGH_SEARCH: any; // initializer: = 8
+
+export { QRCodeDetector } from "./QRCodeDetector";
+export {
+  QRCodeDetectorAruco,
+  QRCodeDetectorAruco_Params,
+} from "./QRCodeDetectorAruco";