cv::quality::QualitySSIM Class Reference

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

#include <opencv2/quality/qualityssim.hpp>

Inheritance diagram for cv::quality::QualitySSIM:

Classes
struct	_mat_data

Public Member Functions
void	clear () CV_OVERRIDE
	Implements Algorithm::clear() More...
cv::Scalar	compute (InputArrayOfArrays cmpImgs) CV_OVERRIDE
	Computes SSIM. 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	getQualityMaps (OutputArrayOfArrays dst) const
	Returns output quality map images that were 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 (InputArrayOfArrays refImgs, InputArrayOfArrays cmpImgs, OutputArrayOfArrays qualityMaps)
	static method for computing quality More...
static Ptr< QualitySSIM >	create (InputArrayOfArrays refImgs)
	Create an object which calculates quality via mean square error. 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
	QualitySSIM (std::vector< _mat_data > refImgData)
	Constructor. More...
Protected Member Functions inherited from cv::Algorithm
void	writeFormat (FileStorage &fs) const

Protected Attributes
std::vector< _mat_data >	_refImgData
	Reference image data. More...
Protected Attributes inherited from cv::quality::QualityBase
std::vector< _quality_map_type >	_qualityMaps
	Output quality maps if generated by algorithm. More...

Additional Inherited Members
Protected Types inherited from cv::quality::QualityBase
using	_quality_map_type = cv::UMat
	internal quality map type default More...

Detailed Description

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

Constructor & Destructor Documentation

QualitySSIM()

cv::quality::QualitySSIM::QualitySSIM ( std::vector< _mat_data >  refImgData )

inlineprotected

Constructor.

Parameters

refImgData

vector of reference images, converted to internal type

Member Function Documentation

clear()

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

inlinevirtual

Python:
	None	=	cv.quality_QualitySSIM.clear(		)

Implements Algorithm::clear()

Reimplemented from cv::quality::QualityBase.

compute() [1/2]

cv::Scalar cv::quality::QualitySSIM::compute ( InputArrayOfArrays  cmpImgs )

virtual

Python:
	retval	=	cv.quality_QualitySSIM.compute(	cmpImgs	)
	retval, qualityMaps	=	cv.quality_QualitySSIM.compute(	refImgs, cmpImgs[, qualityMaps]	)
	retval, qualityMaps	=	cv.quality.QualitySSIM_compute(	refImgs, cmpImgs[, qualityMaps]	)

Computes SSIM.

Parameters

cmpImgs

Comparison images

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 ( InputArrayOfArrays  refImgs, InputArrayOfArrays  cmpImgs, OutputArrayOfArrays  qualityMaps  )

static

Python:
	retval	=	cv.quality_QualitySSIM.compute(	cmpImgs	)
	retval, qualityMaps	=	cv.quality_QualitySSIM.compute(	refImgs, cmpImgs[, qualityMaps]	)
	retval, qualityMaps	=	cv.quality.QualitySSIM_compute(	refImgs, cmpImgs[, qualityMaps]	)

static method for computing quality

Parameters

refImgs	reference image(s)
cmpImgs	comparison image(s)
qualityMaps	output quality map(s), 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 ( InputArrayOfArrays  refImgs )

static

Python:
	retval	=	cv.quality.QualitySSIM_create(	refImgs	)

Create an object which calculates quality via mean square error.

Parameters

refImgs

input image(s) to use as the source for comparison

empty()

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

inlinevirtual

Python:
	retval	=	cv.quality_QualitySSIM.empty(		)

Implements Algorithm::empty()

Reimplemented from cv::quality::QualityBase.

Member Data Documentation

_refImgData

std::vector<_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