<!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>Description</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="imagick.extentimage.html">Imagick::extentImage</a></div>
<div class="next" style="text-align: right; float: right;"><a href="imagick.flattenimages.html">Imagick::flattenImages</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.filter" class="refentry">
<div class="refnamediv">
<h1 class="refname">Imagick::filter</h1>
<p class="verinfo">(No version information available, might only be in Git)</p><p class="refpurpose"><span class="refname">Imagick::filter</span> — <span class="dc-title">Description</span></p>
</div>
<div class="refsect1 description" id="refsect1-imagick.filter-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><strong>Imagick::filter</strong></span>
( <span class="methodparam"><span class="type"><a href="class.imagickkernel.html" class="type ImagickKernel">ImagickKernel</a></span> <code class="parameter">$ImagickKernel</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$channel</code><span class="initializer"> = Imagick::CHANNEL_UNDEFINED</span></span>
] )</div>
<p class="para rdfs-comment">
Applies a custom convolution kernel to the image.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-imagick.filter-parameters">
<h3 class="title">Parameters</h3>
<dl>
<dt>
<code class="parameter">ImagickKernel</code></dt>
<dd>
<p class="para">
An instance of ImagickKernel that represents either a single kernel or a linked series of kernels.
</p>
</dd>
<dt>
<code class="parameter">channel</code></dt>
<dd>
<p class="para">
Provide any channel constant that is valid for your channel mode. To apply to more than one channel, combine <a href="imagick.constants.html#imagick.constants.channel" class="link">channel constants</a> using bitwise operators. Defaults to <strong><code>Imagick::CHANNEL_DEFAULT</code></strong>. Refer to this list of <a href="imagick.constants.html#imagick.constants.channel" class="link">channel constants</a>
</p>
</dd>
</dl>
</div>
<div class="refsect1 returnvalues" id="refsect1-imagick.filter-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <strong><code>TRUE</code></strong> on success.
</p>
</div>
<div class="refsect1 examples" id="refsect1-imagick.filter-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-3912">
<p><strong>Example #1 <span class="function"><strong>Imagick::filter()</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">filter</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">= 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">$matrix </span><span style="color: #007700">= [<br /> [-</span><span style="color: #0000BB">1</span><span style="color: #007700">, </span><span style="color: #0000BB">0</span><span style="color: #007700">, -</span><span style="color: #0000BB">1</span><span style="color: #007700">],<br /> [</span><span style="color: #0000BB">0</span><span style="color: #007700">, </span><span style="color: #0000BB">5</span><span style="color: #007700">, </span><span style="color: #0000BB">0</span><span style="color: #007700">],<br /> [-</span><span style="color: #0000BB">1</span><span style="color: #007700">, </span><span style="color: #0000BB">0</span><span style="color: #007700">, -</span><span style="color: #0000BB">1</span><span style="color: #007700">],<br /> ];<br /> <br /> </span><span style="color: #0000BB">$kernel </span><span style="color: #007700">= \</span><span style="color: #0000BB">ImagickKernel</span><span style="color: #007700">::</span><span style="color: #0000BB">fromMatrix</span><span style="color: #007700">(</span><span style="color: #0000BB">$matrix</span><span style="color: #007700">);<br /> </span><span style="color: #0000BB">$strength </span><span style="color: #007700">= </span><span style="color: #0000BB">0.5</span><span style="color: #007700">; <br /> </span><span style="color: #0000BB">$kernel</span><span style="color: #007700">-></span><span style="color: #0000BB">scale</span><span style="color: #007700">(</span><span style="color: #0000BB">$strength</span><span style="color: #007700">, \</span><span style="color: #0000BB">Imagick</span><span style="color: #007700">::</span><span style="color: #0000BB">NORMALIZE_KERNEL_VALUE</span><span style="color: #007700">); <br /> </span><span style="color: #0000BB">$kernel</span><span style="color: #007700">-></span><span style="color: #0000BB">addUnityKernel</span><span style="color: #007700">(</span><span style="color: #0000BB">1 </span><span style="color: #007700">- </span><span style="color: #0000BB">$strength</span><span style="color: #007700">);<br /><br /> </span><span style="color: #0000BB">$imagick</span><span style="color: #007700">-></span><span style="color: #0000BB">filter</span><span style="color: #007700">(</span><span style="color: #0000BB">$kernel</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.extentimage.html">Imagick::extentImage</a></div>
<div class="next" style="text-align: right; float: right;"><a href="imagick.flattenimages.html">Imagick::flattenImages</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>
