cv::bridge::Bridge Class Reference

Type conversion class for converting OpenCV and native C++ types. More...

#include "bridge.hpp"

Public Member Functions
	Bridge ()
	Bridge (const matlab::MxArray &obj)
	Bridge (const mxArray *obj)
virtual	~Bridge ()
bool	empty () const
template<typename Object >
Object *	getObjectByName (const std::string &name)
	unpack an object from Matlab into C++ More...
	operator bool ()
	operator cv::Mat () const
	operator cv::Moments () const
	operator cv::Point () const
	operator cv::Point2d () const
	operator cv::Point2f () const
	operator cv::Rect ()
	operator cv::RNG ()
	operator cv::RotatedRect ()
	operator cv::Scalar ()
	operator cv::Size () const
	operator cv::TermCriteria ()
	operator double ()
	operator float ()
	operator Ptr_AlignMTB ()
	operator Ptr_CalibrateDebevec ()
	operator Ptr_CalibrateRobertson ()
	operator Ptr_CLAHE ()
	operator Ptr_DenseOpticalFlow ()
	operator Ptr_DualTVL1OpticalFlow ()
	operator Ptr_FeatureDetector ()
	operator Ptr_LineSegmentDetector ()
	operator Ptr_MergeDebevec ()
	operator Ptr_MergeMertens ()
	operator Ptr_MergeRobertson ()
	operator Ptr_StereoBM ()
	operator Ptr_StereoSGBM ()
	operator Ptr_Stitcher ()
	operator Ptr_Tonemap ()
	operator Ptr_TonemapDrago ()
	operator Ptr_TonemapDurand ()
	operator Ptr_TonemapMantiuk ()
	operator Ptr_TonemapReinhard ()
	operator size_t ()
	operator std::string ()
	operator vector_float ()
	operator vector_int ()
	operator vector_KeyPoint ()
	operator vector_Mat ()
	operator vector_Point ()
	operator vector_Rect ()
	operator vector_String ()
	operator vector_uchar ()
	operator vector_vector_char ()
	operator vector_vector_DMatch ()
