org.bytedeco.opencv.opencv_aruco

Class GridBoard

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.opencv.opencv_aruco.Board

org.bytedeco.opencv.opencv_aruco.GridBoard

All Implemented Interfaces:

AutoCloseable

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

\brief 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 drawPlanarBoard)

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
GridBoard() Default native constructor.
GridBoard(long size) Native array allocator.
GridBoard(Pointer p) Pointer cast constructor.

Method Summary

Modifier and Type	Method and Description
static GridBoard	create(int markersX, int markersY, float markerLength, float markerSeparation, Dictionary dictionary)
static GridBoard	create(int markersX, int markersY, float markerLength, float markerSeparation, Dictionary dictionary, int firstMarker) \brief Create a GridBoard 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 GridBoard
void	draw(Size outSize, UMat img)
void	draw(Size outSize, UMat img, int marginSize, int borderBits)
Size	getGridSize()
float	getMarkerLength()
float	getMarkerSeparation()
GridBoard	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

GridBoard

public GridBoard()

Default native constructor.

GridBoard

public GridBoard(long size)

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

GridBoard

public GridBoard(Pointer p)

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

Method Detail

position

public GridBoard position(long position)

Overrides:

position in class Board

draw

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

\brief 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.

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 GridBoard create(int markersX,
                                                int markersY,
                                                float markerLength,
                                                float markerSeparation,
                                                @opencv_core.Ptr
                                                Dictionary dictionary,
                                                int firstMarker)

\brief 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.

create

@opencv_core.Ptr
public static GridBoard create(int markersX,
                                                int markersY,
                                                float markerLength,
                                                float markerSeparation,
                                                @opencv_core.Ptr
                                                Dictionary dictionary)

getGridSize

@ByVal
public Size getGridSize()

getMarkerLength

public float getMarkerLength()

getMarkerSeparation

public float getMarkerSeparation()