opencv 0.82.1

Rust bindings for OpenCV
Documentation
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
pub mod quality {
	use crate::{mod_prelude::*, core, sys, types};
	pub mod prelude {
		pub use { super::QualityBaseTraitConst, super::QualityBaseTrait, super::QualityMSETraitConst, super::QualityMSETrait, super::QualityPSNRTraitConst, super::QualityPSNRTrait, super::QualitySSIMTraitConst, super::QualitySSIMTrait, super::QualityGMSDTraitConst, super::QualityGMSDTrait, super::QualityBRISQUETraitConst, super::QualityBRISQUETrait };
	}
	
	/// Constant methods for [crate::quality::QualityBRISQUE]
	pub trait QualityBRISQUETraitConst: crate::quality::QualityBaseTraitConst {
		fn as_raw_QualityBRISQUE(&self) -> *const c_void;
	
	}
	
	/// Mutable methods for [crate::quality::QualityBRISQUE]
	pub trait QualityBRISQUETrait: crate::quality::QualityBRISQUETraitConst + crate::quality::QualityBaseTrait {
		fn as_raw_mut_QualityBRISQUE(&mut self) -> *mut c_void;
	
		/// Computes BRISQUE quality score for input image
		/// ## Parameters
		/// * img: Image for which to compute quality
		/// ## Returns
		/// cv::Scalar with the score in the first element.  The score ranges from 0 (best quality) to 100 (worst quality)
		#[inline]
		fn compute(&mut self, img: &impl core::ToInputArray) -> Result<core::Scalar> {
			input_array_arg!(img);
			return_send!(via ocvrs_return);
			unsafe { sys::cv_quality_QualityBRISQUE_compute_const__InputArrayR(self.as_raw_mut_QualityBRISQUE(), img.as_raw__InputArray(), ocvrs_return.as_mut_ptr()) };
			return_receive!(unsafe ocvrs_return => ret);
			let ret = ret.into_result()?;
			Ok(ret)
		}
		
	}
	
	/// BRISQUE (Blind/Referenceless Image Spatial Quality Evaluator) is a No Reference Image Quality Assessment (NR-IQA) algorithm.
	/// 
	/// BRISQUE computes a score based on extracting Natural Scene Statistics (<https://en.wikipedia.org/wiki/Scene_statistics>)
	/// and calculating feature vectors. See Mittal et al. [Mittal2](https://docs.opencv.org/4.7.0/d0/de3/citelist.html#CITEREF_Mittal2) for original paper and original implementation [Mittal2_software](https://docs.opencv.org/4.7.0/d0/de3/citelist.html#CITEREF_Mittal2_software) .
	/// 
	/// A trained model is provided in the /samples/ directory and is trained on the LIVE-R2 database [Sheikh](https://docs.opencv.org/4.7.0/d0/de3/citelist.html#CITEREF_Sheikh) as in the original implementation.
	/// When evaluated against the TID2008 database [Ponomarenko](https://docs.opencv.org/4.7.0/d0/de3/citelist.html#CITEREF_Ponomarenko) , the SROCC is -0.8424 versus the SROCC of -0.8354 in the original implementation.
	/// C++ code for the BRISQUE LIVE-R2 trainer and TID2008 evaluator are also provided in the /samples/ directory.
	pub struct QualityBRISQUE {
		ptr: *mut c_void
	}
	
	opencv_type_boxed! { QualityBRISQUE }
	
	impl Drop for QualityBRISQUE {
		#[inline]
		fn drop(&mut self) {
			extern "C" { fn cv_QualityBRISQUE_delete(instance: *mut c_void); }
			unsafe { cv_QualityBRISQUE_delete(self.as_raw_mut_QualityBRISQUE()) };
		}
	}
	
	unsafe impl Send for QualityBRISQUE {}
	
	impl core::AlgorithmTraitConst for QualityBRISQUE {
		#[inline] fn as_raw_Algorithm(&self) -> *const c_void { self.as_raw() }
	}
	
	impl core::AlgorithmTrait for QualityBRISQUE {
		#[inline] fn as_raw_mut_Algorithm(&mut self) -> *mut c_void { self.as_raw_mut() }
	}
	
	impl crate::quality::QualityBaseTraitConst for QualityBRISQUE {
		#[inline] fn as_raw_QualityBase(&self) -> *const c_void { self.as_raw() }
	}
	
	impl crate::quality::QualityBaseTrait for QualityBRISQUE {
		#[inline] fn as_raw_mut_QualityBase(&mut self) -> *mut c_void { self.as_raw_mut() }
	}
	
	impl crate::quality::QualityBRISQUETraitConst for QualityBRISQUE {
		#[inline] fn as_raw_QualityBRISQUE(&self) -> *const c_void { self.as_raw() }
	}
	
	impl crate::quality::QualityBRISQUETrait for QualityBRISQUE {
		#[inline] fn as_raw_mut_QualityBRISQUE(&mut self) -> *mut c_void { self.as_raw_mut() }
	}
	
