<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/class.imagickpixel.inc";
$setup = array (
'home' =>
array (
0 => 'index.php',
1 => 'PHP Manual',
),
'head' =>
array (
0 => 'UTF-8',
1 => 'zh',
),
'this' =>
array (
0 => 'imagickpixel.issimilar.php',
1 => 'ImagickPixel::isSimilar',
2 => 'Check the distance between this color and another',
),
'up' =>
array (
0 => 'class.imagickpixel.php',
1 => 'ImagickPixel',
),
'prev' =>
array (
0 => 'imagickpixel.ispixelsimilarquantum.php',
1 => 'ImagickPixel::isPixelSimilarQuantum',
),
'next' =>
array (
0 => 'imagickpixel.setcolor.php',
1 => 'ImagickPixel::setColor',
),
'alternatives' =>
array (
),
'source' =>
array (
'lang' => 'en',
'path' => 'reference/imagick/imagickpixel/issimilar.xml',
),
'history' =>
array (
),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);
contributors($setup);
?>
<div id="imagickpixel.issimilar" class="refentry">
<div class="refnamediv">
<h1 class="refname">ImagickPixel::isSimilar</h1>
<p class="verinfo">(PECL imagick 2, PECL imagick 3)</p><p class="refpurpose"><span class="refname">ImagickPixel::isSimilar</span> — <span class="dc-title">Check the distance between this color and another</span></p>
</div>
<div class="refsect1 description" id="refsect1-imagickpixel.issimilar-description">
<h3 class="title">说明</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="methodname"><strong>ImagickPixel::isSimilar</strong></span>(<span class="methodparam"><span class="type"><a href="class.imagickpixel.php" class="type ImagickPixel">ImagickPixel</a></span> <code class="parameter">$color</code></span>, <span class="methodparam"><span class="type"><a href="language.types.float.php" class="type float">float</a></span> <code class="parameter">$fuzz</code></span>): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>
<div class="warning"><strong class="warning">警告</strong><p class="simpara">本函数还未编写文档，仅有参数列表。</p></div>
<p class="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.
Deprecated in favour of <a href="imagickpixel.ispixelsimilar.php" class="link">ImagickPixel::isPixelSimilar()</a>.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-imagickpixel.issimilar-parameters">
<h3 class="title">参数</h3>
<p class="para">
<dl>
<dt><code class="parameter">color</code></dt>
<dd>
<p class="para">
The ImagickPixel object to compare this object against.
</p>
</dd>
<dt><code class="parameter">fuzz</code></dt>
<dd>
<p class="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).
</p>
</dd>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-imagickpixel.issimilar-returnvalues">
<h3 class="title">返回值</h3>
<p class="para">
成功时返回 <strong><code><a href="reserved.constants.php#constant.true">true</a></code></strong>。
</p>
</div>
<div class="refsect1 examples" id="refsect1-imagickpixel.issimilar-examples">
<h3 class="title">示例</h3>
<p class="para">
<div class="example" id="example-3183">
<p><strong>示例 #1 <span class="function"><strong>ImagickPixel::isSimilar()</strong></span></strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB"><?php<br /> </span><span style="color: #FF8000">// The tests below are written with the maximum distance expressed as 255<br /> // so we need to scale them by the square root of 3 - the diagonal length<br /> // of a unit cube.<br /> </span><span style="color: #0000BB">$root3 </span><span style="color: #007700">= </span><span style="color: #0000BB">1.732050807568877</span><span style="color: #007700">;<br /><br /> </span><span style="color: #0000BB">$tests </span><span style="color: #007700">= array(<br /> [</span><span style="color: #DD0000">'rgb(245, 0, 0)'</span><span style="color: #007700">, </span><span style="color: #DD0000">'rgb(255, 0, 0)'</span><span style="color: #007700">, </span><span style="color: #0000BB">9 </span><span style="color: #007700">/ </span><span style="color: #0000BB">$root3</span><span style="color: #007700">, </span><span style="color: #0000BB">false</span><span style="color: #007700">,],<br /> [</span><span style="color: #DD0000">'rgb(245, 0, 0)'</span><span style="color: #007700">, </span><span style="color: #DD0000">'rgb(255, 0, 0)'</span><span style="color: #007700">, </span><span style="color: #0000BB">10 </span><span style="color: #007700">/ </span><span style="color: #0000BB">$root3</span><span style="color: #007700">, </span><span style="color: #0000BB">true</span><span style="color: #007700">,],<br /> [</span><span style="color: #DD0000">'rgb(0, 0, 0)'</span><span style="color: #007700">, </span><span style="color: #DD0000">'rgb(7, 7, 0)'</span><span style="color: #007700">, </span><span style="color: #0000BB">9 </span><span style="color: #007700">/ </span><span style="color: #0000BB">$root3</span><span style="color: #007700">, </span><span style="color: #0000BB">false</span><span style="color: #007700">,],<br /> [</span><span style="color: #DD0000">'rgb(0, 0, 0)'</span><span style="color: #007700">, </span><span style="color: #DD0000">'rgb(7, 7, 0)'</span><span style="color: #007700">, </span><span style="color: #0000BB">10 </span><span style="color: #007700">/ </span><span style="color: #0000BB">$root3</span><span style="color: #007700">, </span><span style="color: #0000BB">true</span><span style="color: #007700">,],<br /> [</span><span style="color: #DD0000">'rgba(0, 0, 0, 1)'</span><span style="color: #007700">, </span><span style="color: #DD0000">'rgba(7, 7, 0, 1)'</span><span style="color: #007700">, </span><span style="color: #0000BB">9 </span><span style="color: #007700">/ </span><span style="color: #0000BB">$root3</span><span style="color: #007700">, </span><span style="color: #0000BB">false</span><span style="color: #007700">,],<br /> [</span><span style="color: #DD0000">'rgba(0, 0, 0, 1)'</span><span style="color: #007700">, </span><span style="color: #DD0000">'rgba(7, 7, 0, 1)'</span><span style="color: #007700">, </span><span style="color: #0000BB">10 </span><span style="color: #007700">/ </span><span style="color: #0000BB">$root3</span><span style="color: #007700">, </span><span style="color: #0000BB">true</span><span style="color: #007700">,],<br /> [</span><span style="color: #DD0000">'rgb(128, 128, 128)'</span><span style="color: #007700">, </span><span style="color: #DD0000">'rgb(128, 128, 120)'</span><span style="color: #007700">, </span><span style="color: #0000BB">7 </span><span style="color: #007700">/ </span><span style="color: #0000BB">$root3</span><span style="color: #007700">, </span><span style="color: #0000BB">false</span><span style="color: #007700">,],<br /> [</span><span style="color: #DD0000">'rgb(128, 128, 128)'</span><span style="color: #007700">, </span><span style="color: #DD0000">'rgb(128, 128, 120)'</span><span style="color: #007700">, </span><span style="color: #0000BB">8 </span><span style="color: #007700">/ </span><span style="color: #0000BB">$root3</span><span style="color: #007700">, </span><span style="color: #0000BB">true</span><span style="color: #007700">,],<br /> [</span><span style="color: #DD0000">'rgb(0, 0, 0)'</span><span style="color: #007700">, </span><span style="color: #DD0000">'rgb(255, 255, 255)'</span><span style="color: #007700">, </span><span style="color: #0000BB">254.9</span><span style="color: #007700">, </span><span style="color: #0000BB">false</span><span style="color: #007700">,],<br /> [</span><span style="color: #DD0000">'rgb(0, 0, 0)'</span><span style="color: #007700">, </span><span style="color: #DD0000">'rgb(255, 255, 255)'</span><span style="color: #007700">, </span><span style="color: #0000BB">255</span><span style="color: #007700">, </span><span style="color: #0000BB">true</span><span style="color: #007700">,],<br /> [</span><span style="color: #DD0000">'rgb(255, 0, 0)'</span><span style="color: #007700">, </span><span style="color: #DD0000">'rgb(0, 255, 255)'</span><span style="color: #007700">, </span><span style="color: #0000BB">254.9</span><span style="color: #007700">, </span><span style="color: #0000BB">false</span><span style="color: #007700">,],<br /> [</span><span style="color: #DD0000">'rgb(255, 0, 0)'</span><span style="color: #007700">, </span><span style="color: #DD0000">'rgb(0, 255, 255)'</span><span style="color: #007700">, </span><span style="color: #0000BB">255</span><span style="color: #007700">, </span><span style="color: #0000BB">true</span><span style="color: #007700">,],<br /> [</span><span style="color: #DD0000">'black'</span><span style="color: #007700">, </span><span style="color: #DD0000">'rgba(0, 0, 0)'</span><span style="color: #007700">, </span><span style="color: #0000BB">0.0</span><span style="color: #007700">, </span><span style="color: #0000BB">true</span><span style="color: #007700">],<br /> [</span><span style="color: #DD0000">'black'</span><span style="color: #007700">, </span><span style="color: #DD0000">'rgba(10, 0, 0, 1.0)'</span><span style="color: #007700">, </span><span style="color: #0000BB">10.0 </span><span style="color: #007700">/ </span><span style="color: #0000BB">$root3</span><span style="color: #007700">, </span><span style="color: #0000BB">true</span><span style="color: #007700">],);<br /><br /> </span><span style="color: #0000BB">$output </span><span style="color: #007700">= </span><span style="color: #DD0000">"<table width='100%' class='infoTable'><thead><br /> <tr><br /> <th><br /> Color 1<br /> </th><br /> <th><br /> Color 2<br /> </th><br /> <th><br /> Test distance * 255<br /> </th><br /> <th><br /> Is within distance<br /> </th><br /> </tr><br /> </thead>"</span><span style="color: #007700">;<br /><br /> </span><span style="color: #0000BB">$output </span><span style="color: #007700">.= </span><span style="color: #DD0000">"<tbody>"</span><span style="color: #007700">;<br /><br /> foreach (</span><span style="color: #0000BB">$tests </span><span style="color: #007700">as </span><span style="color: #0000BB">$testInfo</span><span style="color: #007700">) {<br /> </span><span style="color: #0000BB">$color1 </span><span style="color: #007700">= </span><span style="color: #0000BB">$testInfo</span><span style="color: #007700">[</span><span style="color: #0000BB">0</span><span style="color: #007700">];<br /> </span><span style="color: #0000BB">$color2 </span><span style="color: #007700">= </span><span style="color: #0000BB">$testInfo</span><span style="color: #007700">[</span><span style="color: #0000BB">1</span><span style="color: #007700">];<br /> </span><span style="color: #0000BB">$distance </span><span style="color: #007700">= </span><span style="color: #0000BB">$testInfo</span><span style="color: #007700">[</span><span style="color: #0000BB">2</span><span style="color: #007700">];<br /> </span><span style="color: #0000BB">$expectation </span><span style="color: #007700">= </span><span style="color: #0000BB">$testInfo</span><span style="color: #007700">[</span><span style="color: #0000BB">3</span><span style="color: #007700">];<br /> </span><span style="color: #0000BB">$testDistance </span><span style="color: #007700">= (</span><span style="color: #0000BB">$distance </span><span style="color: #007700">/ </span><span style="color: #0000BB">255.0</span><span style="color: #007700">);<br /><br /> </span><span style="color: #0000BB">$color1Pixel </span><span style="color: #007700">= new </span><span style="color: #0000BB">\ImagickPixel</span><span style="color: #007700">(</span><span style="color: #0000BB">$color1</span><span style="color: #007700">);<br /> </span><span style="color: #0000BB">$color2Pixel </span><span style="color: #007700">= new </span><span style="color: #0000BB">\ImagickPixel</span><span style="color: #007700">(</span><span style="color: #0000BB">$color2</span><span style="color: #007700">);<br /><br /> </span><span style="color: #0000BB">$isSimilar </span><span style="color: #007700">= </span><span style="color: #0000BB">$color1Pixel</span><span style="color: #007700">-></span><span style="color: #0000BB">isPixelSimilar</span><span style="color: #007700">(</span><span style="color: #0000BB">$color2Pixel</span><span style="color: #007700">, </span><span style="color: #0000BB">$testDistance</span><span style="color: #007700">);<br /><br /><br /> if (</span><span style="color: #0000BB">$isSimilar </span><span style="color: #007700">!== </span><span style="color: #0000BB">$expectation</span><span style="color: #007700">) {<br /> echo </span><span style="color: #DD0000">"Test distance failed. Color [</span><span style="color: #0000BB">$color1</span><span style="color: #DD0000">] compared to color [</span><span style="color: #0000BB">$color2</span><span style="color: #DD0000">] is not within distance </span><span style="color: #0000BB">$testDistance</span><span style="color: #DD0000"> FAILED."</span><span style="color: #007700">.</span><span style="color: #0000BB">NL</span><span style="color: #007700">;<br /> }<br /><br /> </span><span style="color: #0000BB">$layout </span><span style="color: #007700">= </span><span style="color: #DD0000">"<tr><br /> <td>%s</td><br /> <td>%s</td><br /> <td>%s</td><br /> <td style='text-align: center;'>%s</td><br /> </tr>"</span><span style="color: #007700">;<br /> <br /> </span><span style="color: #0000BB">$output </span><span style="color: #007700">.= </span><span style="color: #0000BB">sprintf</span><span style="color: #007700">(<br /> </span><span style="color: #0000BB">$layout</span><span style="color: #007700">,<br /> </span><span style="color: #0000BB">$color1</span><span style="color: #007700">,<br /> </span><span style="color: #0000BB">$color2</span><span style="color: #007700">,<br /> </span><span style="color: #0000BB">$distance</span><span style="color: #007700">,<br /> </span><span style="color: #0000BB">$isSimilar </span><span style="color: #007700">? </span><span style="color: #DD0000">'yes' </span><span style="color: #007700">: </span><span style="color: #DD0000">'no'<br /> </span><span style="color: #007700">);<br /> }<br /><br /> </span><span style="color: #0000BB">$output </span><span style="color: #007700">.= </span><span style="color: #DD0000">"</tbody></table>"</span><span style="color: #007700">;<br /> <br /> return </span><span style="color: #0000BB">$output</span><span style="color: #007700">;<br /><br /></span><span style="color: #0000BB">?></span></span></code></div>
</div>
</div>
</p>
</div>
</div><?php manual_footer($setup); ?>