org.bytedeco.opencv.opencv_objdetect

Class Dictionary

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.opencv.opencv_objdetect.Dictionary

All Implemented Interfaces:

AutoCloseable

@Namespace(value="cv::aruco")
 @NoOffset
 @Properties(inherit=opencv_objdetect.class)
public class Dictionary
extends Pointer

\addtogroup objdetect_aruco \{

/** \brief Dictionary is a set of unique ArUco markers of the same size bytesList storing as 2-dimensions Mat with 4-th channels (CV_8UC4 type was used) and contains the marker codewords where: - bytesList.rows is the dictionary size - each marker is encoded using nbytes = ceil(markerSize*markerSize/8.) bytes - each row contains all 4 rotations of the marker, so its length is 4*nbytes - the byte order in the bytesList[i] row: //bytes without rotation/bytes with rotation 1/bytes with rotation 2/bytes with rotation 3// So bytesList.ptr(i)[k*nbytes + j] is the j-th byte of i-th marker, in its k-th rotation. \note Python bindings generate matrix with shape of bytesList dictionary_size x nbytes x 4, but it should be indexed like C++ version. Python example for j-th byte of i-th marker, in its k-th rotation: aruco_dict.bytesList[id].ravel()[k*nbytes + j]

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
Dictionary()
Dictionary(long size) Native array allocator.
Dictionary(Mat bytesList, int _markerSize)
Dictionary(Mat bytesList, int _markerSize, int maxcorr) \brief Basic ArUco dictionary constructor
Dictionary(Pointer p) Pointer cast constructor.

Method Summary

Modifier and Type	Method and Description
Mat	bytesList() marker code information.
Dictionary	bytesList(Mat setter)
void	generateImageMarker(int id, int sidePixels, GpuMat _img)
void	generateImageMarker(int id, int sidePixels, GpuMat _img, int borderBits)
void	generateImageMarker(int id, int sidePixels, Mat _img)
void	generateImageMarker(int id, int sidePixels, Mat _img, int borderBits) \brief Generate a canonical marker image
void	generateImageMarker(int id, int sidePixels, UMat _img)
void	generateImageMarker(int id, int sidePixels, UMat _img, int borderBits)
static Mat	getBitsFromByteList(Mat byteList, int markerSize) \brief Transform list of bytes to matrix of bits
static Mat	getByteListFromBits(Mat bits) \brief Transform matrix of bits to list of bytes with 4 marker rotations
int	getDistanceToId(GpuMat bits, int id)
int	getDistanceToId(GpuMat bits, int id, boolean allRotations)
int	getDistanceToId(Mat bits, int id)
int	getDistanceToId(Mat bits, int id, boolean allRotations) \brief Returns Hamming distance of the input bits to the specific id.
int	getDistanceToId(UMat bits, int id)
int	getDistanceToId(UMat bits, int id, boolean allRotations)
Dictionary	getPointer(long i)
boolean	identify(Mat onlyBits, int[] idx, int[] rotation, double maxCorrectionRate)
boolean	identify(Mat onlyBits, IntBuffer idx, IntBuffer rotation, double maxCorrectionRate)
boolean	identify(Mat onlyBits, IntPointer idx, IntPointer rotation, double maxCorrectionRate) \brief Given a matrix of bits.
int	markerSize() number of bits per dimension
Dictionary	markerSize(int setter)
int	maxCorrectionBits() maximum number of bits that can be corrected
Dictionary	maxCorrectionBits(int setter)
Dictionary	position(long position)
boolean	readDictionary(FileNode fn) \brief Read a new dictionary from FileNode.
void	writeDictionary(FileStorage fs)
void	writeDictionary(FileStorage fs, BytePointer name) \brief Write a dictionary to FileStorage, format is the same as in readDictionary().
void	writeDictionary(FileStorage fs, String name)

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, getDirectBufferAddress, getPointer, getPointer, getPointer, hashCode, interruptDeallocatorThread, isNull, isNull, limit, limit, malloc, maxBytes, maxPhysicalBytes, memchr, memcmp, memcpy, memmove, memset, offsetAddress, offsetof, offsetof, parseBytes, physicalBytes, physicalBytesInaccurate, position, put, realloc, referenceCount, releaseReference, retainReference, setNull, sizeof, sizeof, toString, totalBytes, totalCount, totalPhysicalBytes, withDeallocator, zero

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Dictionary

public Dictionary(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

Dictionary

public Dictionary(long size)

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

Dictionary

public Dictionary()

Dictionary

public Dictionary(@Const @ByRef
                  Mat bytesList,
                  int _markerSize,
                  int maxcorr)

\brief Basic ArUco dictionary constructor

Parameters:

bytesList - bits for all ArUco markers in dictionary see memory layout in the class description

_markerSize - ArUco marker size in units

maxcorr - maximum number of bits that can be corrected

Dictionary

public Dictionary(@Const @ByRef
                  Mat bytesList,
                  int _markerSize)

Method Detail

position

public Dictionary position(long position)

Overrides:

position in class Pointer

getPointer

public Dictionary getPointer(long i)

Overrides:

getPointer in class Pointer

bytesList

@ByRef
public Mat bytesList()

marker code information. See class description for more details

bytesList

public Dictionary bytesList(Mat setter)

markerSize

public int markerSize()

number of bits per dimension

markerSize

public Dictionary markerSize(int setter)

maxCorrectionBits

public int maxCorrectionBits()

maximum number of bits that can be corrected

maxCorrectionBits

public Dictionary maxCorrectionBits(int setter)

readDictionary

@Cast(value="bool")
public boolean readDictionary(@Const @ByRef
                                                   FileNode fn)

\brief Read a new dictionary from FileNode. Dictionary example in YAML format:\n nmarkers: 35\n markersize: 6\n maxCorrectionBits: 5\n marker_0: "101011111011111001001001101100000000"\n ...\n marker_34: "011111010000111011111110110101100101"

writeDictionary

public void writeDictionary(@ByRef
                            FileStorage fs,
                            @opencv_core.Str
                            BytePointer name)

\brief Write a dictionary to FileStorage, format is the same as in readDictionary().

writeDictionary

public void writeDictionary(@ByRef
                            FileStorage fs)

writeDictionary

public void writeDictionary(@ByRef
                            FileStorage fs,
                            @opencv_core.Str
                            String name)

identify

@Cast(value="bool")
public boolean identify(@Const @ByRef
                                             Mat onlyBits,
                                             @ByRef
                                             IntPointer idx,
                                             @ByRef
                                             IntPointer rotation,
                                             double maxCorrectionRate)

\brief Given a matrix of bits. Returns whether if marker is identified or not. Returns reference to the marker id in the dictionary (if any) and its rotation.

identify

@Cast(value="bool")
public boolean identify(@Const @ByRef
                                             Mat onlyBits,
                                             @ByRef
                                             IntBuffer idx,
                                             @ByRef
                                             IntBuffer rotation,
                                             double maxCorrectionRate)

identify

@Cast(value="bool")
public boolean identify(@Const @ByRef
                                             Mat onlyBits,
                                             @ByRef
                                             int[] idx,
                                             @ByRef
                                             int[] rotation,
                                             double maxCorrectionRate)

getDistanceToId

public int getDistanceToId(@ByVal
                           Mat bits,
                           int id,
                           @Cast(value="bool")
                           boolean allRotations)

\brief Returns Hamming distance of the input bits to the specific id. If allRotations flag is set, the four posible marker rotations are considered

getDistanceToId

public int getDistanceToId(@ByVal
                           Mat bits,
                           int id)

getDistanceToId

public int getDistanceToId(@ByVal
                           UMat bits,
                           int id,
                           @Cast(value="bool")
                           boolean allRotations)

getDistanceToId

public int getDistanceToId(@ByVal
                           UMat bits,
                           int id)

getDistanceToId

public int getDistanceToId(@ByVal
                           GpuMat bits,
                           int id,
                           @Cast(value="bool")
                           boolean allRotations)

getDistanceToId

public int getDistanceToId(@ByVal
                           GpuMat bits,
                           int id)

generateImageMarker

public void generateImageMarker(int id,
                                int sidePixels,
                                @ByVal
                                Mat _img,
                                int borderBits)

\brief Generate a canonical marker image

generateImageMarker

public void generateImageMarker(int id,
                                int sidePixels,
                                @ByVal
                                Mat _img)

generateImageMarker

public void generateImageMarker(int id,
                                int sidePixels,
                                @ByVal
                                UMat _img,
                                int borderBits)

generateImageMarker

public void generateImageMarker(int id,
                                int sidePixels,
                                @ByVal
                                UMat _img)

generateImageMarker

public void generateImageMarker(int id,
                                int sidePixels,
                                @ByVal
                                GpuMat _img,
                                int borderBits)

generateImageMarker

public void generateImageMarker(int id,
                                int sidePixels,
                                @ByVal
                                GpuMat _img)

getByteListFromBits

@ByVal
public static Mat getByteListFromBits(@Const @ByRef
                                              Mat bits)

\brief Transform matrix of bits to list of bytes with 4 marker rotations

getBitsFromByteList

@ByVal
public static Mat getBitsFromByteList(@Const @ByRef
                                              Mat byteList,
                                              int markerSize)

\brief Transform list of bytes to matrix of bits