UMat Class

UMat Class

http://www.emgu.com

The equivalent of cv::Mat, should only be used if you know what you are doing. In most case you should use the Matrix class instead

Inheritance Hierarchy

SystemObject
  Emgu.UtilDisposableObject
    Emgu.UtilUnmanagedObject
      Emgu.CVMatDataAllocator
        Emgu.CVUMat

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

Syntax

C++

Copy

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

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

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

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

The UMat type exposes the following members.

Constructors

	Name	Description
	UMat	Create an empty cv::UMat
	UMat(SerializationInfo, StreamingContext)	Constructor used to deserialize runtime serialized object
	UMat(UMat, Rectangle)	Get the Umat header for the specific roi of the parent
	UMat(Size, DepthType, Int32)	Create a umat of the specific type.
	UMat(Int32, Int32, DepthType, Int32)	Create a umat of the specific type.

Top

Methods

	Name	Description
	Clone	Make a clone of the current UMat.
	ConvertTo	Converts an array to another data type with optional scaling.
	CopyTo(Array)	Copies the values of the UMat to data.
	CopyTo(IOutputArray, IInputArray)	Copy the data in this umat to the other mat
	Create	Allocates new array data if needed.
	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.)
	Equals(Object)	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Equals(UMat)	Indicates whether the current object is equal to another object of the same type.
	Finalize	Destructor (Inherited from DisposableObject.)
	GetHashCode	Serves as a hash function for a particular type. (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	Gets the type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	MinMax	Returns the min / max location and values for the image
	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.
	Save	Save this image to the specific file.
	SetTo(Array)	Copies the values of the data to Mat.
	SetTo(IInputArray, IInputArray)	Sets all or some of the array elements to the specified value.
	SetTo(MCvScalar, IInputArray)	Sets all or some of the array elements to the specified value.
	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
	ToMat	Return the Mat representation of the UMat
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Extension Methods

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

Top

Fields

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

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 Image 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.)
	Depth	Depth type
	ElementSize	The size of the elements in this matrix
	IsContinuous	True if the data is continues
	IsEmpty	True if the matrix 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

Top

Reference

Emgu.CV Namespace