Table of Contents

Class Dictionary

Namespace
OpenCvSharp.Aruco
Assembly
OpenCvSharp.dll

Dictionary/Set of markers. It contains the inner codification

public class Dictionary : DisposableCvObject, IDisposable, ICvPtrHolder
Inheritance
Dictionary
Implements
Inherited Members

Properties

BytesList

Marker code information

public Mat BytesList { get; }

Property Value

Mat

MarkerSize

Number of bits per dimension.

public int MarkerSize { get; set; }

Property Value

int

MaxCorrectionBits

Maximum number of bits that can be corrected.

public int MaxCorrectionBits { get; set; }

Property Value

int

Methods

DisposeUnmanaged()

Releases unmanaged resources

protected override void DisposeUnmanaged()

GenerateImageMarker(int, int, OutputArray, int)

Generate a canonical marker image

public void GenerateImageMarker(int id, int sidePixels, OutputArray img, int borderBits = 1)

Parameters

id int
sidePixels int
img OutputArray
borderBits int

GetBitsFromByteList(Mat, int)

Transform list of bytes to matrix of bits

public static Mat GetBitsFromByteList(Mat byteList, int markerSize)

Parameters

byteList Mat
markerSize int

Returns

Mat

GetByteListFromBits(Mat)

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

public static Mat GetByteListFromBits(Mat bits)

Parameters

bits Mat

Returns

Mat

GetDistanceToId(InputArray, int, bool)

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

public int GetDistanceToId(InputArray bits, int id, bool allRotations = true)

Parameters

bits InputArray
id int
allRotations bool

Returns

int

Identify(Mat, out int, out int, double)

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

public bool Identify(Mat onlyBits, out int idx, out int rotation, double maxCorrectionRate)

Parameters

onlyBits Mat
idx int
rotation int
maxCorrectionRate double

Returns

bool
Edit this page