Bridge &	operator= (const mxArray *obj)
Bridge &	operator= (const matlab::MxArray &obj)
Bridge &	operator= (const cv::Mat &mat)
Bridge &	operator= (const std::string &)
Bridge &	operator= (const bool &)
Bridge &	operator= (const double &)
Bridge &	operator= (const float &)
Bridge &	operator= (const int &)
Bridge &	operator= (const size_t &)
Bridge &	operator= (const cv::Point &)
Bridge &	operator= (const cv::Point2f &)
Bridge &	operator= (const cv::Point2d &)
Bridge &	operator= (const cv::Size &)
Bridge &	operator= (const cv::Moments &)
Bridge &	operator= (const cv::Scalar &)
Bridge &	operator= (const cv::Rect &)
Bridge &	operator= (const cv::RotatedRect &)
Bridge &	operator= (const cv::TermCriteria &)
Bridge &	operator= (const cv::RNG &)
Bridge &	operator= (const vector_Mat &)
Bridge &	operator= (const vector_int &)
Bridge &	operator= (const vector_float &)
Bridge &	operator= (const vector_Rect &)
Bridge &	operator= (const vector_KeyPoint &)
Bridge &	operator= (const vector_String &)
Bridge &	operator= (const vector_Point &)
Bridge &	operator= (const vector_uchar &)
Bridge &	operator= (const vector_vector_char &)
Bridge &	operator= (const vector_vector_DMatch &)
Bridge &	operator= (const Ptr_StereoBM &)
Bridge &	operator= (const Ptr_StereoSGBM &)
Bridge &	operator= (const Ptr_FeatureDetector &)
Bridge &	operator= (const Ptr_CLAHE &)
Bridge &	operator= (const Ptr_LineSegmentDetector &)
Bridge &	operator= (const Ptr_AlignMTB &)
Bridge &	operator= (const Ptr_CalibrateDebevec &)
Bridge &	operator= (const Ptr_CalibrateRobertson &)
Bridge &	operator= (const Ptr_DenseOpticalFlow &)
Bridge &	operator= (const Ptr_DualTVL1OpticalFlow &)
Bridge &	operator= (const Ptr_MergeDebevec &)
Bridge &	operator= (const Ptr_MergeMertens &)
Bridge &	operator= (const Ptr_MergeRobertson &)
Bridge &	operator= (const Ptr_Stitcher &)
Bridge &	operator= (const Ptr_Tonemap &)
Bridge &	operator= (const Ptr_TonemapDrago &)
Bridge &	operator= (const Ptr_TonemapDurand &)
Bridge &	operator= (const Ptr_TonemapMantiuk &)
Bridge &	operator= (const Ptr_TonemapReinhard &)
bool	toBool ()
double	toDouble ()
float	toFloat ()
int	toInt ()
cv::Mat	toMat () const
template<typename Scalar >
cv::Mat	toMat () const
cv::Moments	toMoments () const
matlab::MxArray	toMxArray ()
cv::Point	toPoint () const
cv::Point2d	toPoint2d () const
cv::Point2f	toPoint2f () const
Ptr_AlignMTB	toPtrAlignMTB ()
Ptr_CalibrateDebevec	toPtrCalibrateDebevec ()
Ptr_CalibrateRobertson	toPtrCalibrateRobertson ()
Ptr_CLAHE	toPtrCLAHE ()
Ptr_DenseOpticalFlow	toPtrDenseOpticalFlow ()
Ptr_DualTVL1OpticalFlow	toPtrDualTVL1OpticalFlow ()
Ptr_FeatureDetector	toPtrFeatureDetector ()
Ptr_LineSegmentDetector	toPtrLineSegmentDetector ()
Ptr_MergeDebevec	toPtrMergeDebevec ()
Ptr_MergeMertens	toPtrMergeMertens ()
Ptr_MergeRobertson	toPtrMergeRobertson ()
Ptr_StereoBM	toPtrStereoBM ()
Ptr_StereoSGBM	toPtrStereoSGBM ()
Ptr_Stitcher	toPtrStitcher ()
Ptr_Tonemap	toPtrTonemap ()
Ptr_TonemapDrago	toPtrTonemapDrago ()
Ptr_TonemapDurand	toPtrTonemapDurand ()
Ptr_TonemapMantiuk	toPtrTonemapMantiuk ()
Ptr_TonemapReinhard	toPtrTonemapReinhard ()
cv::Rect	toRect ()
cv::RNG	toRNG ()
	explicit conversion to cv::RNG() More...
cv::RotatedRect	toRotatedRect ()
cv::Scalar	toScalar ()
cv::Size	toSize () const
size_t	toSizeT ()
std::string	toString ()
cv::TermCriteria	toTermCriteria ()
vector_float	toVectorFloat ()
vector_int	toVectorInt ()
vector_KeyPoint	toVectorKeyPoint ()
vector_Mat	toVectorMat ()
vector_Point	toVectorPoint ()
vector_Rect	toVectorRect ()
vector_String	toVectorString ()
vector_uchar	toVectorUchar ()
vector_vector_char	toVectorVectorChar ()
vector_vector_DMatch	toVectorVectorDMatch ()

Static Public Member Functions
template<typename Scalar >
static matlab::MxArray	FromMat (const cv::Mat &mat)

Detailed Description

Type conversion class for converting OpenCV and native C++ types.

Bridge provides an interface for converting between OpenCV/C++ types to Matlab's mxArray format.

Each type conversion requires three operators: // conversion from ObjectType –> Bridge Bridge& operator=(const ObjectType&); // implicit conversion from Bridge –> ObjectType operator ObjectType(); // explicit conversion from Bridge –> ObjectType ObjectType toObjectType();

The bridging class provides common conversions between OpenCV types, std and stl types to Matlab's mxArray format. By inheriting Bridge, you can add your own custom type conversions.

Because Matlab uses a homogeneous storage type, all operations are provided relative to Matlab's type. That is, Bridge always stores an matlab::MxArray object and converts to and from other object types on demand.

NOTE: for the explicit conversion function, the object name must be in UpperCamelCase, for example: int –> toInt my_object –> MyObject my_Object –> MyObject myObject –> MyObject this is because the binding generator standardises the calling syntax.

