mexopencv_aruco.hpp File Reference

Common definitions for the aruco module. More...

#include "mexopencv.hpp"
#include "opencv2/aruco.hpp"
#include "opencv2/aruco/charuco.hpp"

Go to the source code of this file.

Functions
cv::Ptr< cv::aruco::DetectorParameters >	MxArrayToDetectorParameters (const MxArray &s)
	Convert MxArray to cv::Ptr<cv::aruco::DetectorParameters> More...
cv::Ptr< cv::aruco::Dictionary >	MxArrayToDictionary (const MxArray &arr)
	Convert MxArray to cv::Ptr<cv::aruco::Dictionary> More...
cv::Ptr< cv::aruco::Board >	MxArrayToBoard (const MxArray &arr)
	Convert MxArray to cv::Ptr<cv::aruco::Board> More...
MxArray	toStruct (const cv::Ptr< cv::aruco::DetectorParameters > &params)
	Convert detector parameters to scalar struct. More...
MxArray	toStruct (const cv::Ptr< cv::aruco::Dictionary > &dictionary)
	Convert Dictionary to scalar struct. More...
MxArray	toStruct (const cv::Ptr< cv::aruco::Board > &board)
	Convert Board to scalar struct. More...
MxArray	toStruct (const cv::Ptr< cv::aruco::GridBoard > &board)
	Convert GridBoard to scalar struct. More...
MxArray	toStruct (const cv::Ptr< cv::aruco::CharucoBoard > &board)
	Convert CharucoBoard to scalar struct. More...
cv::Ptr< cv::aruco::Board >	create_Board (std::vector< MxArray >::const_iterator first, std::vector< MxArray >::const_iterator last)
	Create an instance of Board using options in arguments. More...
cv::Ptr< cv::aruco::GridBoard >	create_GridBoard (std::vector< MxArray >::const_iterator first, std::vector< MxArray >::const_iterator last)
	Create an instance of GridBoard using options in arguments. More...
cv::Ptr< cv::aruco::CharucoBoard >	create_CharucoBoard (std::vector< MxArray >::const_iterator first, std::vector< MxArray >::const_iterator last)
	Create an instance of CharucoBoard using options in arguments. More...

Variables
const ConstMap< std::string, cv::aruco::PREDEFINED_DICTIONARY_NAME >	PredefinedDictionaryMap
	Predefined dictionary types. More...
const ConstMap< std::string, int >	CornerRefineMethodMap
	Corner refinement methods map. More...
const ConstMap< int, std::string >	CornerRefineMethodInvMap
	Inverse corner refinement methods map. More...

Detailed Description

Common definitions for the aruco module.

Author

Amro

Date

2016

Header file for MEX-functions that use aruco module from OpenCV library. This file includes maps for option processing, as well as functions for creating instances of classes from parsed arguments.

Definition in file mexopencv_aruco.hpp.

Function Documentation

create_Board()

cv::Ptr<cv::aruco::Board> create_Board	(	std::vector< MxArray >::const_iterator	first,
		std::vector< MxArray >::const_iterator	last
	)

Create an instance of Board using options in arguments.

Parameters

first	iterator at the beginning of the vector range
last	iterator at the end of the vector range

Returns

smart pointer to an instance of created Board

Definition at line 274 of file mexopencv_aruco.cpp.

create_CharucoBoard()

cv::Ptr<cv::aruco::CharucoBoard> create_CharucoBoard	(	std::vector< MxArray >::const_iterator	first,
		std::vector< MxArray >::const_iterator	last
	)

Create an instance of CharucoBoard using options in arguments.

Parameters

first	iterator at the beginning of the vector range
last	iterator at the end of the vector range

Returns

smart pointer to an instance of created CharucoBoard

Definition at line 312 of file mexopencv_aruco.cpp.

create_GridBoard()

cv::Ptr<cv::aruco::GridBoard> create_GridBoard	(	std::vector< MxArray >::const_iterator	first,
		std::vector< MxArray >::const_iterator	last
	)

Create an instance of GridBoard using options in arguments.

Parameters

first	iterator at the beginning of the vector range
last	iterator at the end of the vector range

Returns

smart pointer to an instance of created GridBoard

Definition at line 287 of file mexopencv_aruco.cpp.

MxArrayToBoard()

cv::Ptr<cv::aruco::Board> MxArrayToBoard

(

const MxArray &

arr

)

Convert MxArray to cv::Ptr<cv::aruco::Board>

Parameters

arr	MxArray object. In one of the following forms: a scalar struct with the following fields: "objPoints", "dictionary", and "ids". a cell-array of the form: {Type, ...} starting with the board type ("Board", "GridBoard", or "CharucoBoard") followed by board-specific options.

Returns

smart pointer to an instance of Board object

Definition at line 141 of file mexopencv_aruco.cpp.

MxArrayToDetectorParameters()

cv::Ptr<cv::aruco::DetectorParameters> MxArrayToDetectorParameters

(

const MxArray &

s

)

Convert MxArray to cv::Ptr<cv::aruco::DetectorParameters>

