A Matrix is a wrapper to cvMat of OpenCV.

Namespace: Emgu.CV
Assembly: Emgu.CV (in Emgu.CV.dll) Version: 2.2.1.1150 (2.2.1.1150)

Syntax

         
 C#  Visual Basic  Visual 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>^>

Type Parameters

TDepth
Depth of this matrix (either Byte, SByte, Single, double, UInt16, Int16 or Int32)

Members

               
 All Members  Constructors   Fields   Properties   Methods  
 Public

 Protected
 Instance

 Static 
 Declared

 Inherited
 XNA Framework Only 

 .NET Compact Framework Only 

 MemberDescription
Matrix<(Of <(<'TDepth>)>)>()()()()
The default constructor which allows Data to be set later on
Matrix<(Of <(<'TDepth>)>)>(Size)
Create a matrix of the specific size
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>)>)>(Int32, Int32)
Create a matrix of the specific size
Matrix<(Of <(<'TDepth>)>)>(SerializationInfo, StreamingContext)
Constructor used to deserialize runtime serialized object
Matrix<(Of <(<'TDepth>)>)>(Int32, Int32, Int32)
Create a matrix of the specific size and channels
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, 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, 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
_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 value
(Inherited from CvArray<(Of <(<'TDepth>)>)>.)
_Max(CvArray<(Of <<'(TDepth>)>>))
Inplace elementwise maximize the current Array with other
(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 other
(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(TDepth)
Elementwise add a color val to the current matrix
Add(Matrix<(Of <<'(TDepth>)>>))
Elementwise add another matrix with the current matrix
Addition(Double, Matrix<(Of <<'(TDepth>)>>))
val + mat1
Addition(Matrix<(Of <<'(TDepth>)>>), Matrix<(Of <<'(TDepth>)>>))
Elementwise add mat1 with mat2
Addition(Matrix<(Of <<'(TDepth>)>>), Double)
Elementwise add mat1 with val
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>)>)>.)
CheckRange(Double, Double, Point%)
Check that every array element is neither NaN nor +- inf. The functions also check that each value is between min and max. in the case of multi-channel arrays each channel is processed independently. If some values are out of range, position of the first outlier is stored in pos, and then the functions return false.
(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>)>)>.)
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
Returns determinant of the square matrix
Dispose()()()()
The dispose function that implements IDisposable interface
(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(Object)
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Equals(Matrix<(Of <<'(TDepth>)>>))
Return true if every element of this matrix equals elements in mat2
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()()()()
Return the main diagonal element of this matrix
GetDiag(Int32)
Return the specific diagonal elements of this matrix
GetHashCode()()()()
Serves as a hash function for a particular type.
(Inherited from Object.)
GetObjectData(SerializationInfo, StreamingContext)
A function used for runtime serialization 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>)>)>.)
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(Double, Matrix<(Of <<'(TDepth>)>>))
val * mat1
Multiply(Matrix<(Of <<'(TDepth>)>>), Matrix<(Of <<'(TDepth>)>>))
mat1 * mat2
Multiply(Matrix<(Of <<'(TDepth>)>>), Double)
mat1 * val
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 <<'(TOtherDepth>)>>)(CvArray<(Of <<'(TOtherDepth>)>>), REDUCE_DIMENSION, 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>)>)>.)
ReleaseManagedResources()()()()
Release the managed resources. This function will be called during the disposal of the current object. override ride this function if you need to call the Dispose() function on any managed IDisposable object created by the current object
(Inherited from DisposableObject.)
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
Reshape(Int32, Int32)
Get reshaped matrix which also share the same data with the current matrix
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()()()()
Initialize the identity matrix
(Inherited from CvArray<(Of <(<'TDepth>)>)>.)
SetIdentity(MCvScalar)
Initializs scaled identity matrix
(Inherited from CvArray<(Of <(<'TDepth>)>)>.)
SetRandNormal(MCvScalar, MCvScalar)
Inplace fills Array with normally distributed random numbers
(Inherited from CvArray<(Of <(<'TDepth>)>)>.)
SetRandNormal(UInt64, MCvScalar, MCvScalar)
Inplace fills Array with normally distributed random numbers
(Inherited from CvArray<(Of <(<'TDepth>)>)>.)
SetRandUniform(MCvScalar, MCvScalar)
Inplace fills Array with uniformly 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>)>)>.)
SetValue(Double)
Set the element of the Array to val
(Inherited from CvArray<(Of <(<'TDepth>)>)>.)
SetValue(MCvScalar)
Set the element of the Array to val
(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>)>)>.)
SetValue(MCvScalar, 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(TDepth)
Elementwise subtract a color val to the current matrix
Sub(Matrix<(Of <<'(TDepth>)>>))
Elementwise subtract another matrix from 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

System..::..Object
  Emgu.Util..::..DisposableObject
    Emgu.Util..::..UnmanagedObject
      Emgu.CV..::..CvArray<(Of <(<'TDepth>)>)>
        Emgu.CV..::..Matrix<(Of <(<'TDepth>)>)>
          Emgu.CV..::..ConvolutionKernelF
          Emgu.CV..::..HomographyMatrix
          Emgu.CV..::..RotationMatrix2D<(Of <(<'T>)>)>
          Emgu.CV..::..RotationVector3D

See Also