/
Mat.cs
4119 lines (3694 loc) · 136 KB
/
Mat.cs
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
using System;
using System.Collections.Generic;
using System.Diagnostics.CodeAnalysis;
using System.Diagnostics.Contracts;
using System.IO;
using System.Linq;
using System.Runtime.CompilerServices;
using System.Runtime.InteropServices;
using OpenCvSharp.Internal;
namespace OpenCvSharp;
/// <summary>
/// OpenCV C++ n-dimensional dense array class (cv::Mat)
/// </summary>
public partial class Mat : DisposableCvObject
{
#region Init & Disposal
/// <summary>
/// typeof(T) -> MatType
/// </summary>
protected static readonly IReadOnlyDictionary<Type, MatType> TypeMap = new Dictionary<Type, MatType>
{
[typeof(byte)] = MatType.CV_8UC1,
[typeof(sbyte)] = MatType.CV_8SC1,
[typeof(short)] = MatType.CV_16SC1,
[typeof(char)] = MatType.CV_16UC1,
[typeof(ushort)] = MatType.CV_16UC1,
[typeof(int)] = MatType.CV_32SC1,
[typeof(float)] = MatType.CV_32FC1,
[typeof(double)] = MatType.CV_64FC1,
[typeof(Vec2b)] = MatType.CV_8UC2,
[typeof(Vec3b)] = MatType.CV_8UC3,
[typeof(Vec4b)] = MatType.CV_8UC4,
[typeof(Vec6b)] = MatType.CV_8UC(6),
[typeof(Vec2s)] = MatType.CV_16SC2,
[typeof(Vec3s)] = MatType.CV_16SC3,
[typeof(Vec4s)] = MatType.CV_16SC4,
[typeof(Vec6s)] = MatType.CV_16SC(6),
[typeof(Vec2w)] = MatType.CV_16UC2,
[typeof(Vec3w)] = MatType.CV_16UC3,
[typeof(Vec4w)] = MatType.CV_16UC4,
[typeof(Vec6w)] = MatType.CV_16UC(6),
[typeof(Vec2i)] = MatType.CV_32SC2,
[typeof(Vec3i)] = MatType.CV_32SC3,
[typeof(Vec4i)] = MatType.CV_32SC4,
[typeof(Vec6i)] = MatType.CV_32SC(6),
[typeof(Vec2f)] = MatType.CV_32FC2,
[typeof(Vec3f)] = MatType.CV_32FC3,
[typeof(Vec4f)] = MatType.CV_32FC4,
[typeof(Vec6f)] = MatType.CV_32FC(6),
[typeof(Vec2d)] = MatType.CV_64FC2,
[typeof(Vec3d)] = MatType.CV_64FC3,
[typeof(Vec4d)] = MatType.CV_64FC4,
[typeof(Vec6d)] = MatType.CV_64FC(6),
[typeof(Point)] = MatType.CV_32SC2,
[typeof(Point2f)] = MatType.CV_32FC2,
[typeof(Point2d)] = MatType.CV_64FC2,
[typeof(Point3i)] = MatType.CV_32SC3,
[typeof(Point3f)] = MatType.CV_32FC3,
[typeof(Point3d)] = MatType.CV_64FC3,
[typeof(Size)] = MatType.CV_32SC2,
[typeof(Size2f)] = MatType.CV_32FC2,
[typeof(Size2d)] = MatType.CV_64FC2,
[typeof(Rect)] = MatType.CV_32SC4,
[typeof(Rect2f)] = MatType.CV_32FC4,
[typeof(Rect2d)] = MatType.CV_64FC4,
[typeof(DMatch)] = MatType.CV_32FC4,
};
/// <summary>
/// Creates from native cv::Mat* pointer
/// </summary>
/// <param name="ptr"></param>
public Mat(IntPtr ptr)
{
if (ptr == IntPtr.Zero)
throw new OpenCvSharpException("Native object address is NULL");
this.ptr = ptr;
}
/// <summary>
/// Creates empty Mat
/// </summary>
public Mat()
{
NativeMethods.HandleException(
NativeMethods.core_Mat_new1(out ptr));
}
/// <inheritdoc />
/// <summary>
/// </summary>
/// <param name="m"></param>
protected Mat(Mat m)
{
if (m is null)
throw new ArgumentNullException(nameof(m));
m.ThrowIfDisposed();
NativeMethods.HandleException(
NativeMethods.core_Mat_new12(m.ptr, out ptr));
if (ptr == IntPtr.Zero)
throw new OpenCvSharpException("imread failed.");
}
/// <summary>
/// Loads an image from a file. (cv::imread)
/// </summary>
/// <param name="fileName">Name of file to be loaded.</param>
/// <param name="flags">Specifies color type of the loaded image</param>
public Mat(string fileName, ImreadModes flags = ImreadModes.Color)
{
if (string.IsNullOrEmpty(fileName))
throw new ArgumentNullException(nameof(fileName));
NativeMethods.HandleException(
NativeMethods.imgcodecs_imread(fileName, (int) flags, out ptr));
}
/// <summary>
/// constructs 2D matrix of the specified size and type
/// </summary>
/// <param name="rows">Number of rows in a 2D array.</param>
/// <param name="cols">Number of columns in a 2D array.</param>
/// <param name="type">Array type. Use MatType.CV_8UC1, ..., CV_64FC4 to create 1-4 channel matrices,
/// or MatType. CV_8UC(n), ..., CV_64FC(n) to create multi-channel matrices.</param>
public Mat(int rows, int cols, MatType type)
{
NativeMethods.HandleException(
NativeMethods.core_Mat_new2(rows, cols, type, out ptr));
}
/// <summary>
/// constructs 2D matrix of the specified size and type
/// </summary>
/// <param name="size">2D array size: Size(cols, rows) . In the Size() constructor,
/// the number of rows and the number of columns go in the reverse order.</param>
/// <param name="type">Array type. Use MatType.CV_8UC1, ..., CV_64FC4 to create 1-4 channel matrices,
/// or MatType.CV_8UC(n), ..., CV_64FC(n) to create multi-channel matrices.</param>
public Mat(Size size, MatType type)
{
NativeMethods.HandleException(
NativeMethods.core_Mat_new2(size.Height, size.Width, type, out ptr));
}
/// <summary>
/// constructs 2D matrix and fills it with the specified Scalar value.
/// </summary>
/// <param name="rows">Number of rows in a 2D array.</param>
/// <param name="cols">Number of columns in a 2D array.</param>
/// <param name="type">Array type. Use MatType.CV_8UC1, ..., CV_64FC4 to create 1-4 channel matrices,
/// or MatType. CV_8UC(n), ..., CV_64FC(n) to create multi-channel matrices.</param>
/// <param name="s">An optional value to initialize each matrix element with.
/// To set all the matrix elements to the particular value after the construction, use SetTo(Scalar s) method .</param>
public Mat(int rows, int cols, MatType type, Scalar s)
{
NativeMethods.HandleException(
NativeMethods.core_Mat_new3(rows, cols, type, s, out ptr));
}
/// <summary>
/// constructs 2D matrix and fills it with the specified Scalar value.
/// </summary>
/// <param name="size">2D array size: Size(cols, rows) . In the Size() constructor,
/// the number of rows and the number of columns go in the reverse order.</param>
/// <param name="type">Array type. Use MatType.CV_8UC1, ..., CV_64FC4 to create 1-4 channel matrices,
/// or CV_8UC(n), ..., CV_64FC(n) to create multi-channel (up to CV_CN_MAX channels) matrices.</param>
/// <param name="s">An optional value to initialize each matrix element with.
/// To set all the matrix elements to the particular value after the construction, use SetTo(Scalar s) method .</param>
public Mat(Size size, MatType type, Scalar s)
{
NativeMethods.HandleException(
NativeMethods.core_Mat_new3(size.Height, size.Width, type, s, out ptr));
}
/// <summary>
/// creates a matrix header for a part of the bigger matrix
/// </summary>
/// <param name="m">Array that (as a whole or partly) is assigned to the constructed matrix.
/// No data is copied by these constructors. Instead, the header pointing to m data or its sub-array
/// is constructed and associated with it. The reference counter, if any, is incremented.
/// So, when you modify the matrix formed using such a constructor, you also modify the corresponding elements of m .
/// If you want to have an independent copy of the sub-array, use Mat::clone() .</param>
/// <param name="rowRange">Range of the m rows to take. As usual, the range start is inclusive and the range end is exclusive.
/// Use Range.All to take all the rows.</param>
/// <param name="colRange">Range of the m columns to take. Use Range.All to take all the columns.</param>
public Mat(Mat m, Range rowRange, Range? colRange = null)
{
if (m is null)
throw new ArgumentNullException(nameof(m));
m.ThrowIfDisposed();
if (colRange.HasValue)
NativeMethods.HandleException(NativeMethods.core_Mat_new4(m.ptr, rowRange, colRange.Value, out ptr));
else
NativeMethods.HandleException(NativeMethods.core_Mat_new5(m.ptr, rowRange, out ptr));
GC.KeepAlive(m);
}
/// <summary>
/// creates a matrix header for a part of the bigger matrix
/// </summary>
/// <param name="m">Array that (as a whole or partly) is assigned to the constructed matrix.
/// No data is copied by these constructors. Instead, the header pointing to m data or its sub-array
/// is constructed and associated with it. The reference counter, if any, is incremented.
/// So, when you modify the matrix formed using such a constructor, you also modify the corresponding elements of m .
/// If you want to have an independent copy of the sub-array, use Mat.Clone() .</param>
/// <param name="ranges">Array of selected ranges of m along each dimensionality.</param>
public Mat(Mat m, params Range[] ranges)
{
if (m is null)
throw new ArgumentNullException(nameof(m));
if (ranges is null)
throw new ArgumentNullException(nameof(ranges));
if (ranges.Length == 0)
throw new ArgumentException("empty ranges", nameof(ranges));
m.ThrowIfDisposed();
NativeMethods.HandleException(
NativeMethods.core_Mat_new6(m.ptr, ranges, out ptr));
GC.KeepAlive(m);
}
/// <summary>
/// creates a matrix header for a part of the bigger matrix
/// </summary>
/// <param name="m">Array that (as a whole or partly) is assigned to the constructed matrix.
/// No data is copied by these constructors. Instead, the header pointing to m data or its sub-array
/// is constructed and associated with it. The reference counter, if any, is incremented.
/// So, when you modify the matrix formed using such a constructor, you also modify the corresponding elements of m .
/// If you want to have an independent copy of the sub-array, use Mat.Clone() .</param>
/// <param name="roi">Region of interest.</param>
public Mat(Mat m, Rect roi)
{
if (m is null)
throw new ArgumentNullException(nameof(m));
m.ThrowIfDisposed();
NativeMethods.HandleException(
NativeMethods.core_Mat_new7(m.ptr, roi, out ptr));
GC.KeepAlive(m);
}
/// <summary>
/// constructor for matrix headers pointing to user-allocated data
/// </summary>
/// <param name="rows">Number of rows in a 2D array.</param>
/// <param name="cols">Number of columns in a 2D array.</param>
/// <param name="type">Array type. Use MatType.CV_8UC1, ..., CV_64FC4 to create 1-4 channel matrices,
/// or MatType. CV_8UC(n), ..., CV_64FC(n) to create multi-channel matrices.</param>
/// <param name="data">Pointer to the user data. Matrix constructors that take data and step parameters do not allocate matrix data.
/// Instead, they just initialize the matrix header that points to the specified data, which means that no data is copied.
/// This operation is very efficient and can be used to process external data using OpenCV functions.
/// The external data is not automatically de-allocated, so you should take care of it.</param>
/// <param name="step">Number of bytes each matrix row occupies. The value should include the padding bytes at the end of each row, if any.
/// If the parameter is missing (set to AUTO_STEP ), no padding is assumed and the actual step is calculated as cols*elemSize() .</param>
public Mat(int rows, int cols, MatType type, IntPtr data, long step = 0)
{
NativeMethods.HandleException(
NativeMethods.core_Mat_new8(rows, cols, type, data, new IntPtr(step), out ptr));
}
/// <summary>
/// constructor for matrix headers pointing to user-allocated data
/// </summary>
/// <param name="rows">Number of rows in a 2D array.</param>
/// <param name="cols">Number of columns in a 2D array.</param>
/// <param name="type">Array type. Use MatType.CV_8UC1, ..., CV_64FC4 to create 1-4 channel matrices,
/// or MatType. CV_8UC(n), ..., CV_64FC(n) to create multi-channel matrices.</param>
/// <param name="data">Pointer to the user data. Matrix constructors that take data and step parameters do not allocate matrix data.
/// Instead, they just initialize the matrix header that points to the specified data, which means that no data is copied.
/// This operation is very efficient and can be used to process external data using OpenCV functions.
/// The external data is not automatically de-allocated, so you should take care of it.</param>
/// <param name="step">Number of bytes each matrix row occupies. The value should include the padding bytes at the end of each row, if any.
/// If the parameter is missing (set to AUTO_STEP ), no padding is assumed and the actual step is calculated as cols*elemSize() .</param>
public Mat(int rows, int cols, MatType type, Array data, long step = 0)
{
var handle = AllocGCHandle(data);
NativeMethods.HandleException(
NativeMethods.core_Mat_new8(rows, cols, type,
handle.AddrOfPinnedObject(), new IntPtr(step), out ptr));
}
/// <summary>
/// constructor for matrix headers pointing to user-allocated data
/// </summary>
/// <param name="sizes">Array of integers specifying an n-dimensional array shape.</param>
/// <param name="type">Array type. Use MatType.CV_8UC1, ..., CV_64FC4 to create 1-4 channel matrices,
/// or MatType. CV_8UC(n), ..., CV_64FC(n) to create multi-channel matrices.</param>
/// <param name="data">Pointer to the user data. Matrix constructors that take data and step parameters do not allocate matrix data.
/// Instead, they just initialize the matrix header that points to the specified data, which means that no data is copied.
/// This operation is very efficient and can be used to process external data using OpenCV functions.
/// The external data is not automatically de-allocated, so you should take care of it.</param>
/// <param name="steps">Array of ndims-1 steps in case of a multi-dimensional array (the last step is always set to the element size).
/// If not specified, the matrix is assumed to be continuous.</param>
public Mat(IEnumerable<int> sizes, MatType type, IntPtr data, IEnumerable<long>? steps = null)
{
if (sizes is null)
throw new ArgumentNullException(nameof(sizes));
if (data == IntPtr.Zero)
throw new ArgumentNullException(nameof(data));
#pragma warning disable CA1508
var sizesArray = sizes as int[] ?? sizes.ToArray();
#pragma warning restore CA1508
if (steps is null)
{
NativeMethods.HandleException(
NativeMethods.core_Mat_new9(sizesArray.Length, sizesArray, type, data, IntPtr.Zero, out ptr));
}
else
{
var stepsArray = steps.Select(s => new IntPtr(s)).ToArray();
NativeMethods.HandleException(
NativeMethods.core_Mat_new9(sizesArray.Length, sizesArray, type, data, stepsArray, out ptr));
}
}
/// <summary>
/// constructor for matrix headers pointing to user-allocated data
/// </summary>
/// <param name="sizes">Array of integers specifying an n-dimensional array shape.</param>
/// <param name="type">Array type. Use MatType.CV_8UC1, ..., CV_64FC4 to create 1-4 channel matrices,
/// or MatType. CV_8UC(n), ..., CV_64FC(n) to create multi-channel matrices.</param>
/// <param name="data">Pointer to the user data. Matrix constructors that take data and step parameters do not allocate matrix data.
/// Instead, they just initialize the matrix header that points to the specified data, which means that no data is copied.
/// This operation is very efficient and can be used to process external data using OpenCV functions.
/// The external data is not automatically de-allocated, so you should take care of it.</param>
/// <param name="steps">Array of ndims-1 steps in case of a multi-dimensional array (the last step is always set to the element size).
/// If not specified, the matrix is assumed to be continuous.</param>
public Mat(IEnumerable<int> sizes, MatType type, Array data, IEnumerable<long>? steps = null)
{
if (sizes is null)
throw new ArgumentNullException(nameof(sizes));
if (data is null)
throw new ArgumentNullException(nameof(data));
var handle = AllocGCHandle(data);
#pragma warning disable CA1508
var sizesArray = sizes as int[] ?? sizes.ToArray();
#pragma warning restore CA1508
if (steps is null)
{
NativeMethods.HandleException(
NativeMethods.core_Mat_new9(sizesArray.Length, sizesArray,
type, handle.AddrOfPinnedObject(), IntPtr.Zero, out ptr));
}
else
{
var stepsArray = steps.Select(s => new IntPtr(s)).ToArray();
NativeMethods.HandleException(
NativeMethods.core_Mat_new9(sizesArray.Length, sizesArray,
type, handle.AddrOfPinnedObject(), stepsArray, out ptr));
}
}
/// <summary>
/// constructs n-dimensional matrix
/// </summary>
/// <param name="sizes">Array of integers specifying an n-dimensional array shape.</param>
/// <param name="type">Array type. Use MatType.CV_8UC1, ..., CV_64FC4 to create 1-4 channel matrices,
/// or MatType. CV_8UC(n), ..., CV_64FC(n) to create multi-channel matrices.</param>
public Mat(IEnumerable<int> sizes, MatType type)
{
if (sizes is null)
throw new ArgumentNullException(nameof(sizes));
#pragma warning disable CA1508
var sizesArray = sizes as int[] ?? sizes.ToArray();
#pragma warning restore CA1508
NativeMethods.HandleException(
NativeMethods.core_Mat_new10(sizesArray.Length, sizesArray, type, out ptr));
}
/// <summary>
/// constructs n-dimensional matrix
/// </summary>
/// <param name="sizes">Array of integers specifying an n-dimensional array shape.</param>
/// <param name="type">Array type. Use MatType.CV_8UC1, ..., CV_64FC4 to create 1-4 channel matrices,
/// or MatType. CV_8UC(n), ..., CV_64FC(n) to create multi-channel matrices.</param>
/// <param name="s">An optional value to initialize each matrix element with.
/// To set all the matrix elements to the particular value after the construction, use SetTo(Scalar s) method .</param>
public Mat(IEnumerable<int> sizes, MatType type, Scalar s)
{
if (sizes is null)
throw new ArgumentNullException(nameof(sizes));
#pragma warning disable CA1508
var sizesArray = sizes as int[] ?? sizes.ToArray();
#pragma warning restore CA1508
NativeMethods.HandleException(
NativeMethods.core_Mat_new11(sizesArray.Length, sizesArray, type, s, out ptr));
}
/// <summary>
/// Releases the resources
/// </summary>
public void Release()
{
Dispose();
}
/// <inheritdoc />
/// <summary>
/// Releases unmanaged resources
/// </summary>
protected override void DisposeUnmanaged()
{
if (ptr != IntPtr.Zero && IsEnabledDispose)
NativeMethods.HandleException(
NativeMethods.core_Mat_delete(ptr));
base.DisposeUnmanaged();
}
#region Static Initializers
/// <summary>
/// Creates the Mat instance from System.IO.Stream
/// </summary>
/// <param name="stream"></param>
/// <param name="mode"></param>
/// <returns></returns>
public static Mat FromStream(Stream stream, ImreadModes mode)
{
if (stream is null)
throw new ArgumentNullException(nameof(stream));
if (stream.Length > int.MaxValue)
throw new ArgumentException("Not supported stream (too long)");
using var memoryStream = new MemoryStream();
stream.CopyTo(memoryStream);
return FromImageData(memoryStream.ToArray(), mode);
}
/// <summary>
/// Creates the Mat instance from image data (using cv::decode)
/// </summary>
/// <param name="imageBytes"></param>
/// <param name="mode"></param>
/// <returns></returns>
public static Mat ImDecode(byte[] imageBytes, ImreadModes mode = ImreadModes.Color)
{
if (imageBytes is null)
throw new ArgumentNullException(nameof(imageBytes));
return Cv2.ImDecode(imageBytes, mode);
}
/// <summary>
/// Reads image from the specified buffer in memory.
/// </summary>
/// <param name="span">The input slice of bytes.</param>
/// <param name="mode">The same flags as in imread</param>
/// <returns></returns>
public static Mat ImDecode(ReadOnlySpan<byte> span, ImreadModes mode = ImreadModes.Color)
{
return Cv2.ImDecode(span, mode);
}
/// <summary>
/// Creates the Mat instance from image data (using cv::decode)
/// </summary>
/// <param name="imageBytes"></param>
/// <param name="mode"></param>
/// <returns></returns>
public static Mat FromImageData(byte[] imageBytes, ImreadModes mode = ImreadModes.Color)
{
return ImDecode(imageBytes, mode);
}
/// <summary>
/// Reads image from the specified buffer in memory.
/// </summary>
/// <param name="span">The input slice of bytes.</param>
/// <param name="mode">The same flags as in imread</param>
/// <returns></returns>
public static Mat FromImageData(ReadOnlySpan<byte> span, ImreadModes mode = ImreadModes.Color)
{
return Cv2.ImDecode(span, mode);
}
#endregion
#endregion
#region Static
/// <summary>
/// Extracts a diagonal from a matrix, or creates a diagonal matrix.
/// </summary>
/// <param name="d">One-dimensional matrix that represents the main diagonal.</param>
/// <returns></returns>
public static Mat Diag(Mat d)
{
if (d is null)
throw new ArgumentNullException(nameof(d));
NativeMethods.HandleException(
NativeMethods.core_Mat_diag_static(d.CvPtr, out var ret));
GC.KeepAlive(d);
var retVal = new Mat(ret);
return retVal;
}
/// <summary>
/// Returns a zero array of the specified size and type.
/// </summary>
/// <param name="rows">Number of rows.</param>
/// <param name="cols">Number of columns.</param>
/// <param name="type">Created matrix type.</param>
/// <returns></returns>
public static MatExpr Zeros(int rows, int cols, MatType type)
{
NativeMethods.HandleException(
NativeMethods.core_Mat_zeros1(rows, cols, type, out var ret));
var retVal = new MatExpr(ret);
return retVal;
}
/// <summary>
/// Returns a zero array of the specified size and type.
/// </summary>
/// <param name="size">Alternative to the matrix size specification Size(cols, rows) .</param>
/// <param name="type">Created matrix type.</param>
/// <returns></returns>
public static MatExpr Zeros(Size size, MatType type)
{
return Zeros(size.Height, size.Width, type);
}
/// <summary>
/// Returns a zero array of the specified size and type.
/// </summary>
/// <param name="type">Created matrix type.</param>
/// <param name="sizes"></param>
/// <returns></returns>
public static MatExpr Zeros(MatType type, params int[] sizes)
{
if (sizes is null)
throw new ArgumentNullException(nameof(sizes));
NativeMethods.HandleException(
NativeMethods.core_Mat_zeros2(sizes.Length, sizes, type, out var ret));
var retVal = new MatExpr(ret);
return retVal;
}
/// <summary>
/// Returns an array of all 1’s of the specified size and type.
/// </summary>
/// <param name="rows">Number of rows.</param>
/// <param name="cols">Number of columns.</param>
/// <param name="type">Created matrix type.</param>
/// <returns></returns>
public static MatExpr Ones(int rows, int cols, MatType type)
{
NativeMethods.HandleException(
NativeMethods.core_Mat_ones1(rows, cols, type, out var ret));
var retVal = new MatExpr(ret);
return retVal;
}
/// <summary>
/// Returns an array of all 1’s of the specified size and type.
/// </summary>
/// <param name="size">Alternative to the matrix size specification Size(cols, rows) .</param>
/// <param name="type">Created matrix type.</param>
/// <returns></returns>
public static MatExpr Ones(Size size, MatType type)
{
return Ones(size.Height, size.Width, type);
}
/// <summary>
/// Returns an array of all 1’s of the specified size and type.
/// </summary>
/// <param name="type">Created matrix type.</param>
/// <param name="sizes">Array of integers specifying the array shape.</param>
/// <returns></returns>
public static MatExpr Ones(MatType type, params int[] sizes)
{
if (sizes is null)
throw new ArgumentNullException(nameof(sizes));
NativeMethods.HandleException(
NativeMethods.core_Mat_ones2(sizes.Length, sizes, type, out var ret));
var retVal = new MatExpr(ret);
return retVal;
}
/// <summary>
/// Returns an identity matrix of the specified size and type.
/// </summary>
/// <param name="size">Alternative to the matrix size specification Size(cols, rows) .</param>
/// <param name="type">Created matrix type.</param>
/// <returns></returns>
public static MatExpr Eye(Size size, MatType type)
{
return Eye(size.Height, size.Width, type);
}
/// <summary>
/// Returns an identity matrix of the specified size and type.
/// </summary>
/// <param name="rows">Number of rows.</param>
/// <param name="cols">Number of columns.</param>
/// <param name="type">Created matrix type.</param>
/// <returns></returns>
public static MatExpr Eye(int rows, int cols, MatType type)
{
NativeMethods.HandleException(
NativeMethods.core_Mat_eye(rows, cols, type, out var ret));
var retVal = new MatExpr(ret);
return retVal;
}
#region FromArray
/// <summary>
/// Initializes as N x 1 matrix and copies array data to this
/// </summary>
/// <param name="arr">Source array data to be copied to this</param>
public static Mat<TElem> FromArray<TElem>(params TElem[] arr)
where TElem : unmanaged
{
if (arr is null)
throw new ArgumentNullException(nameof(arr));
if (arr.Length == 0)
throw new ArgumentException("arr.Length == 0");
var numElems = arr.Length /* / ThisChannels*/;
var mat = new Mat<TElem>(numElems, 1);
if (!mat.SetArray(arr))
throw new OpenCvSharpException("Failed to copy pixel data into cv::Mat");
return mat;
}
/// <summary>
/// Initializes as M x N matrix and copies array data to this
/// </summary>
/// <param name="arr">Source array data to be copied to this</param>
public static Mat<TElem> FromArray<TElem>(TElem[,] arr)
where TElem : unmanaged
{
if (arr is null)
throw new ArgumentNullException(nameof(arr));
if (arr.Length == 0)
throw new ArgumentException("arr.Length == 0");
var rows = arr.GetLength(0);
var cols = arr.GetLength(1);
var mat = new Mat<TElem>(rows, cols);
if (!mat.SetRectangularArray(arr))
throw new OpenCvSharpException("Failed to copy pixel data into cv::Mat");
return mat;
}
/// <summary>
/// Initializes as N x 1 matrix and copies array data to this
/// </summary>
/// <param name="enumerable">Source array data to be copied to this</param>
public static Mat<TElem> FromArray<TElem>(IEnumerable<TElem> enumerable)
where TElem : unmanaged
{
return FromArray(enumerable.ToArray());
}
#endregion
#endregion
#region Operators
#pragma warning disable 1591
public static Mat operator +(Mat mat) => mat;
public MatExpr Plus() => this;
public static MatExpr operator -(Mat mat)
{
if (mat is null)
throw new ArgumentNullException(nameof(mat));
NativeMethods.HandleException(
NativeMethods.core_Mat_operatorUnaryMinus(mat.CvPtr, out var ret));
GC.KeepAlive(mat);
return new MatExpr(ret);
}
public MatExpr Negate() => -this;
public static MatExpr operator +(Mat a, Mat b)
{
if (a is null)
throw new ArgumentNullException(nameof(a));
if (b is null)
throw new ArgumentNullException(nameof(b));
a.ThrowIfDisposed();
b.ThrowIfDisposed();
NativeMethods.HandleException(
NativeMethods.core_Mat_operatorAdd_MatMat(a.CvPtr, b.CvPtr, out var ret));
GC.KeepAlive(a);
GC.KeepAlive(b);
return new MatExpr(ret);
}
public static MatExpr operator +(Mat a, Scalar s)
{
if (a is null)
throw new ArgumentNullException(nameof(a));
a.ThrowIfDisposed();
NativeMethods.HandleException(
NativeMethods.core_Mat_operatorAdd_MatScalar(a.CvPtr, s, out var ret));
GC.KeepAlive(a);
return new MatExpr(ret);
}
public static MatExpr operator +(Scalar s, Mat a)
{
if (a is null)
throw new ArgumentNullException(nameof(a));
a.ThrowIfDisposed();
NativeMethods.HandleException(
NativeMethods.core_Mat_operatorAdd_ScalarMat(s, a.CvPtr, out var ret));
GC.KeepAlive(a);
return new MatExpr(ret);
}
public MatExpr Add(Mat m) => this + m;
public MatExpr Add(Scalar s) => this + s;
public static MatExpr operator -(Mat a, Mat b)
{
if (a is null)
throw new ArgumentNullException(nameof(a));
if (b is null)
throw new ArgumentNullException(nameof(b));
a.ThrowIfDisposed();
b.ThrowIfDisposed();
NativeMethods.HandleException(
NativeMethods.core_Mat_operatorSubtract_MatMat(a.CvPtr, b.CvPtr, out var ret));
GC.KeepAlive(a);
GC.KeepAlive(b);
return new MatExpr(ret);
}
public static MatExpr operator -(Mat a, Scalar s)
{
if (a is null)
throw new ArgumentNullException(nameof(a));
a.ThrowIfDisposed();
NativeMethods.HandleException(
NativeMethods.core_Mat_operatorSubtract_MatScalar(a.CvPtr, s, out var ret));
GC.KeepAlive(a);
return new MatExpr(ret);
}
public static MatExpr operator -(Scalar s, Mat a)
{
if (a is null)
throw new ArgumentNullException(nameof(a));
a.ThrowIfDisposed();
NativeMethods.HandleException(
NativeMethods.core_Mat_operatorSubtract_ScalarMat(s, a.CvPtr, out var ret));
GC.KeepAlive(a);
return new MatExpr(ret);
}
public MatExpr Subtract(Mat m) => this - m;
public MatExpr Subtract(Scalar s) => this - s;
public static MatExpr operator *(Mat a, Mat b)
{
if (a is null)
throw new ArgumentNullException(nameof(a));
if (b is null)
throw new ArgumentNullException(nameof(b));
a.ThrowIfDisposed();
b.ThrowIfDisposed();
NativeMethods.HandleException(
NativeMethods.core_Mat_operatorMultiply_MatMat(a.CvPtr, b.CvPtr, out var ret));
GC.KeepAlive(a);
GC.KeepAlive(b);
return new MatExpr(ret);
}
public static MatExpr operator *(Mat a, double s)
{
if (a is null)
throw new ArgumentNullException(nameof(a));
a.ThrowIfDisposed();
NativeMethods.HandleException(
NativeMethods.core_Mat_operatorMultiply_MatDouble(a.CvPtr, s, out var ret));
GC.KeepAlive(a);
return new MatExpr(ret);
}
public static MatExpr operator *(double s, Mat a)
{
if (a is null)
throw new ArgumentNullException(nameof(a));
a.ThrowIfDisposed();
NativeMethods.HandleException(
NativeMethods.core_Mat_operatorMultiply_DoubleMat(s, a.CvPtr, out var ret));
GC.KeepAlive(a);
return new MatExpr(ret);
}
public MatExpr Multiply(Mat m) => this * m;
public MatExpr Multiply(double s) => this * s;
public static MatExpr operator /(Mat a, Mat b)
{
if (a is null)
throw new ArgumentNullException(nameof(a));
if (b is null)
throw new ArgumentNullException(nameof(b));
a.ThrowIfDisposed();
b.ThrowIfDisposed();
NativeMethods.HandleException(
NativeMethods.core_Mat_operatorDivide_MatMat(a.CvPtr, b.CvPtr, out var ret));
GC.KeepAlive(a);
GC.KeepAlive(b);
return new MatExpr(ret);
}
public static MatExpr operator /(Mat a, double s)
{
if (a is null)
throw new ArgumentNullException(nameof(a));
a.ThrowIfDisposed();
NativeMethods.HandleException(
NativeMethods.core_Mat_operatorDivide_MatDouble(a.CvPtr, s, out var ret));
GC.KeepAlive(a);
return new MatExpr(ret);
}
public static MatExpr operator /(double s, Mat a)
{
if (a is null)
throw new ArgumentNullException(nameof(a));
a.ThrowIfDisposed();
NativeMethods.HandleException(
NativeMethods.core_Mat_operatorDivide_DoubleMat(s, a.CvPtr, out var ret));
GC.KeepAlive(a);
return new MatExpr(ret);
}
public MatExpr Divide(Mat m) => this / m;
public MatExpr Divide(double s) => this / s;
public static MatExpr operator &(Mat a, Mat b)
{
if (a is null)
throw new ArgumentNullException(nameof(a));
if (b is null)
throw new ArgumentNullException(nameof(b));
a.ThrowIfDisposed();
b.ThrowIfDisposed();
NativeMethods.HandleException(
NativeMethods.core_Mat_operatorAnd_MatMat(a.CvPtr, b.CvPtr, out var ret));
GC.KeepAlive(a);
GC.KeepAlive(b);
return new MatExpr(ret);
}
public static MatExpr operator &(Mat a, double s)
{
if (a is null)
throw new ArgumentNullException(nameof(a));
a.ThrowIfDisposed();
NativeMethods.HandleException(
NativeMethods.core_Mat_operatorAnd_MatDouble(a.CvPtr, s, out var ret));
GC.KeepAlive(a);
return new MatExpr(ret);
}
public static MatExpr operator &(double s, Mat a)
{
if (a is null)
throw new ArgumentNullException(nameof(a));
a.ThrowIfDisposed();
NativeMethods.HandleException(
NativeMethods.core_Mat_operatorAnd_DoubleMat(s, a.CvPtr, out var ret));
GC.KeepAlive(a);
return new MatExpr(ret);
}
public MatExpr BitwiseAnd(Mat m) => this & m;
public MatExpr BitwiseAnd(double s) => this & s;
public static MatExpr operator |(Mat a, Mat b)
{
if (a is null)
throw new ArgumentNullException(nameof(a));
if (b is null)
throw new ArgumentNullException(nameof(b));
a.ThrowIfDisposed();
b.ThrowIfDisposed();
NativeMethods.HandleException(
NativeMethods.core_Mat_operatorOr_MatMat(a.CvPtr, b.CvPtr, out var ret));
GC.KeepAlive(a);
GC.KeepAlive(b);
return new MatExpr(ret);
}
public static MatExpr operator |(Mat a, double s)
{
if (a is null)
throw new ArgumentNullException(nameof(a));
a.ThrowIfDisposed();
NativeMethods.HandleException(
NativeMethods.core_Mat_operatorOr_MatDouble(a.CvPtr, s, out var ret));
GC.KeepAlive(a);
return new MatExpr(ret);
}
public static MatExpr operator |(double s, Mat a)
{
if (a is null)
throw new ArgumentNullException(nameof(a));
a.ThrowIfDisposed();
NativeMethods.HandleException(
NativeMethods.core_Mat_operatorOr_DoubleMat(s, a.CvPtr, out var ret));
GC.KeepAlive(a);
return new MatExpr(ret);
}
public MatExpr BitwiseOr(Mat m) => this | m;
public MatExpr BitwiseOr(double s) => this | s;
public static MatExpr operator ^(Mat a, Mat b)
{
if (a is null)
throw new ArgumentNullException(nameof(a));
if (b is null)
throw new ArgumentNullException(nameof(b));
a.ThrowIfDisposed();
b.ThrowIfDisposed();
NativeMethods.HandleException(
NativeMethods.core_Mat_operatorXor_MatMat(a.CvPtr, b.CvPtr, out var ret));
GC.KeepAlive(a);
GC.KeepAlive(b);
return new MatExpr(ret);
}
public static MatExpr operator ^(Mat a, double s)
{
if (a is null)
throw new ArgumentNullException(nameof(a));
a.ThrowIfDisposed();
NativeMethods.HandleException(
NativeMethods.core_Mat_operatorXor_MatDouble(a.CvPtr, s, out var ret));
GC.KeepAlive(a);
return new MatExpr(ret);
}
public static MatExpr operator ^(double s, Mat a)
{
if (a is null)
throw new ArgumentNullException(nameof(a));
a.ThrowIfDisposed();
NativeMethods.HandleException(
NativeMethods.core_Mat_operatorXor_DoubleMat(s, a.CvPtr, out var ret));
GC.KeepAlive(a);
return new MatExpr(ret);
}
public MatExpr Xor(Mat m) => this ^ m;
public MatExpr Xor(double s) => this ^ s;
public static MatExpr operator ~(Mat m)
{
if (m is null)
throw new ArgumentNullException(nameof(m));
m.ThrowIfDisposed();
NativeMethods.HandleException(
NativeMethods.core_Mat_operatorNot(m.CvPtr, out var ret));
GC.KeepAlive(m);
return new MatExpr(ret);
}
public MatExpr OnesComplement() => ~this;
#pragma warning restore 1591
#endregion