Resource Base
Table of contents

IntermediateResultReceiver

The IntermediateResultReceiver class is designed as a standardized way for retrieving intermediate results in image processing workflows in the Dynamsoft Capture Vision architecture. It adopts an event-driven approach, with events triggered for specific types of results, such as pre-detected regions, localized barcodes, etc. Each event is optional, allowing flexibility and customization based on the needs of the application.

class IntermediateResultReceiver {
    getObservationParameters(): Core.ObservationParameters;
    onTaskResultsReceived?(result: IntermediateResult, info: IntermediateResultExtraInfo): void;
    onPredetectedRegionsReceived?(result: PredetectedRegionsUnit, info: IntermediateResultExtraInfo): void;
    onLocalizedBarcodesReceived?(result: LocalizedBarcodesUnit, info: IntermediateResultExtraInfo): void;
    onDecodedBarcodesReceived?(result: DecodedBarcodesUnit, info: IntermediateResultExtraInfo): void;
    onLocalizedTextLinesReceived?(result: LocalizedTextLinesUnit, info: IntermediateResultExtraInfo): void;
    onRecognizedTextLinesReceived?(result: RecognizedTextLinesUnit, info: IntermediateResultExtraInfo): void;
    onDetectedQuadsReceived?(result: DetectedQuadsUnit, info: IntermediateResultExtraInfo): void;
    onNormalizedImagesReceived?(result: NormalizedImagesUnit, info: IntermediateResultExtraInfo): void;
    onColourImageUnitReceived?(result: ColourImageUnit, info: IntermediateResultExtraInfo): void;
    onScaledDownColourImageUnitReceived?(result: ScaledDownColourImageUnit, info: IntermediateResultExtraInfo): void;
    onGrayscaleImageUnitReceived?(result: GrayscaleImageUnit, info: IntermediateResultExtraInfo): void;
    onTransformedGrayscaleImageUnitReceived?(result: TransformedGrayscaleImageUnit, info: IntermediateResultExtraInfo): void;
    onEnhancedGrayscaleImageUnitReceived?(result: EnhancedGrayscaleImageUnit, info: IntermediateResultExtraInfo): void;
    onBinaryImageUnitReceived?(result: BinaryImageUnit, info: IntermediateResultExtraInfo): void;
    onTextureDetectionResultUnitReceived?(result: TextureDetectionResultUnit, info: IntermediateResultExtraInfo): void;
    onTextureRemovedGrayscaleImageUnitReceived?(result: TextureRemovedGrayscaleImageUnit, info: IntermediateResultExtraInfo): void;
    onTextureRemovedBinaryImageUnitReceived?(result: TextureRemovedBinaryImageUnit, info: IntermediateResultExtraInfo): void;
    onContoursUnitReceived?(result: ContoursUnit, info: IntermediateResultExtraInfo): void;
    onLineSegmentsUnitReceived?(result: LineSegmentsUnit, info: IntermediateResultExtraInfo): void;
    onTextZonesUnitReceived?(result: TextZonesUnit, info: IntermediateResultExtraInfo): void;
    onTextRemovedBinaryImageUnitReceived?(result: TextRemovedBinaryImageUnit, info: IntermediateResultExtraInfo): void;
    onShortLinesUnitReceived?(result: Core.ShortLinesUnit, info: Core.IntermediateResultExtraInfo): void;
    onLongLinesUnitReceived?(result: LongLinesUnit, info: IntermediateResultExtraInfo): void;
    onCornersUnitReceived?(result: CornersUnit, info: IntermediateResultExtraInfo): void;
    onCandidateQuadEdgesUnitReceived?(result: CandidateQuadEdgesUnit, info: IntermediateResultExtraInfo): void;
    onCandidateBarcodeZonesUnitReceived?(result: LocalizedBarcodesUnit, info: IntermediateResultExtraInfo): void;
    onScaledUpBarcodeImageUnitReceived?(result: ScaledUpBarcodeImageUnit, info: IntermediateResultExtraInfo): void;
    onDeformationResistedBarcodeImageUnitReceived?(result: DeformationResistedBarcodeImageUnit, info: IntermediateResultExtraInfo): void;
    onComplementedBarcodeImageUnitReceived?(result: ComplementedBarcodeImageUnit, info: IntermediateResultExtraInfo): void;
}
Name Description
getObservationParameters() Gets the observed parameters of the intermediate result receiver.
onTaskResultsReceived() Event triggered when task results are received.
onPredetectedRegionsReceived() Event triggered when pre-detected regions are received.
onLocalizedBarcodesReceived() Event triggered when localized barcodes are received.
onDecodedBarcodesReceived() Event triggered when decoded barcodes are received.
onLocalizedTextLinesReceived() Event triggered when localized text lines are received.
onRecognizedTextLinesReceived() Event triggered when recognized text lines are received.
onDetectedQuadsReceived() Event triggered when detected quads are received.
onNormalizedImagesReceived() Event triggered when normalized images are received.
onColourImageUnitReceived() Event triggered when a colour image unit is received.
onScaledDownColourImageUnitReceived() Event triggered when a scaled-down colour image unit is received.
onGrayscaleImageUnitReceived() Event triggered when a grayscale image unit is received.
onTransformedGrayscaleImageUnitReceived() Event triggered when a transformed grayscale image unit is received.
onEnhancedGrayscaleImageUnitReceived() Event triggered when an enhanced grayscale image unit is received.
onBinaryImageUnitReceived() Event triggered when a binary image unit is received.
onTextureDetectionResultUnitReceived() Event triggered when a texture detection result unit is received.
onTextureRemovedGrayscaleImageUnitReceived() Event triggered when a texture-removed grayscale image unit is received.
onTextureRemovedBinaryImageUnitReceived() Event triggered when a texture-removed binary image unit is received.
onContoursUnitReceived() Event triggered when a contours unit is received.
onLineSegmentsUnitReceived() Event triggered when a line segments unit is received.
onTextZonesUnitReceived() Event triggered when a text zones unit is received.
onTextRemovedBinaryImageUnitReceived() Event triggered when a text-removed binary image unit is received.
onShortLinesUnitReceived() Event triggered when a short lines unit is received.
onLongLinesUnitReceived() Event triggered when a long lines unit is received.
onCornersUnitReceived() Event triggered when a corners unit is received.
onCandidateQuadEdgesUnitReceived() Event triggered when a candidate quad edges unit are detected.
onCandidateBarcodeZonesUnitReceived() Event triggered when a candidate barcode zones unit are detected.
onScaledUpBarcodeImageUnitReceived() Event triggered when a scaled-up barcode image unit is received.
onDeformationResistedBarcodeImageUnitReceived() Event triggered when a deformation-resisted barcode image unit is received.
onComplementedBarcodeImageUnitReceived() Event triggered when a complemented barcode image unit is received.

