Mat Class

Mat Class

http://www.emgu.com

The equivalent of cv::Mat

Inheritance Hierarchy

SystemObject
  Emgu.UtilDisposableObject
    Emgu.UtilUnmanagedObject
      Emgu.CVMatDataAllocator
        Emgu.CVMat
          Emgu.CVDenseHistogram
          Emgu.CVRotationMatrix2D

Namespace: Emgu.CV
Assembly: Emgu.CV.World (in Emgu.CV.World.dll) Version: 3.2.0.2682 (3.2.0.2682)

Syntax

C++

Copy

[SerializableAttribute]
public class Mat : MatDataAllocator, IImage, IDisposable, 
	ICloneable, IInputOutputArray, IInputArrayOfArrays, IOutputArrayOfArrays, IOutputArray, 
	IInputArray, IEquatable<Mat>, ISerializable

<SerializableAttribute>
Public Class Mat
	Inherits MatDataAllocator
	Implements IImage, IDisposable, ICloneable, IInputOutputArray, 
	IInputArrayOfArrays, IOutputArrayOfArrays, IOutputArray, IInputArray, IEquatable(Of Mat), 
	ISerializable

[SerializableAttribute]
public ref class Mat : public MatDataAllocator, 
	IImage, IDisposable, ICloneable, IInputOutputArray, IInputArrayOfArrays, 
	IOutputArrayOfArrays, IOutputArray, IInputArray, IEquatable<Mat^>, 
	ISerializable

[<SerializableAttribute>]
type Mat =  
    class
        inherit MatDataAllocator
        interface IImage
        interface IDisposable
        interface ICloneable
        interface IInputOutputArray
        interface IInputArrayOfArrays
        interface IOutputArrayOfArrays
        interface IOutputArray
        interface IInputArray
        interface IEquatable<Mat>
        interface ISerializable
    end

The Mat type exposes the following members.

Constructors

	Name	Description
	Mat	Create an empty cv::Mat
	Mat(SerializationInfo, StreamingContext)	Constructor used to deserialize runtime serialized object
	Mat(String, ImreadModes)	Load the Mat from file
	Mat(Mat, Rectangle)	Create a mat header for the specific ROI
	Mat(Size, DepthType, Int32)	Create a mat of the specific type.
	Mat(Mat, Range, Range)	Create a mat header for the specific ROI
	Mat(Int32, Int32, DepthType, Int32)	Create a mat of the specific type.
	Mat(Int32, DepthType, IntPtr, IntPtr)	Create multi-dimension mat using existing data.
	Mat(Size, DepthType, Int32, IntPtr, Int32)	Create a Mat header from existing data
	Mat(Int32, Int32, DepthType, Int32, IntPtr, Int32)	Create a Mat header from existing data

Top

Properties

	Name	Description
	Bitmap	The Get property provide a more efficient way to convert Image<Gray, Byte>, Image<Bgr, Byte> and Image<Bgra, Byte> into Bitmap such that the image data is shared with Bitmap. If you change the pixel value on the Bitmap, you change the pixel values on the Image object as well! For other types of image this property has the same effect as ToBitmap() Take extra caution not to use the Bitmap after the Mat object is disposed The Set property convert the bitmap to this Image type.
	Cols	The number of columns
	Data	Get the managed data used by the Mat (Inherited from MatDataAllocator.)
	DataPointer	Pointer to the beginning of the raw data
	Depth	Depth type
	Dims	The matrix dimensionality
	ElementSize	The size of the elements in this matrix
	Height	Get the height of the mat.
	IsContinuous	True if the data is continues
	IsEmpty	True if the Mat is empty
	IsSubmatrix	True if the matrix is a submatrix of another matrix
	NumberOfChannels	Number of channels
	Ptr	Pointer to the unmanaged object (Inherited from UnmanagedObject.)
	Rows	The number of rows
	Size	The size of this matrix
	SizeOfDimemsion	Get an array of the size of the dimensions. e.g. if the mat is 9x10x11, the array of {9, 10, 11} will be returned.
	Step	Step
	Total	The method returns the number of array elements (a number of pixels if the array represents an image)
	Width	Get the width of the mat

Top

Methods

	Name	Description
	Clone	Make a clone of the current Mat
	Col	Creates a matrix header for the specified matrix column.
	ConvertTo	Converts an array to another data type with optional scaling.
	CopyTo(IOutputArray, IInputArray)	Copy the data in this cv::Mat to an output array
	CopyToT(T)	Copy data from this Mat to the managed array
	Create	Allocates new array data if needed.
	Cross	Computes a cross-product of two 3-element vectors.
	DeserializeObjectData	A function used for runtime deserailization of the object
	Dispose	The dispose function that implements IDisposable interface (Inherited from DisposableObject.)
	DisposeObject	Release all the unmanaged memory associated with this object. (Overrides MatDataAllocatorDisposeObject.)
	Dot	Computes a dot-product of two vectors.
	Equals(Object)	(Inherited from Object.)
	Equals(Mat)	Compares two Mats and check if they are equal
	Finalize	Destructor (Inherited from DisposableObject.)
	GetData	Gets the binary data from the specific indices.
	GetHashCode	(Inherited from Object.)
	GetInputArray	Pointer to the InputArray
	GetInputOutputArray	Pointer to the InputOutputArray
	GetObjectData	A function used for runtime serialization of the object
	GetOutputArray	Pointer to the OutputArray
	GetType	(Inherited from Object.)
	GetUMat	Convert this Mat to UMat
	GetValueRange	Get the minimum and maximum value across all channels of the mat
	MemberwiseClone	(Inherited from Object.)
	MinMax	Returns the min / max location and values for the image
	PopBack	The method removes one or more rows from the bottom of the matrix
	PushBack	Adds elements to the bottom of the matrix
	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.)
	Reshape	Changes the shape and/or the number of channels of a 2D matrix without copying the data.
	Row	Creates a matrix header for the specified matrix row.
	Save	Save this image to the specific file.
	SetTo(IInputArray, IInputArray)	Set the mat to the specific value
	SetTo(MCvScalar, IInputArray)	Set the mat to the specific value
	SetToT(T)	Copy data from managed array to this Mat
	Split	Split current Image into an array of gray scale images where each element in the array represent a single color channel of the original image
	ToImageTColor, TDepth	Convert this Mat to Image
	ToString	(Inherited from Object.)

Top

Fields

	Name	Description
	_ptr	A pointer to the unmanaged object (Inherited from UnmanagedObject.)

Top

Extension Methods

	Name	Description
	IsUmat	Determines whether the specified input array is umat. (Defined by IInputArrayExtensions.)

Top

Reference

Emgu.CV Namespace