Added docs for segmentimage and deskewimage

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@289128 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Mikko Koppanen 2009-10-03 13:49:57 +00:00
parent 11be010464
commit aa46b9f15a
2 changed files with 160 additions and 0 deletions

View file

@ -0,0 +1,65 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: $ -->
<refentry xml:id="imagick.deskewimage" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>Imagick::deskewImage</refname>
<refpurpose>Removes skew from the image</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>Imagick::deskewImage</methodname>
<methodparam><type>float</type><parameter>threshold</parameter></methodparam>
</methodsynopsis>
<para>
This method can be used to remove skew from for example scanned images where the paper
was not properly placed on the scanning surface. &imagick.method.available.0x645;
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>threshold</parameter></term>
<listitem>
<para>
Deskew threshold
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
</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:"../../../../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
-->

View file

@ -0,0 +1,95 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: $ -->
<refentry xml:id="imagick.segmentimage" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>Imagick::segmentImage</refname>
<refpurpose>Segments an image</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>Imagick::segmentImage</methodname>
<methodparam><type>int</type><parameter>COLORSPACE</parameter></methodparam>
<methodparam><type>float</type><parameter>cluster_threshold</parameter></methodparam>
<methodparam><type>float</type><parameter>smooth_threshold</parameter></methodparam>
<methodparam choice="opt"><type>boolean</type><parameter>verbose</parameter></methodparam>
</methodsynopsis>
<para>
</para>
Analyses the image and identifies units that are similar. &imagick.method.available.0x645;
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>COLORSPACE</parameter></term>
<listitem>
<para>
One of the <link linkend="imagick.constants.colorspace">COLORSPACE constants</link>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>cluster_threshold</parameter></term>
<listitem>
<para>
A percentage describing minimum number of pixels
contained in hexedra before it is considered valid.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>smooth_threshold</parameter></term>
<listitem>
<para>
Eliminates noise from the histogram.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>verbose</parameter></term>
<listitem>
<para>
Whether to output detailed information about recognised classes.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
</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:"../../../../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
-->