getObservationParameters

Gets the observed parameters of the intermediate result receiver. Allowing for configuration of intermediate result observation.

getObservationParameters(): ObservationParameters;

Return Value

The observed parameters, of type ObservationParameters. The default parameters are to observe all intermediate result unit types and all tasks.

See Also

ObservationParameters

onTaskResultsReceived

Event triggered when task results are received.

onTaskResultsReceived?(result: IntermediateResult, info: IntermediateResultExtraInfo): void;

Parameters

result: The intermediate result from the task, of type IntermediateResult.

info: Additional information about the result, of type IntermediateResultExtraInfo.

See Also

IntermediateResult

IntermediateResultExtraInfo

Image-Processing Tasks

onPredetectedRegionsReceived

Event triggered when pre-detected regions are received.

onPredetectedRegionsReceived?(result: PredetectedRegionsUnit, info: IntermediateResultExtraInfo): void;

Parameters

result: The result unit that contains the pre-detected regions, of type PredetectedRegionsUnit.

info: Additional information about the result, of type IntermediateResultExtraInfo.

See Also

PredetectedRegionsUnit

IntermediateResultExtraInfo

onLocalizedBarcodesReceived

Event triggered when localized barcodes are received.

onLocalizedBarcodesReceived?(result: LocalizedBarcodesUnit, info: IntermediateResultExtraInfo): void;

Parameters

result: The result unit that contains the localized barcodes, of type LocalizedBarcodesUnit.

