Emgu CV Library Documentation
Matrix<(Of <(TDepth>)>) Class
NamespacesEmgu.CVMatrix<(Of <(TDepth>)>)

www.emgu.com/wiki
The Matrix class that wrap around CvMat in OpenCV
Declaration Syntax
C#Visual BasicVisual C++
[SerializableAttribute]
public class Matrix<TDepth> : CvArray<TDepth>, 
	ICloneable, IEquatable<Matrix<TDepth>>
where TDepth : new()
<SerializableAttribute> _
Public Class Matrix(Of TDepth As New) _
	Inherits CvArray(Of TDepth) _
	Implements ICloneable, IEquatable(Of Matrix(Of TDepth))
[SerializableAttribute]
generic<typename TDepth>
where TDepth : gcnew()
public ref class Matrix : public CvArray<TDepth>, 
	ICloneable, IEquatable<Matrix<TDepth>^>
Generic Template Parameters
TDepth
Depth of this matrix (either Byte, SByte, Single, double, UInt16, Int16 or Int32)
Members
All MembersConstructorsMethodsPropertiesFields



IconMemberDescription
Matrix<(Of <(TDepth>)>)()()()
The default constructor which allows Data to be set later on

Matrix<(Of <(TDepth>)>)(Int32, Int32, IntPtr, Int32)
Create a Matrix (only header is allocated) using the Pinned/Unmanaged data. The data is not freed by the disposed function of this class

Matrix<(Of <(TDepth>)>)(Int32, Int32, IntPtr)
Create a Matrix (only header is allocated) using the Pinned/Unmanaged data. The data is not freed by the disposed function of this class

Matrix<(Of <(TDepth>)>)(Int32, Int32)
Create a matrix of the specific size

Matrix<(Of <(TDepth>)>)(Size)
Create a matrix of the specific size

Matrix<(Of <(TDepth>)>)(Int32, Int32, Int32)
Create a matrix of the specific size and channels

Matrix<(Of <(TDepth>)>)(array<TDepth,2>[,](,)[,])
Create a matrix using the specific

Matrix<(Of <(TDepth>)>)(array<TDepth>[]()[])
Create a matrix using the specific data

Matrix<(Of <(TDepth>)>)(SerializationInfo, StreamingContext)
Constructor used to deserialize runtime serialized object

_And(CvArray<(Of <(TDepth>)>))
Inplace And operation with src2
(Inherited from CvArray<(Of <(TDepth>)>).)
_dataHandle
The pinned GCHandle to _array;
(Inherited from CvArray<(Of <(TDepth>)>).)
_Max(Double)
Inplace compute the elementwise maximum value with val
(Inherited from CvArray<(Of <(TDepth>)>).)
_Max(CvArray<(Of <(TDepth>)>))
Inplace elementwise maximize the current Array with src2
(Inherited from CvArray<(Of <(TDepth>)>).)
_Min(Double)
Inplace compute the elementwise minimum value
(Inherited from CvArray<(Of <(TDepth>)>).)
_Min(CvArray<(Of <(TDepth>)>))
Inplace elementwise minimize the current Array with src2
(Inherited from CvArray<(Of <(TDepth>)>).)
_Mul(Double)
Inplace multiply elements of the Array by scale
(Inherited from CvArray<(Of <(TDepth>)>).)
_Mul(CvArray<(Of <(TDepth>)>))
Inplace elementwise multiply the current Array with src2
(Inherited from CvArray<(Of <(TDepth>)>).)
_Not()()()
Inplace compute the complement for all Array Elements
(Inherited from CvArray<(Of <(TDepth>)>).)
_Or(CvArray<(Of <(TDepth>)>))
Inplace Or operation with src2
(Inherited from CvArray<(Of <(TDepth>)>).)
_ptr
A pointer to the unmanaged object
(Inherited from UnmanagedObject.)
Add(Matrix<(Of <(TDepth>)>))
Elementwise add another matrix with the current matrix

Add(TDepth)
Elementwise add a color val to the current matrix

Addition(Matrix<(Of <(TDepth>)>), Matrix<(Of <(TDepth>)>))
Elementwise add mat1 with mat2

Addition(Matrix<(Of <(TDepth>)>), Double)
Elementwise add mat1 with val

Addition(Double, Matrix<(Of <(TDepth>)>))
val + mat1

AllocateData(Int32, Int32, Int32)
Allocate data for the array
(Overrides CvArray<(Of <(TDepth>)>).AllocateData(Int32, Int32, Int32).)
Bytes
Get or Set an Array of bytes that represent the data in this array
(Inherited from CvArray<(Of <(TDepth>)>).)
Clone()()()
Make a copy of this matrix

