Forum und email

ImagickPixel::isSimilar

(No version information available, might be only in CVS)

ImagickPixel::isSimilar — Check the distance between this color and another

Description

bool ImagickPixel::isSimilar ( ImagickPixel $color , float $fuzz )
Warning

This function is currently not documented; only the argument list is available.

Warning

This function is EXPERIMENTAL. The behaviour of this function, the name of this function, and anything else documented about this function may change without notice in a future release of PHP. Use this function at your own risk.

Checks the distance between the color described by this ImagickPixel object and that of the provided object, by plotting their RGB values on the color cube. If the distance between the two points is less than the fuzz value given, the colors are similar.

Parameters

color

The ImagickPixel object to compare this object against.

fuzz

The maximum distance within which to consider these colors as similar. The theoretical maximum for this value is the square root of three (1.732).

Return Values

Returns TRUE on success.