Struct opencv::aruco::Dictionary

pub struct Dictionary { /* private fields */ }

Dictionary/Set of markers. It contains the inner codification

bytesList contains the marker codewords where

• bytesList.rows is the dictionary size
• each marker is encoded using nbytes = ceil(markerSize*markerSize/8.)
• each row contains all 4 rotations of the marker, so its length is 4*nbytes

bytesList.ptr(i)[k*nbytes + j] is then the j-th byte of i-th marker, in its k-th rotation.

Implementations

impl Dictionary

pub fn new(
    _bytes_list: &Mat,
    _marker_size: i32,
    _maxcorr: i32
) -> Result<Dictionary>

C++ default parameters

• _bytes_list: Mat()
• _marker_size: 0
• _maxcorr: 0

pub fn copy(_dictionary: &Ptr<Dictionary>) -> Result<Dictionary>

pub fn create(
    n_markers: i32,
    marker_size: i32,
    random_seed: i32
) -> Result<Ptr<Dictionary>>

See also

generateCustomDictionary

C++ default parameters

• random_seed: 0

pub fn create_from(
    n_markers: i32,
    marker_size: i32,
    base_dictionary: &Ptr<Dictionary>,
    random_seed: i32
) -> Result<Ptr<Dictionary>>

See also

generateCustomDictionary

C++ default parameters

• random_seed: 0

pub fn get(dict: i32) -> Result<Ptr<Dictionary>>

See also

getPredefinedDictionary

pub fn get_byte_list_from_bits(bits: &Mat) -> Result<Mat>

Transform matrix of bits to list of bytes in the 4 rotations

pub fn get_bits_from_byte_list(byte_list: &Mat, marker_size: i32) -> Result<Mat>

Transform list of bytes to matrix of bits

Trait Implementations

impl Boxed for Dictionary

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

Wrap the specified raw pointer

fn into_raw(self) -> *mut c_void

Return an the underlying raw pointer while consuming this wrapper.

fn as_raw(&self) -> *const c_void

Return the underlying raw pointer.

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

Return the underlying mutable raw pointer

impl DictionaryTrait for Dictionary

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

fn set_bytes_list(&mut self, val: Mat)

fn set_marker_size(&mut self, val: i32)

fn set_max_correction_bits(&mut self, val: i32)

fn read_dictionary(&mut self, fn_: &FileNode) -> Result<bool>

Read a new dictionary from FileNode. Format:

fn write_dictionary(&mut self, fs: &mut Ptr<FileStorage>) -> Result<()>

Write a dictionary to FileStorage. Format is the same as in readDictionary().

impl DictionaryTraitConst for Dictionary

fn as_raw_Dictionary(&self) -> *const c_void

fn bytes_list(&self) -> Mat

fn marker_size(&self) -> i32

fn max_correction_bits(&self) -> i32

fn identify(
    &self,
    only_bits: &Mat,
    idx: &mut i32,
    rotation: &mut i32,
    max_correction_rate: f64
) -> Result<bool>

Given a matrix of bits. Returns whether if marker is identified or not. It returns by reference the correct id (if any) and the correct rotation

fn get_distance_to_id(
    &self,
    bits: &dyn ToInputArray,
    id: i32,
    all_rotations: bool
) -> Result<i32>

Returns the distance of the input bits to the specific id. If allRotations is true, the four posible bits rotation are considered

fn draw_marker(
    &self,
    id: i32,
    side_pixels: i32,
    _img: &mut dyn ToOutputArray,
    border_bits: i32
) -> Result<()>

Draw a canonical marker image

impl Drop for Dictionary

fn drop(&mut self)

Executes the destructor for this type.

impl Send for Dictionary