org.bytedeco.opencv.opencv_aruco

Class Dictionary

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.opencv.opencv_aruco.Dictionary

All Implemented Interfaces:

AutoCloseable

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

\addtogroup aruco \{

/** \brief 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.

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(Dictionary _dictionary)
Dictionary(long size) Native array allocator.
Dictionary(Mat _bytesList, int _markerSize, int _maxcorr)
Dictionary(Pointer p) Pointer cast constructor.

Method Summary

Modifier and Type	Method and Description
Mat	bytesList()
Dictionary	bytesList(Mat setter)
static Dictionary	create_from(int nMarkers, int markerSize, Dictionary baseDictionary)
static Dictionary	create_from(int nMarkers, int markerSize, Dictionary baseDictionary, int randomSeed)
static Dictionary	create(int nMarkers, int markerSize)
static Dictionary	create(int nMarkers, int markerSize, int randomSeed)
void	drawMarker(int id, int sidePixels, GpuMat _img)
void	drawMarker(int id, int sidePixels, GpuMat _img, int borderBits)
void	drawMarker(int id, int sidePixels, Mat _img)
void	drawMarker(int id, int sidePixels, Mat _img, int borderBits) \brief Draw a canonical marker image
void	drawMarker(int id, int sidePixels, UMat _img)
void	drawMarker(int id, int sidePixels, UMat _img, int borderBits)
static Dictionary	get(int dict)
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 in the 4 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 the distance of the input bits to the specific id.
int	getDistanceToId(UMat bits, int id)
int	getDistanceToId(UMat bits, int id, boolean allRotations)
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()
Dictionary	markerSize(int setter)
int	maxCorrectionBits()
Dictionary	maxCorrectionBits(int setter)
Dictionary	position(long position)

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, hashCode, isNull, isNull, limit, limit, malloc, maxBytes, maxPhysicalBytes, memchr, memcmp, memcpy, memmove, memset, offsetof, parseBytes, physicalBytes, position, put, realloc, referenceCount, releaseReference, retainReference, setNull, sizeof, toString, totalBytes, 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(Pointer).

Dictionary

public Dictionary(long size)

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

Dictionary

public Dictionary(@Const @ByRef(nullValue="cv::Mat()")
                  Mat _bytesList,
                  int _markerSize,
                  int _maxcorr)

Dictionary

public Dictionary()

Dictionary

public Dictionary(@opencv_core.Ptr
                  Dictionary _dictionary)

Method Detail

position

public Dictionary position(long position)

Overrides:

position in class Pointer

bytesList

@ByRef
public Mat bytesList()

bytesList

public Dictionary bytesList(Mat setter)

markerSize

public int markerSize()

markerSize

public Dictionary markerSize(int setter)

maxCorrectionBits

public int maxCorrectionBits()

maxCorrectionBits

public Dictionary maxCorrectionBits(int setter)

create

@opencv_core.Ptr
public static Dictionary create(int nMarkers,
                                                 int markerSize,
                                                 int randomSeed)

See Also:

generateCustomDictionary

create

@opencv_core.Ptr
public static Dictionary create(int nMarkers,
                                                 int markerSize)

create_from

@opencv_core.Ptr
 @Name(value="create")
public static Dictionary create_from(int nMarkers,
                                                                             int markerSize,
                                                                             @opencv_core.Ptr
                                                                             Dictionary baseDictionary,
                                                                             int randomSeed)

See Also:

generateCustomDictionary

create_from

@opencv_core.Ptr
 @Name(value="create")
public static Dictionary create_from(int nMarkers,
                                                                             int markerSize,
                                                                             @opencv_core.Ptr
                                                                             Dictionary baseDictionary)

get

@opencv_core.Ptr
public static Dictionary get(int dict)

See Also:

getPredefinedDictionary

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. It returns by reference the correct id (if any) and the correct 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 the distance of the input bits to the specific id. If allRotations is true, the four posible bits rotation 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)

drawMarker

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

\brief Draw a canonical marker image

drawMarker

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

drawMarker

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

drawMarker

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

drawMarker

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

drawMarker

public void drawMarker(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 in the 4 rotations

getBitsFromByteList

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

\brief Transform list of bytes to matrix of bits