TestResults.io
  • What is TestResults.io
  • System Architecture
  • Regulated Markets
    • Health Care Industry
    • Financial Services Industry
  • What's new?
    • Update Instruction
      • Update of the Designer extension in Visual Studio
      • Update the Execution Engine
      • Update the Base- and Environment Models
    • Migration to new project file
  • Designer
    • Overview
    • First Steps
    • Installation
    • TestResults.io solution
    • The development environment
      • Tool Window Overview
        • Test Environments
          • Steps to configure a SUT VM
          • How to access files on the system under test
        • Remote Viewer
          • Control Mode
          • Capture Mode
          • Screen Editor
          • Capture Single Image
        • Screen Explorer
        • Test Case Designer
        • Image Explorer
        • API Testing
        • TestResults.io options
          • Engines
          • Servers
    • Test Cases
      • Adding Test Cases
      • Test Case structure
      • Simple Test Case (Example)
      • Executing your Test Case
      • Generating Test Containers
      • Publishing Test Cases
      • Execution Variables
    • Software Models
      • Adding SW Models
      • Referencing the Model in the Test Case
      • Generating Test Containers
      • Publishing SW Models
      • Screens and Screen Elements
        • Tables
        • Visual Sense
        • Custom Screen Elements
    • Installers
      • Adding Installers
      • Generating Test Containers
      • Publishing Installers
    • Automation Framework Reference
      • Attributes
      • Enumerations
      • Filters
        • IImageFilter Interface
        • Select
        • Resize
      • GlobalEngineParameters
      • ImageDetectionParameters
      • ImageReference
      • Interfaces
        • ITester Interface
          • ITester Methods
          • ITester Properties
        • ITestee Interface
          • ITestee Methods
        • IConnections Interface
          • IConnections Methods
          • IConnections Properties
        • IDebug Interface
        • IEngineResult
        • IHelpers Interface
        • IImageHelper Interface
          • IImageHelper Methods
        • IKeyboard Interface
          • IKeyboard Methods
        • IMouse Interface
          • IMouse Methods
          • IMouse Properties
        • IReport Interface
          • IReport Methods
        • ISUTConnection Interface
      • OcrEngineParameters
        • Best practise
        • IronOcrEngineParameters
        • LEADOcrEngineParameters
        • OcrEngineRelatedCharacters
        • OcrPreprocessingParameters
      • ResultRectangle
      • SutNotReadyException
      • TestStepAbortedException
    • FAQ
      • Two-factor authentication (2FA) and One Time Passwords (OTP)
      • Receive and verify Emails
      • Using Excel as test data source
      • Verify PDF Content
  • Portal
    • Overview
    • First Steps
    • User's Guide
      • Login
      • Projects
      • Dashboard
      • Test Cases
      • Software & Environments
      • Test Sets
      • Job Queue
      • Management
      • Notifications Summary
    • Automation Engineer's Guide
      • Test Automation Workflow
      • Automating a test case
      • Enabling Software & Environments
    • REST API Reference
      • Authentication
      • Projects
      • Test Sets
      • Test Cases
      • Test Plans
      • Test Reports
      • Files
      • Software
      • Environments
      • Untitled
      • Executions
      • Favorites
      • Statistics
      • User Management
      • Customer Management
      • Notifications
      • Configurations
      • Invoicing
  • Models
    • Overview
    • Base Model
      • BaseScreen
        • BaseScreen Properties
        • BaseScreen Methods
      • OnScreenElement
        • OnScreenElement Methods
        • OnScreenElement Properties
      • Primitives
        • Button
          • Button Methods
          • Button Properties
        • Checkbox
          • Checkbox Methods
        • ContextMenu
          • ContextMenu Methods
          • ContextMenu Properties
        • Dropdown
          • Dropdown Methods
          • Dropdown Properties
        • DropdownMenu
          • DropdownMenu Methods
          • DropdownMenu Properties
        • GenericScroller
          • GenericScroller Methods
          • GenericScroller Properties
        • HorizontalScroller
        • IconButton
          • IconButton Properties
        • Label
        • LabelWithButton
          • LabelWithButton Properties
        • LabelWithCheckbox
          • LabelWithCheckbox Properties
        • LabelWithValue
          • LabelWithValue Methods
          • LabelWithValue Properties
        • PwTextBox
          • PwTextBox Methods
        • TextBox
          • TextBox Methods
          • TextBox Properties
        • Tables and lists
          • Column
            • Column Methods
            • Column Properties
          • ItemList
            • ItemList Methods
            • ItemList Properties
          • Row
            • Row Methods
            • Row Properties
          • TableBase
            • TableBase Methods
            • TableBase Properties
        • LabelWithElementBase
          • LabelWithElementBase Properties
      • Enumerations
      • Extensions
        • EngineResultExtensions Methods
        • EnumExtensions Methods
        • ReportExtensions Methods
        • StringExtensions Methods
        • TesterConnectionExtensions Methods
        • TesterDebugExtensions Methods
        • TesterHelperExtensions Methods
        • TesterMouseExtensions Methods
        • TesterOnScreenElementExtensions
        • TesterSelectExtensions Methods
      • Helper Classes
        • BaseModelHelpers
          • BaseModelHelpers Methods
          • BaseModelHelpers Properties
        • Attributes for Designer
        • ListHelpers
      • Exceptions
        • ElementNotFoundException
        • InteractionFailedException
        • ScreenNotFoundException
      • Interfaces
        • IAppBasics Interface
          • IAppBasics Methods
          • IAppBasics Properties
        • IBrowser
        • ICommandLineWindow
        • IScroller Interface
          • IScroller Methods
          • IScroller Properties
        • ISutLocale Interface
          • ISutLocale Methods
          • ISutLocale Properties
        • ISystemHelpers
        • ISystemInteractions
        • IWindow
    • Environment Model
      • Windows
        • Screens
          • CmdWindow
            • CmdWindow Methods
            • CmdWindow Properties
          • FileDialog
            • FileDialog Methods
            • FileDialog Properties
          • FileExplorer
            • FileExplorer Properties
          • RunWindow
            • RunWindow Methods
            • RunWindow Properties
          • Window
            • Window Methods
            • Window Properties
        • SutLocale
          • SutLocale Methods
          • SutLocale Properties
        • SystemHelpers
          • SystemHelpers Methods
          • SystemHelpers Properties
        • SystemInteractions
        • WebBrowser
          • Browser
            • Browser Methods
            • Browser Properties
          • BrowserScroller
            • BrowserScroller Methods
            • BrowserScroller Properties
          • AuthenticationDialog
            • AuthenticationDialog Methods
            • AuthenticationDialog Properties
          • DownloadDialog
            • DownloadDialog Methods
            • DownloadDialog Properties
        • EnvironmentModel Enumerations
        • Interfaces
          • IWebAppBasics
            • IWebAppBasics Property
