diff --git a/programming/java/api-reference/candidate-quad-edges-unit.md b/programming/java/api-reference/candidate-quad-edges-unit.md new file mode 100644 index 0000000..c7c96ae --- /dev/null +++ b/programming/java/api-reference/candidate-quad-edges-unit.md @@ -0,0 +1,156 @@ +--- +layout: default-layout +title: CandidateQuadEdgesUnit Class +description: This page shows CandidateQuadEdgesUnit class definition of Dynamsoft Document Normalizer SDK Java Edition. +keywords: getCount, getCandidateQuadEdge, CandidateQuadEdgesUnit, api reference +--- + +# CandidateQuadEdgesUnit Class + +The `CandidateQuadEdgesUnit` class represents an intermediate result unit whose type is candidate quad edges. + +## Definition + +*Package:* com.dynamsoft.ddn.intermediate_results + +```java +public class CandidateQuadEdgesUnit extends IntermediateResultUnit +``` + +*Inheritance:* [IntermediateResultUnit]({{ site.dcvb_java_api }}core/intermediate-results/intermediate-result-unit.html) -> CandidateQuadEdgesUnit + +## Methods + +| Method | Description | +|--------|-------------| +| [`getCount`](#getcount) | Gets the count of `Edge` objects in current object.| +| [`getCandidateQuadEdge`](#getcandidatequadedge) | Gets an `Edge` object from current object by specifying a index. | +| [`getCandidateQuadEdges`](#getcandidatequadedges) | Gets all `Edge` objects in current object. | +| [`removeAllCandidateQuadEdges`](#removeallcandidatequadedges) | Removes all the candidate quad edges in current object. | +| [`removeCandidateQuadEdge`](#removecandidatequadedge) | Removes a candidate quad edge from current object by specifying an index. | +| [`addCandidateQuadEdge`](#addcandidatequadedge) | Adds a candidate quad edge to current object. | +| [`setCandidateQuadEdge`](#setcandidatequadedge) | Sets the candidate quad edge at the specified index. | + +### getCount + +Gets the count of `Edge` objects in current object. + +```java +public int getCount() +``` + +**Return Value** + +The count of `Edge` objects in current object. + +### getCandidateQuadEdge + +Gets an `Edge` object from current object by specifying a index. + +```java +public Edge getCandidateQuadEdge(int index) throws DocumentNormalizerException +``` + +**Parameters** + +`index` The index of the `Edge` object. + +**Return Value** + +Returns the `Edge` object got by the specific index. + +**Exceptions** + +[`DocumentNormalizerException`](document-normalizer-exception.html) + +**See Also** + +[Edge]({{ site.dcvb_java_api }}core/basic-classes/edge.html) + +### getCandidateQuadEdges + +Gets all `Edge` objects in current object. + +```java +public Edge[] getCandidateQuadEdges() +``` + +**Return Value** + +Returns an array of `Edge` objects. + +**See Also** + +[Edge]({{ site.dcvb_java_api }}core/basic-classes/edge.html) + +### removeAllCandidateQuadEdges + +Removes all the candidate quad edges in current object. + +```java +public void removeAllCandidateQuadEdges() +``` + +### removeCandidateQuadEdge + +Removes a candidate quad edge from current object by specifying an index. + +```java +public void removeCandidateQuadEdge(int index) throws DocumentNormalizerException +``` + +**Parameters** + +`index` The index of the candidate quad edge to be removed. + +**Exceptions** + +[`DocumentNormalizerException`](document-normalizer-exception.html) + +### addCandidateQuadEdge + +Adds a candidate quad edge to current object. + +```java +public void addCandidateQuadEdge(Edge edge) throws DocumentNormalizerException +public void addCandidateQuadEdge(Edge edge, double[] matrixToOriginalImage) throws DocumentNormalizerException +``` + +**Parameters** + +`edge` The candidate quad edge to be added. + +`matrixToOriginalImage` The matrix to the original image. + +**Exceptions** + +[`DocumentNormalizerException`](document-normalizer-exception.html) + +**See Also** + +[Edge]({{ site.dcvb_java_api }}core/basic-classes/edge.html) + +### setCandidateQuadEdge + +Sets the candidate quad edge at the specified index. + +```java +public void setCandidateQuadEdge(int index, Edge edge) throws DocumentNormalizerException +public void setCandidateQuadEdge(int index, Edge edge, double[] matrixToOriginalImage) throws DocumentNormalizerException +``` + +**Parameters** + +`index` The index of the candidate quad edge to be set. + +`edge` The candidate quad edge to be added. + +`matrixToOriginalImage` The matrix to the original image. + +**Exceptions** + +[`DocumentNormalizerException`](document-normalizer-exception.html) + +**See Also** + +[Edge]({{ site.dcvb_java_api }}core/basic-classes/edge.html) diff --git a/programming/java/api-reference/corners-unit.md b/programming/java/api-reference/corners-unit.md new file mode 100644 index 0000000..15b1f4f --- /dev/null +++ b/programming/java/api-reference/corners-unit.md @@ -0,0 +1,162 @@ +--- +layout: default-layout +title: CornersUnit Class +description: This page shows CornersUnit class definition of Dynamsoft Document Normalizer SDK Java Edition. +keywords: getCount, getCorner, CornersUnit, api reference +--- + +# CornersUnit Class + +The `CornersUnit` class represents an intermediate result unit whose type is corners. + +## Definition + +*Package:* com.dynamsoft.ddn.intermediate_results + +```java +public class CornersUnit extends IntermediateResultUnit +``` + +*Inheritance:* [IntermediateResultUnit]({{ site.dcvb_java_api }}core/intermediate-results/intermediate-result-unit.html) -> CornersUnit + +## Methods + +| Method | Description | +|--------|-------------| +| [`getCount`](#getcount) | Gets the count of `Corner` objects in current object.| +| [`getCorner`](#getcorner) | Gets a `Corner` object from current object by specifying a index. | +| [`getCorners`](#getcorners) | Gets all `Corner` objects in current object. | +| [`removeAllCorners`](#removeallcorners) | Removes all the corners in current object. | +| [`removeCorner`](#removecorner) | Removes a corner from current object by specifying an index. | +| [`addCorner`](#addcorner) | Adds a corner to current object. | +| [`setCorner`](#setcorner) | Sets the corner at the specified index. | + +### getCount + +Gets the count of `Corner` objects in current object. + +```java +public int getCount() +``` + +**Return Value** + +The count of `Corner` objects in current object. + +### getCorner + +Gets a `Corner` object from current object by specifying a index. + +```java +public Corner getCorner(int index) throws DocumentNormalizerException +``` +``` + +**Parameters** + +`index` The index of the `Corner` object. + +**Return Value** + +Returns the `Corner` object got by the specific index. + +**Exceptions** + +[`DocumentNormalizerException`](document-normalizer-exception.html) + +**See Also** + +[Corner]({{ site.dcvb_java_api }}core/basic-classes/corner.html) + +### getCorners + +Gets all `Corner` objects in current object. + +```java +public Corner[] getCorners() +``` + +**Return Value** + +Returns an array of `Corner` objects. + +**See Also** + +[Corner]({{ site.dcvb_java_api }}core/basic-classes/corner.html) + +### removeAllCorners + +Removes all the corners in current object. + +```java +public void removeAllCorners() throws DocumentNormalizerException +``` + +**Exceptions** + +[`DocumentNormalizerException`](document-normalizer-exception.html) + +### removeCorner + +Removes a corner from current object by specifying an index. + +```java +public void removeCorner(int index) throws DocumentNormalizerException +``` + +**Parameters** + +`index` The index of the corner to be removed. + +**Exceptions** + +[`DocumentNormalizerException`](document-normalizer-exception.html) + +### addCorner + +Adds a corner to current object. + +```java +public void addCorner(Corner corner) throws DocumentNormalizerException +public void addCorner(Corner corner, double[] matrixToOriginalImage) throws DocumentNormalizerException +``` + +**Parameters** + +`corner` The corner to be added. + +`matrixToOriginalImage` The matrix to the original image. + +**Exceptions** + +[`DocumentNormalizerException`](document-normalizer-exception.html) + +**See Also** + +[Corner]({{ site.dcvb_java_api }}core/basic-classes/corner.html) + +### setCorner + +Sets the corner at the specified index. + +```java +public void setCorner(int index, Corner corner) throws DocumentNormalizerException +public void setCorner(int index, Corner corner, double[] matrixToOriginalImage) throws DocumentNormalizerException +``` + +**Parameters** + +`index` The index of the corner to be set. + +`corner` The corner to be added. + +`matrixToOriginalImage` The matrix to the original image. + +**Exceptions** + +[`DocumentNormalizerException`](document-normalizer-exception.html) + +**See Also** + +[Corner]({{ site.dcvb_java_api }}core/basic-classes/corner.html) + diff --git a/programming/java/api-reference/deskewed-image-element.md b/programming/java/api-reference/deskewed-image-element.md new file mode 100644 index 0000000..655a0da --- /dev/null +++ b/programming/java/api-reference/deskewed-image-element.md @@ -0,0 +1,80 @@ +--- +layout: default-layout +title: DeskewedImageElement Class +description: This page shows DeskewedImageElement class definition of Dynamsoft Document Normalizer SDK Java Edition. +keywords: setImageData, getSourceDeskewQuad, DeskewedImageElement, api reference +--- + +# DeskewedImageElement Class + +The `DeskewedImageElement` class stores an intermediate result whose type is Deskewed image. + +## Definition + +*Package:* com.dynamsoft.ddn.intermediate_results + +```java +public class DeskewedImageElement extends RegionObjectElement +``` + +*Inheritance:* [RegionObjectElement]({{ site.dcvb_java_api }}core/intermediate-results/region-object-element.html) -> DeskewedImageElement + +## Methods + +| Method | Description | +|--------|-------------| +| [`DeskewedImageElement`](#deskewedimageelement) | Initializes a new instance of the `DeskewedImageElement` class. | +| [`setImageData`](#setimagedata) | Sets the image data of the deskewed image element. | +| [`getSourceDeskewQuad`](#getsourcedeskewquad) | Gets the quadrilateral used for deskewing the image. | + +### DeskewedImageElement + +Initializes a new instance of the `DeskewedImageElement` class. + +```java +public DeskewedImageElement() +``` + +### setImageData + +Sets the image data of the deskewed image element. + +```java +public void setImageData(ImageData imageData) throws DocumentNormalizerException +``` + +**Parameters** + +`imageData` The image data to set. + +**Exceptions** + +[`DocumentNormalizerException`](document-normalizer-exception.html) + +**See Also** + +* [ImageData]({{ site.dcvb_java_api }}core/basic-classes/image-data.html) + +### getSourceDeskewQuad + +Gets the quadrilateral used for deskewing the image. + +```java +public Quadrilateral getSourceDeskewQuad() +``` + +**Return Value** + +A `Quadrilateral` object representing the four corners of the quadrilateral used to deskew the image. + +**See Also** + +* [Quadrilateral]({{ site.dcvb_java_api }}core/basic-classes/quadrilateral.html) + +**Return Value** + +Returns A `Quadrilateral` object representing the four corners of the quadrilateral used to deskew the image. + +**See Also** + +* [Quadrilateral]({{ site.dcvb_python_api }}core/basic-classes/quadrilateral.html) diff --git a/programming/java/api-reference/deskewed-image-result-item.md b/programming/java/api-reference/deskewed-image-result-item.md new file mode 100644 index 0000000..11ba393 --- /dev/null +++ b/programming/java/api-reference/deskewed-image-result-item.md @@ -0,0 +1,89 @@ +--- +layout: default-layout +title: DeskewedImageResultItem Class +description: This page shows DeskewedImageResultItem class definition of Dynamsoft Document Normalizer SDK Java Edition. +keywords: getImageData, getSourceDeskewQuad, getCrossVerificationStatus, getOriginalToLocalMatrix, DeskewedImageResultItem, api reference +--- + +# DeskewedImageResultItem Class + +The `DeskewedImageResultItem` class stores a captured result item whose type is Deskewed image. + +## Definition + +*Package:* com.dynamsoft.ddn + +```java +public class DeskewedImageResultItem extends CapturedResultItem +``` + +*Inheritance:* [CapturedResultItem]({{ site.dcvb_java_api }}core/basic-classes/captured-result-item.html) -> DeskewedImageResultItem + +## Methods + +| Method | Description | +|--------|-------------| +| [`getImageData`](#getimagedata) | Gets the ImageData of current object. | +| [`getSourceDeskewQuad`](#getsourcedeskewquad)| Gets the quadrilateral used for deskewing the image. | +| [`getCrossVerificationStatus`](#getcrossverificationstatus)| Gets the status of current object as a verified deskewed image. | +| [`getOriginalToLocalMatrix`](#getoriginaltolocalmatrix) | Gets the transformation matrix from the original image coordinate system to the local coordinate system. | + +### getImageData + +Gets the ImageData of current object. + +```java +public ImageData getImageData() +``` + +**Return Value** + +The image data. + +**See Also** + +* [ImageData]({{ site.dcvb_java_api }}core/basic-classes/image-data.html) + +### getSourceDeskewQuad + +Gets the quadrilateral used for deskewing the image. + +```java +public Quadrilateral getSourceDeskewQuad() +``` + +**Return Value** + +A `Quadrilateral` object representing the four corners of the quadrilateral used to deskew the image. + +**See Also** + +* [Quadrilateral]({{ site.dcvb_java_api }}core/basic-classes/quadrilateral.html) + +### getCrossVerificationStatus + +Gets the status of current object as a verified deskewed image. + +```java +public @EnumCrossVerificationStatus int getCrossVerificationStatus() +``` + +**Return Value** + +Return the status of current object as a verified deskewed image. + +**See Also** + +[EnumCrossVerificationStatus]({{ site.dcvb_java_api }}core/enum-cross-verification-status.html) + +### getOriginalToLocalMatrix + +Gets the transformation matrix from the original image coordinate system to the local coordinate system. + +```java +public double[] getOriginalToLocalMatrix() +``` + +**Return Value** + +A double array of size 9, representing the 3x3 transformation matrix that converts coordinates from the original image to the local image. \ No newline at end of file diff --git a/programming/java/api-reference/deskewed-image-unit.md b/programming/java/api-reference/deskewed-image-unit.md new file mode 100644 index 0000000..e41c641 --- /dev/null +++ b/programming/java/api-reference/deskewed-image-unit.md @@ -0,0 +1,66 @@ +--- +layout: default-layout +title: DeskewedImageUnit Class +description: This page shows DeskewedImageUnit class definition of Dynamsoft Document Normalizer SDK Java Edition. +keywords: getDeskewedImage, setDeskewedImage, DeskewedImageUnit, api reference +--- + +# DeskewedImageUnit Class + +The `DeskewedImageUnit` class represents an intermediate result unit whose type is Deskewed images. + +## Definition + +*Package:* com.dynamsoft.ddn.intermediate_results + +```java +public class DeskewedImageUnit extends IntermediateResultUnit +``` + +*Inheritance:* [IntermediateResultUnit]({{ site.dcvb_java_api }}core/intermediate-results/intermediate-result-unit.html) -> DeskewedImageUnit + +## Methods + +| Method | Description | +|--------|-------------| +| [`getDeskewedImage`](#getdeskewedimage) | Gets a `DeskewedImageElement` object from current object. | +| [`setDeskewedImage`](#setdeskewedimage) | Sets the deskewed image. | + +### getDeskewedImage + +Gets a `DeskewedImageElement` object from current unit. + +```java +public DeskewedImageElement getDeskewedImage() +``` + +**Return Value** + +Returns the `DeskewedImageElement` object. + +**See Also** + +* [DeskewedImageElement]({{ site.ddn_java_api }}deskewed-image-element.html) + +### setDeskewedImage + +Sets the deskewed image. + +```java +public void setDeskewedImage(DeskewedImageElement element) throws DocumentNormalizerException +public void setDeskewedImage(DeskewedImageElement element, double[] matrixToOriginalImage) throws DocumentNormalizerException +``` + +**Parameters** + +`element` The deskewed image to be set. + +`matrixToOriginalImage` The matrix to original image. + +**Exceptions** + +[`DocumentNormalizerException`](document-normalizer-exception.html) + +**See Also** + +* [DeskewedImageElement]({{ site.ddn_java_api }}deskewed-image-element.html) diff --git a/programming/java/api-reference/detected-quad-element.md b/programming/java/api-reference/detected-quad-element.md new file mode 100644 index 0000000..e024ec7 --- /dev/null +++ b/programming/java/api-reference/detected-quad-element.md @@ -0,0 +1,68 @@ +--- +layout: default-layout +title: DetectedQuadElement Class +description: This page shows DetectedQuadElement class definition of Dynamsoft Document Normalizer SDK Java Edition. +keywords: getConfidenceAsDocumentBoundary, DetectedQuadElement, api reference +--- + +# DetectedQuadElement Class + +The `DetectedQuadElement` class stores an intermediate result whose type is detected quad. + +## Definition + +*Package:* com.dynamsoft.ddn.intermediate_results + +```java +public class DetectedQuadElement extends RegionObjectElement +``` + +*Inheritance:* [RegionObjectElement]({{ site.dcvb_java_api }}core/intermediate-results/region-object-element.html) -> DetectedQuadElement + +## Methods + +| Method | Description | +|--------|-------------| +| [`DetectedQuadElement`](#detectedquadelement) | Initializes a new instance of the `DetectedQuadElement` class. | +| [`getConfidenceAsDocumentBoundary`](#getconfidenceasdocumentboundary) | Gets the confidence as document boundary of current object. | +| [`setLocation`](#setlocation) | Sets the location of the detected quad element. | + +### DetectedQuadElement + +Initializes a new instance of the `DetectedQuadElement` class. + +```java +public DetectedQuadElement() +``` + +### getConfidenceAsDocumentBoundary + +Gets the confidence as document boundary of current object. + +```java +public int getConfidenceAsDocumentBoundary() +``` + +**Return Value** + +The confidence as document boundary of current object. + +### setLocation + +Sets the location of the detected quad element. + +```java +public void setLocation(Quadrilateral location) throws DocumentNormalizerException +``` + +**Parameters** + +`location` The location of the detected quad element. + +**Exceptions** + +[`DocumentNormalizerException`](document-normalizer-exception.html) + +**See Also** + +* [Quadrilateral]({{ site.dcvb_java_api }}core/basic-classes/quadrilateral.html) diff --git a/programming/java/api-reference/detected-quad-result-item.md b/programming/java/api-reference/detected-quad-result-item.md new file mode 100644 index 0000000..5cfaf6a --- /dev/null +++ b/programming/java/api-reference/detected-quad-result-item.md @@ -0,0 +1,73 @@ +--- +layout: default-layout +title: DetectedQuadResultItem Class - Dynamsoft Document Normalizer Module Java Edition API Reference +description: Definition of DetectedQuadResultItem class in Dynamsoft Document Normalizer Module Java Edition. +keywords: getLocation, getConfidenceAsDocumentBoundary, DetectedQuadResultItem, api reference +--- + +# DetectedQuadResultItem Class + +The `DetectedQuadResultItem` class stores a captured result whose type is detected quad. + +## Definition + +*Package:* com.dynamsoft.ddn + +```java +public class DetectedQuadResultItem extends CapturedResultItem +``` + +*Inheritance:* [CapturedResultItem]({{ site.dcvb_java_api }}core/basic-classes/captured-result-item.html) -> DetectedQuadResultItem + +## Methods + +| Method | Description | +|--------|-------------| +| [`getLocation`](#getlocation) | Gets the location of current object. | +| [`getConfidenceAsDocumentBoundary`](#getconfidenceasdocumentboundary) | Gets the confidence of current object as a document boundary. | +| [`getCrossVerificationStatus`](#getcrossverificationstatus) | Gets the status of current object as a verified document boundary. | + +### getLocation + +Gets the location of current object. + +```java +public Quadrilateral getLocation() +``` + +**Return Value** + +The location of current object. + +**See Also** + +[Quadrilateral]({{ site.dcvb_java_api }}core/basic-classes/quadrilateral.html) + +### getConfidenceAsDocumentBoundary + +Gets the confidence of current object as a document boundary. + +```java +public int getConfidenceAsDocumentBoundary() +``` + +**Return Value** + +The confidence as document boundary of the detected quad result. + +### getCrossVerificationStatus + +Gets the status of current object as a verified document boundary. + +```java +public @EnumCrossVerificationStatus int getCrossVerificationStatus() +``` + +**Return Value** + +The status of current object as a verified document boundary. + +**See Also** + +[EnumCrossVerificationStatus]({{ site.dcvb_java_api }}core/enum-cross-verification-status.html) + diff --git a/programming/java/api-reference/detected-quads-result.md b/programming/java/api-reference/detected-quads-result.md new file mode 100644 index 0000000..cb79cc3 --- /dev/null +++ b/programming/java/api-reference/detected-quads-result.md @@ -0,0 +1,114 @@ +--- +layout: default-layout +title: DetectedQuadsResult Class - Dynamsoft Document Normalizer Module Java Edition API Reference +description: Definition of DetectedQuadsResult class in Dynamsoft Document Normalizer Module Java Edition. +keywords: getItems, getErrorCode, getErrorString, getOriginalImageHashId, getOriginalImageTag, DetectedQuadsResult, api reference +--- + +# DetectedQuadsResult Class + +The `DetectedQuadsResult` class stores a captured result whose type is detected quads. + +## Definition + +*Package:* com.dynamsoft.ddn + +```java +public class DetectedQuadsResult +``` + +## Methods + +| Method | Description | +|--------|-------------| +| [`getErrorCode`](#geterrorcode) | Gets the error code of the detection operation. | +| [`getErrorString`](#geterrorstring) | Gets the error message of the detection operation. | +| [`getItems`](#getitems) | Gets the detected quadrilateral item at a specified index. | +| [`getRotationTransformMatrix`](#getrotationtransformmatrix) | Gets the 3x3 rotation transformation matrix of the original image relative to the rotated image.| +| [`getOriginalImageHashId`](#getoriginalimagehashid) | Gets the hash ID of the original image. | +| [`getOriginalImageTag`](#getoriginalimagetag) | Gets the tag of the original image. | + +### getErrorCode + +Gets the error code of the detection operation. + +```java +public int getErrorCode() +``` + +**Return Value** + +Returns the error code. + +**See Also** + +[EnumErrorCode]({{ site.dcvb_java_api }}core/enum-error-code.html) + +### getErrorString + +Gets the error message of the detection operation. + +```java +public String getErrorString() +``` + +**Return Value** + +Returns a string that represents the error message. + +### getItems + +Gets all the detected quadrilateral items. + +```java +public DetectedQuadResultItem[] getItems() +``` + +**Return Value** + +Returns a `DetectedQuadResultItem` array. + +**See Also** + +[DetectedQuadResultItem]({{ site.ddn_java_api }}detected-quad-result-item.html) + +### getRotationTransformMatrix + +Gets the 3x3 rotation transformation matrix of the original image relative to the rotated image. + +```java +public double[] getRotationTransformMatrix() +``` + +**Return Value** + +Returns a double array of length 9 which represents a 3x3 rotation matrix. + +### getOriginalImageHashId + +Gets the hash ID of the original image. + +```java +public String getOriginalImageHashId() +``` + +**Return Value** + +Returns a string that represents the hash ID of the original image. + +### getOriginalImageTag + +Gets the tag of the original image. + +```java +public ImageTag getOriginalImageTag() +``` + +**Return Value** + +Returns an `ImageTag` object that represents the tag of the original image. + +**See Also** + +[ImageTag]({{ site.dcvb_java_api }}core/basic-classes/image-tag.html) + diff --git a/programming/java/api-reference/detected-quads-unit.md b/programming/java/api-reference/detected-quads-unit.md new file mode 100644 index 0000000..db207f6 --- /dev/null +++ b/programming/java/api-reference/detected-quads-unit.md @@ -0,0 +1,152 @@ +--- +layout: default-layout +title: DetectedQuadsUnit Class +description: This page shows DetectedQuadsUnit class definition of Dynamsoft Document Normalizer SDK Java Edition. +keywords: getCount, getDetectedQuad, DetectedQuadsUnit, api reference +--- + +# DetectedQuadsUnit Class + +The `DetectedQuadsUnit` class represents an intermediate result unit whose type is detected quads. + +## Definition + +*Package:* com.dynamsoft.ddn.intermediate_results + +```java +public class DetectedQuadsUnit extends IntermediateResultUnit +``` + +*Inheritance:* [IntermediateResultUnit]({{ site.dcvb_java_api }}core/intermediate-results/intermediate-result-unit.html) -> DetectedQuadsUnit + +## Methods + +| Method | Description | +|--------|-------------| +| [`getCount`](#getcount) | Gets the count of `DetectedQuadElement` objects in current object.| +| [`getDetectedQuad`](#getdetectedquad) | Gets a `DetectedQuadElement` object from current object by specifying a index. | +| [`getDetectedQuads`](#getdetectedquads) | Gets all `DetectedQuadElement` objects in current object. | +| [`removeAllDetectedQuads`](#removealldetectedquads) | Removes all the detected quads in current object. | +| [`removeDetectedQuad`](#removedetectedquad) | Removes a detected quad from current object by specifying an index. | +| [`addDetectedQuad`](#adddetectedquad) | Adds a detected quad to current object. | +| [`setDetectedQuad`](#setdetectedquad) | Sets the detected quad at the specified index. | + +### getCount + +Gets the count of `DetectedQuadElement` objects in current object. + +```java +public int getCount() +``` + +**Return Value** + +The count of `DetectedQuadElement` objects in current object. + +### getDetectedQuad + +Gets a `DetectedQuadElement` object from current object by specifying a index. + +```java +public DetectedQuadElement getDetectedQuad(int index) +``` + +**Parameters** + +`index` The index of the `DetectedQuadElement` object. + +**Return Value** + +Returns the `DetectedQuadElement` object got by the specific index. + +**See Also** + +[DetectedQuadElement]({{ site.ddn_java_api }}detected-quad-element.html) + +### getDetectedQuads + +Gets all `DetectedQuadElement` objects in current object. + +```java +public DetectedQuadElement[] getDetectedQuads() +``` + +**Return Value** + +Returns an array of `DetectedQuadElement` objects. + +**See Also** + +[DetectedQuadElement]({{ site.ddn_java_api }}detected-quad-element.html) + +### removeAllDetectedQuads + +Removes all the DetectedQuads in current object. + +```java +public void removeAllDetectedQuads() +``` + +### removeDetectedQuad + +Removes a detected quad from current object by specifying an index. + +```java +public void removeDetectedQuad(int index) throws DocumentNormalizerException +``` + +**Parameters** + +`index` The index of the detected quad to be removed. + +**Exceptions** + +[`DocumentNormalizerException`](document-normalizer-exception.html) + +### addDetectedQuad + +Adds a `DetectedQuadElement` object to current object. + +```java +public void addDetectedQuad(DetectedQuadElement element) throws DocumentNormalizerException +public void addDetectedQuad(DetectedQuadElement element, double[] matrixToOriginalImage) throws DocumentNormalizerException +``` + +**Parameters** + +`element` The detected quad to be added. + +`matrixToOriginalImage` The matrix to the original image. + +**Exceptions** + +[`DocumentNormalizerException`](document-normalizer-exception.html) + +**See Also** + +[DetectedQuadElement]({{ site.ddn_java_api }}detected-quad-element.html) + +### setDetectedQuad + +Sets the DetectedQuad at the specified index. + +```java +public void setDetectedQuad(int index, DetectedQuadElement element) throws DocumentNormalizerException +public void setDetectedQuad(int index, DetectedQuadElement element, double[] matrixToOriginalImage) throws DocumentNormalizerException +``` + +**Parameters** + +`index` The index of the detected quad to be set. + +`element` The detected quad to be added. + +`matrixToOriginalImage` The matrix to the original image. + +**Exceptions** + +[`DocumentNormalizerException`](document-normalizer-exception.html) + +**See Also** + +[DetectedQuadElement]({{ site.ddn_java_api }}detected-quad-element.html) diff --git a/programming/java/api-reference/document-normalizer-module.md b/programming/java/api-reference/document-normalizer-module.md new file mode 100644 index 0000000..085cc79 --- /dev/null +++ b/programming/java/api-reference/document-normalizer-module.md @@ -0,0 +1,43 @@ +--- +layout: default-layout +title: DocumentNormalizerModule Class - Dynamsoft Document Normalizer Module Java Edition API Reference +description: Definition of DocumentNormalizerModule class in Dynamsoft Document Normalizer Module Java Edition. +keywords: document normalizer module, java +needAutoGenerateSidebar: true +needGenerateH3Content: true +--- + +# DocumentNormalizerModule + +The `DocumentNormalizerModule` class defines general functions in the document normalizer module. + +## Definition + +*Package:* com.dynamsoft.ddn + +```java +public final class DocumentNormalizerModule +``` + +## Methods + +| Method | Description | +| ------------------------------------------------------------- | ------------------------------------------------------ | +| [getVersion](#getversion) | Returns the version of the document normalizer module. | + +### getVersion + +Returns the version of the document normalizer module. + +```java +public static String getVersion() +``` + +**Parameters** + +None. + +**Return Value** + +Returns a string representing the version of the document normalizer module. + diff --git a/programming/java/api-reference/enhanced-image-element.md b/programming/java/api-reference/enhanced-image-element.md new file mode 100644 index 0000000..61e6ff7 --- /dev/null +++ b/programming/java/api-reference/enhanced-image-element.md @@ -0,0 +1,55 @@ +--- +layout: default-layout +title: EnhancedImageElement Class +description: This page shows EnhancedImageElement class definition of Dynamsoft Document Normalizer SDK Java Edition. +keywords: setImageData, EnhancedImageElement, api reference +--- + +# EnhancedImageElement Class + +The `EnhancedImageElement` class stores an intermediate result whose type is Enhanced image. + +## Definition + +*Package:* com.dynamsoft.ddn.intermediate_results + +```java +public class EnhancedImageElement extends RegionObjectElement +``` + +*Inheritance:* [RegionObjectElement]({{ site.dcvb_java_api }}core/intermediate-results/region-object-element.html) -> EnhancedImageElement + +## Methods + +| Method | Description | +|--------|-------------| +| [`EnhancedImageElement`](#enhancedimageelement) | Initializes a new instance of the `EnhancedImageElement` class. | +| [`setImageData`](#setimagedata) | Sets the image data of the Enhanced image element. | + +### EnhancedImageElement + +Initializes a new instance of the `EnhancedImageElement` class. + +```java +public EnhancedImageElement() +``` + +### setImageData + +Sets the image data of the Enhanced image element. + +```java +public void setImageData(ImageData imageData) throws DocumentNormalizerException +``` + +**Parameters** + +`imageData` The image data to set. + +**Exceptions** + +[`DocumentNormalizerException`](document-normalizer-exception.html) + +**See Also** + +* [ImageData]({{ site.dcvb_java_api }}core/basic-classes/image-data.html) diff --git a/programming/java/api-reference/enhanced-image-result-item.md b/programming/java/api-reference/enhanced-image-result-item.md new file mode 100644 index 0000000..6119211 --- /dev/null +++ b/programming/java/api-reference/enhanced-image-result-item.md @@ -0,0 +1,55 @@ +--- +layout: default-layout +title: EnhancedImageResultItem Class +description: This page shows EnhancedImageResultItem class definition of Dynamsoft Document Normalizer SDK Java Edition. +keywords: getImageData, getOriginalToLocalMatrix, EnhancedImageResultItem, api reference +--- + +# EnhancedImageResultItem Class + +The `EnhancedImageResultItem` class stores a captured result item whose type is Enhanced image. + +## Definition + +*Package:* com.dynamsoft.ddn + +```java +public class EnhancedImageResultItem extends CapturedResultItem +``` + +*Inheritance:* [CapturedResultItem]({{ site.dcvb_java_api }}core/basic-classes/captured-result-item.html) -> EnhancedImageResultItem + +## Methods + +| Method | Description | +|--------|-------------| +| [`getImageData`](#getimagedata) | Gets the ImageData of current object. | +| [`getOriginalToLocalMatrix`](#getoriginaltolocalmatrix) | Gets the transformation matrix from the original image coordinate system to the local coordinate system. | + +### getImageData + +Gets the ImageData of current object. + +```java +public ImageData getImageData() +``` + +**Return Value** + +The image data. + +**See Also** + +* [ImageData]({{ site.dcvb_java_api }}core/basic-classes/image-data.html) + +### getOriginalToLocalMatrix + +Gets the transformation matrix from the original image coordinate system to the local coordinate system. + +```java +public double[] getOriginalToLocalMatrix() +``` + +**Return Value** + +A double array of size 9, representing the 3x3 transformation matrix that converts coordinates from the original image to the local image. \ No newline at end of file diff --git a/programming/java/api-reference/enhanced-image-unit.md b/programming/java/api-reference/enhanced-image-unit.md new file mode 100644 index 0000000..2cfa158 --- /dev/null +++ b/programming/java/api-reference/enhanced-image-unit.md @@ -0,0 +1,63 @@ +--- +layout: default-layout +title: EnhancedImageUnit Class - Dynamsoft Document Normalizer Module Java Edition API Reference +description: Definition of the EnhancedImageUnit class in Dynamsoft Document Normalizer Module Java Edition. +keywords: getEnhancedImage, setEnhancedImage, EnhancedImageUnit, api reference, java +--- + +# EnhancedImageUnit + +The `EnhancedImageUnit` class represents an intermediate result unit whose type is enhanced images. + +## Definition + +*Package:* com.dynamsoft.ddn.intermediate_results + +*Inheritance:* [IntermediateResultUnit]({{ site.dcvb_java_api }}core/intermediate-results/intermediate-result-unit.html) -> EnhancedImageUnit + +```java +public class EnhancedImageUnit extends IntermediateResultUnit +``` + +## Methods + +| Method | Description | +|--------|-------------| +| [`getEnhancedImage`](#getenhancedimage) | Gets an `EnhancedImageElement` object from current object. | +| [`setEnhancedImage`](#setenhancedimage) | Sets the enhanced image. | + +### getEnhancedImage + +Gets an `EnhancedImageElement` object from current unit. + +```java +public EnhancedImageElement getEnhancedImage() +``` + +**Return Value** + +Returns the `EnhancedImageElement` object. + +**See Also** + +* [EnhancedImageElement]({{ site.ddn_java_api }}enhanced-image-element.html) + +### setEnhancedImage + +Sets the enhanced image. + +```java +public void setEnhancedImage(EnhancedImageElement element) throws DocumentNormalizerException +``` + +**Parameters** + +`element` The enhanced image to be set. + +**Exceptions** + +[`DocumentNormalizerException`]({{ site.ddn_java_api }}document-normalizer-exception.html) + +**See Also** + +* [EnhancedImageElement]({{ site.ddn_java_api }}enhanced-image-element.html) diff --git a/programming/java/api-reference/enum-image-colour-mode.md b/programming/java/api-reference/enum-image-colour-mode.md new file mode 100644 index 0000000..22280a2 --- /dev/null +++ b/programming/java/api-reference/enum-image-colour-mode.md @@ -0,0 +1,22 @@ +--- +layout: default-layout +title: EnumImageColourMode - Dynamsoft Document Normalizer Java Enumerations +description: The enumeration EnumImageColourMode of Dynamsoft Document Normalizer describes the mapping status of a parsed field. +keywords: Mapping status +--- + +# Enumeration ImageColourMode + +`EnumImageColourMode` describes the output colour mode of the normalized image. + +```java +@Retention(RetentionPolicy.CLASS) +public @interface EnumImageColourMode { + //Output image in colour mode. + int ICM_COLOUR = 0; + //Output image in grayscale mode. + int ICM_GRAYSCALE = 1; + //Output image in binary mode. + int ICM_BINARY = 2; +} +``` \ No newline at end of file diff --git a/programming/java/api-reference/logic-lines-unit.md b/programming/java/api-reference/logic-lines-unit.md new file mode 100644 index 0000000..55d1c9c --- /dev/null +++ b/programming/java/api-reference/logic-lines-unit.md @@ -0,0 +1,144 @@ +--- +layout: default-layout +title: LogicLinesUnit Class - Dynamsoft Document Normalizer Module Java Edition API Reference +description: Definition of the LogicLinesUnit class in Dynamsoft Document Normalizer Module Java Edition. +keywords: getCount, getLogicLine, LogicLinesUnit, api reference, java +--- + +# LogicLinesUnit + +The `LogicLinesUnit` class represents an intermediate result unit whose type is logic lines. Logic lines are formed by combining long lines that meet certain conditions. + +## Definition + +*Package:* com.dynamsoft.ddn.intermediate_results + +*Inheritance:* [IntermediateResultUnit]({{ site.dcvb_java_api }}core/intermediate-results/intermediate-result-unit.html) -> LogicLinesUnit + +```java +public class LogicLinesUnit extends IntermediateResultUnit +``` + +## Methods + +| Method | Description | +|--------|-------------| +| [`getCount`](#getcount) | Gets the count of `LogicLine` objects in current object.| +| [`getLogicLine`](#getlogicline) | Gets a `LogicLine` object from current object by specifying a index. | +| [`getLogicLines`](#getlogiclines) | Gets all the `LogicLine` objects from current object. | +| [`removeAllLogicLines`](#removealllogiclines) | Removes all the `LogicLines` in current object. | +| [`removeLogicLine`](#removelogicline) | Removes a `LogicLine` from current object by specifying an index. | +| [`addLogicLine`](#addlogicline) | Adds a `LogicLine` to current object. | +| [`setLogicLine`](#setlogicline) | Sets the `LogicLine` at the specified index. | + +### getCount + +Gets the count of `LogicLine` objects in current object. + +```java +public int getCount() +``` + +**Return Value** + +The count of `LogicLine` objects in current object. + +### getLogicLine + +Gets a `LogicLine` object from current object by specifying a index. + +```java +public LineSegment getLogicLine(int index) +``` + +**Parameters** + +`index` The index of the `LogicLine` object. + +**Return Value** + +Returns the `LogicLine` object. + +**See Also** + +* [LineSegment]({{ site.dcvb_java_api }}core/basic-structures/line-segment.html) + +### getLogicLines + +Gets all the `LogicLine` objects from current object. + +```java +public LineSegment[] getLogicLines() +``` + +**Return Value** + +Returns all the `LogicLine` objects as an array. + +**See Also** + +* [LineSegment]({{ site.dcvb_java_api }}core/basic-structures/line-segment.html) + +### removeAllLogicLines + +Removes all the LogicLines in current object. + +```java +public void removeAllLogicLines() +``` + +### removeLogicLine + +Removes a `LogicLine` from current object by specifying an index. + +```java +public void removeLogicLine(int index) throws DocumentNormalizerException +``` + +**Parameters** + +`index` The index of the `LogicLine` to be removed. + +**Exceptions** + +[`DocumentNormalizerException`]({{ site.ddn_java_api }}document-normalizer-exception.html) + +### addLogicLine + +Adds a `LogicLine` to current object. + +```java +public void addLogicLine(LineSegment logicline) throws DocumentNormalizerException +public void addLogicLine(LineSegment logicline, double[] matrixToOriginalImage) throws DocumentNormalizerException +``` + +**Parameters** + +`logicline` The `LogicLine` to be added. + +`matrixToOriginalImage` The matrix to the original image. Must be a double array of length 9. + +**Exceptions** + +[`DocumentNormalizerException`]({{ site.ddn_java_api }}document-normalizer-exception.html) + +### setLogicLine + +Sets the `LogicLine` at the specified index. + +```java +public void setLogicLine(int index, LineSegment logicline) throws DocumentNormalizerException +public void setLogicLine(int index, LineSegment logicline, double[] matrixToOriginalImage) throws DocumentNormalizerException +``` + +**Parameters** + +`index` The index of the LogicLine to be set. + +`logicline` The LogicLine to be added. + +`matrixToOriginalImage` The matrix to the original image. Must be a double array of length 9. + +**Exceptions** + +[`DocumentNormalizerException`]({{ site.ddn_java_api }}document-normalizer-exception.html) diff --git a/programming/java/api-reference/long-lines-unit.md b/programming/java/api-reference/long-lines-unit.md new file mode 100644 index 0000000..090a2b2 --- /dev/null +++ b/programming/java/api-reference/long-lines-unit.md @@ -0,0 +1,148 @@ +--- +layout: default-layout +title: LongLinesUnit Class +description: This page shows LongLinesUnit class definition of Dynamsoft Document Normalizer SDK Java Edition. +keywords: getCount, getLongLine, LongLinesUnit, api reference +--- + +# LongLinesUnit Class + +The `LongLinesUnit` class represents an intermediate result unit whose type is long lines. Short line segments that are located in the same line are extended and merged to form a long line segment. + +## Definition + +*Package:* com.dynamsoft.ddn.intermediate_results + +```java +public class LongLinesUnit extends IntermediateResultUnit +``` + +*Inheritance:* [IntermediateResultUnit]({{ site.dcvb_java_api }}core/intermediate-results/intermediate-result-unit.html) -> LongLinesUnit + +## Methods + +| Method | Description | +|--------|-------------| +| [`getCount`](#getcount) | Gets the count of `LineSegment` objects in current object.| +| [`getLongLine`](#getlongline) | Gets a `LineSegment` object from current object by specifying a index. | +| [`getLongLines`](#getlonglines) | Gets all `LineSegment` objects in current object. | +| [`removeAllLongLines`](#removealllonglines) | Removes all the `LongLines` in current object. | +| [`removeLongLine`](#removelongline) | Removes a `LongLine` from current object by specifying an index. | +| [`addLongLine`](#addlongline) | Adds a `LongLine` to current object. | +| [`setLongLine`](#setlongline) | Sets the `LongLine` at the specified index. | + +### getCount + +Gets the count of `LineSegment` objects in current object. + +```java +public int getCount() +``` + +**Return Value** + +The count of `LineSegment` objects in current object. + +### getLongLine + +Gets a `LineSegment` object from current object by specifying a index. + +```java +public LineSegment getLongLine(int index) +``` + +**Parameters** + +`index` The index of the `LineSegment` object. + +**Return Value** + +Returns the `LineSegment` object. + +**See Also** + +* [LineSegment]({{ site.dcvb_java_api }}core/basic-classes/line-segment.html) + +### getLongLines + +Gets all `LineSegment` objects in current object. + +```java +public LineSegment[] getLongLines() +``` + +**Return Value** + +Returns an array of `LineSegment` objects. + +**See Also** + +* [LineSegment]({{ site.dcvb_java_api }}core/basic-classes/line-segment.html) + +### removeAllLongLines + +Removes all the `LongLines` in current object. + +```java +public void removeAllLongLines() +``` + +### removeLongLine + +Removes a `LongLine` from current object by specifying an index. + +```java +public void removeLongLine(int index) throws DocumentNormalizerException +``` + +**Parameters** + +`index` The index of the `LongLine` to be removed. + +**Exceptions** + +[`DocumentNormalizerException`](document-normalizer-exception.html) + +### addLongLine + +Adds a `LongLine` to current object. + +```java +public void addLongLine(LineSegment line) throws DocumentNormalizerException +public void addLongLine(LineSegment line, double[] matrixToOriginalImage) throws DocumentNormalizerException +``` + +**Parameters** + +`line` The `LongLine` to be added. + +`matrixToOriginalImage` The matrix to the original image. + +**Exceptions** + +[`DocumentNormalizerException`](document-normalizer-exception.html) + +**See Also** + +* [LineSegment]({{ site.dcvb_java_api }}core/basic-classes/line-segment.html) + +### setLongLine + +Sets the `LongLine` at the specified index. + +```java +public void setLongLine(int index, LineSegment line) throws DocumentNormalizerException +public void setLongLine(int index, LineSegment line, double[] matrixToOriginalImage) throws DocumentNormalizerException +``` + +**Parameters** + +`index` The index of the `LongLine` to be set. + +`line` the `LongLine` to be set. + +`matrixToOriginalImage` The matrix to the original image. + +**Exceptions** + +[`DocumentNormalizerException`](document-normalizer-exception.html) diff --git a/programming/java/api-reference/processed-document-result.md b/programming/java/api-reference/processed-document-result.md new file mode 100644 index 0000000..7bf1009 --- /dev/null +++ b/programming/java/api-reference/processed-document-result.md @@ -0,0 +1,166 @@ +--- +layout: default-layout +title: ProcessedDocumentResult Class +description: This page shows ProcessedDocumentResult class definition of Dynamsoft Document Normalizer SDK Java Edition. +keywords: ProcessedDocumentResult, api reference +--- + +# ProcessedDocumentResult Class + +The `ProcessedDocumentResult` class is a base class for storing processed document results, including detected quads, deskewed images, and enhanced images. It inherits from `CapturedResultBase`. + +## Definition + +*Package:* com.dynamsoft.ddn + +```java +public class ProcessedDocumentResult extends CapturedResultBase +``` + +*Inheritance:* [CapturedResultBase]({{ site.dcvb_java_api }}core/basic-classes/captured-result-base.html) -> ProcessedDocumentResult + +## Methods + +| Method | Description | +|--------|-------------| +| [`getDeskewedImageResultItems`](#getdeskewedimageresultitems) | Retrieves the deskewed image result items. | +| [`getDetectedQuadResultItems`](#getdetectedquadresultitems) | Retrieves the detected quad result items. | +| [`getEnhancedImageResultItems`](#getenhancedimageresultitems) | Retrieves the enhanced image result items. | +| [`getDeskewedImageResultItemsCount`](#getdeskewedimageresultitemscount) | Gets the count of deskewed image result items. | +| [`getDetectedQuadResultItemsCount`](#getdetectedquadresultitemscount) | Gets the count of detected quad result items. | +| [`getEnhancedImageResultItemsCount`](#getenhancedimageresultitemscount) | Gets the count of enhanced image result items. | +| [`getDeskewedImageResultItem`](#getdeskewedimageresultitem) | Gets a deskewed image result item by index. | +| [`getDetectedQuadResultItem`](#getdetectedquadresultitem) | Gets a detected quad result item by index. | +| [`getEnhancedImageResultItem`](#getenhancedimageresultitem) | Gets an enhanced image result item by index. | + +### getDeskewedImageResultItems + +Retrieves the deskewed image result items. + +```java +public DeskewedImageResultItem[] getDeskewedImageResultItems() +``` + +**Return Value** + +Returns an array of `DeskewedImageResultItem` object representing the deskewed image result items. + +**See Also** + +* [DeskewedImageResultItem]({{ site.ddn_java_api }}deskewed-image-result-item.html) + +### getDetectedQuadResultItems + +Retrieves the detected quad result items. + +```java +public DetectedQuadResultItem[] getDetectedQuadResultItems() +``` + +**Return Value** + +Returns an array of `DetectedQuadResultItem` object representing the detected quad results. + +**See Also** + +* [DetectedQuadResultItem]({{ site.ddn_java_api }}detected-quad-result-item.html) + +### getEnhancedImageResultItems + +Retrieves the enhanced image result items. + +```java +public EnhancedImageResultItem[] getEnhancedImageResultItems() +``` + +**Return Value** + +Returns an array of `EnhancedImageResultItem` object representing the enhanced image results. + +**See Also** + +* [EnhancedImageResultItem]({{ site.ddn_java_api }}enhanced-image-result-item.html) + +### getDeskewedImageResultItemsCount + +Gets the count of deskewed image result items. + +```java +public int getDeskewedImageResultItemsCount() +``` + +**Return Value** + +Returns the count of deskewed image result items. + +### getDetectedQuadResultItemsCount + +Gets the count of detected quad result items. + +```java +public int getDetectedQuadResultItemsCount() +``` + +**Return Value** + +Returns the count of detected quad result items. + +### getEnhancedImageResultItemsCount + +Gets the count of enhanced image result items. + +```java +public int getEnhancedImageResultItemsCount() +``` + +**Return Value** + +Returns the count of enhanced image result items. + +### getDeskewedImageResultItem + +Gets a deskewed image result item by index. + +```java +public DeskewedImageResultItem getDeskewedImageResultItem(int index) +``` + +**Parameters** + +`index` The index of the deskewed image result item. + +**Return Value** + +Returns a `DeskewedImageResultItem` object. + +### getDetectedQuadResultItem + +Gets a detected quad result item by index. + +```java +public DetectedQuadResultItem getDetectedQuadResultItem(int index) +``` + +**Parameters** + +`index` The index of the detected quad result item. + +**Return Value** + +Returns a `DetectedQuadResultItem` object. + +### getEnhancedImageResultItem + +Gets an enhanced image result item by index. + +```java +public EnhancedImageResultItem getEnhancedImageResultItem(int index) +``` + +**Parameters** + +`index` The index of the enhanced image result item. + +**Return Value** + +Returns an `EnhancedImageResultItem` object. diff --git a/programming/java/api-reference/simplified-document-normalizer-settings.md b/programming/java/api-reference/simplified-document-normalizer-settings.md new file mode 100644 index 0000000..8dc1cb8 --- /dev/null +++ b/programming/java/api-reference/simplified-document-normalizer-settings.md @@ -0,0 +1,138 @@ +--- +layout: default-layout +title: SimplifiedDocumentNormalizerSettings Class - Dynamsoft Document Normalizer Module Java Edition API Reference +description: Definition of the SimplifiedDocumentNormalizerSettings class in Dynamsoft Document Normalizer Module Java Edition. +keywords: class, java, SimplifiedDocumentNormalizerSettings +--- + +# SimplifiedDocumentNormalizerSettings + +The `SimplifiedDocumentNormalizerSettings` class contains settings for document normalization. It is a sub-parameter of `SimplifiedCaptureVisionSettings` + +```java +public class SimplifiedDocumentNormalizerSettings +``` + +## Attributes Summary + +| Attribute | Type | +| --------- | ---- | +| [`grayscaleTransformationModes`](#grayscaletransformationmodes) | *int[]* | +| [`grayscaleEnhancementModes`](#grayscaleenhancementmodes) | *int[]* | +| [`colourMode`](#colourmode) | *int* | +| [`pageSize`](#pagesize) | *int[]* | +| [`brightness`](#brightness) | *int* | +| [`contrast`](#contrast) | *int* | +| [`maxThreadsInOneTask`](#maxthreadsinonetask) | *int* | +| [`scaleDownThreshold`](#scaledownthreshold) | *int* | +| [`minQuadrilateralAreaRatio`](#minquadrilateralarearatio) | *int* | +| [`expectedDocumentsCount`](#expecteddocumentscount) | *int* | + +### grayscaleTransformationModes + +Specifies how grayscale transformations should be applied, including whether to process inverted grayscale images and the specific transformation mode to use. + +It is an array of 8 integers, where each integer represents a mode specified by the [`EnumGrayscaleTransformationMode`]({{ site.dcvb_java_api }}core/enum-grayscale-transformation-mode.html) enumeration. + +View the parameter reference page of `GrayscaleTransformationModes` for more detail about grayscale transformation modes. + +### grayscaleEnhancementModes + +Specifies how to enhance the quality of the grayscale image. + +It is an array of 8 integers, where each integer represents a mode specified by the [`EnumGrayscaleEnhancementMode`]({{ site.dcvb_java_api }}core/enum-grayscale-enhancement-mode.html) enumeration. + +View the parameter reference page of `GrayscaleEnhancementModes` for more detail about grayscale enhancement modes. + +### colourMode + +Specifies the colour mode of the output image. + +It is a value of the [`EnumImageColourMode`]({{ site.ddn_java_api }}enum-image-colour-mode.html) enumeration. + +View the parameter reference page of `ColourMode` for more detail about colour mode. + +**Default value** + +0, which means output image in colour mode. + +### pageSize + +Specifies the page size (width by height in pixels) of the normalized image. + +### brightness + +Specifies the brightness of the normalized image. + +**Value Range** + +[-100,100] + +**Default value** + +0 + +### contrast + +Specifies the contrast of the normalized image. + +**Value Range** + +[-100,100] + +**Default value** + +0 + +### maxThreadsInOneTask + +Specifies the maximum available threads count in one document normalization task. + +**Value Range** + +[1, 256] + +**Default value** + +4 + +### scaleDownThreshold + +Specifies the threshold for the image shrinking. + +**Value Range** + +[512, 0x7fffffff] + +**Default Value** + +2300 + +**Remarks** + +If the shorter edge size is larger than the given threshold value, the library will calculate the required height and width of the barcode image and shrink the image to that size before detection. Otherwise, the library will perform document detection on the original image. + +### minQuadrilateralAreaRatio + +Specifies the minimum ratio between the target quadrilateral area and the total image area. Only those exceeding this value will be output (measured in percentages). + +**Value Range** + +[0, 100] + +**Default Value** + +0, which means no limitation. + +### expectedDocumentsCount + +Specifies the number of documents expected to be detected. + +**Value Range** + +[0, 0x7fffffff] + +**Default Value** + +1. +