VintaSoft Imaging .NET SDK 14.0: Documentation for .NET developer
Vintasoft.Imaging.Ocr.Tesseract Namespace / TesseractOcr Class / SetVariable Methods / SetVariable(String,String) Method
Syntax Exceptions Remarks Example Requirements SeeAlso
In This Topic
    SetVariable(String,String) Method (TesseractOcr)
    In This Topic
    Sets a value of string variable of Tesseract OCR engine.
    Syntax
    'Declaration
    
    Public Overloads Function SetVariable( _
    ByVal name
    Name of the variable.
    As System.String, _
    ByVal value
    Value of the variable.
    As System.String _
    ) As Boolean
    public bool SetVariable(
    System.String name,
    System.String value
    )
    public: bool SetVariable(
    System.String name,
    System.String value
    )
    public:
    bool SetVariable(
    System.String name,
    System.String value
    )

    Parameters

    name
    Name of the variable.
    value
    Value of the variable.

    Return Value

    True if value of variable is successfully set; otherwise, false.
    Exceptions
    ExceptionDescription
    Thrown if OCR engine is not initialized yet.
    Remarks

    Method Init(OcrEngineSettings) must be executed before executing of this method.

    Example

    This C#/VB.NET code shows how to specify that the recognizing text contains only the limited set of characters and recognize the text from image.

    
    ''' <summary>
    ''' Specifies that text contains only the limited set of characters and
    ''' recognizes the text in image.
    ''' </summary>
    ''' <param name="filename">The name of file, which stores images with text.</param>
    Public Shared Sub OcrImageWithDigits(filename As String)
        ' create an image collection
        Using images As New Vintasoft.Imaging.ImageCollection()
            ' add images from file to the image collection
            images.Add(filename)
    
            System.Console.WriteLine("Create Tesseract OCR engine...")
            ' create the Tesseract OCR engine
            Using tesseractOcr As New Vintasoft.Imaging.Ocr.Tesseract.TesseractOcr()
                System.Console.WriteLine("Initialize OCR engine...")
                ' init the Tesseract OCR engine
                tesseractOcr.Init(New Vintasoft.Imaging.Ocr.OcrEngineSettings(Vintasoft.Imaging.Ocr.OcrLanguage.English))
    
                ' set the "white list" of recognizing characters
                tesseractOcr.SetVariable("tessedit_char_whitelist", "01234567890")
    
                ' for each image
                For Each image As Vintasoft.Imaging.VintasoftImage In images
                    System.Console.WriteLine("Recognize the image...")
    
                    ' recognize text in image
                    Dim ocrResult As Vintasoft.Imaging.Ocr.Results.OcrPage = tesseractOcr.Recognize(image)
    
                    ' output the recognized text
    
                    System.Console.WriteLine("Page Text:")
                    System.Console.WriteLine(ocrResult.GetText())
                    System.Console.WriteLine()
                Next
    
                ' shutdown the Tesseract OCR engine
                tesseractOcr.Shutdown()
            End Using
    
            ' free images
            images.ClearAndDisposeItems()
        End Using
    End Sub
    
    
    
    /// <summary>
    /// Specifies that text contains only the limited set of characters and
    /// recognizes the text in image.
    /// </summary>
    /// <param name="filename">The name of file, which stores images with text.</param>
    public static void OcrImageWithDigits(string filename)
    {
        // create an image collection
        using (Vintasoft.Imaging.ImageCollection images = 
            new Vintasoft.Imaging.ImageCollection())
        {
            // add images from file to the image collection
            images.Add(filename);
    
            System.Console.WriteLine("Create Tesseract OCR engine...");
            // create the Tesseract OCR engine
            using (Vintasoft.Imaging.Ocr.Tesseract.TesseractOcr tesseractOcr = 
                new Vintasoft.Imaging.Ocr.Tesseract.TesseractOcr())
            {
                System.Console.WriteLine("Initialize OCR engine...");
                // init the Tesseract OCR engine
                tesseractOcr.Init(new Vintasoft.Imaging.Ocr.OcrEngineSettings(
                    Vintasoft.Imaging.Ocr.OcrLanguage.English));
    
                // set the "white list" of recognizing characters
                tesseractOcr.SetVariable(
                    "tessedit_char_whitelist", "01234567890");
    
                // for each image
                foreach (Vintasoft.Imaging.VintasoftImage image in images)
                {
                    System.Console.WriteLine("Recognize the image...");
    
                    // recognize text in image
                    Vintasoft.Imaging.Ocr.Results.OcrPage ocrResult = tesseractOcr.Recognize(image);
    
                    // output the recognized text
    
                    System.Console.WriteLine("Page Text:");
                    System.Console.WriteLine(ocrResult.GetText());
                    System.Console.WriteLine();
                }
    
                // shutdown the Tesseract OCR engine
                tesseractOcr.Shutdown();
            }
    
            // free images
            images.ClearAndDisposeItems();
        }
    }
    
    

    Requirements

    Target Platforms: .NET9; .NET 8; .NET 7; .NET 6; .NET Framework 4.8, 4.7, 4.6, 4.5, 4.0, 3.5

    See Also