	impl QualityBRISQUE {
		/// Create an object which calculates quality
		/// ## Parameters
		/// * model_file_path: cv::String which contains a path to the BRISQUE model data, eg. /path/to/brisque_model_live.yml
		/// * range_file_path: cv::String which contains a path to the BRISQUE range data, eg. /path/to/brisque_range_live.yml
		#[inline]
		pub fn create(model_file_path: &str, range_file_path: &str) -> Result<core::Ptr<crate::quality::QualityBRISQUE>> {
			extern_container_arg!(model_file_path);
			extern_container_arg!(range_file_path);
			return_send!(via ocvrs_return);
			unsafe { sys::cv_quality_QualityBRISQUE_create_const_StringR_const_StringR(model_file_path.opencv_as_extern(), range_file_path.opencv_as_extern(), ocvrs_return.as_mut_ptr()) };
			return_receive!(unsafe ocvrs_return => ret);
			let ret = ret.into_result()?;
			let ret = unsafe { core::Ptr::<crate::quality::QualityBRISQUE>::opencv_from_extern(ret) };
			Ok(ret)
		}
		
		/// Create an object which calculates quality
		/// ## Parameters
		/// * model: cv::Ptr<cv::ml::SVM> which contains a loaded BRISQUE model
		/// * range: cv::Mat which contains BRISQUE range data
		#[inline]
		pub fn create_1(model: &core::Ptr<crate::ml::SVM>, range: &core::Mat) -> Result<core::Ptr<crate::quality::QualityBRISQUE>> {
			return_send!(via ocvrs_return);
			unsafe { sys::cv_quality_QualityBRISQUE_create_const_PtrLSVMGR_const_MatR(model.as_raw_PtrOfSVM(), range.as_raw_Mat(), ocvrs_return.as_mut_ptr()) };
			return_receive!(unsafe ocvrs_return => ret);
			let ret = ret.into_result()?;
			let ret = unsafe { core::Ptr::<crate::quality::QualityBRISQUE>::opencv_from_extern(ret) };
			Ok(ret)
		}
		
		/// static method for computing quality
		/// ## Parameters
		/// * img: image for which to compute quality
		/// * model_file_path: cv::String which contains a path to the BRISQUE model data, eg. /path/to/brisque_model_live.yml
		/// * range_file_path: cv::String which contains a path to the BRISQUE range data, eg. /path/to/brisque_range_live.yml
		/// ## Returns
		/// cv::Scalar with the score in the first element.  The score ranges from 0 (best quality) to 100 (worst quality)
		#[inline]
		pub fn compute(img: &impl core::ToInputArray, model_file_path: &str, range_file_path: &str) -> Result<core::Scalar> {
			input_array_arg!(img);
			extern_container_arg!(model_file_path);
			extern_container_arg!(range_file_path);
			return_send!(via ocvrs_return);
			unsafe { sys::cv_quality_QualityBRISQUE_compute_const__InputArrayR_const_StringR_const_StringR(img.as_raw__InputArray(), model_file_path.opencv_as_extern(), range_file_path.opencv_as_extern(), ocvrs_return.as_mut_ptr()) };
			return_receive!(unsafe ocvrs_return => ret);
			let ret = ret.into_result()?;
			Ok(ret)
		}
		
		/// static method for computing image features used by the BRISQUE algorithm
		/// ## Parameters
		/// * img: image (BGR(A) or grayscale) for which to compute features
		/// * features: output row vector of features to cv::Mat or cv::UMat
		#[inline]
		pub fn compute_features(img: &impl core::ToInputArray, features: &mut impl core::ToOutputArray) -> Result<()> {
			input_array_arg!(img);
			output_array_arg!(features);
			return_send!(via ocvrs_return);
			unsafe { sys::cv_quality_QualityBRISQUE_computeFeatures_const__InputArrayR_const__OutputArrayR(img.as_raw__InputArray(), features.as_raw__OutputArray(), ocvrs_return.as_mut_ptr()) };
			return_receive!(unsafe ocvrs_return => ret);
			let ret = ret.into_result()?;
			Ok(ret)
		}
		
	}
	
	boxed_cast_base! { QualityBRISQUE, core::Algorithm, cv_QualityBRISQUE_to_Algorithm }
	
	/// Constant methods for [crate::quality::QualityBase]
	pub trait QualityBaseTraitConst: core::AlgorithmTraitConst {
		fn as_raw_QualityBase(&self) -> *const c_void;
	
		/// Returns output quality map that was generated during computation, if supported by the algorithm
		#[inline]
		fn get_quality_map(&self, dst: &mut impl core::ToOutputArray) -> Result<()> {
			output_array_arg!(dst);
			return_send!(via ocvrs_return);
			unsafe { sys::cv_quality_QualityBase_getQualityMap_const_const__OutputArrayR(self.as_raw_QualityBase(), dst.as_raw__OutputArray(), ocvrs_return.as_mut_ptr()) };
			return_receive!(unsafe ocvrs_return => ret);
			let ret = ret.into_result()?;
			Ok(ret)
		}
		
