CmpTypes

Author: shimat

src/OpenCvSharp/Cv2/Cv2_core.cs

@@ -1288,7 +1288,6 @@ public static void BitwiseAnd(InputArray src1, InputArray src2, OutputArray dst,
         GC.KeepAlive(src1);
         GC.KeepAlive(src2);
         GC.KeepAlive(dst);
-        dst.Fix();
         GC.KeepAlive(mask);
     }
 
@@ -1491,7 +1490,7 @@ public static void InRange(InputArray src, Scalar lowerb, Scalar upperb, OutputA
     /// <param name="dst">output array of type ref CV_8U that has the same size and the same number of channels as the input arrays.</param>
     /// <param name="cmpop">a flag, that specifies correspondence between the arrays (cv::CmpTypes)</param>
     // ReSharper disable once IdentifierTypo
-    public static void Compare(InputArray src1, InputArray src2, OutputArray dst, CmpType cmpop)
+    public static void Compare(InputArray src1, InputArray src2, OutputArray dst, CmpTypes cmpop)
     {
         if (src1 is null)
             throw new ArgumentNullException(nameof(src1));
@@ -1748,7 +1747,6 @@ public static void Log(InputArray src, OutputArray dst)
 
         GC.KeepAlive(src);
         GC.KeepAlive(dst);
-        dst.Fix();
     }
 
 
@@ -2511,7 +2509,7 @@ public static void EigenNonSymmetric(InputArray src, OutputArray eigenvalues, Ou
     /// <param name="samples">samples stored as separate matrices</param>
     /// <param name="covar">output covariance matrix of the type ctype and square size.</param>
     /// <param name="mean">input or output (depending on the flags) array as the average value of the input vectors.</param>
-    /// <param name="flags">operation flags as a combination of CovarFlags</param>
+    /// <param name="flags">operation flags - see CovarFlags.</param>
     /// <param name="ctype">type of the matrixl; it equals 'CV_64F' by default.</param>
     public static void CalcCovarMatrix(
         Mat[] samples, Mat covar, Mat mean,
@@ -2542,7 +2540,7 @@ public static void CalcCovarMatrix(
     /// <param name="samples">samples stored as rows/columns of a single matrix.</param>
     /// <param name="covar">output covariance matrix of the type ctype and square size.</param>
     /// <param name="mean">input or output (depending on the flags) array as the average value of the input vectors.</param>
-    /// <param name="flags">operation flags as a combination of CovarFlags</param>
+    /// <param name="flags">operation flags - see CovarFlags.</param>
     /// <param name="ctype">type of the matrixl; it equals 'CV_64F' by default.</param>
     public static void CalcCovarMatrix(
         InputArray samples, OutputArray covar,
@@ -2575,7 +2573,7 @@ public static void CalcCovarMatrix(
     /// <param name="data">input samples stored as the matrix rows or as the matrix columns.</param>
     /// <param name="mean">optional mean value; if the matrix is empty (noArray()), the mean is computed from the data.</param>
     /// <param name="eigenvectors">eigenvectors of the covariation matrix</param>
-    /// <param name="maxComponents">maximum number of components that PCA should
+    /// <param name="maxComponents">Number of components that PCA should
     /// retain; by default, all the components are retained.</param>
     public static void PCACompute(
         InputArray data, InputOutputArray mean,
@@ -2606,7 +2604,7 @@ public static void PCACompute(
     /// <param name="mean">optional mean value; if the matrix is empty (noArray()), the mean is computed from the data.</param>
     /// <param name="eigenvectors">eigenvectors of the covariation matrix</param>
     /// <param name="eigenvalues">eigenvalues of the covariation matrix</param>
-    /// <param name="maxComponents">maximum number of components that PCA should
+    /// <param name="maxComponents">Number of components that PCA should
     /// retain; by default, all the components are retained.</param>
     public static void PCACompute(
         InputArray data, InputOutputArray mean,

src/OpenCvSharp/Modules/core/Enum/CmpType.cs

@@ -0,0 +1,74 @@
+namespace OpenCvSharp;
+
+/// <summary>
+/// The flag specifying the relation between the elements to be checked
+/// </summary>
+public enum CmpTypes
+{
+    /// <summary>
+    /// src1(I) "equal to" src2(I)
+    /// </summary>
+    EQ = 0,
+        
+    /// <summary>
+    /// src1(I) "greater than" src2(I)
+    /// </summary>
+    GT = 1,
+        
+    /// <summary>
+    /// src1(I) "greater or equal" src2(I)
+    /// </summary>
+    GE = 2,
+
+    /// <summary>
+    /// src1(I) "less than" src2(I)
+    /// </summary>
+    LT = 3,
+
+    /// <summary>
+    /// src1(I) "less or equal" src2(I)
+    /// </summary>
+    LE = 4,
+
+    /// <summary>
+    /// src1(I) "not equal to" src2(I)
+    /// </summary>
+    NE = 5,
+}
+
+/// <summary>
+/// Obsolete: Use CmpTypes instead. This enum is kept for backward compatibility.
+/// </summary>
+[Obsolete("Use CmpTypes instead", false)]
+public enum CmpType
+{
+    /// <summary>
+    /// src1(I) "equal to" src2(I)
+    /// </summary>
+    EQ = 0,
+
+    /// <summary>
+    /// src1(I) "greater than" src2(I)
+    /// </summary>
+    GT = 1,
+
+    /// <summary>
+    /// src1(I) "greater or equal" src2(I)
+    /// </summary>
+    GE = 2,
+
+    /// <summary>
+    /// src1(I) "less than" src2(I)
+    /// </summary>
+    LT = 3,
+
+    /// <summary>
+    /// src1(I) "less or equal" src2(I)
+    /// </summary>
+    LE = 4,
+
+    /// <summary>
+    /// src1(I) "not equal to" src2(I)
+    /// </summary>
+    NE = 5,
+}

src/OpenCvSharp/Modules/core/Enum/CmpTypes.cs

@@ -180,7 +180,7 @@ private Mat GetLabelMask(int label)
         using var labels = Mat.FromPixelData(rows, cols, MatType.CV_32SC1, Labels.GetBuffer());
         using var cmp = new Mat(rows, cols, MatType.CV_32SC1, Scalar.All(label));
         var result = new Mat();
-        Cv2.Compare(labels, cmp, result, CmpType.EQ);
+        Cv2.Compare(labels, cmp, result, CmpTypes.EQ);
         return result;
     }
 

src/OpenCvSharp/Modules/imgproc/ConnectedComponent.cs

@@ -38,7 +38,7 @@ protected static void ImageEquals(Mat img1, Mat img2)
 #pragma warning restore CA1062 
 
         using var comparison = new Mat();
-        Cv2.Compare(img1, img2, comparison, CmpType.NE);
+        Cv2.Compare(img1, img2, comparison, CmpTypes.NE);
 
         if (img1.Channels() == 1)
         {

test/OpenCvSharp.Tests/TestBase.cs

@@ -288,7 +288,7 @@ public void Compare()
         using var src = Mat.FromPixelData(bytes.Length, 1, MatType.CV_8UC1, bytes);
         using var dst = new Mat();
 
-        Cv2.Compare(src, 3, dst, CmpType.LE);
+        Cv2.Compare(src, 3, dst, CmpTypes.LE);
         Assert.Equal(255, dst.Get<byte>(0));
         Assert.Equal(255, dst.Get<byte>(1));
         Assert.Equal(255, dst.Get<byte>(2));