Parameters

s	scalar struct MxArray object

Returns

smart pointer to a detector parameters object

Definition at line 18 of file mexopencv_aruco.cpp.

MxArrayToDictionary()

cv::Ptr<cv::aruco::Dictionary> MxArrayToDictionary

(

const MxArray &

arr

)

Convert MxArray to cv::Ptr<cv::aruco::Dictionary>

Parameters

arr

MxArray object. In one of the following forms: a string, one of the recognized predefined dictionaries. a scalar struct with the following fields: "bytesList", "markerSize", and "maxCorrectionBits". a cell-array of the form: {Type, ...} starting with the dictionary type ("Predefined", "Custom", or "Manual") followed by dictionary-specific options.

Returns

smart pointer to an instance of Dictionary object

Definition at line 71 of file mexopencv_aruco.cpp.

toStruct() [1/5]

MxArray toStruct

(

const cv::Ptr< cv::aruco::DetectorParameters > &

params

)

Convert detector parameters to scalar struct.

Parameters

params

smart pointer to an instance of detector parameters

Returns

scalar struct MxArray object

Definition at line 169 of file mexopencv_aruco.cpp.

toStruct() [2/5]

MxArray toStruct

(

const cv::Ptr< cv::aruco::Dictionary > &

dictionary

)

Convert Dictionary to scalar struct.

Parameters

dictionary

smart pointer to an instance of dictionary

Returns

scalar struct MxArray object

toStruct() [3/5]

MxArray toStruct

(

const cv::Ptr< cv::aruco::Board > &

board

)

Convert Board to scalar struct.

Parameters

board

smart pointer to an instance of Board

Returns

scalar struct MxArray object

Definition at line 229 of file mexopencv_aruco.cpp.

toStruct() [4/5]

MxArray toStruct

(

const cv::Ptr< cv::aruco::GridBoard > &

board

)

Convert GridBoard to scalar struct.

Parameters

board

smart pointer to an instance of GridBoard

Returns

scalar struct MxArray object

Definition at line 239 of file mexopencv_aruco.cpp.

toStruct() [5/5]

MxArray toStruct

(

const cv::Ptr< cv::aruco::CharucoBoard > &

board

)

Convert CharucoBoard to scalar struct.

Parameters

board

smart pointer to an instance of CharucoBoard

Returns

scalar struct MxArray object

Definition at line 253 of file mexopencv_aruco.cpp.

Variable Documentation

CornerRefineMethodInvMap

const ConstMap<int, std::string> CornerRefineMethodInvMap

Initial value:

= ConstMap<int, std::string>
    (cv::aruco::CORNER_REFINE_NONE,    "None")
    (cv::aruco::CORNER_REFINE_SUBPIX,  "Subpix")
    (cv::aruco::CORNER_REFINE_CONTOUR, "Contour")

Inverse corner refinement methods map.

Definition at line 50 of file mexopencv_aruco.hpp.

CornerRefineMethodMap

const ConstMap<std::string, int> CornerRefineMethodMap

Initial value:

= ConstMap<std::string, int>
    ("None",    cv::aruco::CORNER_REFINE_NONE)
    ("Subpix",  cv::aruco::CORNER_REFINE_SUBPIX)
    ("Contour", cv::aruco::CORNER_REFINE_CONTOUR)

Corner refinement methods map.

Definition at line 44 of file mexopencv_aruco.hpp.

PredefinedDictionaryMap

const ConstMap<std::string, cv::aruco::PREDEFINED_DICTIONARY_NAME> PredefinedDictionaryMap

Initial value:

=
    ConstMap<std::string, cv::aruco::PREDEFINED_DICTIONARY_NAME>
    ("4x4_50",        cv::aruco::DICT_4X4_50)
    ("4x4_100",       cv::aruco::DICT_4X4_100)
    ("4x4_250",       cv::aruco::DICT_4X4_250)
    ("4x4_1000",      cv::aruco::DICT_4X4_1000)
    ("5x5_50",        cv::aruco::DICT_5X5_50)
    ("5x5_100",       cv::aruco::DICT_5X5_100)
    ("5x5_250",       cv::aruco::DICT_5X5_250)
    ("5x5_1000",      cv::aruco::DICT_5X5_1000)
    ("6x6_50",        cv::aruco::DICT_6X6_50)
    ("6x6_100",       cv::aruco::DICT_6X6_100)
    ("6x6_250",       cv::aruco::DICT_6X6_250)
    ("6x6_1000",      cv::aruco::DICT_6X6_1000)
    ("7x7_50",        cv::aruco::DICT_7X7_50)
    ("7x7_100",       cv::aruco::DICT_7X7_100)
    ("7x7_250",       cv::aruco::DICT_7X7_250)
    ("7x7_1000",      cv::aruco::DICT_7X7_1000)
    ("ArucoOriginal", cv::aruco::DICT_ARUCO_ORIGINAL)

Predefined dictionary types.

Definition at line 23 of file mexopencv_aruco.hpp.