Bridge attempts to make as few assumptions as possible, however in some cases where 1-to-1 mappings don't exist, some assumptions are necessary. In particular:

• conversion from of a 2-channel Mat to an mxArray will result in a complex output
• conversion from multi-channel interleaved Mats will result in multichannel planar mxArrays

Constructor & Destructor Documentation

Bridge() [1/3]

cv::bridge::Bridge::Bridge

(

)

~Bridge()

virtual cv::bridge::Bridge::~Bridge ( )

virtual

Bridge() [2/3]

cv::bridge::Bridge::Bridge

(

const matlab::MxArray &

obj

)

Bridge() [3/3]

cv::bridge::Bridge::Bridge

(

const mxArray *

obj

)

Member Function Documentation

empty()

bool cv::bridge::Bridge::empty

(

)

const

FromMat()

template<typename Scalar >

static matlab::MxArray cv::bridge::Bridge::FromMat ( const cv::Mat &  mat )

static

getObjectByName()

template<typename Object >

Object* cv::bridge::Bridge::getObjectByName

(

const std::string &

name

)

unpack an object from Matlab into C++

this function checks whether the given bridge is derived from an object in Matlab. If so, it converts it to a (platform dependent) pointer to the underlying C++ object.

NOTE! This function assumes that the C++ pointer is stored in inst_

operator bool()

cv::bridge::Bridge::operator bool

(

)

operator cv::Mat()

cv::bridge::Bridge::operator cv::Mat

(

)

const

operator cv::Moments()

cv::bridge::Bridge::operator cv::Moments

(

)

const

operator cv::Point()

cv::bridge::Bridge::operator cv::Point

(

)

const

operator cv::Point2d()

cv::bridge::Bridge::operator cv::Point2d

(

)

const

operator cv::Point2f()

cv::bridge::Bridge::operator cv::Point2f

(

)

const

operator cv::Rect()

cv::bridge::Bridge::operator cv::Rect

(

)

operator cv::RNG()

cv::bridge::Bridge::operator cv::RNG

(

)

operator cv::RotatedRect()

cv::bridge::Bridge::operator cv::RotatedRect

(

)

operator cv::Scalar()

cv::bridge::Bridge::operator cv::Scalar

(

)

operator cv::Size()

cv::bridge::Bridge::operator cv::Size

(

)

const

operator cv::TermCriteria()

cv::bridge::Bridge::operator cv::TermCriteria

(

)

operator double()

cv::bridge::Bridge::operator double

(

)

operator float()

cv::bridge::Bridge::operator float

(

)

operator Ptr_AlignMTB()

cv::bridge::Bridge::operator Ptr_AlignMTB

(

)

operator Ptr_CalibrateDebevec()

cv::bridge::Bridge::operator Ptr_CalibrateDebevec

(

)

operator Ptr_CalibrateRobertson()

cv::bridge::Bridge::operator Ptr_CalibrateRobertson

(

)

operator Ptr_CLAHE()

cv::bridge::Bridge::operator Ptr_CLAHE

(

)

operator Ptr_DenseOpticalFlow()

cv::bridge::Bridge::operator Ptr_DenseOpticalFlow

(

)

operator Ptr_DualTVL1OpticalFlow()

cv::bridge::Bridge::operator Ptr_DualTVL1OpticalFlow

(

)

operator Ptr_FeatureDetector()

cv::bridge::Bridge::operator Ptr_FeatureDetector

(

)

operator Ptr_LineSegmentDetector()

cv::bridge::Bridge::operator Ptr_LineSegmentDetector

(

)

operator Ptr_MergeDebevec()

cv::bridge::Bridge::operator Ptr_MergeDebevec

(

)

operator Ptr_MergeMertens()

cv::bridge::Bridge::operator Ptr_MergeMertens

(

)

operator Ptr_MergeRobertson()

cv::bridge::Bridge::operator Ptr_MergeRobertson

(

)

operator Ptr_StereoBM()

cv::bridge::Bridge::operator Ptr_StereoBM

(

)

operator Ptr_StereoSGBM()

cv::bridge::Bridge::operator Ptr_StereoSGBM

(

)

operator Ptr_Stitcher()

cv::bridge::Bridge::operator Ptr_Stitcher

(

)

