imagemagick-compare/dist/index.d.ts

Compare images with NodeJS using ImageMagick's Magick++

/// <reference types="node" />
/**
 * AE - absolute error count, number of different pixels (-fuzz affected)
 *
 * DSSIM - structural dissimilarity index
 *
 * FUZZ - mean color distance
 *
 * MAE - mean absolute error (normalized), average channel error distance
 *
 * MEPP - mean error per pixel (normalized mean error, normalized peak error)
 *
 * MSE - mean error squared, average of the channel error squared
 *
 * NCC - normalized cross correlation
 *
 * PAE - peak absolute (normalized peak absolute)
 *
 * PHASH - perceptual hash for the sRGB and HCLp colorspaces
 *
 * PSNR - peak signal to noise ratio
 *
 * RMSE - root mean squared (normalized root mean squared)
 *
 * SSIM - structural similarity index
 */
export type CompareMetric = 'AE' | 'DSSIM' | 'FUZZ' | 'MAE' | 'MEPP' | 'MSE' | 'NCC' | 'PAE' | 'PHASH' | 'PSNR' | 'RMSE' | 'SSIM';
/**
 * Metric is defaulting to SSIM.
 *
 * Additional options like radius, sigma, k1 and k2 options will only be used for SSIM and DSSIM metrics.
 */
export type CompareOptions = {
    metric?: CompareMetric;
    radius?: number;
    sigma?: number;
    k1?: number;
    k2?: number;
};
export type CompareCallback = (err: Error | undefined, res: number | undefined) => void;
/**
 *
 * @returns The version of the installed Magick++ library
 */
export declare function version(): string;
/**
 * Compares two images using Magick++ assynchronously.
 * @param originalImage Image buffer of the original image
 * @param compareWith Image buffer of the image to compare with
 * @param options Define metric options
 * @param callback Optional callback function if you don't want to use promises
 * @returns Promise with metric result as a number
 */
export declare function compare(originalImage: Buffer, compareWith: Buffer, options?: CompareOptions, callback?: CompareCallback): Promise<number | undefined>;
/**
 * Compares two images using Magick++ synchronously.
 * @param originalImage Image buffer of the original image
 * @param compareWith Image buffer of the image to compare with
 * @param options Define metric options
 * @returns Metric result as a number
 */
export declare function compareSync(originalImage: Buffer, compareWith: Buffer, options?: CompareOptions): number;