<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Applies wave filter to the image</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="imagick.vignetteimage.html">Imagick::vignetteImage</a></div>
<div class="next" style="text-align: right; float: right;"><a href="imagick.whitethresholdimage.html">Imagick::whiteThresholdImage</a></div>
<div class="up"><a href="class.imagick.html">Imagick</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="imagick.waveimage" class="refentry">
<div class="refnamediv">
<h1 class="refname">Imagick::waveImage</h1>
<p class="verinfo">(PECL imagick 2.0.0)</p><p class="refpurpose"><span class="refname">Imagick::waveImage</span> — <span class="dc-title">Applies wave filter to the image</span></p>
</div>
<div class="refsect1 description" id="refsect1-imagick.waveimage-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><strong>Imagick::waveImage</strong></span>
( <span class="methodparam"><span class="type">float</span> <code class="parameter">$amplitude</code></span>
, <span class="methodparam"><span class="type">float</span> <code class="parameter">$length</code></span>
)</div>
<p class="para rdfs-comment">
Applies a wave filter to the image.
This method is available if Imagick has been compiled against ImageMagick version 6.2.9 or newer.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-imagick.waveimage-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<code class="parameter">amplitude</code></dt>
<dd>
<p class="para">
The amplitude of the wave.
</p>
</dd>
<dt>
<code class="parameter">length</code></dt>
<dd>
<p class="para">
The length of the wave.
</p>
</dd>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-imagick.waveimage-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <strong><code>TRUE</code></strong> on success.
</p>
</div>
<div class="refsect1 errors" id="refsect1-imagick.waveimage-errors">
<h3 class="title">Errors/Exceptions</h3>
<p class="para">
Throws ImagickException on error.
</p>
</div>
<div class="refsect1 seealso" id="refsect1-imagick.waveimage-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"><span class="function"><a href="imagick.solarizeimage.html" class="function" rel="rdfs-seeAlso">Imagick::solarizeImage()</a> - Applies a solarizing effect to the image</span></li>
<li class="member"><span class="function"><a href="imagick.oilpaintimage.html" class="function" rel="rdfs-seeAlso">Imagick::oilpaintImage()</a> - Simulates an oil painting</span></li>
<li class="member"><span class="function"><a href="imagick.embossimage.html" class="function" rel="rdfs-seeAlso">Imagick::embossImage()</a> - Returns a grayscale image with a three-dimensional effect</span></li>
<li class="member"><span class="function"><a href="imagick.addnoiseimage.html" class="function" rel="rdfs-seeAlso">Imagick::addNoiseImage()</a> - Adds random noise to the image</span></li>
<li class="member"><span class="function"><a href="imagick.swirlimage.html" class="function" rel="rdfs-seeAlso">Imagick::swirlImage()</a> - Swirls the pixels about the center of the image</span></li>
</ul>
</p>
</div>
<div class="refsect1 examples" id="refsect1-imagick.waveimage-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-4058">
<p><strong>Example #1 WaveImage can be quite slow <span class="function"><strong>Imagick::waveImage()</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: #007700">function </span><span style="color: #0000BB">waveImage</span><span style="color: #007700">(</span><span style="color: #0000BB">$imagePath</span><span style="color: #007700">, </span><span style="color: #0000BB">$amplitude</span><span style="color: #007700">, </span><span style="color: #0000BB">$length</span><span style="color: #007700">) {<br /> </span><span style="color: #0000BB">$imagick </span><span style="color: #007700">= new \</span><span style="color: #0000BB">Imagick</span><span style="color: #007700">(</span><span style="color: #0000BB">realpath</span><span style="color: #007700">(</span><span style="color: #0000BB">$imagePath</span><span style="color: #007700">));<br /> </span><span style="color: #0000BB">$imagick</span><span style="color: #007700">-></span><span style="color: #0000BB">waveImage</span><span style="color: #007700">(</span><span style="color: #0000BB">$amplitude</span><span style="color: #007700">, </span><span style="color: #0000BB">$length</span><span style="color: #007700">);<br /> </span><span style="color: #0000BB">header</span><span style="color: #007700">(</span><span style="color: #DD0000">"Content-Type: image/jpg"</span><span style="color: #007700">);<br /> echo </span><span style="color: #0000BB">$imagick</span><span style="color: #007700">-></span><span style="color: #0000BB">getImageBlob</span><span style="color: #007700">();<br />}<br /><br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="imagick.vignetteimage.html">Imagick::vignetteImage</a></div>
<div class="next" style="text-align: right; float: right;"><a href="imagick.whitethresholdimage.html">Imagick::whiteThresholdImage</a></div>
<div class="up"><a href="class.imagick.html">Imagick</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