operator Ptr_Tonemap()

cv::bridge::Bridge::operator Ptr_Tonemap

(

)

operator Ptr_TonemapDrago()

cv::bridge::Bridge::operator Ptr_TonemapDrago

(

)

operator Ptr_TonemapDurand()

cv::bridge::Bridge::operator Ptr_TonemapDurand

(

)

operator Ptr_TonemapMantiuk()

cv::bridge::Bridge::operator Ptr_TonemapMantiuk

(

)

operator Ptr_TonemapReinhard()

cv::bridge::Bridge::operator Ptr_TonemapReinhard

(

)

operator size_t()

cv::bridge::Bridge::operator size_t

(

)

operator std::string()

cv::bridge::Bridge::operator std::string

(

)

operator vector_float()

cv::bridge::Bridge::operator vector_float

(

)

operator vector_int()

cv::bridge::Bridge::operator vector_int

(

)

operator vector_KeyPoint()

cv::bridge::Bridge::operator vector_KeyPoint

(

)

operator vector_Mat()

cv::bridge::Bridge::operator vector_Mat

(

)

operator vector_Point()

cv::bridge::Bridge::operator vector_Point

(

)

operator vector_Rect()

cv::bridge::Bridge::operator vector_Rect

(

)

operator vector_String()

cv::bridge::Bridge::operator vector_String

(

)

operator vector_uchar()

cv::bridge::Bridge::operator vector_uchar

(

)

operator vector_vector_char()

cv::bridge::Bridge::operator vector_vector_char

(

)

operator vector_vector_DMatch()

cv::bridge::Bridge::operator vector_vector_DMatch

(

)

operator=() [1/47]

Bridge& cv::bridge::Bridge::operator=

(

const mxArray *

obj

)

operator=() [2/47]

Bridge& cv::bridge::Bridge::operator=

(

const matlab::MxArray &

obj

)

operator=() [3/47]

Bridge& cv::bridge::Bridge::operator=

(

const std::string &

)

operator=() [4/47]

Bridge& cv::bridge::Bridge::operator=

(

const bool &

)

operator=() [5/47]

Bridge& cv::bridge::Bridge::operator=

(

const double &

)

operator=() [6/47]

Bridge& cv::bridge::Bridge::operator=

(

const float &

)

operator=() [7/47]

Bridge& cv::bridge::Bridge::operator=

(

const int &

)

operator=() [8/47]

Bridge& cv::bridge::Bridge::operator=

(

const size_t &

)

operator=() [9/47]

Bridge& cv::bridge::Bridge::operator=

(

const cv::Point &

)

operator=() [10/47]

Bridge& cv::bridge::Bridge::operator=

(

const cv::Point2f &

)

operator=() [11/47]

Bridge& cv::bridge::Bridge::operator=

(

const cv::Point2d &

)

operator=() [12/47]

Bridge& cv::bridge::Bridge::operator=

(

const cv::Size &

)

operator=() [13/47]

Bridge& cv::bridge::Bridge::operator=

(

const cv::Moments &

)

operator=() [14/47]

Bridge& cv::bridge::Bridge::operator=

(

const cv::Scalar &

)

operator=() [15/47]

Bridge& cv::bridge::Bridge::operator=

(

const cv::Rect &

)

operator=() [16/47]

Bridge& cv::bridge::Bridge::operator=

(

const cv::RotatedRect &

)

operator=() [17/47]

Bridge& cv::bridge::Bridge::operator=

(

const cv::TermCriteria &

)

operator=() [18/47]

Bridge& cv::bridge::Bridge::operator=

(

const cv::RNG &

)

operator=() [19/47]

Bridge& cv::bridge::Bridge::operator=

(

const vector_Mat &

)

operator=() [20/47]

Bridge& cv::bridge::Bridge::operator=

(

const vector_int &

)

operator=() [21/47]

Bridge& cv::bridge::Bridge::operator=

(

const vector_float &

)

operator=() [22/47]

Bridge& cv::bridge::Bridge::operator=

(

const vector_Rect &

)

operator=() [23/47]

Bridge& cv::bridge::Bridge::operator=

(

const vector_KeyPoint &

)

operator=() [24/47]

Bridge& cv::bridge::Bridge::operator=

