OpenCV  4.1.2-dev
Open Source Computer Vision
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
cv::quality::QualityMSE Class Reference

Full reference mean square error algorithm https://en.wikipedia.org/wiki/Mean_squared_error. More...

#include <opencv2/quality/qualitymse.hpp>

Inheritance diagram for cv::quality::QualityMSE:
cv::quality::QualityBase cv::Algorithm

Public Member Functions

void clear () CV_OVERRIDE
 Implements Algorithm::clear() More...
 
cv::Scalar compute (InputArrayOfArrays cmpImgs) CV_OVERRIDE
 Computes MSE for reference images supplied in class constructor and provided comparison images. More...
 
bool empty () const CV_OVERRIDE
 Implements Algorithm::empty() More...
 
- Public Member Functions inherited from cv::quality::QualityBase
virtual ~QualityBase ()=default
 Destructor. More...
 
virtual void getQualityMap (OutputArray dst) const
 Returns output quality map that was generated during computation, if supported by the algorithm. More...
 
- Public Member Functions inherited from cv::Algorithm
 Algorithm ()
 
virtual ~Algorithm ()
 
virtual String getDefaultName () const
 
virtual void read (const FileNode &fn)
 Reads algorithm parameters from a file storage. More...
 
virtual void save (const String &filename) const
 
virtual void write (FileStorage &fs) const
 Stores algorithm parameters in a file storage. More...
 
void write (const Ptr< FileStorage > &fs, const String &name=String()) const
 simplified API for language bindings This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
 

Static Public Member Functions

static cv::Scalar compute (InputArray ref, InputArray cmp, OutputArray qualityMap)
 static method for computing quality More...
 
static Ptr< QualityMSEcreate (InputArray ref)
 Create an object which calculates quality. More...
 
- Static Public Member Functions inherited from cv::Algorithm
template<typename _Tp >
static Ptr< _Tp > load (const String &filename, const String &objname=String())
 Loads algorithm from the file. More...
 
template<typename _Tp >
static Ptr< _Tp > loadFromString (const String &strModel, const String &objname=String())
 Loads algorithm from a String. More...
 
template<typename _Tp >
static Ptr< _Tp > read (const FileNode &fn)
 Reads algorithm from the file node. More...
 

Protected Member Functions

 QualityMSE (QualityBase::_mat_type ref)
 Constructor. More...
 
- Protected Member Functions inherited from cv::Algorithm
void writeFormat (FileStorage &fs) const
 

Protected Attributes

QualityBase::_mat_type _ref
 Reference image, converted to internal mat type. More...
 
- Protected Attributes inherited from cv::quality::QualityBase
_mat_type _qualityMap
 Output quality maps if generated by algorithm. More...
 

Additional Inherited Members

- Protected Types inherited from cv::quality::QualityBase
using _mat_type = cv::UMat
 internal mat type default More...
 

Detailed Description

Full reference mean square error algorithm https://en.wikipedia.org/wiki/Mean_squared_error.

Constructor & Destructor Documentation

◆ QualityMSE()

cv::quality::QualityMSE::QualityMSE ( QualityBase::_mat_type  ref)
inlineprotected

Constructor.

Parameters
refreference image, converted to internal type

Member Function Documentation

◆ clear()

void cv::quality::QualityMSE::clear ( )
inlinevirtual
Python:
None=cv.quality_QualityMSE.clear()

Implements Algorithm::clear()

Reimplemented from cv::quality::QualityBase.

◆ compute() [1/2]

cv::Scalar cv::quality::QualityMSE::compute ( InputArrayOfArrays  cmpImgs)
virtual
Python:
retval=cv.quality_QualityMSE.compute(cmpImgs)
retval, qualityMap=cv.quality_QualityMSE.compute(ref, cmp[, qualityMap])
retval, qualityMap=cv.quality.QualityMSE_compute(ref, cmp[, qualityMap])

Computes MSE for reference images supplied in class constructor and provided comparison images.

Parameters
cmpImgsComparison image(s)
Returns
cv::Scalar with per-channel quality values. Values range from 0 (best) to potentially max float (worst)

Implements cv::quality::QualityBase.

◆ compute() [2/2]

static cv::Scalar cv::quality::QualityMSE::compute ( InputArray  ref,
InputArray  cmp,
OutputArray  qualityMap 
)
static
Python:
retval=cv.quality_QualityMSE.compute(cmpImgs)
retval, qualityMap=cv.quality_QualityMSE.compute(ref, cmp[, qualityMap])
retval, qualityMap=cv.quality.QualityMSE_compute(ref, cmp[, qualityMap])

static method for computing quality

Parameters
refreference image
cmpcomparison image=
qualityMapoutput quality map, or cv::noArray()
Returns
cv::Scalar with per-channel quality values. Values range from 0 (best) to max float (worst)

◆ create()

static Ptr<QualityMSE> cv::quality::QualityMSE::create ( InputArray  ref)
static
Python:
retval=cv.quality.QualityMSE_create(ref)

Create an object which calculates quality.

Parameters
refinput image to use as the reference for comparison

◆ empty()

bool cv::quality::QualityMSE::empty ( ) const
inlinevirtual
Python:
retval=cv.quality_QualityMSE.empty()

Implements Algorithm::empty()

Reimplemented from cv::quality::QualityBase.

Member Data Documentation

◆ _ref

QualityBase::_mat_type cv::quality::QualityMSE::_ref
protected

Reference image, converted to internal mat type.


The documentation for this class was generated from the following file: