RecognitionRejection Property

Applies to TestComplete 15.70, last modified on December 17, 2024
This property is provided by the legacy OCR plugin. In version 12.60, the plugin was replaced with the new Optical Character Recognition plugin powered by Google Cloud Vision API. To learn more, see Optical Character Recognition.
The legacy OCR plugin was removed from TestComplete in version 12.60. If you need to use objects, methods, and properties provided by the legacy plugin with this version of TestComplete, please contact our Customer Care team. The legacy OCR plugin was restored in TestComplete version 14.0. To use the objects, methods, and properties with this or later TestComplete version, you need to install and enable the plugin manually.

Description

The OCROptions.RecognitionRejection property lets you specify the threshold used to decide if the recognition of a character fails or not. To learn more about the character recognition threshold, see Optical Character Recognition. The value set in this property takes effect only if the OCROptions.RecognitionRejectionAuto property is False.

Declaration

OCROptionsObj.RecognitionRejection

Read-Write Property Real
OCROptionsObj An expression, variable or parameter that specifies a reference to an OCROptions object

Applies To

The property is applied to the following object:

Property Value

A real value from 0.0 to 1.0 that denotes the character recognition threshold.

Example

The following example sets the custom character recognition threshold value to 0.5 and recognizes characters written in Windows Notepad by using the specified recognition threshold. After that, it posts the recognized characters to the test log.

JavaScript, JScript

function OCROptionsSample()
{
  var notepad, Window, Rect, OCRObj, OCROptions;
  // Obtains the Notepad window
  notepad = Sys.Process("notepad");
  Window = notepad.Window("Notepad", "*").Window("Edit");
  // Captures an image of the Notepad window
  Rect = Window.Picture();
  Log.Picture(Rect, "Region with the text to be recognized");

  // Creates an OCR object
  OCRObj = OCR.CreateObject(Rect);
  // Creates an OCRoptions object
  OCROptions = OCRObj.CreateOptions();

  // Specifies that the custom character recognition threshold will be used
  OCROptions.RecognitionRejectionAuto = false;
  // Sets the custom character recognition threshold value
  OCROptions.RecognitionRejection = 0.5;
  // Recognizes the text and posts it to the test log

  Log.Message("Recognized characters:", OCRObj.GetText(OCROptions));
}

Python

def OCROptionsSample():
  # Obtains the Notepad window
  notepad = Sys.Process("notepad")
  Window = notepad.Window("Notepad", "*").Window("Edit")
  # Captures an image of the Notepad window
  Rect = Window.Picture()
  Log.Picture(Rect, "Region with the text to be recognized")
  # Creates an OCR object
  OCRObj = OCR.CreateObject(Rect)
  # Creates an OCRoptions object
  OCROptions = OCRObj.CreateOptions()
  # Specifies that the custom character recognition threshold will be used
  OCROptions.RecognitionRejectionAuto = False
  # Sets the custom character recognition threshold value
  OCROptions.RecognitionRejection = 0.5
  # Recognizes the text and posts it to the test log
  Log.Message("Recognized characters:", OCRObj.GetText(OCROptions))

VBScript

Sub OCROptionsSample

  ' Obtains the Notepad window
  Set notepad = Sys.Process("notepad")
  Set Window = notepad.Window("Notepad", "*").Window("Edit")
  ' Captures an image of the Notepad window
  Set Rect = Window.Picture
  Call Log.Picture(Rect, "Region with the text to be recognized")

  ' Creates an OCR object
  Set OCRObj = OCR.CreateObject(Rect)
  ' Creates an OCRoptions object
  Set OCROptions = OCRobj.CreateOptions

  ' Specifies that the custom character recognition threshold will be used
  OCROptions.RecognitionRejectionAuto = False
  ' Sets the custom character recognition threshold value
  OCROptions.RecognitionRejection = 0.5
  ' Recognizes the text and posts it to the test log

  Call Log.Message("Recognized characters:", OCRObj.GetText(OCROptions))
End Sub

DelphiScript

procedure OCROptionsSample();
var notepad, Window, Rect, OCRObj, OCROptions : OleVariant;
begin
  // Obtains the Notepad window
  notepad := Sys.Process('notepad');
  Window := notepad.Window('Notepad', '*').Window('Edit');
  // Captures an image of the Notepad window
  Rect := Window.Picture;
  Log.Picture(Rect, 'Region with the text to be recognized');

  // Creates an OCR object
  OCRObj := OCR.CreateObject(Rect);
  // Creates an OCRoptions object
  OCROptions := OCRObj.CreateOptions;

  // Specifies that the custom character recognition threshold will be used
  OCROptions.RecognitionRejectionAuto := false;
  // Sets the custom character recognition threshold value
  OCROptions.RecognitionRejection := 0.5;
  // Recognizes the text and posts it to the test log

  Log.Message('Recognized characters:', OCRObj.GetText(OCROptions));
end;

C++Script, C#Script

function OCROptionsSample()
{
  var notepad, Window, Rect, OCRObj, OCROptions;
  // Obtains the Notepad window
  notepad = Sys["Process"]("notepad");
  Window = notepad["Window"]("Notepad", "*")["Window"]("Edit");
  // Captures an image of the Notepad window
  Rect = Window["Picture"]();
  Log["Picture"](Rect, "Region with the text to be recognized");

  // Creates an OCR object
  OCRObj = OCR["CreateObject"](Rect);
  // Creates an OCRoptions object
  OCROptions = OCRObj["CreateOptions"]();

  // Specifies that the custom character recognition threshold will be used
  OCROptions["RecognitionRejectionAuto"] = false;
  // Sets the custom character recognition threshold value
  OCROptions["RecognitionRejection"] = 0.5;
  // Recognizes the text and posts it to the test log

  Log["Message"]("Recognized characters:", OCRObj["GetText"](OCROptions));
}

See Also

OCROptions.RecognitionRejectionAuto
Optical Character Recognition
Using Optical Character Recognition - Tips

Highlight search results