info: Additional information about the result, of type IntermediateResultExtraInfo.

See Also

LocalizedBarcodesUnit

IntermediateResultExtraInfo

onDecodedBarcodesReceived

Event triggered when decoded barcodes are received.

onDecodedBarcodesReceived?(result: DecodedBarcodesUnit, info: IntermediateResultExtraInfo): void;

Parameters

result: The result unit that contains the decoded barcodes, of type DecodedBarcodesUnit.

info: Additional information about the result, of type IntermediateResultExtraInfo.

See Also

DecodedBarcodesUnit

IntermediateResultExtraInfo

onLocalizedTextLinesReceived

Event triggered when localized text lines are received.

onLocalizedTextLinesReceived?(result: LocalizedTextLinesUnit, info: IntermediateResultExtraInfo): void;

Parameters

result: The result unit that contains the localized text lines, of type LocalizedTextLinesUnit.

info: Additional information about the result, of type IntermediateResultExtraInfo.

See Also

LocalizedTextLinesUnit

IntermediateResultExtraInfo

onRecognizedTextLinesReceived

Event triggered when recognized text lines are received.

onRecognizedTextLinesReceived?(result: RecognizedTextLinesUnit, info: IntermediateResultExtraInfo): void;

Parameters

result: The result unit that contains the recognized text lines, of type RecognizedTextLinesUnit.

info: Additional information about the result, of type IntermediateResultExtraInfo.

See Also

RecognizedTextLinesUnit

IntermediateResultExtraInfo

onDetectedQuadsReceived

Event triggered when detected quads are received.

onDetectedQuadsReceived?(result: DetectedQuadsUnit, info: IntermediateResultExtraInfo): void;

Parameters

result: The result unit that contains the detected quads, of type DetectedQuadsUnit.

info: Additional information about the result, of type IntermediateResultExtraInfo.

See Also

DetectedQuadsUnit

IntermediateResultExtraInfo

onNormalizedImagesReceived

Event triggered when normalized images are received.

onNormalizedImagesReceived?(result: NormalizedImagesUnit, info: IntermediateResultExtraInfo): void;

Parameters

result: The result unit that contains the normalized images, of type NormalizedImagesUnit.

info: Additional information about the result, of type IntermediateResultExtraInfo.

See Also

NormalizedImagesUnit

IntermediateResultExtraInfo

onColourImageUnitReceived

Event triggered when a colour image unit is received.

onColourImageUnitReceived?(result: ColourImageUnit, info: IntermediateResultExtraInfo): void;

Parameters

result: The result unit that contains the colour image, of type ColourImageUnit.

info: Additional information about the result, of type IntermediateResultExtraInfo.

See Also

ColourImageUnit

IntermediateResultExtraInfo

onScaledDownColourImageUnitReceived

Event triggered when a scaled-down colour image unit is received.

onScaledDownColourImageUnitReceived?(result: ScaledDownColourImageUnit, info: IntermediateResultExtraInfo): void;

Parameters

result: The result unit that contains the scaled-down colour image, of type ScaledDownColourImageUnit.

info: Additional information about the result, of type IntermediateResultExtraInfo.

See Also

ScaledDownColourImageUnit

IntermediateResultExtraInfo

onGrayscaleImageUnitReceived

Event triggered when a grayscale image unit is received.

onGrayscaleImageUnitReceived?(result: GrayscaleImageUnit, info: IntermediateResultExtraInfo): void;

Parameters

result: The result unit that contains the grayscale image, of type GrayscaleImageUnit.

info: Additional information about the result, of type IntermediateResultExtraInfo.

See Also

GrayscaleImageUnit

IntermediateResultExtraInfo

onTransformedGrayscaleImageUnitReceived

Event triggered when a transformed grayscale image unit is received.

onTransformedGrayscaleImageUnitReceived?(result: TransformedGrayscaleImageUnit, info: IntermediateResultExtraInfo): void;

Parameters

result: The result unit that contains the transformed grayscale image, of type TransformedGrayscaleImageUnit.

info: Additional information about the result, of type IntermediateResultExtraInfo.

See Also

TransformedGrayscaleImageUnit

IntermediateResultExtraInfo

