View Source Evision.GraphicalCodeDetector (Evision v0.2.9)

Summary

Types

t()

Type that represents an GraphicalCodeDetector struct.

Functions

decode(named_args)

decode(self, img, points)

Decodes graphical code in image once it's found by the detect() method.

decode(self, img, points, opts)

Decodes graphical code in image once it's found by the detect() method.

decodeMulti(named_args)

decodeMulti(self, img, points)

Decodes graphical codes in image once it's found by the detect() method.

decodeMulti(self, img, points, opts)

Decodes graphical codes in image once it's found by the detect() method.

detect(named_args)

detect(self, img)

Detects graphical code in image and returns the quadrangle containing the code.

detect(self, img, opts)

Detects graphical code in image and returns the quadrangle containing the code.

detectAndDecode(named_args)

detectAndDecode(self, img)

Both detects and decodes graphical code

detectAndDecode(self, img, opts)

Both detects and decodes graphical code

detectAndDecodeMulti(named_args)

detectAndDecodeMulti(self, img)

Both detects and decodes graphical codes

detectAndDecodeMulti(self, img, opts)

Both detects and decodes graphical codes

detectMulti(named_args)

detectMulti(self, img)

Detects graphical codes in image and returns the vector of the quadrangles containing the codes.

detectMulti(self, img, opts)

Detects graphical codes in image and returns the vector of the quadrangles containing the codes.

Types

t()

@type t() :: %Evision.GraphicalCodeDetector{ref: reference()}

Type that represents an GraphicalCodeDetector struct.

ref. reference()
The underlying erlang resource variable.

Functions

decode(named_args)

@spec decode(Keyword.t()) :: any() | {:error, String.t()}

decode(self, img, points)

@spec decode(t(), Evision.Mat.maybe_mat_in(), Evision.Mat.maybe_mat_in()) ::
  {binary(), Evision.Mat.t()} | {:error, String.t()}

Decodes graphical code in image once it's found by the detect() method.

Positional Arguments

self: Evision.GraphicalCodeDetector.t()
img: Evision.Mat.
grayscale or color (BGR) image containing graphical code.
points: Evision.Mat.
Quadrangle vertices found by detect() method (or some other algorithm).

Return

retval: string
straight_code: Evision.Mat.t().
The optional output image containing binarized code, will be empty if not found.

Returns UTF8-encoded output string or empty string if the code cannot be decoded.

Python prototype (for reference only):

decode(img, points[, straight_code]) -> retval, straight_code

decode(self, img, points, opts)

@spec decode(
  t(),
  Evision.Mat.maybe_mat_in(),
  Evision.Mat.maybe_mat_in(),
  [{atom(), term()}, ...] | nil
) ::
  {binary(), Evision.Mat.t()} | {:error, String.t()}

Decodes graphical code in image once it's found by the detect() method.

Positional Arguments

self: Evision.GraphicalCodeDetector.t()
img: Evision.Mat.
grayscale or color (BGR) image containing graphical code.
points: Evision.Mat.
Quadrangle vertices found by detect() method (or some other algorithm).

Return

retval: string
straight_code: Evision.Mat.t().
The optional output image containing binarized code, will be empty if not found.

Returns UTF8-encoded output string or empty string if the code cannot be decoded.

Python prototype (for reference only):

decode(img, points[, straight_code]) -> retval, straight_code

decodeMulti(named_args)

@spec decodeMulti(Keyword.t()) :: any() | {:error, String.t()}

decodeMulti(self, img, points)

@spec decodeMulti(t(), Evision.Mat.maybe_mat_in(), Evision.Mat.maybe_mat_in()) ::
  {[binary()], [Evision.Mat.t()]} | false | {:error, String.t()}

Decodes graphical codes in image once it's found by the detect() method.

Positional Arguments

self: Evision.GraphicalCodeDetector.t()
img: Evision.Mat.
grayscale or color (BGR) image containing graphical codes.
points: Evision.Mat.
vector of Quadrangle vertices found by detect() method (or some other algorithm).

