org.bytedeco.opencv.opencv_quality

Class QualitySSIM

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.opencv.opencv_core.Algorithm

org.bytedeco.opencv.opencv_quality.QualityBase

org.bytedeco.opencv.opencv_quality.QualitySSIM

All Implemented Interfaces:

AutoCloseable

@Namespace(value="cv::quality")
 @NoOffset
 @Properties(inherit=opencv_quality.class)
public class QualitySSIM
extends QualityBase

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

Nested Class Summary

Nested classes/interfaces inherited from class org.bytedeco.javacpp.Pointer

Pointer.CustomDeallocator, Pointer.Deallocator, Pointer.NativeDeallocator, Pointer.ReferenceCounter

Field Summary

Fields inherited from class org.bytedeco.javacpp.Pointer

address, capacity, limit, position

Constructor Summary

Constructors

Constructor and Description
QualitySSIM(Algorithm pointer) Downcast constructor.
QualitySSIM(Pointer p) Pointer cast constructor.

Method Summary

Modifier and Type	Method and Description
void	clear() \brief Implements Algorithm::clear()
Scalar	compute(GpuMat cmp)
static Scalar	compute(GpuMat ref, GpuMat cmp, GpuMat qualityMap)
Scalar	compute(Mat cmp) \brief Computes SSIM
static Scalar	compute(Mat ref, Mat cmp, Mat qualityMap) \brief static method for computing quality
Scalar	compute(UMat cmp)
static Scalar	compute(UMat ref, UMat cmp, UMat qualityMap)
static QualitySSIM	create(GpuMat ref)
static QualitySSIM	create(Mat ref) \brief Create an object which calculates quality
static QualitySSIM	create(UMat ref)
boolean	empty() \brief Implements Algorithm::empty()

Methods inherited from class org.bytedeco.opencv.opencv_quality.QualityBase

asAlgorithm, asAlgorithm, getQualityMap, getQualityMap, getQualityMap

Methods inherited from class org.bytedeco.opencv.opencv_core.Algorithm

getDefaultName, getPointer, position, read, save, save, write, write, write

Methods inherited from class org.bytedeco.javacpp.Pointer

address, asBuffer, asByteBuffer, availablePhysicalBytes, calloc, capacity, capacity, close, deallocate, deallocate, deallocateReferences, deallocator, deallocator, equals, fill, formatBytes, free, getDirectBufferAddress, getPointer, getPointer, getPointer, hashCode, interruptDeallocatorThread, isNull, isNull, limit, limit, malloc, maxBytes, maxPhysicalBytes, memchr, memcmp, memcpy, memmove, memset, offsetAddress, offsetof, offsetof, parseBytes, physicalBytes, physicalBytesInaccurate, position, put, realloc, referenceCount, releaseReference, retainReference, setNull, sizeof, sizeof, toString, totalBytes, totalCount, totalPhysicalBytes, withDeallocator, zero

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

QualitySSIM

public QualitySSIM(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

QualitySSIM

public QualitySSIM(Algorithm pointer)

Downcast constructor.

Method Detail

compute

@ByVal
public Scalar compute(@ByVal
                              Mat cmp)

\brief Computes SSIM

Overrides:

compute in class QualityBase

Parameters:

cmp - Comparison image

Returns:

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

compute

@ByVal
public Scalar compute(@ByVal
                              UMat cmp)

Overrides:

compute in class QualityBase

compute

@ByVal
public Scalar compute(@ByVal
                              GpuMat cmp)

Overrides:

compute in class QualityBase

empty

@Cast(value="bool")
public boolean empty()

\brief Implements Algorithm::empty()

Overrides:

empty in class QualityBase

clear

public void clear()

\brief Implements Algorithm::clear()

Overrides:

clear in class QualityBase

create

@opencv_core.Ptr
public static QualitySSIM create(@ByVal
                                                   Mat ref)

\brief Create an object which calculates quality

Parameters:

ref - input image to use as the reference image for comparison

create

@opencv_core.Ptr
public static QualitySSIM create(@ByVal
                                                   UMat ref)

create

@opencv_core.Ptr
public static QualitySSIM create(@ByVal
                                                   GpuMat ref)

compute

@ByVal
public static Scalar compute(@ByVal
                                     Mat ref,
                                     @ByVal
                                     Mat cmp,
                                     @ByVal
                                     Mat qualityMap)

\brief 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)

compute

@ByVal
public static Scalar compute(@ByVal
                                     UMat ref,
                                     @ByVal
                                     UMat cmp,
                                     @ByVal
                                     UMat qualityMap)

compute

@ByVal
public static Scalar compute(@ByVal
                                     GpuMat ref,
                                     @ByVal
                                     GpuMat cmp,
                                     @ByVal
                                     GpuMat qualityMap)