Cmp(Matrix<(Of <(TDepth>)>), CMP_TYPE)
This function compare the current matrix with mat2 and returns the comparison mask

Cols
The number of cols for this array
(Inherited from CvArray<(Of <(TDepth>)>).)
ConcateHorizontal(Matrix<(Of <(TDepth>)>))
Concate the current matrix with another matrix horizontally. If this matrix is n x m1 and otherMatrix is n x m2, the resulting matrix is n x (m1 + m2).

ConcateVertical(Matrix<(Of <(TDepth>)>))
Concate the current matrix with another matrix vertically. If this matrix is n1 x m and otherMatrix is n2 x m, the resulting matrix is (n1+n2) x m.

Convert<(Of <(TOtherDepth>)>)()()()
Convert this matrix to different depth

CopyBlank()()()
Return a matrix of the same size with all elements equals 0

CopyTo(CvArray<(Of <(TDepth>)>))
Copy the current array to dest
(Inherited from CvArray<(Of <(TDepth>)>).)
CvDepth
Get the depth representation for openCV

Data
Get or Set the data for this matrix

DeserializeObjectData(SerializationInfo, StreamingContext)
A function used for runtime deserailization of the object
(Inherited from CvArray<(Of <(TDepth>)>).)
Det
The function cvDet returns determinant of the square matrix

Dispose()()()
The dispose function that implements IDisposable interface
(Inherited from DisposableObject.)
Dispose(Boolean)
Release the all the memory associate with this object
(Inherited from DisposableObject.)
DisposeObject()()()
Release the matrix and all the memory associate with it
(Overrides CvArray<(Of <(TDepth>)>).DisposeObject()()().)
Division(Matrix<(Of <(TDepth>)>), Double)
mat1 / val

DotProduct(CvArray<(Of <(TDepth>)>))
Calculates and returns the Euclidean dot product of two arrays. src1 dot src2 = sumI(src1(I)*src2(I))
(Inherited from CvArray<(Of <(TDepth>)>).)
Equals(Matrix<(Of <(TDepth>)>))
Return true if every element of this matrix equals elements in mat2

Equals(Object)
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
EqualSize<(Of <(D2>)>)(CvArray<(Of <(D2>)>))
Determine if the size (width and height) of this Array equals the size of src2
(Inherited from CvArray<(Of <(TDepth>)>).)
Finalize()()()
Destructor
(Inherited from DisposableObject.)
GetCol(Int32)
Get the specific column of the matrix

GetCols(Int32, Int32)
Get the Matrix, corresponding to a specified column span of the input array

GetDiag(Int32)
Return the specific diagonal elements of this matrix

GetDiag()()()
Return the main diagonal element of this matrix

GetHashCode()()()
Serves as a hash function for a particular type.
(Inherited from Object.)
GetObjectData(SerializationInfo, StreamingContext)
A function used for runtime serilization of the object
(Inherited from CvArray<(Of <(TDepth>)>).)
GetRow(Int32)
Get the specific row of the matrix

GetRows(Int32, Int32, Int32)
Return the matrix corresponding to a specified row span of the input array

GetSchema()()()
Get the xml schema
(Inherited from CvArray<(Of <(TDepth>)>).)
GetSubMatrix(Rectangle) Obsolete.
Get a submatrix corresponding to a specified rectangle

GetSubRect(Rectangle)
Get a submatrix corresponding to a specified rectangle

