PHP: полный мануал с примерами, функциями и ООП

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="imagick.levelimage">
 <refnamediv>
  <refname>Imagick::levelImage</refname>
  <refpurpose>Adjusts the levels of an image</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <modifier>public</modifier> <type>bool</type><methodname>Imagick::levelImage</methodname>
   <methodparam><type>float</type><parameter>blackPoint</parameter></methodparam>
   <methodparam><type>float</type><parameter>gamma</parameter></methodparam>
   <methodparam><type>float</type><parameter>whitePoint</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>channel</parameter><initializer>Imagick::CHANNEL_DEFAULT</initializer></methodparam>
  </methodsynopsis>
  <para>
   Adjusts the levels of an image by scaling the colors falling
   between specified white and black points to the full
   available quantum range. The parameters provided represent
   the black, mid, and white points. The black point specifies
   the darkest color in the image. Colors darker than the black
   point are set to zero. Mid point specifies a gamma
   correction to apply to the image.  White point specifies the
   lightest color in the image. Colors brighter than the white
   point are set to the maximum quantum value.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>blackPoint</parameter></term>
     <listitem>
      <para>
      The image black point
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>gamma</parameter></term>
     <listitem>
      <para>
      The gamma value
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>whitePoint</parameter></term>
     <listitem>
      <para>
      The image white point
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>channel</parameter></term>
     <listitem>
      <para>
       Provide any channel constant that is valid for your channel mode. To
       apply to more than one channel, combine channeltype constants using
       bitwise operators. Refer to this
       list of  <link linkend="imagick.constants.channel">channel constants</link>.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &imagick.return.success;
  </para>
 </refsect1>

 <refsect1 role="errors">
  &reftitle.errors;
  <para>
   &imagick.imagick.throws;
  </para>
 </refsect1>



 <refsect1 role="examples">
  &reftitle.examples;
  <para>
    <example>
      <title> <function>Imagick::levelImage</function></title>
      <programlisting role="php">
      <![CDATA[
<?php
function levelImage($blackPoint, $gamma, $whitePoint) {
    $imagick = new \Imagick();
    $imagick->newPseudoimage(500, 500, 'gradient:black-white');

    $imagick->setFormat('png');
    $quantum = $imagick->getQuantum();
    $imagick->levelImage($blackPoint / 100 , $gamma, $quantum * $whitePoint / 100);

    header("Content-Type: image/png");
    echo $imagick->getImageBlob();
}

?>
]]>
      </programlisting>
    </example>
  </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
-->

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="imagick.equalizeimage">
 <refnamediv>
  <refname>Imagick::equalizeImage</refname>
  <refpurpose>Equalizes the image histogram</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <modifier>public</modifier> <type>bool</type><methodname>Imagick::equalizeImage</methodname>
   <void/>
  </methodsynopsis>
  <para>
   Equalizes the image histogram.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  &no.function.parameters;
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &imagick.return.success;
  </para>
 </refsect1>

 <refsect1 role="errors">
  &reftitle.errors;
  <para>
   &imagick.imagick.throws;
  </para>
 </refsect1>



 <refsect1 role="examples">
  &reftitle.examples;
  <para>
    <example>
      <title> <function>Imagick::equalizeImage</function></title>
      <programlisting role="php">
      <![CDATA[
<?php
function equalizeImage($imagePath) {
    $imagick = new \Imagick(realpath($imagePath));
    $imagick->equalizeImage();
    header("Content-Type: image/jpg");
    echo $imagick->getImageBlob();
}

?>
]]>
      </programlisting>
    </example>
  </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
-->

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="imagick.sigmoidalcontrastimage" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>Imagick::sigmoidalContrastImage</refname>
  <refpurpose>Adjusts the contrast of an image</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <modifier>public</modifier> <type>bool</type><methodname>Imagick::sigmoidalContrastImage</methodname>
   <methodparam><type>bool</type><parameter>sharpen</parameter></methodparam>
   <methodparam><type>float</type><parameter>alpha</parameter></methodparam>
   <methodparam><type>float</type><parameter>beta</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>channel</parameter><initializer>Imagick::CHANNEL_DEFAULT</initializer></methodparam>
  </methodsynopsis>
  <simpara>
   Adjusts the contrast of an image with a non-linear sigmoidal contrast
   algorithm. Increase the contrast of the image using a sigmoidal transfer
   function without saturating highlights or shadows. <parameter>alpha</parameter> indicates
   how much to increase the contrast: <literal>0.00</literal> is none; <literal>3.00</literal> is
   typical; <literal>20.00</literal> is pushing it.
   <parameter>beta</parameter> indicates where midtones fall in the resultant
   image, as a fraction of the quantum range: <literal>0.0</literal> is white,
   <literal>0.5</literal> is middle-gray, <literal>1.0</literal> is black
   (multiply by <code>getQuantumRange()['quantumRangeLong']</code> to get the value to
   pass).
  </simpara>
  <simpara>
   See also <link xlink:href="&url.imagemagick.usage.color_mods.sigmoidal;">ImageMagick
    Examples -- Color Modifications — Sigmoidal Non-linearity Contrast</link>.
  </simpara>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>sharpen</parameter></term>
     <listitem>
      <simpara>
       If &true; increase the contrast, if &false; decrease the contrast.
      </simpara>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>alpha</parameter></term>
     <listitem>
      <simpara>
       The amount of contrast to apply. <literal>1.00</literal> is very little, <literal>5.00</literal>
       is a significant amount, <literal>20.00</literal> is extreme.
      </simpara>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>beta</parameter></term>
     <listitem>
      <simpara>
       Where the midpoint of the gradient will be. This value should be in the range <literal>0.00</literal>
       to <literal>1.00</literal> - multiplied by the quantum value for ImageMagick.
      </simpara>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>channel</parameter></term>
     <listitem>
      <simpara>
       Which color channels the contrast will be applied to.
      </simpara>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &imagick.return.success;
  </para>
 </refsect1>

 <refsect1 role="errors">
  &reftitle.errors;
  <para>
   &imagick.imagick.throws;
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <example>
   <title>
    Create a gradient image using <function>Imagick::sigmoidalContrastImage</function>
    suitable for blending two images together smoothly, with the blending
    defined by <parameter>alpha</parameter> and <parameter>beta</parameter>
   </title>
   <programlisting role="php">
<![CDATA[
<?php

function generateBlendImage($width, $height, $alpha = 10, $beta = 0.5)
{
    $imagick = new Imagick();
    $imagick->newPseudoImage($width, $height, 'gradient:black-white');
    $quanta = $imagick->getQuantumRange();
    $imagick->sigmoidalContrastImage(true, $alpha, $beta * $quanta["quantumRangeLong"]);

    return $imagick;
}
]]>
   </programlisting>
  </example>
 </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
-->