(

const vector_String &

)

operator=() [25/47]

Bridge& cv::bridge::Bridge::operator=

(

const vector_Point &

)

operator=() [26/47]

Bridge& cv::bridge::Bridge::operator=

(

const vector_uchar &

)

operator=() [27/47]

Bridge& cv::bridge::Bridge::operator=

(

const vector_vector_char &

)

operator=() [28/47]

Bridge& cv::bridge::Bridge::operator=

(

const vector_vector_DMatch &

)

operator=() [29/47]

Bridge& cv::bridge::Bridge::operator=

(

const Ptr_StereoBM &

)

operator=() [30/47]

Bridge& cv::bridge::Bridge::operator=

(

const Ptr_StereoSGBM &

)

operator=() [31/47]

Bridge& cv::bridge::Bridge::operator=

(

const Ptr_FeatureDetector &

)

operator=() [32/47]

Bridge& cv::bridge::Bridge::operator=

(

const Ptr_CLAHE &

)

operator=() [33/47]

Bridge& cv::bridge::Bridge::operator=

(

const Ptr_LineSegmentDetector &

)

operator=() [34/47]

Bridge& cv::bridge::Bridge::operator=

(

const Ptr_AlignMTB &

)

operator=() [35/47]

Bridge& cv::bridge::Bridge::operator=

(

const Ptr_CalibrateDebevec &

)

operator=() [36/47]

Bridge& cv::bridge::Bridge::operator=

(

const Ptr_CalibrateRobertson &

)

operator=() [37/47]

Bridge& cv::bridge::Bridge::operator=

(

const Ptr_DenseOpticalFlow &

)

operator=() [38/47]

Bridge& cv::bridge::Bridge::operator=

(

const Ptr_DualTVL1OpticalFlow &

)

operator=() [39/47]

Bridge& cv::bridge::Bridge::operator=

(

const Ptr_MergeDebevec &

)

operator=() [40/47]

Bridge& cv::bridge::Bridge::operator=

(

const Ptr_MergeMertens &

)

operator=() [41/47]

Bridge& cv::bridge::Bridge::operator=

(

const Ptr_MergeRobertson &

)

operator=() [42/47]

Bridge& cv::bridge::Bridge::operator=

(

const Ptr_Stitcher &

)

operator=() [43/47]

Bridge& cv::bridge::Bridge::operator=

(

const Ptr_Tonemap &

)

operator=() [44/47]

Bridge& cv::bridge::Bridge::operator=

(

const Ptr_TonemapDrago &

)

operator=() [45/47]

Bridge& cv::bridge::Bridge::operator=

(

const Ptr_TonemapDurand &

)

operator=() [46/47]

Bridge& cv::bridge::Bridge::operator=

(

const Ptr_TonemapMantiuk &

)

operator=() [47/47]

Bridge& cv::bridge::Bridge::operator=

(

const Ptr_TonemapReinhard &

)

toBool()

bool cv::bridge::Bridge::toBool

(

)

toDouble()

double cv::bridge::Bridge::toDouble

(

)

toFloat()

float cv::bridge::Bridge::toFloat

(

)

toInt()

int cv::bridge::Bridge::toInt

(

)

toMat()

template<typename Scalar >

cv::Mat cv::bridge::Bridge::toMat

(

)

const

toMoments()

cv::Moments cv::bridge::Bridge::toMoments

(

)

const

toMxArray()

matlab::MxArray cv::bridge::Bridge::toMxArray

(

)

toPoint()

cv::Point cv::bridge::Bridge::toPoint

(

)

const

toPoint2d()

cv::Point2d cv::bridge::Bridge::toPoint2d

(

)

const

toPoint2f()

cv::Point2f cv::bridge::Bridge::toPoint2f

(

)

const

toPtrAlignMTB()

Ptr_AlignMTB cv::bridge::Bridge::toPtrAlignMTB

(

)

toPtrCalibrateDebevec()

Ptr_CalibrateDebevec cv::bridge::Bridge::toPtrCalibrateDebevec

(

)

toPtrCalibrateRobertson()

Ptr_CalibrateRobertson cv::bridge::Bridge::toPtrCalibrateRobertson

(

)

