org.bytedeco.opencv.opencv_quality

Class QualityPSNR

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.opencv.opencv_core.Algorithm

org.bytedeco.opencv.opencv_quality.QualityBase

org.bytedeco.opencv.opencv_quality.QualityPSNR

All Implemented Interfaces:

AutoCloseable

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

\brief Full reference peak signal to noise ratio (PSNR) algorithm https://en.wikipedia.org/wiki/Peak_signal-to-noise_ratio

Nested Class Summary

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

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

Field Summary

Fields

Modifier and Type	Field and Description
static double	MAX_PIXEL_VALUE_DEFAULT

Fields inherited from class org.bytedeco.javacpp.Pointer

address, capacity, limit, position

Constructor Summary

Constructors

Constructor and Description
QualityPSNR(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)
static Scalar	compute(GpuMat ref, GpuMat cmp, GpuMat qualityMap, double maxPixelValue)
Scalar	compute(Mat cmp) \brief Compute the PSNR
static Scalar	compute(Mat ref, Mat cmp, Mat qualityMap)
static Scalar	compute(Mat ref, Mat cmp, Mat qualityMap, double maxPixelValue) \brief static method for computing quality
Scalar	compute(UMat cmp)
static Scalar	compute(UMat ref, UMat cmp, UMat qualityMap)
static Scalar	compute(UMat ref, UMat cmp, UMat qualityMap, double maxPixelValue)
static QualityPSNR	create(GpuMat ref)
static QualityPSNR	create(GpuMat ref, double maxPixelValue)
static QualityPSNR	create(Mat ref)
static QualityPSNR	create(Mat ref, double maxPixelValue) \brief Create an object which calculates quality
static QualityPSNR	create(UMat ref)
static QualityPSNR	create(UMat ref, double maxPixelValue)
boolean	empty() \brief Implements Algorithm::empty()
double	getMaxPixelValue() \brief return the maximum pixel value used for PSNR computation
static double	MAX_PIXEL_VALUE_DEFAULT() \brief Default maximum pixel value
void	setMaxPixelValue(double val) \brief sets the maximum pixel value used for PSNR computation

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

getQualityMap, getQualityMap, getQualityMap

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

getDefaultName, 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, hashCode, isNull, isNull, limit, limit, malloc, maxBytes, maxPhysicalBytes, memchr, memcmp, memcpy, memmove, memset, offsetof, parseBytes, physicalBytes, position, put, realloc, referenceCount, releaseReference, retainReference, setNull, sizeof, toString, totalBytes, totalPhysicalBytes, withDeallocator, zero

Methods inherited from class java.lang.Object

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

Field Detail

MAX_PIXEL_VALUE_DEFAULT

public static final double MAX_PIXEL_VALUE_DEFAULT

Constructor Detail

QualityPSNR

public QualityPSNR(Pointer p)

Pointer cast constructor. Invokes Pointer.Pointer(Pointer).

Method Detail

MAX_PIXEL_VALUE_DEFAULT

@MemberGetter
public static double MAX_PIXEL_VALUE_DEFAULT()

\brief Default maximum pixel value

create

@opencv_core.Ptr
public static QualityPSNR create(@ByVal
                                                  Mat ref,
                                                  double maxPixelValue)

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

create

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

create

@opencv_core.Ptr
public static QualityPSNR create(@ByVal
                                                  UMat ref,
                                                  double maxPixelValue)

create

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

create

@opencv_core.Ptr
public static QualityPSNR create(@ByVal
                                                  GpuMat ref,
                                                  double maxPixelValue)

create

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

compute

@ByVal
public Scalar compute(@ByVal
                             Mat cmp)

\brief Compute the PSNR

Overrides:

compute in class QualityBase

Parameters:

cmp - Comparison image

Returns:

Per-channel PSNR value, or std::numeric_limits::infinity() if the MSE between the two images == 0

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

compute

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

\brief 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::infinity() if the MSE between the two images == 0

compute

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

compute

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

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,
                                    double maxPixelValue)

compute

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

getMaxPixelValue

public double getMaxPixelValue()

\brief return the maximum pixel value used for PSNR computation

setMaxPixelValue

public void setMaxPixelValue(double val)

\brief sets the maximum pixel value used for PSNR computation

Parameters:

val - Maximum pixel value