mkoppanen Tue Aug 14 12:17:57 2007 UTC
Modified files:
/phpdoc/en/reference/imagick/imagick adaptivesharpenimage.xml
Log:
Fixed the documentation for Imagick::adaptiveSharpenImage and added an
example.
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imagick/imagick/adaptivesharpenimage.xml?r1=1.4&r2=1.5&diff_format=u
Index: phpdoc/en/reference/imagick/imagick/adaptivesharpenimage.xml
diff -u phpdoc/en/reference/imagick/imagick/adaptivesharpenimage.xml:1.4
phpdoc/en/reference/imagick/imagick/adaptivesharpenimage.xml:1.5
--- phpdoc/en/reference/imagick/imagick/adaptivesharpenimage.xml:1.4 Wed Jun
20 22:24:41 2007
+++ phpdoc/en/reference/imagick/imagick/adaptivesharpenimage.xml Tue Aug
14 12:17:57 2007
@@ -1,9 +1,9 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.4 $ -->
+<!-- $Revision: 1.5 $ -->
<refentry xmlns="http://docbook.org/ns/docbook";
xml:id="function.imagick-adaptivesharpenimage">
<refnamediv>
<refname>Imagick::adaptiveSharpenImage</refname>
- <refpurpose>Adaptively resize image with data dependent
triangulation</refpurpose>
+ <refpurpose>Adaptively sharpen the image</refpurpose>
</refnamediv>
<refsect1 role="description">
@@ -17,7 +17,8 @@
&warn.undocumented.func;
&warn.experimental.func;
<para>
- Adaptively resize image with data dependent triangulation
+ Adaptively sharpen the image by sharpening more intensely
+ near image edges and less intensely far from edges.
</para>
</refsect1>
@@ -29,7 +30,7 @@
<term><parameter>radius</parameter></term>
<listitem>
<para>
- Its description
+ The radius of the Gaussian, in pixels, not counting the center pixel.
Use 0 for auto-select.
</para>
</listitem>
</varlistentry>
@@ -37,7 +38,7 @@
<term><parameter>sigma</parameter></term>
<listitem>
<para>
- Its description
+ The standard deviation of the Gaussian, in pixels.
</para>
</listitem>
</varlistentry>
@@ -45,7 +46,10 @@
<term><parameter>channel</parameter></term>
<listitem>
<para>
- Its description
+ Provide any channel constant that is valid for your channel mode. To
+ apply to more than one channel, combine channeltype constants using
+ bitwise operators. Defaults to Imagick::CHANNEL_ALL. Refer to this
+ list of <link linkend="imagick.constants.channel">channel
constants</link>.
</para>
</listitem>
</varlistentry>
@@ -93,48 +97,41 @@
</refsect1>
-->
- <!-- Use when examples exist
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>A <function>Imagick::adaptiveSharpenImage</function> example</title>
<para>
- Any text that describes the purpose of the example, or
- what goes on in the example should go here (inside the
- <example> tag, not out
+ Adaptively sharpen the image with radius 2 and sigma 1.
</para>
<programlisting role="php">
<![CDATA[
<?php
-if ($anexample === true) {
- echo 'Use the PEAR Coding Standards';
+try {
+ $image = new Imagick('image.png');
+ $image->adaptiveSharpenImage(2,1);
+} catch(ImagickException $e) {
+ echo 'Error: ' , $e->getMessage();
+ die();
}
+header('Content-type: image/png');
+echo $image;
?>
]]>
</programlisting>
- &example.outputs;
- <screen>
-<![CDATA[
-Use the PEAR Coding Standards
-]]>
- </screen>
</example>
</para>
</refsect1>
- -->
- <!-- Use when adding See Also links
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
- <member><function></function></member>
- <member>Or <link linkend="somethingelse">something else</link></member>
+ <member><function>Imagick::sharpenImage</function></member>
</simplelist>
</para>
</refsect1>
- -->
</refentry>
