diff --git a/_data/full_tree.yml b/_data/full_tree.yml index d4f6c60..f1a3f70 100644 --- a/_data/full_tree.yml +++ b/_data/full_tree.yml @@ -2,6 +2,5 @@ tree_file_list: - sidelist-full-tree.html - sidelist-architecture.html - sidelist-parameter-reference.html - - sidelist-parameter-reference-v2.4.2200.html - sidelist-parameters-organization.html - sidelist-understanding.html \ No newline at end of file diff --git a/enums/core/corner-type-v2.4.2100.md b/enums/core/corner-type-v2.4.2100.md new file mode 100644 index 0000000..5100924 --- /dev/null +++ b/enums/core/corner-type-v2.4.2100.md @@ -0,0 +1,105 @@ +--- +layout: default-layout +title: CornerType - Dynamsoft Core Enumerations +description: The enumeration CornerType of Dynamsoft Core describes how the corner is formed by its sides. +keywords: Corner type +needGenerateH3Content: true +needAutoGenerateSidebar: true +noTitleIndex: true +breadcrumbText: CornerType +codeAutoHeight: true +--- + +# Enumeration CornerType + +`CornerType` categorizes the nature of a corner based on the intersection of its adjoining sides. + +
+ >- JavaScript + >- Android + >- Objective-C + >- Swift + >- C++ + > +> +```javascript +enum EnumCornerType { + /** + * Represents a corner formed by the standard intersection of two line segments at a point, creating a typical corner shape. + * This is the most common corner type, where the angle between the line segments can vary from acute to obtuse. + */ + CT_NORMAL_INTERSECTED = 0, + /** + * Describes a corner where two line segments intersect in a T-shape. + * This occurs when one line segment terminates at the midpoint of another, creating three distinct angles. + */ + CT_T_INTERSECTED = 1, + /** + * Characterizes a corner formed by two line segments intersecting each other in a cross shape. + * This configuration results in four angles and is commonly encountered in grid or lattice patterns. + */ + CT_CROSS_INTERSECTED = 2, + /** + * Defines a scenario where two line segments do not physically intersect but conceptually form a corner. + * This can occur in virtual shapes or when the corner is implied by the continuation of lines beyond their endpoints. + */ + CT_NOT_INTERSECTED = 3 +} +``` +> +```java +@Retention(RetentionPolicy.CLASS) +public @interface EnumCornerType +{ + /** The corner is formed by two intersecting line segments. */ + public static final int CT_NORMAL_INTERSECTED = 0; + /** The corner is formed by two T intersecting line segments. */ + public static final int CT_T_INTERSECTED = 1; + /** The corner is formed by two cross intersecting line segments. */ + public static final int CT_CROSS_INTERSECTED = 2; + /** The two line segments are not intersected but they definitely consist a corner. */ + public static final int CT_NOT_INTERSECTED = 3; +} +``` +> +```objc +typedef NS_ENUM(NSInteger, DSCornerType) +{ + /** The corner is formed by two intersecting line segments. */ + DSCornerTypeNormalIntersected, + /** The corner is formed by two T intersecting line segments. */ + DSCornerTypeTIntersected, + /** The corner is formed by two cross intersecting line segments. */ + DSCornerTypeCrossIntersected, + /** The two line segments are not intersected but they definitely consist a corner. */ + DSCornerTypeNotIntersected +}; +``` +> +```swift +public enum CornerType : Int +{ + /** The corner is formed by two intersecting line segments. */ + intersected + /** The corner is formed by two T intersecting line segments. */ + tIntersected + /** The corner is formed by two cross intersecting line segments. */ + crossIntersected + /** The two line segments are not intersected but they definitely consist a corner. */ + notIntersected +}; +``` +> +```cpp +typedef enum CornerType +{ + /* The sides of the corner is normally intersected. */ + CT_NORMAL_INTERSECTED = 0, + /* The sides of the corner is T-intersected. */ + CT_T_INTERSECTED = 1, + /* The sides of the corner is cross-intersected. */ + CT_CROSS_INTERSECTED = 2, + /* The sides are not intersected but they definitely make up a corner. */ + CT_NOT_INTERSECTED = 3, +} CornerType; +``` diff --git a/enums/core/corner-type.md b/enums/core/corner-type.md index 5100924..823a1b8 100644 --- a/enums/core/corner-type.md +++ b/enums/core/corner-type.md @@ -20,6 +20,7 @@ codeAutoHeight: true >- Objective-C >- Swift >- C++ + >- Python > > ```javascript @@ -103,3 +104,15 @@ typedef enum CornerType CT_NOT_INTERSECTED = 3, } CornerType; ``` +> +```python +class EnumCornerType(IntEnum): + # The sides of the corner is normally intersected. + CT_NORMAL_INTERSECTED + # The sides of the corner is T-intersected. + CT_T_INTERSECTED + # The sides of the corner is cross-intersected. + CT_CROSS_INTERSECTED + # The sides are not intersected but they definitely make up a corner. + CT_NOT_INTERSECTED +``` diff --git a/enums/core/cross-verification-status.md b/enums/core/cross-verification-status.md index e1f7aff..265f349 100644 --- a/enums/core/cross-verification-status.md +++ b/enums/core/cross-verification-status.md @@ -15,12 +15,24 @@ codeAutoHeight: true `CrossVerificationStatus` describes the status of the captured results.
+ >- JavaScript >- Android >- Objective-C >- Swift >- C++ > > +```javascript +enum EnumCrossVerificationStatus { + /** The cross verification has not been performed yet. */ + CVS_NOT_VERIFIED = 0, + /** The cross verification has been passed successfully. */ + CVS_PASSED = 1, + /** The cross verification has failed. */ + CVS_FAILED = 2 + } +``` +> ```java @Retention(RetentionPolicy.CLASS) public @interface EnumCrossVerificationStatus diff --git a/enums/core/intermediate-result-unit-type-v2.5.2100.md b/enums/core/intermediate-result-unit-type-v2.5.2100.md new file mode 100644 index 0000000..ab8702f --- /dev/null +++ b/enums/core/intermediate-result-unit-type-v2.5.2100.md @@ -0,0 +1,427 @@ +--- +layout: default-layout +title: IntermediateResultUnitType - Dynamsoft Core Enumerations +description: The enumeration IntermediateResultUnitType of Dynamsoft Core describes the type of the intermediate result unit. +keywords: Intermediate result unit type +needGenerateH3Content: true +needAutoGenerateSidebar: true +noTitleIndex: true +breadcrumbText: IntermediateResultUnitType +codeAutoHeight: true +--- + +# Enumeration IntermediateResultUnitType + +`IntermediateResultUnitType` defines different types of intermediate results generated or expected to be generated during image processing. + +
+ >- JavaScript + >- Android + >- Objective-C + >- Swift + >- C++ + >- Python + > +> +```javascript +enum EnumIntermediateResultUnitType { + /** No intermediate result. */ + IRUT_NULL = 0, + /** A full-color image. */ + IRUT_COLOUR_IMAGE = 1, + /** A color image that has been scaled down for efficiency. */ + IRUT_SCALED_DOWN_COLOUR_IMAGE = 1 << 1, + /** A grayscale image derived from the original input. */ + IRUT_GRAYSCALE_IMAGE = 1 << 2, + /** A grayscale image that has undergone transformation. */ + IRUT_TRANSOFORMED_GRAYSCALE_IMAGE = 1 << 3, + /** A grayscale image enhanced for further processing. */ + IRUT_ENHANCED_GRAYSCALE_IMAGE = 1 << 4, + /** Regions pre-detected as potentially relevant for further analysis. */ + IRUT_PREDETECTED_REGIONS = 1 << 5, + /** A binary (black and white) image. */ + IRUT_BINARY_IMAGE = 1 << 6, + /** Results from detecting textures within the image. */ + IRUT_TEXTURE_DETECTION_RESULT = 1 << 7, + /** A grayscale image with textures removed to enhance subject details like text or barcodes. */ + IRUT_TEXTURE_REMOVED_GRAYSCALE_IMAGE = 1 << 8, + /** A binary image with textures removed, useful for clear detection of subjects without background noise. */ + IRUT_TEXTURE_REMOVED_BINARY_IMAGE = 1 << 9, + /** Detected contours within the image, which can help in identifying shapes and objects. */ + IRUT_CONTOURS = 1 << 10, + /** Detected line segments, useful in structural analysis of the image content. */ + IRUT_LINE_SEGMENTS = 1 << 11, + /** Identified text zones, indicating areas with potential textual content. */ + IRUT_TEXT_ZONES = 1 << 12, + /** A binary image with text regions removed. */ + IRUT_TEXT_REMOVED_BINARY_IMAGE = 1 << 13, + /** Zones identified as potential barcode areas, aiding in focused barcode detection. */ + IRUT_CANDIDATE_BARCODE_ZONES = 1 << 14, + /** Barcodes that have been localized but not yet decoded. */ + IRUT_LOCALIZED_BARCODES = 1 << 15, + /** Barcode images scaled up for improved readability or decoding accuracy. */ + IRUT_SCALED_UP_BARCODE_IMAGE = 1 << 16, + /** Images of barcodes processed to resist deformation and improve decoding success. */ + IRUT_DEFORMATION_RESISTED_BARCODE_IMAGE = 1 << 17, + /** Barcode images that have been complemented. */ + IRUT_COMPLEMENTED_BARCODE_IMAGE = 1 << 18, + /** Successfully decoded barcodes. */ + IRUT_DECODED_BARCODES = 1 << 19, + /** Detected long lines. */ + IRUT_LONG_LINES = 1 << 20, + /** Detected corners within the image. */ + IRUT_CORNERS = 1 << 21, + /** Candidate edges identified as potential components of quadrilaterals. */ + IRUT_CANDIDATE_QUAD_EDGES = 1 << 22, + /** Successfully detected quadrilaterals. */ + IRUT_DETECTED_QUADS = 1 << 23, + /** Text lines that have been localized in preparation for recognition. */ + IRUT_LOCALIZED_TEXT_LINES = 1 << 24, + /** Successfully recognized text lines. */ + IRUT_RECOGNIZED_TEXT_LINES = 1 << 25, + /** Successfully normalized images. */ + IRUT_NORMALIZED_IMAGES = 1 << 26, + /**Detected short lines.*/ + IRUT_SHORT_LINES = 1 << 27, + /**grouped lines of text.*/ + IRUT_TEXT_LINE_GROUPS = 1 << 28, + /** A mask to select all types of intermediate results. */ + IRUT_ALL = 0xFFFFFFFFFFFFFFFF +} +``` +> +```java +@Retention(RetentionPolicy.CLASS) +public @interface EnumIntermediateResultUnitType { + /** No intermediate result. */ + long IRUT_NULL = 0L; + /** A full-color image. */ + long IRUT_COLOUR_IMAGE = 1L; + /** A color image that has been scaled down for efficiency. */ + long IRUT_SCALED_DOWN_COLOUR_IMAGE = 1L << 1; + /** A grayscale image derived from the original input. */ + long IRUT_GRAYSCALE_IMAGE = 1L << 2; + /** A grayscale image that has undergone transformation. */ + long IRUT_TRANSOFORMED_GRAYSCALE_IMAGE = 1L << 3; + /** A grayscale image enhanced for further processing. */ + long IRUT_ENHANCED_GRAYSCALE_IMAGE = 1L << 4; + /** Regions pre-detected as potentially relevant for further analysis. */ + long IRUT_PREDETECTED_REGIONS = 1L << 5; + /** A binary (black and white) image. */ + long IRUT_BINARY_IMAGE = 1L << 6; + /** Results from detecting textures within the image. */ + long IRUT_TEXTURE_DETECTION_RESULT = 1L << 7; + /** A grayscale image with textures removed to enhance subject details like text or barcodes. */ + long IRUT_TEXTURE_REMOVED_GRAYSCALE_IMAGE = 1L << 8; + /** A binary image with textures removed, useful for clear detection of subjects without background noise. */ + long IRUT_TEXTURE_REMOVED_BINARY_IMAGE = 1L << 9; + /** Detected contours within the image, which can help in identifying shapes and objects. */ + long IRUT_CONTOURS = 1L << 10; + /** Detected line segments, useful in structural analysis of the image content. */ + long IRUT_LINE_SEGMENTS = 1L << 11; + /** Identified text zones, indicating areas with potential textual content. */ + long IRUT_TEXT_ZONES = 1L << 12; + /** A binary image with text regions removed. */ + long IRUT_TEXT_REMOVED_BINARY_IMAGE = 1L << 13; + /** Zones identified as potential barcode areas, aiding in focused barcode detection. */ + long IRUT_CANDIDATE_BARCODE_ZONES = 1L << 14; + /** Barcodes that have been localized but not yet decoded. */ + long IRUT_LOCALIZED_BARCODES = 1L << 15; + /** Barcode images scaled up for improved readability or decoding accuracy. */ + long IRUT_SCALED_UP_BARCODE_IMAGE = 1L << 16; + /** Images of barcodes processed to resist deformation and improve decoding success. */ + long IRUT_DEFORMATION_RESISTED_BARCODE_IMAGE = 1L << 17; + /** Barcode images that have been complemented. */ + long IRUT_COMPLEMENTED_BARCODE_IMAGE = 1L << 18; + /** Successfully decoded barcodes. */ + long IRUT_DECODED_BARCODES = 1L << 19; + /** Detected long lines. */ + long IRUT_LONG_LINES = 1L << 20; + /** Detected corners within the image. */ + long IRUT_CORNERS = 1L << 21; + /** Candidate edges identified as potential components of quadrilaterals. */ + long IRUT_CANDIDATE_QUAD_EDGES = 1L << 22; + /** Successfully detected quadrilaterals. */ + long IRUT_DETECTED_QUADS = 1L << 23; + /** Text lines that have been localized in preparation for recognition. */ + long IRUT_LOCALIZED_TEXT_LINES = 1L << 24; + /** Successfully recognized text lines. */ + long IRUT_RECOGNIZED_TEXT_LINES = 1L << 25; + /** Successfully normalized images. */ + long IRUT_NORMALIZED_IMAGES = 1L << 26; + /** Detected short lines. */ + long IRUT_SHORT_LINES = 1L << 27; + /** Recognized raw text lines. */ + public static final long IRUT_RAW_TEXT_LINES = 1 << 28; + /** A mask to select all types of intermediate results. */ + long IRUT_ALL = 0xFFFFFFFFFFFFFFFF; +} +``` +> +```objc +typedef NS_OPTIONS(NSUInteger, DSIntermediateResultUnitType) { + /** No intermediate result. */ + DSIntermediateResultUnitTypeNull = 0, + /** A full-color image. */ + DSIntermediateResultUnitTypeColourImage = 1, + /** A color image that has been scaled down for efficiency. */ + DSIntermediateResultUnitTypeScaledDownColourImage = 1 << 1, + /** A grayscale image derived from the original input. */ + DSIntermediateResultUnitTypeGrayscaleImage = 1 << 2, + /** A grayscale image that has undergone transformation. */ + DSIntermediateResultUnitTypeTransformedGrayscaleImage = 1 << 3, + /** A grayscale image enhanced for further processing. */ + DSIntermediateResultUnitTypeEnhancedGrayscaleImage = 1 << 4, + /** Regions pre-detected as potentially relevant for further analysis. */ + DSIntermediateResultUnitTypePredetectedRegions = 1 << 5, + /** A binary (black and white) image. */ + DSIntermediateResultUnitTypeBinaryImage = 1 << 6, + /** Results from detecting textures within the image. */ + DSIntermediateResultUnitTypeTextureDetectionResult = 1 << 7, + /** A grayscale image with textures removed to enhance subject details like text or barcodes. */ + DSIntermediateResultUnitTypeTextureRemovedGrayscaleImage = 1 << 8, + /** A binary image with textures removed, useful for clear detection of subjects without background noise. */ + DSIntermediateResultUnitTypeTextureRemovedBinaryImage = 1 << 9, + /** Detected contours within the image, which can help in identifying shapes and objects. */ + DSIntermediateResultUnitTypeContours = 1 << 10, + /** Detected line segments, useful in structural analysis of the image content. */ + DSIntermediateResultUnitTypeLineSegments = 1 << 11, + /** Identified text zones, indicating areas with potential textual content. */ + DSIntermediateResultUnitTypeTextZones = 1 << 12, + /** A binary image with text regions removed. */ + DSIntermediateResultUnitTypeTextRemovedBinaryImage = 1 << 13, + /** Zones identified as potential barcode areas, aiding in focused barcode detection. */ + DSIntermediateResultUnitTypeCandidateBarcodeZones = 1 << 14, + /** Barcodes that have been localized but not yet decoded. */ + DSIntermediateResultUnitTypeLocalizedBarcodes = 1 << 15, + /** Barcode images scaled up for improved readability or decoding accuracy. */ + DSIntermediateResultUnitTypeScaledUpBarcodeImage = 1 << 16, + /** Images of barcodes processed to resist deformation and improve decoding success. */ + DSIntermediateResultUnitTypeDeformationResistedBarcodeImage = 1 << 17, + /** Barcode images that have been complemented. */ + DSIntermediateResultUnitTypeComplementedBarcodeImage = 1 << 18, + /** Successfully decoded barcodes. */ + DSIntermediateResultUnitTypeDecodedBarcodes = 1 << 19, + /** Detected long lines. */ + DSIntermediateResultUnitTypeLongLines = 1 << 20, + /** Detected corners within the image. */ + DSIntermediateResultUnitTypeCorners = 1 << 21, + /** Candidate edges identified as potential components of quadrilaterals. */ + DSIntermediateResultUnitTypeCandidateQuadEdges = 1 << 22, + /** Successfully detected quadrilaterals. */ + DSIntermediateResultUnitTypeDetectedQuads = 1 << 23, + /** Text lines that have been localized in preparation for recognition. */ + DSIntermediateResultUnitTypeLocalizedTextLines = 1 << 24, + /** Successfully recognized text lines. */ + DSIntermediateResultUnitTypeRecognizedTextLines = 1 << 25, + /** Successfully normalized images. */ + DSIntermediateResultUnitTypeNormalizedImages = 1 << 26, + /** Detected short lines. */ + DSIntermediateResultUnitTypeShortLines = 1 << 27, + /** Recognized raw text lines. */ + DSIntermediateResultUnitTypeRawTextLines = 1 << 28, + /** A mask to select all types of intermediate results. */ + DSIntermediateResultUnitTypeAll = 0xFFFFFFFFFFFFFFFF +}; +``` +> +```swift +public enum IntermediateResultUnitType: Int { + /** No intermediate result. */ + case null = 0 + /** A full-color image. */ + case colourImage = 1 + /** A color image that has been scaled down for efficiency. */ + case scaledDownColourImage = 1 << 1 + /** A grayscale image derived from the original input. */ + case grayscaleImage = 1 << 2 + /** A grayscale image that has undergone transformation. */ + case transformedGrayscaleImage = 1 << 3 + /** A grayscale image enhanced for further processing. */ + case enhancedGrayscaleImage = 1 << 4 + /** Regions pre-detected as potentially relevant for further analysis. */ + case predetectedRegions = 1 << 5 + /** A binary (black and white) image. */ + case binaryImage = 1 << 6 + /** Results from detecting textures within the image. */ + case textureDetectionResult = 1 << 7 + /** A grayscale image with textures removed to enhance subject details like text or barcodes. */ + case textureRemovedGrayscaleImage = 1 << 8 + /** A binary image with textures removed, useful for clear detection of subjects without background noise. */ + case textureRemovedBinaryImage = 1 << 9 + /** Detected contours within the image, which can help in identifying shapes and objects. */ + case contours = 1 << 10 + /** Detected line segments, useful in structural analysis of the image content. */ + case lineSegments = 1 << 11 + /** Identified text zones, indicating areas with potential textual content. */ + case textZones = 1 << 12 + /** A binary image with text regions removed. */ + case textRemovedBinaryImage = 1 << 13 + /** Zones identified as potential barcode areas, aiding in focused barcode detection. */ + case candidateBarcodeZones = 1 << 14 + /** Barcodes that have been localized but not yet decoded. */ + case localizedBarcodes = 1 << 15 + /** Barcode images scaled up for improved readability or decoding accuracy. */ + case scaledUpBarcodeImage = 1 << 16 + /** Images of barcodes processed to resist deformation and improve decoding success. */ + case deformationResistedBarcodeImage = 1 << 17 + /** Barcode images that have been complemented. */ + case complementedBarcodeImage = 1 << 18 + /** Successfully decoded barcodes. */ + case decodedBarcodes = 1 << 19 + /** Detected long lines. */ + case longLines = 1 << 20 + /** Detected corners within the image. */ + case corners = 1 << 21 + /** Candidate edges identified as potential components of quadrilaterals. */ + case candidateQuadEdges = 1 << 22 + /** Successfully detected quadrilaterals. */ + case detectedQuads = 1 << 23 + /** Text lines that have been localized in preparation for recognition. */ + case localizedTextLines = 1 << 24 + /** Successfully recognized text lines. */ + case recognizedTextLines = 1 << 25 + /** Successfully normalized images. */ + case normalizedImages = 1 << 26 + /** Detected short lines. */ + case shortLines = 1 << 27 + /** Recognized raw text lines. */ + rawTextLines = 1 << 28 + /** A mask to select all types of intermediate results. */ + case all = 0xFFFFFFFFFFFFFFFF +} +``` +> +```cpp +enum IntermediateResultUnitType : unsigned long long +{ + /**No IntermediateResult type is specified.*/ + IRUT_NULL = 0, + /**The type of the IntermediateResult is "colour image".*/ + IRUT_COLOUR_IMAGE = 1, + /**The type of the IntermediateResult is "scaled down colour image".*/ + IRUT_SCALED_DOWN_COLOUR_IMAGE = 1 << 1, + /**The type of the IntermediateResult is "grayscale image".*/ + IRUT_GRAYSCALE_IMAGE = 1 << 2, + /**The type of the IntermediateResult is "transformed grayscale image".*/ + IRUT_TRANSFORMED_GRAYSCALE_IMAGE = 1 << 3, + /**The type of the IntermediateResult is "enhanced grayscale image".*/ + IRUT_ENHANCED_GRAYSCALE_IMAGE = 1 << 4, + /**The type of the IntermediateResult is "predected regions".*/ + IRUT_PREDETECTED_REGIONS = 1 << 5, + /**The type of the IntermediateResult is "binary image".*/ + IRUT_BINARY_IMAGE = 1 << 6, + /**The type of the IntermediateResult is "texture detection result".*/ + IRUT_TEXTURE_DETECTION_RESULT = 1 << 7, + /**The type of the IntermediateResult is "texture removed grayscale image".*/ + IRUT_TEXTURE_REMOVED_GRAYSCALE_IMAGE = 1 << 8, + /**The type of the IntermediateResult is "texture removed binary image".*/ + IRUT_TEXTURE_REMOVED_BINARY_IMAGE = 1 << 9, + /**The type of the IntermediateResult is "contours".*/ + IRUT_CONTOURS = 1 << 10, + /**The type of the IntermediateResult is "line segments".*/ + IRUT_LINE_SEGMENTS = 1 << 11, + /**The type of the IntermediateResult is "text zones".*/ + IRUT_TEXT_ZONES = 1 << 12, + /**The type of the IntermediateResult is "text removed binary image".*/ + IRUT_TEXT_REMOVED_BINARY_IMAGE = 1 << 13, + /**The type of the IntermediateResult is "candidate barcode zones".*/ + IRUT_CANDIDATE_BARCODE_ZONES = 1 << 14, + /**The type of the IntermediateResult is "localized barcodes".*/ + IRUT_LOCALIZED_BARCODES = 1 << 15, + /**The type of the IntermediateResult is "scaled up barcode image".*/ + IRUT_SCALED_UP_BARCODE_IMAGE = 1 << 16, + /**The type of the IntermediateResult is "deformation resisted barcode image".*/ + IRUT_DEFORMATION_RESISTED_BARCODE_IMAGE = 1 << 17, + /**The type of the IntermediateResult is "complemented barcode image".*/ + IRUT_COMPLEMENTED_BARCODE_IMAGE = 1 << 18, + /**The type of the IntermediateResult is "decoded barcodes".*/ + IRUT_DECODED_BARCODES = 1 << 19, + /**The type of the IntermediateResult is "long lines".*/ + IRUT_LONG_LINES = 1 << 20, + /**The type of the IntermediateResult is "corners".*/ + IRUT_CORNERS = 1 << 21, + /**The type of the IntermediateResult is "candidate quad edges".*/ + IRUT_CANDIDATE_QUAD_EDGES = 1 << 22, + /**The type of the IntermediateResult is "detected quads".*/ + IRUT_DETECTED_QUADS = 1 << 23, + /**The type of the IntermediateResult is "localized text lines".*/ + IRUT_LOCALIZED_TEXT_LINES = 1 << 24, + /**The type of the IntermediateResult is "recognized text lines".*/ + IRUT_RECOGNIZED_TEXT_LINES = 1 << 25, + /**The type of the IntermediateResult is "normalized image".*/ + IRUT_NORMALIZED_IMAGES = 1 << 26, + /**The type of the IntermediateResult is "short lines".*/ + IRUT_SHORT_LINES = 1 << 27, + /**The type of the IntermediateResult is "text line groups".*/ + IRUT_RAW_TEXT_LINES = 1LL << 28, + /**The type of the IntermediateResult is "all".*/ + IRUT_ALL = 0xFFFFFFFFFFFFFFFF +}; +``` +> +```python +class EnumIntermediateResultUnitType(IntEnum): + # No IntermediateResult type is specified. + IRUT_NULL = 0 + # The type of the IntermediateResult is "colour image". + IRUT_COLOUR_IMAGE = 1 + # The type of the IntermediateResult is "scaled down colour image". + IRUT_SCALED_DOWN_COLOUR_IMAGE = 1 << 1 + # The type of the IntermediateResult is "grayscale image". + IRUT_GRAYSCALE_IMAGE = 1 << 2 + # The type of the IntermediateResult is "transformed grayscale image". + IRUT_TRANSFORMED_GRAYSCALE_IMAGE = 1 << 3 + # The type of the IntermediateResult is "enhanced grayscale image". + IRUT_ENHANCED_GRAYSCALE_IMAGE = 1 << 4 + # The type of the IntermediateResult is "predected regions". + IRUT_PREDETECTED_REGIONS = 1 << 5 + # The type of the IntermediateResult is "binary image". + IRUT_BINARY_IMAGE = 1 << 6 + # The type of the IntermediateResult is "texture detection result". + IRUT_TEXTURE_DETECTION_RESULT = 1 << 7 + # The type of the IntermediateResult is "texture removed grayscale image". + IRUT_TEXTURE_REMOVED_GRAYSCALE_IMAGE = 1 << 8 + # The type of the IntermediateResult is "texture removed binary image". + IRUT_TEXTURE_REMOVED_BINARY_IMAGE = 1 << 9 + # The type of the IntermediateResult is "contours". + IRUT_CONTOURS = 1 << 10 + # The type of the IntermediateResult is "line segments". + IRUT_LINE_SEGMENTS = 1 << 11 + # The type of the IntermediateResult is "text zones". + IRUT_TEXT_ZONES = 1 << 12 + # The type of the IntermediateResult is "text removed binary image". + IRUT_TEXT_REMOVED_BINARY_IMAGE = 1 << 13 + # The type of the IntermediateResult is "candidate barcode zones". + IRUT_CANDIDATE_BARCODE_ZONES = 1 << 14 + # The type of the IntermediateResult is "localized barcodes". + IRUT_LOCALIZED_BARCODES = 1 << 15 + # The type of the IntermediateResult is "scaled up barcode image". + IRUT_SCALED_UP_BARCODE_IMAGE = 1 << 16 + # The type of the IntermediateResult is "deformation resisted barcode image". + IRUT_DEFORMATION_RESISTED_BARCODE_IMAGE = 1 << 17 + # The type of the IntermediateResult is "complemented barcode image". + IRUT_COMPLEMENTED_BARCODE_IMAGE = 1 << 18 + # The type of the IntermediateResult is "decoded barcodes". + IRUT_DECODED_BARCODES = 1 << 19 + # The type of the IntermediateResult is "long lines". + IRUT_LONG_LINES = 1 << 20 + # The type of the IntermediateResult is "corners". + IRUT_CORNERS = 1 << 21 + # The type of the IntermediateResult is "candidate quad edges". + IRUT_CANDIDATE_QUAD_EDGES = 1 << 22 + # The type of the IntermediateResult is "detected quads". + IRUT_DETECTED_QUADS = 1 << 23 + # The type of the IntermediateResult is "localized text lines". + IRUT_LOCALIZED_TEXT_LINES = 1 << 24 + # The type of the IntermediateResult is "recognized text lines". + IRUT_RECOGNIZED_TEXT_LINES = 1 << 25 + # The type of the IntermediateResult is "normalized image". + IRUT_NORMALIZED_IMAGES = 1 << 26 + # The type of the IntermediateResult is "short lines". + IRUT_SHORT_LINES = 1 << 27 + # The type of the IntermediateResult is "text line groups". + IRUT_RAW_TEXT_LINES = 1LL << 28 + # The type of the IntermediateResult is "all". + IRUT_ALL = 0xFFFFFFFFFFFFFFFF +``` diff --git a/enums/core/intermediate-result-unit-type.md b/enums/core/intermediate-result-unit-type.md index e028f65..3d0beb5 100644 --- a/enums/core/intermediate-result-unit-type.md +++ b/enums/core/intermediate-result-unit-type.md @@ -84,6 +84,8 @@ enum EnumIntermediateResultUnitType { IRUT_SHORT_LINES = 1 << 27, /**grouped lines of text.*/ IRUT_TEXT_LINE_GROUPS = 1 << 28, + /** Detected logic lines. */ + IRUT_LOGIC_LINES = 1 << 29, /** A mask to select all types of intermediate results. */ IRUT_ALL = 0xFFFFFFFFFFFFFFFF } diff --git a/enums/core/region-object-element-type-v2.4.2100.md b/enums/core/region-object-element-type-v2.4.2100.md new file mode 100644 index 0000000..3c80eff --- /dev/null +++ b/enums/core/region-object-element-type-v2.4.2100.md @@ -0,0 +1,130 @@ +--- +layout: default-layout +title: RegionObjectElementType - Dynamsoft Core Enumerations +description: The enumeration RegionObjectElementType of Dynamsoft Core describes the types of RegionObjectElement. +keywords: Region object element type +needGenerateH3Content: true +needAutoGenerateSidebar: true +noTitleIndex: true +breadcrumbText: RegionObjectElementType +codeAutoHeight: true +--- + +# Enumeration RegionObjectElementType + +`RegionObjectElementType` specifies the exact subclass type within the `RegionObjectElement` hierarchy. This enumeration facilitates the identification and differentiation of various processed elements in an image. + +
+ >- JavaScript + >- Android + >- Objective-C + >- Swift + >- C++ + > +> +```javascript +enum EnumRegionObjectElementType { + /** + * Corresponds to the `PredetectedRegionElement` subclass, representing areas within the image identified as potentially significant + * for further analysis before detailed processing. + */ + ROET_PREDETECTED_REGION = 0, + /** Corresponds to the `LocalizedBarcodeElement` subclass, indicating areas where barcodes have been localized within the image.*/ + ROET_LOCALIZED_BARCODE = 1, + /** Corresponds to the `DecodedBarcodeElement` subclass, signifying barcodes that have not only been localized but also successfully decoded. */ + ROET_DECODED_BARCODE = 2, + /** Corresponds to the `LocalizedTextLineElement` subclass, indicating lines of text that have been localized within the image. */ + ROET_LOCALIZED_TEXT_LINE = 3, + /** Corresponds to the `RecognizedTextLineElement` subclass, referring to text lines that have been recognized. */ + ROET_RECOGNIZED_TEXT_LINE = 4, + /** Corresponds to the `DetectedQuadElement` subclass, representing quadrilateral shapes detected within the image. */ + ROET_DETECTED_QUAD = 5, + /** Corresponds to the `NormalizedImageElement` subclass, referring to images that have been normalized. */ + ROET_NORMALIZED_IMAGE = 6 +} +``` +> +```java +@Retention(RetentionPolicy.CLASS) +public @interface EnumRegionObjectElementType +{ + /**The type of subclass PredetectedRegionElement.*/ + public static final int ROET_PREDETECTED_REGION = 0; + /**The type of subclass LocalizedBarcodeElement.*/ + public static final int ROET_LOCALIZED_BARCODE = 1; + /**The type of subclass DecodedBarcodeElement.*/ + public static final int ROET_DECODED_BARCODE = 2; + /**The type of subclass LocalizedTextLineElement.*/ + public static final int ROET_LOCALIZED_TEXT_LINE = 3; + /**The type of subclass RecognizedTextLineElement.*/ + public static final int ROET_RECOGNIZED_TEXT_LINE = 4; + /**The type of subclass DetectedQuadElement.*/ + public static final int ROET_DETECTED_QUAD = 5; + /**The type of subclass NormalizedImageElement.*/ + public static final int ROET_NORMALIZED_IMAGE = 6; +} +``` +> +```objc +typedef NS_ENUM(NSInteger, DSRegionObjectElementType) +{ + /**The type of subclass PredetectedRegionElement.*/ + DSRegionObjectElementTypePredetectedRegion = 0, + /**The type of subclass LocalizedBarcodeElement.*/ + DSRegionObjectElementTypeLocalizedBarcode = 1, + /**The type of subclass DecodedBarcodeElement.*/ + DSRegionObjectElementTypeDecodedBarcode = 2, + /**The type of subclass LocalizedTextLineElement.*/ + DSRegionObjectElementTypeLocalizedTextLine = 3, + /**The type of subclass RecognizedTextLineElement.*/ + DSRegionObjectElementTypeRecognizedTextLine = 4, + /**The type of subclass DetectedQuadElement.*/ + DSRegionObjectElementTypeDetectedQuad = 5, + /**The type of subclass NormalizedImageElement.*/ + DSRegionObjectElementTypeNormalizedImage = 6 +}; +``` +> +```swift +public enum RegionObjectElementType : Int +{ + /**The type of subclass PredetectedRegionElement.*/ + predetectedRegion = 0, + /**The type of subclass LocalizedBarcodeElement.*/ + localizedBarcode = 1, + /**The type of subclass DecodedBarcodeElement.*/ + decodedBarcode = 2, + /**The type of subclass LocalizedTextLineElement.*/ + localizedTextLine = 3, + /**The type of subclass RecognizedTextLineElement.*/ + recognizedTextLine = 4, + /**The type of subclass DetectedQuadElement.*/ + detectedQuad = 5, + /**The type of subclass NormalizedImageElement.*/ + normalizedImage = 6 +} +``` +> +```cpp +typedef enum RegionObjectElementType +{ + /**The type of subclass PredetectedRegionElement.*/ + ROET_PREDETECTED_REGION, + /**The type of subclass LocalizedBarcodeElement.*/ + ROET_LOCALIZED_BARCODE, + /**The type of subclass DecodedBarcodeElement.*/ + ROET_DECODED_BARCODE, + /**The type of subclass LocalizedTextLineElement.*/ + ROET_LOCALIZED_TEXT_LINE, + /**The type of subclass RecognizedTextLineElement.*/ + ROET_RECOGNIZED_TEXT_LINE, + /**The type of subclass DetectedQuadElement.*/ + ROET_DETECTED_QUAD, + /**The type of subclass NormalizedImageElement.*/ + ROET_NORMALIZED_IMAGE, + /**The type of subclass SourceImageElement.*/ + ROET_SOURCE_IMAGE, + /**The type of subclass TargetROIElement.*/ + ROET_TARGET_ROI +} RegionObjectElementType; +``` diff --git a/enums/core/region-object-element-type.md b/enums/core/region-object-element-type.md index 3c80eff..84758e8 100644 --- a/enums/core/region-object-element-type.md +++ b/enums/core/region-object-element-type.md @@ -20,6 +20,7 @@ codeAutoHeight: true >- Objective-C >- Swift >- C++ + >- Python > > ```javascript @@ -128,3 +129,25 @@ typedef enum RegionObjectElementType ROET_TARGET_ROI } RegionObjectElementType; ``` +> +```python +class EnumRegionObjectElementType(IntEnum): + # The type of subclass PredetectedRegionElement. + ROET_PREDETECTED_REGION + # The type of subclass LocalizedBarcodeElement. + ROET_LOCALIZED_BARCODE + # The type of subclass DecodedBarcodeElement. + ROET_DECODED_BARCODE + # The type of subclass LocalizedTextLineElement. + ROET_LOCALIZED_TEXT_LINE + # The type of subclass RecognizedTextLineElement. + ROET_RECOGNIZED_TEXT_LINE + # The type of subclass DetectedQuadElement. + ROET_DETECTED_QUAD + # The type of subclass NormalizedImageElement. + ROET_NORMALIZED_IMAGE + # The type of subclass SourceImageElement. + ROET_SOURCE_IMAGE + # The type of subclass TargetROIElement. + ROET_TARGET_ROI +``` diff --git a/enums/core/section-type-v2.4.2100.md b/enums/core/section-type-v2.4.2100.md new file mode 100644 index 0000000..8a40ce3 --- /dev/null +++ b/enums/core/section-type-v2.4.2100.md @@ -0,0 +1,134 @@ +--- +layout: default-layout +title: SectionType - Dynamsoft Core Enumerations +description: The enumeration SectionType of Dynamsoft Core describes the section of the algorithm. +keywords: Section type +needGenerateH3Content: true +needAutoGenerateSidebar: true +noTitleIndex: true +breadcrumbText: SectionType +codeAutoHeight: true +--- + +# Enumeration SectionType + +`SectionType` categorizes the distinct segments within the image processing algorithm, pinpointing the exact phase responsible for generating a specific `IntermediateResult`. + + +
+ >- JavaScript + >- Android + >- Objective-C + >- Swift + >- C++ + > +> +```javascript +enum EnumSectionType { + /** Indicates that no specific section type has been specified. */ + ST_NULL = 0, + /** Corresponds to results generated in the "region prediction" section. */ + ST_REGION_PREDETECTION = 1, + /** Corresponds to results generated in the "barcode localization" section. */ + ST_BARCODE_LOCALIZATION = 2, + /** Corresponds to results generated in the "barcode decoding" section. */ + ST_BARCODE_DECODING = 3, + /** Corresponds to results generated in the "text line localization" section. */ + ST_TEXT_LINE_LOCALIZATION = 4, + /** Corresponds to results generated in the "text line recognition" section. */ + ST_TEXT_LINE_RECOGNITION = 5, + /** Corresponds to results generated in the "document detection" section. */ + ST_DOCUMENT_DETECTION = 6, + /** Corresponds to results generated in the "document normalization" section. */ + ST_DOCUMENT_NORMALIZATION = 7 +} +``` +> +```java +@Retention(RetentionPolicy.CLASS) +public @interface EnumSectionType +{ + /**No section type is specified.*/ + public static final int ST_NULL = 0; + /**The result is output by "region prediction" section.*/ + public static final int ST_REGION_PREDETECTION = 1; + /**The result is output by "barcode localization" section.*/ + public static final int ST_BARCODE_LOCALIZATION = 2; + /**The result is output by "barcode decoding" section.*/ + public static final int ST_BARCODE_DECODING = 3; + /**The result is output by "text line localization" section.*/ + public static final int ST_TEXT_LINE_LOCALIZATION = 4; + /**The result is output by "text line recognition" section.*/ + public static final int ST_TEXT_LINE_RECOGNITION = 5; + /**The result is output by "document detection" section.*/ + public static final int ST_DOCUMENT_DETECTION = 6; + /**The result is output by "document normalization" section.*/ + public static final int ST_DOCUMENT_NORMALIZATION = 7; +} +``` +> +```objc +typedef NS_ENUM(NSInteger, DSSectionType) +{ + /**No section type is specified.*/ + DSSectionTypeNull = 0, + /**The result is output by "region prediction" section.*/ + DSSectionTypeRegionPredection = 1, + /**The result is output by "barcode localization" section.*/ + DSSectionTypeBarcodeLocalization = 2, + /**The result is output by "barcode decoding" section.*/ + DSSectionTypeBarcodeDecoding = 3, + /**The result is output by "text line localization" section.*/ + DSSectionTypeTextLineLocalization = 4, + /**The result is output by "text line recognition" section.*/ + DSSectionTypeTextLineRecognition = 5, + /**The result is output by "document detection" section.*/ + DSSectionTypeDocumentDetection = 6, + /**The result is output by "document normalization" section.*/ + DSSectionTypeDocumentNormalization = 7 +}; +``` +> +```swift +public enum SectionType : Int +{ + /**No section type is specified.*/ + null = 0, + /**The result is output by "region prediction" section.*/ + regionPredection = 1, + /**The result is output by "barcode localization" section.*/ + barcodeLocalization = 2, + /**The result is output by "barcode decoding" section.*/ + barcodeDecoding = 3, + /**The result is output by "text line localization" section.*/ + textLineLocalization = 4, + /**The result is output by "text line recognition" section.*/ + textLineRecognition = 5, + /**The result is output by "document detection" section.*/ + documentDetection = 6, + /**The result is output by "document normalization" section.*/ + documentNormalization = 7 +} +``` +> +```cpp +typedef enum SectionType +{ + /**No section type is specified.*/ + ST_NULL, + /**The result is output by "region prediction" section.*/ + ST_REGION_PREDETECTION, + /**The result is output by "barcode localization" section.*/ + ST_BARCODE_LOCALIZATION, + /**The result is output by "barcode decoding" section.*/ + ST_BARCODE_DECODING, + /**The result is output by "text line localization" section.*/ + ST_TEXT_LINE_LOCALIZATION, + /**The result is output by "text line recognition" section.*/ + ST_TEXT_LINE_RECOGNITION, + /**The result is output by "document detection" section.*/ + ST_DOCUMENT_DETECTION, + /**The result is output by "document normalization" section.*/ + ST_DOCUMENT_NORMALIZATION, +} SectionType; +``` diff --git a/enums/core/section-type.md b/enums/core/section-type.md index 8a40ce3..45fdc27 100644 --- a/enums/core/section-type.md +++ b/enums/core/section-type.md @@ -21,6 +21,7 @@ codeAutoHeight: true >- Objective-C >- Swift >- C++ + >- Python > > ```javascript @@ -132,3 +133,23 @@ typedef enum SectionType ST_DOCUMENT_NORMALIZATION, } SectionType; ``` +> +```python +class EnumSectionType(IntEnum): + # No section type is specified. + ST_NULL + # The result is output by "region prediction" section. + ST_REGION_PREDETECTION + # The result is output by "barcode localization" section. + ST_BARCODE_LOCALIZATION + # The result is output by "barcode decoding" section. + ST_BARCODE_DECODING + # The result is output by "text line localization" section. + ST_TEXT_LINE_LOCALIZATION + # The result is output by "text line recognition" section. + ST_TEXT_LINE_RECOGNITION + # The result is output by "document detection" section. + ST_DOCUMENT_DETECTION + # The result is output by "document normalization" section. + ST_DOCUMENT_NORMALIZATION +``` diff --git a/enums/core/transform-matrix-type-v2.4.2100.md b/enums/core/transform-matrix-type-v2.4.2100.md new file mode 100644 index 0000000..50f5e12 --- /dev/null +++ b/enums/core/transform-matrix-type-v2.4.2100.md @@ -0,0 +1,86 @@ +--- +layout: default-layout +title: TransformMatrixType - Dynamsoft Core Enumerations +description: The enumeration TransformMatrixType of Dynamsoft Core describes transform matrix types. +keywords: Target type +needGenerateH3Content: true +needAutoGenerateSidebar: true +noTitleIndex: true +breadcrumbText: TransformMatrixType +--- + +# Enumeration TransformMatrixType + +`TransformMatrixType` describes the transform matrix types. + +
+ >- JavaScript + >- Android + >- Objective-C + >- Swift + >- C++ + > +> +```javascript +enum EnumTransformMatrixType { + /**Represents a transformation matrix that converts coordinates from the local image to the original image.*/ + TMT_LOCAL_TO_ORIGINAL_IMAGE, + /**Represents a transformation matrix that converts coordinates from the original image to the local image.*/ + TMT_ORIGINAL_TO_LOCAL_IMAGE +} +``` +> +```java +public @interface EnumTransformMatrixType { + /**Represents a transformation matrix that converts coordinates from the local image to the original image.*/ + int TMT_LOCAL_TO_ORIGINAL_IMAGE = 0; + /**Represents a transformation matrix that converts coordinates from the original image to the local image.*/ + int TMT_ORIGINAL_TO_LOCAL_IMAGE = 1; + /**Represents a transformation matrix that converts coordinates from the rotated image to the original image.*/ + int TMT_ROTATED_TO_ORIGINAL_IMAGE = 2; + /**Represents a transformation matrix that converts coordinates from the original image to the rotated image.*/ + int TMT_ORIGINAL_TO_ROTATED_IMAGE = 3; +} +``` +> +```objc +typedef NS_ENUM(NSInteger, DSTransformMatrixType) +{ + /**Represents a transformation matrix that converts coordinates from the local image to the original image.*/ + DSTransformMatrixTypeLocalToOriginalImage = 0, + /**Represents a transformation matrix that converts coordinates from the original image to the local image.*/ + DSTransformMatrixTypeOriginalToLocalImage = 1, + /**Represents a transformation matrix that converts coordinates from the rotated image to the original image.*/ + DSTransformMatrixTypeRotatedToOriginalImage = 2, + /**Represents a transformation matrix that converts coordinates from the original image to the rotated image.*/ + DSTransformMatrixTypeOriginalToRotatedImage = 3 +}NS_SWIFT_NAME(TransformMatrixType); +``` +> +```swift +public enum TransformMatrixType : Int +{ + /**Represents a transformation matrix that converts coordinates from the local image to the original image.*/ + localToOriginalImage = 0, + /**Represents a transformation matrix that converts coordinates from the original image to the local image.*/ + originalToLocalImage = 1, + /**Represents a transformation matrix that converts coordinates from the rotated image to the original image.*/ + rotatedToOriginalImage = 2, + /**Represents a transformation matrix that converts coordinates from the original image to the rotated image.*/ + originalToRotatedImage = 3 +} +``` +> +```cpp +typedef enum TransformMatrixType +{ + /**Represents a transformation matrix that converts coordinates from the local image to the original image.*/ + TMT_LOCAL_TO_ORIGINAL_IMAGE, + /**Represents a transformation matrix that converts coordinates from the original image to the local image.*/ + TMT_ORIGINAL_TO_LOCAL_IMAGE, + /**Represents a transformation matrix that converts coordinates from the rotated image to the original image.*/ + TMT_ROTATED_TO_ORIGINAL_IMAGE, + /**Represents a transformation matrix that converts coordinates from the original image to the rotated image.*/ + TMT_ORIGINAL_TO_ROTATED_IMAGE +} TransformMatrixType; +``` diff --git a/enums/core/transform-matrix-type.md b/enums/core/transform-matrix-type.md index 6b68707..ecc814e 100644 --- a/enums/core/transform-matrix-type.md +++ b/enums/core/transform-matrix-type.md @@ -19,6 +19,7 @@ breadcrumbText: TransformMatrixType >- Objective-C >- Swift >- C++ + >- Python > > ```javascript @@ -84,3 +85,15 @@ typedef enum TransformMatrixType TMT_ORIGINAL_TO_ROTATED_IMAGE } TransformMatrixType; ``` +> +```python +class EnumTransformMatrixType(IntEnum): + # Represents a transformation matrix that converts coordinates from the local image to the original image. + TMT_LOCAL_TO_ORIGINAL_IMAGE + # Represents a transformation matrix that converts coordinates from the original image to the local image. + TMT_ORIGINAL_TO_LOCAL_IMAGE + # Represents a transformation matrix that converts coordinates from the rotated image to the original image. + TMT_ROTATED_TO_ORIGINAL_IMAGE + # Represents a transformation matrix that converts coordinates from the original image to the rotated image. + TMT_ORIGINAL_TO_ROTATED_IMAGE +``` diff --git a/enums/label-recognizer/raw-text-line-status-v2.4.2100.md b/enums/label-recognizer/raw-text-line-status-v2.4.2100.md new file mode 100644 index 0000000..04c8a8e --- /dev/null +++ b/enums/label-recognizer/raw-text-line-status-v2.4.2100.md @@ -0,0 +1,55 @@ +--- +layout: default-layout +title: RawTextLineStatus - Dynamsoft LabelRecognizer Enumerations +description: The enumeration RawTextLineStatus of Dynamsoft LabelRecognizer describes the final status of a raw text line. +keywords: Raw Text Line Status +needGenerateH3Content: true +needAutoGenerateSidebar: true +noTitleIndex: true +breadcrumbText: RawTextLineStatus +codeAutoHeight: true +--- + +# Enumeration RawTextLineStatus + +`RawTextLineStatus` enumerates the final status of a raw text line. + +
+ >- JavaScript + >- C++ + >- Python + > +> +```javascript +enum EnumRawTextLineStatus +{ + /** Localized but recognition not performed. */ + RTLS_LOCALIZED = 0 , + /** Recognition failed. */ + RTLS_RECOGNITION_FAILED = 1, + /** Successfully recognized. */ + RTLS_RECOGNITION_SUCCEEDED = 2 +} +``` +> +```cpp +typedef enum RawTextLineStatus +{ + /** Localized but recognition not performed. */ + RTLS_LOCALIZED, + /** Recognition failed. */ + RTLS_RECOGNITION_FAILED, + /** Successfully recognized. */ + RTLS_RECOGNITION_SUCCEEDED +} RawTextLineStatus; +``` +> +```python +class EnumRawTextLineStatus(IntEnum): + # Localized but recognition not performed. + RTLS_LOCALIZED + # Recognition failed. + RTLS_RECOGNITION_FAILED + # Successfully recognized. + RTLS_RECOGNITION_SUCCEEDED +```