Return

retval: bool
decoded_info: [string].
UTF8-encoded output vector of string or empty vector of string if the codes cannot be decoded.
straight_code: [Evision.Mat].
The optional output vector of images containing binarized codes

Python prototype (for reference only):

decodeMulti(img, points[, straight_code]) -> retval, decoded_info, straight_code

decodeMulti(self, img, points, opts)

@spec decodeMulti(
  t(),
  Evision.Mat.maybe_mat_in(),
  Evision.Mat.maybe_mat_in(),
  [{atom(), term()}, ...] | nil
) :: {[binary()], [Evision.Mat.t()]} | false | {:error, String.t()}

Decodes graphical codes in image once it's found by the detect() method.

Positional Arguments

self: Evision.GraphicalCodeDetector.t()
img: Evision.Mat.
grayscale or color (BGR) image containing graphical codes.
points: Evision.Mat.
vector of Quadrangle vertices found by detect() method (or some other algorithm).

Return

retval: bool
decoded_info: [string].
UTF8-encoded output vector of string or empty vector of string if the codes cannot be decoded.
straight_code: [Evision.Mat].
The optional output vector of images containing binarized codes

Python prototype (for reference only):

decodeMulti(img, points[, straight_code]) -> retval, decoded_info, straight_code

detect(named_args)

@spec detect(Keyword.t()) :: any() | {:error, String.t()}

detect(self, img)

@spec detect(t(), Evision.Mat.maybe_mat_in()) ::
  Evision.Mat.t() | false | {:error, String.t()}

Detects graphical code in image and returns the quadrangle containing the code.

Positional Arguments

self: Evision.GraphicalCodeDetector.t()
img: Evision.Mat.
grayscale or color (BGR) image containing (or not) graphical code.

Return

retval: bool
points: Evision.Mat.t().
Output vector of vertices of the minimum-area quadrangle containing the code.

Python prototype (for reference only):

detect(img[, points]) -> retval, points

detect(self, img, opts)

@spec detect(t(), Evision.Mat.maybe_mat_in(), [{atom(), term()}, ...] | nil) ::
  Evision.Mat.t() | false | {:error, String.t()}

Detects graphical code in image and returns the quadrangle containing the code.

Positional Arguments

self: Evision.GraphicalCodeDetector.t()
img: Evision.Mat.
grayscale or color (BGR) image containing (or not) graphical code.

Return

retval: bool
points: Evision.Mat.t().
Output vector of vertices of the minimum-area quadrangle containing the code.

Python prototype (for reference only):

detect(img[, points]) -> retval, points

detectAndDecode(named_args)

@spec detectAndDecode(Keyword.t()) :: any() | {:error, String.t()}

detectAndDecode(self, img)

@spec detectAndDecode(t(), Evision.Mat.maybe_mat_in()) ::
  {binary(), Evision.Mat.t(), Evision.Mat.t()} | {:error, String.t()}

Both detects and decodes graphical code

Positional Arguments

self: Evision.GraphicalCodeDetector.t()
img: Evision.Mat.
grayscale or color (BGR) image containing graphical code.

Return

retval: string
points: Evision.Mat.t().
optional output array of vertices of the found graphical code quadrangle, will be empty if not found.
straight_code: Evision.Mat.t().
The optional output image containing binarized code

Python prototype (for reference only):

detectAndDecode(img[, points[, straight_code]]) -> retval, points, straight_code

detectAndDecode(self, img, opts)

@spec detectAndDecode(t(), Evision.Mat.maybe_mat_in(), [{atom(), term()}, ...] | nil) ::
  {binary(), Evision.Mat.t(), Evision.Mat.t()} | {:error, String.t()}

Both detects and decodes graphical code

Positional Arguments

self: Evision.GraphicalCodeDetector.t()
img: Evision.Mat.
grayscale or color (BGR) image containing graphical code.

Return

retval: string
points: Evision.Mat.t().
optional output array of vertices of the found graphical code quadrangle, will be empty if not found.
straight_code: Evision.Mat.t().
The optional output image containing binarized code

