<?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.getimagechanneldistortions.php',
    1 => 'Imagick::getImageChannelDistortions',
    2 => 'Gets channel distortions',
  ),
  'up' => 
  array (
    0 => 'class.imagick.php',
    1 => 'Imagick',
  ),
  'prev' => 
  array (
    0 => 'imagick.getimagechanneldistortion.php',
    1 => 'Imagick::getImageChannelDistortion',
  ),
  'next' => 
  array (
    0 => 'imagick.getimagechannelextrema.php',
    1 => 'Imagick::getImageChannelExtrema',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'en',
    'path' => 'reference/imagick/imagick/getimagechanneldistortions.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="imagick.getimagechanneldistortions" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">Imagick::getImageChannelDistortions</h1>
  <p class="verinfo">(PECL imagick 2 &gt;= 2.3.0, PECL imagick 3)</p><p class="refpurpose"><span class="refname">Imagick::getImageChannelDistortions</span> &mdash; <span class="dc-title">Gets channel distortions</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-imagick.getimagechanneldistortions-description">
  <h3 class="title">Description</h3>
  <div class="methodsynopsis dc-description">
   <span class="modifier">public</span> <span class="methodname"><strong>Imagick::getImageChannelDistortions</strong></span>(<span class="methodparam"><span class="type"><a href="class.imagick.php" class="type Imagick">Imagick</a></span> <code class="parameter">$reference</code></span>, <span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$metric</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.float.php" class="type float">float</a></span></div>


  <p class="para rdfs-comment">
   Compares one or more image channels of an image to a reconstructed image and returns the specified distortion metrics
   This method is available if Imagick has been compiled against ImageMagick version 6.4.4 or newer.
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-imagick.getimagechanneldistortions-parameters">
  <h3 class="title">Parameters</h3>
  <p class="para">
   <dl>
    
     <dt><code class="parameter">reference</code></dt>
     <dd>
      <p class="para">
       Imagick object containing the reference image
      </p>
     </dd>
    
    
     <dt><code class="parameter">metric</code></dt>
     <dd>
      <p class="para">
       Refer to this list of <a href="imagick.constants.php#imagick.constants.metric" class="link">metric type constants</a>.
      </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.php#imagick.constants.channel" class="link">channel constants</a> using bitwise operators. Defaults to <strong><code><a href="imagick.constants.php#imagick.constants.channel-default">Imagick::CHANNEL_DEFAULT</a></code></strong>. Refer to this list of <a href="imagick.constants.php#imagick.constants.channel" class="link">channel constants</a>
      </p>
     </dd>
    
   </dl>
  </p>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-imagick.getimagechanneldistortions-returnvalues">
  <h3 class="title">Return Values</h3>
  <p class="para">
   Returns a <span class="type"><a href="language.types.float.php" class="type float">float</a></span> describing the channel distortion.
  </p>
 </div>


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


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