OpenCV  4.8.0
Open Source Computer Vision
Public Member Functions | List of all members

Planar board with grid arrangement of markers. More...

#include <opencv2/objdetect/aruco_board.hpp>

Inheritance diagram for cv::aruco::GridBoard:
cv::aruco::Board

Public Member Functions

 GridBoard (const Size &size, float markerLength, float markerSeparation, const Dictionary &dictionary, InputArray ids=noArray())
 GridBoard constructor. More...
 
 GridBoard ()
 
Size getGridSize () const
 
float getMarkerLength () const
 
float getMarkerSeparation () const
 
- Public Member Functions inherited from cv::aruco::Board
 Board (InputArrayOfArrays objPoints, const Dictionary &dictionary, InputArray ids)
 Common Board constructor. More...
 
 Board ()
 
void generateImage (Size outSize, OutputArray img, int marginSize=0, int borderBits=1) const
 Draw a planar board. More...
 
const DictionarygetDictionary () const
 return the Dictionary of markers employed for this board More...
 
const std::vector< int > & getIds () const
 vector of the identifiers of the markers in the board (should be the same size as objPoints) More...
 
const std::vector< std::vector< Point3f > > & getObjPoints () const
 return array of object points of all the marker corners in the board. More...
 
const Point3fgetRightBottomCorner () const
 get coordinate of the bottom right corner of the board, is set when calling the function create() More...
 
void matchImagePoints (InputArrayOfArrays detectedCorners, InputArray detectedIds, OutputArray objPoints, OutputArray imgPoints) const
 Given a board configuration and a set of detected markers, returns the corresponding image points and object points, can be used in solvePnP() More...
 

Additional Inherited Members

- Protected Member Functions inherited from cv::aruco::Board
 Board (const Ptr< Impl > &impl)
 
- Protected Attributes inherited from cv::aruco::Board
Ptr< Impl > impl
 

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 image can be drawn using generateImage() method.

Constructor & Destructor Documentation

◆ GridBoard() [1/2]

cv::aruco::GridBoard::GridBoard ( const Size size,
float  markerLength,
float  markerSeparation,
const Dictionary dictionary,
InputArray  ids = noArray() 
)

GridBoard constructor.

Parameters
sizenumber of markers in x and y directions
markerLengthmarker side length (normally in meters)
markerSeparationseparation between two markers (same unit as markerLength)
dictionarydictionary of markers indicating the type of markers
idsset of marker ids in dictionary to use on board.

◆ GridBoard() [2/2]

cv::aruco::GridBoard::GridBoard ( )

Member Function Documentation

◆ getGridSize()

Size cv::aruco::GridBoard::getGridSize ( ) const
Python:
cv.aruco.GridBoard.getGridSize() -> retval

◆ getMarkerLength()

float cv::aruco::GridBoard::getMarkerLength ( ) const
Python:
cv.aruco.GridBoard.getMarkerLength() -> retval

◆ getMarkerSeparation()

float cv::aruco::GridBoard::getMarkerSeparation ( ) const
Python:
cv.aruco.GridBoard.getMarkerSeparation() -> retval

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