From 4a6a10c5ee14da8b8f174f7e30a04a8a4f8fa6fb Mon Sep 17 00:00:00 2001 From: DMGithubPublisher Date: Thu, 21 Mar 2024 00:46:05 -0700 Subject: [PATCH] update to internal commit f33aed92 --- .../api-reference/detected-quad-element.md | 4 +-- .../detected-quad-result-item.md | 8 ++--- .../api-reference/detected-quads-result.md | 14 +++----- .../normalized-image-result-item.md | 6 ++-- .../api-reference/normalized-images-result.md | 14 +++----- ...simplified-document-normalizer-settings.md | 18 +++++------ programming/android/upgrade-instruction.md | 22 ++++++------- .../candidate-quad-edges-unit-v2.0.20.md | 2 +- .../candidate-quad-edges-unit.md | 2 +- .../ios/api-reference/corners-unit-v2.0.20.md | 2 +- programming/ios/api-reference/corners-unit.md | 2 +- .../api-reference/detected-quad-element.md | 6 ++-- .../detected-quad-result-item.md | 10 +++--- .../api-reference/detected-quads-result.md | 12 +++---- .../detected-quads-unit-v2.0.20.md | 2 +- .../ios/api-reference/detected-quads-unit.md | 2 +- .../document-normalizer-module.md | 2 +- .../api-reference/long-lines-unit-2.0.20.md | 2 +- .../ios/api-reference/long-lines-unit.md | 2 +- .../api-reference/normalized-image-element.md | 2 +- .../normalized-image-result-item.md | 8 ++--- .../normalized-image-unit-v2.0.20.md | 2 +- .../api-reference/normalized-image-unit.md | 2 +- .../api-reference/normalized-images-result.md | 12 +++---- ...simplified-document-normalizer-settings.md | 20 ++++++------ programming/ios/release-notes/ios-2.md | 4 +-- programming/ios/upgrade-instruction.md | 32 +++++++++---------- 27 files changed, 103 insertions(+), 111 deletions(-) diff --git a/programming/android/api-reference/detected-quad-element.md b/programming/android/api-reference/detected-quad-element.md index 443e2fb..b0bd261 100644 --- a/programming/android/api-reference/detected-quad-element.md +++ b/programming/android/api-reference/detected-quad-element.md @@ -26,11 +26,11 @@ class DetectedQuadElement extends RegionObjectElement | Methods | Description | | ------- | ----------- | -| [`getConfidenceAsDocumentBoundary`](#getconfidenceasdocumentboundary) | Get the confidence of the quadrilateral to be a document boundary. | +| [`getConfidenceAsDocumentBoundary`](#getconfidenceasdocumentboundary) | Returns the confidence score of the detected quadrilateral's boundary, measuring the certainty that the detected quadrilateral represents the boundary of a document. | ## getConfidenceAsDocumentBoundary -Get the confidence of the quadrilateral to be a document boundary. +Returns the confidence score of the detected quadrilateral's boundary, measuring the certainty that the detected quadrilateral represents the boundary of a document. ```java int getConfidenceAsDocumentBoundary(); diff --git a/programming/android/api-reference/detected-quad-result-item.md b/programming/android/api-reference/detected-quad-result-item.md index 378f6f9..2fd8efb 100644 --- a/programming/android/api-reference/detected-quad-result-item.md +++ b/programming/android/api-reference/detected-quad-result-item.md @@ -10,7 +10,7 @@ noTitleIndex: true # DetectedQuadResultItem -The `DetectedQuadResultItem` class represents a captured result item whose type is detected quad, which contains the location and confidence as a document boundary. +The `DetectedQuadResultItem` class is an extension of the [`CapturedResultItem`]({{ site.dcv_android_api }}core/basic-structures/captured-result-item.html) that represents a detected quadrilateral. This is the most basic unit of a detected quadrilateral, one of the captured result types that the Capture Vision Router can output. ## Definition @@ -27,11 +27,11 @@ class DetectedQuadResultItem extends CapturedResultItem | Methods | Description | | ------- | ----------- | | [`getLocation`](#getlocation) | Get a Quadrilateral object as the location of current object. | -| [`getConfidenceAsDocumentBoundary`](#getconfidenceasdocumentboundary) | Get the confidence of current object as a document boundary. | +| [`getConfidenceAsDocumentBoundary`](#getconfidenceasdocumentboundary) | Returns the confidence score of the detected quadrilateral's boundary, measuring the certainty that the detected quadrilateral represents the boundary of a document. | ### getLocation -Get a Quadrilateral object as the location of current object. +Returns a [Quadrilateral]({{ site.dcv_android_api }}core/basic-structures/quadrilateral.html) object that represents the location of the detected quadrilateral within the image or frame. ```java Quadrilateral getLocation(); @@ -43,7 +43,7 @@ The location of current object. ### getConfidenceAsDocumentBoundary -Get the confidence of current object as a document boundary. +Returns the confidence score of the detected quadrilateral's boundary, measuring the certainty that the detected quadrilateral represents the boundary of a document. ```java int getConfidenceAsDocumentBoundary(); diff --git a/programming/android/api-reference/detected-quads-result.md b/programming/android/api-reference/detected-quads-result.md index df49cb6..35cafd3 100644 --- a/programming/android/api-reference/detected-quads-result.md +++ b/programming/android/api-reference/detected-quads-result.md @@ -10,7 +10,7 @@ noTitleIndex: true # DetectedQuadsResult -The `DetectedQuadsResult` class represents a captured result whose type is detected quads, which contains an array of `DetectedQuadResultItem` and the rotation transformation matrix of the original image relative to the rotated image. +The `DetectedQuadsResult` class represents a collection of [`DetectedQuadResultItems`](detected-quad-result-item.md), the basic unit of a detected quad result. ## Definition @@ -33,7 +33,7 @@ class DetectedQuadsResult ### getItems -An array of [`DetectedQuadResultItem`](./detected-quad-result-item.md), which are the detected quadrilateral items. +Returns an array of [`DetectedQuadResultItem`](./detected-quad-result-item.md), which represents the basic unit of the captured result, in this case, a detected quadrilateral. ```java DetectedQuadResultItem[] getItems(); @@ -45,7 +45,7 @@ The array of the detected quadrilateral items. ### getRotationTransformMatrix -The rotation transformation matrix of the original image relative to the rotated image. +Returns the rotation transformation matrix of the original image relative to the rotated image. Please see [Matrix](https://developer.android.com/reference/android/opengl/Matrix){:target="_blank"} for more info. ```java Matrix getRotationTransformMatrix(); @@ -57,19 +57,15 @@ The rotation transformation matrix of the original image relative to the rotated ### getOriginalImageHashId -The hash id of the original image. You can use this ID to get the original image via `IntermediateResultManager` class. +Returns the hash ID of the original image. You can use this ID to get the original image via [`IntermediateResultManager`]({{ site.dcv_android_api }}core/intermediate-results/intermediate-result-manager.html) class. ```java String getOriginalImageHashId(); ``` -**Return Value** - -The hash id of the original image. - ### getOriginalImageTag -The tag of the original image. +Returns the [`ImageTag`]({{ site.dcv_android_api }}core/basic-structures/image-tag.html) of the original image, which contains various information about the image. ```java ImageTag getOriginalImageTag(); diff --git a/programming/android/api-reference/normalized-image-result-item.md b/programming/android/api-reference/normalized-image-result-item.md index 007cdd9..a7724a5 100644 --- a/programming/android/api-reference/normalized-image-result-item.md +++ b/programming/android/api-reference/normalized-image-result-item.md @@ -10,7 +10,7 @@ noTitleIndex: true # NormalizedImageResultItem -The `NormalizedImageResultItem` class represents a captured result item whose type is a normalized image. It stores the normalized image information. +The `NormalizedImageResultItem` class is an extension of [`CapturedResultItem`]({{ site.dcv_android_api }}core/basic-structures/captured-result-item.html) that represents a normalized image. This is the most basic unit of the normalized image result, one of the captured result types that the Capture Vision Router can output. ## Definition @@ -31,7 +31,7 @@ class NormalizedImageResultItem extends CapturedResultItem ### getImageData -Gets an `ImageData` object as the normalized image. +Returns an [`ImageData`]({{ site.dcv_android_api }}core/basic-structures/image-data.html) object for the normalized image. ```java ImageData getImageData(); @@ -43,7 +43,7 @@ The `ImageData` object as the normalized image. ### getLocation -Gets the quadrilateral from which you get the normalized image result item. +Returns the [Quadrilateral]({{ site.dcv_android_api }}core/basic-structures/quadrilateral.html) that represents the location of the normalized image within the original image or frame. ```java Quadrilateral getLocation(); diff --git a/programming/android/api-reference/normalized-images-result.md b/programming/android/api-reference/normalized-images-result.md index 596a81b..7824ced 100644 --- a/programming/android/api-reference/normalized-images-result.md +++ b/programming/android/api-reference/normalized-images-result.md @@ -10,7 +10,7 @@ noTitleIndex: true # NormalizedImagesResult -The `NormalizedImagesResult` class represents a collection of captured result items whose type are normalized images. +The `NormalizedImagesResult` class represents a collection of [`NormalizedImageResultItem`](normalized-image-result-item.md), the basic unit of a normalized image result. ## Definition @@ -33,7 +33,7 @@ class NormalizedImagesResult ### getItems -Gets an array of `NormalizedImageResultItem` objects, where each object represents a single normalized image. +Returns an array of [`NormalizedImageResultItem`](normalized-image-result-item.md) objects, where each `NormalizedImageResultItem` represents a single normalized image. ```java NormalizedImageResultItem[] getItems(); @@ -45,7 +45,7 @@ The array of the normalized image result items. ### getRotationTransformMatrix -Gets the rotation transformation matrix of the original image relative to the rotated image. +Returns the rotation transformation matrix of the original image relative to the rotated image. Please see [Matrix](https://developer.android.com/reference/android/opengl/Matrix){:target="_blank"} for more info. ```java Matrix getRotationTransformMatrix(); @@ -57,7 +57,7 @@ The rotation transformation matrix of the original image relative to the rotated ### getOriginalImageHashId -Gets the hash id of the original image. You can use this ID to get the original image via `IntermediateResultManager` class. +Returns the hash ID of the original image. You can use this ID to get the original image via [`IntermediateResultManager`]({{ site.dcv_android_api }}core/intermediate-results/intermediate-result-manager.html) class. ```java String getOriginalImageHashId(); @@ -69,7 +69,7 @@ The hash id of the original image. ### getOriginalImageTag -Gets the tag of the original image. +Returns the [`ImageTag`]({{ site.dcv_android_api }}core/basic-structures/image-tag.html) of the original image, which contains various information about the image. ```java ImageTag getOriginalImageTag(); @@ -78,7 +78,3 @@ ImageTag getOriginalImageTag(); **Return Value** The tag of the original image. - -**See Also** - -* [ImageTag]({{ site.dcv_android_api }}core/basic-structures/image-tag.html) \ No newline at end of file diff --git a/programming/android/api-reference/simplified-document-normalizer-settings.md b/programming/android/api-reference/simplified-document-normalizer-settings.md index 649de04..c8e90ad 100644 --- a/programming/android/api-reference/simplified-document-normalizer-settings.md +++ b/programming/android/api-reference/simplified-document-normalizer-settings.md @@ -10,7 +10,7 @@ noTitleIndex: true # SimplifiedDocumentNormalizerSettings -The `SimplifiedDocumentNormalizerSettings` class represents the simplified document normalizer settings. +The `SimplifiedDocumentNormalizerSettings` class represents a series of simple settings related to the Document Normalizer. Please note that this is not the full list of settings that can be utilized by the Document Normalizer, which you can find on the [Dynamsoft Document Normalizer Parameters]({{ site.parameters }}reference/index.html){:target="_blank"} page. ## Definition @@ -37,7 +37,7 @@ class SimplifiedDocumentNormalizerSettings ### grayscaleTransformationModes -Defines the grayscale transformation mode with an array of [`EnumGrayscaleTransformationMode`]({{ site.dcv_enumerations }}core/grayscale-transformation-mode.html?lang=android). It controls whether to detect the inverted document boundary. +Defines the grayscale transformation modes with an array of [`EnumGrayscaleTransformationMode`]({{ site.dcv_enumerations }}core/grayscale-transformation-mode.html?lang=android) items. This parameter is important when working with inverted documents, and must be used in order to locate the inverted document boundary. ```java EnumGrayscaleTransformationMode[] grayscaleTransformationModes; @@ -45,7 +45,7 @@ EnumGrayscaleTransformationMode[] grayscaleTransformationModes; ### grayscaleEnhancementModes -Defines the grayscale enhancement mode with an array of [`EnumGrayscaleEnhancementModes`]({{ site.dcv_enumerations }}core/grayscale-enhancement-modes.html?lang=android). +Defines the grayscale enhancement modes with an array of [`EnumGrayscaleEnhancementModes`]({{ site.dcv_enumerations }}core/grayscale-enhancement-modes.html?lang=android) items. This parameter can be quite powerful in increasing the border detection rate of your application should you experience any trouble in that area. To learn more about the `grayscaleEnhancementModes` and how they can be used, please visit the main [GrayscaleEnhancementModes]({{ site.dcv_parameters }}reference/image-parameter/grayscale-enhancement-modes.html) parameter page. ```java EnumGrayscaleEnhancementMode[] grayscaleEnhancementModes; @@ -53,7 +53,7 @@ EnumGrayscaleEnhancementMode[] grayscaleEnhancementModes; ### colourMode -Defines the colour mode of the normalized image with an [`EnumImageColourMode`]({{ site.dcv_enumerations }}core/image-colour-mode.html?lang=android) member. +Defines the colour mode of the normalized image with an [`EnumImageColourMode`]({{ site.dcv_enumerations }}document-normalizer/image-colour-mode.html?lang=android) member. By default, the normalized image will output in colour. In order to make the result image grayscale or binary, setting the `colourMode` to the corresponding pixel type will do the trick. ```java EnumImageColourMode colourMode; @@ -61,7 +61,7 @@ EnumImageColourMode colourMode; ### pageSize -Defines the page size of the normalized image with the width and height in an int array. +Defines the page size of the normalized image through an integer array. ```java int[] pageSize; @@ -69,7 +69,7 @@ int[] pageSize; ### brightness -Defines the brightness of the normalized image with an integer. +Defines the brightness of the normalized image result with an integer. ```java int brightness; @@ -77,7 +77,7 @@ int brightness; ### contrast -Defines the contrast of the normalized image with an integer. +Defines the contrast of the normalized image result with an integer. ```java int contrast; @@ -85,7 +85,7 @@ int contrast; ### maxThreadsInOneTask -Defines the maximum number of threads in one task. +Defines the maximum number of threads dedicated to a single task. ```java int maxThreadsInOneTask; @@ -93,7 +93,7 @@ int maxThreadsInOneTask; ### scaleDownThreshold -Defines the scale down threshold. If the image size is larger than the scale down threshold, the image is scaled down by half. +If the original image size is quite large, then the `scaledownThreshold` can be used to shrink the image and speed up the processing. If the shorter edge size is larger than the defined scale down threshold, the library will calculate the required width and height of the image and shrink it to that size before moving forward in the process. ```java int scaleDownThreshold; diff --git a/programming/android/upgrade-instruction.md b/programming/android/upgrade-instruction.md index 68560a9..8babc7c 100644 --- a/programming/android/upgrade-instruction.md +++ b/programming/android/upgrade-instruction.md @@ -11,13 +11,13 @@ permalink: /programming/android/upgrade-instruction.html ## From version 1.x to 2.x -`DynamsoftDocumentNormalizer` SDK has been revamped to integrate with `DynamsoftCaptureVision (DCV)` architecture. To upgrade from version 1.x to 2.x, we recommend you to follow the [`User Guide`](user-guide.md) and re-write your codes. +`DynamsoftDocumentNormalizer` SDK has been revamped to integrate with `DynamsoftCaptureVision (DCV)` architecture. To upgrade from version 1.x to 2.x, we recommend that you follow the [`User Guide`](user-guide.md) and re-write your code to match what is in the guide. Here are some of the main actions you may take: ### Update the Dependencies -Since the SDK architecture is changed, you have to change your `build.gradle` for including the following libraries: +Since the SDK architecture has changed, you have to change your `build.gradle` to include the following libraries: ```groovy dependencies { @@ -31,11 +31,11 @@ dependencies { } ``` ->Note: Please view [user guide](user-guide.md#add-the-library-via-maven) for the correct version number. +>Note: Please view [user guide](user-guide.md#add-the-library-via-maven) for the most up-to-date version number. ### Migrate from Class DocumentNormalizer to Class CaptureVisionRouter -The `CaptureVisionRouter` class serves as the central class of the DCV framework's execution flow. It encompasses the following functionalities: +The `CaptureVisionRouter` class serves as the central class of DCV's execution flow. It encompasses the following functionalities: - Retrieving images from the `ImageSourceAdapter`. - Updating templates and configuring settings. @@ -44,13 +44,13 @@ The `CaptureVisionRouter` class serves as the central class of the DCV framework ### Convert Parameter Templates -The parameter system is restructured and the template you used for v1.x can't be directly recognized by the new version. Please contact us to upgrade your parameter template. +The parameter system has been restructured and the template you used for v1.x cannot be directly recognized by v2.x (and beyond). Please contact us to upgrade your parameter template. ### Update Your Codes #### Single Image Processing -You should now utilize the provided `capture` APIs instead of the previous `detectQuad` and `normalize` APIs. These `capture` APIs directly return results for boundary detection or document normalization. +You should now utilize the provided `capture` API methods instead of the previous `detectQuad` and `normalize` API methods. These `capture` API methods directly return results for boundary detection or document normalization. ```java CapturedResult capture(String filePath, String templateName) throws CaptureVisionRouterException @@ -61,12 +61,12 @@ CapturedResult capture(ImageData imageData, String templateName) throws CaptureV #### Batch Image Processing -The DCV architecture allows you to conveniently and continuously obtain frames from `CameraEnhancer`, and detect or normalize them. The key steps are as follows: +The DCV architecture allows you to conveniently and continuously obtain frames from the `CameraEnhancer`, and then detect or normalize them. The key steps are as follows: -- Set a `CameraEnhancer` object as the input of the `CaptureVisionRouter` object via `setInput` API. -- Register a `CapturedResultReceiver` object as the output of the `CaptureVisionRouter` object via `addResultReceiver` API. -- Open/Close camera via `CameraEnhancer.open` and `CameraEnhancer.close` API. -- Start/Stop capturing via `CaptureVisionRouter.startCapturing` and `CaptureVisionRouter.stopCapturing` API. +- Set a `CameraEnhancer` object as the input of the `CaptureVisionRouter` object via the `setInput` API method. +- Register a `CapturedResultReceiver` object as the output of the `CaptureVisionRouter` object via the `addResultReceiver` API method. +- Open/Close camera via `CameraEnhancer.open` and `CameraEnhancer.close` API methods. +- Start/Stop capturing via `CaptureVisionRouter.startCapturing` and `CaptureVisionRouter.stopCapturing` API methods. ```java public class MainActivity extends AppCompatActivity { diff --git a/programming/ios/api-reference/candidate-quad-edges-unit-v2.0.20.md b/programming/ios/api-reference/candidate-quad-edges-unit-v2.0.20.md index dc0608d..5a90b27 100644 --- a/programming/ios/api-reference/candidate-quad-edges-unit-v2.0.20.md +++ b/programming/ios/api-reference/candidate-quad-edges-unit-v2.0.20.md @@ -14,7 +14,7 @@ The `DSCandidateQuadEdgesUnit` class represents an intermediate result unit whos ## Definition -*Assembly:* DynamsoftDocumentNormalizer.framework +*Assembly:* DynamsoftDocumentNormalizer.xcframework
>- Objective-C diff --git a/programming/ios/api-reference/candidate-quad-edges-unit.md b/programming/ios/api-reference/candidate-quad-edges-unit.md index 8595d5f..5d84ea6 100644 --- a/programming/ios/api-reference/candidate-quad-edges-unit.md +++ b/programming/ios/api-reference/candidate-quad-edges-unit.md @@ -14,7 +14,7 @@ The `DSCandidateQuadEdgesUnit` class represents an intermediate result unit whos ## Definition -*Assembly:* DynamsoftDocumentNormalizer.framework +*Assembly:* DynamsoftDocumentNormalizer.xcframework
>- Objective-C diff --git a/programming/ios/api-reference/corners-unit-v2.0.20.md b/programming/ios/api-reference/corners-unit-v2.0.20.md index 3f95a8f..b99bb43 100644 --- a/programming/ios/api-reference/corners-unit-v2.0.20.md +++ b/programming/ios/api-reference/corners-unit-v2.0.20.md @@ -14,7 +14,7 @@ The `DSCornersUnit` class represents an intermediate result unit whose type is c ## Definition -*Assembly:* DynamsoftDocumentNormalizer.framework +*Assembly:* DynamsoftDocumentNormalizer.xcframework
>- Objective-C diff --git a/programming/ios/api-reference/corners-unit.md b/programming/ios/api-reference/corners-unit.md index 1580d25..6198bc2 100644 --- a/programming/ios/api-reference/corners-unit.md +++ b/programming/ios/api-reference/corners-unit.md @@ -14,7 +14,7 @@ The `DSCornersUnit` class represents an intermediate result unit whose type is c ## Definition -*Assembly:* DynamsoftDocumentNormalizer.framework +*Assembly:* DynamsoftDocumentNormalizer.xcframework
>- Objective-C diff --git a/programming/ios/api-reference/detected-quad-element.md b/programming/ios/api-reference/detected-quad-element.md index 1450133..97f1dad 100644 --- a/programming/ios/api-reference/detected-quad-element.md +++ b/programming/ios/api-reference/detected-quad-element.md @@ -14,7 +14,7 @@ The `DSDetectedQuadElement` class represents a detected quadrilateral element, w ## Definition -*Assembly:* DynamsoftDocumentNormalizer.framework +*Assembly:* DynamsoftDocumentNormalizer.xcframework
>- Objective-C @@ -33,11 +33,11 @@ class DetectedQuadElement: RegionObjectElement | Attributes | Type | Description | | ---------- | ---- | ----------- | -| [`confidenceAsDocumentBoundary`](#confidenceasdocumentboundary) | *NSInteger* | The confidence of the quadrilateral to be a document boundary. | +| [`confidenceAsDocumentBoundary`](#confidenceasdocumentboundary) | *NSInteger* | The confidence score of the detected quadrilateral's boundary, measuring the certainty that the detected quadrilateral represents the boundary of a document. | ## confidenceAsDocumentBoundary -The confidence of the quadrilateral to be a document boundary. +The confidence score of the detected quadrilateral's boundary, measuring the certainty that the detected quadrilateral represents the boundary of a document.
>- Objective-C diff --git a/programming/ios/api-reference/detected-quad-result-item.md b/programming/ios/api-reference/detected-quad-result-item.md index 79967ef..82de26b 100644 --- a/programming/ios/api-reference/detected-quad-result-item.md +++ b/programming/ios/api-reference/detected-quad-result-item.md @@ -10,11 +10,11 @@ noTitleIndex: true # DSDetectedQuadResultItem -The `DSDetectedQuadResultItem` class represents a captured result whose type is detected quads, which contains the location and confidence as a document boundary. +The `DetectedQuadResultItem` class is an extension of the [`DSCapturedResultItem`]({{ site.dcv_ios_api }}core/basic-structures/captured-result-item.html) that represents a detected quadrilateral. This is the most basic unit of a detected quadrilateral, one of the captured result types that the Capture Vision Router can output. ## Definition -*Assembly:* DynamsoftDocumentNormalizer.framework +*Assembly:* DynamsoftDocumentNormalizer.xcframework
>- Objective-C @@ -35,11 +35,11 @@ class DetectedQuadResultItem: CapturedResultItem | Attributes | Type | Description | | ---------- | ---- | ----------- | | [`location`](#location) | *DSQuadrilateral* | A DSQuadrilateral object as the location of current object. | -| [`confidenceAsDocumentBoundary`](#confidenceasdocumentboundary) | *NSInteger* | The confidence of current object as a document boundary. | +| [`confidenceAsDocumentBoundary`](#confidenceasdocumentboundary) | *NSInteger* | TThe confidence score of the detected quadrilateral's boundary, measuring the certainty that the detected quadrilateral represents the boundary of a document. | ### location -A DSQuadrilateral object as the location of current object. +A [DSQuadrilateral]({{ site.dcv_ios_api }}core/basic-structures/quadrilateral.html) object that represents the location of the detected quadrilateral within the image or frame.
>- Objective-C @@ -56,7 +56,7 @@ var location: DSQuadrilateral? { get } ### confidenceAsDocumentBoundary -The confidence of current object as a document boundary. +The confidence score of the detected quadrilateral's boundary, measuring the certainty that the detected quadrilateral represents the boundary of a document.
>- Objective-C diff --git a/programming/ios/api-reference/detected-quads-result.md b/programming/ios/api-reference/detected-quads-result.md index b237342..745d1e3 100644 --- a/programming/ios/api-reference/detected-quads-result.md +++ b/programming/ios/api-reference/detected-quads-result.md @@ -10,11 +10,11 @@ noTitleIndex: true # DSDetectedQuadsResult -The `DSDetectedQuadsResult` class represents a captured result whose type is detected quads, which contains an array of `DSDetectedQuadResultItems` and the rotation transformation matrix of the original image relative to the rotated image. +The `DSDetectedQuadsResult` class represents a collection of [`DSDetectedQuadResultItems`](detected-quad-result-item.md), the basic unit of a detected quad result. ## Definition -*Assembly:* DynamsoftDocumentNormalizer.framework +*Assembly:* DynamsoftDocumentNormalizer.xcframework
>- Objective-C @@ -40,7 +40,7 @@ class DetectedQuadsResult : NSObject ### items -An array of `DSDetectedQuadResultItems`, which are the basic unit of the captured results. +An array of [`DSDetectedQuadResultItems`](detected-quad-result-item.md), which represents the basic unit of the captured result, in this case, a detected quadrilateral.
>- Objective-C @@ -57,7 +57,7 @@ var items: [DSDetectedQuadResultItem]? { get } ### rotationTransformMatrix -The rotation transformation matrix of the original image relative to the rotated image. +The rotation transformation matrix of the original image relative to the rotated image. Please see [CGAffineTransform](https://developer.apple.com/documentation/corefoundation/cgaffinetransform){:target="_blank"} for more info.
>- Objective-C @@ -74,7 +74,7 @@ var rotationTransformMatrix: CGAffineTransform { get } ### originalImageHashId -The hash id of the original image. You can use this ID to get the original image via IntermediateResultManager class. +The hash ID of the original image. You can use this ID to get the original image via [`IntermediateResultManager`]({{ site.dcv_ios_api }}core/intermediate-results/intermediate-result-manager.html) class.
>- Objective-C @@ -91,7 +91,7 @@ var originalImageHashId: String { get } ### originalImageTag -The tag of the original image, from which you get the detected quads result. +The [`ImageTag`]({{ site.dcv_ios_api }}core/basic-structures/image-tag.html) of the original image, which contains various information about the image.
>- Objective-C diff --git a/programming/ios/api-reference/detected-quads-unit-v2.0.20.md b/programming/ios/api-reference/detected-quads-unit-v2.0.20.md index 808486c..fec2ee2 100644 --- a/programming/ios/api-reference/detected-quads-unit-v2.0.20.md +++ b/programming/ios/api-reference/detected-quads-unit-v2.0.20.md @@ -14,7 +14,7 @@ The `DSDetectedQuadsUnit` class represents an intermediate result unit whose typ ## Definition -*Assembly:* DynamsoftDocumentNormalizer.framework +*Assembly:* DynamsoftDocumentNormalizer.xcframework
>- Objective-C diff --git a/programming/ios/api-reference/detected-quads-unit.md b/programming/ios/api-reference/detected-quads-unit.md index 790838e..580bd99 100644 --- a/programming/ios/api-reference/detected-quads-unit.md +++ b/programming/ios/api-reference/detected-quads-unit.md @@ -14,7 +14,7 @@ The `DSDetectedQuadsUnit` class represents an intermediate result unit whose typ ## Definition -*Assembly:* DynamsoftDocumentNormalizer.framework +*Assembly:* DynamsoftDocumentNormalizer.xcframework
>- Objective-C diff --git a/programming/ios/api-reference/document-normalizer-module.md b/programming/ios/api-reference/document-normalizer-module.md index 8d959a4..eaad6b2 100644 --- a/programming/ios/api-reference/document-normalizer-module.md +++ b/programming/ios/api-reference/document-normalizer-module.md @@ -14,7 +14,7 @@ The `DSDocumentNormalizerModule` class defines general functions of the document ## Definition -*Assembly:* DynamsoftDocumentNormalizer.framework +*Assembly:* DynamsoftDocumentNormalizer.xcframework
>- Objective-C diff --git a/programming/ios/api-reference/long-lines-unit-2.0.20.md b/programming/ios/api-reference/long-lines-unit-2.0.20.md index cfdc025..0fe4407 100644 --- a/programming/ios/api-reference/long-lines-unit-2.0.20.md +++ b/programming/ios/api-reference/long-lines-unit-2.0.20.md @@ -14,7 +14,7 @@ The `DSLongLinesUnit` class represents an intermediate result unit whose type is ## Definition -*Assembly:* DynamsoftDocumentNormalizer.framework +*Assembly:* DynamsoftDocumentNormalizer.xcframework
>- Objective-C diff --git a/programming/ios/api-reference/long-lines-unit.md b/programming/ios/api-reference/long-lines-unit.md index 5f92361..68d4908 100644 --- a/programming/ios/api-reference/long-lines-unit.md +++ b/programming/ios/api-reference/long-lines-unit.md @@ -14,7 +14,7 @@ The `DSLongLinesUnit` class represents an intermediate result unit whose type is ## Definition -*Assembly:* DynamsoftDocumentNormalizer.framework +*Assembly:* DynamsoftDocumentNormalizer.xcframework
>- Objective-C diff --git a/programming/ios/api-reference/normalized-image-element.md b/programming/ios/api-reference/normalized-image-element.md index 9e1a65e..71d2b07 100644 --- a/programming/ios/api-reference/normalized-image-element.md +++ b/programming/ios/api-reference/normalized-image-element.md @@ -14,7 +14,7 @@ The `DSNormalizedImageElement` class represents an intermediate result whose typ ## Definition -*Assembly:* DynamsoftDocumentNormalizer.framework +*Assembly:* DynamsoftDocumentNormalizer.xcframework
>- Objective-C diff --git a/programming/ios/api-reference/normalized-image-result-item.md b/programming/ios/api-reference/normalized-image-result-item.md index 1ebfb24..aacb43f 100644 --- a/programming/ios/api-reference/normalized-image-result-item.md +++ b/programming/ios/api-reference/normalized-image-result-item.md @@ -10,11 +10,11 @@ noTitleIndex: true # DSNormalizedImageResultItem -The `DSNormalizedImageResultItem` class represents a captured result item whose type is a normalized image. It stores the normalized image information. +The `DSNormalizedImageResultItem` class is an extension of [`DSCapturedResultItem`]({{ site.dcv_ios_api }}core/basic-structures/captured-result-item.html) that represents a normalized image. This is the most basic unit of the normalized image result, one of the captured result types that the Capture Vision Router can output. ## Definition -*Assembly:* DynamsoftDocumentNormalizer.framework +*Assembly:* DynamsoftDocumentNormalizer.xcframework
>- Objective-C @@ -38,7 +38,7 @@ class NormalizedImageResultItem : CapturedResultItem ### imageData -A `DSImageData` object as the image data of a normalized image. +A [`DSImageData`]({{ site.dcv_ios_api }}core/basic-structures/image-data.html) object for the normalized image.
>- Objective-C @@ -55,7 +55,7 @@ var imageData: ImageData? { get } ### location -The quadrilateral from which you get the normalized image result item. +The [DSQuadrilateral]({{ site.dcv_ios_api }}core/basic-structures/quadrilateral.html) that represents the location of the normalized image within the original image or frame.
>- Objective-C diff --git a/programming/ios/api-reference/normalized-image-unit-v2.0.20.md b/programming/ios/api-reference/normalized-image-unit-v2.0.20.md index edddc48..2972226 100644 --- a/programming/ios/api-reference/normalized-image-unit-v2.0.20.md +++ b/programming/ios/api-reference/normalized-image-unit-v2.0.20.md @@ -14,7 +14,7 @@ The `DSNormalizedImagesUnit` class represents an intermediate result unit whose ## Definition -*Assembly:* DynamsoftDocumentNormalizer.framework +*Assembly:* DynamsoftDocumentNormalizer.xcframework
>- Objective-C diff --git a/programming/ios/api-reference/normalized-image-unit.md b/programming/ios/api-reference/normalized-image-unit.md index 781e8ad..e9ce4c1 100644 --- a/programming/ios/api-reference/normalized-image-unit.md +++ b/programming/ios/api-reference/normalized-image-unit.md @@ -14,7 +14,7 @@ The `DSNormalizedImagesUnit` class represents an intermediate result unit whose ## Definition -*Assembly:* DynamsoftDocumentNormalizer.framework +*Assembly:* DynamsoftDocumentNormalizer.xcframework
>- Objective-C diff --git a/programming/ios/api-reference/normalized-images-result.md b/programming/ios/api-reference/normalized-images-result.md index b772e89..fc35946 100644 --- a/programming/ios/api-reference/normalized-images-result.md +++ b/programming/ios/api-reference/normalized-images-result.md @@ -10,11 +10,11 @@ noTitleIndex: true # DSNormalizedImagesResult -The `DSNormalizedImagesResult` class represents a collection of captured result items whose type are normalized images. +The `DSNormalizedImagesResult` class represents a collection of [`DSNormalizedImageResultItem`](normalized-image-result-item.md), the basic unit of a normalized image result. ## Definition -*Assembly:* DynamsoftDocumentNormalizer.framework +*Assembly:* DynamsoftDocumentNormalizer.xcframework
>- Objective-C @@ -40,7 +40,7 @@ class NormalizedImagesResult : NSObject ### items -An array of DSNormalizedImageResultItem. Each DSNormalizedImageResultItem is a result object of a single normalized image. +An array of [`DSNormalizedImageResultItem`](normalized-image-result-item.md), where each `DSNormalizedImageResultItem` represents a single normalized image.
>- Objective-C @@ -57,7 +57,7 @@ var items: [DSNormalizedImageResultItem]? { get } ### rotationTransformMatrix -The rotation transformation matrix of the original image relative to the rotated image. +The rotation transformation matrix of the original image relative to the rotated image. Please see [CGAffineTransform](https://developer.apple.com/documentation/corefoundation/cgaffinetransform){:target="_blank"} for more info.
>- Objective-C @@ -74,7 +74,7 @@ var rotationTransformMatrix: CGAffineTransform { get } ### originalImageHashId -The hash id of the original image. You can use this ID to get the original image via IntermediateResultManager class. +The hash ID of the original image. You can use this ID to get the original image via [`IntermediateResultManager`]({{ site.dcv_ios_api }}core/intermediate-results/intermediate-result-manager.html) class.
>- Objective-C @@ -91,7 +91,7 @@ var originalImageHashId: String { get } ### originalImageTag -The tag of the original image, from which you get the normalized image. +The [`ImageTag`]({{ site.dcv_ios_api }}core/basic-structures/image-tag.html) of the original image, which contains various information about the image.
>- Objective-C diff --git a/programming/ios/api-reference/simplified-document-normalizer-settings.md b/programming/ios/api-reference/simplified-document-normalizer-settings.md index 9eb34d2..3da996f 100644 --- a/programming/ios/api-reference/simplified-document-normalizer-settings.md +++ b/programming/ios/api-reference/simplified-document-normalizer-settings.md @@ -10,11 +10,11 @@ noTitleIndex: true # DSSimplifiedDocumentNormalizerSettings -The `DSSimplifiedDocumentNormalizerSettings` class represents the simplified document normalizer settings. +The `DSSimplifiedDocumentNormalizerSettings` class represents a series of simple settings related to the Document Normalizer. Please note that this is not the full list of settings that can be utilized by the Document Normalizer, which you can find on the [Dynamsoft Document Normalizer Parameters]({{ site.parameters }}reference/index.html){:target="_blank"} page. ## Definition -*Assembly:* DynamsoftDocumentNormalizer.framework +*Assembly:* DynamsoftDocumentNormalizer.xcframework
>- Objective-C @@ -44,7 +44,7 @@ class SimplifiedDocumentNormalizerSettings: NSObject ### grayscaleTransformationModes -Defines the grayscale transformation mode with an array of [`DSGrayscaleTransformationMode`]({{ site.dcv_enumerations }}core/grayscale-transformation-mode.html?lang=objc,swift). It controls whether to detect the inverted document boundary. +Defines the grayscale transformation modes with an array of [`DSGrayscaleTransformationMode`]({{ site.dcv_enumerations }}core/grayscale-transformation-mode.html?lang=objc,swift) items. This parameter is important when working with inverted documents, and must be used in order to locate the inverted document boundary.
>- Objective-C @@ -61,7 +61,7 @@ var grayscaleTransformationModes: [NSNumber]? { get set } ### grayscaleEnhancementModes -Defines the grayscale enhancement mode with an array of [`DSGrayscaleEnhancementModes`]({{ site.dcv_enumerations }}core/grayscale-enhancement-modes.html?lang=objc,swift). +Defines the grayscale enhancement modes with an array of [`DSGrayscaleEnhancementModes`]({{ site.dcv_enumerations }}core/grayscale-enhancement-modes.html?lang=objc,swift) items. This parameter can be quite powerful in increasing the border detection rate of your application should you experience any trouble in that area. To learn more about the `grayscaleEnhancementModes` and how they can be used, please visit the main [GrayscaleEnhancementModes]({{ site.dcv_parameters }}reference/image-parameter/grayscale-enhancement-modes.html) parameter page.
>- Objective-C @@ -78,7 +78,7 @@ var grayscaleEnhancementModes: [NSNumber]? { get set } ### colourMode -Defines the colour mode of the normalized image with a [`DSImageColourMode`]({{ site.dcv_enumerations }}core/image-colour-mode.html?lang=objc,swift) member. +Defines the colour mode (pixel type) of the normalized image with a [`DSImageColourMode`]({{ site.dcv_enumerations }}document-normalizer/image-colour-mode.html?lang=objc,swift) member. By default, the normalized image will output in colour. In order to make the result image grayscale or binary, setting the `colourMode` to the corresponding pixel type will do the trick.
>- Objective-C @@ -95,7 +95,7 @@ var colourMode: ImageColourMode { get set } ### pageSize -Defines the page size of the normalized image with a [`CGSize`]({{ site.dcv_structs }}core/size.html?lang=objc,swift) object. +Defines the page size of the normalized image with a [`CGSize`](https://developer.apple.com/documentation/corefoundation/cgsize){:target="_blank"} object.
>- Objective-C @@ -112,7 +112,7 @@ var pageSize: CGSize { get set } ### brightness -Defines the brightness of the normalized image with an integer. +Defines the brightness of the normalized image result with an integer.
>- Objective-C @@ -129,7 +129,7 @@ var brightness: Int { get set } ### contrast -Defines the contrast of the normalized image with an integer. +Defines the contrast of the normalized image result with an integer.
>- Objective-C @@ -146,7 +146,7 @@ var contrast: Int { get set } ### maxThreadsInOneTask -Defines the maximum number of threads in one task. +Defines the maximum number of threads dedicated to a single task.
>- Objective-C @@ -163,7 +163,7 @@ var maxThreadsInOneTask: Int { get set } ### scaleDownThreshold -Defines the scale down threshold. If the image size is larger than the scale down threshold, the image is scaled down by half. +If the original image size is quite large, then the `scaledownThreshold` can be used to shrink the image and speed up the processing. If the shorter edge size is larger than the defined scale down threshold, the library will calculate the required width and height of the image and shrink it to that size before moving forward in the process.
>- Objective-C diff --git a/programming/ios/release-notes/ios-2.md b/programming/ios/release-notes/ios-2.md index 05fd0b8..35bbed0 100644 --- a/programming/ios/release-notes/ios-2.md +++ b/programming/ios/release-notes/ios-2.md @@ -36,7 +36,7 @@ permalink: /programming/ios/release-notes/ios-2.html - Added `ReferenceXAxis` & `ReferenceYAxis` to define the X & Y axis. - Modified `FirstPoint`, `SecondPoint`, `ThirdPoint` & `FourthPoint`. You can specify whether the X or Y coordinate of the point is measured by percentage. - Deprecated `ReferenceObjectSize` Type. -- The following classes are migrated from `DynamsoftCore.framework` into `DynamsoftCaptureVision.framework`: +- The following classes are migrated from `DynamsoftCore.xcframework` into `DynamsoftCaptureVision.xcframework`: - [`DSCapturedResult`]({{ site.dcv_ios_api }}capture-vision-router/auxiliary-classes/captured-result.html) - [`DSIntermediateResultReceiver`]({{ site.dcv_ios_api }}capture-vision-router/auxiliary-classes/intermediate-result-receiver.html) - [`DSCapturedResultReceiver`]({{ site.dcv_ios_api }}capture-vision-router/auxiliary-classes/captured-result-receiver.html) @@ -44,7 +44,7 @@ permalink: /programming/ios/release-notes/ios-2.html - [`DSIntermediateResultManager`]({{ site.dcv_ios_api }}capture-vision-router/auxiliary-classes/intermediate-result-manager.html) - Added a new call back method [`onShortLinesUnitReceived`]({{ site.dcv_ios_api }}capture-vision-router/auxiliary-classes/intermediate-result-receiver.html#onshortlinesunitreceived) to the [`DSIntermediateResultReceiver`]({{ site.dcv_ios_api }}capture-vision-router/auxiliary-classes/intermediate-result-receiver.html) class. - Added methods [`pauseCapturing`]({{ site.dcv_ios_api }}capture-vision-router/multiple-file-processing.html#pausecapturing) and [`resumeCapturing`]({{ site.dcv_ios_api }}capture-vision-router/multiple-file-processing.html#resumecapturing). Two new enumeration members, `CapturedStatePaused` and `CapturedStateResumed`, are added to [`DSCapturedState`]({{ site.dcv_enumerations }}capture-vision-router/capture-state.html?lang=objc,swift) as well. -- Added a new property [`documentSettings`]({{ site.dcv_ios_api }}capture-vision-router/auxiliary-classes/simplified-capture-vision-settings.html#documentsettings) to class [`DSSimplifiedCaptureVisionSettings`]({{ site.dcv_ios_api }}capture-vision-router/auxiliary-classes/simplified-capture-vision-settings.html). The corresponding class [`DSSimplifiedDocumentNormalizerSettings`]({{ site.ddn_ios_api }}simplified-document-normalizer-settings.html) is added to the `DynamsoftDocumentNormalizer.framework` to store the `documentSettings`. +- Added a new property [`documentSettings`]({{ site.dcv_ios_api }}capture-vision-router/auxiliary-classes/simplified-capture-vision-settings.html#documentsettings) to class [`DSSimplifiedCaptureVisionSettings`]({{ site.dcv_ios_api }}capture-vision-router/auxiliary-classes/simplified-capture-vision-settings.html). The corresponding class [`DSSimplifiedDocumentNormalizerSettings`]({{ site.ddn_ios_api }}simplified-document-normalizer-settings.html) is added to the `DynamsoftDocumentNormalizer.xcframework` to store the `documentSettings`. - Added a new property [`resultUnitTypesOnlyForInput`]({{ site.dcv_ios_api }}core/intermediate-results/observation-parameters.html#resultunittypesonlyforinput) to the `ObservationParameters` class to specify the `input only` result unit. - Added the following methods to the [`RegionObjectElement`]({{ site.dcv_ios_api }}core/intermediate-results/region-object-element.html) class to support the intermediate result modification. - `setLocation` diff --git a/programming/ios/upgrade-instruction.md b/programming/ios/upgrade-instruction.md index 2e31c0c..8e10fb9 100644 --- a/programming/ios/upgrade-instruction.md +++ b/programming/ios/upgrade-instruction.md @@ -11,13 +11,13 @@ permalink: /programming/ios/upgrade-instruction.html ## From version 1.x to 2.x -`DynamsoftDocumentNormalizer` SDK has been revamped to integrate with `DynamsoftCaptureVision (DCV)` architecture. To upgrade from version 1.x to 2.x, we recommend you to follow the [`User Guide`](user-guide.md) and re-write your codes. +`DynamsoftDocumentNormalizer` SDK has been revamped to integrate with `DynamsoftCaptureVision (DCV)` architecture. To upgrade from version 1.x to 2.x, we recommend that you follow the [`User Guide`](user-guide.md) and re-write your code to match what is in the guide. Here are some of the main actions you may take: ### Update the Dependencies -Since the SDK architecture is changed, you have to change your `Podfile` for including the following libraries: +Since the SDK architecture has changed, you have to change your `Podfile` to include the following libraries: ```sh pod 'DynamsoftCaptureVisionRouter','{version-number}' @@ -29,11 +29,11 @@ pod 'DynamsoftImageProcessing','{version-number}' pod 'DynamsoftUtility','{version-number}' ``` ->Note: Please view [user guide](user-guide.md#add-the-frameworks-via-cocoapodsn) for the correct version number. +>Note: Please view [user guide](user-guide.md#add-the-frameworks-via-cocoapodsn) for the most up-to-date version number. ### Migrate from Class DynamsoftDocumentNormalizer to Class DSCaptureVisionRouter -The `DSCaptureVisionRouter` class serves as the central class of the DCV framework's execution flow. It encompasses the following functionalities: +The `DSCaptureVisionRouter` class serves as the central class of DCV's execution flow. It encompasses the following functionalities: - Retrieving images from the `DSImageSourceAdapter`. - Updating templates and configuring settings. @@ -42,13 +42,13 @@ The `DSCaptureVisionRouter` class serves as the central class of the DCV framewo ### Convert Parameter Templates -The parameter system is restructured and the template you used for v1.x can't be directly recognized by the new version. Please contact us to upgrade your parameter template. +The parameter system has been restructured and the template you used for v1.x cannot be directly recognized by v2.x (and beyond). Please contact us to upgrade your parameter template. -### Update Your Codes +### Update the Code #### Single Image Processing -You should now utilize the provided multiple `capture` APIs instead of the previous `detectQuad` and `normalize` APIs. These `capture` APIs directly return results for boundary detection or document normalization. +You should now utilize the provided multiple `capture` API methods instead of the previous `detectQuad` and `normalize` API methods. These `capture` API methods directly return results for boundary detection or document normalization.
>- Objective-C @@ -71,20 +71,20 @@ You should now utilize the provided multiple `capture` APIs instead of the previ ``` 2. ```swift -func captureFromFile(_ file:String, templateName:String) throws -> CaptureResult -func captureFromFileBytes(_ fileBytes:Data, templateName:String) throws -> CaptureResult -func captureFromBuffer(_ buffer:DSImageData, templateName:String) throws -> CaptureResult -func captureFromImage(_ image:UIImage, templateName:String) throws -> CaptureResult +func captureFromFile(_ file:String, templateName:String) throws -> CapturedResult +func captureFromFileBytes(_ fileBytes:Data, templateName:String) throws -> CapturedResult +func captureFromBuffer(_ buffer:DSImageData, templateName:String) throws -> CapturedResult +func captureFromImage(_ image:UIImage, templateName:String) throws -> CapturedResult ``` #### Batch Image Processing -The DCV architecture allows you to conveniently and continuously obtain frames from `DSCameraEnhancer`, and detect or normalize them. The key steps are as follows: +The DCV architecture allows you to conveniently and continuously obtain frames from the `DSCameraEnhancer`, and then detect or normalize them. The key steps are as follows: -- Set a `DSCameraEnhancer` object as the input of the `DSCaptureVisionRouter` object via `setInput` API. -- Register a `DSCapturedResultReceiver` object as the output of the `DSCaptureVisionRouter` object via `addResultReceiver` API. -- Open/Close camera via `DSCameraEnhancer.open` and `DSCameraEnhancer.close` API. -- Start/Stop capturing via `DSCaptureVisionRouter.startCapturing` and `DSCaptureVisionRouter.stopCapturing` API. +- Set a `DSCameraEnhancer` object as the input of the `DSCaptureVisionRouter` object via the `setInput` API method. +- Register a `DSCapturedResultReceiver` object as the output of the `DSCaptureVisionRouter` object via the `addResultReceiver` API method. +- Open/Close camera via `DSCameraEnhancer.open` and `DSCameraEnhancer.close` API methods. +- Start/Stop capturing via `DSCaptureVisionRouter.startCapturing` and `DSCaptureVisionRouter.stopCapturing` API methods.
>- Objective-C