<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/class.imagick.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'en',
  ),
  'this' => 
  array (
    0 => 'imagick.trimimage.php',
    1 => 'Imagick::trimImage',
    2 => 'Remove edges from the image',
  ),
  'up' => 
  array (
    0 => 'class.imagick.php',
    1 => 'Imagick',
  ),
  'prev' => 
  array (
    0 => 'imagick.transverseimage.php',
    1 => 'Imagick::transverseImage',
  ),
  'next' => 
  array (
    0 => 'imagick.uniqueimagecolors.php',
    1 => 'Imagick::uniqueImageColors',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'en',
    'path' => 'reference/imagick/imagick/trimimage.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="imagick.trimimage" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">Imagick::trimImage</h1>
  <p class="verinfo">(PECL imagick 2, PECL imagick 3)</p><p class="refpurpose"><span class="refname">Imagick::trimImage</span> &mdash; <span class="dc-title">Remove edges from the image</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-imagick.trimimage-description">
  <h3 class="title">Description</h3>
  <div class="methodsynopsis dc-description">
   <span class="modifier">public</span> <span class="methodname"><strong>Imagick::trimImage</strong></span>(<span class="methodparam"><span class="type"><a href="language.types.float.php" class="type float">float</a></span> <code class="parameter">$fuzz</code></span>): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>


  <p class="para rdfs-comment">
   Remove edges that are the background color from 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.trimimage-parameters">
  <h3 class="title">Parameters</h3>
  <p class="para">
   <dl>
    
     <dt><code class="parameter">fuzz</code></dt>
     <dd>
      <p class="para">
       By default target must match a particular pixel color exactly.
       However, in many cases two colors may differ by a small amount.
       The fuzz member of image defines how much tolerance is acceptable
       to consider two colors as the same. This parameter represents the variation
       on the quantum range.
      </p>
     </dd>
    
   </dl>
  </p>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-imagick.trimimage-returnvalues">
  <h3 class="title">Return Values</h3>
  <p class="para">
   Returns <strong><code><a href="reserved.constants.php#constant.true">true</a></code></strong> on success.
  </p>
 </div>


 <div class="refsect1 errors" id="refsect1-imagick.trimimage-errors">
  <h3 class="title">Errors/Exceptions</h3>
  <p class="para">
   Throws ImagickException on error.
  </p>
 </div>


  <div class="refsect1 examples" id="refsect1-imagick.trimimage-examples">
  <h3 class="title">Examples</h3>
  <p class="para">
   <div class="example" id="example-1">
    <p><strong>Example #1 Using <span class="function"><strong>Imagick::trimImage()</strong></span>:</strong></p>
    <div class="example-contents"><p>
     Trim 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">&lt;?php<br /></span><span style="color: #FF8000">/* Create the object and read the image in */<br /></span><span style="color: #0000BB">$im </span><span style="color: #007700">= new </span><span style="color: #0000BB">Imagick</span><span style="color: #007700">(</span><span style="color: #DD0000">"image.jpg"</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">/* Trim the image. */<br /></span><span style="color: #0000BB">$im</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">trimImage</span><span style="color: #007700">(</span><span style="color: #0000BB">0</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">/* Ouput the image */<br /></span><span style="color: #0000BB">header</span><span style="color: #007700">(</span><span style="color: #DD0000">"Content-Type: image/" </span><span style="color: #007700">. </span><span style="color: #0000BB">$im</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">getImageFormat</span><span style="color: #007700">());<br />echo </span><span style="color: #0000BB">$im</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
    </div>

   </div>
  </p>
 </div>


 <div class="refsect1 seealso" id="refsect1-imagick.trimimage-seealso">
  <h3 class="title">See Also</h3>
  <p class="para">
   <ul class="simplelist">
    <li><span class="function"><a href="imagick.getquantumdepth.php" class="function" rel="rdfs-seeAlso">Imagick::getQuantumDepth()</a> - Gets the quantum depth</span></li>
    <li><span class="function"><a href="imagick.getquantumrange.php" class="function" rel="rdfs-seeAlso">Imagick::getQuantumRange()</a> - Returns the Imagick quantum range</span></li>
    <li><span class="function"><a href="function.imagecropauto.php" class="function" rel="rdfs-seeAlso">imagecropauto()</a> - Crop an image automatically using one of the available modes</span></li>
   </ul>
  </p>
 </div>


</div><?php manual_footer($setup); ?>