Struct GridBoard

pub struct GridBoard { /* private fields */ }

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.

Implementations

impl GridBoard

pub fn new( size: Size, marker_length: f32, marker_separation: f32, dictionary: &impl DictionaryTraitConst, ids: &impl ToInputArray, ) -> Result<GridBoard>

GridBoard constructor

Parameters

• size: number of markers in x and y directions
• 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
• ids: set of marker ids in dictionary to use on board.

C++ default parameters

• ids: noArray()

pub fn new_def( size: Size, marker_length: f32, marker_separation: f32, dictionary: &impl DictionaryTraitConst, ) -> Result<GridBoard>

GridBoard constructor

Parameters

• size: number of markers in x and y directions
• 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
• ids: set of marker ids in dictionary to use on board.

Note

This alternative version of [new] function uses the following default values for its arguments:

• ids: noArray()

pub fn default() -> Result<GridBoard>

Trait Implementations

impl BoardTrait for GridBoard

fn as_raw_mut_Board(&mut self) -> *mut c_void

impl BoardTraitConst for GridBoard

fn as_raw_Board(&self) -> *const c_void

fn get_dictionary(&self) -> Result<Dictionary>

return the Dictionary of markers employed for this board

fn get_obj_points(&self) -> Result<Vector<Vector<Point3f>>>

return array of object points of all the marker corners in the board.

fn get_ids(&self) -> Result<Vector<i32>>

vector of the identifiers of the markers in the board (should be the same size as objPoints)

fn get_right_bottom_corner(&self) -> Result<Point3f>

get coordinate of the bottom right corner of the board, is set when calling the function create()

fn match_image_points( &self, detected_corners: &impl ToInputArray, detected_ids: &impl ToInputArray, obj_points: &mut impl ToOutputArray, img_points: &mut impl ToOutputArray, ) -> Result<()>

Given a board configuration and a set of detected markers, returns the corresponding image points and object points, can be used in solvePnP()

fn generate_image( &self, out_size: Size, img: &mut impl ToOutputArray, margin_size: i32, border_bits: i32, ) -> Result<()>

Draw a planar board

fn generate_image_def( &self, out_size: Size, img: &mut impl ToOutputArray, ) -> Result<()>

Draw a planar board

impl Boxed for GridBoard

unsafe fn from_raw(ptr: <GridBoard as OpenCVFromExtern>::ExternReceive) -> Self

Wrap the specified raw pointer

fn into_raw(self) -> <GridBoard as OpenCVTypeExternContainer>::ExternSendMut

Return the underlying raw pointer while consuming this wrapper.

fn as_raw(&self) -> <GridBoard as OpenCVTypeExternContainer>::ExternSend

Return the underlying raw pointer.

fn as_raw_mut( &mut self, ) -> <GridBoard as OpenCVTypeExternContainer>::ExternSendMut

Return the underlying mutable raw pointer

impl Clone for GridBoard

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for GridBoard

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Drop for GridBoard

fn drop(&mut self)

Executes the destructor for this type.

impl From<GridBoard> for Board

fn from(s: GridBoard) -> Self

Converts to this type from the input type.

impl GridBoardTrait for GridBoard

fn as_raw_mut_GridBoard(&mut self) -> *mut c_void

impl GridBoardTraitConst for GridBoard

fn as_raw_GridBoard(&self) -> *const c_void

fn get_grid_size(&self) -> Result<Size>

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

fn get_marker_separation(&self) -> Result<f32>

impl Send for GridBoard