GetType()()()
Gets the Type of the current instance.
(Inherited from Object.)
Height
Get the height (#Rows) of the cvArray. If ROI is set, the height of the ROI
(Inherited from CvArray<(Of <(TDepth>)>).)
Item[([(Int32, Int32])])
Get or Set the value in the specific row and col

ManagedArray
Get the underneath managed array
(Overrides CvArray<(Of <(TDepth>)>).ManagedArray.)
MCvMat
The MCvMat structure format

MemberwiseClone()()()
Creates a shallow copy of the current Object.
(Inherited from Object.)
MinMax(Double%, Double%, Point%, Point%)
Returns the min / max locations and values for the matrix

Mul(Double)
Multiply the current matrix with scale

Mul(Matrix<(Of <(TDepth>)>))
Multiply the current matrix with mat2

Multiply(Matrix<(Of <(TDepth>)>), Double)
mat1 * val

Multiply(Double, Matrix<(Of <(TDepth>)>))
val * mat1

Multiply(Matrix<(Of <(TDepth>)>), Matrix<(Of <(TDepth>)>))
mat1 * mat2

Norm
The norm of this Array
(Inherited from CvArray<(Of <(TDepth>)>).)
NumberOfChannels
Get the number of channels for this matrix
(Overrides CvArray<(Of <(TDepth>)>).NumberOfChannels.)
Ptr
The pointer to the internal structure
(Inherited from CvArray<(Of <(TDepth>)>).)
ReadXml(XmlReader)
Function to call when deserializing this object from XML
(Inherited from CvArray<(Of <(TDepth>)>).)
Reduce<(Of <(TDepth2>)>)(CvArray<(Of <(TDepth2>)>), REDUCE_TYPE)
Reduces matrix to a vector by treating the matrix rows/columns as a set of 1D vectors and performing the specified operation on the vectors until a single row/column is obtained.
(Inherited from CvArray<(Of <(TDepth>)>).)
RemoveCols(Int32, Int32)
Return the matrix without a specified column span of the input array

RemoveRows(Int32, Int32)
Return the matrix without a specified row span of the input array

Rows
The number of rows for this array
(Inherited from CvArray<(Of <(TDepth>)>).)
Save(String)
Save the CvArray as image
(Inherited from CvArray<(Of <(TDepth>)>).)
SerializationCompressionRatio
Get or set the Compression Ratio for serialization. A number between 0 - 9. 0 means no compression at all, while 9 means best compression
(Inherited from CvArray<(Of <(TDepth>)>).)
SetIdentity(MCvScalar)
Initializs scaled identity matrix
(Inherited from CvArray<(Of <(TDepth>)>).)
SetIdentity()()()
Initialize the identity matrix
(Inherited from CvArray<(Of <(TDepth>)>).)
SetRandNormal(UInt64, MCvScalar, MCvScalar)
Inplace fills Array with normally distributed random numbers
(Inherited from CvArray<(Of <(TDepth>)>).)
SetRandNormal(MCvScalar, MCvScalar)
Inplace fills Array with normally distributed random numbers
(Inherited from CvArray<(Of <(TDepth>)>).)
SetRandUniform(UInt64, MCvScalar, MCvScalar)
Inplace fills Array with uniformly distributed random numbers
(Inherited from CvArray<(Of <(TDepth>)>).)
SetRandUniform(MCvScalar, MCvScalar)
Inplace fills Array with uniformly distributed random numbers
(Inherited from CvArray<(Of <(TDepth>)>).)
SetValue(MCvScalar)
Set the element of the Array to val
(Inherited from CvArray<(Of <(TDepth>)>).)
SetValue(Double)
Set the element of the Array to val
(Inherited from CvArray<(Of <(TDepth>)>).)
SetValue(MCvScalar, CvArray<(Of <(Byte>)>))
Set the element of the Array to val, using the specific mask
(Inherited from CvArray<(Of <(TDepth>)>).)
SetValue(Double, CvArray<(Of <(Byte>)>))
Set the element of the Array to val, using the specific mask
(Inherited from CvArray<(Of <(TDepth>)>).)
SetZero()()()
Set the values to zero
(Inherited from CvArray<(Of <(TDepth>)>).)
Size
Get the size of the array
(Inherited from CvArray<(Of <(TDepth>)>).)
Split()()()
Get all channels for the multi channel matrix

Sub(Matrix<(Of <(TDepth>)>))
Elementwise substract another matrix from the current matrix

Sub(TDepth)
Elementwise substract a color val to the current matrix

SubR(TDepth)
result = val - this

Subtraction(Double, Matrix<(Of <(TDepth>)>))
val - mat1

Subtraction(Matrix<(Of <(TDepth>)>), Matrix<(Of <(TDepth>)>))
mat1 - mat2

Subtraction(Matrix<(Of <(TDepth>)>), Double)
mat1 - val

Sum
Return the sum of the elements in this matrix

ToString()()()
Returns a String that represents the current Object.
(Inherited from Object.)
Trace
Sum of diagonal elements of the matrix
(Inherited from CvArray<(Of <(TDepth>)>).)
Transpose()()()
Returns the transpose of this matrix

Width
Get the width (#Cols) of the cvArray. If ROI is set, the width of the ROI
(Inherited from CvArray<(Of <(TDepth>)>).)
WriteXml(XmlWriter)
Function to call when serializing this object to XML
(Inherited from CvArray<(Of <(TDepth>)>).)
Inheritance Hierarchy
Object
DisposableObject
 UnmanagedObject
  CvArray<(Of <(TDepth>)>)
   Matrix<(Of <(TDepth>)>)
    ConvolutionKernelF
    RotationMatrix2D<(Of <(T>)>)
    RotationVector3D

Assembly: Emgu.CV (Module: Emgu.CV) Version: 1.5.0.0 (1.5.0.0)