<!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>Adds blur filter to image</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="imagick.blackthresholdimage.html">Imagick::blackThresholdImage</a></div>
<div class="next" style="text-align: right; float: right;"><a href="imagick.borderimage.html">Imagick::borderImage</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.blurimage" class="refentry">
<div class="refnamediv">
<h1 class="refname">Imagick::blurImage</h1>
<p class="verinfo">(PECL imagick 2.0.0)</p><p class="refpurpose"><span class="refname">Imagick::blurImage</span> — <span class="dc-title">Adds blur filter to image</span></p>
</div>
<div class="refsect1 description" id="refsect1-imagick.blurimage-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><strong>Imagick::blurImage</strong></span>
( <span class="methodparam"><span class="type">float</span> <code class="parameter">$radius</code></span>
, <span class="methodparam"><span class="type">float</span> <code class="parameter">$sigma</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$channel</code></span>
] )</div>
<p class="para rdfs-comment">
Adds blur filter to image. Optional third parameter to blur a specific
channel.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-imagick.blurimage-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">radius</code></em></span>
<dd>
<p class="para">
Blur radius
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">sigma</code></em></span>
<dd>
<p class="para">
Standard deviation
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">channel</code></em></span>
<dd>
<p class="para">
The <a href="imagick.constants.html#imagick.constants.channel" class="link">Channeltype</a>
constant. When not supplied, all channels are blurred.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-imagick.blurimage-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.blurimage-errors">
<h3 class="title">Errors/Exceptions</h3>
<p class="para">
Throws ImagickException on error.
</p>
</div>
<div class="refsect1 examples" id="refsect1-imagick.blurimage-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-3311">
<p><strong>Example #1 Using <span class="function"><strong>Imagick::blurImage()</strong></span>:</strong></p>
<div class="example-contents"><p>
Blur an image, then display to the browser.
</p></div>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /><br />header</span><span style="color: #007700">(</span><span style="color: #DD0000">'Content-type: image/jpeg'</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$image </span><span style="color: #007700">= new </span><span style="color: #0000BB">Imagick</span><span style="color: #007700">(</span><span style="color: #DD0000">'test.jpg'</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$image</span><span style="color: #007700">-></span><span style="color: #0000BB">blurImage</span><span style="color: #007700">(</span><span style="color: #0000BB">5</span><span style="color: #007700">,</span><span style="color: #0000BB">3</span><span style="color: #007700">);<br />echo </span><span style="color: #0000BB">$image</span><span style="color: #007700">;<br /><br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-imagick.blurimage-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="imagick.adaptiveblurimage.html" class="function" rel="rdfs-seeAlso">Imagick::adaptiveBlurImage()</a> - Adds adaptive blur filter to image</span></li>
<li class="member"> <span class="function"><a href="imagick.motionblurimage.html" class="function" rel="rdfs-seeAlso">Imagick::motionBlurImage()</a> - Simulates motion blur</span></li>
<li class="member"> <span class="function"><a href="imagick.radialblurimage.html" class="function" rel="rdfs-seeAlso">Imagick::radialBlurImage()</a> - Radial blurs an image</span></li>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="imagick.blackthresholdimage.html">Imagick::blackThresholdImage</a></div>
<div class="next" style="text-align: right; float: right;"><a href="imagick.borderimage.html">Imagick::borderImage</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>