Powered by GitBook
On this page
  • AcceptedOcrCharacters
  • CleanBackgroundNoise
  • ColorDepth
  • ColorSpace
  • DetectWhiteTextOnDarkBackgrounds
  • EnhanceContrast
  • EnhanceResolution
  • InputImageType
  • ReadBarCodes
  • RotateAndStraighten
  • Strategy
  • UseAutoMode

Was this helpful?

  1. Designer
  2. Automation Framework Reference
  3. OcrEngineParameters

IronOcrEngineParameters

PreviousBest practiseNextLEADOcrEngineParameters

Last updated 4 years ago

Was this helpful?

AcceptedOcrCharacters

Specifies the characters the OCR engine will look for, which can hugely improve speed and accuracy. The default behavior is to identify all UTF-8 characters including accented characters borrowed from international languages. E.g. "0123456789" for only numbers, or "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz.:;?!@$%&+-,-()\"'0123456789" for English characters without accents. Default: null

Syntax: public string AcceptedOcrCharacters { get; set; }

CleanBackgroundNoise

AdvancedOcr will clean background 'noise' , dust, speckles and signs of paper away from printed text. In the context of detecting text on the UI, CleanBackgroundNoise can help on screen segments with different backgrounds, e.g. tables with alternating row colors. Note: This will produce unusable results for white text on dark backgrounds. If you want to use it in that case, enable in . Default: false

Syntax: public bool CleanBackgroundNoise { get; set; }

ColorDepth

Bits of color per channel per pixel. Lower ColorDepth can reduce scanning time for documents that also contain many colors or images. A value of ZERO will result in image color depths not being modified from the original source image. Default: 0

Syntax: public int ColorDepth { get; set; }

ColorSpace

OCR documents can be scanned in GreyScale to reduce processing time. This may not work well for low-contrast text on a non-white backgrounds. Default: GrayScale

Syntax: public OcrColorSpace ColorSpace { get; set; }

DetectWhiteTextOnDarkBackgrounds

Automatically detects and adjusts white text on darker backgrounds. Default: true

Syntax: public bool DetectWhiteTextOnDarkBackgrounds { get; set; }

EnhanceContrast

Enhances image contrast adaptively, which generally increases text readability both by humans and machines. Default: false

Syntax: public bool EnhanceContrast { get; set; }

EnhanceResolution

Re-renders low quality images at a higher DPI. IronOcr works faster and more accurately with high resolution images. Useful for images scanned at under 250 DPI (standard dpi for vnc is 95, so this is a very important parameter for detecting text on the UI!) Default: true

Syntax: public bool EnhanceResolution { get; set; }

InputImageType

Hints the OCR Engine about the type of image being scanned, which can reduce OCR time and increase accuracy. Can be AutoDetect, Document, Snippet Default: Snippet

Syntax: public InputTypes InputImageType { get; set; }

ReadBarCodes

Enables Barcodes to be extracted from OCR documents, alongside the text content. Default: false

Syntax: public bool ReadBarCodes { get; set; }

RotateAndStraighten

AdvancedOcr will deskew and rotate images to be straight, upright, unbent and without perspective. RotateAndStraighten is a powerful tool, making imperfect scans OCR accurately. CPU/GPU intensive. Default: false

Syntax: public bool RotateAndStraighten { get; set; }

Strategy

Algorithm to be used for OCR text analysis. Can be Fast or Advanced. Advanced will take considerably longer and produce much more false results, but might help to recognize text that is not detected as text with Fast strategy. Default: Fast

Syntax: public OcrStrategy Strategy { get; set; }

UseAutoMode

AutoOcr uses meta-data and computer-vision to predict intelligent default settings for each setting. Ignores all other IronOcrParameters except ReadBarCodes. Generally takes longer than the default settings for AdvancedOcr and doesn't produce better results. Default: false

Syntax: public bool UseAutoMode { get; set; }

PreprocessingParameters
UseInvertModification