From ebd258b873094dc2e1bf598ed493df385c5ed26c Mon Sep 17 00:00:00 2001 From: Canming Huang Date: Mon, 9 Jun 2025 12:38:31 -0400 Subject: [PATCH] Documentation updates. --- Emgu.CV/Core/UMat.cs | 64 +++++++++++++++++++++++--------------------- 1 file changed, 33 insertions(+), 31 deletions(-) diff --git a/Emgu.CV/Core/UMat.cs b/Emgu.CV/Core/UMat.cs index de4ee20b9..59b98744e 100644 --- a/Emgu.CV/Core/UMat.cs +++ b/Emgu.CV/Core/UMat.cs @@ -153,7 +153,7 @@ namespace Emgu.CV } /// - /// Get or Set the raw image data + /// Set the raw image data, or get a copy of the raw image data. /// public byte[] Bytes { @@ -193,7 +193,7 @@ namespace Emgu.CV } /// - /// Create a umat of the specific type. + /// Create an umat of the specific type. /// /// Number of rows in a 2D array. /// Number of columns in a 2D array. @@ -207,7 +207,7 @@ namespace Emgu.CV } /// - /// Create a umat of the specific type. + /// Create an umat of the specific type. /// /// Size of the UMat /// Mat element type @@ -220,9 +220,9 @@ namespace Emgu.CV } /// - /// Get the Umat header for the specific roi of the parent + /// Get the UMat header for the specific roi of the parent /// - /// The parent Umat + /// The parent UMat /// The region of interest public UMat(UMat parent, Rectangle roi) : this(UMatInvoke.cveUMatCreateFromRect(parent.Ptr, ref roi), true) @@ -230,9 +230,9 @@ namespace Emgu.CV } /// - /// Create a umat header for the specific ROI + /// Create an UMat header for the specific ROI /// - /// The umat where the new UMat header will share data from + /// The UMat where the new UMat header will share data from /// The region of interest /// The region of interest public UMat(UMat umat, Emgu.CV.Structure.Range rowRange, Emgu.CV.Structure.Range colRange) @@ -314,7 +314,7 @@ namespace Emgu.CV } /// - /// Copy the data in this umat to the other mat + /// Copy the data in this UMat to the other mat /// /// Operation mask. Its non-zero elements indicate which matrix elements need to be copied. /// The input array to copy to @@ -465,7 +465,7 @@ namespace Emgu.CV } /// - /// Convert this Mat to Image + /// Convert this UMat to Image /// /// The type of Color /// The type of Depth @@ -689,7 +689,7 @@ namespace Emgu.CV } /// - /// Copy data from this Mat to the managed array + /// Copy data from this UMat to the managed array /// /// The type of managed data array /// The managed array where data will be copied to. @@ -752,7 +752,7 @@ namespace Emgu.CV /// /// Get a copy of the data values as an array /// - /// If true, a jagged array will returned. Otherwise it will return a regular array. + /// If true, a jagged array will be returned. Otherwise, it will return a regular array. /// a copy of the data values as an array public Array GetData(bool jagged = true) { @@ -847,7 +847,7 @@ namespace Emgu.CV } /// - /// Perform an binary OR operation with some value + /// Perform a binary OR operation with some value /// /// The mat to OR /// The color to OR @@ -863,7 +863,7 @@ namespace Emgu.CV } /// - /// Perform an binary OR operation with some color + /// Perform a binary OR operation with some color /// /// The mat to OR /// The color to OR @@ -874,7 +874,7 @@ namespace Emgu.CV } /// - /// Perform an binary OR operation with some scalar + /// Perform a binary OR operation with some scalar /// /// The mat to OR /// The value to OR @@ -890,7 +890,7 @@ namespace Emgu.CV } /// - /// Perform an binary OR operation with some scalar + /// Perform a binary OR operation with some scalar /// /// The mat to OR /// The color to OR @@ -1055,11 +1055,11 @@ namespace Emgu.CV } /// - /// * + /// Multiplies the specified by a scalar value. /// - /// The mat - /// The multiplication scale - /// * + /// The to be multiplied. + /// The scalar value to multiply the by. + /// A new that is the result of multiplying by . public static UMat operator *(UMat mat, double scale) { using (ScalarArray saValue = new ScalarArray(scale)) @@ -1071,33 +1071,35 @@ namespace Emgu.CV } /// - /// * + /// Multiplies the specified by a scalar value. /// - /// The mat - /// The multiplication scale - /// * + /// The to be multiplied. + /// The scalar value to multiply the by. + /// A new that is the result of multiplying by . public static UMat operator *(double scale, UMat mat) { return mat * scale; } /// - /// / + /// Divides the elements of the specified by the given scalar value. /// - /// The mat - /// The division scale - /// / + /// The whose elements are to be divided. + /// The scalar value by which to divide the elements of . + /// A new where each element is the result of the division of the corresponding element in by . + /// Thrown when is zero. public static UMat operator /(UMat mat, double scale) { return mat * (1.0 / scale); } /// - /// / + /// Divides the elements of the given scalar value by the specified . /// - /// The mat - /// The scale - /// / + /// The The elements to be divided. + /// The scalar value by which to be divided by the elements of . + /// A new where each element is the result of the division of by the corresponding element in . + /// Thrown when is zero./returns> public static UMat operator /(double scale, UMat mat) { using (ScalarArray saScale = new ScalarArray(scale))