onEnhancedGrayscaleImageUnitReceived

Event triggered when an enhanced grayscale image unit is received.

onEnhancedGrayscaleImageUnitReceived?(result: EnhancedGrayscaleImageUnit, info: IntermediateResultExtraInfo): void;

Parameters

result: The result unit that contains the enhanced grayscale image, of type EnhancedGrayscaleImageUnit.

info: Additional information about the result, of type IntermediateResultExtraInfo.

See Also

EnhancedGrayscaleImageUnit

IntermediateResultExtraInfo

onBinaryImageUnitReceived

Event triggered when a binary image unit is received.

onBinaryImageUnitReceived?(result: BinaryImageUnit, info: IntermediateResultExtraInfo): void;

Parameters

result: The result unit that contains the binary image, of type BinaryImageUnit.

info: Additional information about the result, of type IntermediateResultExtraInfo.

See Also

BinaryImageUnit

IntermediateResultExtraInfo

onTextureDetectionResultUnitReceived

Event triggered when a texture detection result unit is received.

onTextureDetectionResultUnitReceived?(result: TextureDetectionResultUnit, info: IntermediateResultExtraInfo): void;

Parameters

result: The result unit that contains the texture detection result, of type TextureDetectionResultUnit.

info: Additional information about the result, of type IntermediateResultExtraInfo.

See Also

TextureDetectionResultUnit

IntermediateResultExtraInfo

onTextureRemovedGrayscaleImageUnitReceived

Event triggered when a texture-removed grayscale image unit is received.

onTextureRemovedGrayscaleImageUnitReceived?(result: TextureRemovedGrayscaleImageUnit, info: IntermediateResultExtraInfo): void;

Parameters

result: The result unit that contains the texture-removed grayscale image, of type TextureRemovedGrayscaleImageUnit.

info: Additional information about the result, of type IntermediateResultExtraInfo.

See Also

TextureRemovedGrayscaleImageUnit

IntermediateResultExtraInfo

onTextureRemovedBinaryImageUnitReceived

Event triggered when a texture-removed binary image unit is received.

onTextureRemovedBinaryImageUnitReceived?(result: TextureRemovedBinaryImageUnit, info: IntermediateResultExtraInfo): void;

Parameters

result: The result unit that contains the texture-removed binary image, of type TextureRemovedBinaryImageUnit.

info: Additional information about the result, of type IntermediateResultExtraInfo.

See Also

TextureRemovedBinaryImageUnit

IntermediateResultExtraInfo

onContoursUnitReceived

Event triggered when a contours unit is received.

onContoursUnitReceived?(result: ContoursUnit, info: IntermediateResultExtraInfo): void;

Parameters

result: The result unit that contains the contours, of type ContoursUnit.

info: Additional information about the result, of type IntermediateResultExtraInfo.

See Also

ContoursUnit

IntermediateResultExtraInfo

onLineSegmentsUnitReceived

Event triggered when a line segments unit is received.

onLineSegmentsUnitReceived?(result: LineSegmentsUnit, info: IntermediateResultExtraInfo): void;

Parameters

result: The result unit that contains the line segments, of type LineSegmentsUnit.

info: Additional information about the result, of type IntermediateResultExtraInfo.

See Also

LineSegmentsUnit

IntermediateResultExtraInfo

onTextZonesUnitReceived

Event triggered when a text zones unit is received.

onTextZonesUnitReceived?(result: TextZonesUnit, info: IntermediateResultExtraInfo): void;

Parameters

result: The result unit that contains the text zones, of type TextZonesUnit.

info: Additional information about the result, of type IntermediateResultExtraInfo.

See Also

TextZonesUnit

IntermediateResultExtraInfo

onTextRemovedBinaryImageUnitReceived

Event triggered when a text-removed binary image unit is received.

onTextRemovedBinaryImageUnitReceived?(result: TextRemovedBinaryImageUnit, info: IntermediateResultExtraInfo): void;

Parameters

result: The result unit that contains the text-removed binary image, of type TextRemovedBinaryImageUnit.

info: Additional information about the result, of type IntermediateResultExtraInfo.

See Also

TextRemovedBinaryImageUnit

