Intermediate Result Classes

iIntermediateResult

iIntermediateResult is the class that stores the intermediate result data.

@interface iIntermediateResult

Attribute	Type	Description
`resultsCount`	NSInteger	The total result count.
`results`	NSObject*	One of the following types: Array of `iContour`, Array of `iImageData`, Array of `iLineSegment`, Array of `iLocalizationResult`, Array of `iRegionOfInterest`.
`dataType`	`EnumIMResultDataType`	The data type of the intermediate result.
`resultType`	`EnumIntermediateResultType`	Intermediate result type.
`barcodeComplementMode`	`EnumBarcodeComplementMode`	The `EnumBarcodeComplementMode` used when generating the current intermediate result.
`bcmIndex`	NSInteger	The array index of current used `EnumBarcodeComplementMode` in the `barcodeComplementModes` setting.
`deformationResistingMode`	`EnumDeformationResistingMode`	The `EnumDeformationResistingMode` used when generating the current intermediate result.
`drmIndex`	NSInteger	The array index of current used `EnumDeformationResistingMode` in the `deformationResistingModes` setting.
`dpmCodeReadingMode`	`EnumDPMCodeReadingMode`	The `EnumDPMCodeReadingMode` used when generating the current intermediate result.
`dpmcrmIndex`	NSInteger	The array index of current used `EnumDPMCodeReadingMode` in the `dpmCodeReadingModes` setting.
`transformationMatrix`	NSArray *	The rotation matrix.
`textFilterMode`	`EnumTextFilterMode`	The `EnumTextFilterMode` used when generating the current intermediate result.
`tfmIndex`	NSInteger	The array index of current used `EnumTextFilterMode` in the `textFilterModes` setting.
`localizationMode`	`EnumLocalizationMode`	The `EnumLocalizationMode` used when generating the current intermediate result.
`lmIndex`	NSInteger	The array index of current used `EnumLocalizationMode` in the `localizationModes` setting.
`binarizationMode`	`EnumBinarizationMode`	The `EnumBinarizationMode` used when generating the current intermediate result.
`bmIndex`	NSInteger	The array index of current used `EnumBinarizationMode` in the `binarizationModes` setting.
`imagePreprocessingMode`	`EnumImagePreprocessingMode`	The `EnumImagePreprocessingMode` used when generating the current intermediate result.
`ipmIndex`	NSInteger	The array index of current used `EnumImagePreprocessingMode` in `imagePreprocessingModes` setting.
`roiId`	NSInteger	The ID of the ROI (Region Of Interest) generated by the SDK. -1 means the original image.
`regionPredetectionMode`	`EnumRegionPredetectionMode`	The `EnumRegionPredetectionMode` used when generating the current intermediate result.
`rpmIndex`	NSInteger	The array index of current used `EnumRegionPredetectionMode` in the `regionPredetectionModes` setting.
`grayscaleTransformationMode`	`EnumGrayscaleTransformationMode`	The `EnumGrayscaleTransformationMode` used when generating the current intermediate result.
`gtmIndex`	NSInteger	The array index of current used `EnumGrayscaleTransformationMode` in the `grayscaleTransformationModes` setting.
`colourConversionMode`	`EnumColourConversionMode`	The `EnumColourConversionMode` used when generating the current intermediate result.
`cicmIndex`	NSInteger	The array index of current used `EnumColourConversionMode` in the `colourConversionModes` setting.
`colourClusteringMode`	`EnumColourClusteringMode`	The `EnumColourClusteringMode` used when generating the current intermediate result.
`ccmIndex`	NSInteger	The array index of current used `EnumColourClusteringMode` in the `colourClusteringModes` setting.
`scaleDownRatio`	NSInteger	The scale down ratio.
`frameId`	NSInteger	The ID of the operated frame.

iContour

contour is one of the results type in IntermediateResult.

@interface iContour

Attribute	Type	Description
`pointsCount`	NSInteger	The total points count of the contour.
`points`	NSArray *	The points array of the points that surround the barcode area..

iImageData

ImageData is one of the results type in IntermediateResult.

@interface iImageData

Attribute	Type	Descriptions
`bytes`	unsigned char*	The image data content in a byte array.
`bytesLength`	NSInteger	The length of the image data byte array.
`width`	NSInteger	The width of the image in pixels.
`height`	NSInteger	The height of the image in pixels.
`stride`	NSInteger	The stride (or scan width) of the image.
`format`	`EnumImagePixelFormat`	The image pixel format used in the image byte array.

iLineSegment

LineSegment is one of the results type in IntermediateResult.

@interface iLineSegment

Attribute	Type	Descriptions
`startPoint`	`CGPoint`	The start point of the line segment.
`endPoint`	`CGPoint`	The end point of the line segment.
`linesConfidenceCoefficients`	NSData *	byte[]	The confidence coefficients for lines.

iRegionOfInterest

RegionOfInterest is one of the results type in IntermediateResult.

@interface iRegionOfInterest

Attribute	Type	Descriptions
`roiId`	NSInteger	The ID generated by the SDK.
`point`	`CGPoint`	The left top point of the region.
`width`	NSInteger	The width of the region.
`height`	NSInteger	The height of the region.

iLocalizationResult

View more in TextResult » LocalizationResult

LocalizationResult can be the extension of the class IntermediateResult. It stores the localization result information.

@interface iLocalizationResult

Attribute	Type	Description
`terminatePhase`	`EnumTerminatePhase`	The terminate phase of localization result.
`barcodeFormat`	`EnumBarcodeFormat`	Barcode type in BarcodeFormat group 1.
`barcodeFormatString`	NSString *	Barcode type in BarcodeFormat group 1 as string.
`barcodeFormat_2`	`EnumBarcodeFormat2`	Barcode type in BarcodeFormat group 2.
`barcodeFormatString_2`	NSString *	Barcode type in BarcodeFormat group 2 as string.
`resultPoints`	NSArray *	The vertices coordinates information of the barcode region.
`angle`	NSInteger	The angle of a barcode. Values range is from 0 to 360.
`moduleSize`	NSInteger	The barcode module size (the minimum bar width in pixel).
`pageNumber`	NSInteger	The page number the barcode located in. The index is 0-based.
`regionName`	NSString *	The region name the barcode located in.
`documentName`	NSString *	The document name.
`resultCoordinateType`	`EnumResultCoordinateType`	The coordinate type.
`accompanyingTextBytes`	NSData *	The accompanying text content in a byte array.
`accompanyingTextBytesLength`	NSInteger	The length of the accompanying text byte array.
`confidence`	NSInteger	The confidence of the localization result.