		/// Implements Algorithm::empty()
		#[inline]
		fn empty(&self) -> Result<bool> {
			return_send!(via ocvrs_return);
			unsafe { sys::cv_quality_QualityBase_empty_const(self.as_raw_QualityBase(), ocvrs_return.as_mut_ptr()) };
			return_receive!(unsafe ocvrs_return => ret);
			let ret = ret.into_result()?;
			Ok(ret)
		}
		
	}
	
	/// Mutable methods for [crate::quality::QualityBase]
	pub trait QualityBaseTrait: core::AlgorithmTrait + crate::quality::QualityBaseTraitConst {
		fn as_raw_mut_QualityBase(&mut self) -> *mut c_void;
	
		/// Compute quality score per channel with the per-channel score in each element of the resulting cv::Scalar.  See specific algorithm for interpreting result scores
		/// ## Parameters
		/// * img: comparison image, or image to evalute for no-reference quality algorithms
		#[inline]
		fn compute(&mut self, img: &impl core::ToInputArray) -> Result<core::Scalar> {
			input_array_arg!(img);
			return_send!(via ocvrs_return);
			unsafe { sys::cv_quality_QualityBase_compute_const__InputArrayR(self.as_raw_mut_QualityBase(), img.as_raw__InputArray(), ocvrs_return.as_mut_ptr()) };
			return_receive!(unsafe ocvrs_return => ret);
			let ret = ret.into_result()?;
			Ok(ret)
		}
		
		/// Implements Algorithm::clear()
		#[inline]
		fn clear(&mut self) -> Result<()> {
			return_send!(via ocvrs_return);
			unsafe { sys::cv_quality_QualityBase_clear(self.as_raw_mut_QualityBase(), ocvrs_return.as_mut_ptr()) };
			return_receive!(unsafe ocvrs_return => ret);
			let ret = ret.into_result()?;
			Ok(ret)
		}
		
	}
	
	/// ********************************* Quality Base Class ***********************************
	pub struct QualityBase {
		ptr: *mut c_void
	}
	
	opencv_type_boxed! { QualityBase }
	
	impl Drop for QualityBase {
		#[inline]
		fn drop(&mut self) {
			extern "C" { fn cv_QualityBase_delete(instance: *mut c_void); }
			unsafe { cv_QualityBase_delete(self.as_raw_mut_QualityBase()) };
		}
	}
	
	unsafe impl Send for QualityBase {}
	
	impl core::AlgorithmTraitConst for QualityBase {
		#[inline] fn as_raw_Algorithm(&self) -> *const c_void { self.as_raw() }
	}
	
	impl core::AlgorithmTrait for QualityBase {
		#[inline] fn as_raw_mut_Algorithm(&mut self) -> *mut c_void { self.as_raw_mut() }
	}
	
	impl crate::quality::QualityBaseTraitConst for QualityBase {
		#[inline] fn as_raw_QualityBase(&self) -> *const c_void { self.as_raw() }
	}
	
	impl crate::quality::QualityBaseTrait for QualityBase {
		#[inline] fn as_raw_mut_QualityBase(&mut self) -> *mut c_void { self.as_raw_mut() }
	}
	
	impl QualityBase {
	}
	
	boxed_cast_descendant! { QualityBase, crate::quality::QualityBRISQUE, cv_QualityBase_to_QualityBRISQUE }
	
	boxed_cast_descendant! { QualityBase, crate::quality::QualityGMSD, cv_QualityBase_to_QualityGMSD }
	
	boxed_cast_descendant! { QualityBase, crate::quality::QualityMSE, cv_QualityBase_to_QualityMSE }
	
	boxed_cast_descendant! { QualityBase, crate::quality::QualityPSNR, cv_QualityBase_to_QualityPSNR }
	
	boxed_cast_descendant! { QualityBase, crate::quality::QualitySSIM, cv_QualityBase_to_QualitySSIM }
	
	boxed_cast_base! { QualityBase, core::Algorithm, cv_QualityBase_to_Algorithm }
	
	/// Constant methods for [crate::quality::QualityGMSD]
	pub trait QualityGMSDTraitConst: crate::quality::QualityBaseTraitConst {
		fn as_raw_QualityGMSD(&self) -> *const c_void;
	
		/// Implements Algorithm::empty()
		#[inline]
		fn empty(&self) -> Result<bool> {
			return_send!(via ocvrs_return);
			unsafe { sys::cv_quality_QualityGMSD_empty_const(self.as_raw_QualityGMSD(), ocvrs_return.as_mut_ptr()) };
			return_receive!(unsafe ocvrs_return => ret);
			let ret = ret.into_result()?;
			Ok(ret)
		}
		
	}
	
	/// Mutable methods for [crate::quality::QualityGMSD]
	pub trait QualityGMSDTrait: crate::quality::QualityBaseTrait + crate::quality::QualityGMSDTraitConst {
		fn as_raw_mut_QualityGMSD(&mut self) -> *mut c_void;
	
