<!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>Segments an image</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="imagick.scaleimage.html">Imagick::scaleImage</a></div>
<div class="next" style="text-align: right; float: right;"><a href="imagick.selectiveblurimage.html">Imagick::selectiveBlurImage</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.segmentimage" class="refentry">
<div class="refnamediv">
<h1 class="refname">Imagick::segmentImage</h1>
<p class="verinfo">(No version information available, might only be in Git)</p><p class="refpurpose"><span class="refname">Imagick::segmentImage</span> — <span class="dc-title">Segments an image</span></p>
</div>
<div class="refsect1 description" id="refsect1-imagick.segmentimage-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::segmentImage</strong></span>
( <span class="methodparam"><span class="type">int</span> <code class="parameter">$COLORSPACE</code></span>
, <span class="methodparam"><span class="type">float</span> <code class="parameter">$cluster_threshold</code></span>
, <span class="methodparam"><span class="type">float</span> <code class="parameter">$smooth_threshold</code></span>
[, <span class="methodparam"><span class="type">bool</span> <code class="parameter">$verbose</code><span class="initializer"> = <strong><code>FALSE</code></strong></span></span>
] )</div>
<p class="para rdfs-comment">
Analyses the image and identifies units that are similar. This method is available if Imagick has been compiled against ImageMagick version 6.4.5 or newer.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-imagick.segmentimage-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<code class="parameter">COLORSPACE</code></dt>
<dd>
<p class="para">
One of the <a href="imagick.constants.html#imagick.constants.colorspace" class="link">COLORSPACE constants</a>.
</p>
</dd>
<dt>
<code class="parameter">cluster_threshold</code></dt>
<dd>
<p class="para">
A percentage describing minimum number of pixels
contained in hexedra before it is considered valid.
</p>
</dd>
<dt>
<code class="parameter">smooth_threshold</code></dt>
<dd>
<p class="para">
Eliminates noise from the histogram.
</p>
</dd>
<dt>
<code class="parameter">verbose</code></dt>
<dd>
<p class="para">
Whether to output detailed information about recognised classes.
</p>
</dd>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-imagick.segmentimage-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
</p>
</div>
<div class="refsect1 examples" id="refsect1-imagick.segmentimage-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-3999">
<p><strong>Example #1 <span class="function"><strong>Imagick::segmentImage()</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">segmentImage</span><span style="color: #007700">(</span><span style="color: #0000BB">$imagePath</span><span style="color: #007700">, </span><span style="color: #0000BB">$colorSpace</span><span style="color: #007700">, </span><span style="color: #0000BB">$clusterThreshold</span><span style="color: #007700">, </span><span style="color: #0000BB">$smoothThreshold</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">segmentImage</span><span style="color: #007700">(</span><span style="color: #0000BB">$colorSpace</span><span style="color: #007700">, </span><span style="color: #0000BB">$clusterThreshold</span><span style="color: #007700">, </span><span style="color: #0000BB">$smoothThreshold</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">segmentImage</span><span style="color: #007700">(</span><span style="color: #0000BB">$imagePath</span><span style="color: #007700">, \</span><span style="color: #0000BB">Imagick</span><span style="color: #007700">::</span><span style="color: #0000BB">COLORSPACE_RGB</span><span style="color: #007700">, </span><span style="color: #0000BB">5</span><span style="color: #007700">, </span><span style="color: #0000BB">5</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="imagick.scaleimage.html">Imagick::scaleImage</a></div>
<div class="next" style="text-align: right; float: right;"><a href="imagick.selectiveblurimage.html">Imagick::selectiveBlurImage</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>
