Back to Aurora Vision Library website

You are here: Start » Function Reference » Computer Vision » Datacodes » ReadSingleCode_IK

ReadSingleCode_IK


Header: AVL.h
Namespace: avl
Module: Datacodes

Detects and recognizes Codes in one image.

Syntax

C++
C#
 
void avl::ReadSingleCode_IK
(
	const avl::Image& inImage,
	atl::Optional<const avl::Rectangle2D&> inRoi,
	avl::CodeInverse1D::Type inInverse,
	atl::Optional<int> inTimeout,
	const avl::CodeDetectionParameters& inDetectionParameters,
	bool inEnableCode39,
	atl::Optional<const avl::Code128Parameters&> inEnableCode128,
	bool inEnableInterleaved2of5,
	atl::Optional<const avl::DatamatrixParameters&> inEnableDatamatrix,
	bool inEnablePDF417,
	bool inEnableQRCode,
	bool inEnableUPCEAN,
	bool inEnableCode93,
	bool inEnableDotCode,
	bool inEnableMaxiCode,
	bool inEnableAztec,
	bool inEnableMSI,
	atl::Optional<const avl::CodabarParameters&> inEnableCodabar,
	atl::Optional<const avl::GS1DatabarParameters&> inEnableGS1Databar,
	atl::Conditional<atl::String>& outResult,
	atl::Conditional<avl::Path>& outOutline,
	atl::Conditional<avl::CodeFormat::Type>& outCodeFormat,
	atl::Conditional<float>& outPPM
)

Parameters

Name Type Default Description
Input value inImage const Image& Input image
Input value inRoi Optional<const Rectangle2D&> NIL Region of interest
Input value inInverse CodeInverse1D::Type
Input value inTimeout Optional<int> NIL Processing timeout
Input value inDetectionParameters const CodeDetectionParameters&
Input value inEnableCode39 bool True
Input value inEnableCode128 Optional<const Code128Parameters&> Code128Parameters ( )
Input value inEnableInterleaved2of5 bool True
Input value inEnableDatamatrix Optional<const DatamatrixParameters&> DatamatrixParameters ( )
Input value inEnablePDF417 bool True
Input value inEnableQRCode bool True
Input value inEnableUPCEAN bool True
Input value inEnableCode93 bool
Input value inEnableDotCode bool
Input value inEnableMaxiCode bool
Input value inEnableAztec bool
Input value inEnableMSI bool
Input value inEnableCodabar Optional<const CodabarParameters&> NIL
Input value inEnableGS1Databar Optional<const GS1DatabarParameters&> NIL
Output value outResult Conditional<String>&
Output value outOutline Conditional<Path>&
Output value outCodeFormat Conditional<CodeFormat::Type>&
Output value outPPM Conditional<float>& Pixels per module

Remarks

It is only possible to run it in one thread (Worker Task) in application.

Errors

List of possible exceptions:

Error type Description
DomainError ReadSingleCode_IK is supported only in x64 environment.

See Also