Mark parameter 'tessedit_do_invert' as deprecated

Signed-off-by: Stefan Weil <[email protected]>
tesseract-ocr · Jun 26, 2022 · b8b6c15 · b8b6c15
1 parent 96861b5
commit b8b6c15
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 1 deletion.
diff --git a/src/ccmain/tesseractclass.cpp b/src/ccmain/tesseractclass.cpp
@@ -63,7 +63,10 @@ Tesseract::Tesseract()
                   "Break input into lines and remap boxes if present", this->params())
     , BOOL_MEMBER(tessedit_dump_pageseg_images, false,
                   "Dump intermediate images made during page segmentation", this->params())
-    , BOOL_MEMBER(tessedit_do_invert, true, "Try inverted line image if necessary",
+    // TODO: remove deprecated tessedit_do_invert in release 6.
+    , BOOL_MEMBER(tessedit_do_invert, true,
+                  "Try inverted line image if necessary (deprecated, will be "
+                  "removed in release 6, use the 'invert_threshold' parameter instead)",
                   this->params())
     , double_MEMBER(invert_threshold, 0.7,
                     "For lines with a mean confidence below this value, OCR is also tried with an inverted image",

diff --git a/src/ccmain/tesseractclass.h b/src/ccmain/tesseractclass.h
@@ -755,6 +755,7 @@ class TESS_API Tesseract : public Wordrec {
   BOOL_VAR_H(tessedit_make_boxes_from_boxes);
   BOOL_VAR_H(tessedit_train_line_recognizer);
   BOOL_VAR_H(tessedit_dump_pageseg_images);
+  // TODO: remove deprecated tessedit_do_invert in release 6.
   BOOL_VAR_H(tessedit_do_invert);
   double_VAR_H(invert_threshold);
   INT_VAR_H(tessedit_pageseg_mode);