cv::quality::QualitySSIM Class Reference

Full reference structural similarity algorithm https://en.wikipedia.org/wiki/Structural_similarity. More...

#include <opencv2/quality/qualityssim.hpp>

Collaboration diagram for cv::quality::QualitySSIM:

Classes
struct	_mat_data

Public Member Functions
void	clear () CV_OVERRIDE
	Implements Algorithm::clear()
cv::Scalar	compute (InputArray cmp) CV_OVERRIDE
	Computes SSIM.
bool	empty () const CV_OVERRIDE
	Implements Algorithm::empty()
Public Member Functions inherited from cv::quality::QualityBase
virtual	~QualityBase ()=default
	Destructor.
virtual void	getQualityMap (OutputArray dst) const
	Returns output quality map that was generated during computation, if supported by the algorithm
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.
virtual void	save (const String &filename) const
void	write (const Ptr< FileStorage > &fs, const String &name=String()) const
virtual void	write (FileStorage &fs) const
	Stores algorithm parameters in a file storage.
void	write (FileStorage &fs, const String &name) const

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

Protected Member Functions
	QualitySSIM (_mat_data refImgData)
	Constructor.
Protected Member Functions inherited from cv::Algorithm
void	writeFormat (FileStorage &fs) const

Protected Attributes
_mat_data	_refImgData
	Reference image data.
Protected Attributes inherited from cv::quality::QualityBase
_mat_type	_qualityMap
	Output quality maps if generated by algorithm.

Additional Inherited Members
Protected Types inherited from cv::quality::QualityBase
using	_mat_type = cv::UMat
	internal mat type default

Detailed Description

Full reference structural similarity algorithm https://en.wikipedia.org/wiki/Structural_similarity.

Constructor & Destructor Documentation

QualitySSIM()

cv::quality::QualitySSIM::QualitySSIM ( _mat_data refImgData )

inlineprotected

Constructor.

Parameters

refImgData

reference image, converted to internal type

Member Function Documentation

clear()

void cv::quality::QualitySSIM::clear ( )

inlinevirtual

Python:
	cv.quality.QualitySSIM.clear(		) ->	None

Implements Algorithm::clear()

Reimplemented from cv::quality::QualityBase.

compute() [1/2]

cv::Scalar cv::quality::QualitySSIM::compute ( InputArray cmp )

virtual

Python:
	cv.quality.QualitySSIM.compute(	cmp	) ->	retval
	cv.quality.QualitySSIM.compute(	ref, cmp[, qualityMap]	) ->	retval, qualityMap
	cv.quality.QualitySSIM_compute(	ref, cmp[, qualityMap]	) ->	retval, qualityMap

Computes SSIM.

Parameters

cmp	Comparison image

Returns

cv::Scalar with per-channel quality values. Values range from 0 (worst) to 1 (best)

Implements cv::quality::QualityBase.

compute() [2/2]

static cv::Scalar cv::quality::QualitySSIM::compute ( InputArray ref, InputArray cmp, OutputArray qualityMap )

static

Python:
	cv.quality.QualitySSIM.compute(	cmp	) ->	retval
	cv.quality.QualitySSIM.compute(	ref, cmp[, qualityMap]	) ->	retval, qualityMap
	cv.quality.QualitySSIM_compute(	ref, cmp[, qualityMap]	) ->	retval, qualityMap

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)

create()

static Ptr< QualitySSIM > cv::quality::QualitySSIM::create ( InputArray ref )

static

Python:
	cv.quality.QualitySSIM.create(	ref	) ->	retval
	cv.quality.QualitySSIM_create(	ref	) ->	retval

Create an object which calculates quality.

Parameters

ref	input image to use as the reference image for comparison

empty()

bool cv::quality::QualitySSIM::empty ( ) const

inlinevirtual

Python:
	cv.quality.QualitySSIM.empty(		) ->	retval

Implements Algorithm::empty()

Reimplemented from cv::quality::QualityBase.

Member Data Documentation

_refImgData

_mat_data cv::quality::QualitySSIM::_refImgData

protected

Reference image data.

---

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

• opencv2/quality/qualityssim.hpp