		/// Compute GMSD
		/// ## Parameters
		/// * cmp: comparison image
		/// ## Returns
		/// cv::Scalar with per-channel quality value.  Values range from 0 (worst) to 1 (best)
		#[inline]
		fn compute(&mut self, cmp: &impl core::ToInputArray) -> Result<core::Scalar> {
			input_array_arg!(cmp);
			return_send!(via ocvrs_return);
			unsafe { sys::cv_quality_QualityGMSD_compute_const__InputArrayR(self.as_raw_mut_QualityGMSD(), cmp.as_raw__InputArray(), ocvrs_return.as_mut_ptr()) };
			return_receive!(unsafe ocvrs_return => ret);
			let ret = ret.into_result()?;
			Ok(ret)
		}
		
		/// Implements Algorithm::clear()
		#[inline]
		fn clear(&mut self) -> Result<()> {
			return_send!(via ocvrs_return);
			unsafe { sys::cv_quality_QualityGMSD_clear(self.as_raw_mut_QualityGMSD(), ocvrs_return.as_mut_ptr()) };
			return_receive!(unsafe ocvrs_return => ret);
			let ret = ret.into_result()?;
			Ok(ret)
		}
		
	}
	
	/// Full reference GMSD algorithm
	/// <http://www4.comp.polyu.edu.hk/~cslzhang/IQA/GMSD/GMSD.htm>
	pub struct QualityGMSD {
		ptr: *mut c_void
	}
	
	opencv_type_boxed! { QualityGMSD }
	
	impl Drop for QualityGMSD {
		#[inline]
		fn drop(&mut self) {
			extern "C" { fn cv_QualityGMSD_delete(instance: *mut c_void); }
			unsafe { cv_QualityGMSD_delete(self.as_raw_mut_QualityGMSD()) };
		}
	}
	
	unsafe impl Send for QualityGMSD {}
	
	impl core::AlgorithmTraitConst for QualityGMSD {
		#[inline] fn as_raw_Algorithm(&self) -> *const c_void { self.as_raw() }
	}
	
	impl core::AlgorithmTrait for QualityGMSD {
		#[inline] fn as_raw_mut_Algorithm(&mut self) -> *mut c_void { self.as_raw_mut() }
	}
	
	impl crate::quality::QualityBaseTraitConst for QualityGMSD {
		#[inline] fn as_raw_QualityBase(&self) -> *const c_void { self.as_raw() }
	}
	
	impl crate::quality::QualityBaseTrait for QualityGMSD {
		#[inline] fn as_raw_mut_QualityBase(&mut self) -> *mut c_void { self.as_raw_mut() }
	}
	
	impl crate::quality::QualityGMSDTraitConst for QualityGMSD {
		#[inline] fn as_raw_QualityGMSD(&self) -> *const c_void { self.as_raw() }
	}
	
	impl crate::quality::QualityGMSDTrait for QualityGMSD {
		#[inline] fn as_raw_mut_QualityGMSD(&mut self) -> *mut c_void { self.as_raw_mut() }
	}
	
	impl QualityGMSD {
		/// Create an object which calculates image quality
		/// ## Parameters
		/// * ref: reference image
		#[inline]
		pub fn create(ref_: &impl core::ToInputArray) -> Result<core::Ptr<crate::quality::QualityGMSD>> {
			input_array_arg!(ref_);
			return_send!(via ocvrs_return);
			unsafe { sys::cv_quality_QualityGMSD_create_const__InputArrayR(ref_.as_raw__InputArray(), ocvrs_return.as_mut_ptr()) };
			return_receive!(unsafe ocvrs_return => ret);
			let ret = ret.into_result()?;
			let ret = unsafe { core::Ptr::<crate::quality::QualityGMSD>::opencv_from_extern(ret) };
			Ok(ret)
		}
		
		/// static method for computing quality
		/// ## Parameters
		/// * ref: reference image
		/// * cmp: comparison image
		/// * qualityMap: output quality map, or cv::noArray()
		/// ## Returns
		/// cv::Scalar with per-channel quality value.  Values range from 0 (worst) to 1 (best)
		#[inline]
		pub fn compute(ref_: &impl core::ToInputArray, cmp: &impl core::ToInputArray, quality_map: &mut impl core::ToOutputArray) -> Result<core::Scalar> {
			input_array_arg!(ref_);
			input_array_arg!(cmp);
			output_array_arg!(quality_map);
			return_send!(via ocvrs_return);
			unsafe { sys::cv_quality_QualityGMSD_compute_const__InputArrayR_const__InputArrayR_const__OutputArrayR(ref_.as_raw__InputArray(), cmp.as_raw__InputArray(), quality_map.as_raw__OutputArray(), ocvrs_return.as_mut_ptr()) };
			return_receive!(unsafe ocvrs_return => ret);
			let ret = ret.into_result()?;
			Ok(ret)
		}
		
	}
	
