<?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.clutimage.php',
    1 => 'Imagick::clutImage',
    2 => 'Replaces colors in the image',
  ),
  'up' => 
  array (
    0 => 'class.imagick.php',
    1 => 'Imagick',
  ),
  'prev' => 
  array (
    0 => 'imagick.clone.php',
    1 => 'Imagick::clone',
  ),
  'next' => 
  array (
    0 => 'imagick.coalesceimages.php',
    1 => 'Imagick::coalesceImages',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'en',
    'path' => 'reference/imagick/imagick/clutimage.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="imagick.clutimage" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">Imagick::clutImage</h1>
  <p class="verinfo">(PECL imagick 2, PECL imagick 3)</p><p class="refpurpose"><span class="refname">Imagick::clutImage</span> &mdash; <span class="dc-title">Replaces colors in the image</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-imagick.clutimage-description">
  <h3 class="title">Description</h3>
  <div class="methodsynopsis dc-description">
   <span class="modifier">public</span> <span class="methodname"><strong>Imagick::clutImage</strong></span>(<span class="methodparam"><span class="type"><a href="class.imagick.php" class="type Imagick">Imagick</a></span> <code class="parameter">$lookup_table</code></span>, <span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$channel</code><span class="initializer"> = Imagick::CHANNEL_DEFAULT</span></span>): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>


  <p class="para rdfs-comment">
   Replaces colors in the image from a color lookup table. Optional second
   parameter to replace colors in a specific channel. This method is available if Imagick has been compiled against ImageMagick version 6.3.6 or newer.
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-imagick.clutimage-parameters">
  <h3 class="title">Parameters</h3>
  <p class="para">
   <dl>
    
     <dt><code class="parameter">lookup_table</code></dt>
     <dd>
      <p class="para">
       Imagick object containing the color lookup table
      </p>
     </dd>
    
    
     <dt><code class="parameter">channel</code></dt>
     <dd>
      <p class="para">
       The <a href="imagick.constants.php#imagick.constants.channel" class="link">Channeltype</a>
       constant. When not supplied, default channels are replaced.
      </p>
     </dd>
    
   </dl>
  </p>

 </div>

 <div class="refsect1 returnvalues" id="refsect1-imagick.clutimage-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 examples" id="refsect1-imagick.clutimage-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::clutImage()</strong></span>:</strong></p>
    <div class="example-contents"><p>
     Replace colors in the image from a color lookup table.
    </p></div>
    <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br />$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 /></span><span style="color: #0000BB">$clut </span><span style="color: #007700">= new </span><span style="color: #0000BB">Imagick</span><span style="color: #007700">();<br /></span><span style="color: #0000BB">$clut</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">newImage</span><span style="color: #007700">(</span><span style="color: #0000BB">1</span><span style="color: #007700">, </span><span style="color: #0000BB">1</span><span style="color: #007700">, new </span><span style="color: #0000BB">ImagickPixel</span><span style="color: #007700">(</span><span style="color: #DD0000">'black'</span><span style="color: #007700">));<br /></span><span style="color: #0000BB">$image</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">clutImage</span><span style="color: #007700">(</span><span style="color: #0000BB">$clut</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$image</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">writeImage</span><span style="color: #007700">(</span><span style="color: #DD0000">'test_out.jpg'</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.clutimage-seealso">
  <h3 class="title">See Also</h3>
  <p class="para">
   <ul class="simplelist">
    <li><span class="function"><a href="imagick.adaptiveblurimage.php" class="function" rel="rdfs-seeAlso">Imagick::adaptiveBlurImage()</a> - Adds adaptive blur filter to image</span></li>
    <li><span class="function"><a href="imagick.motionblurimage.php" class="function" rel="rdfs-seeAlso">Imagick::motionBlurImage()</a> - Simulates motion blur</span></li>
    <li><span class="function"><a href="imagick.radialblurimage.php" class="function" rel="rdfs-seeAlso">Imagick::radialBlurImage()</a> - Radial blurs an image</span></li>
   </ul>
  </p>
 </div>


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