Back to Aurora Vision Library website

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

ReadSingleDatacode_Deprecated


Header: AVL.h
Namespace: avl
Module: Datacodes

Detects and recognizes one Data Code.

Syntax

void avl::ReadSingleDatacode_Deprecated
(
	avl::ReadDataCodes_State& ioState,
	const avl::Image& inImage,
	atl::Optional<const avl::Rectangle2D&> inRoi,
	atl::Optional<const avl::CoordinateSystem2D&> inRoiAlignment,
	const avl::DatacodeParams& inCodeParams,
	const avl::DatacodeDetectionParams& inDetectionParams,
	bool inComputeScores,
	const avl::DataCodeTypeSelection& inTypeSelection,
	atl::Conditional<avl::DataCode>& outDataCode,
	atl::Array<avl::Path>& outCandidates,
	atl::Optional<avl::Rectangle2D&> outAlignedRoi = atl::NIL
)

Parameters

Name Type Default Description
Input will be modified ioState ReadDataCodes_State& Object used to maintain state of the function.
Input value inImage const Image& Input image
Input value inRoi Optional<const Rectangle2D&> NIL Region of interest
Input value inRoiAlignment Optional<const CoordinateSystem2D&> NIL Coordinate system for the region of interest
Input value inCodeParams const DatacodeParams& Specification of codes that can be detected
Input value inDetectionParams const DatacodeDetectionParams& Parameters of the code detection algorithm
Input value inComputeScores bool Enables computing of confidence scores (slower)
Input value inTypeSelection const DataCodeTypeSelection& Specifies which code types the filter should try to read
Output value outDataCode Conditional<DataCode>& A code that has been correctly detected and decoded
Output value outCandidates Array<Path>& Diagnostic information about detection results
Output value outAlignedRoi Optional<Rectangle2D&> NIL Input ROI after transformation (in the image coordinates)

Optional Outputs

The computation of following outputs can be switched off by passing value atl::NIL to these parameters: outAlignedRoi.

Read more about Optional Outputs.