ALOcrConfig Class Reference

Inherits from NSObject
Declared in ALPluginConfig.h

Overview

Configuration for general OCR scanning use-cases

  charCountX

Sets the number of characters in each text line for ‘grid’ mode.

@property (nonatomic, nullable, strong) NSNumber *charCountX

Declared In

ALPluginConfig.h

  charCountY

Sets the number of text lines for ‘grid’ mode.

@property (nonatomic, nullable, strong) NSNumber *charCountY

Declared In

ALPluginConfig.h

  charPaddingXFactor

Defines the average horizontal distance between two characters in ‘grid’ mode, measured in percentage of the characters width.

@property (nonatomic, nullable, strong) NSNumber *charPaddingXFactor

Declared In

ALPluginConfig.h

  charPaddingYFactor

Defines the average vertical distance between two characters in ‘grid’ mode, measured in percentage of the characters height.

@property (nonatomic, nullable, strong) NSNumber *charPaddingYFactor

Declared In

ALPluginConfig.h

  charWhitelist

Restricts the scanner to a set of characters to be detected.

@property (nonatomic, nullable, copy) NSString *charWhitelist

Declared In

ALPluginConfig.h

  customCmdFile

Sets a custom Anyline script. The file has to be located in the project and point to a path relative from the project root. Please check the official documentation for more details.

@property (nonatomic, nullable, copy) NSString *customCmdFile

Declared In

ALPluginConfig.h

  maxCharHeight

Sets a maximum character height (in pixels) to be considered in the scanning process.

@property (nonatomic, nullable, strong) NSNumber *maxCharHeight

Declared In

ALPluginConfig.h

  minCharHeight

Sets a minimum character height (in pixels) to be considered in the scanning process.

@property (nonatomic, nullable, strong) NSNumber *minCharHeight

Declared In

ALPluginConfig.h

  minConfidence

Sets a minimum confidence which has to be reached in order to trigger a scan result.

@property (nonatomic, nullable, strong) NSNumber *minConfidence

Declared In

ALPluginConfig.h

  minSharpness

Sets a sharpnes factor (0-100) to rule out blurry images.

@property (nonatomic, nullable, strong) NSNumber *minSharpness

Declared In

ALPluginConfig.h

  models

Sets one or more custom Anyline models. The files have to be located in the project and point to a path relative from the project root. If no customCmdFile is set, only a maximum of one model is valid. If a customCmdFile is set, it depends whether or not the customCmdFile requires multiple models or not. Please check the official documentation for more details.

@property (nonatomic, nullable, copy) NSArray<NSString*> *models

Declared In

ALPluginConfig.h

  scanMode

Sets whether to scan single-line texts, multi-line texts in a grid-formation or finds text automatically.

@property (nonatomic, nullable, assign) ALOcrConfigScanMode *scanMode

Declared In

ALPluginConfig.h

  validationRegex

Sets a regular expression which the scanned text needs to match in order to trigger a scan result.

@property (nonatomic, nullable, copy) NSString *validationRegex

Declared In

ALPluginConfig.h