quality_QualitySSIM

qualityclassOpenCV 5.0.0

import { quality_QualitySSIM } from '@banou/opencv-wasm'

Use after await initOpenCV(). See the initialization and named imports guide.

Explore visually: PSNR and SSIM quality metrics →

Measure selected differences or quality cues between images, or estimate quality without a reference.

VISUAL WALKTHROUGHSimilarity

REFERENCE INPUTReference image

Compare aligned images with the same numeric range.

→

RESULTAggregate the error

These values are computed from the displayed 16 × 12 arrays. SSIM and other perceptual metrics use different definitions.

Computed MSE and PSNR example. Scalar error metrics summarize a spatial difference; they do not explain perceptual quality by themselves.

Native object: release it with using or delete(). Factories can return null; check before calling methods. Inherits quality_QualityBase.

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

Upstream declaration ↗

Constructors and members

static compute1

static method for computing quality

compute1(ref: Mat, cmp: Mat, qualityMap: Mat): Scalar;

ref

reference image

cmp

comparison image

qualityMap

Output destination, filled by the native operation. output quality map, or cv::noArray()

Returns

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

Upstream declaration ↗

static create

Create an object which calculates quality

create(ref: Mat): quality_QualitySSIM | null;

ref

input image to use as the reference image for comparison

Returns

The quality_QualitySSIM | null result.

Upstream declaration ↗

clone

Create another handle to the same native object. This retains the object without copying its pixels or algorithm state; dispose both handles separately.

clone(): this;

Returns

The this result.

compute

quality_QualitySSIM.compute: Computes SSIM

compute(cmp: Mat): Scalar;

cmp

Comparison image

Returns

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

Upstream declaration ↗

empty

Implements Algorithm::empty()

empty(): boolean;

Returns

The boolean result.

Upstream declaration ↗

clear

Implements Algorithm::clear()

clear(): void;

Upstream declaration ↗

These signatures describe this package. Upstream documentation can mention optional backends that are absent from this build. Check runtime compatibility before choosing a backend or file format.