1. IronOCR
  2. How-Tos
  3. Progress Tracking

How to Use Progress Tracking

Chaknith related to How to Use Progress Tracking
Chaknith Bin
Updated:

IronOCR provides an event for subscribing to track the progress of the OCR (Optical Character Recognition) reading operation. These properties offer valuable information about the progress, duration, and completion status of the OCR job, enabling applications to effectively monitor and report on the OCR process.

Get Started with IronOCR

Start using IronOCR in your project today with a free trial.

First Step:
green arrow pointer

How to Use Progress Tracking

  1. Download a C# library for tracking reading progress
  2. Subscribe to the OcrProgress event
  3. Utilize the instance passed by the event to retrieve progress information
  4. Obtain progress in percentage and total duration
  5. Retrieve start and end times, as well as the total number of pages


Progress Tracking Example

The OcrProgress event can be subscribed to receive progress updates on the reading process. The event will pass an instance containing information about the progress of the OCR job, such as the start time, total pages, progress as a percentage, duration, and end time. Let's use the following document as our sample: "Experiences in Biodiversity Research: A Field Course" by Thea B. Gessler, Iowa State University.

:path=/static-assets/ocr/content-code-examples/how-to/progress-tracking-progress-tracking.cs
using IronOcr;
using System;

var ocrTesseract = new IronTesseract();

// Subscribe to OcrProgress event
ocrTesseract.OcrProgress += (_, ocrProgressEventsArgs) =>
{
    Console.WriteLine("Start time: " + ocrProgressEventsArgs.StartTimeUTC.ToString());
    Console.WriteLine("Total pages number: " + ocrProgressEventsArgs.TotalPages);
    Console.WriteLine("Progress(%) | Duration");
    Console.WriteLine("    " + ocrProgressEventsArgs.ProgressPercent + "%     | " + ocrProgressEventsArgs.Duration.TotalSeconds + "s");
    Console.WriteLine("End time: " + ocrProgressEventsArgs.EndTimeUTC.ToString());
    Console.WriteLine("----------------------------------------------");
};

using var input = new OcrInput();
input.LoadPdf("Experiences-in-Biodiversity-Research-A-Field-Course.pdf");

// Progress events will fire during the read operation
var result = ocrTesseract.Read(input);
Imports IronOcr
Imports System

Private ocrTesseract = New IronTesseract()

' Subscribe to OcrProgress event
Private ocrTesseract.OcrProgress += Sub(underscore, ocrProgressEventsArgs)
	Console.WriteLine("Start time: " & ocrProgressEventsArgs.StartTimeUTC.ToString())
	Console.WriteLine("Total pages number: " & ocrProgressEventsArgs.TotalPages)
	Console.WriteLine("Progress(%) | Duration")
	Console.WriteLine("    " & ocrProgressEventsArgs.ProgressPercent & "%     | " & ocrProgressEventsArgs.Duration.TotalSeconds & "s")
	Console.WriteLine("End time: " & ocrProgressEventsArgs.EndTimeUTC.ToString())
	Console.WriteLine("----------------------------------------------")
End Sub

Private input = New OcrInput()
input.LoadPdf("Experiences-in-Biodiversity-Research-A-Field-Course.pdf")

' Progress events will fire during the read operation
Dim result = ocrTesseract.Read(input)
$vbLabelText   $csharpLabel
Progress update

Information from the Event

  • ProgressPercent: Represents the progress of the OCR job as a percentage of pages completed. It ranges from 0 to 100.
  • TotalPages: Indicates the total number of pages being processed by the OCR engine.
  • PagesComplete: Specifies the number of pages where OCR reading has been fully completed. This count may increase gradually as pages are processed.
  • Duration: Represents the total duration of the OCR job, indicating the time taken for the entire process to complete. It's measured in TimeSpan format. This time is updated every time the event is triggered.
  • StartTimeUTC: Denotes the date and time when the OCR job started, represented in Coordinated Universal Time (UTC) format.
  • EndTimeUTC: Represents the date and time when the OCR job was 100% completed in UTC format. This property is null while OCR is still in progress and gets populated once the OCR process is finished.

Frequently Asked Questions

How do I start using progress tracking with a C# library?

To start using progress tracking, you need to download the IronOCR C# library from NuGet and subscribe to the OcrProgress event to receive updates on the OCR process.

What information can be obtained from the progress tracking event?

The OcrProgress event in IronOCR provides information such as the progress percentage, total pages, pages completed, elapsed time, and start time in UTC format.

How can I display the progress of a reading process?

You can display the progress of the OCR process by subscribing to the OcrProgress event in IronOCR and using the eventArgs to retrieve progress details like percentage completed, pages completed, and elapsed time.

What does the progress percentage property represent?

The ProgressPercent property in IronOCR represents the progress of the OCR job as a percentage of pages completed, ranging from 0 to 100.

How is the time duration used in progress tracking?

The Duration property in IronOCR indicates the total time taken for the OCR job to complete. It is updated each time the OcrProgress event is triggered.

What is the significance of the start time in the OCR process?

StartTimeUTC in IronOCR denotes the date and time when the OCR job started, represented in Coordinated Universal Time (UTC). It helps track when the OCR process began.

Is it possible to track when the reading job is completed?

Yes, in IronOCR, the EndTimeUTC property becomes populated with the date and time in UTC format once the OCR job is 100% completed.

Can I track the number of pages processed during reading?

Yes, in IronOCR, the PagesComplete and TotalPages properties allow you to track the number of pages that have been fully processed and the total number of pages being processed, respectively.

What coding example is provided for progress tracking?

The provided coding example demonstrates how to subscribe to the OcrProgress event in IronOCR using a sample PDF document titled 'Experiences in Biodiversity Research: A Field Course.'

Chaknith related to Information from the Event
Chaknith Bin
  Chat with engineering team now
Software Engineer
Chaknith is the Sherlock Holmes of developers. It first occurred to him he might have a future in software engineering, when he was doing code challenges for fun. His focus is on IronXL and IronBarcode, but he takes pride in helping customers with every product. Chaknith leverages his knowledge from talking directly with customers, to help further improve the products themselves. His anecdotal feedback goes beyond Jira tickets and supports product development, documentation and marketing, to improve customer’s overall experience.When he isn’t in the office, he can be found learning about machine learning, coding and hiking.
Talk to an Expert Five Star Trust Score Rating

Ready to Get Started?

Nuget Passed
Free NuGet Download Total downloads: 4,117,530
View Licenses