You are here: Start » DLInvoke.DL_ReadCharacters
DLInvoke.DL_ReadCharacters
Performs optical character recognition using a pretrained deep learning model.
| Namespace: | Fil |
|---|---|
| Assembly: | FilNet.DL.Cpu.dll |
Syntax
C++
C#
public static void DL_ReadCharacters ( Fil.Image inImage, Optional<Fil.Rectangle2D> inRoi, Optional<Fil.CoordinateSystem2D> inRoiAlignment, Fil.ReadCharactersModelId inModelId, int inCharHeight, float inWidthScale, float inCharSpacing, Optional<string> inCharRange, float inMinScore, Fil.Polarity inPolarization, float inContrastThreshold, bool inCalculateCandidates, bool inRemoveBoundaryCharacters, List<Fil.OcrResult> outCharacters, List<List<Fil.OcrCandidate>> outCandidates, List<Fil.Region> outMasks, Optional<Fil.Rectangle2D> outAlignedRoi, Diagnostic<Fil.Image> diagInputImage )
Parameters
| Name | Type | Range | Default | Description | |
|---|---|---|---|---|---|
 | inImage | Fil.Image | Input image. | ||
| inRoi | Ftl.Optional<Fil.Rectangle2D> | Limits the area where recognized characters are located. Default value: ftl::NIL. | ||
| inRoiAlignment | Ftl.Optional<Fil.CoordinateSystem2D> | |||
| inModelId | Fil.ReadCharactersModelId | Identifier of a Read Characters model. Default value: (). | ||
| inCharHeight | int | Average height of characters in pixels. Default value: 35. | ||
| inWidthScale | float | Scales image width by the given factor. Default value: 1.0f. | ||
| inCharSpacing | float | Distance between characters denoted as fraction of inCharHeight. Default value: 0.0f. | ||
| inCharRange | Ftl.Optional<string> | Limits the set of wanted characters. Default value: "A-Z,a-z,0-9,\\\\,/,-". | ||
| inMinScore | float | Sets a minimum required score for a character to be returned. Default value: 0.5f. | ||
| inPolarization | Fil.Polarity | Sets a required polarity for a character to be returned. Default value: Any. | ||
| inContrastThreshold | float | Sets a threshold for a contrast of found characters. Default value: 0.0f. | ||
| inCalculateCandidates | bool | If set to true then outCandidates is calculated. Default value: True. | ||
| inRemoveBoundaryCharacters | bool | If set to true characters that are not entirely contained in the ROI are filtered out. Default value: False. | ||
 | outCharacters | System.Collections.Generic.List<Fil.OcrResult> | |||
| outCandidates | System.Collections.Generic.List<System.Collections.Generic.List<Fil.OcrCandidate>> | Array of the most likely characters. The first element is the character from outCharacters. | ||
| outMasks | System.Collections.Generic.List<Fil.Region> | Masks of found characters (in Extended model). Contains empty regions in case of using model not supporting masks (in Fast and Balanced model). | ||
| outAlignedRoi | Ftl.Optional<Fil.Rectangle2D> | Input roi after transformation. | ||
 | diagInputImage | Fil.Diagnostic<Fil.Image> | Analyzed area of the input image. |
