<!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>Gets channel distortions</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="imagick.getimagechanneldistortion.html">Imagick::getImageChannelDistortion</a></div>
<div class="next" style="text-align: right; float: right;"><a href="imagick.getimagechannelextrema.html">Imagick::getImageChannelExtrema</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.getimagechanneldistortions" class="refentry">
<div class="refnamediv">
<h1 class="refname">Imagick::getImageChannelDistortions</h1>
<p class="verinfo">(No version information available, might only be in SVN)</p><p class="refpurpose"><span class="refname">Imagick::getImageChannelDistortions</span> — <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="type">float</span> <span class="methodname"><strong>Imagick::getImageChannelDistortions</strong></span>
( <span class="methodparam"><span class="type"><a href="class.imagick.html" class="type Imagick">Imagick</a></span> <code class="parameter">$reference</code></span>
, <span class="methodparam"><span class="type">int</span> <code class="parameter">$metric</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$channel</code><span class="initializer"> = Imagick::CHANNEL_DEFAULT</span></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>
<span class="term"><em><code class="parameter">reference</code></em></span>
<dd>
<p class="para">
Imagick object containing the reference image
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">metric</code></em></span>
<dd>
<p class="para">
Refer to this list of <a href="imagick.constants.html#imagick.constants.metric" class="link">metric type constants</a>.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">channel</code></em></span>
<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.html#imagick.constants.channel" class="link">channel constants</a> using bitwise operators. Defaults to <strong><code>Imagick::CHANNEL_DEFAULT</code></strong>. Refer to this list of <a href="imagick.constants.html#imagick.constants.channel" class="link">channel constants</a>
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-imagick.getimagechanneldistortions-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns a double 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><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="imagick.getimagechanneldistortion.html">Imagick::getImageChannelDistortion</a></div>
<div class="next" style="text-align: right; float: right;"><a href="imagick.getimagechannelextrema.html">Imagick::getImageChannelExtrema</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>