Python prototype (for reference only):

detectAndDecode(img[, points[, straight_code]]) -> retval, points, straight_code

detectAndDecodeMulti(named_args)

@spec detectAndDecodeMulti(Keyword.t()) :: any() | {:error, String.t()}

detectAndDecodeMulti(self, img)

@spec detectAndDecodeMulti(t(), Evision.Mat.maybe_mat_in()) ::
  {[binary()], Evision.Mat.t(), [Evision.Mat.t()]}
  | false
  | {:error, String.t()}

Both detects and decodes graphical codes

Positional Arguments

self: Evision.GraphicalCodeDetector.t()
img: Evision.Mat.
grayscale or color (BGR) image containing graphical codes.

Return

retval: bool
decoded_info: [string].
UTF8-encoded output vector of string or empty vector of string if the codes cannot be decoded.
points: Evision.Mat.t().
optional output vector of vertices of the found graphical code quadrangles. Will be empty if not found.
straight_code: [Evision.Mat].
The optional vector of images containing binarized codes
If there are QR codes encoded with a Structured Append mode on the image and all of them detected and decoded correctly, method writes a full message to position corresponds to 0-th code in a sequence. The rest of QR codes from the same sequence have empty string.

Python prototype (for reference only):

detectAndDecodeMulti(img[, points[, straight_code]]) -> retval, decoded_info, points, straight_code

detectAndDecodeMulti(self, img, opts)

@spec detectAndDecodeMulti(
  t(),
  Evision.Mat.maybe_mat_in(),
  [{atom(), term()}, ...] | nil
) ::
  {[binary()], Evision.Mat.t(), [Evision.Mat.t()]}
  | false
  | {:error, String.t()}

Both detects and decodes graphical codes

Positional Arguments

self: Evision.GraphicalCodeDetector.t()
img: Evision.Mat.
grayscale or color (BGR) image containing graphical codes.

Return

retval: bool
decoded_info: [string].
UTF8-encoded output vector of string or empty vector of string if the codes cannot be decoded.
points: Evision.Mat.t().
optional output vector of vertices of the found graphical code quadrangles. Will be empty if not found.
straight_code: [Evision.Mat].
The optional vector of images containing binarized codes
If there are QR codes encoded with a Structured Append mode on the image and all of them detected and decoded correctly, method writes a full message to position corresponds to 0-th code in a sequence. The rest of QR codes from the same sequence have empty string.

Python prototype (for reference only):

detectAndDecodeMulti(img[, points[, straight_code]]) -> retval, decoded_info, points, straight_code

detectMulti(named_args)

@spec detectMulti(Keyword.t()) :: any() | {:error, String.t()}

detectMulti(self, img)

@spec detectMulti(t(), Evision.Mat.maybe_mat_in()) ::
  Evision.Mat.t() | false | {:error, String.t()}

Detects graphical codes in image and returns the vector of the quadrangles containing the codes.

Positional Arguments

self: Evision.GraphicalCodeDetector.t()
img: Evision.Mat.
grayscale or color (BGR) image containing (or not) graphical codes.

Return

retval: bool
points: Evision.Mat.t().
Output vector of vector of vertices of the minimum-area quadrangle containing the codes.

Python prototype (for reference only):

detectMulti(img[, points]) -> retval, points

detectMulti(self, img, opts)

@spec detectMulti(t(), Evision.Mat.maybe_mat_in(), [{atom(), term()}, ...] | nil) ::
  Evision.Mat.t() | false | {:error, String.t()}

Detects graphical codes in image and returns the vector of the quadrangles containing the codes.

Positional Arguments

self: Evision.GraphicalCodeDetector.t()
img: Evision.Mat.
grayscale or color (BGR) image containing (or not) graphical codes.

Return

retval: bool
points: Evision.Mat.t().
Output vector of vector of vertices of the minimum-area quadrangle containing the codes.

Python prototype (for reference only):

detectMulti(img[, points]) -> retval, points