From c0b024eee8af0538b3fddfcdd46cca5e53a830e1 Mon Sep 17 00:00:00 2001 From: DMGithubPublisher Date: Thu, 24 Oct 2024 16:16:06 +0800 Subject: [PATCH 1/2] update to internal commit b5b98d87 --- .../maui/api-reference/character-result.md | 92 ++++++++++++++++++ .../api-reference/label-recognizer-module.md | 41 ++++++++ .../recognized-text-lines-result.md | 94 ++++++++++++++++++ .../simplified-label-recognizer-settings.md | 96 +++++++++++++++++++ .../api-reference/text-line-result-item.md | 76 +++++++++++++++ 5 files changed, 399 insertions(+) create mode 100644 programming/maui/api-reference/character-result.md create mode 100644 programming/maui/api-reference/label-recognizer-module.md create mode 100644 programming/maui/api-reference/recognized-text-lines-result.md create mode 100644 programming/maui/api-reference/simplified-label-recognizer-settings.md create mode 100644 programming/maui/api-reference/text-line-result-item.md diff --git a/programming/maui/api-reference/character-result.md b/programming/maui/api-reference/character-result.md new file mode 100644 index 0000000..2e5bcd8 --- /dev/null +++ b/programming/maui/api-reference/character-result.md @@ -0,0 +1,92 @@ +--- +layout: default-layout +title: CharacterResult - Dynamsoft Label Recognizer MAUI Edition +description: The class CharacterResult of Dynamsoft Label Recognizer MAUI edition represents the result of a character recognition process. +keywords: Character result +needGenerateH3Content: true +needAutoGenerateSidebar: true +noTitleIndex: true +breadcrumbText: CharacterResult +--- + +# CharacterResult + +The `CharacterResult` class represents the result of a character recognition process. It contains the characters recognized (high, medium, and low confidence), their respective confidences, and the location of the character in a quadrilateral shape. + +## Definition + +*Namespace:* Dynamsoft.LabelRecognizer.Maui + +*Assembly:* Dynamsoft.LabelRecognizer.Maui + +```csharp +class CharacterResult +``` + +## Properties + +| Property | Type | Description | +| -------- | ---- | ----------- | +| [`CharacterH`](#characterh) | *char* | Returns the highest confidence character recognized. | +| [`CharacterM`](#characterm) | *char* | Returns the medium confidence character recognized. | +| [`CharacterL`](#characterl) | *char* | Returns the lowest confidence character recognized. | +| [`Location`](#location) | *Quadrilateral* | Returns the location of the recognized character within the image. | +| [`CharacterHConfidence`](#characterhconfidence) | *int* | Returns the confidence score for the highest confidence character. | +| [`CharacterMConfidence`](#charactermconfidence) | *int* | Returns the confidence score for the medium confidence character. | +| [`CharacterLConfidence`](#characterlconfidence) | *int* | Returns the confidence score for the lowest confidence character. | + +### CharacterH + +Returns the highest confidence character recognized. + +```csharp +char CharacterH { get; } +``` + +### CharacterM + +Returns the medium confidence character recognized. + +```csharp +char CharacterM { get; } +``` + +### CharacterL + +Returns the lowest confidence character recognized. + +```csharp +char CharacterL { get; } +``` + +### Location + +Returns the location of the recognized character within the image. + +```csharp +Quadrilateral Location { get; } +``` + +### CharacterHConfidence + +Returns the confidence score for the highest confidence character. + +```csharp +int CharacterHConfidence { get; } +``` + +### CharacterMConfidence + +Returns the confidence score for the medium confidence character. + +```csharp +int CharacterMConfidence { get; } +``` + +### CharacterLConfidence + +Returns the confidence score for the lowest confidence character. + +```csharp +int CharacterLConfidence { get; } +``` diff --git a/programming/maui/api-reference/label-recognizer-module.md b/programming/maui/api-reference/label-recognizer-module.md new file mode 100644 index 0000000..c1c1941 --- /dev/null +++ b/programming/maui/api-reference/label-recognizer-module.md @@ -0,0 +1,41 @@ +--- +layout: default-layout +title: LabelRecognizerModule - Dynamsoft Label Recognizer MAUI Edition +description: The LabelRecognizerModule class of Dynamsoft Label Recognizer MAUI edition defines general functions of the DynamsoftLabelRecognizer module. +keywords: label recognizer module, MAUI +needAutoGenerateSidebar: true +needGenerateH3Content: true +breadcrumbText: LabelRecognizerModule +--- + +# LabelRecognizerModule + +The `LabelRecognizerModule` class defines general functions of the `DynamsoftLabelRecognizer` module. + +## Definition + +*Namespace:* Dynamsoft.LabelRecognizer.Maui + +*Assembly:* Dynamsoft.LabelRecognizer.Maui + +```csharp +class LabelRecognizerModule +``` + +## Methods + +| Method | Description | +| ------ | ----------- | +| [GetVersion](#getversion) | Get the version of the `DynamsoftLabelRecognizer` module. | + +## getVersion + +Get the version of the `DynamsoftLabelRecognizer` module. + +```csharp +static string GetVersion(); +``` + +**Return Value** + +Returns a string representing the version of the `DynamsoftLabelRecognizer` module. diff --git a/programming/maui/api-reference/recognized-text-lines-result.md b/programming/maui/api-reference/recognized-text-lines-result.md new file mode 100644 index 0000000..7c435a4 --- /dev/null +++ b/programming/maui/api-reference/recognized-text-lines-result.md @@ -0,0 +1,94 @@ +--- +layout: default-layout +title: RecognizedTextLinesResult - Dynamsoft Label Recognizer MAUI Edition +description: The class RecognizedTextLinesResult of Dynamsoft Label Recognizer MAUI edition represents the result of a text recognition process. +keywords: Recognized text lines result +needGenerateH3Content: true +needAutoGenerateSidebar: true +noTitleIndex: true +breadcrumbText: RecognizedTextLinesResult +--- + +# RecognizedTextLinesResult + +The `RecognizedTextLinesResult` class represents the overall result(s) of a text recognition process. It provides access to information about the recognized text lines, the original image, and any errors that occurred during the recognition process. + +## Definition + +*Namespace:* Dynamsoft.LabelRecognizer.Maui + +*Assembly:* Dynamsoft.LabelRecognizer.Maui + +```csharp +class RecognizedTextLinesResult +``` + +## Properties + +| Property | Type | Description | +| -------- | ---- | ----------- | +| [`OriginalImageHashId`](#originalimagehashid) | *String* | Gets the hash ID of the original image. | +| [`Items`](#items) | *IList* | Gets the text line result item at the specified index. | +| [`RotationTransformMatrix`](#rotationtransformmatrix) | *Matrix* | Get the rotation transformation matrix of the original image relative to the rotated image.| +| [`ErrorCode`](#errorcode) | *int* | Gets the error code of the recognition result, if an error occurred. | +| [`ErrorMessage`](#errormessage) | *String* | Gets the error message of the recognition result, if an error occurred. | + +### OriginalImageHashId + +Get the hash id of the original image. You can use this ID to get the original image via the [`IntermediateResultManager`]({{ site.dcv_maui_api }}core/intermediate-results/intermediate-result-manager.html) class. + +```csharp +String OriginalImageHashId { get; } +``` + +**Return value** + +Returns the hash ID of the original image as a string. + +### Items + +Gets all the text line result(s) recognized from the image/frame in an array of [`DSTextLineResultItem`](text-line-result-item.md). + +```csharp +IList Items { get; } +``` + +**Return value** + +Returns an array of `TextLineResultItem` that contains all text line recognition results. + +### RotationTransformMatrix + +Get the rotation transformation matrix of the original image relative to the rotated image. + +```csharp +Matrix RotationTransformMatrix { get; } +``` + +**Return Value** + +A `Matrix` which represents the rotation transform matrix. + +### ErrorCode + +Gets the error code of the recognition result, if an error occurred. + +```csharp +int ErrorCode { get; } +``` + +**Return value** + +Returns the error code of the recognition result, or 0 if no error occurred. + +### ErrorMessage + +Gets the error message of the recognition result, if an error occurred. + +```csharp +String ErrorMessage { get; } +``` + +**Return value** + +Returns a string that describes the error message. diff --git a/programming/maui/api-reference/simplified-label-recognizer-settings.md b/programming/maui/api-reference/simplified-label-recognizer-settings.md new file mode 100644 index 0000000..b99f674 --- /dev/null +++ b/programming/maui/api-reference/simplified-label-recognizer-settings.md @@ -0,0 +1,96 @@ +--- +layout: default-layout +title: SimplifiedLabelRecognizerSettings - Dynamsoft Label Recognizer MAUI Edition API Reference +description: The SimplifiedLabelRecognizerSettings contains label recognition setting of Dynamsoft Label Recognizer MAUI edition +keywords: MAUI, SimplifiedLabelRecognizerSettings +needAutoGenerateSidebar: true +needGenerateH3Content: true +breadcrumbText: SimplifiedLabelRecognizerSettings +--- + +# SimplifiedLabelRecognizerSettings + +The `SimplifiedLabelRecognizerSettings` class contains settings for label recognition. It is a sub-parameter of `SimplifiedCaptureVisionSettings` + +## Definition + +*Namespace:* Dynamsoft.LabelRecognizer.Maui + +*Assembly:* Dynamsoft.LabelRecognizer.Maui + +```csharp +class SimplifiedLabelRecognizerSettings +``` + +## Properties + +| Property | Type | Description | +| --------- | ---- | ----------- | +| [`GrayscaleTransformationModes`](#grayscaletransformationmodes) | *EnumGrayscaleTransformationMode[]* | Set the grayscale transformation modes with an array of enumeration [`GrayscaleTransformationMode`]({{ site.dcv_enumerations}}core/grayscale-transformation-mode.html). | +| [`GrayscaleEnhancementModes`](#grayscaleenhancementmodes) | *EnumGrayscaleEnhancementMode[]* | Set the grayscale enhancement modes with an array of enumeration [`GrayscaleEnhancementMode`]({{ site.dcv_enumerations}}core/grayscale-enhancement-mode.html). | +| [`CharacterModelName`](#charactermodelname) | *String* | Specify a character model by its name. | +| [`LineStringRegExPattern`](#linestringregexpattern) | *String* | Set the RegEx pattern of the text line string to filter out the unqualified results. | +| [`MaxThreadsInOneTask`](#maxthreadsinonetask) | *int* | Set the maximum available threads count in one label recognition task. | +| [`ScaleDownThreshold`](#scaledownthreshold) | *int* | Set the threshold for image shrinking when dealing with large images. | + +### GrayscaleTransformationModes + +Set the grayscale transformation modes with an array of enumeration [`GrayscaleTransformationMode`]({{ site.dcv_enumerations}}core/grayscale-transformation-mode.html). + +```csharp +EnumGrayscaleTransformationMode[] GrayscaleTransformationModes { get; set ; } +``` + +**Remarks** + +View the parameter reference page of [`GrayscaleTransformationMode`]({{ site.dcv_parameter_reference }}image-parameter/grayscale-transformation-modes.html){:target="_blank"} for more detail about how to set grayscale transformation modes. + +### GrayscaleEnhancementModes + +Set the grayscale enhancement modes with an array of enumeration [`GrayscaleEnhancementMode`]({{ site.dcv_enumerations}}core/grayscale-enhancement-mode.html). + +```csharp +EnumGrayscaleEnhancementMode[] GrayscaleEnhancementModes { get; set; } +``` + +**Remarks** + +View the reference page of [`GrayscaleEnhancementMode`]({{ site.dcv_parameter_reference }}image-parameter/grayscale-enhancement-modes.html){:target="_blank"} for more detail about how to set grayscale enhancement modes. + +### CharacterModelName + +Specify a character model by its name. + +```csharp +String CharacterModelName { get; set ; } +``` + +**Remarks** + +View the parameter reference of [CharacterModelName]({{ site.dcv_parameter_reference }}text-line-specification/character-model-name.html) for more details about how to use the parameter. + +### LineStringRegExPattern + +Set the RegEx pattern of the text line string to filter out the unqualified results. + +```csharp +String LineStringRegExPattern { get; set ; } +``` + +### MaxThreadsInOneTask + +Set the maximum available threads count in one label recognition task. + +```csharp +int MaxThreadsInOneTask { get; set ; } +``` + +**Remarks** + +### ScaleDownThreshold + +Set the threshold for image shrinking when dealing with large images. + +```csharp +int ScaleDownThreshold { get; set ; } +``` diff --git a/programming/maui/api-reference/text-line-result-item.md b/programming/maui/api-reference/text-line-result-item.md new file mode 100644 index 0000000..102bcaf --- /dev/null +++ b/programming/maui/api-reference/text-line-result-item.md @@ -0,0 +1,76 @@ +--- +layout: default-layout +title: TextLineResultItem - Dynamsoft Label Recognizer MAUI Edition +description: The class TextLineResultItem of Dynamsoft Label Recognizer MAUI edition represents a text line result item recognized by a document layout analysis engine. +keywords: Text line result item +needGenerateH3Content: true +needAutoGenerateSidebar: true +noTitleIndex: true +breadcrumbText: TextLineResultItem +--- + +# TextLineResultItem + +The `TextLineResultItem` class represents a single text line result item recognized by the library. It is derived from `CapturedResultItem` and is one of the base items of `RecognizedTextLinesResult`. + +## Definition + +*Namespace:* Dynamsoft.LabelRecognizer.Maui + +*Assembly:* Dynamsoft.LabelRecognizer.Maui + +```csharp +public class TextLineResultItem : CapturedResultItem +``` + +*Inheritance:* [CapturedResultItem]({{ site.dcv_maui_api }}core/basic-structures/captured-result-item.html) -> TextLineResultItem + +## Properties + +| Property | Type | Description | +| --------- | ---- | ----------- | +| [`Text`](#text) | *String* | Returns the text content of the text line. | +| [`Location`](#location) | *Quadrilateral* | Returns the location of the text line in the form of a quadrilateral. | +| [`Confidence`](#confidence) | *int* | Returns the confidence of the text line recognition result. | +| [`CharacterResults`](#characterresults) | *IList* | Get all the characters in the text line. Each character is represented by a [`CharacterResult`](character-result.html) object. | +| [`SpecificationName`](#specificationname) | *String* | Returns the name of the [`TextLineSpecification`]({{site.dcv_parameter_reference}}text-line-specification/) object that generated this `TextLineResultItem`. | + +### Text + +Returns the text content of the individual text line. + +```csharp +string Text { get; } +``` + +### Location + +It is used to get the location of the text line in the form of a [Quadrilateral]({{ site.dcv_maui_api }}core/basic-structures/quadrilateral.html). + +```csharp +Quadrilateral Location { get; } +``` + +### Confidence + +Returns the confidence of the individual text line recognition result. + +```csharp +int Confidence { get; } +``` + +### CharacterResults + +Returns all the characters in the text line. Each character is represented by a [`CharacterResult`](character-result.md) object. + +```csharp +IList CharacterResults { get; } +``` + +### SpecificationName + +Returns the name of the [`TextLineSpecification`]({{site.dcv_parameter_reference}}text-line-specification/) object that generated this `TextLineResultItem`. + +```csharp +String SpecificationName { get; } +``` From 1649e317679db3d1f9b30ff2d3c88f1d8a6c7a9e Mon Sep 17 00:00:00 2001 From: DMGithubPublisher Date: Thu, 24 Oct 2024 17:31:49 +0800 Subject: [PATCH 2/2] update to internal commit 1f2141b8 --- programming/maui/api-reference/character-result.md | 4 ++-- programming/maui/api-reference/label-recognizer-module.md | 4 ++-- .../maui/api-reference/recognized-text-lines-result.md | 4 ++-- .../api-reference/simplified-label-recognizer-settings.md | 4 ++-- programming/maui/api-reference/text-line-result-item.md | 4 ++-- 5 files changed, 10 insertions(+), 10 deletions(-) diff --git a/programming/maui/api-reference/character-result.md b/programming/maui/api-reference/character-result.md index 2e5bcd8..c0d1bb2 100644 --- a/programming/maui/api-reference/character-result.md +++ b/programming/maui/api-reference/character-result.md @@ -1,7 +1,7 @@ --- layout: default-layout -title: CharacterResult - Dynamsoft Label Recognizer MAUI Edition -description: The class CharacterResult of Dynamsoft Label Recognizer MAUI edition represents the result of a character recognition process. +title: CharacterResult - Dynamsoft Capture Vision MAUI Edition +description: The class CharacterResult of Dynamsoft Capture Vision MAUI edition represents the result of a character recognition process. keywords: Character result needGenerateH3Content: true needAutoGenerateSidebar: true diff --git a/programming/maui/api-reference/label-recognizer-module.md b/programming/maui/api-reference/label-recognizer-module.md index c1c1941..d853a55 100644 --- a/programming/maui/api-reference/label-recognizer-module.md +++ b/programming/maui/api-reference/label-recognizer-module.md @@ -1,7 +1,7 @@ --- layout: default-layout -title: LabelRecognizerModule - Dynamsoft Label Recognizer MAUI Edition -description: The LabelRecognizerModule class of Dynamsoft Label Recognizer MAUI edition defines general functions of the DynamsoftLabelRecognizer module. +title: LabelRecognizerModule - Dynamsoft Capture Vision MAUI Edition +description: The LabelRecognizerModule class of Dynamsoft Capture Vision MAUI edition defines general functions of the DynamsoftLabelRecognizer module. keywords: label recognizer module, MAUI needAutoGenerateSidebar: true needGenerateH3Content: true diff --git a/programming/maui/api-reference/recognized-text-lines-result.md b/programming/maui/api-reference/recognized-text-lines-result.md index 7c435a4..49d8aec 100644 --- a/programming/maui/api-reference/recognized-text-lines-result.md +++ b/programming/maui/api-reference/recognized-text-lines-result.md @@ -1,7 +1,7 @@ --- layout: default-layout -title: RecognizedTextLinesResult - Dynamsoft Label Recognizer MAUI Edition -description: The class RecognizedTextLinesResult of Dynamsoft Label Recognizer MAUI edition represents the result of a text recognition process. +title: RecognizedTextLinesResult - Dynamsoft Capture Vision MAUI Edition +description: The class RecognizedTextLinesResult of Dynamsoft Capture Vision MAUI edition represents the result of a text recognition process. keywords: Recognized text lines result needGenerateH3Content: true needAutoGenerateSidebar: true diff --git a/programming/maui/api-reference/simplified-label-recognizer-settings.md b/programming/maui/api-reference/simplified-label-recognizer-settings.md index b99f674..075e83f 100644 --- a/programming/maui/api-reference/simplified-label-recognizer-settings.md +++ b/programming/maui/api-reference/simplified-label-recognizer-settings.md @@ -1,7 +1,7 @@ --- layout: default-layout -title: SimplifiedLabelRecognizerSettings - Dynamsoft Label Recognizer MAUI Edition API Reference -description: The SimplifiedLabelRecognizerSettings contains label recognition setting of Dynamsoft Label Recognizer MAUI edition +title: SimplifiedLabelRecognizerSettings - Dynamsoft Capture Vision MAUI Edition API Reference +description: The SimplifiedLabelRecognizerSettings contains label recognition setting of Dynamsoft Capture Vision MAUI edition keywords: MAUI, SimplifiedLabelRecognizerSettings needAutoGenerateSidebar: true needGenerateH3Content: true diff --git a/programming/maui/api-reference/text-line-result-item.md b/programming/maui/api-reference/text-line-result-item.md index 102bcaf..c32aa11 100644 --- a/programming/maui/api-reference/text-line-result-item.md +++ b/programming/maui/api-reference/text-line-result-item.md @@ -1,7 +1,7 @@ --- layout: default-layout -title: TextLineResultItem - Dynamsoft Label Recognizer MAUI Edition -description: The class TextLineResultItem of Dynamsoft Label Recognizer MAUI edition represents a text line result item recognized by a document layout analysis engine. +title: TextLineResultItem - Dynamsoft Capture Vision MAUI Edition +description: The class TextLineResultItem of Dynamsoft Capture Vision MAUI edition represents a text line result item recognized by a document layout analysis engine. keywords: Text line result item needGenerateH3Content: true needAutoGenerateSidebar: true