Ocean
Ocean::CV::ImageQuality Class Reference

This class implements functions to measure the quality of images. More...

Static Public Member Functions

static bool structuralSimilarity8BitPerChannel (const uint8_t *const imageX, const uint8_t *const imageY, const unsigned int width, const unsigned int height, const unsigned int channels, const unsigned int imageXPaddingElements, const unsigned int imageYPaddingElements, double &meanSSIM, double &meanContrast, Worker *worker=nullptr)
 Determines the structural similarity (SSIM) of two images with identical frame type for images with pixel formats that have 8 bit per channel. More...
 
static bool multiScaleStructuralSimilarity8BitPerChannel (const uint8_t *const imageX, const uint8_t *const imageY, const unsigned int width, const unsigned int height, const unsigned int channels, const unsigned int imageXPaddingElements, const unsigned int imageYPaddingElements, double &msssim, Worker *worker=nullptr)
 Determines the multi-scale structural similarity (MSSSIM) of two images with identical frame type for images with pixel formats that have 8 bit per channel. More...
 

Detailed Description

This class implements functions to measure the quality of images.

Member Function Documentation

◆ multiScaleStructuralSimilarity8BitPerChannel()

static bool Ocean::CV::ImageQuality::multiScaleStructuralSimilarity8BitPerChannel ( const uint8_t *const  imageX,
const uint8_t *const  imageY,
const unsigned int  width,
const unsigned int  height,
const unsigned int  channels,
const unsigned int  imageXPaddingElements,
const unsigned int  imageYPaddingElements,
double &  msssim,
Worker worker = nullptr 
)
static

Determines the multi-scale structural similarity (MSSSIM) of two images with identical frame type for images with pixel formats that have 8 bit per channel.

Beware: For backwards-compatibility the implementation of this function does not fully match that in the paper "Multi-Scale Structural Similarity for Image Quality Assessment"

Parameters
imageXThe first image to be used, must be valid
imageYThe second image to be used, must be valid
widthThe width of both images in pixel, with range [11, infinity)
heightThe height of both images in pixel, with range [11, infinity)
channelsThe number of data channels both images have, with range [1, 4]
imageXPaddingElementsOptional number of padding elements at the end of each first image row, in elements, with range [0, infinity)
imageYPaddingElementsOptional number of padding elements at the end of each second image row, in elements, with range [0, infinity)
msssimThe resulting msssim index, with range [0, 1]
workerOptional worker object to distribute the computation
See also
structuralSimilarity8BitPerChannel().

◆ structuralSimilarity8BitPerChannel()

static bool Ocean::CV::ImageQuality::structuralSimilarity8BitPerChannel ( const uint8_t *const  imageX,
const uint8_t *const  imageY,
const unsigned int  width,
const unsigned int  height,
const unsigned int  channels,
const unsigned int  imageXPaddingElements,
const unsigned int  imageYPaddingElements,
double &  meanSSIM,
double &  meanContrast,
Worker worker = nullptr 
)
static

Determines the structural similarity (SSIM) of two images with identical frame type for images with pixel formats that have 8 bit per channel.

Parameters
imageXThe first image to be used, must be valid
imageYThe second image to be used, e.g., a compressed/noisy version of image x, must be valid
widthThe width of both images in pixel, with range [11, infinity)
heightThe height of both images in pixel, with range [11, infinity)
channelsThe number of data channels both images have, with range [1, infinity)
imageXPaddingElementsOptional number of padding elements at the end of each first image row, in elements, with range [0, infinity)
imageYPaddingElementsOptional number of padding elements at the end of each second image row, in elements, with range [0, infinity)
meanSSIMThe resulting ssim index, with range [0, 1]
meanContrastThe resulting mean contrast measure, with range [0, 1]
workerOptional worker object to distribute the computation
See also
multiScaleStructuralSimilarity8BitPerChannel().

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