Struct opencv::aruco::CharucoBoard

pub struct CharucoBoard { /* fields omitted */ }

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.

Methods

impl CharucoBoard

pub fn as_raw_CharucoBoard(&self) -> *mut c_void

pub unsafe fn from_raw_ptr(ptr: *mut c_void) -> Self

impl CharucoBoard

pub fn draw(
    &mut self,
    out_size: Size,
    img: &mut dyn ToOutputArray,
    margin_size: i32,
    border_bits: i32
) -> Result<()>

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.

C++ default parameters

• margin_size: 0
• border_bits: 1

pub fn create(
    squares_x: i32,
    squares_y: i32,
    square_length: f32,
    marker_length: f32,
    dictionary: &PtrOfDictionary
) -> Result<PtrOfCharucoBoard>

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.

pub fn get_chessboard_size(&self) -> Result<Size>

pub fn get_square_length(&self) -> Result<f32>

pub fn get_marker_length(&self) -> Result<f32>

Trait Implementations

impl BoardTrait for CharucoBoard

fn as_raw_Board(&self) -> *mut c_void

impl Send for CharucoBoard

impl Drop for CharucoBoard

fn drop(&mut self)

Executes the destructor for this type.