<!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>Compares an image to a reconstructed image</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="imagick.compareimagelayers.html">Imagick::compareImageLayers</a></div>
<div class="next" style="text-align: right; float: right;"><a href="imagick.compositeimage.html">Imagick::compositeImage</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.compareimages" class="refentry">
<div class="refnamediv">
<h1 class="refname">Imagick::compareImages</h1>
<p class="verinfo">(PECL imagick 2.0.0)</p><p class="refpurpose"><span class="refname">Imagick::compareImages</span> — <span class="dc-title">Compares an image to a reconstructed image</span></p>
</div>
<div class="refsect1 description" id="refsect1-imagick.compareimages-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">array</span> <span class="methodname"><strong>Imagick::compareImages</strong></span>
( <span class="methodparam"><span class="type"><a href="class.imagick.html" class="type Imagick">Imagick</a></span> <code class="parameter">$compare</code></span>
, <span class="methodparam"><span class="type">int</span> <code class="parameter">$metric</code></span>
)</div>
<p class="para rdfs-comment">
Returns an array containing a reconstructed image and the difference between images.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-imagick.compareimages-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">compare</code></em></span>
<dd>
<p class="para">
An image to compare to.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">metric</code></em></span>
<dd>
<p class="para">
Provide a valid metric type constant. Refer to this
list of <a href="imagick.constants.html#imagick.constants.metric" class="link">metric constants</a>.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-imagick.compareimages-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <strong><code>TRUE</code></strong> on success.
</p>
</div>
<div class="refsect1 errors" id="refsect1-imagick.compareimages-errors">
<h3 class="title">Errors/Exceptions</h3>
<p class="para">
Throws ImagickException on error.
</p>
</div>
<div class="refsect1 examples" id="refsect1-imagick.compareimages-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-3317">
<p><strong>Example #1 Using <span class="function"><strong>Imagick::compareImages()</strong></span>:</strong></p>
<div class="example-contents"><p>
Compare images and display the reconstructed image
</p></div>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /><br />$image1 </span><span style="color: #007700">= new </span><span style="color: #0000BB">imagick</span><span style="color: #007700">(</span><span style="color: #DD0000">"image1.png"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$image2 </span><span style="color: #007700">= new </span><span style="color: #0000BB">imagick</span><span style="color: #007700">(</span><span style="color: #DD0000">"image2.png"</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$result </span><span style="color: #007700">= </span><span style="color: #0000BB">$image1</span><span style="color: #007700">-></span><span style="color: #0000BB">compareImages</span><span style="color: #007700">(</span><span style="color: #0000BB">$image2</span><span style="color: #007700">, </span><span style="color: #0000BB">Imagick</span><span style="color: #007700">::</span><span style="color: #0000BB">METRIC_MEANSQUAREERROR</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$result</span><span style="color: #007700">[</span><span style="color: #0000BB">0</span><span style="color: #007700">]-></span><span style="color: #0000BB">setImageFormat</span><span style="color: #007700">(</span><span style="color: #DD0000">"png"</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">header</span><span style="color: #007700">(</span><span style="color: #DD0000">"Content-Type: image/png"</span><span style="color: #007700">);<br />echo </span><span style="color: #0000BB">$result</span><span style="color: #007700">[</span><span style="color: #0000BB">0</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.compareimagelayers.html">Imagick::compareImageLayers</a></div>
<div class="next" style="text-align: right; float: right;"><a href="imagick.compositeimage.html">Imagick::compositeImage</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>