IntermediateResultExtraInfo

onShortLinesUnitReceived

Event triggered when a short lines unit is received.

onShortLinesUnitReceived?(result: ShortLinesUnit, info: IntermediateResultExtraInfo): void;

Parameters

result: The result unit that contains the short lines, of type ShortLinesUnit.

info: Additional information about the result, of type IntermediateResultExtraInfo.

See Also

ShortLinesUnit

IntermediateResultExtraInfo

onLongLinesUnitReceived

Event triggered when a long lines unit is received.

onLongLinesUnitReceived?(result: LongLinesUnit, info: IntermediateResultExtraInfo): void;

Parameters

result: The result unit that contains the long lines, of type LongLinesUnit.

info: Additional information about the result, of type IntermediateResultExtraInfo.

See Also

LongLinesUnit

IntermediateResultExtraInfo

onCornersUnitReceived

Event triggered when a corners unit is received.

onCornersUnitReceived?(result: CornersUnit, info: IntermediateResultExtraInfo): void;

Parameters

result: The result unit that contains the corners, of type CornersUnit.

info: Additional information about the result, of type IntermediateResultExtraInfo.

See Also

CornersUnit

IntermediateResultExtraInfo

onCandidateQuadEdgesUnitReceived

Event triggered when candidate quad edges are detected.

onCandidateQuadEdgesUnitReceived?(result: CandidateQuadEdgesUnit, info: IntermediateResultExtraInfo): void;

Parameters

result: The result unit that contains the candidate quad edges, of type CandidateQuadEdgesUnit.

info: Additional information about the result, of type IntermediateResultExtraInfo.

See Also

CandidateQuadEdgesUnit

IntermediateResultExtraInfo

onCandidateBarcodeZonesUnitReceived

Event triggered when candidate barcode zones are detected.

onCandidateBarcodeZonesUnitReceived?(result: CandidateBarcodeZonesUnit, info: IntermediateResultExtraInfo): void;

Parameters

result: The result unit that contains the candidate barcode zones, of type CandidateBarcodeZonesUnit.

info: Additional information about the result, of type IntermediateResultExtraInfo.

See Also

CandidateBarcodeZonesUnit

IntermediateResultExtraInfo

onScaledUpBarcodeImageUnitReceived

Called when a scaled up barcode image unit is received.

onScaledUpBarcodeImageUnitReceived?(result: ScaledUpBarcodeImageUnit, info: IntermediateResultExtraInfo): void;

Parameters

result: The result unit that contains the scaled up barcode image, of type ScaledUpBarcodeImageUnit.

info: Additional information about the result, of type IntermediateResultExtraInfo.

See Also

ScaledUpBarcodeImageUnit

IntermediateResultExtraInfo

onDeformationResistedBarcodeImageUnitReceived

Called when a deformation resisted barcode image unit is received.

onDeformationResistedBarcodeImageUnitReceived?(result: DeformationResistedBarcodeImageUnit, info: IntermediateResultExtraInfo): void;

Parameters

result: The result unit that contains the deformation resisted barcode image, of type DeformationResistedBarcodeImageUnit.

info: Additional information about the result, of type IntermediateResultExtraInfo.

See Also

DeformationResistedBarcodeImageUnit

IntermediateResultExtraInfo

onComplementedBarcodeImageUnitReceived

Called when a complemented barcode image unit is received.

onComplementedBarcodeImageUnitReceived?(result: ComplementedBarcodeImageUnit, info: IntermediateResultExtraInfo): void;

Parameters

result: The result unit that contains the complemented barcode image, of type ComplementedBarcodeImageUnit.

info: Additional information about the result, of type IntermediateResultExtraInfo.

See Also

ComplementedBarcodeImageUnit

IntermediateResultExtraInfo

This page is compatible for:

Version 1.0

Is this page helpful?

YesYes NoNo

In this article:

latest version

  • Latest version(2.2.30)
  • Version 2.x
    • Version 2.2.10
    • Version 2.0.30
    • Version 2.0.20
    • Version 2.0.10
Change +
© 2003–2024 Dynamsoft. All rights reserved.
Privacy Statement / Site Map / Home / Purchase / Support