You are here: Start » Function Reference » Datacodes » ReadSinglePDF417Code

ReadSinglePDF417Code

Header:	AVL.h
Namespace:	avl

Detects and recognizes one PDF417 code.

Syntax

void avl::ReadSinglePDF417Code
(
	const avl::Image& inImage,
	atl::Optional<const avl::Rectangle2D&> inRoi,
	atl::Optional<const avl::CoordinateSystem2D&> inRoiAlignment,
	const avl::PDF417CodeParams& inCodeParams,
	const avl::PDF417DetectionParams& inDetectionParams,
	atl::Conditional<avl::PDF417Code>& outPDF417Code,
	atl::Optional<avl::Rectangle2D&> outAlignedRoi = atl::NIL
)

Parameters

Name	Type	Default	Description
inImage	const Image&		Input image
inRoi	Optional<const Rectangle2D&>	NIL	Region of interest
inRoiAlignment	Optional<const CoordinateSystem2D&>	NIL	Coordinate system for the region of interest
inCodeParams	const PDF417CodeParams&		Specification of codes that can be detected
inDetectionParams	const PDF417DetectionParams&		Specification of the way the code is being detected
outPDF417Code	Conditional<PDF417Code>&		Found PDF417 code
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.

Hints

If code is not detected, try to use ResizeImage on it before processing with ReadSinglePDF417Code.

Remarks

In inCodeParams the parameter MinModuleSize should be more or equal to 3. For values less than 3 it is not guaranteed, that ReadSinglePDF417Code will process code properly.