View Source Evision.ArUco.GridBoard (Evision v0.1.28)

Link to this section Summary

Types

t()

Type that represents an ArUco.GridBoard struct.

Link to this section Types

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

Type that represents an ArUco.GridBoard struct.

  • ref. reference()

    The underlying erlang resource variable.

Link to this section Functions

@spec getGridSize(t()) :: {number(), number()} | {:error, String.t()}

getGridSize

Positional Arguments
  • self: Evision.ArUco.GridBoard.t()
Return
  • retval: Size

Python prototype (for reference only):

getGridSize() -> retval
@spec getMarkerLength(t()) :: number() | {:error, String.t()}

getMarkerLength

Positional Arguments
  • self: Evision.ArUco.GridBoard.t()
Return
  • retval: float

Python prototype (for reference only):

getMarkerLength() -> retval
Link to this function

getMarkerSeparation(self)

View Source
@spec getMarkerSeparation(t()) :: number() | {:error, String.t()}

getMarkerSeparation

Positional Arguments
  • self: Evision.ArUco.GridBoard.t()
Return
  • retval: float

Python prototype (for reference only):

getMarkerSeparation() -> retval
Link to this function

gridBoard(size, markerLength, markerSeparation, dictionary)

View Source
@spec gridBoard(
  {number(), number()},
  number(),
  number(),
  Evision.ArUco.Dictionary.t()
) ::
  t() | {:error, String.t()}

GridBoard constructor

Positional Arguments
  • size: Size.

    number of markers in x and y directions

  • markerLength: float.

    marker side length (normally in meters)

  • markerSeparation: float.

    separation between two markers (same unit as markerLength)

  • dictionary: Dictionary.

    dictionary of markers indicating the type of markers

Keyword Arguments
  • ids: Evision.Mat.t().

    set of marker ids in dictionary to use on board.

Return
  • self: GridBoard

Python prototype (for reference only):

GridBoard(size, markerLength, markerSeparation, dictionary[, ids]) -> <aruco_GridBoard object>
Link to this function

gridBoard(size, markerLength, markerSeparation, dictionary, opts)

View Source
@spec gridBoard(
  {number(), number()},
  number(),
  number(),
  Evision.ArUco.Dictionary.t(),
  [{atom(), term()}, ...] | nil
) :: t() | {:error, String.t()}

GridBoard constructor

Positional Arguments
  • size: Size.

    number of markers in x and y directions

  • markerLength: float.

    marker side length (normally in meters)

  • markerSeparation: float.

    separation between two markers (same unit as markerLength)

  • dictionary: Dictionary.

    dictionary of markers indicating the type of markers

Keyword Arguments
  • ids: Evision.Mat.t().

    set of marker ids in dictionary to use on board.

Return
  • self: GridBoard

Python prototype (for reference only):

GridBoard(size, markerLength, markerSeparation, dictionary[, ids]) -> <aruco_GridBoard object>