#include <opencv2/aruco.hpp>

Inheritance diagram for cv::aruco::Board:

Public Member Functions
void	setIds (InputArray ids)
	Set ids vector. More...

Static Public Member Functions
static Ptr< Board >	create (InputArrayOfArrays objPoints, const Ptr< Dictionary > &dictionary, InputArray ids)
	Provide way to create Board by passing necessary data. Specially needed in Python. More...

Public Attributes
Ptr< Dictionary >	dictionary
	the dictionary of markers employed for this board More...

std::vector< int >	ids

std::vector< std::vector< Point3f > >	objPoints

Point3f	rightBottomBorder
	coordinate of the bottom right corner of the board, is set when calling the function create() More...

Detailed Description

Board of markers.

A board is a set of markers in the 3D space with a common coordinate system. The common form of a board of marker is a planar (2D) board, however any 3D layout can be used. A Board object is composed by:

The object points of the marker corners, i.e. their coordinates respect to the board system.
The dictionary which indicates the type of markers of the board
The identifier of all the markers in the board.

Member Function Documentation

◆ create()

static Ptr<Board> cv::aruco::Board::create	(	InputArrayOfArrays	objPoints,
		const Ptr< Dictionary > &	dictionary,
		InputArray	ids
	)

static

Python:
	cv.aruco.Board.create(	objPoints, dictionary, ids	) ->	retval
	cv.aruco.Board_create(	objPoints, dictionary, ids	) ->	retval

Provide way to create Board by passing necessary data. Specially needed in Python.

Parameters

objPoints	array of object points of all the marker corners in the board
dictionary	the dictionary of markers employed for this board
ids	vector of the identifiers of the markers in the board

◆ setIds()

void cv::aruco::Board::setIds ( InputArray ids )

Python:
	cv.aruco.Board.setIds(	ids	) ->	None

Set ids vector.

Parameters

ids	vector of the identifiers of the markers in the board (should be the same size as objPoints)

Recommended way to set ids vector, which will fail if the size of ids does not match size of objPoints.

Member Data Documentation

◆ dictionary

Ptr<Dictionary> cv::aruco::Board::dictionary

the dictionary of markers employed for this board

◆ ids

std::vector< int > cv::aruco::Board::ids

vector of the identifiers of the markers in the board (same size than objPoints) The identifiers refers to the board dictionary

◆ objPoints

std::vector< std::vector< Point3f > > cv::aruco::Board::objPoints

array of object points of all the marker corners in the board each marker include its 4 corners in this order:

objPoints[i][0] - left-top point of i-th marker
objPoints[i][1] - right-top point of i-th marker
objPoints[i][2] - right-bottom point of i-th marker
objPoints[i][3] - left-bottom point of i-th marker

Markers are placed in a certain order - row by row, left to right in every row. For M markers, the size is Mx4.

◆ rightBottomBorder

Point3f cv::aruco::Board::rightBottomBorder

coordinate of the bottom right corner of the board, is set when calling the function create()

The documentation for this class was generated from the following file:

opencv2/aruco.hpp

Public Member Functions

Static Public Member Functions

Public Attributes