	boxed_cast_base! { QualityGMSD, core::Algorithm, cv_QualityGMSD_to_Algorithm }
	
	/// Constant methods for [crate::quality::QualityMSE]
	pub trait QualityMSETraitConst: crate::quality::QualityBaseTraitConst {
		fn as_raw_QualityMSE(&self) -> *const c_void;
	
		/// Implements Algorithm::empty()
		#[inline]
		fn empty(&self) -> Result<bool> {
			return_send!(via ocvrs_return);
			unsafe { sys::cv_quality_QualityMSE_empty_const(self.as_raw_QualityMSE(), ocvrs_return.as_mut_ptr()) };
			return_receive!(unsafe ocvrs_return => ret);
			let ret = ret.into_result()?;
			Ok(ret)
		}
		
	}
	
	/// Mutable methods for [crate::quality::QualityMSE]
	pub trait QualityMSETrait: crate::quality::QualityBaseTrait + crate::quality::QualityMSETraitConst {
		fn as_raw_mut_QualityMSE(&mut self) -> *mut c_void;
	
		/// Computes MSE for reference images supplied in class constructor and provided comparison images
		/// ## Parameters
		/// * cmpImgs: Comparison image(s)
		/// ## Returns
		/// cv::Scalar with per-channel quality values.  Values range from 0 (best) to potentially max float (worst)
		#[inline]
		fn compute(&mut self, cmp_imgs: &impl core::ToInputArray) -> Result<core::Scalar> {
			input_array_arg!(cmp_imgs);
			return_send!(via ocvrs_return);
			unsafe { sys::cv_quality_QualityMSE_compute_const__InputArrayR(self.as_raw_mut_QualityMSE(), cmp_imgs.as_raw__InputArray(), ocvrs_return.as_mut_ptr()) };
			return_receive!(unsafe ocvrs_return => ret);
			let ret = ret.into_result()?;
			Ok(ret)
		}
		
		/// Implements Algorithm::clear()
		#[inline]
		fn clear(&mut self) -> Result<()> {
			return_send!(via ocvrs_return);
			unsafe { sys::cv_quality_QualityMSE_clear(self.as_raw_mut_QualityMSE(), ocvrs_return.as_mut_ptr()) };
			return_receive!(unsafe ocvrs_return => ret);
			let ret = ret.into_result()?;
			Ok(ret)
		}
		
	}
	
	/// Full reference mean square error algorithm  <https://en.wikipedia.org/wiki/Mean_squared_error>
	pub struct QualityMSE {
		ptr: *mut c_void
	}
	
	opencv_type_boxed! { QualityMSE }
	
	impl Drop for QualityMSE {
		#[inline]
		fn drop(&mut self) {
			extern "C" { fn cv_QualityMSE_delete(instance: *mut c_void); }
			unsafe { cv_QualityMSE_delete(self.as_raw_mut_QualityMSE()) };
		}
	}
	
	unsafe impl Send for QualityMSE {}
	
	impl core::AlgorithmTraitConst for QualityMSE {
		#[inline] fn as_raw_Algorithm(&self) -> *const c_void { self.as_raw() }
	}
	
	impl core::AlgorithmTrait for QualityMSE {
		#[inline] fn as_raw_mut_Algorithm(&mut self) -> *mut c_void { self.as_raw_mut() }
	}
	
	impl crate::quality::QualityBaseTraitConst for QualityMSE {
		#[inline] fn as_raw_QualityBase(&self) -> *const c_void { self.as_raw() }
	}
	
	impl crate::quality::QualityBaseTrait for QualityMSE {
		#[inline] fn as_raw_mut_QualityBase(&mut self) -> *mut c_void { self.as_raw_mut() }
	}
	
	impl crate::quality::QualityMSETraitConst for QualityMSE {
		#[inline] fn as_raw_QualityMSE(&self) -> *const c_void { self.as_raw() }
	}
	
	impl crate::quality::QualityMSETrait for QualityMSE {
		#[inline] fn as_raw_mut_QualityMSE(&mut self) -> *mut c_void { self.as_raw_mut() }
	}
	
	impl QualityMSE {
		/// Create an object which calculates quality
		/// ## Parameters
		/// * ref: input image to use as the reference for comparison
		#[inline]
		pub fn create(ref_: &impl core::ToInputArray) -> Result<core::Ptr<crate::quality::QualityMSE>> {
			input_array_arg!(ref_);
			return_send!(via ocvrs_return);
			unsafe { sys::cv_quality_QualityMSE_create_const__InputArrayR(ref_.as_raw__InputArray(), ocvrs_return.as_mut_ptr()) };
			return_receive!(unsafe ocvrs_return => ret);
			let ret = ret.into_result()?;
			let ret = unsafe { core::Ptr::<crate::quality::QualityMSE>::opencv_from_extern(ret) };
			Ok(ret)
		}
		
