org.bytedeco.opencv.opencv_aruco

Class CharucoBoard

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.opencv.opencv_aruco.Board

org.bytedeco.opencv.opencv_aruco.CharucoBoard

All Implemented Interfaces:

AutoCloseable

@Namespace(value="cv::aruco")
 @NoOffset
 @Properties(inherit=opencv_aruco.class)
public class CharucoBoard
extends Board

\addtogroup aruco \{

/** \brief ChArUco board Specific class for ChArUco boards. A ChArUco board is a planar board where the markers are placed inside the white squares of a chessboard. The benefits of ChArUco boards is that they provide both, ArUco markers versatility and chessboard corner precision, which is important for calibration and pose estimation. This class also allows the easy creation and drawing of ChArUco boards.

Nested Class Summary

Nested classes/interfaces inherited from class org.bytedeco.javacpp.Pointer

Pointer.CustomDeallocator, Pointer.Deallocator, Pointer.NativeDeallocator, Pointer.ReferenceCounter

Field Summary

Fields inherited from class org.bytedeco.javacpp.Pointer

address, capacity, limit, position

Constructor Summary

Constructors

Constructor and Description
CharucoBoard() Default native constructor.
CharucoBoard(long size) Native array allocator.
CharucoBoard(Pointer p) Pointer cast constructor.

Method Summary

Modifier and Type	Method and Description
Point3fVector	chessboardCorners()
CharucoBoard	chessboardCorners(Point3fVector setter)
static CharucoBoard	create(int squaresX, int squaresY, float squareLength, float markerLength, Dictionary dictionary) \brief Create a CharucoBoard object
void	draw(Size outSize, GpuMat img)
void	draw(Size outSize, GpuMat img, int marginSize, int borderBits)
void	draw(Size outSize, Mat img)
void	draw(Size outSize, Mat img, int marginSize, int borderBits) \brief Draw a ChArUco board
void	draw(Size outSize, UMat img)
void	draw(Size outSize, UMat img, int marginSize, int borderBits)
Size	getChessboardSize()
float	getMarkerLength()
float	getSquareLength()
IntVectorVector	nearestMarkerCorners()
CharucoBoard	nearestMarkerCorners(IntVectorVector setter)
IntVectorVector	nearestMarkerIdx()
CharucoBoard	nearestMarkerIdx(IntVectorVector setter)
CharucoBoard	position(long position)

Methods inherited from class org.bytedeco.opencv.opencv_aruco.Board

create, create, create, create, create, create, create, create, create, dictionary, dictionary, ids, ids, objPoints, objPoints

Methods inherited from class org.bytedeco.javacpp.Pointer

address, asBuffer, asByteBuffer, availablePhysicalBytes, calloc, capacity, capacity, close, deallocate, deallocate, deallocateReferences, deallocator, deallocator, equals, fill, formatBytes, free, hashCode, isNull, isNull, limit, limit, malloc, maxBytes, maxPhysicalBytes, memchr, memcmp, memcpy, memmove, memset, offsetof, parseBytes, physicalBytes, position, put, realloc, referenceCount, releaseReference, retainReference, setNull, sizeof, toString, totalBytes, totalPhysicalBytes, withDeallocator, zero

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CharucoBoard

public CharucoBoard()

Default native constructor.

CharucoBoard

public CharucoBoard(long size)

Native array allocator. Access with Pointer.position(long).

CharucoBoard

public CharucoBoard(Pointer p)

Pointer cast constructor. Invokes Pointer.Pointer(Pointer).

Method Detail

position

public CharucoBoard position(long position)

Overrides:

position in class Board

chessboardCorners

@ByRef
 @Cast(value="std::vector<cv::Point3f>*")
public Point3fVector chessboardCorners()

chessboardCorners

public CharucoBoard chessboardCorners(Point3fVector setter)

nearestMarkerIdx

@ByRef
public IntVectorVector nearestMarkerIdx()

nearestMarkerIdx

public CharucoBoard nearestMarkerIdx(IntVectorVector setter)

nearestMarkerCorners

@ByRef
public IntVectorVector nearestMarkerCorners()

nearestMarkerCorners

public CharucoBoard nearestMarkerCorners(IntVectorVector setter)

draw

public void draw(@ByVal
                 Size outSize,
                 @ByVal
                 Mat img,
                 int marginSize,
                 int borderBits)

\brief Draw a ChArUco board

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 ChArUco board, ready to be printed.

draw

public void draw(@ByVal
                 Size outSize,
                 @ByVal
                 Mat img)

draw

public void draw(@ByVal
                 Size outSize,
                 @ByVal
                 UMat img,
                 int marginSize,
                 int borderBits)

draw

public void draw(@ByVal
                 Size outSize,
                 @ByVal
                 UMat img)

draw

public void draw(@ByVal
                 Size outSize,
                 @ByVal
                 GpuMat img,
                 int marginSize,
                 int borderBits)

draw

public void draw(@ByVal
                 Size outSize,
                 @ByVal
                 GpuMat img)

create

@opencv_core.Ptr
public static CharucoBoard create(int squaresX,
                                                   int squaresY,
                                                   float squareLength,
                                                   float markerLength,
                                                   @opencv_core.Ptr
                                                   Dictionary dictionary)

\brief Create a CharucoBoard object

Parameters:

squaresX - number of chessboard squares in X direction

squaresY - number of chessboard squares in Y direction

squareLength - chessboard square side length (normally in meters)

markerLength - marker side length (same unit than squareLength)

dictionary - dictionary of markers indicating the type of markers. The first markers in the dictionary are used to fill the white chessboard squares.

Returns:

the output CharucoBoard object This functions creates a CharucoBoard object given the number of squares in each direction and the size of the markers and chessboard squares.

getChessboardSize

@ByVal
public Size getChessboardSize()

getSquareLength

public float getSquareLength()

getMarkerLength

public float getMarkerLength()