@opencvjs/types 4.10.0-release.1

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,23 @@
+# @opencvjs/types
+
+This package contains the TypeScript definitions for the [OpenCV.js](https://docs.opencv.org/4.x/d0/d84/tutorial_js_usage.html) library.
+
+## Installation
+
+```bash
+npm install @opencvjs/types
+```
+
+## Usage
+
+```ts
+import type { OpenCV } from "@opencvjs/types";
+```
+
+## Credits
+
+The definitions are based on the [@techstark/opencv-js](https://github.com/TechStark/opencv-js) and [mirada](https://github.com/cancerberoSgx/mirada) projects.
+
+## License
+
+Apache-2.0

package/lib/index.d.ts

@@ -0,0 +1,2 @@
+import type * as OpenCV from "./opencv/_types";
+export type { OpenCV };

package/lib/opencv/Affine3.d.ts

@@ -0,0 +1,206 @@
+import type { float_type, int, Mat, Mat3, Mat4, Vec3 } from "./_types";
+
+/**
+ * It represents a 4x4 homogeneous transformation matrix `$T$`
+ *
+ * `\\[T = \\begin{bmatrix} R & t\\\\ 0 & 1\\\\ \\end{bmatrix} \\]`
+ *
+ * where `$R$` is a 3x3 rotation matrix and `$t$` is a 3x1 translation vector.
+ *
+ * You can specify `$R$` either by a 3x3 rotation matrix or by a 3x1 rotation vector, which is
+ * converted to a 3x3 rotation matrix by the Rodrigues formula.
+ *
+ * To construct a matrix `$T$` representing first rotation around the axis `$r$` with rotation angle
+ * `$|r|$` in radian (right hand rule) and then translation by the vector `$t$`, you can use
+ *
+ * ```cpp
+ * cv::Vec3f r, t;
+ * cv::Affine3f T(r, t);
+ * ```
+ *
+ * If you already have the rotation matrix `$R$`, then you can use
+ *
+ * ```cpp
+ * cv::Matx33f R;
+ * cv::Affine3f T(R, t);
+ * ```
+ *
+ * To extract the rotation matrix `$R$` from `$T$`, use
+ *
+ * ```cpp
+ * cv::Matx33f R = T.rotation();
+ * ```
+ *
+ * To extract the translation vector `$t$` from `$T$`, use
+ *
+ * ```cpp
+ * cv::Vec3f t = T.translation();
+ * ```
+ *
+ * To extract the rotation vector `$r$` from `$T$`, use
+ *
+ * ```cpp
+ * cv::Vec3f r = T.rvec();
+ * ```
+ *
+ * Note that since the mapping from rotation vectors to rotation matrices is many to one. The returned
+ * rotation vector is not necessarily the one you used before to set the matrix.
+ *
+ * If you have two transformations `$T = T_1 * T_2$`, use
+ *
+ * ```cpp
+ * cv::Affine3f T, T1, T2;
+ * T = T2.concatenate(T1);
+ * ```
+ *
+ * To get the inverse transform of `$T$`, use
+ *
+ * ```cpp
+ * cv::Affine3f T, T_inv;
+ * T_inv = T.inv();
+ * ```
+ *
+ * Source:
+ * [opencv2/core/affine.hpp](https://github.com/opencv/opencv/tree/master/modules/core/include/opencv2/core/affine.hpp#L129).
+ *
+ */
+export declare class Affine3 {
+  public matrix: Mat4;
+
+  public constructor();
+
+  public constructor(affine: Mat4);
+
+  /**
+   *   The resulting 4x4 matrix is
+   *
+   *   `\\[ \\begin{bmatrix} R & t\\\\ 0 & 1\\\\ \\end{bmatrix} \\]`
+   *
+   * @param R 3x3 rotation matrix.
+   *
+   * @param t 3x1 translation vector.
+   */
+  public constructor(R: Mat3, t?: Vec3);
+
+  /**
+   *   Rodrigues vector.
+   *
+   *   The last row of the current matrix is set to [0,0,0,1].
+   *
+   * @param rvec 3x1 rotation vector. Its direction indicates the rotation axis and its length
+   * indicates the rotation angle in radian (using right hand rule).
+   *
+   * @param t 3x1 translation vector.
+   */
+  public constructor(rvec: Vec3, t?: Vec3);
+
+  /**
+   *   Combines all constructors above. Supports 4x4, 3x4, 3x3, 1x3, 3x1 sizes of data matrix.
+   *
+   *   The last row of the current matrix is set to [0,0,0,1] when data is not 4x4.
+   *
+   * @param data 1-channel matrix. when it is 4x4, it is copied to the current matrix and t is not
+   * used. When it is 3x4, it is copied to the upper part 3x4 of the current matrix and t is not used.
+   * When it is 3x3, it is copied to the upper left 3x3 part of the current matrix. When it is 3x1 or
+   * 1x3, it is treated as a rotation vector and the Rodrigues formula is used to compute a 3x3 rotation
+   * matrix.
+   *
+   * @param t 3x1 translation vector. It is used only when data is neither 4x4 nor 3x4.
+   */
+  public constructor(data: Mat, t?: Vec3);
+
+  public constructor(vals: float_type);
+
+  public cast(arg401: any): Affine3;
+
+  public concatenate(affine: Affine3): Affine3;
+
+  /**
+   *   the inverse of the current matrix.
+   */
+  public inv(method?: int): Affine3;
+
+  /**
+   *   Copy the 3x3 matrix L to the upper left part of the current matrix
+   *
+   *   It sets the upper left 3x3 part of the matrix. The remaining part is unaffected.
+   *
+   * @param L 3x3 matrix.
+   */
+  public linear(L: Mat3): Mat3;
+
+  /**
+   *   the upper left 3x3 part
+   */
+  public linear(): Mat3;
+
+  public rotate(R: Mat3): Affine3;
+
+  public rotate(rvec: Vec3): Affine3;
+
+  /**
+   *   Rotation matrix.
+   *
+   *   Copy the rotation matrix to the upper left 3x3 part of the current matrix. The remaining elements
+   * of the current matrix are not changed.
+   *
+   * @param R 3x3 rotation matrix.
+   */
+  public rotation(R: Mat3): Mat3;
+
+  /**
+   *   Rodrigues vector.
+   *
+   *   It sets the upper left 3x3 part of the matrix. The remaining part is unaffected.
+   *
+   * @param rvec 3x1 rotation vector. The direction indicates the rotation axis and its length
+   * indicates the rotation angle in radian (using the right thumb convention).
+   */
+  public rotation(rvec: Vec3): Vec3;
+
+  /**
+   *   Combines rotation methods above. Supports 3x3, 1x3, 3x1 sizes of data matrix.
+   *
+   *   It sets the upper left 3x3 part of the matrix. The remaining part is unaffected.
+   *
+   * @param data 1-channel matrix. When it is a 3x3 matrix, it sets the upper left 3x3 part of the
+   * current matrix. When it is a 1x3 or 3x1 matrix, it is used as a rotation vector. The Rodrigues
+   * formula is used to compute the rotation matrix and sets the upper left 3x3 part of the current
+   * matrix.
+   */
+  public rotation(data: Mat): Mat;
+
+  /**
+   *   the upper left 3x3 part
+   */
+  public rotation(): Mat3;
+
+  /**
+   *   Rodrigues vector.
+   *
+   *   a vector representing the upper left 3x3 rotation matrix of the current matrix.
+   *
+   *   Since the mapping between rotation vectors and rotation matrices is many to one, this function
+   * returns only one rotation vector that represents the current rotation matrix, which is not
+   * necessarily the same one set by `[rotation(const Vec3& rvec)]`.
+   */
+  public rvec(): Vec3;
+
+  public translate(t: Vec3): Affine3;
+
+  /**
+   *   Copy t to the first three elements of the last column of the current matrix
+   *
+   *   It sets the upper right 3x1 part of the matrix. The remaining part is unaffected.
+   *
+   * @param t 3x1 translation vector.
+   */
+  public translation(t: Vec3): Vec3;
+
+  /**
+   *   the upper right 3x1 part
+   */
+  public translation(): Vec3;
+
+  public static Identity(): Affine3;
+}

package/lib/opencv/Algorithm.d.ts

@@ -0,0 +1,126 @@
+import type {
+  bool,
+  EmscriptenEmbindInstance,
+  FileNode,
+  FileStorage,
+  Ptr,
+} from "./_types";
+
+/**
+ * especially for classes of algorithms, for which there can be multiple implementations. The examples
+ * are stereo correspondence (for which there are algorithms like block matching, semi-global block
+ * matching, graph-cut etc.), background subtraction (which can be done using mixture-of-gaussians
+ * models, codebook-based algorithm etc.), optical flow (block matching, Lucas-Kanade, Horn-Schunck
+ * etc.).
+ *
+ * Here is example of [SimpleBlobDetector](#d0/d7a/classcv_1_1SimpleBlobDetector}) use in your
+ * application via [Algorithm](#d3/d46/classcv_1_1Algorithm}) interface:
+ *
+ * ```cpp
+ *     Ptr<Feature2D> sbd = SimpleBlobDetector::create();
+ *     FileStorage fs_read("SimpleBlobDetector_params.xml", FileStorage::READ);
+ *
+ *     if (fs_read.isOpened()) // if we have file with parameters, read them
+ *     {
+ *         sbd->read(fs_read.root());
+ *         fs_read.release();
+ *     }
+ *     else // else modify the parameters and store them; user can later edit the file to use different
+ * parameters
+ *     {
+ *         fs_read.release();
+ *         FileStorage fs_write("SimpleBlobDetector_params.xml", FileStorage::WRITE);
+ *         sbd->write(fs_write);
+ *         fs_write.release();
+ *     }
+ *
+ *     Mat result, image = imread("../data/detect_blob.png", IMREAD_COLOR);
+ *     vector<KeyPoint> keypoints;
+ *     sbd->detect(image, keypoints, Mat());
+ *
+ *     drawKeypoints(image, keypoints, result);
+ *     for (vector<KeyPoint>::iterator k = keypoints.begin(); k != keypoints.end(); ++k)
+ *         circle(result, k->pt, (int)k->size, Scalar(0, 0, 255), 2);
+ *
+ *     imshow("result", result);
+ *     waitKey(0);
+ * ```
+ *
+ * Source:
+ * [opencv2/core.hpp](https://github.com/opencv/opencv/tree/master/modules/core/include/opencv2/core.hpp#L3077).
+ *
+ */
+export declare class Algorithm extends EmscriptenEmbindInstance {
+  public constructor();
+
+  public clear(): void;
+
+  public empty(): bool;
+
+  /**
+   *   Returns the algorithm string identifier. This string is used as top level xml/yml node tag when
+   * the object is saved to a file or string.
+   */
+  public getDefaultName(): String;
+
+  public read(fn: FileNode): FileNode;
+
+  /**
+   *   Saves the algorithm to a file. In order to make this method work, the derived class must implement
+   * Algorithm::write(FileStorage& fs).
+   */
+  public save(filename: String): String;
+
+  public write(fs: FileStorage): FileStorage;
+
+  public write(fs: Ptr, name?: String): Ptr;
+
+  /**
+   *   This is static template method of [Algorithm]. It's usage is following (in the case of SVM):
+   *
+   *   ```cpp
+   *   Ptr<SVM> svm = Algorithm::load<SVM>("my_svm_model.xml");
+   *   ```
+   *
+   *    In order to make this method work, the derived class must overwrite [Algorithm::read](const
+   * [FileNode]& fn).
+   *
+   * @param filename Name of the file to read.
+   *
+   * @param objname The optional name of the node to read (if empty, the first top-level node will be
+   * used)
+   */
+  public static load(arg0: any, filename: String, objname?: String): Ptr;
+
+  /**
+   *   This is static template method of [Algorithm]. It's usage is following (in the case of SVM):
+   *
+   *   ```cpp
+   *   Ptr<SVM> svm = Algorithm::loadFromString<SVM>(myStringModel);
+   *   ```
+   *
+   * @param strModel The string variable containing the model you want to load.
+   *
+   * @param objname The optional name of the node to read (if empty, the first top-level node will be
+   * used)
+   */
+  public static loadFromString(
+    arg1: any,
+    strModel: String,
+    objname?: String,
+  ): Ptr;
+
+  /**
+   *   This is static template method of [Algorithm]. It's usage is following (in the case of SVM):
+   *
+   *   ```cpp
+   *   cv::FileStorage fsRead("example.xml", FileStorage::READ);
+   *   Ptr<SVM> svm = Algorithm::read<SVM>(fsRead.root());
+   *   ```
+   *
+   *    In order to make this method work, the derived class must overwrite [Algorithm::read](const
+   * [FileNode]& fn) and also have static create() method without parameters (or with all the optional
+   * parameters)
+   */
+  public static read(arg2: any, fn: FileNode): Ptr;
+}

package/lib/opencv/AutoBuffer.d.ts

@@ -0,0 +1,50 @@
+import type { size_t } from "./_types";
+
+/**
+ * The class is used for temporary buffers in functions and methods. If a temporary buffer is usually
+ * small (a few K's of memory), but its size depends on the parameters, it makes sense to create a
+ * small fixed-size array on stack and use it if it's large enough. If the required buffer size is
+ * larger than the fixed size, another buffer of sufficient size is allocated dynamically and released
+ * after the processing. Therefore, in typical cases, when the buffer size is small, there is no
+ * overhead associated with malloc()/free(). At the same time, there is no limit on the size of
+ * processed data.
+ *
+ * This is what [AutoBuffer](#d8/dd0/classcv_1_1AutoBuffer}) does. The template takes 2 parameters -
+ * type of the buffer elements and the number of stack-allocated elements. Here is how the class is
+ * used:
+ *
+ * ```cpp
+ * void my_func(const cv::Mat& m)
+ * {
+ *    cv::AutoBuffer<float> buf(1000); // create automatic buffer containing 1000 floats
+ *
+ *    buf.allocate(m.rows); // if m.rows <= 1000, the pre-allocated buffer is used,
+ *                          // otherwise the buffer of "m.rows" floats will be allocated
+ *                          // dynamically and deallocated in cv::AutoBuffer destructor
+ *    ...
+ * }
+ * ```
+ *
+ * Source:
+ * [opencv2/core/utility.hpp](https://github.com/opencv/opencv/tree/master/modules/core/include/opencv2/core/utility.hpp#L128).
+ *
+ */
+export declare class AutoBuffer {
+  public constructor();
+
+  public constructor(_size: size_t);
+
+  public constructor(buf: AutoBuffer);
+
+  public allocate(_size: size_t): void;
+
+  public data(): any;
+
+  public data(): any;
+
+  public deallocate(): void;
+
+  public resize(_size: size_t): void;
+
+  public size(): size_t;
+}

package/lib/opencv/BFMatcher.d.ts

@@ -0,0 +1,37 @@
+import type { bool, DescriptorMatcher, int, Ptr } from "./_types";
+
+/**
+ * For each descriptor in the first set, this matcher finds the closest descriptor in the second set by
+ * trying each one. This descriptor matcher supports masking permissible matches of descriptor sets.
+ *
+ * Source:
+ * [opencv2/features2d.hpp](https://github.com/opencv/opencv/tree/master/modules/core/include/opencv2/features2d.hpp#L1140).
+ *
+ */
+export declare class BFMatcher extends DescriptorMatcher {
+  public constructor(normType?: int, crossCheck?: bool);
+
+  /**
+   * @param emptyTrainData If emptyTrainData is false, the method creates a deep copy of the object,
+   * that is, copies both parameters and train data. If emptyTrainData is true, the method creates an
+   * object copy with the current parameters but with empty train data.
+   */
+  public clone(emptyTrainData?: bool): Ptr;
+
+  public isMaskSupported(): bool;
+
+  /**
+   * @param normType One of NORM_L1, NORM_L2, NORM_HAMMING, NORM_HAMMING2. L1 and L2 norms are
+   * preferable choices for SIFT and SURF descriptors, NORM_HAMMING should be used with ORB, BRISK and
+   * BRIEF, NORM_HAMMING2 should be used with ORB when WTA_K==3 or 4 (see ORB::ORB constructor
+   * description).
+   *
+   * @param crossCheck If it is false, this is will be default BFMatcher behaviour when it finds the k
+   * nearest neighbors for each query descriptor. If crossCheck==true, then the knnMatch() method with
+   * k=1 will only return pairs (i,j) such that for i-th query descriptor the j-th descriptor in the
+   * matcher's collection is the nearest and vice versa, i.e. the BFMatcher will only return consistent
+   * pairs. Such technique usually produces best results with minimal number of outliers when there are
+   * enough matches. This is alternative to the ratio test, used by D. Lowe in SIFT paper.
+   */
+  public static create(normType?: int, crossCheck?: bool): Ptr;
+}