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.CVUMat

Namespace: Emgu.CV
Assembly: Emgu.CV.Platform.NetStandard (in Emgu.CV.Platform.NetStandard.dll) Version: 4.3.0.3890

Syntax

C++

Copy

[SerializableAttribute]
public class UMat : UnmanagedObject, IEquatable<UMat>, 
	IInputOutputArray, IInputArray, IDisposable, IOutputArray, IInputArrayOfArrays, 
	IOutputArrayOfArrays, ISerializable

<SerializableAttribute>
Public Class UMat
	Inherits UnmanagedObject
	Implements IEquatable(Of UMat), IInputOutputArray, 
	IInputArray, IDisposable, IOutputArray, IInputArrayOfArrays, IOutputArrayOfArrays, 
	ISerializable

[SerializableAttribute]
public ref class UMat : public UnmanagedObject, 
	IEquatable<UMat^>, IInputOutputArray, IInputArray, IDisposable, 
	IOutputArray, IInputArrayOfArrays, IOutputArrayOfArrays, ISerializable

[<SerializableAttribute>]
type UMat =  
    class
        inherit UnmanagedObject
        interface IEquatable<UMat>
        interface IInputOutputArray
        interface IInputArray
        interface IDisposable
        interface IOutputArray
        interface IInputArrayOfArrays
        interface IOutputArrayOfArrays
        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(String, ImreadModes)	Read a UMat from file.
	UMat(UMat, Rectangle)	Get the Umat header for the specific roi of the parent
	UMat(UMat, Range, Range)	Create a umat header for the specific ROI
	UMat(Size, DepthType, Int32, UMatUsage)	Create a umat of the specific type.
	UMat(Int32, Int32, DepthType, Int32, UMatUsage)	Create a umat of the specific type.

Top

Properties

	Name	Description
	Bytes	Get or Set the raw image data
	Cols	The number of columns
	Depth	Depth type
	Dims	The matrix dimensionality
	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
	Total	The method returns the number of array elements (a number of pixels if the array represents an image)

Top

Methods

	Name	Description
	Clone	Make a clone of the current UMat.
	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 umat to the other mat
	CopyToT(T)	Copy data from this Mat to the managed array
	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 DisposableObjectDisposeObject.)
	Dot	Computes the dot product of two mats
	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.)
	GetData	Get a copy of the data values as an array
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetInputArray	Pointer to the InputArray
	GetInputOutputArray	Pointer to the InputOutputArray
	GetMat	Return the Mat representation of the UMat
	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.
	Row	Creates a matrix header for the specified matrix row.
	Save	Save this image to the specific file.
	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.
	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	Returns a string that represents the current object. (Inherited from Object.)

Top

Operators

	Name	Description
	Addition(Double, UMat)	Element wise add mat1 with value
	Addition(MCvScalar, UMat)	Element wise add mat with value
	Addition(UMat, MCvScalar)	Element wise add mat with value
	Addition(UMat, UMat)	Element wise add mat1 with mat2
	Addition(UMat, Double)	Element wise add mat with value
	BitwiseAnd(Double, UMat)	Perform an element wise AND operation using a mat and a color
	BitwiseAnd(MCvScalar, UMat)	Perform an element wise AND operation using a mat and a scalar
	BitwiseAnd(UMat, MCvScalar)	Perform an element wise AND operation using a mat and a scalar
	BitwiseAnd(UMat, UMat)	Perform an element wise AND operation on the two mats
	BitwiseAnd(UMat, Double)	Perform an element wise AND operation using a mat and a scalar
	BitwiseOr(Double, UMat)	Perform an binary OR operation with some color
	BitwiseOr(MCvScalar, UMat)	Perform an binary OR operation with some scalar
	BitwiseOr(UMat, MCvScalar)	Perform an binary OR operation with some scalar
	BitwiseOr(UMat, UMat)	Perform an element wise OR operation with another mat and return the result
	BitwiseOr(UMat, Double)	Perform an binary OR operation with some value
	Division(Double, UMat)	scale / mat
	Division(UMat, Double)	mat / scale
	Multiply(Double, UMat)	scale*mat
	Multiply(UMat, Double)	mat * scale
	OnesComplement	Compute the complement Mat
	Subtraction(Double, UMat)	value - mat
	Subtraction(MCvScalar, UMat)	Element wise subtract value from the current mat
	Subtraction(UMat, MCvScalar)	Element wise subtract another mat from the current mat
	Subtraction(UMat, UMat)	Element wise subtract another mat from the current mat
	Subtraction(UMat, Double)	Element wise subtract value from the current mat

Top

Fields

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

Top

Extension Methods

	Name	Description
	ForEachDuplicateChannel(ActionIInputArray, Int32)	Overloaded. Apply converter and compute result for each channel of the image, for single channel image, apply converter directly, for multiple channel image, make a copy of each channel to a temperary image and apply the convertor (Defined by IInputArrayExtensions.)
	ForEachDuplicateChannelTReturn(FuncIInputArray, Int32, TReturn)	Overloaded. Apply converter and compute result for each channel of the image, for single channel image, apply converter directly, for multiple channel image, make a copy of each channel to a temperary image and apply the convertor (Defined by IInputArrayExtensions.)
	IsUmat	Determines whether the specified input array is umat. (Defined by IInputArrayExtensions.)
	ToBitmap	Overloaded. Convert the umat into Bitmap, the pixel values are copied over to the Bitmap (Defined by BitmapExtension.)
	ToBitmap	Overloaded. (Defined by BitmapExtension.)

Top

Reference

Emgu.CV Namespace