PageRenderTime 50ms CodeModel.GetById 23ms RepoModel.GetById 1ms app.codeStats 0ms

/branches/ImageMagick-6.5.9/www/api/compare.html

https://github.com/trevor/ImageMagick
HTML | 338 lines | 273 code | 63 blank | 2 comment | 0 complexity | 5cb9721a65dc8fc955bf023cc9915ce5 MD5 | raw file
    

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"

    2. 

  2.     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">

    3. 

  3. <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">

    4. 

  4. <head>

    5. 

  5.   <meta http-equiv="Content-Type" value="application/xhtml+xml" />

    6. 

  6.   <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U=" />

    7. 

  7.   <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf" />

    8. 

  8.   <style type="text/css" media="screen,projection"><!--

    9. 

  9.     @import url("../../www/magick.css");

    10. 

  10.   --></style>

    11. 

  11.   <link rel="shortcut icon" href="../../images/wand.ico"  type="images/vnd.microsoft.icon"/>
    12. 

  12.   <title>ImageMagick: MagickCore, C API for ImageMagick: Compare an Image to a Reconstructed Image</title>
    13. 

  13.   <meta http-equiv="Content-Language" content="en-US"/>
    14. 

  14.   <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
    15. 

  15.   <meta http-equiv="Reply-to" content="magick-users@imagemagick.org"/>
    16. 

  16.   <meta name="Generator" content="PHP"/>
    17. 

  17.   <meta name="Keywords" content="magickcore, c, api, for, imagemagick:, compare, an, image, to, a, reconstructed, image, ImageMagick, ImageMagic, MagickCore, MagickWand, PerlMagick, Magick++, RMagick, PythonMagick, JMagick, TclMagick, Image, Magick, Magic, Wand, ImageMagickObject, Swiss, Army, Knife, Image, Processing"/>
    18. 

  18.   <meta name="Description" content="ImageMagick® is a software suite to create, edit, and compose bitmap images. It can read, convert and write images in a variety of formats (about 100) including GIF, JPEG, JPEG-2000, PNG, PDF, PhotoCD, TIFF, and DPX. Use ImageMagick to translate, flip, mirror, rotate, scale, shear and transform images, adjust image colors, apply various special effects, or draw text, lines, polygons, ellipses and Bézier curves.  ImageMagick is free software delivered as a ready-to-run binary distribution or as source code that you can freely use, copy, modify, and distribute. Its license is compatible with the GPL. It runs on all major operating systems.  The functionality of ImageMagick is typically utilized from the command line or you can use the features from programs written in your favorite programming language. Choose from these interfaces: MagickCore (C), MagickWand (C), ChMagick (Ch), Magick++ (C++), JMagick (Java), L-Magick (Lisp), PascalMagick (Pascal), PerlMagick (Perl), MagickWand for PHP (PHP), PythonMagick (Python), RMagick (Ruby), or TclMagick (Tcl/TK). With a language interface, use ImageMagick to modify or create images automagically and dynamically."/>
    19. 

  19.   <meta name="Rating" content="GENERAL"/>
    20. 

  20.   <meta name="Robots" content="INDEX, FOLLOW"/>
    21. 

  21.   <meta name="Generator" content="ImageMagick Studio LLC"/>
    22. 

  22.   <meta name="Author" content="ImageMagick Studio LLC"/>
    23. 

  23.   <meta name="Revisit-after" content="2 DAYS"/>
    24. 

  24.   <meta name="Resource-type" content="document"/>
    25. 

  25.   <meta name="Copyright" content="Copyright (c) 1999-2010 ImageMagick Studio LLC"/>
    26. 

  26.   <meta name="Distribution" content="Global"/>
    27. 

  27. </head>

    28. 

  28. 

    29. 

  29. <body id="www-imagemagick-org">

    30. 

  30. <div class="titlebar">

    31. 

  31. <a href="../../index.html">

    32. 

  32.   <img src="../../images/script.png" alt="[ImageMagick]"

    33. 

  33.   style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>

    34. 

  34. <a href="http://www.networkredux.com">

    35. 

  35.   <img src="../../images/networkredux.png" alt="[sponsor]"

    36. 

  36.   style="margin: 45px auto; border: 0px; float: left;" /></a>

    37. 

  37. <a href="http://www.imagemagick.org/discourse-server/">

    38. 

  38.   <img src="../../images/logo.jpg" alt=""

    39. 

  39.   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>

    40. 

  40. <a href="../../index.html">

    41. 

  41.   <img src="../../images/sprite.jpg" alt=""

    42. 

  42.   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>

    43. 

  43. </div>

    44. 

  44. 

    45. 

  45. <div class="eastbar">

    46. 

  46. 

    47. 

  47. <div class="menu">
    48. 

  48.   <a href="../../index.html">About ImageMagick</a>
    49. 

  49. </div>
    50. 

  50. <div class="sep"></div>

    51. 

  51. <div class="menu">
    52. 

  52.   <a href="../../www/command-line-tools.html">Command-line Tools</a>
    53. 

  53. </div>
    54. 

  54. <div class="sub">
    55. 

  55.     <a href="../../www/command-line-processing.html">Processing</a>
    56. 

  56. </div>
    57. 

  57. <div class="sub">
    58. 

  58.     <a href="../../www/command-line-options.html">Options</a>
    59. 

  59. </div>
    60. 

  60. <div class="sub">
    61. 

  61.     <a href="http://www.imagemagick.org/Usage/">Usage</a>
    62. 

  62. </div>
    63. 

  63. <div class="menu">
    64. 

  64.   <a href="../../www/api.html">Program Interfaces</a>
    65. 

  65. </div>
    66. 

  66. <div class="sub">
    67. 

  67.     <a href="../../www/magick-wand.html">MagickWand</a>
    68. 

  68. </div>
    69. 

  69. <div class="sub">
    70. 

  70.     <a href="../../www/magick-core.html">MagickCore</a>
    71. 

  71. </div>
    72. 

  72. <div class="sub">
    73. 

  73.     <a href="../../www/perl-magick.html">PerlMagick</a>
    74. 

  74. </div>
    75. 

  75. <div class="sub">
    76. 

  76.     <a href="../../Magick++/">Magick++</a>
    77. 

  77. </div>
    78. 

  78. <div class="menu">
    79. 

  79.   <a href="../../www/architecture.html">Architecture</a>
    80. 

  80. </div>
    81. 

  81. <div class="sep"></div>

    82. 

  82. <div  class="menu">
    83. 

  83.    <a href="../../www/install-source.html">Install from Source</a>
    84. 

  84. </div>
    85. 

  85. <div class="sub">
    86. 

  86.     <a href="../../www/install-source.html#unix">Unix</a>
    87. 

  87. </div>
    88. 

  88. <div class="sub">
    89. 

  89.     <a href="../../www/install-source.html#windows">Windows</a>
    90. 

  90.  </div>
    91. 

  91. <div class="menu">
    92. 

  92.   <a href="../../www/binary-releases.html">Binary Releases</a>
    93. 

  93. </div>
    94. 

  94. <div class="sub">
    95. 

  95.     <a href="../../www/binary-releases.html#unix">Unix</a>
    96. 

  96. </div>
    97. 

  97. <div class="sub">
    98. 

  98.     <a href="../../www/binary-releases.html#macosx">Mac OS X</a>
    99. 

  99. </div>
    100. 

  100. <div class="sub">
    101. 

  101.     <a href="../../www/binary-releases.html#windows">Windows</a>
    102. 

  102. </div>
    103. 

  103. <div class="menu">
    104. 

  104.   <a href="../../www/resources.html">Resources</a>
    105. 

  105. </div>
    106. 

  106. <div class="sep"></div>

    107. 

  107. <div class="menu">
    108. 

  108.   <a href="../../www/download.html">Download</a>
    109. 

  109. </div>
    110. 

  110. <div class="sep"></div>

    111. 

  111. <div class="menu">
    112. 

  112.   <a href="../http://www.imagemagick.org/script/search.php">Search</a>
    113. 

  113. </div>
    114. 

  114. <div class="sep"></div>

    115. 

  115. <div class="menu">
    116. 

  116.   <a href="../../www/sitemap.html">Site Map</a>
    117. 

  117. </div>
    118. 

  118. <div  class="sub">
    119. 

  119.     <a href="../../www/links.html">Links</a>
    120. 

  120. </div>
    121. 

  121. <div class="sep"></div>

    122. 

  122. <div  class="menu">
    123. 

  123.   <a href="../../www/sponsors.html">Sponsors:</a>
    124. 

  124. 

  125. <div class="sponsbox">
    126. 

  126. <div  class="sponsor">
    127. 

  127.    <a href="http://www.abi-stoff.de/abizeitung/" title="Abibuch">Abizeitung</a><!-- 20101101000200 -->
    128. 

  128. </div>
    129. 

  129. <div  class="sponsor">
    130. 

  130.   <a href="http://www.tomsgutscheine.de">Tom's Gutscheine</a><!-- 201005010360 invendio.de-->
    131. 

  131. </div>
    132. 

  132. <div  class="sponsor">
    133. 

  133.   <a href="http://www.online-kredit-index.de">Kredit</a><!-- 201007010120 Buchhorn -->
    134. 

  134. </div>
    135. 

  135. <div  class="sponsor">
    136. 

  136.   <a href="http://www.blumenversender.com">Blumenversand</a><!-- 201005010120 -->
    137. 

  137. </div>
    138. 

  138. <div  class="sponsor">
    139. 

  139.   <a href="http://www.print24.de/">Druckerei</a><!-- 201009010720 -->
    140. 

  140. </div>
    141. 

  141. <div  class="sponsor">
    142. 

  142.    <a href="http://www.goyax.de">Börse</a><!-- 201004010240 Gewiese digital-finance.de -->
    143. 

  143. </div>
    144. 

  144. <div  class="sponsor">
    145. 

  145.    <a href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012011200 allesdruck.de-->
    146. 

  146. </div>
    147. 

  147. </div>
    148. 

  148. </div>
    149. 

  149. 

    150. 

  150. 

    151. 

  151. </div>

    152. 

  152. 

    153. 

  153. <div class="main">

    154. 

  154. 

    155. 

  155. <p class="navigation-index">[<a href="#CompareImageChannels">CompareImageChannels</a> &bull; <a href="#GetImageChannelDistortion">GetImageChannelDistortion</a> &bull; <a href="#GetImageChannelDistrortion">GetImageChannelDistrortion</a> &bull; <a href="#IsImagesEqual">IsImagesEqual</a> &bull; <a href="#SimilarityImage">SimilarityImage</a>]</p>
    156. 

  156. 

  157. <h2><a href="http://www.imagemagick.org/api/MagickCore/compare
    158. 

  158. _8c.html" target="source" name="CompareImageChannels">CompareImageChannels</a></h2>
    159. 

  159. <div class="doc-section">
    160. 

  160. 

  161. <p>CompareImageChannels() compares one or more image channels of an image to a reconstructed image and returns the difference image.</p></ol>
    162. 

  162. 

  163. <p>The format of the CompareImageChannels method is:</p>
    164. 

  164. 

  165. <pre class="code">
    166. 

  166.   Image *CompareImageChannels(const Image *image,
    167. 

  167.     const Image *reconstruct_image,const ChannelType channel,
    168. 

  168.     const MetricType metric,double *distortion,ExceptionInfo *exception)
    169. 

  169. </pre>
    170. 

  170. 

  171. <p>A description of each parameter follows:</p></ol>
    172. 

  172. 

  173. <h5>image</h5>
    174. 

  174. <ol><p>the image.</p></ol>
    175. 

  175. 

  176. <h5>reconstruct_image</h5>
    177. 

  177. <ol><p>the reconstruct image.</p></ol>
    178. 

  178. 

  179. <h5>channel</h5>
    180. 

  180. <ol><p>the channel.</p></ol>
    181. 

  181. 

  182. <h5>metric</h5>
    183. 

  183. <ol><p>the metric.</p></ol>
    184. 

  184. 

  185. <h5>distortion</h5>
    186. 

  186. <ol><p>the computed distortion between the images.</p></ol>
    187. 

  187. 

  188. <h5>exception</h5>
    189. 

  189. <ol><p>return any errors or warnings in this structure.</p></ol>
    190. 

  190. 

  191.  </div>
    192. 

  192. <h2><a href="http://www.imagemagick.org/api/MagickCore/compare
    193. 

  193. _8c.html" target="source" name="GetImageChannelDistortion">GetImageChannelDistortion</a></h2>
    194. 

  194. <div class="doc-section">
    195. 

  195. 

  196. <p>GetImageChannelDistortion() compares one or more image channels of an image to a reconstructed image and returns the specified distortion metric.</p></ol>
    197. 

  197. 

  198. <p>The format of the CompareImageChannels method is:</p>
    199. 

  199. 

  200. <pre class="code">
    201. 

  201.   MagickBooleanType GetImageChannelDistortion(const Image *image,
    202. 

  202.     const Image *reconstruct_image,const ChannelType channel,
    203. 

  203.     const MetricType metric,double *distortion,ExceptionInfo *exception)
    204. 

  204. </pre>
    205. 

  205. 

  206. <p>A description of each parameter follows:</p></ol>
    207. 

  207. 

  208. <h5>image</h5>
    209. 

  209. <ol><p>the image.</p></ol>
    210. 

  210. 

  211. <h5>reconstruct_image</h5>
    212. 

  212. <ol><p>the reconstruct image.</p></ol>
    213. 

  213. 

  214. <h5>channel</h5>
    215. 

  215. <ol><p>the channel.</p></ol>
    216. 

  216. 

  217. <h5>metric</h5>
    218. 

  218. <ol><p>the metric.</p></ol>
    219. 

  219. 

  220. <h5>distortion</h5>
    221. 

  221. <ol><p>the computed distortion between the images.</p></ol>
    222. 

  222. 

  223. <h5>exception</h5>
    224. 

  224. <ol><p>return any errors or warnings in this structure.</p></ol>
    225. 

  225. 

  226.  </div>
    227. 

  227. <h2><a href="http://www.imagemagick.org/api/MagickCore/compare
    228. 

  228. _8c.html" target="source" name="GetImageChannelDistrortion">GetImageChannelDistrortion</a></h2>
    229. 

  229. <div class="doc-section">
    230. 

  230. 

  231. <p>GetImageChannelDistrortion() compares the image channels of an image to a reconstructed image and returns the specified distortion metric for each channel.</p></ol>
    232. 

  232. 

  233. <p>The format of the CompareImageChannels method is:</p>
    234. 

  234. 

  235. <pre class="code">
    236. 

  236.   double *GetImageChannelDistortions(const Image *image,
    237. 

  237.     const Image *reconstruct_image,const MetricType metric,
    238. 

  238.     ExceptionInfo *exception)
    239. 

  239. </pre>
    240. 

  240. 

  241. <p>A description of each parameter follows:</p></ol>
    242. 

  242. 

  243. <h5>image</h5>
    244. 

  244. <ol><p>the image.</p></ol>
    245. 

  245. 

  246. <h5>reconstruct_image</h5>
    247. 

  247. <ol><p>the reconstruct image.</p></ol>
    248. 

  248. 

  249. <h5>metric</h5>
    250. 

  250. <ol><p>the metric.</p></ol>
    251. 

  251. 

  252. <h5>exception</h5>
    253. 

  253. <ol><p>return any errors or warnings in this structure.</p></ol>
    254. 

  254. 

  255.  </div>
    256. 

  256. <h2><a href="http://www.imagemagick.org/api/MagickCore/compare
    257. 

  257. _8c.html" target="source" name="IsImagesEqual">IsImagesEqual</a></h2>
    258. 

  258. <div class="doc-section">
    259. 

  259. 

  260. <p>IsImagesEqual() measures the difference between colors at each pixel location of two images.  A value other than 0 means the colors match exactly.  Otherwise an error measure is computed by summing over all pixels in an image the distance squared in RGB space between each image pixel and its corresponding pixel in the reconstruct image.  The error measure is assigned to these image members:</p>
    261. 

  261. 

  262. <pre class="text">
    263. 

  263.       o mean_error_per_pixel:  The mean error for any single pixel in
    264. 

  264.   the image.
    265. 

  265. </pre>
    266. 

  266. 

  267. <h5>normalized_mean_error</h5>
    268. 

  268. <ol><p>The normalized mean quantization error for any single pixel in the image.  This distance measure is normalized to a range between 0 and 1.  It is independent of the range of red, green, and blue values in the image.</p></ol>
    269. 

  269. 

  270. <h5>normalized_maximum_error</h5>
    271. 

  271. <ol><p>The normalized maximum quantization error for any single pixel in the image.  This distance measure is normalized to a range between 0 and 1.  It is independent of the range of red, green, and blue values in your image.</p></ol>
    272. 

  272. 

  273. <p>A small normalized mean square error, accessed as image->normalized_mean_error, suggests the images are very similar in spatial layout and color.</p></ol>
    274. 

  274. 

  275. <p>The format of the IsImagesEqual method is:</p>
    276. 

  276. 

  277. <pre class="code">
    278. 

  278.   MagickBooleanType IsImagesEqual(Image *image,
    279. 

  279.     const Image *reconstruct_image)
    280. 

  280. </pre>
    281. 

  281. 

  282. <p>A description of each parameter follows.</p></ol>
    283. 

  283. 

  284. <h5>image</h5>
    285. 

  285. <ol><p>the image.</p></ol>
    286. 

  286. 

  287. <h5>reconstruct_image</h5>
    288. 

  288. <ol><p>the reconstruct image.</p></ol>
    289. 

  289. 

  290.  </div>
    291. 

  291. <h2><a href="http://www.imagemagick.org/api/MagickCore/compare
    292. 

  292. _8c.html" target="source" name="SimilarityImage">SimilarityImage</a></h2>
    293. 

  293. <div class="doc-section">
    294. 

  294. 

  295. <p>SimilarityImage() compares the reference image of the image and returns the best match offset.  In addition, it returns a similarity image such that an exact match location is completely white and if none of the pixels match, black, otherwise some gray level in-between.</p></ol>
    296. 

  296. 

  297. <p>The format of the SimilarityImageImage method is:</p>
    298. 

  298. 

  299. <pre class="code">
    300. 

  300.   Image *SimilarityImage(const Image *image,const Image *reference,
    301. 

  301.     RectangleInfo *offset,double *similarity,ExceptionInfo *exception)
    302. 

  302. </pre>
    303. 

  303. 

  304. <p>A description of each parameter follows:</p></ol>
    305. 

  305. 

  306. <h5>image</h5>
    307. 

  307. <ol><p>the image.</p></ol>
    308. 

  308. 

  309. <h5>reference</h5>
    310. 

  310. <ol><p>find an area of the image that closely resembles this image.</p></ol>
    311. 

  311. 

  312. <p>o the best match offset of the reference image within the image.</p></ol>
    313. 

  313. 

  314. <h5>similarity</h5>
    315. 

  315. <ol><p>the computed similarity between the images.</p></ol>
    316. 

  316. 

  317. <h5>exception</h5>
    318. 

  318. <ol><p>return any errors or warnings in this structure.</p></ol>
    319. 

  319. 

  320.  </div>
    321. 

  321. 

    322. 

  322. </div>

    323. 

  323. 

    324. 

  324. <div id="linkbar">

    325. 

  325.  <!--    <span id="linkbar-west">&nbsp;</span>  -->

    326. 

  326.     <span id="linkbar-center">

    327. 

  327.       <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;

    328. 

  328.     <a href="http://studio.webbyland.com/ImageMagick/MagickStudio/scripts/MagickStudio.cgi">Studio</a>

    329. 

  329.     </span>

    330. 

  330.     <span id="linkbar-east">&nbsp;</span>

    331. 

  331.   </div>

    332. 

  332.   <div class="footer">

    333. 

  333.     <span id="footer-west">&copy; 1999-2010 ImageMagick Studio LLC</span>

    334. 

  334.     <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>

    335. 

  335.   </div>

    336. 

  336.   <div style="clear: both; margin: 0; width: 100%; "></div>

    337. 

  337. </body>

    338. 

  338. </html>

    339. 

  339.