<!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="imagickkernel.frommatrix.html">ImagickKernel::fromMatrix</a></div>
<div class="next" style="text-align: right; float: right;"><a href="imagickkernel.scale.html">ImagickKernel::scale</a></div>
<div class="up"><a href="class.imagickkernel.html">ImagickKernel</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="imagickkernel.getmatrix" class="refentry">
<div class="refnamediv">
<h1 class="refname">ImagickKernel::getMatrix</h1>
<p class="verinfo">(PECL imagick >= 3.3.0)</p><p class="refpurpose"><span class="refname">ImagickKernel::getMatrix</span> — <span class="dc-title">Description</span></p>
</div>
<div class="refsect1 description" id="refsect1-imagickkernel.getmatrix-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">array</span> <span class="methodname"><strong>ImagickKernel::getMatrix</strong></span>
( <span class="methodparam">void</span>
)</div>
<p class="para rdfs-comment">
Get the 2d matrix of values used in this kernel. The elements are either
float for elements that are used or 'false' if the element should be skipped.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-imagickkernel.getmatrix-parameters">
<h3 class="title">Parameters</h3>
<p class="para">This function has no parameters.</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-imagickkernel.getmatrix-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
A matrix (2d array) of the values that represent the kernel.
</p>
</div>
<div class="refsect1 examples" id="refsect1-imagickkernel.getmatrix-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-4137">
<p><strong>Example #1 <span class="function"><strong>ImagickKernel::getMatrix()</strong></span></strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /><br /><br /></span><span style="color: #007700">function </span><span style="color: #0000BB">renderKernelTable</span><span style="color: #007700">(</span><span style="color: #0000BB">$matrix</span><span style="color: #007700">) {<br /> </span><span style="color: #0000BB">$output </span><span style="color: #007700">= </span><span style="color: #DD0000">"<table class='infoTable'>"</span><span style="color: #007700">;<br /><br /> foreach (</span><span style="color: #0000BB">$matrix </span><span style="color: #007700">as </span><span style="color: #0000BB">$row</span><span style="color: #007700">) {<br /> </span><span style="color: #0000BB">$output </span><span style="color: #007700">.= </span><span style="color: #DD0000">"<tr>"</span><span style="color: #007700">;<br /> foreach (</span><span style="color: #0000BB">$row </span><span style="color: #007700">as </span><span style="color: #0000BB">$cell</span><span style="color: #007700">) {<br /> </span><span style="color: #0000BB">$output </span><span style="color: #007700">.= </span><span style="color: #DD0000">"<td style='text-align:left'>"</span><span style="color: #007700">;<br /> if (</span><span style="color: #0000BB">$cell </span><span style="color: #007700">=== </span><span style="color: #0000BB">false</span><span style="color: #007700">) {<br /> </span><span style="color: #0000BB">$output </span><span style="color: #007700">.= </span><span style="color: #DD0000">"false"</span><span style="color: #007700">;<br /> }<br /> else {<br /> </span><span style="color: #0000BB">$output </span><span style="color: #007700">.= </span><span style="color: #0000BB">round</span><span style="color: #007700">(</span><span style="color: #0000BB">$cell</span><span style="color: #007700">, </span><span style="color: #0000BB">3</span><span style="color: #007700">);<br /> }<br /> </span><span style="color: #0000BB">$output </span><span style="color: #007700">.= </span><span style="color: #DD0000">"</td>"</span><span style="color: #007700">;<br /> }<br /> </span><span style="color: #0000BB">$output </span><span style="color: #007700">.= </span><span style="color: #DD0000">"</tr>"</span><span style="color: #007700">;<br /> }<br /><br /> </span><span style="color: #0000BB">$output </span><span style="color: #007700">.= </span><span style="color: #DD0000">"</table>"</span><span style="color: #007700">;<br /><br /> return </span><span style="color: #0000BB">$output</span><span style="color: #007700">;<br />}<br /><br /> </span><span style="color: #0000BB">$output </span><span style="color: #007700">= </span><span style="color: #DD0000">"The built-in kernel name 'ring' with parameters of '2,3.5':<br/>"</span><span style="color: #007700">;<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">fromBuiltIn</span><span style="color: #007700">(<br /> \</span><span style="color: #0000BB">Imagick</span><span style="color: #007700">::</span><span style="color: #0000BB">KERNEL_RING</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">"2,3.5"<br /> </span><span style="color: #007700">);<br /> </span><span style="color: #0000BB">$matrix </span><span style="color: #007700">= </span><span style="color: #0000BB">$kernel</span><span style="color: #007700">-></span><span style="color: #0000BB">getMatrix</span><span style="color: #007700">();<br /> </span><span style="color: #0000BB">$output </span><span style="color: #007700">.= </span><span style="color: #0000BB">renderKernelTable</span><span style="color: #007700">(</span><span style="color: #0000BB">$matrix</span><span style="color: #007700">);<br /><br /> echo </span><span style="color: #0000BB">$output</span><span style="color: #007700">;<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="imagickkernel.frommatrix.html">ImagickKernel::fromMatrix</a></div>
<div class="next" style="text-align: right; float: right;"><a href="imagickkernel.scale.html">ImagickKernel::scale</a></div>
<div class="up"><a href="class.imagickkernel.html">ImagickKernel</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
