GdPicture.NET.14.API
GdPicture14 Namespace / GdPictureOCR Class / RunOCR Method / RunOCR() Method
Example





In This Topic
RunOCR() Method
In This Topic
Runs the OCR on the image previously set by the GdPictureOCR.SetImage method and using the available parameters you have previously specified within the current GdPictureOCR object. The result of this process, identifiable by its unique ID, is internally attached to the current GdPictureOCR object as well.

Please note, that the accuracy and the speed depend on the selected OCR mode (balance between speed and accuracy).

Syntax
'Declaration
 
Public Overloads Function RunOCR() As String
public string RunOCR()
public function RunOCR(): String; 
public function RunOCR() : String;
public: string* RunOCR(); 
public:
String^ RunOCR(); 

Return Value

A unique result identifier of the executed OCR process. Please always use the GdPictureOCR.GetStat method to determine if this method has been successful.
Remarks
It is recommend to use the GdPictureOCR.GetStat method to identify the specific reason for the method's failure, if any.

Please ensure that you have set all required parameters, first of all the image, before you start the new OCR process. This method uses the GdPictureImage object previously set by the GdPictureOCR.SetImage method. Setting up an image is a mandatory step before running any OCR process.

Just to inform you, that releasing already used OCR results by the GdPictureOCR.ReleaseOCRResults method can improve the memory management if you run more OCR processes in a row.

Example
How to run more OCR processes on the same image with different settings.
Dim caption As String = "Example: RunOCR"
Using gdpictureOCR As GdPictureOCR = New GdPictureOCR()
    'Set up your prefered parameters for OCR.
    gdpictureOCR.ResourcesFolder = "\GdPicture.Net 14\redist\OCR"
    If gdpictureOCR.AddLanguage(OCRLanguage.English) = GdPictureStatus.OK Then
        'Set up the image you want to process.
        Dim gdpictureImaging As GdPictureImaging = New GdPictureImaging()
        'Display the standard open file dialog to allow you to select the file.
        Dim image As Integer = gdpictureImaging.CreateGdPictureImageFromFile("")
        If (gdpictureImaging.GetStat() = GdPictureStatus.OK) AndAlso
           (gdpictureOCR.SetImage(image) = GdPictureStatus.OK) Then
            'Run the first OCR process.
            'Note that gdpictureOCR.OCRMode = OCRMode.FavorSpeed by default.
            Dim result1 As String = gdpictureOCR.RunOCR()
            If gdpictureOCR.GetStat() = GdPictureStatus.OK Then
                'Save the result.
                If gdpictureOCR.SaveAsText(result1, "OCR_result1.txt", OCROutputTextFormat.Utf16, True) = GdPictureStatus.OK Then
                    MessageBox.Show("The OCR result has been successfully saved.", caption)
                Else
                    MessageBox.Show("The SaveAsText() method has failed with the status: " + gdpictureOCR.GetStat().ToString(), caption)
                End If
            Else
                MessageBox.Show("The OCR process has failed with the status: " + gdpictureOCR.GetStat().ToString(), caption)
            End If
 
            'Change OCR settings.
            gdpictureOCR.OCRMode = OCRMode.FavorAccuracy
 
            'Run the second OCR process.
            Dim result2 As String = gdpictureOCR.RunOCR()
            If gdpictureOCR.GetStat() = GdPictureStatus.OK Then
                'Save the result.
                If gdpictureOCR.SaveAsText(result2, "OCR_result2.txt", OCROutputTextFormat.Utf16, True) = GdPictureStatus.OK Then
                    MessageBox.Show("The OCR result has been successfully saved.", caption)
                Else
                    MessageBox.Show("The SaveAsText() method has failed with the status: " + gdpictureOCR.GetStat().ToString(), caption)
                End If
            Else
                MessageBox.Show("The OCR process has failed with the status: " + gdpictureOCR.GetStat().ToString(), caption)
            End If
 
            'Release the used image.
            gdpictureImaging.ReleaseGdPictureImage(image)
        Else
            MessageBox.Show("The error occurred when setting up the image: " + gdpictureImaging.GetStat().ToString() + " or " + gdpictureOCR.GetStat().ToString(), caption)
        End If
        gdpictureImaging.Dispose()
    Else
        MessageBox.Show("The AddLanguage() method has failed with the status: " + gdpictureOCR.GetStat().ToString(), caption)
    End If
    gdpictureOCR.ReleaseOCRResults()
End Using
string caption = "Example: RunOCR";
using (GdPictureOCR gdpictureOCR = new GdPictureOCR())
{
    //Set up your prefered parameters for OCR.
    gdpictureOCR.ResourcesFolder = "\\GdPicture.Net 14\\redist\\OCR";
    if (gdpictureOCR.AddLanguage(OCRLanguage.English) == GdPictureStatus.OK)
    {
        //Set up the image you want to process.
        GdPictureImaging gdpictureImaging = new GdPictureImaging();
        //The standard open file dialog displays to allow you to select the file.
        int image = gdpictureImaging.CreateGdPictureImageFromFile("");
        if ((gdpictureImaging.GetStat() == GdPictureStatus.OK) &&
            (gdpictureOCR.SetImage(image) == GdPictureStatus.OK))
        {
            //Run the first OCR process.
            //Note that gdpictureOCR.OCRMode = OCRMode.FavorSpeed by default.
            string result1 = gdpictureOCR.RunOCR();
            if (gdpictureOCR.GetStat() == GdPictureStatus.OK)
            {
                //Save the result.
                if (gdpictureOCR.SaveAsText(result1, "OCR_result1.txt", OCROutputTextFormat.Utf16, true) == GdPictureStatus.OK)
                    MessageBox.Show("The OCR result has been successfully saved.", caption);
                else
                    MessageBox.Show("The SaveAsText() method has failed with the status: " + gdpictureOCR.GetStat().ToString(), caption);
            }
            else
            {
                MessageBox.Show("The OCR process has failed with the status: " + gdpictureOCR.GetStat().ToString(), caption);
            }
 
            //Change OCR settings.
            gdpictureOCR.OCRMode = OCRMode.FavorAccuracy;
 
            //Run the second OCR process.
            string result2 = gdpictureOCR.RunOCR();
            if (gdpictureOCR.GetStat() == GdPictureStatus.OK)
            {
                //Save the result.
                if (gdpictureOCR.SaveAsText(result2, "OCR_result2.txt", OCROutputTextFormat.Utf16, true) == GdPictureStatus.OK)
                    MessageBox.Show("The OCR result has been successfully saved.", caption);
                else
                    MessageBox.Show("The SaveAsText() method has failed with the status: " + gdpictureOCR.GetStat().ToString(), caption);
            }
            else
            {
                MessageBox.Show("The OCR process has failed with the status: " + gdpictureOCR.GetStat().ToString(), caption);
            }
 
            //Release the used image.
            gdpictureImaging.ReleaseGdPictureImage(image);
        }
        else
            MessageBox.Show("The error occurred when setting up the image: " + gdpictureImaging.GetStat().ToString() + " or " + gdpictureOCR.GetStat().ToString(), caption);
        gdpictureImaging.Dispose();
    }
    else
        MessageBox.Show("The AddLanguage() method has failed with the status: " + gdpictureOCR.GetStat().ToString(), caption);
    gdpictureOCR.ReleaseOCRResults();
}
See Also