		/// static method for computing quality
		/// ## Parameters
		/// * ref: reference image
		/// * cmp: comparison image=
		/// * qualityMap: output quality map, or cv::noArray()
		/// ## Returns
		/// cv::Scalar with per-channel quality values.  Values range from 0 (best) to max float (worst)
		#[inline]
		pub fn compute(ref_: &impl core::ToInputArray, cmp: &impl core::ToInputArray, quality_map: &mut impl core::ToOutputArray) -> Result<core::Scalar> {
			input_array_arg!(ref_);
			input_array_arg!(cmp);
			output_array_arg!(quality_map);
			return_send!(via ocvrs_return);
			unsafe { sys::cv_quality_QualityMSE_compute_const__InputArrayR_const__InputArrayR_const__OutputArrayR(ref_.as_raw__InputArray(), cmp.as_raw__InputArray(), quality_map.as_raw__OutputArray(), ocvrs_return.as_mut_ptr()) };
			return_receive!(unsafe ocvrs_return => ret);
			let ret = ret.into_result()?;
			Ok(ret)
		}
		
	}
	
	boxed_cast_base! { QualityMSE, core::Algorithm, cv_QualityMSE_to_Algorithm }
	
	/// Constant methods for [crate::quality::QualityPSNR]
	pub trait QualityPSNRTraitConst: crate::quality::QualityBaseTraitConst {
		fn as_raw_QualityPSNR(&self) -> *const c_void;
	
		/// Implements Algorithm::empty()
		#[inline]
		fn empty(&self) -> Result<bool> {
			return_send!(via ocvrs_return);
			unsafe { sys::cv_quality_QualityPSNR_empty_const(self.as_raw_QualityPSNR(), ocvrs_return.as_mut_ptr()) };
			return_receive!(unsafe ocvrs_return => ret);
			let ret = ret.into_result()?;
			Ok(ret)
		}
		
		/// return the maximum pixel value used for PSNR computation
		#[inline]
		fn get_max_pixel_value(&self) -> Result<f64> {
			return_send!(via ocvrs_return);
			unsafe { sys::cv_quality_QualityPSNR_getMaxPixelValue_const(self.as_raw_QualityPSNR(), ocvrs_return.as_mut_ptr()) };
			return_receive!(unsafe ocvrs_return => ret);
			let ret = ret.into_result()?;
			Ok(ret)
		}
		
	}
	
	/// Mutable methods for [crate::quality::QualityPSNR]
	pub trait QualityPSNRTrait: crate::quality::QualityBaseTrait + crate::quality::QualityPSNRTraitConst {
		fn as_raw_mut_QualityPSNR(&mut self) -> *mut c_void;
	
		/// Compute the PSNR
		/// ## Parameters
		/// * cmp: Comparison image
		/// ## Returns
		/// Per-channel PSNR value, or std::numeric_limits<double>::infinity() if the MSE between the two images == 0
		#[inline]
		fn compute(&mut self, cmp: &impl core::ToInputArray) -> Result<core::Scalar> {
			input_array_arg!(cmp);
			return_send!(via ocvrs_return);
			unsafe { sys::cv_quality_QualityPSNR_compute_const__InputArrayR(self.as_raw_mut_QualityPSNR(), cmp.as_raw__InputArray(), ocvrs_return.as_mut_ptr()) };
			return_receive!(unsafe ocvrs_return => ret);
			let ret = ret.into_result()?;
			Ok(ret)
		}
		
		/// Implements Algorithm::clear()
		#[inline]
		fn clear(&mut self) -> Result<()> {
			return_send!(via ocvrs_return);
			unsafe { sys::cv_quality_QualityPSNR_clear(self.as_raw_mut_QualityPSNR(), ocvrs_return.as_mut_ptr()) };
			return_receive!(unsafe ocvrs_return => ret);
			let ret = ret.into_result()?;
			Ok(ret)
		}
		
		/// sets the maximum pixel value used for PSNR computation
		/// ## Parameters
		/// * val: Maximum pixel value
		#[inline]
		fn set_max_pixel_value(&mut self, val: f64) -> Result<()> {
			return_send!(via ocvrs_return);
			unsafe { sys::cv_quality_QualityPSNR_setMaxPixelValue_double(self.as_raw_mut_QualityPSNR(), val, ocvrs_return.as_mut_ptr()) };
			return_receive!(unsafe ocvrs_return => ret);
			let ret = ret.into_result()?;
			Ok(ret)
		}
		
	}
	
	/// Full reference peak signal to noise ratio (PSNR) algorithm  <https://en.wikipedia.org/wiki/Peak_signal-to-noise_ratio>
	pub struct QualityPSNR {
		ptr: *mut c_void
	}
	
	opencv_type_boxed! { QualityPSNR }
	
	impl Drop for QualityPSNR {
		#[inline]
		fn drop(&mut self) {
			extern "C" { fn cv_QualityPSNR_delete(instance: *mut c_void); }
			unsafe { cv_QualityPSNR_delete(self.as_raw_mut_QualityPSNR()) };
		}
	}
	
