CodeReader Class Reference

#include <peak_icv/algorithms/code_reader/peak_icv_code_reader.hpp>

Public Member Functions
	CodeReader ()
	Creates an instance of a code reader.
	~CodeReader ()
	CodeReader (const CodeReader &other)=delete
	CodeReader (CodeReader &&other) noexcept
CodeReader &	operator= (const CodeReader &other)=delete
CodeReader &	operator= (CodeReader &&other) noexcept
std::vector< CodeType >	GetCodeTypesToDetect () const
	Retrieves the number of configured code types.
void	setCodeTypesToDetect (const std::vector< CodeType > &codeTypesToDetect) const
	Sets the allowed code types for detection and decoding.
std::vector< CodeReaderResult >	DetectAndDecode (const Image &image) const
	Detects and decodes codes in an input image.
void	SetMaximumNumberOfCodesToDetect (size_t count) const
	Sets the maximum number of codes to detect per call.
size_t	GetMaximumNumberOfCodesToDetect () const
	Retrieves the maximum number of codes to detect per call.

Detailed Description

Class to read codes from an image.

Since

ids_peak_icv 1.2

Warning

This function is still in development and not released.

Constructor & Destructor Documentation

CodeReader() [1/3]

CodeReader ( )

inline

Creates an instance of a code reader.

Since

ids_peak_icv 1.2

Warning

This function is still in development and not released.

~CodeReader()

~CodeReader ( )

inline

Since

ids_peak_icv 1.2

Warning

This function is still in development and not released.

CodeReader() [2/3]

CodeReader ( const CodeReader & other )

delete

CodeReader() [3/3]

CodeReader ( CodeReader && other )

inlinenoexcept

Since

ids_peak_icv 1.2

Warning

This function is still in development and not released.

Member Function Documentation

DetectAndDecode()

std::vector< CodeReaderResult > DetectAndDecode ( const Image & image ) const

inline

Detects and decodes codes in an input image.

Attempts to find codes of the configured types in image and decodes their payload.

Returns

The found and decoded Codes in a CodeReaderResult

Since

ids_peak_icv 1.2

Warning

This function is still in development and not released.

GetCodeTypesToDetect()

std::vector< CodeType > GetCodeTypesToDetect ( ) const

inline

Retrieves the number of configured code types.

When no explicit code types are set via setCodeTypesToDetect, the implementation-defined default set is active.

Since

ids_peak_icv 1.2

Warning

This function is still in development and not released.

GetMaximumNumberOfCodesToDetect()

size_t GetMaximumNumberOfCodesToDetect ( ) const

inline

Retrieves the maximum number of codes to detect per call.

Returns the current limit configured via SetMaximumNumberOfCodesToDetect.

Since

ids_peak_icv 1.2

Warning

This function is still in development and not released.

operator=() [1/2]

CodeReader & operator= ( CodeReader && other )

inlinenoexcept

Since

ids_peak_icv 1.2

Warning

This function is still in development and not released.

operator=() [2/2]

CodeReader & operator= ( const CodeReader & other )

delete

setCodeTypesToDetect()

void setCodeTypesToDetect ( const std::vector< CodeType > & codeTypesToDetect ) const

inline

Sets the allowed code types for detection and decoding.

Restricts the Code Reader to the provided list of CodeType values.

Since

ids_peak_icv 1.2

Warning

This function is still in development and not released.

SetMaximumNumberOfCodesToDetect()

void SetMaximumNumberOfCodesToDetect ( size_t count ) const

inline

Sets the maximum number of codes to detect per call.

Limits how many codes the detector will return for a single invocation of DetectAndDecode. This can be used to cap runtime and memory usage in scenarios with many codes present.

Since

ids_peak_icv 1.2

Warning

This function is still in development and not released.