This tutorial shows how to create a C# Windows Console application that sets up the LEAD OCR Engine to process OCR.
Overview | |
---|---|
Summary | This tutorial covers how to set up the LEAD OCR Engine in a C# Windows Console application. |
Completion Time | 30 minutes |
Visual Studio Project | Download tutorial project (3 KB) |
Platform | C# Windows Console Application |
IDE | Visual Studio 2017, 2019 |
Development License | Download LEADTOOLS |
Try it in another language |
|
Get familiar with the basic steps of creating a project by reviewing the Add References and Set a License tutorial, before working on the Convert Images to Searchable PDF With OCR - Console C# tutorial.
Start with a copy of the project created in the Add References and Set a License tutorial. If you do not have that project, follow the steps in that tutorial to create it.
The references needed depend upon the purpose of the project. References can be added by one or the other of the following two methods (but not both). For this project, the following references are needed:
If using NuGet references, this tutorial requires the following NuGet package:
Leadtools.Ocr
If local DLL references are used, the following DLLs are needed. The DLLs are located at <INSTALL_DIR>\LEADTOOLS22\Bin\Dotnet4\x64
:
Leadtools.dll
Leadtools.Codecs.dll
Leadtools.Codecs.Cmp.dll
Leadtools.Codecs.Tif.dll
Leadtools.Codecs.Fax.dll
Leadtools.Document.Writer.dll
Leadtools.Ocr.dll
Leadtools.Ocr.LEADEngine.dll
For a complete list of which DLL files are required for your application, refer to Files to be Included in your Application.
The License unlocks the features needed for the project. It must be set before any toolkit function is called. For details including tutorials for different platforms, refer to Setting a Runtime License.
There are two types of runtime licenses:
Note
Adding LEADTOOLS NuGet and local references and setting a license are covered in more detail in the Add References and Set a License tutorial.
With the project created, the references added, and the license set, coding can begin.
In Solution Explorer, open Program.cs
. To initialize and run the OCR Engine, add a new OCR(string inputFile, string outputFile)
method and call it inside the Main
method.
Add the following statements to the using
block at the top of Program.cs
:
using Leadtools;
using Leadtools.Ocr;
using Leadtools.Document.Writer;
// Using block at the top
using System;
using System.IO;
using Leadtools;
using Leadtools.Document.Writer;
using Leadtools.Ocr;
using Leadtools.Document;
static void OCR(string inputFile, string outputFile)
{
using (IOcrEngine ocrEngine = OcrEngineManager.CreateEngine(OcrEngineType.LEAD))
{
//Startup the LEADTOOLS OCR Engine
ocrEngine.Startup(null, null, null, @"C:\LEADTOOLS22\Bin\Common\OcrLEADRuntime");
//Run the AutoRecognizeManager and specify PDF format
ocrEngine.AutoRecognizeManager.Run(inputFile, outputFile, DocumentFormat.Pdf, null, null);
Console.WriteLine($"OCR output saved to {outputFile}");
}
}
static void Main(string[] args)
{
SetLicense();
string input = @"C:\LEADTOOLS22\Resources\Images\OCR1.TIF";
string output = @"C:\LEADTOOLS22\Resources\Images\OCR1.PDF";
OCR(input, output);
}
To use MemoryStream
with the files, replace the existing code in the OCR()
method with the following:
static void OCR(string inputFile, string outputFile)
{
using (IOcrEngine ocrEngine = OcrEngineManager.CreateEngine(OcrEngineType.LEAD))
{
using (var stream = File.OpenRead(inputFile))
{
var options = new LoadDocumentOptions();
using (var document = DocumentFactory.LoadFromStream(stream, options))
{
// Console commands to double check that the file was loaded properly
Console.WriteLine(document.DocumentId);
Console.WriteLine(document.DocumentId);
Console.WriteLine("Document loaded");
//Startup the LEADTOOLS OCR Engine
ocrEngine.Startup(null, null, null, @"C:\LEADTOOLS22\Bin\Common\OcrLEADRuntime");
//Run the AutoRecognizeManager and specify PDF format
ocrEngine.AutoRecognizeManager.Run(inputFile, outputFile, DocumentFormat.Pdf, null, null);
Console.WriteLine($"OCR output saved to {outputFile}");
}
}
}
}
Run the project by pressing F5, or by selecting Debug -> Start Debugging.
If the steps were followed correctly, the console appears and confirms that the license was set correctly. Then the application converts the OCR1.TIF image to PDF format and saves it to the specified location (as a searchable PDF).
This tutorial showed how to create a simple console-based OCR application that initializes the LEAD OCR Engine, takes a specified input file and outputs the recognition results to the specified output file in the specified format.