	unsafe impl Send for QualityPSNR {}
	
	impl core::AlgorithmTraitConst for QualityPSNR {
		#[inline] fn as_raw_Algorithm(&self) -> *const c_void { self.as_raw() }
	}
	
	impl core::AlgorithmTrait for QualityPSNR {
		#[inline] fn as_raw_mut_Algorithm(&mut self) -> *mut c_void { self.as_raw_mut() }
	}
	
	impl crate::quality::QualityBaseTraitConst for QualityPSNR {
		#[inline] fn as_raw_QualityBase(&self) -> *const c_void { self.as_raw() }
	}
	
	impl crate::quality::QualityBaseTrait for QualityPSNR {
		#[inline] fn as_raw_mut_QualityBase(&mut self) -> *mut c_void { self.as_raw_mut() }
	}
	
	impl crate::quality::QualityPSNRTraitConst for QualityPSNR {
		#[inline] fn as_raw_QualityPSNR(&self) -> *const c_void { self.as_raw() }
	}
	
	impl crate::quality::QualityPSNRTrait for QualityPSNR {
		#[inline] fn as_raw_mut_QualityPSNR(&mut self) -> *mut c_void { self.as_raw_mut() }
	}
	
	impl QualityPSNR {
		pub const MAX_PIXEL_VALUE_DEFAULT: f64 = 255.;
		/// Create an object which calculates quality
		/// ## Parameters
		/// * ref: input image to use as the source for comparison
		/// * maxPixelValue: maximum per-channel value for any individual pixel; eg 255 for uint8 image
		/// 
		/// ## C++ default parameters
		/// * max_pixel_value: QualityPSNR::MAX_PIXEL_VALUE_DEFAULT
		#[inline]
		pub fn create(ref_: &impl core::ToInputArray, max_pixel_value: f64) -> Result<core::Ptr<crate::quality::QualityPSNR>> {
			input_array_arg!(ref_);
			return_send!(via ocvrs_return);
			unsafe { sys::cv_quality_QualityPSNR_create_const__InputArrayR_double(ref_.as_raw__InputArray(), max_pixel_value, ocvrs_return.as_mut_ptr()) };
			return_receive!(unsafe ocvrs_return => ret);
			let ret = ret.into_result()?;
			let ret = unsafe { core::Ptr::<crate::quality::QualityPSNR>::opencv_from_extern(ret) };
			Ok(ret)
		}
		
		/// static method for computing quality
		/// ## Parameters
		/// * ref: reference image
		/// * cmp: comparison image
		/// * qualityMap: output quality map, or cv::noArray()
		/// * maxPixelValue: maximum per-channel value for any individual pixel; eg 255 for uint8 image
		/// ## Returns
		/// PSNR value, or std::numeric_limits<double>::infinity() if the MSE between the two images == 0
		/// 
		/// ## C++ default parameters
		/// * max_pixel_value: QualityPSNR::MAX_PIXEL_VALUE_DEFAULT
		#[inline]
		pub fn compute(ref_: &impl core::ToInputArray, cmp: &impl core::ToInputArray, quality_map: &mut impl core::ToOutputArray, max_pixel_value: f64) -> Result<core::Scalar> {
			input_array_arg!(ref_);
			input_array_arg!(cmp);
			output_array_arg!(quality_map);
			return_send!(via ocvrs_return);
			unsafe { sys::cv_quality_QualityPSNR_compute_const__InputArrayR_const__InputArrayR_const__OutputArrayR_double(ref_.as_raw__InputArray(), cmp.as_raw__InputArray(), quality_map.as_raw__OutputArray(), max_pixel_value, ocvrs_return.as_mut_ptr()) };
			return_receive!(unsafe ocvrs_return => ret);
			let ret = ret.into_result()?;
			Ok(ret)
		}
		
	}
	
	boxed_cast_base! { QualityPSNR, core::Algorithm, cv_QualityPSNR_to_Algorithm }
	
	/// Constant methods for [crate::quality::QualitySSIM]
	pub trait QualitySSIMTraitConst: crate::quality::QualityBaseTraitConst {
		fn as_raw_QualitySSIM(&self) -> *const c_void;
	
		/// Implements Algorithm::empty()
		#[inline]
		fn empty(&self) -> Result<bool> {
			return_send!(via ocvrs_return);
			unsafe { sys::cv_quality_QualitySSIM_empty_const(self.as_raw_QualitySSIM(), ocvrs_return.as_mut_ptr()) };
			return_receive!(unsafe ocvrs_return => ret);
			let ret = ret.into_result()?;
			Ok(ret)
		}
		
	}
	
	/// Mutable methods for [crate::quality::QualitySSIM]
	pub trait QualitySSIMTrait: crate::quality::QualityBaseTrait + crate::quality::QualitySSIMTraitConst {
		fn as_raw_mut_QualitySSIM(&mut self) -> *mut c_void;
	
