Back to FabImage Library website

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

ReadSinglePDF417Code


Header: FIL.h
Namespace: fil
Module: Datacodes

Detects and recognizes one PDF417 code.

Syntax

C++
C#
 
void fil::ReadSinglePDF417Code
(
	const fil::Image& inImage,
	ftl::Optional<const fil::Rectangle2D&> inRoi,
	ftl::Optional<const fil::CoordinateSystem2D&> inRoiAlignment,
	const fil::PDF417CodeParams& inCodeParams,
	const fil::PDF417DetectionParams& inDetectionParams,
	ftl::Conditional<fil::PDF417Code>& outPDF417Code,
	ftl::Optional<fil::Rectangle2D&> outAlignedRoi = ftl::NIL
)

Parameters

Name Type Default Description
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 PDF417CodeParams& Specification of codes that can be detected
Input value inDetectionParams const PDF417DetectionParams& Specification of the way the code is being detected
Output value outPDF417Code Conditional<PDF417Code>& Found PDF417 code
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 ftl::NIL to these parameters: outAlignedRoi.

Read more about Optional Outputs.

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.