Module ImageSSIM

Original TypeScript implementation: https://github.com/igor-bezkrovny/image-quantization/blob/9f62764ac047c3e53accdf1d7e4e424b0ef2fb60/src/quality/ssim.ts
Based on Java implementation: https://github.com/rhys-e/structural-similarity
For more information see: http://en.wikipedia.org/wiki/Structural_similarity

Index

Modules

Internals

Enumerations

Channels

Interfaces

Type aliases

Data

Functions

compare

Type aliases

Data

Data: number[] | any[] | Uint8Array

Functions

compare

compare(image1: IImage, image2: IImage, windowSize?: number, K1?: number, K2?: number, luminance?: boolean, bitsPerComponent?: number): IResult

- Defined in node_modules/image-ssim/index.ts:46
Entry point.

throws

new Error('Images have different sizes!')

Parameters
- image1: IImage
- image2: IImage
- Default value windowSize: number = 8
- Default value K1: number = 0.01
- Default value K2: number = 0.03
- Default value luminance: boolean = true
- Default value bitsPerComponent: number = 8
Returns IResult

Generated using TypeDoc