		/// Computes SSIM
		/// ## Parameters
		/// * cmp: Comparison image
		/// ## Returns
		/// cv::Scalar with per-channel quality values.  Values range from 0 (worst) to 1 (best)
		#[inline]
		fn compute(&mut self, cmp: &impl core::ToInputArray) -> Result<core::Scalar> {
			input_array_arg!(cmp);
			return_send!(via ocvrs_return);
			unsafe { sys::cv_quality_QualitySSIM_compute_const__InputArrayR(self.as_raw_mut_QualitySSIM(), cmp.as_raw__InputArray(), ocvrs_return.as_mut_ptr()) };
			return_receive!(unsafe ocvrs_return => ret);
			let ret = ret.into_result()?;
			Ok(ret)
		}
		
		/// Implements Algorithm::clear()
		#[inline]
		fn clear(&mut self) -> Result<()> {
			return_send!(via ocvrs_return);
			unsafe { sys::cv_quality_QualitySSIM_clear(self.as_raw_mut_QualitySSIM(), ocvrs_return.as_mut_ptr()) };
			return_receive!(unsafe ocvrs_return => ret);
			let ret = ret.into_result()?;
			Ok(ret)
		}
		
	}
	
	/// Full reference structural similarity algorithm  <https://en.wikipedia.org/wiki/Structural_similarity>
	pub struct QualitySSIM {
		ptr: *mut c_void
	}
	
	opencv_type_boxed! { QualitySSIM }
	
	impl Drop for QualitySSIM {
		#[inline]
		fn drop(&mut self) {
			extern "C" { fn cv_QualitySSIM_delete(instance: *mut c_void); }
			unsafe { cv_QualitySSIM_delete(self.as_raw_mut_QualitySSIM()) };
		}
	}
	
	unsafe impl Send for QualitySSIM {}
	
	impl core::AlgorithmTraitConst for QualitySSIM {
		#[inline] fn as_raw_Algorithm(&self) -> *const c_void { self.as_raw() }
	}
	
	impl core::AlgorithmTrait for QualitySSIM {
		#[inline] fn as_raw_mut_Algorithm(&mut self) -> *mut c_void { self.as_raw_mut() }
	}
	
	impl crate::quality::QualityBaseTraitConst for QualitySSIM {
		#[inline] fn as_raw_QualityBase(&self) -> *const c_void { self.as_raw() }
	}
	
	impl crate::quality::QualityBaseTrait for QualitySSIM {
		#[inline] fn as_raw_mut_QualityBase(&mut self) -> *mut c_void { self.as_raw_mut() }
	}
	
	impl crate::quality::QualitySSIMTraitConst for QualitySSIM {
		#[inline] fn as_raw_QualitySSIM(&self) -> *const c_void { self.as_raw() }
	}
	
	impl crate::quality::QualitySSIMTrait for QualitySSIM {
		#[inline] fn as_raw_mut_QualitySSIM(&mut self) -> *mut c_void { self.as_raw_mut() }
	}
	
	impl QualitySSIM {
		/// Create an object which calculates quality
		/// ## Parameters
		/// * ref: input image to use as the reference image for comparison
		#[inline]
		pub fn create(ref_: &impl core::ToInputArray) -> Result<core::Ptr<crate::quality::QualitySSIM>> {
			input_array_arg!(ref_);
			return_send!(via ocvrs_return);
			unsafe { sys::cv_quality_QualitySSIM_create_const__InputArrayR(ref_.as_raw__InputArray(), ocvrs_return.as_mut_ptr()) };
			return_receive!(unsafe ocvrs_return => ret);
			let ret = ret.into_result()?;
			let ret = unsafe { core::Ptr::<crate::quality::QualitySSIM>::opencv_from_extern(ret) };
			Ok(ret)
		}
		
		/// static method for computing quality
		/// ## Parameters
		/// * ref: reference image
		/// * cmp: comparison image
		/// * qualityMap: output quality map, or cv::noArray()
		/// ## Returns
		/// cv::Scalar with per-channel quality values.  Values range from 0 (worst) to 1 (best)
		#[inline]
		pub fn compute(ref_: &impl core::ToInputArray, cmp: &impl core::ToInputArray, quality_map: &mut impl core::ToOutputArray) -> Result<core::Scalar> {
			input_array_arg!(ref_);
			input_array_arg!(cmp);
			output_array_arg!(quality_map);
			return_send!(via ocvrs_return);
			unsafe { sys::cv_quality_QualitySSIM_compute_const__InputArrayR_const__InputArrayR_const__OutputArrayR(ref_.as_raw__InputArray(), cmp.as_raw__InputArray(), quality_map.as_raw__OutputArray(), ocvrs_return.as_mut_ptr()) };
			return_receive!(unsafe ocvrs_return => ret);
			let ret = ret.into_result()?;
			Ok(ret)
		}
		
	}
	
	boxed_cast_base! { QualitySSIM, core::Algorithm, cv_QualitySSIM_to_Algorithm }
}