toPtrCLAHE()

Ptr_CLAHE cv::bridge::Bridge::toPtrCLAHE

(

)

toPtrDenseOpticalFlow()

Ptr_DenseOpticalFlow cv::bridge::Bridge::toPtrDenseOpticalFlow

(

)

toPtrDualTVL1OpticalFlow()

Ptr_DualTVL1OpticalFlow cv::bridge::Bridge::toPtrDualTVL1OpticalFlow

(

)

toPtrFeatureDetector()

Ptr_FeatureDetector cv::bridge::Bridge::toPtrFeatureDetector

(

)

toPtrLineSegmentDetector()

Ptr_LineSegmentDetector cv::bridge::Bridge::toPtrLineSegmentDetector

(

)

toPtrMergeDebevec()

Ptr_MergeDebevec cv::bridge::Bridge::toPtrMergeDebevec

(

)

toPtrMergeMertens()

Ptr_MergeMertens cv::bridge::Bridge::toPtrMergeMertens

(

)

toPtrMergeRobertson()

Ptr_MergeRobertson cv::bridge::Bridge::toPtrMergeRobertson

(

)

toPtrStereoBM()

Ptr_StereoBM cv::bridge::Bridge::toPtrStereoBM

(

)

toPtrStereoSGBM()

Ptr_StereoSGBM cv::bridge::Bridge::toPtrStereoSGBM

(

)

toPtrStitcher()

Ptr_Stitcher cv::bridge::Bridge::toPtrStitcher

(

)

toPtrTonemap()

Ptr_Tonemap cv::bridge::Bridge::toPtrTonemap

(

)

toPtrTonemapDrago()

Ptr_TonemapDrago cv::bridge::Bridge::toPtrTonemapDrago

(

)

toPtrTonemapDurand()

Ptr_TonemapDurand cv::bridge::Bridge::toPtrTonemapDurand

(

)

toPtrTonemapMantiuk()

Ptr_TonemapMantiuk cv::bridge::Bridge::toPtrTonemapMantiuk

(

)

toPtrTonemapReinhard()

Ptr_TonemapReinhard cv::bridge::Bridge::toPtrTonemapReinhard

(

)

toRect()

cv::Rect cv::bridge::Bridge::toRect

(

)

toRNG()

cv::RNG cv::bridge::Bridge::toRNG

(

)

explicit conversion to cv::RNG()

Converts a bridge object to a cv::RNG(). We explicitly assert that the object is an RNG in matlab space before attempting to deference its pointer

toRotatedRect()

cv::RotatedRect cv::bridge::Bridge::toRotatedRect

(

)

toScalar()

cv::Scalar cv::bridge::Bridge::toScalar

(

)

toSize()

cv::Size cv::bridge::Bridge::toSize

(

)

const

toSizeT()

size_t cv::bridge::Bridge::toSizeT

(

)

toString()

std::string cv::bridge::Bridge::toString

(

)

toTermCriteria()

cv::TermCriteria cv::bridge::Bridge::toTermCriteria

(

)

toVectorFloat()

vector_float cv::bridge::Bridge::toVectorFloat

(

)

toVectorInt()

vector_int cv::bridge::Bridge::toVectorInt

(

)

toVectorKeyPoint()

vector_KeyPoint cv::bridge::Bridge::toVectorKeyPoint

(

)

toVectorMat()

vector_Mat cv::bridge::Bridge::toVectorMat

(

)

toVectorPoint()

vector_Point cv::bridge::Bridge::toVectorPoint

(

)

toVectorRect()

vector_Rect cv::bridge::Bridge::toVectorRect

(

)

toVectorString()

vector_String cv::bridge::Bridge::toVectorString

(

)

toVectorUchar()

vector_uchar cv::bridge::Bridge::toVectorUchar

(

)

toVectorVectorChar()

vector_vector_char cv::bridge::Bridge::toVectorVectorChar

(

)

toVectorVectorDMatch()

vector_vector_DMatch cv::bridge::Bridge::toVectorVectorDMatch

(

)

---

The documentation for this class was generated from the following file:

• /build/master-contrib_docs-lin64/opencv_contrib/modules/matlab/include/opencv2/matlab/bridge.hpp