cv::aruco::GridBoard Class Reference

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 can be drawn using drawPlanarBoard() function (. More...

#include <aruco.hpp>

Inheritance diagram for cv::aruco::GridBoard:

Public Member Functions
CV_WRAP void	draw (Size outSize, OutputArray img, int marginSize=0, int borderBits=1)
	Draw a GridBoard. More...
CV_WRAP Size	getGridSize () const
CV_WRAP float	getMarkerLength () const
CV_WRAP float	getMarkerSeparation () const

Static Public Member Functions
static CV_WRAP Ptr< GridBoard >	create (int markersX, int markersY, float markerLength, float markerSeparation, const Ptr< Dictionary > &dictionary, int firstMarker=0)
	Create a GridBoard object. More...
Static Public Member Functions inherited from cv::aruco::Board
static CV_WRAP 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...

Private Attributes
float	_markerLength
float	_markerSeparation
int	_markersX
int	_markersY

Additional Inherited Members
Public Attributes inherited from cv::aruco::Board
CV_PROP Ptr< Dictionary >	dictionary
	the dictionary of markers employed for this board More...
CV_PROP std::vector< int >	ids
CV_PROP std::vector< std::vector< Point3f > >	objPoints

Detailed Description

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 can be drawn using drawPlanarBoard() function (.

See also

drawPlanarBoard)

Definition at line 303 of file aruco.hpp.

Member Function Documentation

create()

Ptr< GridBoard > cv::aruco::GridBoard::create ( int  markersX, int  markersY, float  markerLength, float  markerSeparation, const Ptr< Dictionary > &  dictionary, int  firstMarker = 0  )

static

Create a GridBoard object.

Parameters

markersX	number of markers in X direction
markersY	number of markers in Y direction
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
firstMarker	id of first marker in dictionary to use on board.

Returns

the output GridBoard object

This functions creates a GridBoard object given the number of markers in each direction and the marker size and marker separation.

Definition at line 1658 of file aruco.cpp.

draw()

void cv::aruco::GridBoard::draw	(	Size	outSize,
		OutputArray	img,
		int	marginSize = 0,
		int	borderBits = 1
	)

Draw a GridBoard.

Parameters

outSize	size of the output image in pixels.
img	output image with the board. The size of this image will be outSize and the board will be on the center, keeping the board proportions.
marginSize	minimum margins (in pixels) of the board in the output image
borderBits	width of the marker borders.

This function return the image of the GridBoard, ready to be printed.

Definition at line 1622 of file aruco.cpp.

getGridSize()

CV_WRAP Size cv::aruco::GridBoard::getGridSize ( ) const

inline

Definition at line 340 of file aruco.hpp.

getMarkerLength()

CV_WRAP float cv::aruco::GridBoard::getMarkerLength ( ) const

inline

Definition at line 345 of file aruco.hpp.

getMarkerSeparation()

CV_WRAP float cv::aruco::GridBoard::getMarkerSeparation ( ) const

inline

Definition at line 350 of file aruco.hpp.

Member Data Documentation

_markerLength

float cv::aruco::GridBoard::_markerLength

private

Definition at line 358 of file aruco.hpp.

_markerSeparation

float cv::aruco::GridBoard::_markerSeparation

private

Definition at line 361 of file aruco.hpp.

_markersX

int cv::aruco::GridBoard::_markersX

private

Definition at line 355 of file aruco.hpp.

_markersY

int cv::aruco::GridBoard::_markersY

private

Definition at line 355 of file aruco.hpp.

---

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

• aruco.hpp
• aruco.cpp