1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 331921 $ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="imagickpixel.ispixelsimilar">
<refnamediv>
<refname>ImagickPixel::isPixelSimilar</refname>
<refpurpose>Check the distance between this color and another</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>ImagickPixel::isPixelSimilar</methodname>
<methodparam><type>ImagickPixel</type><parameter>color</parameter></methodparam>
<methodparam><type>float</type><parameter>fuzz</parameter></methodparam>
</methodsynopsis>
<para>
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.
This method replaces <link linkend="imagickpixel.issimilar">ImagickPixel::isSimilar()</link>
and correctly normalises the fuzz value to ImageMagick QuantumRange.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>color</parameter></term>
<listitem>
<para>
The ImagickPixel object to compare this object against.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>fuzz</parameter></term>
<listitem>
<para>
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).
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&imagick.return.success;
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
|
