ispixelsimilar.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: fa0c88f1e36a3f28b4fcee0b2d1e188b54e0c44b Maintainer: sergey Status: ready -->
<!-- Reviewed: no -->

<refentry xmlns="http://docbook.org/ns/docbook" xml:id="imagickpixel.ispixelsimilar">
 <refnamediv>
  <refname>ImagickPixel::isPixelSimilar</refname>
  <refpurpose>Проверяет расстояние между этим цветом и другим</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <modifier>public</modifier> <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>
   Проверяет расстояние между цветом, описанным этим объектом ImagickPixel,
   и цветом предоставленного объекта, нанося их значения RGB
   на цветной куб. Если расстояние между двумя точками меньше
   заданного значения размытия, цвета схожи.
   Метод заменяет <link linkend="imagickpixel.issimilar">ImagickPixel::isSimilar()</link>
   и корректно нормализует значение fuzz в ImageMagick QuantumRange.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>color</parameter></term>
     <listitem>
      <para>
       Объект ImagickPixel для сравнения с текущим объектом.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>fuzz</parameter></term>
     <listitem>
      <para>
       Максимальное расстояние, на котором можно считать эти цвета одинаковыми.
       Теоретическим максимумом для этого значения является квадратный корень из трёх
       (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
-->