Skip to content

aruco_GridBoard

objdetectclassOpenCV 5.0.0
import { aruco_GridBoard } from '@banou/opencv-wasm'

Use after await initOpenCV(). See the initialization and named imports guide.

ARGUMENTSConstructor or factory
CLASSaruco_GridBoard
RETURN TYPEOwned native handle
Call structure. A void return can still write to destination arguments. The parameter descriptions define inputs, outputs and ownership.

Native object: release it with using or delete(). Factories can return null; check before calling methods. Inherits aruco_Board.

Planar board with grid arrangement of markers

More common type of board. All markers are placed in the same plane in a grid arrangement. The board image can be drawn using generateImage() method.

Constructors and members

static new

GridBoard constructor

new(size: Size, markerLength: number, markerSeparation: number, dictionary: aruco_Dictionary, ids: Mat): aruco_GridBoard;
2 available overloads
new(size: Size, markerLength: number, markerSeparation: number, dictionary: aruco_Dictionary): aruco_GridBoard;
new(size: Size, markerLength: number, markerSeparation: number, dictionary: aruco_Dictionary, ids: Mat): aruco_GridBoard;
size

number of markers in x and y directions

markerLength

marker side length (normally in meters)

markerSeparation

separation between two markers (same unit as markerLength)

dictionary

dictionary of markers indicating the type of markers

ids

set of marker ids in dictionary to use on board.

Returns

The aruco_GridBoard result.

clone

Create another handle to the same native object. This retains the object without copying its pixels or algorithm state; dispose both handles separately.

clone(): this;
Returns

The this result.

getGridSize

Return the grid size configured on this aruco_GridBoard object.

getGridSize(): Size;
Returns

The Size result.

getMarkerLength

Return the marker length configured on this aruco_GridBoard object.

getMarkerLength(): number;
Returns

The number result.

getMarkerSeparation

Return the marker separation configured on this aruco_GridBoard object.

getMarkerSeparation(): number;
Returns

The number result.

These signatures describe this package. Upstream documentation can mention optional backends that are absent from this build. Check runtime compatibility before choosing a backend or file format.