Add notes about the limitations of the current orientation detection …

…method
robertknight · Jun 5, 2022 · 26893cc · 26893cc
1 parent ebd135c
commit 26893cc
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 0 deletions.
diff --git a/src/ocr-client.js b/src/ocr-client.js
@@ -207,6 +207,12 @@ export class OCRClient {
   /**
    * Attempt to determine the orientation of the image.
    *
+   * This currently uses a simplistic algorithm [1] which is designed for
+   * non-uppercase Latin text. It will likely perform badly for other scripts or
+   * if the text is all uppercase.
+   *
+   * [1] See http://www.leptonica.org/papers/skew-measurement.pdf
+   *
    * @return {Promise<Orientation>}
    */
   async getOrientation() {

diff --git a/src/ocr-engine.js b/src/ocr-engine.js
@@ -252,6 +252,12 @@ class OCREngine {
   /**
    * Attempt to determine the orientation of the document image in degrees.
    *
+   * This currently uses a simplistic algorithm [1] which is designed for
+   * non-uppercase Latin text. It will likely perform badly for other scripts or
+   * if the text is all uppercase.
+   *
+   * [1] See http://www.leptonica.org/papers/skew-measurement.pdf
+   *
    * @return {Orientation}
    */
   getOrientation() {