Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ImageMagick / 81492d6942a69818c45aec137680685f441dd531 / . / www / api / magick-image.html
blob: 5bd6261621cfa03081f4b528d562833d4a39fffa [file] [log] [blame]
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
2 "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
cristy2bd2a982011-02-15 00:52:58 +0000[diff] [blame]3<html version="-//W3C//DTD XHTML 1.1//EN"
4 xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"
5 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
6 xsi:schemaLocation="http://www.w3.org/1999/xhtml
7 http://www.w3.org/MarkUp/SCHEMA/xhtml11.xsd">
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]8<head>
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]9 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
10 <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U="/>
cristyffb69ed2010-12-25 00:06:48 +0000[diff] [blame]11 <title>ImageMagick: MagickWand, C API for ImageMagick: Image Methods</title>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]12 <meta http-equiv="Content-Language" content="en-US"/>
13 <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
14 <meta http-equiv="Reply-to" content="magick-users@imagemagick.org"/>
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]15 <meta name="Application-name" content="ImageMagick"/>
cristye6e84152011-06-06 14:16:49 +0000[diff] [blame]16 <meta name="Description" content="Use ImageMagick to convert, edit, or compose bitmap images in a variety of formats. In addition resize, rotate, shear, distort and transform images automagically."/>
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]17 <meta name="Application-url" content="http://www.imagemagick.org"/>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]18 <meta name="Generator" content="PHP"/>
cristye6e84152011-06-06 14:16:49 +0000[diff] [blame]19 <meta name="Keywords" content="magickwc, api, for, imagemagick:, image, methods, ImageMagick, ImageMagic, MagickCore, MagickWand, PerlMagick, Magick++, RMagick, PythonMagick, JMagick, TclMagick, Image, Magick, Magic, Wand, ImageMagickObject, Image, Processing, Automagically"/>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]20 <meta name="Rating" content="GENERAL"/>
21 <meta name="Robots" content="INDEX, FOLLOW"/>
22 <meta name="Generator" content="ImageMagick Studio LLC"/>
23 <meta name="Author" content="ImageMagick Studio LLC"/>
24 <meta name="Revisit-after" content="2 DAYS"/>
25 <meta name="Resource-type" content="document"/>
cristy4103d562010-12-10 01:38:54 +0000[diff] [blame]26 <meta name="Copyright" content="Copyright (c) 1999-2011 ImageMagick Studio LLC"/>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]27 <meta name="Distribution" content="Global"/>
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]28 <link rel="icon" href="../../images/wand.png"/>
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]29 <link rel="shortcut icon" href="../../images/wand.ico" type="images/x-icon"/>
30 <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf"/>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]31 <link rel="stylesheet" href="http://www.google.com/cse/style/look/default.css" type="text/css" />
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]32 <style type="text/css" media="all">
33 @import url("../../www/magick.css");
34 </style>
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]35 <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.4/jquery.min.js"></script>
cristy361f4662010-12-31 23:02:52 +0000[diff] [blame]36 <script type="text/javascript" src="../fancybox/jquery.fancybox-1.3.4.pack.js"></script>
37 <link rel="stylesheet" type="text/css" href="../fancybox/jquery.fancybox-1.3.4.css" media="screen" />
38 <script type="text/javascript">
39 $(document).ready(function() {
40 $("a[href$=.jpg],a[href$=.png],a[href$=.gif]").fancybox({
41 'transitionIn' : 'elastic',
42 'transitionOut' : 'elastic',
43 'overlayShow' : false,
44 'opacity' : true
45 });
46 });
47 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]48</head>
49
50<body id="www-imagemagick-org">
51<div class="titlebar">
cristyb52981c2011-03-19 17:09:31 +0000[diff] [blame]52<div style="margin: 17px auto; float: left;">
53 <script type="text/javascript">
54 <!--
55 google_ad_client = "pub-3129977114552745";
56 google_ad_slot = "5439289906";
57 google_ad_width = 728;
58 google_ad_height = 90;
59 //-->
60 </script>
61 <script type="text/javascript"
62 src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
63 </script>
64</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]65<a href="http://www.imagemagick.org/discourse-server/">
cristyaf8d6652011-02-04 21:57:45 +0000[diff] [blame]66 <img src="../../images/logo.jpg"
67 alt="ImageMagick Logo"
cristy178edaf2011-01-23 03:42:39 +0000[diff] [blame]68 style="width: 123px; height: 118px; border: 0px; float: right;" /></a>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]69<a href="../../index.html">
cristyaf8d6652011-02-04 21:57:45 +0000[diff] [blame]70 <img src="../../images/sprite.jpg"
71 alt="ImageMagick Sprite"
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]72 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
73</div>
74
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]75<div class="westbar">
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]76
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]77<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]78 <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]79</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]80<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]81<div class="menu">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]82 <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
83</div>
84<div class="sub">
85 <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
86</div>
87<div class="sub">
88 <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
89</div>
90<div class="sub">
cristye6e84152011-06-06 14:16:49 +0000[diff] [blame]91 <a title="Binary Release: iOS" href="../../www/binary-releases.html#iOS">iOS</a>
cristyda16f162011-02-19 23:52:17 +0000[diff] [blame]92</div>
93<div class="sub">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]94 <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
95</div>
96<div class="sep"></div>
97<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]98 <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]99</div>
100<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]101 <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]102</div>
103<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]104 <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]105</div>
106<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]107 <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]108</div>
109<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]110 <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]111</div>
112<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]113 <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]114</div>
115<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]116 <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]117</div>
118<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]119 <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]120</div>
121<div class="sub">
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]122 <a title="Program Interface: Magick++" href="../../www/magick++.html">Magick++</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]123</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]124<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]125<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]126 <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]127</div>
128<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]129 <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]130</div>
131<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]132 <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]133 </div>
134<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]135 <a title="Resources" href="../../www/resources.html">Resources</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]136</div>
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]137<div class="menu">
138 <a title="Architecture" href="../../www/architecture.html">Architecture</a>
139</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]140<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]141 <a title="Download" href="../../www/download.html">Download</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]142</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]143<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]144<div class="menu">
cristy52923442011-01-15 22:54:31 +0000[diff] [blame]145 <a title="Search" href="../../www/search.html">Search</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]146</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]147<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]148<div class="menu">
cristyffb69ed2010-12-25 00:06:48 +0000[diff] [blame]149 <a title="Site Map" href="../../www/sitemap.html">Site Map</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]150</div>
151<div class="sub">
cristyffb69ed2010-12-25 00:06:48 +0000[diff] [blame]152 <a title="Site Map: Links" href="../../www/links.html">Links</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]153</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]154<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]155<div class="menu">
cristy10549a12011-05-15 19:04:46 +0000[diff] [blame]156 <a rel="follow" title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]157
cristyb52981c2011-03-19 17:09:31 +0000[diff] [blame]158<a href="http://www.networkredux.com">
159 <img src="../../images/networkredux.png" alt="[sponsor]"
160 style="margin-top: 4px; margin-left: 4px; border: 0px; float: left;" /></a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]161<div class="sponsbox">
cristy178edaf2011-01-23 03:42:39 +0000[diff] [blame]162<div class="sponsor">
cristy81492d62011-06-07 16:41:42 +0000[diff] [blame^]163 <a rel="follow" title="Sponsor: Web Hosting" href="http://www.micfo.com">Web Hosting</a><!-- 209901010090s golestan -->
164</div>
165<div class="sponsor">
166 <a rel="follow" title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 -->
167</div>
168<div class="sponsor">
cristyba1758d2011-06-03 01:29:12 +0000[diff] [blame]169 <a rel="follow" title="Sponsor: Web Hosting Deals" href="http://www.webhostingdeals.org">Web Hosting Deals</a><!-- 201111010270 chee.hoa darin -->
170</div>
171<div class="sponsor">
172 <a rel="follow" title="Sponsor: Web Hosting Reviews" href="http://www.webhostingsecretrevealed.com">Web Hosting Secret Revealed</a><!-- 201204010540 iamchee jerry -->
173</div>
174<div class="sponsor">
cristy4bf6e232011-05-21 01:43:33 +0000[diff] [blame]175 <a rel="follow" title="Sponsor: Web Hosting Break" href="http://www.webhostingbreak.com">Web Hosting Break</a><!-- 201109010090 ian@ian-m... -->
cristy45dbd322011-03-27 16:40:38 +0000[diff] [blame]176</div>
177<div class="sponsor">
cristy10549a12011-05-15 19:04:46 +0000[diff] [blame]178 <a rel="follow" title="Sponsor: Druckerei" href="http://www.allesdruck.de">Druckerei</a><!-- 201303011500 r.leo -->
cristy4c54bbb2011-03-17 13:53:13 +0000[diff] [blame]179</div>
180<div class="sponsor">
cristy575d5ee2011-05-24 01:59:01 +0000[diff] [blame]181 <a rel="follow" title="Sponsor: Website Hosting" href="http://www.hostreviewgeeks.com">Website Hosting</a><!-- 201110010090 alexanian media -->
cristy4bf6e232011-05-21 01:43:33 +0000[diff] [blame]182</div>
183<div class="sponsor">
cristy10549a12011-05-15 19:04:46 +0000[diff] [blame]184 <a rel="follow" title="Sponsor: Hotel München" href="http://www.messehotel-erb-muenchen.de">Hotel München</a><!-- 201111010450 cerb -->
cristyaf8d6652011-02-04 21:57:45 +0000[diff] [blame]185</div>
186<div class="sponsor">
cristy10549a12011-05-15 19:04:46 +0000[diff] [blame]187 <a rel="follow" title="Sponsor: Best Web Hosting" href="http://webhostinggeeks.com">Best Web Hosting</a><!-- 201110010720 -->
cristy73fd1cd2010-09-12 19:14:25 +0000[diff] [blame]188</div>
189<div class="sponsor">
cristy10549a12011-05-15 19:04:46 +0000[diff] [blame]190 <a rel="follow" title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
cristyee742642011-02-26 02:49:59 +0000[diff] [blame]191</div>
192<div class="sponsor">
cristy10549a12011-05-15 19:04:46 +0000[diff] [blame]193 <a rel="follow" title="Sponsor: Web Hosting Reviews" href="http://www.webhostingmasters.com">Web Hosting Reviews</a><!-- 201107011500 affliatelabel -->
cristy851dbce2010-08-06 21:40:00 +0000[diff] [blame]194</div>
cristyec6b4752011-01-08 03:16:23 +0000[diff] [blame]195<div class="sponsor">
cristy10549a12011-05-15 19:04:46 +0000[diff] [blame]196 <a rel="follow" title="Sponsor: Web Hosting Ratings" href="http://webhostingrating.com">Web Hosting Ratings</a><!-- 201110010720 -->
cristybaacd172011-04-30 23:11:03 +0000[diff] [blame]197</div>
198<div class="sponsor">
cristy81492d62011-06-07 16:41:42 +0000[diff] [blame^]199 <a rel="follow" title="Sponsor: Free Catalogs" href="http://www.who-sells-it.com/">Free Catalogs</a><!-- 20120801000600 -->
cristyec6b4752011-01-08 03:16:23 +0000[diff] [blame]200</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]201</div>
202</div>
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]203</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]204
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]205<div class="eastbar">
cristyb52981c2011-03-19 17:09:31 +0000[diff] [blame]206
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]207</div>
208
209<div class="main">
210
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]211<h1>Module magick-image Methods</h1>
cristyb52981c2011-03-19 17:09:31 +0000[diff] [blame]212<p class="navigation-index">[<a href="#GetImageFromMagickWand">GetImageFromMagickWand</a> &bull; <a href="#MagickAdaptiveBlurImage">MagickAdaptiveBlurImage</a> &bull; <a href="#MagickAdaptiveResizeImage">MagickAdaptiveResizeImage</a> &bull; <a href="#MagickAdaptiveSharpenImage">MagickAdaptiveSharpenImage</a> &bull; <a href="#MagickAdaptiveThresholdImage">MagickAdaptiveThresholdImage</a> &bull; <a href="#MagickAddImage">MagickAddImage</a> &bull; <a href="#MagickAddNoiseImage">MagickAddNoiseImage</a> &bull; <a href="#MagickAffineTransformImage">MagickAffineTransformImage</a> &bull; <a href="#MagickAnnotateImage">MagickAnnotateImage</a> &bull; <a href="#MagickAnimateImages">MagickAnimateImages</a> &bull; <a href="#MagickAppendImages">MagickAppendImages</a> &bull; <a href="#MagickAutoGammaImage">MagickAutoGammaImage</a> &bull; <a href="#MagickAutoLevelImage">MagickAutoLevelImage</a> &bull; <a href="#MagickBlackThresholdImage">MagickBlackThresholdImage</a> &bull; <a href="#MagickBlueShiftImage">MagickBlueShiftImage</a> &bull; <a href="#MagickBlurImage">MagickBlurImage</a> &bull; <a href="#MagickBorderImage">MagickBorderImage</a> &bull; <a href="#Use MagickBrightnessContrastImage">Use MagickBrightnessContrastImage</a> &bull; <a href="#MagickCharcoalImage">MagickCharcoalImage</a> &bull; <a href="#MagickChopImage">MagickChopImage</a> &bull; <a href="#MagickClampImage">MagickClampImage</a> &bull; <a href="#MagickClipImage">MagickClipImage</a> &bull; <a href="#MagickClipImagePath">MagickClipImagePath</a> &bull; <a href="#MagickClutImage">MagickClutImage</a> &bull; <a href="#MagickCoalesceImages">MagickCoalesceImages</a> &bull; <a href="#MagickColorDecisionListImage">MagickColorDecisionListImage</a> &bull; <a href="#MagickColorizeImage">MagickColorizeImage</a> &bull; <a href="#MagickColorMatrixImage">MagickColorMatrixImage</a> &bull; <a href="#MagickCombineImages">MagickCombineImages</a> &bull; <a href="#MagickCommentImage">MagickCommentImage</a> &bull; <a href="#MagickCompareImageChannels">MagickCompareImageChannels</a> &bull; <a href="#MagickCompareImageLayers">MagickCompareImageLayers</a> &bull; <a href="#MagickCompareImages">MagickCompareImages</a> &bull; <a href="#MagickCompositeImage">MagickCompositeImage</a> &bull; <a href="#MagickContrastImage">MagickContrastImage</a> &bull; <a href="#MagickContrastStretchImage">MagickContrastStretchImage</a> &bull; <a href="#MagickConvolveImage">MagickConvolveImage</a> &bull; <a href="#MagickCropImage">MagickCropImage</a> &bull; <a href="#MagickCycleColormapImage">MagickCycleColormapImage</a> &bull; <a href="#MagickConstituteImage">MagickConstituteImage</a> &bull; <a href="#MagickDecipherImage">MagickDecipherImage</a> &bull; <a href="#MagickDeconstructImages">MagickDeconstructImages</a> &bull; <a href="#MagickDeskewImage">MagickDeskewImage</a> &bull; <a href="#MagickDespeckleImage">MagickDespeckleImage</a> &bull; <a href="#MagickDestroyImage">MagickDestroyImage</a> &bull; <a href="#MagickDisplayImage">MagickDisplayImage</a> &bull; <a href="#MagickDisplayImages">MagickDisplayImages</a> &bull; <a href="#MagickDistortImage">MagickDistortImage</a> &bull; <a href="#MagickDrawImage">MagickDrawImage</a> &bull; <a href="#MagickEdgeImage">MagickEdgeImage</a> &bull; <a href="#MagickEmbossImage">MagickEmbossImage</a> &bull; <a href="#MagickEncipherImage">MagickEncipherImage</a> &bull; <a href="#MagickEnhanceImage">MagickEnhanceImage</a> &bull; <a href="#MagickEqualizeImage">MagickEqualizeImage</a> &bull; <a href="#MagickEvaluateImage">MagickEvaluateImage</a> &bull; <a href="#MagickExportImagePixels">MagickExportImagePixels</a> &bull; <a href="#MagickExtentImage">MagickExtentImage</a> &bull; <a href="#MagickFilterImage">MagickFilterImage</a> &bull; <a href="#MagickFlipImage">MagickFlipImage</a> &bull; <a href="#MagickFloodfillPaintImage">MagickFloodfillPaintImage</a> &bull; <a href="#MagickFlopImage">MagickFlopImage</a> &bull; <a href="#MagickForwardFourierTransformImage">MagickForwardFourierTransformImage</a> &bull; <a href="#MagickFrameImage">MagickFrameImage</a> &bull; <a href="#MagickFunctionImage">MagickFunctionImage</a> &bull; <a href="#MagickFxImage">MagickFxImage</a> &bull; <a href="#MagickGammaImage">MagickGammaImage</a> &bull; <a href="#MagickGaussianBlurImage">MagickGaussianBlurImage</a> &bull; <a href="#MagickGetImage">MagickGetImage</a> &bull; <a href="#MagickGetImageAlphaChannel">MagickGetImageAlphaChannel</a> &bull; <a href="#MagickGetImageClipMask">MagickGetImageClipMask</a> &bull; <a href="#MagickGetImageBackgroundColor">MagickGetImageBackgroundColor</a> &bull; <a href="#MagickGetImageBlob">MagickGetImageBlob</a> &bull; <a href="#MagickGetImageBlob">MagickGetImageBlob</a> &bull; <a href="#MagickGetImageBluePrimary">MagickGetImageBluePrimary</a> &bull; <a href="#MagickGetImageBorderColor">MagickGetImageBorderColor</a> &bull; <a href="#MagickGetImageChannelDepth">MagickGetImageChannelDepth</a> &bull; <a href="#MagickGetImageChannelDistortion">MagickGetImageChannelDistortion</a> &bull; <a href="#MagickGetImageChannelDistortions">MagickGetImageChannelDistortions</a> &bull; <a href="#MagickGetImageChannelFeatures">MagickGetImageChannelFeatures</a> &bull; <a href="#MagickGetImageChannelKurtosis">MagickGetImageChannelKurtosis</a> &bull; <a href="#MagickGetImageChannelMean">MagickGetImageChannelMean</a> &bull; <a href="#MagickGetImageChannelRange">MagickGetImageChannelRange</a> &bull; <a href="#MagickGetImageChannelStatistics">MagickGetImageChannelStatistics</a> &bull; <a href="#MagickGetImageColormapColor">MagickGetImageColormapColor</a> &bull; <a href="#MagickGetImageColors">MagickGetImageColors</a> &bull; <a href="#MagickGetImageColorspace">MagickGetImageColorspace</a> &bull; <a href="#MagickGetImageCompose">MagickGetImageCompose</a> &bull; <a href="#MagickGetImageCompression">MagickGetImageCompression</a> &bull; <a href="#MagickGetImageCompression">MagickGetImageCompression</a> &bull; <a href="#MagickGetImageDelay">MagickGetImageDelay</a> &bull; <a href="#MagickGetImageDepth">MagickGetImageDepth</a> &bull; <a href="#MagickGetImageDistortion">MagickGetImageDistortion</a> &bull; <a href="#MagickGetImageDispose">MagickGetImageDispose</a> &bull; <a href="#MagickGetImageFilename">MagickGetImageFilename</a> &bull; <a href="#MagickGetImageFormat">MagickGetImageFormat</a> &bull; <a href="#MagickGetImageFuzz">MagickGetImageFuzz</a> &bull; <a href="#MagickGetImageGamma">MagickGetImageGamma</a> &bull; <a href="#MagickGetImageGravity">MagickGetImageGravity</a> &bull; <a href="#MagickGetImageGreenPrimary">MagickGetImageGreenPrimary</a> &bull; <a href="#MagickGetImageHeight">MagickGetImageHeight</a> &bull; <a href="#MagickGetImageHistogram">MagickGetImageHistogram</a> &bull; <a href="#MagickGetImageInterlaceScheme">MagickGetImageInterlaceScheme</a> &bull; <a href="#MagickGetImageInterpolateMethod">MagickGetImageInterpolateMethod</a> &bull; <a href="#MagickGetImageIterations">MagickGetImageIterations</a> &bull; <a href="#MagickGetImageLength">MagickGetImageLength</a> &bull; <a href="#MagickGetImageMatteColor">MagickGetImageMatteColor</a> &bull; <a href="#MagickGetImageOrientation">MagickGetImageOrientation</a> &bull; <a href="#MagickGetImagePage">MagickGetImagePage</a> &bull; <a href="#MagickGetImagePixelColor">MagickGetImagePixelColor</a> &bull; <a href="#MagickGetImageRedPrimary">MagickGetImageRedPrimary</a> &bull; <a href="#MagickGetImageRegion">MagickGetImageRegion</a> &bull; <a href="#MagickGetImageRenderingIntent">MagickGetImageRenderingIntent</a> &bull; <a href="#MagickGetImageResolution">MagickGetImageResolution</a> &bull; <a href="#MagickGetImageScene">MagickGetImageScene</a> &bull; <a href="#MagickGetImageSignature">MagickGetImageSignature</a> &bull; <a href="#MagickGetImageTicksPerSecond">MagickGetImageTicksPerSecond</a> &bull; <a href="#MagickGetImageType">MagickGetImageType</a> &bull; <a href="#MagickGetImageUnits">MagickGetImageUnits</a> &bull; <a href="#MagickGetImageVirtualPixelMethod">MagickGetImageVirtualPixelMethod</a> &bull; <a href="#MagickGetImageWhitePoint">MagickGetImageWhitePoint</a> &bull; <a href="#MagickGetImageWidth">MagickGetImageWidth</a> &bull; <a href="#MagickGetNumberImages">MagickGetNumberImages</a> &bull; <a href="#MagickGetImageTotalInkDensity">MagickGetImageTotalInkDensity</a> &bull; <a href="#MagickHaldClutImage">MagickHaldClutImage</a> &bull; <a href="#MagickHasNextImage">MagickHasNextImage</a> &bull; <a href="#MagickHasPreviousImage">MagickHasPreviousImage</a> &bull; <a href="#MagickIdentifyImage">MagickIdentifyImage</a> &bull; <a href="#MagickImplodeImage">MagickImplodeImage</a> &bull; <a href="#MagickImportImagePixels">MagickImportImagePixels</a> &bull; <a href="#MagickInverseFourierTransformImage">MagickInverseFourierTransformImage</a> &bull; <a href="#MagickLabelImage">MagickLabelImage</a> &bull; <a href="#MagickLevelImage">MagickLevelImage</a> &bull; <a href="#MagickLinearStretchImage">MagickLinearStretchImage</a> &bull; <a href="#MagickLiquidRescaleImage">MagickLiquidRescaleImage</a> &bull; <a href="#MagickMagnifyImage">MagickMagnifyImage</a> &bull; <a href="#MagickMergeImageLayers">MagickMergeImageLayers</a> &bull; <a href="#MagickMinifyImage">MagickMinifyImage</a> &bull; <a href="#MagickModulateImage">MagickModulateImage</a> &bull; <a href="#MagickMontageImage">MagickMontageImage</a> &bull; <a href="#MagickMorphImages">MagickMorphImages</a> &bull; <a href="#MagickMorphologyImage">MagickMorphologyImage</a> &bull; <a href="#MagickMotionBlurImage">MagickMotionBlurImage</a> &bull; <a href="#MagickNegateImage">MagickNegateImage</a> &bull; <a href="#MagickNewImage">MagickNewImage</a> &bull; <a href="#MagickNextImage">MagickNextImage</a> &bull; <a href="#MagickNormalizeImage">MagickNormalizeImage</a> &bull; <a href="#MagickOilPaintImage">MagickOilPaintImage</a> &bull; <a href="#MagickOpaquePaintImage">MagickOpaquePaintImage</a> &bull; <a href="#MagickOptimizeImageLayers">MagickOptimizeImageLayers</a> &bull; <a href="#MagickOrderedPosterizeImage">MagickOrderedPosterizeImage</a> &bull; <a href="#MagickPingImage">MagickPingImage</a> &bull; <a href="#MagickPingImageBlob">MagickPingImageBlob</a> &bull; <a href="#MagickPingImageFile">MagickPingImageFile</a> &bull; <a href="#MagickPolaroidImage">MagickPolaroidImage</a> &bull; <a href="#MagickPosterizeImage">MagickPosterizeImage</a> &bull; <a href="#MagickPreviewImages">MagickPreviewImages</a> &bull; <a href="#MagickPreviousImage">MagickPreviousImage</a> &bull; <a href="#MagickQuantizeImage">MagickQuantizeImage</a> &bull; <a href="#MagickQuantizeImages">MagickQuantizeImages</a> &bull; <a href="#MagickRadialBlurImage">MagickRadialBlurImage</a> &bull; <a href="#MagickRaiseImage">MagickRaiseImage</a> &bull; <a href="#MagickRandomThresholdImage">MagickRandomThresholdImage</a> &bull; <a href="#MagickReadImage">MagickReadImage</a> &bull; <a href="#MagickReadImageBlob">MagickReadImageBlob</a> &bull; <a href="#MagickReadImageFile">MagickReadImageFile</a> &bull; <a href="#MagickRemapImage">MagickRemapImage</a> &bull; <a href="#MagickRemoveImage">MagickRemoveImage</a> &bull; <a href="#MagickResampleImage">MagickResampleImage</a> &bull; <a href="#MagickResetImagePage">MagickResetImagePage</a> &bull; <a href="#MagickResizeImage">MagickResizeImage</a> &bull; <a href="#MagickRollImage">MagickRollImage</a> &bull; <a href="#MagickRotateImage">MagickRotateImage</a> &bull; <a href="#MagickSampleImage">MagickSampleImage</a> &bull; <a href="#MagickScaleImage">MagickScaleImage</a> &bull; <a href="#MagickSegmentImage">MagickSegmentImage</a> &bull; <a href="#MagickSelectiveBlurImage">MagickSelectiveBlurImage</a> &bull; <a href="#MagickSeparateImageChannel">MagickSeparateImageChannel</a> &bull; <a href="#MagickSepiaToneImage">MagickSepiaToneImage</a> &bull; <a href="#MagickSetImage">MagickSetImage</a> &bull; <a href="#MagickSetImageAlphaChannel">MagickSetImageAlphaChannel</a> &bull; <a href="#MagickSetImageBackgroundColor">MagickSetImageBackgroundColor</a> &bull; <a href="#MagickSetImageBias">MagickSetImageBias</a> &bull; <a href="#MagickSetImageBluePrimary">MagickSetImageBluePrimary</a> &bull; <a href="#MagickSetImageBorderColor">MagickSetImageBorderColor</a> &bull; <a href="#MagickSetImageChannelDepth">MagickSetImageChannelDepth</a> &bull; <a href="#MagickSetImageClipMask">MagickSetImageClipMask</a> &bull; <a href="#MagickSetImageColor">MagickSetImageColor</a> &bull; <a href="#MagickSetImageColormapColor">MagickSetImageColormapColor</a> &bull; <a href="#MagickSetImageColorspace">MagickSetImageColorspace</a> &bull; <a href="#MagickSetImageCompose">MagickSetImageCompose</a> &bull; <a href="#MagickSetImageCompression">MagickSetImageCompression</a> &bull; <a href="#MagickSetImageCompressionQuality">MagickSetImageCompressionQuality</a> &bull; <a href="#MagickSetImageDelay">MagickSetImageDelay</a> &bull; <a href="#MagickSetImageDepth">MagickSetImageDepth</a> &bull; <a href="#MagickSetImageDispose">MagickSetImageDispose</a> &bull; <a href="#MagickSetImageExtent">MagickSetImageExtent</a> &bull; <a href="#MagickSetImageFilename">MagickSetImageFilename</a> &bull; <a href="#MagickSetImageFormat">MagickSetImageFormat</a> &bull; <a href="#MagickSetImageFuzz">MagickSetImageFuzz</a> &bull; <a href="#MagickSetImageGamma">MagickSetImageGamma</a> &bull; <a href="#MagickSetImageGravity">MagickSetImageGravity</a> &bull; <a href="#MagickSetImageGreenPrimary">MagickSetImageGreenPrimary</a> &bull; <a href="#MagickSetImageInterlaceScheme">MagickSetImageInterlaceScheme</a> &bull; <a href="#MagickSetImageInterpolateMethod">MagickSetImageInterpolateMethod</a> &bull; <a href="#MagickSetImageIterations">MagickSetImageIterations</a> &bull; <a href="#MagickSetImageMatte">MagickSetImageMatte</a> &bull; <a href="#MagickSetImageMatteColor">MagickSetImageMatteColor</a> &bull; <a href="#MagickSetImageOpacity">MagickSetImageOpacity</a> &bull; <a href="#MagickSetImageOrientation">MagickSetImageOrientation</a> &bull; <a href="#MagickSetImagePage">MagickSetImagePage</a> &bull; <a href="#MagickSetImageProgressMonitor">MagickSetImageProgressMonitor</a> &bull; <a href="#MagickSetImageRedPrimary">MagickSetImageRedPrimary</a> &bull; <a href="#MagickSetImageRenderingIntent">MagickSetImageRenderingIntent</a> &bull; <a href="#MagickSetImageResolution">MagickSetImageResolution</a> &bull; <a href="#MagickSetImageScene">MagickSetImageScene</a> &bull; <a href="#MagickSetImageTicksPerSecond">MagickSetImageTicksPerSecond</a> &bull; <a href="#MagickSetImageType">MagickSetImageType</a> &bull; <a href="#MagickSetImageUnits">MagickSetImageUnits</a> &bull; <a href="#MagickSetImageVirtualPixelMethod">MagickSetImageVirtualPixelMethod</a> &bull; <a href="#MagickSetImageWhitePoint">MagickSetImageWhitePoint</a> &bull; <a href="#MagickShadeImage">MagickShadeImage</a> &bull; <a href="#MagickShadowImage">MagickShadowImage</a> &bull; <a href="#MagickSharpenImage">MagickSharpenImage</a> &bull; <a href="#MagickShaveImage">MagickShaveImage</a> &bull; <a href="#MagickShearImage">MagickShearImage</a> &bull; <a href="#MagickSigmoidalContrastImage">MagickSigmoidalContrastImage</a> &bull; <a href="#MagickSimilarityImage">MagickSimilarityImage</a> &bull; <a href="#MagickSketchImage">MagickSketchImage</a> &bull; <a href="#MagickSmushImages">MagickSmushImages</a> &bull; <a href="#MagickSolarizeImage">MagickSolarizeImage</a> &bull; <a href="#MagickSparseColorImage">MagickSparseColorImage</a> &bull; <a href="#MagickSpliceImage">MagickSpliceImage</a> &bull; <a href="#MagickSpreadImage">MagickSpreadImage</a> &bull; <a href="#MagickStatisticImage">MagickStatisticImage</a> &bull; <a href="#MagickSteganoImage">MagickSteganoImage</a> &bull; <a href="#MagickStereoImage">MagickStereoImage</a> &bull; <a href="#MagickStripImage">MagickStripImage</a> &bull; <a href="#MagickSwirlImage">MagickSwirlImage</a> &bull; <a href="#MagickTextureImage">MagickTextureImage</a> &bull; <a href="#MagickThresholdImage">MagickThresholdImage</a> &bull; <a href="#MagickThumbnailImage">MagickThumbnailImage</a> &bull; <a href="#MagickTintImage">MagickTintImage</a> &bull; <a href="#MagickTransformImage">MagickTransformImage</a> &bull; <a href="#MagickTransformImageColorspace">MagickTransformImageColorspace</a> &bull; <a href="#MagickTransparentPaintImage">MagickTransparentPaintImage</a> &bull; <a href="#MagickTransposeImage">MagickTransposeImage</a> &bull; <a href="#MagickTransverseImage">MagickTransverseImage</a> &bull; <a href="#MagickTrimImage">MagickTrimImage</a> &bull; <a href="#MagickUniqueImageColors">MagickUniqueImageColors</a> &bull; <a href="#MagickUnsharpMaskImage">MagickUnsharpMaskImage</a> &bull; <a href="#MagickVignetteImage">MagickVignetteImage</a> &bull; <a href="#MagickWaveImage">MagickWaveImage</a> &bull; <a href="#MagickWhiteThresholdImage">MagickWhiteThresholdImage</a> &bull; <a href="#MagickWriteImage">MagickWriteImage</a> &bull; <a href="#MagickWriteImageFile">MagickWriteImageFile</a> &bull; <a href="#MagickWriteImages">MagickWriteImages</a> &bull; <a href="#MagickWriteImagesFile">MagickWriteImagesFile</a>]</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]213
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]214<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="GetImageFromMagickWand">GetImageFromMagickWand</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]215<div class="doc-section">
216
217<p>GetImageFromMagickWand() returns the current image from the magick wand.</p>
218
219<p>The format of the GetImageFromMagickWand method is:</p>
220
221<pre class="code">
222 Image *GetImageFromMagickWand(const MagickWand *wand)
223</pre>
224
225<p>A description of each parameter follows:</p>
226
227<h5>wand</h5>
228<p>the magick wand.</p>
229
230 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]231<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickAdaptiveBlurImage">MagickAdaptiveBlurImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]232<div class="doc-section">
233
234<p>MagickAdaptiveBlurImage() adaptively blurs the image by blurring less intensely near image edges and more intensely far from edges. We blur the image with a Gaussian operator of the given radius and standard deviation (sigma). For reasonable results, radius should be larger than sigma. Use a radius of 0 and MagickAdaptiveBlurImage() selects a suitable radius for you.</p>
235
236<p>The format of the MagickAdaptiveBlurImage method is:</p>
237
238<pre class="code">
239 MagickBooleanType MagickAdaptiveBlurImage(MagickWand *wand,
240 const double radius,const double sigma)
241 MagickBooleanType MagickAdaptiveBlurImageChannel(MagickWand *wand,
242 const ChannelType channel,const double radius,const double sigma)
243</pre>
244
245<p>A description of each parameter follows:</p>
246
247<h5>wand</h5>
248<p>the magick wand.</p>
249
250<h5>channel</h5>
251<p>the image channel(s).</p>
252
253<h5>radius</h5>
254<p>the radius of the Gaussian, in pixels, not counting the center pixel.</p>
255
256<h5>sigma</h5>
257<p>the standard deviation of the Gaussian, in pixels.</p>
258
259 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]260<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickAdaptiveResizeImage">MagickAdaptiveResizeImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]261<div class="doc-section">
262
263<p>MagickAdaptiveResizeImage() adaptively resize image with data dependent triangulation.</p>
264
265<p>MagickBooleanType MagickAdaptiveResizeImage(MagickWand *wand, const size_t columns,const size_t rows)</p>
266
267<p>A description of each parameter follows:</p>
268
269<h5>wand</h5>
270<p>the magick wand.</p>
271
272<h5>columns</h5>
273<p>the number of columns in the scaled image.</p>
274
275<h5>rows</h5>
276<p>the number of rows in the scaled image.</p>
277
278 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]279<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickAdaptiveSharpenImage">MagickAdaptiveSharpenImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]280<div class="doc-section">
281
282<p>MagickAdaptiveSharpenImage() adaptively sharpens the image by sharpening more intensely near image edges and less intensely far from edges. We sharpen the image with a Gaussian operator of the given radius and standard deviation (sigma). For reasonable results, radius should be larger than sigma. Use a radius of 0 and MagickAdaptiveSharpenImage() selects a suitable radius for you.</p>
283
284<p>The format of the MagickAdaptiveSharpenImage method is:</p>
285
286<pre class="code">
287 MagickBooleanType MagickAdaptiveSharpenImage(MagickWand *wand,
288 const double radius,const double sigma)
289 MagickBooleanType MagickAdaptiveSharpenImageChannel(MagickWand *wand,
290 const ChannelType channel,const double radius,const double sigma)
291</pre>
292
293<p>A description of each parameter follows:</p>
294
295<h5>wand</h5>
296<p>the magick wand.</p>
297
298<h5>channel</h5>
299<p>the image channel(s).</p>
300
301<h5>radius</h5>
302<p>the radius of the Gaussian, in pixels, not counting the center pixel.</p>
303
304<h5>sigma</h5>
305<p>the standard deviation of the Gaussian, in pixels.</p>
306
307 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]308<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickAdaptiveThresholdImage">MagickAdaptiveThresholdImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]309<div class="doc-section">
310
311<p>MagickAdaptiveThresholdImage() selects an individual threshold for each pixel based on the range of intensity values in its local neighborhood. This allows for thresholding of an image whose global intensity histogram doesn't contain distinctive peaks.</p>
312
313<p>The format of the AdaptiveThresholdImage method is:</p>
314
315<pre class="code">
316 MagickBooleanType MagickAdaptiveThresholdImage(MagickWand *wand,
317 const size_t width,const size_t height,const ssize_t offset)
318</pre>
319
320<p>A description of each parameter follows:</p>
321
322<h5>wand</h5>
323<p>the magick wand.</p>
324
325<h5>width</h5>
326<p>the width of the local neighborhood.</p>
327
328<h5>height</h5>
329<p>the height of the local neighborhood.</p>
330
331<h5>offset</h5>
332<p>the mean offset.</p>
333
334 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]335<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickAddImage">MagickAddImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]336<div class="doc-section">
337
338<p>MagickAddImage() adds the specified images at the current image location.</p>
339
340<p>The format of the MagickAddImage method is:</p>
341
342<pre class="code">
343 MagickBooleanType MagickAddImage(MagickWand *wand,
344 const MagickWand *add_wand)
345</pre>
346
347<p>A description of each parameter follows:</p>
348
349<h5>wand</h5>
350<p>the magick wand.</p>
351
352<h5>add_wand</h5>
353<p>A wand that contains images to add at the current image location.</p>
354
355 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]356<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickAddNoiseImage">MagickAddNoiseImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]357<div class="doc-section">
358
359<p>MagickAddNoiseImage() adds random noise to the image.</p>
360
361<p>The format of the MagickAddNoiseImage method is:</p>
362
363<pre class="code">
364 MagickBooleanType MagickAddNoiseImage(MagickWand *wand,
365 const NoiseType noise_type)
366 MagickBooleanType MagickAddNoiseImageChannel(MagickWand *wand,
367 const ChannelType channel,const NoiseType noise_type)
368</pre>
369
370<p>A description of each parameter follows:</p>
371
372<h5>wand</h5>
373<p>the magick wand.</p>
374
375<h5>channel</h5>
376<p>the image channel(s).</p>
377
378<h5>noise_type</h5>
379<p>The type of noise: Uniform, Gaussian, Multiplicative, Impulse, Laplacian, or Poisson.</p>
380
381 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]382<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickAffineTransformImage">MagickAffineTransformImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]383<div class="doc-section">
384
385<p>MagickAffineTransformImage() transforms an image as dictated by the affine matrix of the drawing wand.</p>
386
387<p>The format of the MagickAffineTransformImage method is:</p>
388
389<pre class="code">
390 MagickBooleanType MagickAffineTransformImage(MagickWand *wand,
391 const DrawingWand *drawing_wand)
392</pre>
393
394<p>A description of each parameter follows:</p>
395
396<h5>wand</h5>
397<p>the magick wand.</p>
398
399<h5>drawing_wand</h5>
400<p>the draw wand.</p>
401
402 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]403<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickAnnotateImage">MagickAnnotateImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]404<div class="doc-section">
405
406<p>MagickAnnotateImage() annotates an image with text.</p>
407
408<p>The format of the MagickAnnotateImage method is:</p>
409
410<pre class="code">
411 MagickBooleanType MagickAnnotateImage(MagickWand *wand,
412 const DrawingWand *drawing_wand,const double x,const double y,
413 const double angle,const char *text)
414</pre>
415
416<p>A description of each parameter follows:</p>
417
418<h5>wand</h5>
419<p>the magick wand.</p>
420
421<h5>drawing_wand</h5>
422<p>the draw wand.</p>
423
424<h5>x</h5>
425<p>x ordinate to left of text</p>
426
427<h5>y</h5>
428<p>y ordinate to text baseline</p>
429
430<h5>angle</h5>
431<p>rotate text relative to this angle.</p>
432
433<h5>text</h5>
434<p>text to draw</p>
435
436 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]437<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickAnimateImages">MagickAnimateImages</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]438<div class="doc-section">
439
440<p>MagickAnimateImages() animates an image or image sequence.</p>
441
442<p>The format of the MagickAnimateImages method is:</p>
443
444<pre class="code">
445 MagickBooleanType MagickAnimateImages(MagickWand *wand,
446 const char *server_name)
447</pre>
448
449<p>A description of each parameter follows:</p>
450
451<h5>wand</h5>
452<p>the magick wand.</p>
453
454<h5>server_name</h5>
455<p>the X server name.</p>
456
457 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]458<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickAppendImages">MagickAppendImages</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]459<div class="doc-section">
460
461<p>MagickAppendImages() append a set of images.</p>
462
463<p>The format of the MagickAppendImages method is:</p>
464
465<pre class="code">
466 MagickWand *MagickAppendImages(MagickWand *wand,
467 const MagickBooleanType stack)
468</pre>
469
470<p>A description of each parameter follows:</p>
471
472<h5>wand</h5>
473<p>the magick wand.</p>
474
475<h5>stack</h5>
476<p>By default, images are stacked left-to-right. Set stack to MagickTrue to stack them top-to-bottom.</p>
477
478 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]479<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickAutoGammaImage">MagickAutoGammaImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]480<div class="doc-section">
481
482<p>MagickAutoGammaImage() extracts the 'mean' from the image and adjust the image to try make set its gamma appropriatally.</p>
483
484<p>The format of the MagickAutoGammaImage method is:</p>
485
486<pre class="code">
487 MagickBooleanType MagickAutoGammaImage(MagickWand *wand)
488 MagickBooleanType MagickAutoGammaImageChannel(MagickWand *wand,
489 const ChannelType channel)
490</pre>
491
492<p>A description of each parameter follows:</p>
493
494<h5>wand</h5>
495<p>the magick wand.</p>
496
497<h5>channel</h5>
498<p>the image channel(s).</p>
499
500 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]501<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickAutoLevelImage">MagickAutoLevelImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]502<div class="doc-section">
503
504<p>MagickAutoLevelImage() adjusts the levels of a particular image channel by scaling the minimum and maximum values to the full quantum range.</p>
505
506<p>The format of the MagickAutoLevelImage method is:</p>
507
508<pre class="code">
509 MagickBooleanType MagickAutoLevelImage(MagickWand *wand)
510 MagickBooleanType MagickAutoLevelImageChannel(MagickWand *wand,
511 const ChannelType channel)
512</pre>
513
514<p>A description of each parameter follows:</p>
515
516<h5>wand</h5>
517<p>the magick wand.</p>
518
519<h5>channel</h5>
520<p>the image channel(s).</p>
521
522 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]523<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickBlackThresholdImage">MagickBlackThresholdImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]524<div class="doc-section">
525
526<p>MagickBlackThresholdImage() is like MagickThresholdImage() but forces all pixels below the threshold into black while leaving all pixels above the threshold unchanged.</p>
527
528<p>The format of the MagickBlackThresholdImage method is:</p>
529
530<pre class="code">
531 MagickBooleanType MagickBlackThresholdImage(MagickWand *wand,
532 const PixelWand *threshold)
533</pre>
534
535<p>A description of each parameter follows:</p>
536
537<h5>wand</h5>
538<p>the magick wand.</p>
539
540<h5>threshold</h5>
541<p>the pixel wand.</p>
542
543 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]544<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickBlueShiftImage">MagickBlueShiftImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]545<div class="doc-section">
546
547<p>MagickBlueShiftImage() mutes the colors of the image to simulate a scene at nighttime in the moonlight.</p>
548
549<p>The format of the MagickBlueShiftImage method is:</p>
550
551<pre class="code">
552 MagickBooleanType MagickBlueShiftImage(MagickWand *wand,
553 const double factor)
554</pre>
555
556<p>A description of each parameter follows:</p>
557
558<h5>wand</h5>
559<p>the magick wand.</p>
560
561<h5>factor</h5>
562<p>the blue shift factor (default 1.5)</p>
563
564 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]565<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickBlurImage">MagickBlurImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]566<div class="doc-section">
567
568<p>MagickBlurImage() blurs an image. We convolve the image with a gaussian operator of the given radius and standard deviation (sigma). For reasonable results, the radius should be larger than sigma. Use a radius of 0 and BlurImage() selects a suitable radius for you.</p>
569
570<p>The format of the MagickBlurImage method is:</p>
571
572<pre class="code">
573 MagickBooleanType MagickBlurImage(MagickWand *wand,const double radius,
574 const double sigma)
575 MagickBooleanType MagickBlurImageChannel(MagickWand *wand,
576 const ChannelType channel,const double radius,const double sigma)
577</pre>
578
579<p>A description of each parameter follows:</p>
580
581<h5>wand</h5>
582<p>the magick wand.</p>
583
584<h5>channel</h5>
585<p>the image channel(s).</p>
586
587<h5>radius</h5>
588<p>the radius of the , in pixels, not counting the center pixel.</p>
589
590<h5>sigma</h5>
591<p>the standard deviation of the , in pixels.</p>
592
593 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]594<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickBorderImage">MagickBorderImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]595<div class="doc-section">
596
597<p>MagickBorderImage() surrounds the image with a border of the color defined by the bordercolor pixel wand.</p>
598
599<p>The format of the MagickBorderImage method is:</p>
600
601<pre class="code">
602 MagickBooleanType MagickBorderImage(MagickWand *wand,
603 const PixelWand *bordercolor,const size_t width,
604 const size_t height)
605</pre>
606
607<p>A description of each parameter follows:</p>
608
609<h5>wand</h5>
610<p>the magick wand.</p>
611
612<h5>bordercolor</h5>
613<p>the border color pixel wand.</p>
614
615<h5>width</h5>
616<p>the border width.</p>
617
618<h5>height</h5>
619<p>the border height.</p>
620
621 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]622<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="Use_MagickBrightnessContrastImage">Use MagickBrightnessContrastImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]623<div class="doc-section">
624
625<p>Use MagickBrightnessContrastImage() to change the brightness and/or contrast of an image. It converts the brightness and contrast parameters into slope and intercept and calls a polynomical function to apply to the image.</p>
626
627
628<p>The format of the MagickBrightnessContrastImage method is:</p>
629
630<pre class="code">
631 MagickBooleanType MagickBrightnessContrastImage(MagickWand *wand,
632 const double brightness,const double contrast)
633 MagickBooleanType MagickBrightnessContrastImageChannel(MagickWand *wand,
634 const ChannelType channel,const double brightness,
635 const double contrast)
636</pre>
637
638<p>A description of each parameter follows:</p>
639
640<h5>wand</h5>
641<p>the magick wand.</p>
642
643<h5>channel</h5>
644<p>the image channel(s).</p>
645
646<h5>brightness</h5>
647<p>the brightness percent (-100 .. 100).</p>
648
649<h5>contrast</h5>
650<p>the contrast percent (-100 .. 100).</p>
651
652 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]653<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickCharcoalImage">MagickCharcoalImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]654<div class="doc-section">
655
656<p>MagickCharcoalImage() simulates a charcoal drawing.</p>
657
658<p>The format of the MagickCharcoalImage method is:</p>
659
660<pre class="code">
661 MagickBooleanType MagickCharcoalImage(MagickWand *wand,
662 const double radius,const double sigma)
663</pre>
664
665<p>A description of each parameter follows:</p>
666
667<h5>wand</h5>
668<p>the magick wand.</p>
669
670<h5>radius</h5>
671<p>the radius of the Gaussian, in pixels, not counting the center pixel.</p>
672
673<h5>sigma</h5>
674<p>the standard deviation of the Gaussian, in pixels.</p>
675
676 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]677<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickChopImage">MagickChopImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]678<div class="doc-section">
679
680<p>MagickChopImage() removes a region of an image and collapses the image to occupy the removed portion</p>
681
682<p>The format of the MagickChopImage method is:</p>
683
684<pre class="code">
685 MagickBooleanType MagickChopImage(MagickWand *wand,
686 const size_t width,const size_t height,const ssize_t x,
687 const ssize_t y)
688</pre>
689
690<p>A description of each parameter follows:</p>
691
692<h5>wand</h5>
693<p>the magick wand.</p>
694
695<h5>width</h5>
696<p>the region width.</p>
697
698<h5>height</h5>
699<p>the region height.</p>
700
701<h5>x</h5>
702<p>the region x offset.</p>
703
704<h5>y</h5>
705<p>the region y offset.</p>
706
707
708 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]709<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickClampImage">MagickClampImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]710<div class="doc-section">
711
712<p>MagickClampImage() restricts the color range from 0 to the quantum depth.</p>
713
714<p>The format of the MagickClampImage method is:</p>
715
716<pre class="code">
717 MagickBooleanType MagickClampImage(MagickWand *wand)
718 MagickBooleanType MagickClampImageChannel(MagickWand *wand,
719 const ChannelType channel)
720</pre>
721
722<p>A description of each parameter follows:</p>
723
724<h5>wand</h5>
725<p>the magick wand.</p>
726
727<h5>channel</h5>
728<p>the channel.</p>
729
730 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]731<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickClipImage">MagickClipImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]732<div class="doc-section">
733
734<p>MagickClipImage() clips along the first path from the 8BIM profile, if present.</p>
735
736<p>The format of the MagickClipImage method is:</p>
737
738<pre class="code">
739 MagickBooleanType MagickClipImage(MagickWand *wand)
740</pre>
741
742<p>A description of each parameter follows:</p>
743
744<h5>wand</h5>
745<p>the magick wand.</p>
746
747 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]748<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickClipImagePath">MagickClipImagePath</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]749<div class="doc-section">
750
751<p>MagickClipImagePath() clips along the named paths from the 8BIM profile, if present. Later operations take effect inside the path. Id may be a number if preceded with #, to work on a numbered path, e.g., "#1" to use the first path.</p>
752
753<p>The format of the MagickClipImagePath method is:</p>
754
755<pre class="code">
756 MagickBooleanType MagickClipImagePath(MagickWand *wand,
757 const char *pathname,const MagickBooleanType inside)
758</pre>
759
760<p>A description of each parameter follows:</p>
761
762<h5>wand</h5>
763<p>the magick wand.</p>
764
765<h5>pathname</h5>
766<p>name of clipping path resource. If name is preceded by #, use clipping path numbered by name.</p>
767
768<h5>inside</h5>
769<p>if non-zero, later operations take effect inside clipping path. Otherwise later operations take effect outside clipping path.</p>
770
771 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]772<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickClutImage">MagickClutImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]773<div class="doc-section">
774
775<p>MagickClutImage() replaces colors in the image from a color lookup table.</p>
776
777<p>The format of the MagickClutImage method is:</p>
778
779<pre class="code">
780 MagickBooleanType MagickClutImage(MagickWand *wand,
781 const MagickWand *clut_wand)
782 MagickBooleanType MagickClutImageChannel(MagickWand *wand,
783 const ChannelType channel,const MagickWand *clut_wand)
784</pre>
785
786<p>A description of each parameter follows:</p>
787
788<h5>wand</h5>
789<p>the magick wand.</p>
790
791<h5>clut_image</h5>
792<p>the clut image.</p>
793
794 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]795<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickCoalesceImages">MagickCoalesceImages</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]796<div class="doc-section">
797
798<p>MagickCoalesceImages() composites a set of images while respecting any page offsets and disposal methods. GIF, MIFF, and MNG animation sequences typically start with an image background and each subsequent image varies in size and offset. MagickCoalesceImages() returns a new sequence where each image in the sequence is the same size as the first and composited with the next image in the sequence.</p>
799
800<p>The format of the MagickCoalesceImages method is:</p>
801
802<pre class="code">
803 MagickWand *MagickCoalesceImages(MagickWand *wand)
804</pre>
805
806<p>A description of each parameter follows:</p>
807
808<h5>wand</h5>
809<p>the magick wand.</p>
810
811 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]812<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickColorDecisionListImage">MagickColorDecisionListImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]813<div class="doc-section">
814
815<p>MagickColorDecisionListImage() accepts a lightweight Color Correction Collection (CCC) file which solely contains one or more color corrections and applies the color correction to the image. Here is a sample CCC file:</p>
816
817<pre class="text">
818 <ColorCorrectionCollection xmlns="urn:ASC:CDL:v1.2">
819 <ColorCorrection id="cc03345">
820 <SOPNode>
821 <Slope> 0.9 1.2 0.5 </Slope>
822 <Offset> 0.4 -0.5 0.6 </Offset>
823 <Power> 1.0 0.8 1.5 </Power>
824 </SOPNode>
825 <SATNode>
826 <Saturation> 0.85 </Saturation>
827 </SATNode>
828 </ColorCorrection>
829 </ColorCorrectionCollection>
830</pre>
831
832<p>which includes the offset, slope, and power for each of the RGB channels as well as the saturation.</p>
833
834<p>The format of the MagickColorDecisionListImage method is:</p>
835
836<pre class="code">
837 MagickBooleanType MagickColorDecisionListImage(MagickWand *wand,
838 const double gamma)
839</pre>
840
841<p>A description of each parameter follows:</p>
842
843<h5>wand</h5>
844<p>the magick wand.</p>
845
846<h5>color_correction_collection</h5>
847<p>the color correction collection in XML.</p>
848
849 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]850<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickColorizeImage">MagickColorizeImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]851<div class="doc-section">
852
853<p>MagickColorizeImage() blends the fill color with each pixel in the image.</p>
854
855<p>The format of the MagickColorizeImage method is:</p>
856
857<pre class="code">
858 MagickBooleanType MagickColorizeImage(MagickWand *wand,
859 const PixelWand *colorize,const PixelWand *opacity)
860</pre>
861
862<p>A description of each parameter follows:</p>
863
864<h5>wand</h5>
865<p>the magick wand.</p>
866
867<h5>colorize</h5>
868<p>the colorize pixel wand.</p>
869
870<h5>opacity</h5>
871<p>the opacity pixel wand.</p>
872
873 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]874<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickColorMatrixImage">MagickColorMatrixImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]875<div class="doc-section">
876
877<p>MagickColorMatrixImage() apply color transformation to an image. The method permits saturation changes, hue rotation, luminance to alpha, and various other effects. Although variable-sized transformation matrices can be used, typically one uses a 5x5 matrix for an RGBA image and a 6x6 for CMYKA (or RGBA with offsets). The matrix is similar to those used by Adobe Flash except offsets are in column 6 rather than 5 (in support of CMYKA images) and offsets are normalized (divide Flash offset by 255).</p>
878
879<p>The format of the MagickColorMatrixImage method is:</p>
880
881<pre class="code">
882 MagickBooleanType MagickColorMatrixImage(MagickWand *wand,
883 const KernelInfo *color_matrix)
884</pre>
885
886<p>A description of each parameter follows:</p>
887
888<h5>wand</h5>
889<p>the magick wand.</p>
890
891<h5>color_matrix</h5>
892<p>the color matrix.</p>
893
894 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]895<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickCombineImages">MagickCombineImages</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]896<div class="doc-section">
897
898<p>MagickCombineImages() combines one or more images into a single image. The grayscale value of the pixels of each image in the sequence is assigned in order to the specified hannels of the combined image. The typical ordering would be image 1 => Red, 2 => Green, 3 => Blue, etc.</p>
899
900<p>The format of the MagickCombineImages method is:</p>
901
902<pre class="code">
903 MagickWand *MagickCombineImages(MagickWand *wand,
904 const ChannelType channel)
905</pre>
906
907<p>A description of each parameter follows:</p>
908
909<h5>wand</h5>
910<p>the magick wand.</p>
911
912<h5>channel</h5>
913<p>the channel.</p>
914
915 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]916<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickCommentImage">MagickCommentImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]917<div class="doc-section">
918
919<p>MagickCommentImage() adds a comment to your image.</p>
920
921<p>The format of the MagickCommentImage method is:</p>
922
923<pre class="code">
924 MagickBooleanType MagickCommentImage(MagickWand *wand,
925 const char *comment)
926</pre>
927
928<p>A description of each parameter follows:</p>
929
930<h5>wand</h5>
931<p>the magick wand.</p>
932
933<h5>comment</h5>
934<p>the image comment.</p>
935
936 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]937<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickCompareImageChannels">MagickCompareImageChannels</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]938<div class="doc-section">
939
940<p>MagickCompareImageChannels() compares one or more image channels of an image to a reconstructed image and returns the difference image.</p>
941
942<p>The format of the MagickCompareImageChannels method is:</p>
943
944<pre class="code">
945 MagickWand *MagickCompareImageChannels(MagickWand *wand,
946 const MagickWand *reference,const ChannelType channel,
947 const MetricType metric,double *distortion)
948</pre>
949
950<p>A description of each parameter follows:</p>
951
952<h5>wand</h5>
953<p>the magick wand.</p>
954
955<h5>reference</h5>
956<p>the reference wand.</p>
957
958<h5>channel</h5>
959<p>the channel.</p>
960
961<h5>metric</h5>
962<p>the metric.</p>
963
964<h5>distortion</h5>
965<p>the computed distortion between the images.</p>
966
967 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]968<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickCompareImageLayers">MagickCompareImageLayers</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]969<div class="doc-section">
970
971<p>MagickCompareImageLayers() compares each image with the next in a sequence and returns the maximum bounding region of any pixel differences it discovers.</p>
972
973<p>The format of the MagickCompareImageLayers method is:</p>
974
975<pre class="code">
976 MagickWand *MagickCompareImageLayers(MagickWand *wand,
977 const ImageLayerMethod method)
978</pre>
979
980<p>A description of each parameter follows:</p>
981
982<h5>wand</h5>
983<p>the magick wand.</p>
984
985<h5>method</h5>
986<p>the compare method.</p>
987
988 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]989<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickCompareImages">MagickCompareImages</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]990<div class="doc-section">
991
992<p>MagickCompareImages() compares an image to a reconstructed image and returns the specified difference image.</p>
993
994<p>The format of the MagickCompareImages method is:</p>
995
996<pre class="code">
997 MagickWand *MagickCompareImages(MagickWand *wand,
998 const MagickWand *reference,const MetricType metric,
999 double *distortion)
1000</pre>
1001
1002<p>A description of each parameter follows:</p>
1003
1004<h5>wand</h5>
1005<p>the magick wand.</p>
1006
1007<h5>reference</h5>
1008<p>the reference wand.</p>
1009
1010<h5>metric</h5>
1011<p>the metric.</p>
1012
1013<h5>distortion</h5>
1014<p>the computed distortion between the images.</p>
1015
1016 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]1017<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickCompositeImage">MagickCompositeImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]1018<div class="doc-section">
1019
1020<p>MagickCompositeImage() composite one image onto another at the specified offset.</p>
1021
1022<p>The format of the MagickCompositeImage method is:</p>
1023
1024<pre class="code">
1025 MagickBooleanType MagickCompositeImage(MagickWand *wand,
1026 const MagickWand *composite_wand,const CompositeOperator compose,
1027 const ssize_t x,const ssize_t y)
1028 MagickBooleanType MagickCompositeImageChannel(MagickWand *wand,
1029 const ChannelType channel,const MagickWand *composite_wand,
1030 const CompositeOperator compose,const ssize_t x,const ssize_t y)
1031</pre>
1032
1033<p>A description of each parameter follows:</p>
1034
1035<h5>wand</h5>
1036<p>the magick wand.</p>
1037
1038<h5>composite_image</h5>
1039<p>the composite image.</p>
1040
1041<h5>compose</h5>
1042<p>This operator affects how the composite is applied to the image. The default is Over. Choose from these operators:</p>
1043
1044<pre class="text">
1045 OverCompositeOp InCompositeOp OutCompositeOp
1046 AtopCompositeOp XorCompositeOp PlusCompositeOp
1047 MinusCompositeOp AddCompositeOp SubtractCompositeOp
1048 DifferenceCompositeOp BumpmapCompositeOp CopyCompositeOp
1049 DisplaceCompositeOp
1050</pre>
1051
1052<h5>x</h5>
1053<p>the column offset of the composited image.</p>
1054
1055<h5>y</h5>
1056<p>the row offset of the composited image.</p>
1057
1058 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]1059<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickContrastImage">MagickContrastImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]1060<div class="doc-section">
1061
1062<p>MagickContrastImage() enhances the intensity differences between the lighter and darker elements of the image. Set sharpen to a value other than 0 to increase the image contrast otherwise the contrast is reduced.</p>
1063
1064<p>The format of the MagickContrastImage method is:</p>
1065
1066<pre class="code">
1067 MagickBooleanType MagickContrastImage(MagickWand *wand,
1068 const MagickBooleanType sharpen)
1069</pre>
1070
1071<p>A description of each parameter follows:</p>
1072
1073<h5>wand</h5>
1074<p>the magick wand.</p>
1075
1076<h5>sharpen</h5>
1077<p>Increase or decrease image contrast.</p>
1078
1079
1080 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]1081<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickContrastStretchImage">MagickContrastStretchImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]1082<div class="doc-section">
1083
1084<p>MagickContrastStretchImage() enhances the contrast of a color image by adjusting the pixels color to span the entire range of colors available. You can also reduce the influence of a particular channel with a gamma value of 0.</p>
1085
1086<p>The format of the MagickContrastStretchImage method is:</p>
1087
1088<pre class="code">
1089 MagickBooleanType MagickContrastStretchImage(MagickWand *wand,
1090 const double black_point,const double white_point)
1091 MagickBooleanType MagickContrastStretchImageChannel(MagickWand *wand,
1092 const ChannelType channel,const double black_point,
1093 const double white_point)
1094</pre>
1095
1096<p>A description of each parameter follows:</p>
1097
1098<h5>wand</h5>
1099<p>the magick wand.</p>
1100
1101<h5>channel</h5>
1102<p>the image channel(s).</p>
1103
1104<h5>black_point</h5>
1105<p>the black point.</p>
1106
1107<h5>white_point</h5>
1108<p>the white point.</p>
1109
1110 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]1111<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickConvolveImage">MagickConvolveImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]1112<div class="doc-section">
1113
1114<p>MagickConvolveImage() applies a custom convolution kernel to the image.</p>
1115
1116<p>The format of the MagickConvolveImage method is:</p>
1117
1118<pre class="code">
1119 MagickBooleanType MagickConvolveImage(MagickWand *wand,
1120 const size_t order,const double *kernel)
1121 MagickBooleanType MagickConvolveImageChannel(MagickWand *wand,
1122 const ChannelType channel,const size_t order,
1123 const double *kernel)
1124</pre>
1125
1126<p>A description of each parameter follows:</p>
1127
1128<h5>wand</h5>
1129<p>the magick wand.</p>
1130
1131<h5>channel</h5>
1132<p>the image channel(s).</p>
1133
1134<h5>order</h5>
1135<p>the number of columns and rows in the filter kernel.</p>
1136
1137<h5>kernel</h5>
1138<p>An array of doubles representing the convolution kernel.</p>
1139
1140 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]1141<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickCropImage">MagickCropImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]1142<div class="doc-section">
1143
1144<p>MagickCropImage() extracts a region of the image.</p>
1145
1146<p>The format of the MagickCropImage method is:</p>
1147
1148<pre class="code">
1149 MagickBooleanType MagickCropImage(MagickWand *wand,
1150 const size_t width,const size_t height,const ssize_t x,const ssize_t y)
1151</pre>
1152
1153<p>A description of each parameter follows:</p>
1154
1155<h5>wand</h5>
1156<p>the magick wand.</p>
1157
1158<h5>width</h5>
1159<p>the region width.</p>
1160
1161<h5>height</h5>
1162<p>the region height.</p>
1163
1164<h5>x</h5>
1165<p>the region x-offset.</p>
1166
1167<h5>y</h5>
1168<p>the region y-offset.</p>
1169
1170 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]1171<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickCycleColormapImage">MagickCycleColormapImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]1172<div class="doc-section">
1173
1174<p>MagickCycleColormapImage() displaces an image's colormap by a given number of positions. If you cycle the colormap a number of times you can produce a psychodelic effect.</p>
1175
1176<p>The format of the MagickCycleColormapImage method is:</p>
1177
1178<pre class="code">
1179 MagickBooleanType MagickCycleColormapImage(MagickWand *wand,
1180 const ssize_t displace)
1181</pre>
1182
1183<p>A description of each parameter follows:</p>
1184
1185<h5>wand</h5>
1186<p>the magick wand.</p>
1187
1188<h5>pixel_wand</h5>
1189<p>the pixel wand.</p>
1190
1191 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]1192<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickConstituteImage">MagickConstituteImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]1193<div class="doc-section">
1194
1195<p>MagickConstituteImage() adds an image to the wand comprised of the pixel data you supply. The pixel data must be in scanline order top-to-bottom. The data can be char, short int, int, float, or double. Float and double require the pixels to be normalized [0..1], otherwise [0..Max], where Max is the maximum value the type can accomodate (e.g. 255 for char). For example, to create a 640x480 image from unsigned red-green-blue character data, use</p>
1196
1197<p>MagickConstituteImage(wand,640,640,"RGB",CharPixel,pixels);</p>
1198
1199<p>The format of the MagickConstituteImage method is:</p>
1200
1201<pre class="code">
1202 MagickBooleanType MagickConstituteImage(MagickWand *wand,
1203 const size_t columns,const size_t rows,const char *map,
1204 const StorageType storage,void *pixels)
1205</pre>
1206
1207<p>A description of each parameter follows:</p>
1208
1209<h5>wand</h5>
1210<p>the magick wand.</p>
1211
1212<h5>columns</h5>
1213<p>width in pixels of the image.</p>
1214
1215<h5>rows</h5>
1216<p>height in pixels of the image.</p>
1217
1218<h5>map</h5>
1219<p>This string reflects the expected ordering of the pixel array. It can be any combination or order of R = red, G = green, B = blue, A = alpha (0 is transparent), O = opacity (0 is opaque), C = cyan, Y = yellow, M = magenta, K = black, I = intensity (for grayscale), P = pad.</p>
1220
1221<h5>storage</h5>
1222<p>Define the data type of the pixels. Float and double types are expected to be normalized [0..1] otherwise [0..QuantumRange]. Choose from these types: CharPixel, DoublePixel, FloatPixel, IntegerPixel, LongPixel, QuantumPixel, or ShortPixel.</p>
1223
1224<h5>pixels</h5>
1225<p>This array of values contain the pixel components as defined by map and type. You must preallocate this array where the expected length varies depending on the values of width, height, map, and type.</p>
1226
1227
1228 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]1229<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickDecipherImage">MagickDecipherImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]1230<div class="doc-section">
1231
1232<p>MagickDecipherImage() converts cipher pixels to plain pixels.</p>
1233
1234<p>The format of the MagickDecipherImage method is:</p>
1235
1236<pre class="code">
1237 MagickBooleanType MagickDecipherImage(MagickWand *wand,
1238 const char *passphrase)
1239</pre>
1240
1241<p>A description of each parameter follows:</p>
1242
1243<h5>wand</h5>
1244<p>the magick wand.</p>
1245
1246<h5>passphrase</h5>
1247<p>the passphrase.</p>
1248
1249 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]1250<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickDeconstructImages">MagickDeconstructImages</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]1251<div class="doc-section">
1252
1253<p>MagickDeconstructImages() compares each image with the next in a sequence and returns the maximum bounding region of any pixel differences it discovers.</p>
1254
1255<p>The format of the MagickDeconstructImages method is:</p>
1256
1257<pre class="code">
1258 MagickWand *MagickDeconstructImages(MagickWand *wand)
1259</pre>
1260
1261<p>A description of each parameter follows:</p>
1262
1263<h5>wand</h5>
1264<p>the magick wand.</p>
1265
1266 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]1267<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickDeskewImage">MagickDeskewImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]1268<div class="doc-section">
1269
1270<p>MagickDeskewImage() removes skew from the image. Skew is an artifact that occurs in scanned images because of the camera being misaligned, imperfections in the scanning or surface, or simply because the paper was not placed completely flat when scanned.</p>
1271
1272<p>The format of the MagickDeskewImage method is:</p>
1273
1274<pre class="code">
1275 MagickBooleanType MagickDeskewImage(MagickWand *wand,
1276 const double threshold)
1277</pre>
1278
1279<p>A description of each parameter follows:</p>
1280
1281<h5>wand</h5>
1282<p>the magick wand.</p>
1283
1284<h5>threshold</h5>
1285<p>separate background from foreground.</p>
1286
1287 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]1288<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickDespeckleImage">MagickDespeckleImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]1289<div class="doc-section">
1290
1291<p>MagickDespeckleImage() reduces the speckle noise in an image while perserving the edges of the original image.</p>
1292
1293<p>The format of the MagickDespeckleImage method is:</p>
1294
1295<pre class="code">
1296 MagickBooleanType MagickDespeckleImage(MagickWand *wand)
1297</pre>
1298
1299<p>A description of each parameter follows:</p>
1300
1301<h5>wand</h5>
1302<p>the magick wand.</p>
1303
1304 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]1305<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickDestroyImage">MagickDestroyImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]1306<div class="doc-section">
1307
1308<p>MagickDestroyImage() dereferences an image, deallocating memory associated with the image if the reference count becomes zero.</p>
1309
1310<p>The format of the MagickDestroyImage method is:</p>
1311
1312<pre class="code">
1313 Image *MagickDestroyImage(Image *image)
1314</pre>
1315
1316<p>A description of each parameter follows:</p>
1317
1318<h5>image</h5>
1319<p>the image.</p>
1320
1321 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]1322<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickDisplayImage">MagickDisplayImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]1323<div class="doc-section">
1324
1325<p>MagickDisplayImage() displays an image.</p>
1326
1327<p>The format of the MagickDisplayImage method is:</p>
1328
1329<pre class="code">
1330 MagickBooleanType MagickDisplayImage(MagickWand *wand,
1331 const char *server_name)
1332</pre>
1333
1334<p>A description of each parameter follows:</p>
1335
1336<h5>wand</h5>
1337<p>the magick wand.</p>
1338
1339<h5>server_name</h5>
1340<p>the X server name.</p>
1341
1342 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]1343<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickDisplayImages">MagickDisplayImages</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]1344<div class="doc-section">
1345
1346<p>MagickDisplayImages() displays an image or image sequence.</p>
1347
1348<p>The format of the MagickDisplayImages method is:</p>
1349
1350<pre class="code">
1351 MagickBooleanType MagickDisplayImages(MagickWand *wand,
1352 const char *server_name)
1353</pre>
1354
1355<p>A description of each parameter follows:</p>
1356
1357<h5>wand</h5>
1358<p>the magick wand.</p>
1359
1360<h5>server_name</h5>
1361<p>the X server name.</p>
1362
1363 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]1364<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickDistortImage">MagickDistortImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]1365<div class="doc-section">
1366
1367<p>MagickDistortImage() distorts an image using various distortion methods, by mapping color lookups of the source image to a new destination image usally of the same size as the source image, unless 'bestfit' is set to true.</p>
1368
1369<p>If 'bestfit' is enabled, and distortion allows it, the destination image is adjusted to ensure the whole source 'image' will just fit within the final destination image, which will be sized and offset accordingly. Also in many cases the virtual offset of the source image will be taken into account in the mapping.</p>
1370
1371<p>The format of the MagickDistortImage method is:</p>
1372
1373<pre class="code">
1374 MagickBooleanType MagickDistortImage(MagickWand *wand,
1375 const DistortImageMethod method,const size_t number_arguments,
1376 const double *arguments,const MagickBooleanType bestfit)
1377</pre>
1378
1379<p>A description of each parameter follows:</p>
1380
1381<h5>image</h5>
1382<p>the image to be distorted.</p>
1383
1384<h5>method</h5>
1385<p>the method of image distortion.</p>
1386
1387<p>ArcDistortion always ignores the source image offset, and always 'bestfit' the destination image with the top left corner offset relative to the polar mapping center.</p>
1388
1389<p>Bilinear has no simple inverse mapping so it does not allow 'bestfit' style of image distortion.</p>
1390
1391<p>Affine, Perspective, and Bilinear, do least squares fitting of the distortion when more than the minimum number of control point pairs are provided.</p>
1392
1393<p>Perspective, and Bilinear, falls back to a Affine distortion when less that 4 control point pairs are provided. While Affine distortions let you use any number of control point pairs, that is Zero pairs is a no-Op (viewport only) distrotion, one pair is a translation and two pairs of control points do a scale-rotate-translate, without any shearing.</p>
1394
1395<h5>number_arguments</h5>
1396<p>the number of arguments given for this distortion method.</p>
1397
1398<h5>arguments</h5>
1399<p>the arguments for this distortion method.</p>
1400
1401<h5>bestfit</h5>
1402<p>Attempt to resize destination to fit distorted source.</p>
1403
1404 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]1405<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickDrawImage">MagickDrawImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]1406<div class="doc-section">
1407
1408<p>MagickDrawImage() renders the drawing wand on the current image.</p>
1409
1410<p>The format of the MagickDrawImage method is:</p>
1411
1412<pre class="code">
1413 MagickBooleanType MagickDrawImage(MagickWand *wand,
1414 const DrawingWand *drawing_wand)
1415</pre>
1416
1417<p>A description of each parameter follows:</p>
1418
1419<h5>wand</h5>
1420<p>the magick wand.</p>
1421
1422<h5>drawing_wand</h5>
1423<p>the draw wand.</p>
1424
1425 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]1426<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickEdgeImage">MagickEdgeImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]1427<div class="doc-section">
1428
1429<p>MagickEdgeImage() enhance edges within the image with a convolution filter of the given radius. Use a radius of 0 and Edge() selects a suitable radius for you.</p>
1430
1431<p>The format of the MagickEdgeImage method is:</p>
1432
1433<pre class="code">
1434 MagickBooleanType MagickEdgeImage(MagickWand *wand,const double radius)
1435</pre>
1436
1437<p>A description of each parameter follows:</p>
1438
1439<h5>wand</h5>
1440<p>the magick wand.</p>
1441
1442<h5>radius</h5>
1443<p>the radius of the pixel neighborhood.</p>
1444
1445 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]1446<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickEmbossImage">MagickEmbossImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]1447<div class="doc-section">
1448
1449<p>MagickEmbossImage() returns a grayscale image with a three-dimensional effect. We convolve the image with a Gaussian operator of the given radius and standard deviation (sigma). For reasonable results, radius should be larger than sigma. Use a radius of 0 and Emboss() selects a suitable radius for you.</p>
1450
1451<p>The format of the MagickEmbossImage method is:</p>
1452
1453<pre class="code">
1454 MagickBooleanType MagickEmbossImage(MagickWand *wand,const double radius,
1455 const double sigma)
1456</pre>
1457
1458<p>A description of each parameter follows:</p>
1459
1460<h5>wand</h5>
1461<p>the magick wand.</p>
1462
1463<h5>radius</h5>
1464<p>the radius of the Gaussian, in pixels, not counting the center pixel.</p>
1465
1466<h5>sigma</h5>
1467<p>the standard deviation of the Gaussian, in pixels.</p>
1468
1469 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]1470<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickEncipherImage">MagickEncipherImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]1471<div class="doc-section">
1472
1473<p>MagickEncipherImage() converts plaint pixels to cipher pixels.</p>
1474
1475<p>The format of the MagickEncipherImage method is:</p>
1476
1477<pre class="code">
1478 MagickBooleanType MagickEncipherImage(MagickWand *wand,
1479 const char *passphrase)
1480</pre>
1481
1482<p>A description of each parameter follows:</p>
1483
1484<h5>wand</h5>
1485<p>the magick wand.</p>
1486
1487<h5>passphrase</h5>
1488<p>the passphrase.</p>
1489
1490 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]1491<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickEnhanceImage">MagickEnhanceImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]1492<div class="doc-section">
1493
1494<p>MagickEnhanceImage() applies a digital filter that improves the quality of a noisy image.</p>
1495
1496<p>The format of the MagickEnhanceImage method is:</p>
1497
1498<pre class="code">
1499 MagickBooleanType MagickEnhanceImage(MagickWand *wand)
1500</pre>
1501
1502<p>A description of each parameter follows:</p>
1503
1504<h5>wand</h5>
1505<p>the magick wand.</p>
1506
1507 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]1508<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickEqualizeImage">MagickEqualizeImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]1509<div class="doc-section">
1510
1511<p>MagickEqualizeImage() equalizes the image histogram.</p>
1512
1513<p>The format of the MagickEqualizeImage method is:</p>
1514
1515<pre class="code">
1516 MagickBooleanType MagickEqualizeImage(MagickWand *wand)
1517 MagickBooleanType MagickEqualizeImageChannel(MagickWand *wand,
1518 const ChannelType channel)
1519</pre>
1520
1521<p>A description of each parameter follows:</p>
1522
1523<h5>wand</h5>
1524<p>the magick wand.</p>
1525
1526<h5>channel</h5>
1527<p>the image channel(s).</p>
1528
1529 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]1530<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickEvaluateImage">MagickEvaluateImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]1531<div class="doc-section">
1532
1533<p>MagickEvaluateImage() applys an arithmetic, relational, or logical expression to an image. Use these operators to lighten or darken an image, to increase or decrease contrast in an image, or to produce the "negative" of an image.</p>
1534
1535<p>The format of the MagickEvaluateImage method is:</p>
1536
1537<pre class="code">
1538 MagickBooleanType MagickEvaluateImage(MagickWand *wand,
1539 const MagickEvaluateOperator operator,const double value)
1540 MagickBooleanType MagickEvaluateImages(MagickWand *wand,
1541 const MagickEvaluateOperator operator)
1542 MagickBooleanType MagickEvaluateImageChannel(MagickWand *wand,
1543 const ChannelType channel,const MagickEvaluateOperator op,
1544 const double value)
1545</pre>
1546
1547<p>A description of each parameter follows:</p>
1548
1549<h5>wand</h5>
1550<p>the magick wand.</p>
1551
1552<h5>channel</h5>
1553<p>the channel(s).</p>
1554
1555<h5>op</h5>
1556<p>A channel operator.</p>
1557
1558<h5>value</h5>
1559<p>A value value.</p>
1560
1561 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]1562<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickExportImagePixels">MagickExportImagePixels</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]1563<div class="doc-section">
1564
1565<p>MagickExportImagePixels() extracts pixel data from an image and returns it to you. The method returns MagickTrue on success otherwise MagickFalse if an error is encountered. The data is returned as char, short int, int, ssize_t, float, or double in the order specified by map.</p>
1566
1567<p>Suppose you want to extract the first scanline of a 640x480 image as character data in red-green-blue order:</p>
1568
1569<pre class="text">
1570 MagickExportImagePixels(wand,0,0,640,1,"RGB",CharPixel,pixels);
1571</pre>
1572
1573<p>The format of the MagickExportImagePixels method is:</p>
1574
1575<pre class="code">
1576 MagickBooleanType MagickExportImagePixels(MagickWand *wand,
1577 const ssize_t x,const ssize_t y,const size_t columns,
1578 const size_t rows,const char *map,const StorageType storage,
1579 void *pixels)
1580</pre>
1581
1582<p>A description of each parameter follows:</p>
1583
1584<h5>wand</h5>
1585<p>the magick wand.</p>
1586
1587<h5>x, y, columns, rows</h5>
1588<p>These values define the perimeter of a region of pixels you want to extract.</p>
1589
1590<h5>map</h5>
1591<p>This string reflects the expected ordering of the pixel array. It can be any combination or order of R = red, G = green, B = blue, A = alpha (0 is transparent), O = opacity (0 is opaque), C = cyan, Y = yellow, M = magenta, K = black, I = intensity (for grayscale), P = pad.</p>
1592
1593<h5>storage</h5>
1594<p>Define the data type of the pixels. Float and double types are expected to be normalized [0..1] otherwise [0..QuantumRange]. Choose from these types: CharPixel, DoublePixel, FloatPixel, IntegerPixel, LongPixel, QuantumPixel, or ShortPixel.</p>
1595
1596<h5>pixels</h5>
1597<p>This array of values contain the pixel components as defined by map and type. You must preallocate this array where the expected length varies depending on the values of width, height, map, and type.</p>
1598
1599 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]1600<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickExtentImage">MagickExtentImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]1601<div class="doc-section">
1602
1603<p>MagickExtentImage() extends the image as defined by the geometry, gravity, and wand background color. Set the (x,y) offset of the geometry to move the original wand relative to the extended wand.</p>
1604
1605<p>The format of the MagickExtentImage method is:</p>
1606
1607<pre class="code">
1608 MagickBooleanType MagickExtentImage(MagickWand *wand,
1609 const size_t width,const size_t height,const ssize_t x,
1610 const ssize_t y)
1611</pre>
1612
1613<p>A description of each parameter follows:</p>
1614
1615<h5>wand</h5>
1616<p>the magick wand.</p>
1617
1618<h5>width</h5>
1619<p>the region width.</p>
1620
1621<h5>height</h5>
1622<p>the region height.</p>
1623
1624<h5>x</h5>
1625<p>the region x offset.</p>
1626
1627<h5>y</h5>
1628<p>the region y offset.</p>
1629
1630 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]1631<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickFilterImage">MagickFilterImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]1632<div class="doc-section">
1633
1634<p>MagickFilterImage() applies a custom convolution kernel to the image.</p>
1635
1636<p>The format of the MagickFilterImage method is:</p>
1637
1638<pre class="code">
1639 MagickBooleanType MagickFilterImage(MagickWand *wand,
1640 const KernelInfo *kernel)
1641 MagickBooleanType MagickFilterImageChannel(MagickWand *wand,
1642 const ChannelType channel,const KernelInfo *kernel)
1643</pre>
1644
1645<p>A description of each parameter follows:</p>
1646
1647<h5>wand</h5>
1648<p>the magick wand.</p>
1649
1650<h5>channel</h5>
1651<p>the image channel(s).</p>
1652
1653<h5>kernel</h5>
1654<p>An array of doubles representing the convolution kernel.</p>
1655
1656 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]1657<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickFlipImage">MagickFlipImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]1658<div class="doc-section">
1659
1660<p>MagickFlipImage() creates a vertical mirror image by reflecting the pixels around the central x-axis.</p>
1661
1662<p>The format of the MagickFlipImage method is:</p>
1663
1664<pre class="code">
1665 MagickBooleanType MagickFlipImage(MagickWand *wand)
1666</pre>
1667
1668<p>A description of each parameter follows:</p>
1669
1670<h5>wand</h5>
1671<p>the magick wand.</p>
1672
1673 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]1674<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickFloodfillPaintImage">MagickFloodfillPaintImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]1675<div class="doc-section">
1676
1677<p>MagickFloodfillPaintImage() changes the color value of any pixel that matches target and is an immediate neighbor. If the method FillToBorderMethod is specified, the color value is changed for any neighbor pixel that does not match the bordercolor member of image.</p>
1678
1679<p>The format of the MagickFloodfillPaintImage method is:</p>
1680
1681<pre class="code">
1682 MagickBooleanType MagickFloodfillPaintImage(MagickWand *wand,
1683 const ChannelType channel,const PixelWand *fill,const double fuzz,
1684 const PixelWand *bordercolor,const ssize_t x,const ssize_t y,
1685 const MagickBooleanType invert)
1686</pre>
1687
1688<p>A description of each parameter follows:</p>
1689
1690<h5>wand</h5>
1691<p>the magick wand.</p>
1692
1693<h5>channel</h5>
1694<p>the channel(s).</p>
1695
1696<h5>fill</h5>
1697<p>the floodfill color pixel wand.</p>
1698
1699<h5>fuzz</h5>
1700<p>By default target must match a particular pixel color exactly. However, in many cases two colors may differ by a small amount. The fuzz member of image defines how much tolerance is acceptable to consider two colors as the same. For example, set fuzz to 10 and the color red at intensities of 100 and 102 respectively are now interpreted as the same color for the purposes of the floodfill.</p>
1701
1702<h5>bordercolor</h5>
1703<p>the border color pixel wand.</p>
1704
1705<h5>x,y</h5>
1706<p>the starting location of the operation.</p>
1707
1708<h5>invert</h5>
1709<p>paint any pixel that does not match the target color.</p>
1710
1711 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]1712<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickFlopImage">MagickFlopImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]1713<div class="doc-section">
1714
1715<p>MagickFlopImage() creates a horizontal mirror image by reflecting the pixels around the central y-axis.</p>
1716
1717<p>The format of the MagickFlopImage method is:</p>
1718
1719<pre class="code">
1720 MagickBooleanType MagickFlopImage(MagickWand *wand)
1721</pre>
1722
1723<p>A description of each parameter follows:</p>
1724
1725<h5>wand</h5>
1726<p>the magick wand.</p>
1727
1728 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]1729<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickForwardFourierTransformImage">MagickForwardFourierTransformImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]1730<div class="doc-section">
1731
1732<p>MagickForwardFourierTransformImage() implements the discrete Fourier transform (DFT) of the image either as a magnitude / phase or real / imaginary image pair.</p>
1733
1734<p>The format of the MagickForwardFourierTransformImage method is:</p>
1735
1736<pre class="code">
1737 MagickBooleanType MagickForwardFourierTransformImage(MagickWand *wand,
1738 const MagickBooleanType magnitude)
1739</pre>
1740
1741<p>A description of each parameter follows:</p>
1742
1743<h5>wand</h5>
1744<p>the magick wand.</p>
1745
1746<h5>magnitude</h5>
1747<p>if true, return as magnitude / phase pair otherwise a real / imaginary image pair.</p>
1748
1749 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]1750<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickFrameImage">MagickFrameImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]1751<div class="doc-section">
1752
1753<p>MagickFrameImage() adds a simulated three-dimensional border around the image. The width and height specify the border width of the vertical and horizontal sides of the frame. The inner and outer bevels indicate the width of the inner and outer shadows of the frame.</p>
1754
1755<p>The format of the MagickFrameImage method is:</p>
1756
1757<pre class="code">
1758 MagickBooleanType MagickFrameImage(MagickWand *wand,
1759 const PixelWand *matte_color,const size_t width,
1760 const size_t height,const ssize_t inner_bevel,
1761 const ssize_t outer_bevel)
1762</pre>
1763
1764<p>A description of each parameter follows:</p>
1765
1766<h5>wand</h5>
1767<p>the magick wand.</p>
1768
1769<h5>matte_color</h5>
1770<p>the frame color pixel wand.</p>
1771
1772<h5>width</h5>
1773<p>the border width.</p>
1774
1775<h5>height</h5>
1776<p>the border height.</p>
1777
1778<h5>inner_bevel</h5>
1779<p>the inner bevel width.</p>
1780
1781<h5>outer_bevel</h5>
1782<p>the outer bevel width.</p>
1783
1784 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]1785<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickFunctionImage">MagickFunctionImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]1786<div class="doc-section">
1787
1788<p>MagickFunctionImage() applys an arithmetic, relational, or logical expression to an image. Use these operators to lighten or darken an image, to increase or decrease contrast in an image, or to produce the "negative" of an image.</p>
1789
1790<p>The format of the MagickFunctionImage method is:</p>
1791
1792<pre class="code">
1793 MagickBooleanType MagickFunctionImage(MagickWand *wand,
1794 const MagickFunction function,const size_t number_arguments,
1795 const double *arguments)
1796 MagickBooleanType MagickFunctionImageChannel(MagickWand *wand,
1797 const ChannelType channel,const MagickFunction function,
1798 const size_t number_arguments,const double *arguments)
1799</pre>
1800
1801<p>A description of each parameter follows:</p>
1802
1803<h5>wand</h5>
1804<p>the magick wand.</p>
1805
1806<h5>channel</h5>
1807<p>the channel(s).</p>
1808
1809<h5>function</h5>
1810<p>the image function.</p>
1811
1812<h5>number_arguments</h5>
1813<p>the number of function arguments.</p>
1814
1815<h5>arguments</h5>
1816<p>the function arguments.</p>
1817
1818 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]1819<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickFxImage">MagickFxImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]1820<div class="doc-section">
1821
1822<p>MagickFxImage() evaluate expression for each pixel in the image.</p>
1823
1824<p>The format of the MagickFxImage method is:</p>
1825
1826<pre class="code">
1827 MagickWand *MagickFxImage(MagickWand *wand,const char *expression)
1828 MagickWand *MagickFxImageChannel(MagickWand *wand,
1829 const ChannelType channel,const char *expression)
1830</pre>
1831
1832<p>A description of each parameter follows:</p>
1833
1834<h5>wand</h5>
1835<p>the magick wand.</p>
1836
1837<h5>channel</h5>
1838<p>the image channel(s).</p>
1839
1840<h5>expression</h5>
1841<p>the expression.</p>
1842
1843 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]1844<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickGammaImage">MagickGammaImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]1845<div class="doc-section">
1846
1847<p>MagickGammaImage() gamma-corrects an image. The same image viewed on different devices will have perceptual differences in the way the image's intensities are represented on the screen. Specify individual gamma levels for the red, green, and blue channels, or adjust all three with the gamma parameter. Values typically range from 0.8 to 2.3.</p>
1848
1849<p>You can also reduce the influence of a particular channel with a gamma value of 0.</p>
1850
1851<p>The format of the MagickGammaImage method is:</p>
1852
1853<pre class="code">
1854 MagickBooleanType MagickGammaImage(MagickWand *wand,const double gamma)
1855 MagickBooleanType MagickGammaImageChannel(MagickWand *wand,
1856 const ChannelType channel,const double gamma)
1857</pre>
1858
1859<p>A description of each parameter follows:</p>
1860
1861<h5>wand</h5>
1862<p>the magick wand.</p>
1863
1864<h5>channel</h5>
1865<p>the channel.</p>
1866
1867<h5>level</h5>
1868<p>Define the level of gamma correction.</p>
1869
1870 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]1871<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickGaussianBlurImage">MagickGaussianBlurImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]1872<div class="doc-section">
1873
1874<p>MagickGaussianBlurImage() blurs an image. We convolve the image with a Gaussian operator of the given radius and standard deviation (sigma). For reasonable results, the radius should be larger than sigma. Use a radius of 0 and MagickGaussianBlurImage() selects a suitable radius for you.</p>
1875
1876<p>The format of the MagickGaussianBlurImage method is:</p>
1877
1878<pre class="code">
1879 MagickBooleanType MagickGaussianBlurImage(MagickWand *wand,
1880 const double radius,const double sigma)
1881 MagickBooleanType MagickGaussianBlurImageChannel(MagickWand *wand,
1882 const ChannelType channel,const double radius,const double sigma)
1883</pre>
1884
1885<p>A description of each parameter follows:</p>
1886
1887<h5>wand</h5>
1888<p>the magick wand.</p>
1889
1890<h5>channel</h5>
1891<p>the image channel(s).</p>
1892
1893<h5>radius</h5>
1894<p>the radius of the Gaussian, in pixels, not counting the center pixel.</p>
1895
1896<h5>sigma</h5>
1897<p>the standard deviation of the Gaussian, in pixels.</p>
1898
1899 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]1900<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickGetImage">MagickGetImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]1901<div class="doc-section">
1902
1903<p>MagickGetImage() gets the image at the current image index.</p>
1904
1905<p>The format of the MagickGetImage method is:</p>
1906
1907<pre class="code">
1908 MagickWand *MagickGetImage(MagickWand *wand)
1909</pre>
1910
1911<p>A description of each parameter follows:</p>
1912
1913<h5>wand</h5>
1914<p>the magick wand.</p>
1915
1916 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]1917<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickGetImageAlphaChannel">MagickGetImageAlphaChannel</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]1918<div class="doc-section">
1919
1920<p>MagickGetImageAlphaChannel() returns MagickFalse if the image alpha channel is not activated. That is, the image is RGB rather than RGBA or CMYK rather than CMYKA.</p>
1921
1922<p>The format of the MagickGetImageAlphaChannel method is:</p>
1923
1924<pre class="code">
1925 size_t MagickGetImageAlphaChannel(MagickWand *wand)
1926</pre>
1927
1928<p>A description of each parameter follows:</p>
1929
1930<h5>wand</h5>
1931<p>the magick wand.</p>
1932
1933 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]1934<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickGetImageClipMask">MagickGetImageClipMask</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]1935<div class="doc-section">
1936
1937<p>MagickGetImageClipMask() gets the image clip mask at the current image index.</p>
1938
1939<p>The format of the MagickGetImageClipMask method is:</p>
1940
1941<pre class="code">
1942 MagickWand *MagickGetImageClipMask(MagickWand *wand)
1943</pre>
1944
1945<p>A description of each parameter follows:</p>
1946
1947<h5>wand</h5>
1948<p>the magick wand.</p>
1949
1950 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]1951<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickGetImageBackgroundColor">MagickGetImageBackgroundColor</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]1952<div class="doc-section">
1953
1954<p>MagickGetImageBackgroundColor() returns the image background color.</p>
1955
1956<p>The format of the MagickGetImageBackgroundColor method is:</p>
1957
1958<pre class="code">
1959 MagickBooleanType MagickGetImageBackgroundColor(MagickWand *wand,
1960 PixelWand *background_color)
1961</pre>
1962
1963<p>A description of each parameter follows:</p>
1964
1965<h5>wand</h5>
1966<p>the magick wand.</p>
1967
1968<h5>background_color</h5>
1969<p>Return the background color.</p>
1970
1971 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]1972<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickGetImageBlob">MagickGetImageBlob</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]1973<div class="doc-section">
1974
1975<p>MagickGetImageBlob() implements direct to memory image formats. It returns the image as a blob (a formatted "file" in memory) and its length, starting from the current position in the image sequence. Use MagickSetImageFormat() to set the format to write to the blob (GIF, JPEG, PNG, etc.).</p>
1976
1977<p>Utilize MagickResetIterator() to ensure the write is from the beginning of the image sequence.</p>
1978
1979<p>Use MagickRelinquishMemory() to free the blob when you are done with it.</p>
1980
1981<p>The format of the MagickGetImageBlob method is:</p>
1982
1983<pre class="code">
1984 unsigned char *MagickGetImageBlob(MagickWand *wand,size_t *length)
1985</pre>
1986
1987<p>A description of each parameter follows:</p>
1988
1989<h5>wand</h5>
1990<p>the magick wand.</p>
1991
1992<h5>length</h5>
1993<p>the length of the blob.</p>
1994
1995 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]1996<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickGetImageBlob">MagickGetImageBlob</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]1997<div class="doc-section">
1998
1999<p>MagickGetImageBlob() implements direct to memory image formats. It returns the image sequence as a blob and its length. The format of the image determines the format of the returned blob (GIF, JPEG, PNG, etc.). To return a different image format, use MagickSetImageFormat().</p>
2000
2001<p>Note, some image formats do not permit multiple images to the same image stream (e.g. JPEG). in this instance, just the first image of the sequence is returned as a blob.</p>
2002
2003<p>The format of the MagickGetImagesBlob method is:</p>
2004
2005<pre class="code">
2006 unsigned char *MagickGetImagesBlob(MagickWand *wand,size_t *length)
2007</pre>
2008
2009<p>A description of each parameter follows:</p>
2010
2011<h5>wand</h5>
2012<p>the magick wand.</p>
2013
2014<h5>length</h5>
2015<p>the length of the blob.</p>
2016
2017 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]2018<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickGetImageBluePrimary">MagickGetImageBluePrimary</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]2019<div class="doc-section">
2020
2021<p>MagickGetImageBluePrimary() returns the chromaticy blue primary point for the image.</p>
2022
2023<p>The format of the MagickGetImageBluePrimary method is:</p>
2024
2025<pre class="code">
2026 MagickBooleanType MagickGetImageBluePrimary(MagickWand *wand,double *x,
2027 double *y)
2028</pre>
2029
2030<p>A description of each parameter follows:</p>
2031
2032<h5>wand</h5>
2033<p>the magick wand.</p>
2034
2035<h5>x</h5>
2036<p>the chromaticity blue primary x-point.</p>
2037
2038<h5>y</h5>
2039<p>the chromaticity blue primary y-point.</p>
2040
2041 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]2042<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickGetImageBorderColor">MagickGetImageBorderColor</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]2043<div class="doc-section">
2044
2045<p>MagickGetImageBorderColor() returns the image border color.</p>
2046
2047<p>The format of the MagickGetImageBorderColor method is:</p>
2048
2049<pre class="code">
2050 MagickBooleanType MagickGetImageBorderColor(MagickWand *wand,
2051 PixelWand *border_color)
2052</pre>
2053
2054<p>A description of each parameter follows:</p>
2055
2056<h5>wand</h5>
2057<p>the magick wand.</p>
2058
2059<h5>border_color</h5>
2060<p>Return the border color.</p>
2061
2062 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]2063<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickGetImageChannelDepth">MagickGetImageChannelDepth</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]2064<div class="doc-section">
2065
2066<p>MagickGetImageChannelDepth() gets the depth for one or more image channels.</p>
2067
2068<p>The format of the MagickGetImageChannelDepth method is:</p>
2069
2070<pre class="code">
2071 size_t MagickGetImageChannelDepth(MagickWand *wand,
2072 const ChannelType channel)
2073</pre>
2074
2075<p>A description of each parameter follows:</p>
2076
2077<h5>wand</h5>
2078<p>the magick wand.</p>
2079
2080<h5>channel</h5>
2081<p>the image channel(s).</p>
2082
2083 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]2084<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickGetImageChannelDistortion">MagickGetImageChannelDistortion</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]2085<div class="doc-section">
2086
2087<p>MagickGetImageChannelDistortion() compares one or more image channels of an image to a reconstructed image and returns the specified distortion metric.</p>
2088
2089<p>The format of the MagickGetImageChannelDistortion method is:</p>
2090
2091<pre class="code">
2092 MagickBooleanType MagickGetImageChannelDistortion(MagickWand *wand,
2093 const MagickWand *reference,const ChannelType channel,
2094 const MetricType metric,double *distortion)
2095</pre>
2096
2097<p>A description of each parameter follows:</p>
2098
2099<h5>wand</h5>
2100<p>the magick wand.</p>
2101
2102<h5>reference</h5>
2103<p>the reference wand.</p>
2104
2105<h5>channel</h5>
2106<p>the channel.</p>
2107
2108<h5>metric</h5>
2109<p>the metric.</p>
2110
2111<h5>distortion</h5>
2112<p>the computed distortion between the images.</p>
2113
2114 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]2115<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickGetImageChannelDistortions">MagickGetImageChannelDistortions</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]2116<div class="doc-section">
2117
2118<p>MagickGetImageChannelDistortions() compares one or more image channels of an image to a reconstructed image and returns the specified distortion metrics.</p>
2119
2120<p>Use MagickRelinquishMemory() to free the metrics when you are done with them.</p>
2121
2122<p>The format of the MagickGetImageChannelDistortion method is:</p>
2123
2124<pre class="code">
2125 double *MagickGetImageChannelDistortion(MagickWand *wand,
2126 const MagickWand *reference,const MetricType metric)
2127</pre>
2128
2129<p>A description of each parameter follows:</p>
2130
2131<h5>wand</h5>
2132<p>the magick wand.</p>
2133
2134<h5>reference</h5>
2135<p>the reference wand.</p>
2136
2137<h5>metric</h5>
2138<p>the metric.</p>
2139
2140 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]2141<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickGetImageChannelFeatures">MagickGetImageChannelFeatures</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]2142<div class="doc-section">
2143
2144<p>MagickGetImageChannelFeatures() returns features for each channel in the image in each of four directions (horizontal, vertical, left and right diagonals) for the specified distance. The features include the angular second moment, contrast, correlation, sum of squares: variance, inverse difference moment, sum average, sum varience, sum entropy, entropy, difference variance, difference entropy, information measures of correlation 1, information measures of correlation 2, and maximum correlation coefficient. You can access the red channel contrast, for example, like this:</p>
2145
2146<pre class="text">
2147 channel_features=MagickGetImageChannelFeatures(wand,1);
2148 contrast=channel_features[RedChannel].contrast[0];
2149</pre>
2150
2151<p>Use MagickRelinquishMemory() to free the statistics buffer.</p>
2152
2153<p>The format of the MagickGetImageChannelFeatures method is:</p>
2154
2155<pre class="code">
2156 ChannelFeatures *MagickGetImageChannelFeatures(MagickWand *wand,
2157 const size_t distance)
2158</pre>
2159
2160<p>A description of each parameter follows:</p>
2161
2162<h5>wand</h5>
2163<p>the magick wand.</p>
2164
2165<h5>distance</h5>
2166<p>the distance.</p>
2167
2168 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]2169<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickGetImageChannelKurtosis">MagickGetImageChannelKurtosis</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]2170<div class="doc-section">
2171
2172<p>MagickGetImageChannelKurtosis() gets the kurtosis and skewness of one or more image channels.</p>
2173
2174<p>The format of the MagickGetImageChannelKurtosis method is:</p>
2175
2176<pre class="code">
2177 MagickBooleanType MagickGetImageChannelKurtosis(MagickWand *wand,
2178 const ChannelType channel,double *kurtosis,double *skewness)
2179</pre>
2180
2181<p>A description of each parameter follows:</p>
2182
2183<h5>wand</h5>
2184<p>the magick wand.</p>
2185
2186<h5>channel</h5>
2187<p>the image channel(s).</p>
2188
2189<h5>kurtosis</h5>
2190<p>The kurtosis for the specified channel(s).</p>
2191
2192<h5>skewness</h5>
2193<p>The skewness for the specified channel(s).</p>
2194
2195 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]2196<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickGetImageChannelMean">MagickGetImageChannelMean</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]2197<div class="doc-section">
2198
2199<p>MagickGetImageChannelMean() gets the mean and standard deviation of one or more image channels.</p>
2200
2201<p>The format of the MagickGetImageChannelMean method is:</p>
2202
2203<pre class="code">
2204 MagickBooleanType MagickGetImageChannelMean(MagickWand *wand,
2205 const ChannelType channel,double *mean,double *standard_deviation)
2206</pre>
2207
2208<p>A description of each parameter follows:</p>
2209
2210<h5>wand</h5>
2211<p>the magick wand.</p>
2212
2213<h5>channel</h5>
2214<p>the image channel(s).</p>
2215
2216<h5>mean</h5>
2217<p>The mean pixel value for the specified channel(s).</p>
2218
2219<h5>standard_deviation</h5>
2220<p>The standard deviation for the specified channel(s).</p>
2221
2222 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]2223<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickGetImageChannelRange">MagickGetImageChannelRange</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]2224<div class="doc-section">
2225
2226<p>MagickGetImageChannelRange() gets the range for one or more image channels.</p>
2227
2228<p>The format of the MagickGetImageChannelRange method is:</p>
2229
2230<pre class="code">
2231 MagickBooleanType MagickGetImageChannelRange(MagickWand *wand,
2232 const ChannelType channel,double *minima,double *maxima)
2233</pre>
2234
2235<p>A description of each parameter follows:</p>
2236
2237<h5>wand</h5>
2238<p>the magick wand.</p>
2239
2240<h5>channel</h5>
2241<p>the image channel(s).</p>
2242
2243<h5>minima</h5>
2244<p>The minimum pixel value for the specified channel(s).</p>
2245
2246<h5>maxima</h5>
2247<p>The maximum pixel value for the specified channel(s).</p>
2248
2249 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]2250<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickGetImageChannelStatistics">MagickGetImageChannelStatistics</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]2251<div class="doc-section">
2252
2253<p>MagickGetImageChannelStatistics() returns statistics for each channel in the image. The statistics include the channel depth, its minima and maxima, the mean, the standard deviation, the kurtosis and the skewness. You can access the red channel mean, for example, like this:</p>
2254
2255<pre class="text">
2256 channel_statistics=MagickGetImageChannelStatistics(wand);
2257 red_mean=channel_statistics[RedChannel].mean;
2258</pre>
2259
2260<p>Use MagickRelinquishMemory() to free the statistics buffer.</p>
2261
2262<p>The format of the MagickGetImageChannelStatistics method is:</p>
2263
2264<pre class="code">
2265 ChannelStatistics *MagickGetImageChannelStatistics(MagickWand *wand)
2266</pre>
2267
2268<p>A description of each parameter follows:</p>
2269
2270<h5>wand</h5>
2271<p>the magick wand.</p>
2272
2273 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]2274<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickGetImageColormapColor">MagickGetImageColormapColor</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]2275<div class="doc-section">
2276
2277<p>MagickGetImageColormapColor() returns the color of the specified colormap index.</p>
2278
2279<p>The format of the MagickGetImageColormapColor method is:</p>
2280
2281<pre class="code">
2282 MagickBooleanType MagickGetImageColormapColor(MagickWand *wand,
2283 const size_t index,PixelWand *color)
2284</pre>
2285
2286<p>A description of each parameter follows:</p>
2287
2288<h5>wand</h5>
2289<p>the magick wand.</p>
2290
2291<h5>index</h5>
2292<p>the offset into the image colormap.</p>
2293
2294<h5>color</h5>
2295<p>Return the colormap color in this wand.</p>
2296
2297 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]2298<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickGetImageColors">MagickGetImageColors</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]2299<div class="doc-section">
2300
2301<p>MagickGetImageColors() gets the number of unique colors in the image.</p>
2302
2303<p>The format of the MagickGetImageColors method is:</p>
2304
2305<pre class="code">
2306 size_t MagickGetImageColors(MagickWand *wand)
2307</pre>
2308
2309<p>A description of each parameter follows:</p>
2310
2311<h5>wand</h5>
2312<p>the magick wand.</p>
2313
2314 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]2315<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickGetImageColorspace">MagickGetImageColorspace</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]2316<div class="doc-section">
2317
2318<p>MagickGetImageColorspace() gets the image colorspace.</p>
2319
2320<p>The format of the MagickGetImageColorspace method is:</p>
2321
2322<pre class="code">
2323 ColorspaceType MagickGetImageColorspace(MagickWand *wand)
2324</pre>
2325
2326<p>A description of each parameter follows:</p>
2327
2328<h5>wand</h5>
2329<p>the magick wand.</p>
2330
2331 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]2332<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickGetImageCompose">MagickGetImageCompose</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]2333<div class="doc-section">
2334
2335<p>MagickGetImageCompose() returns the composite operator associated with the image.</p>
2336
2337<p>The format of the MagickGetImageCompose method is:</p>
2338
2339<pre class="code">
2340 CompositeOperator MagickGetImageCompose(MagickWand *wand)
2341</pre>
2342
2343<p>A description of each parameter follows:</p>
2344
2345<h5>wand</h5>
2346<p>the magick wand.</p>
2347
2348 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]2349<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickGetImageCompression">MagickGetImageCompression</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]2350<div class="doc-section">
2351
2352<p>MagickGetImageCompression() gets the image compression.</p>
2353
2354<p>The format of the MagickGetImageCompression method is:</p>
2355
2356<pre class="code">
2357 CompressionType MagickGetImageCompression(MagickWand *wand)
2358</pre>
2359
2360<p>A description of each parameter follows:</p>
2361
2362<h5>wand</h5>
2363<p>the magick wand.</p>
2364
2365 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]2366<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickGetImageCompression">MagickGetImageCompression</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]2367<div class="doc-section">
2368
2369<p>MagickGetImageCompression() gets the image compression quality.</p>
2370
2371<p>The format of the MagickGetImageCompression method is:</p>
2372
2373<pre class="code">
2374 size_t MagickGetImageCompression(MagickWand *wand)
2375</pre>
2376
2377<p>A description of each parameter follows:</p>
2378
2379<h5>wand</h5>
2380<p>the magick wand.</p>
2381
2382 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]2383<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickGetImageDelay">MagickGetImageDelay</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]2384<div class="doc-section">
2385
2386<p>MagickGetImageDelay() gets the image delay.</p>
2387
2388<p>The format of the MagickGetImageDelay method is:</p>
2389
2390<pre class="code">
2391 size_t MagickGetImageDelay(MagickWand *wand)
2392</pre>
2393
2394<p>A description of each parameter follows:</p>
2395
2396<h5>wand</h5>
2397<p>the magick wand.</p>
2398
2399 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]2400<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickGetImageDepth">MagickGetImageDepth</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]2401<div class="doc-section">
2402
2403<p>MagickGetImageDepth() gets the image depth.</p>
2404
2405<p>The format of the MagickGetImageDepth method is:</p>
2406
2407<pre class="code">
2408 size_t MagickGetImageDepth(MagickWand *wand)
2409</pre>
2410
2411<p>A description of each parameter follows:</p>
2412
2413<h5>wand</h5>
2414<p>the magick wand.</p>
2415
2416 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]2417<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickGetImageDistortion">MagickGetImageDistortion</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]2418<div class="doc-section">
2419
2420<p>MagickGetImageDistortion() compares an image to a reconstructed image and returns the specified distortion metric.</p>
2421
2422<p>The format of the MagickGetImageDistortion method is:</p>
2423
2424<pre class="code">
2425 MagickBooleanType MagickGetImageDistortion(MagickWand *wand,
2426 const MagickWand *reference,const MetricType metric,
2427 double *distortion)
2428</pre>
2429
2430<p>A description of each parameter follows:</p>
2431
2432<h5>wand</h5>
2433<p>the magick wand.</p>
2434
2435<h5>reference</h5>
2436<p>the reference wand.</p>
2437
2438<h5>metric</h5>
2439<p>the metric.</p>
2440
2441<h5>distortion</h5>
2442<p>the computed distortion between the images.</p>
2443
2444 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]2445<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickGetImageDispose">MagickGetImageDispose</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]2446<div class="doc-section">
2447
2448<p>MagickGetImageDispose() gets the image disposal method.</p>
2449
2450<p>The format of the MagickGetImageDispose method is:</p>
2451
2452<pre class="code">
2453 DisposeType MagickGetImageDispose(MagickWand *wand)
2454</pre>
2455
2456<p>A description of each parameter follows:</p>
2457
2458<h5>wand</h5>
2459<p>the magick wand.</p>
2460
2461 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]2462<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickGetImageFilename">MagickGetImageFilename</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]2463<div class="doc-section">
2464
2465<p>MagickGetImageFilename() returns the filename of a particular image in a sequence.</p>
2466
2467<p>The format of the MagickGetImageFilename method is:</p>
2468
2469<pre class="code">
2470 char *MagickGetImageFilename(MagickWand *wand)
2471</pre>
2472
2473<p>A description of each parameter follows:</p>
2474
2475<h5>wand</h5>
2476<p>the magick wand.</p>
2477
2478 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]2479<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickGetImageFormat">MagickGetImageFormat</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]2480<div class="doc-section">
2481
2482<p>MagickGetImageFormat() returns the format of a particular image in a sequence.</p>
2483
2484<p>The format of the MagickGetImageFormat method is:</p>
2485
2486<pre class="code">
2487 const char *MagickGetImageFormat(MagickWand *wand)
2488</pre>
2489
2490<p>A description of each parameter follows:</p>
2491
2492<h5>wand</h5>
2493<p>the magick wand.</p>
2494
2495 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]2496<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickGetImageFuzz">MagickGetImageFuzz</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]2497<div class="doc-section">
2498
2499<p>MagickGetImageFuzz() gets the image fuzz.</p>
2500
2501<p>The format of the MagickGetImageFuzz method is:</p>
2502
2503<pre class="code">
2504 double MagickGetImageFuzz(MagickWand *wand)
2505</pre>
2506
2507<p>A description of each parameter follows:</p>
2508
2509<h5>wand</h5>
2510<p>the magick wand.</p>
2511
2512 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]2513<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickGetImageGamma">MagickGetImageGamma</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]2514<div class="doc-section">
2515
2516<p>MagickGetImageGamma() gets the image gamma.</p>
2517
2518<p>The format of the MagickGetImageGamma method is:</p>
2519
2520<pre class="code">
2521 double MagickGetImageGamma(MagickWand *wand)
2522</pre>
2523
2524<p>A description of each parameter follows:</p>
2525
2526<h5>wand</h5>
2527<p>the magick wand.</p>
2528
2529 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]2530<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickGetImageGravity">MagickGetImageGravity</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]2531<div class="doc-section">
2532
2533<p>MagickGetImageGravity() gets the image gravity.</p>
2534
2535<p>The format of the MagickGetImageGravity method is:</p>
2536
2537<pre class="code">
2538 GravityType MagickGetImageGravity(MagickWand *wand)
2539</pre>
2540
2541<p>A description of each parameter follows:</p>
2542
2543<h5>wand</h5>
2544<p>the magick wand.</p>
2545
2546 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]2547<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickGetImageGreenPrimary">MagickGetImageGreenPrimary</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]2548<div class="doc-section">
2549
2550<p>MagickGetImageGreenPrimary() returns the chromaticy green primary point.</p>
2551
2552<p>The format of the MagickGetImageGreenPrimary method is:</p>
2553
2554<pre class="code">
2555 MagickBooleanType MagickGetImageGreenPrimary(MagickWand *wand,double *x,
2556 double *y)
2557</pre>
2558
2559<p>A description of each parameter follows:</p>
2560
2561<h5>wand</h5>
2562<p>the magick wand.</p>
2563
2564<h5>x</h5>
2565<p>the chromaticity green primary x-point.</p>
2566
2567<h5>y</h5>
2568<p>the chromaticity green primary y-point.</p>
2569
2570 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]2571<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickGetImageHeight">MagickGetImageHeight</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]2572<div class="doc-section">
2573
2574<p>MagickGetImageHeight() returns the image height.</p>
2575
2576<p>The format of the MagickGetImageHeight method is:</p>
2577
2578<pre class="code">
2579 size_t MagickGetImageHeight(MagickWand *wand)
2580</pre>
2581
2582<p>A description of each parameter follows:</p>
2583
2584<h5>wand</h5>
2585<p>the magick wand.</p>
2586
2587 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]2588<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickGetImageHistogram">MagickGetImageHistogram</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]2589<div class="doc-section">
2590
2591<p>MagickGetImageHistogram() returns the image histogram as an array of PixelWand wands.</p>
2592
2593<p>The format of the MagickGetImageHistogram method is:</p>
2594
2595<pre class="code">
2596 PixelWand **MagickGetImageHistogram(MagickWand *wand,
2597 size_t *number_colors)
2598</pre>
2599
2600<p>A description of each parameter follows:</p>
2601
2602<h5>wand</h5>
2603<p>the magick wand.</p>
2604
2605<h5>number_colors</h5>
2606<p>the number of unique colors in the image and the number of pixel wands returned.</p>
2607
2608 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]2609<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickGetImageInterlaceScheme">MagickGetImageInterlaceScheme</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]2610<div class="doc-section">
2611
2612<p>MagickGetImageInterlaceScheme() gets the image interlace scheme.</p>
2613
2614<p>The format of the MagickGetImageInterlaceScheme method is:</p>
2615
2616<pre class="code">
2617 InterlaceType MagickGetImageInterlaceScheme(MagickWand *wand)
2618</pre>
2619
2620<p>A description of each parameter follows:</p>
2621
2622<h5>wand</h5>
2623<p>the magick wand.</p>
2624
2625 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]2626<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickGetImageInterpolateMethod">MagickGetImageInterpolateMethod</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]2627<div class="doc-section">
2628
2629<p>MagickGetImageInterpolateMethod() returns the interpolation method for the sepcified image.</p>
2630
2631<p>The format of the MagickGetImageInterpolateMethod method is:</p>
2632
2633<pre class="code">
2634 InterpolatePixelMethod MagickGetImageInterpolateMethod(MagickWand *wand)
2635</pre>
2636
2637<p>A description of each parameter follows:</p>
2638
2639<h5>wand</h5>
2640<p>the magick wand.</p>
2641
2642 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]2643<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickGetImageIterations">MagickGetImageIterations</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]2644<div class="doc-section">
2645
2646<p>MagickGetImageIterations() gets the image iterations.</p>
2647
2648<p>The format of the MagickGetImageIterations method is:</p>
2649
2650<pre class="code">
2651 size_t MagickGetImageIterations(MagickWand *wand)
2652</pre>
2653
2654<p>A description of each parameter follows:</p>
2655
2656<h5>wand</h5>
2657<p>the magick wand.</p>
2658
2659 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]2660<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickGetImageLength">MagickGetImageLength</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]2661<div class="doc-section">
2662
2663<p>MagickGetImageLength() returns the image length in bytes.</p>
2664
2665<p>The format of the MagickGetImageLength method is:</p>
2666
2667<pre class="code">
2668 MagickBooleanType MagickGetImageLength(MagickWand *wand,
2669 MagickSizeType *length)
2670</pre>
2671
2672<p>A description of each parameter follows:</p>
2673
2674<h5>wand</h5>
2675<p>the magick wand.</p>
2676
2677<h5>length</h5>
2678<p>the image length in bytes.</p>
2679
2680 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]2681<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickGetImageMatteColor">MagickGetImageMatteColor</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]2682<div class="doc-section">
2683
2684<p>MagickGetImageMatteColor() returns the image matte color.</p>
2685
2686<p>The format of the MagickGetImageMatteColor method is:</p>
2687
2688<pre class="code">
2689 MagickBooleanType MagickGetImagematteColor(MagickWand *wand,
2690 PixelWand *matte_color)
2691</pre>
2692
2693<p>A description of each parameter follows:</p>
2694
2695<h5>wand</h5>
2696<p>the magick wand.</p>
2697
2698<h5>matte_color</h5>
2699<p>Return the matte color.</p>
2700
2701 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]2702<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickGetImageOrientation">MagickGetImageOrientation</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]2703<div class="doc-section">
2704
2705<p>MagickGetImageOrientation() returns the image orientation.</p>
2706
2707<p>The format of the MagickGetImageOrientation method is:</p>
2708
2709<pre class="code">
2710 OrientationType MagickGetImageOrientation(MagickWand *wand)
2711</pre>
2712
2713<p>A description of each parameter follows:</p>
2714
2715<h5>wand</h5>
2716<p>the magick wand.</p>
2717
2718 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]2719<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickGetImagePage">MagickGetImagePage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]2720<div class="doc-section">
2721
2722<p>MagickGetImagePage() returns the page geometry associated with the image.</p>
2723
2724<p>The format of the MagickGetImagePage method is:</p>
2725
2726<pre class="code">
2727 MagickBooleanType MagickGetImagePage(MagickWand *wand,
2728 size_t *width,size_t *height,ssize_t *x,ssize_t *y)
2729</pre>
2730
2731<p>A description of each parameter follows:</p>
2732
2733<h5>wand</h5>
2734<p>the magick wand.</p>
2735
2736<h5>width</h5>
2737<p>the page width.</p>
2738
2739<h5>height</h5>
2740<p>the page height.</p>
2741
2742<h5>x</h5>
2743<p>the page x-offset.</p>
2744
2745<h5>y</h5>
2746<p>the page y-offset.</p>
2747
2748 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]2749<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickGetImagePixelColor">MagickGetImagePixelColor</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]2750<div class="doc-section">
2751
2752<p>MagickGetImagePixelColor() returns the color of the specified pixel.</p>
2753
2754<p>The format of the MagickGetImagePixelColor method is:</p>
2755
2756<pre class="code">
2757 MagickBooleanType MagickGetImagePixelColor(MagickWand *wand,
2758 const ssize_t x,const ssize_t y,PixelWand *color)
2759</pre>
2760
2761<p>A description of each parameter follows:</p>
2762
2763<h5>wand</h5>
2764<p>the magick wand.</p>
2765
2766<h5>x,y</h5>
2767<p>the pixel offset into the image.</p>
2768
2769<h5>color</h5>
2770<p>Return the colormap color in this wand.</p>
2771
2772 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]2773<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickGetImageRedPrimary">MagickGetImageRedPrimary</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]2774<div class="doc-section">
2775
2776<p>MagickGetImageRedPrimary() returns the chromaticy red primary point.</p>
2777
2778<p>The format of the MagickGetImageRedPrimary method is:</p>
2779
2780<pre class="code">
2781 MagickBooleanType MagickGetImageRedPrimary(MagickWand *wand,double *x,
2782 double *y)
2783</pre>
2784
2785<p>A description of each parameter follows:</p>
2786
2787<h5>wand</h5>
2788<p>the magick wand.</p>
2789
2790<h5>x</h5>
2791<p>the chromaticity red primary x-point.</p>
2792
2793<h5>y</h5>
2794<p>the chromaticity red primary y-point.</p>
2795
2796 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]2797<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickGetImageRegion">MagickGetImageRegion</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]2798<div class="doc-section">
2799
2800<p>MagickGetImageRegion() extracts a region of the image and returns it as a a new wand.</p>
2801
2802<p>The format of the MagickGetImageRegion method is:</p>
2803
2804<pre class="code">
2805 MagickWand *MagickGetImageRegion(MagickWand *wand,
2806 const size_t width,const size_t height,const ssize_t x,
2807 const ssize_t y)
2808</pre>
2809
2810<p>A description of each parameter follows:</p>
2811
2812<h5>wand</h5>
2813<p>the magick wand.</p>
2814
2815<h5>width</h5>
2816<p>the region width.</p>
2817
2818<h5>height</h5>
2819<p>the region height.</p>
2820
2821<h5>x</h5>
2822<p>the region x offset.</p>
2823
2824<h5>y</h5>
2825<p>the region y offset.</p>
2826
2827 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]2828<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickGetImageRenderingIntent">MagickGetImageRenderingIntent</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]2829<div class="doc-section">
2830
2831<p>MagickGetImageRenderingIntent() gets the image rendering intent.</p>
2832
2833<p>The format of the MagickGetImageRenderingIntent method is:</p>
2834
2835<pre class="code">
2836 RenderingIntent MagickGetImageRenderingIntent(MagickWand *wand)
2837</pre>
2838
2839<p>A description of each parameter follows:</p>
2840
2841<h5>wand</h5>
2842<p>the magick wand.</p>
2843
2844 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]2845<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickGetImageResolution">MagickGetImageResolution</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]2846<div class="doc-section">
2847
2848<p>MagickGetImageResolution() gets the image X and Y resolution.</p>
2849
2850<p>The format of the MagickGetImageResolution method is:</p>
2851
2852<pre class="code">
2853 MagickBooleanType MagickGetImageResolution(MagickWand *wand,double *x,
2854 double *y)
2855</pre>
2856
2857<p>A description of each parameter follows:</p>
2858
2859<h5>wand</h5>
2860<p>the magick wand.</p>
2861
2862<h5>x</h5>
2863<p>the image x-resolution.</p>
2864
2865<h5>y</h5>
2866<p>the image y-resolution.</p>
2867
2868 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]2869<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickGetImageScene">MagickGetImageScene</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]2870<div class="doc-section">
2871
2872<p>MagickGetImageScene() gets the image scene.</p>
2873
2874<p>The format of the MagickGetImageScene method is:</p>
2875
2876<pre class="code">
2877 size_t MagickGetImageScene(MagickWand *wand)
2878</pre>
2879
2880<p>A description of each parameter follows:</p>
2881
2882<h5>wand</h5>
2883<p>the magick wand.</p>
2884
2885 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]2886<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickGetImageSignature">MagickGetImageSignature</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]2887<div class="doc-section">
2888
2889<p>MagickGetImageSignature() generates an SHA-256 message digest for the image pixel stream.</p>
2890
2891<p>The format of the MagickGetImageSignature method is:</p>
2892
2893<pre class="code">
2894 const char MagickGetImageSignature(MagickWand *wand)
2895</pre>
2896
2897<p>A description of each parameter follows:</p>
2898
2899<h5>wand</h5>
2900<p>the magick wand.</p>
2901
2902 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]2903<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickGetImageTicksPerSecond">MagickGetImageTicksPerSecond</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]2904<div class="doc-section">
2905
2906<p>MagickGetImageTicksPerSecond() gets the image ticks-per-second.</p>
2907
2908<p>The format of the MagickGetImageTicksPerSecond method is:</p>
2909
2910<pre class="code">
2911 size_t MagickGetImageTicksPerSecond(MagickWand *wand)
2912</pre>
2913
2914<p>A description of each parameter follows:</p>
2915
2916<h5>wand</h5>
2917<p>the magick wand.</p>
2918
2919 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]2920<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickGetImageType">MagickGetImageType</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]2921<div class="doc-section">
2922
2923<p>MagickGetImageType() gets the potential image type:</p>
2924
2925<p>Bilevel Grayscale GrayscaleMatte Palette PaletteMatte TrueColor TrueColorMatte ColorSeparation ColorSeparationMatte</p>
2926
2927<p>To ensure the image type matches its potential, use MagickSetImageType():</p>
2928
2929<pre class="text">
2930 (void) MagickSetImageType(wand,MagickGetImageType(wand));
2931</pre>
2932
2933<p>The format of the MagickGetImageType method is:</p>
2934
2935<pre class="code">
2936 ImageType MagickGetImageType(MagickWand *wand)
2937</pre>
2938
2939<p>A description of each parameter follows:</p>
2940
2941<h5>wand</h5>
2942<p>the magick wand.</p>
2943
2944 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]2945<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickGetImageUnits">MagickGetImageUnits</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]2946<div class="doc-section">
2947
2948<p>MagickGetImageUnits() gets the image units of resolution.</p>
2949
2950<p>The format of the MagickGetImageUnits method is:</p>
2951
2952<pre class="code">
2953 ResolutionType MagickGetImageUnits(MagickWand *wand)
2954</pre>
2955
2956<p>A description of each parameter follows:</p>
2957
2958<h5>wand</h5>
2959<p>the magick wand.</p>
2960
2961 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]2962<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickGetImageVirtualPixelMethod">MagickGetImageVirtualPixelMethod</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]2963<div class="doc-section">
2964
2965<p>MagickGetImageVirtualPixelMethod() returns the virtual pixel method for the sepcified image.</p>
2966
2967<p>The format of the MagickGetImageVirtualPixelMethod method is:</p>
2968
2969<pre class="code">
2970 VirtualPixelMethod MagickGetImageVirtualPixelMethod(MagickWand *wand)
2971</pre>
2972
2973<p>A description of each parameter follows:</p>
2974
2975<h5>wand</h5>
2976<p>the magick wand.</p>
2977
2978 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]2979<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickGetImageWhitePoint">MagickGetImageWhitePoint</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]2980<div class="doc-section">
2981
2982<p>MagickGetImageWhitePoint() returns the chromaticy white point.</p>
2983
2984<p>The format of the MagickGetImageWhitePoint method is:</p>
2985
2986<pre class="code">
2987 MagickBooleanType MagickGetImageWhitePoint(MagickWand *wand,double *x,
2988 double *y)
2989</pre>
2990
2991<p>A description of each parameter follows:</p>
2992
2993<h5>wand</h5>
2994<p>the magick wand.</p>
2995
2996<h5>x</h5>
2997<p>the chromaticity white x-point.</p>
2998
2999<h5>y</h5>
3000<p>the chromaticity white y-point.</p>
3001
3002 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]3003<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickGetImageWidth">MagickGetImageWidth</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]3004<div class="doc-section">
3005
3006<p>MagickGetImageWidth() returns the image width.</p>
3007
3008<p>The format of the MagickGetImageWidth method is:</p>
3009
3010<pre class="code">
3011 size_t MagickGetImageWidth(MagickWand *wand)
3012</pre>
3013
3014<p>A description of each parameter follows:</p>
3015
3016<h5>wand</h5>
3017<p>the magick wand.</p>
3018
3019 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]3020<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickGetNumberImages">MagickGetNumberImages</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]3021<div class="doc-section">
3022
3023<p>MagickGetNumberImages() returns the number of images associated with a magick wand.</p>
3024
3025<p>The format of the MagickGetNumberImages method is:</p>
3026
3027<pre class="code">
3028 size_t MagickGetNumberImages(MagickWand *wand)
3029</pre>
3030
3031<p>A description of each parameter follows:</p>
3032
3033<h5>wand</h5>
3034<p>the magick wand.</p>
3035
3036 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]3037<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickGetImageTotalInkDensity">MagickGetImageTotalInkDensity</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]3038<div class="doc-section">
3039
3040<p>MagickGetImageTotalInkDensity() gets the image total ink density.</p>
3041
3042<p>The format of the MagickGetImageTotalInkDensity method is:</p>
3043
3044<pre class="code">
3045 double MagickGetImageTotalInkDensity(MagickWand *wand)
3046</pre>
3047
3048<p>A description of each parameter follows:</p>
3049
3050<h5>wand</h5>
3051<p>the magick wand.</p>
3052
3053 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]3054<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickHaldClutImage">MagickHaldClutImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]3055<div class="doc-section">
3056
3057<p>MagickHaldClutImage() replaces colors in the image from a Hald color lookup table. A Hald color lookup table is a 3-dimensional color cube mapped to 2 dimensions. Create it with the HALD coder. You can apply any color transformation to the Hald image and then use this method to apply the transform to the image.</p>
3058
3059<p>The format of the MagickHaldClutImage method is:</p>
3060
3061<pre class="code">
3062 MagickBooleanType MagickHaldClutImage(MagickWand *wand,
3063 const MagickWand *hald_wand)
3064 MagickBooleanType MagickHaldClutImageChannel(MagickWand *wand,
3065 const ChannelType channel,const MagickWand *hald_wand)
3066</pre>
3067
3068<p>A description of each parameter follows:</p>
3069
3070<h5>wand</h5>
3071<p>the magick wand.</p>
3072
3073<h5>hald_image</h5>
3074<p>the hald CLUT image.</p>
3075
3076 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]3077<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickHasNextImage">MagickHasNextImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]3078<div class="doc-section">
3079
3080<p>MagickHasNextImage() returns MagickTrue if the wand has more images when traversing the list in the forward direction</p>
3081
3082<p>The format of the MagickHasNextImage method is:</p>
3083
3084<pre class="code">
3085 MagickBooleanType MagickHasNextImage(MagickWand *wand)
3086</pre>
3087
3088<p>A description of each parameter follows:</p>
3089
3090<h5>wand</h5>
3091<p>the magick wand.</p>
3092
3093 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]3094<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickHasPreviousImage">MagickHasPreviousImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]3095<div class="doc-section">
3096
3097<p>MagickHasPreviousImage() returns MagickTrue if the wand has more images when traversing the list in the reverse direction</p>
3098
3099<p>The format of the MagickHasPreviousImage method is:</p>
3100
3101<pre class="code">
3102 MagickBooleanType MagickHasPreviousImage(MagickWand *wand)
3103</pre>
3104
3105<p>A description of each parameter follows:</p>
3106
3107<h5>wand</h5>
3108<p>the magick wand.</p>
3109
3110 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]3111<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickIdentifyImage">MagickIdentifyImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]3112<div class="doc-section">
3113
3114<p>MagickIdentifyImage() identifies an image by printing its attributes to the file. Attributes include the image width, height, size, and others.</p>
3115
3116<p>The format of the MagickIdentifyImage method is:</p>
3117
3118<pre class="code">
3119 const char *MagickIdentifyImage(MagickWand *wand)
3120</pre>
3121
3122<p>A description of each parameter follows:</p>
3123
3124<h5>wand</h5>
3125<p>the magick wand.</p>
3126
3127 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]3128<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickImplodeImage">MagickImplodeImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]3129<div class="doc-section">
3130
3131<p>MagickImplodeImage() creates a new image that is a copy of an existing one with the image pixels "implode" by the specified percentage. It allocates the memory necessary for the new Image structure and returns a pointer to the new image.</p>
3132
3133<p>The format of the MagickImplodeImage method is:</p>
3134
3135<pre class="code">
3136 MagickBooleanType MagickImplodeImage(MagickWand *wand,
3137 const double radius)
3138</pre>
3139
3140<p>A description of each parameter follows:</p>
3141
3142<h5>wand</h5>
3143<p>the magick wand.</p>
3144
3145<h5>amount</h5>
3146<p>Define the extent of the implosion.</p>
3147
3148 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]3149<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickImportImagePixels">MagickImportImagePixels</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]3150<div class="doc-section">
3151
3152<p>MagickImportImagePixels() accepts pixel datand stores it in the image at the location you specify. The method returns MagickFalse on success otherwise MagickTrue if an error is encountered. The pixel data can be either char, short int, int, ssize_t, float, or double in the order specified by map.</p>
3153
3154<p>Suppose your want to upload the first scanline of a 640x480 image from character data in red-green-blue order:</p>
3155
3156<pre class="text">
3157 MagickImportImagePixels(wand,0,0,640,1,"RGB",CharPixel,pixels);
3158</pre>
3159
3160<p>The format of the MagickImportImagePixels method is:</p>
3161
3162<pre class="code">
3163 MagickBooleanType MagickImportImagePixels(MagickWand *wand,
3164 const ssize_t x,const ssize_t y,const size_t columns,
3165 const size_t rows,const char *map,const StorageType storage,
3166 const void *pixels)
3167</pre>
3168
3169<p>A description of each parameter follows:</p>
3170
3171<h5>wand</h5>
3172<p>the magick wand.</p>
3173
3174<h5>x, y, columns, rows</h5>
3175<p>These values define the perimeter of a region of pixels you want to define.</p>
3176
3177<h5>map</h5>
3178<p>This string reflects the expected ordering of the pixel array. It can be any combination or order of R = red, G = green, B = blue, A = alpha (0 is transparent), O = opacity (0 is opaque), C = cyan, Y = yellow, M = magenta, K = black, I = intensity (for grayscale), P = pad.</p>
3179
3180<h5>storage</h5>
3181<p>Define the data type of the pixels. Float and double types are expected to be normalized [0..1] otherwise [0..QuantumRange]. Choose from these types: CharPixel, ShortPixel, IntegerPixel, LongPixel, FloatPixel, or DoublePixel.</p>
3182
3183<h5>pixels</h5>
3184<p>This array of values contain the pixel components as defined by map and type. You must preallocate this array where the expected length varies depending on the values of width, height, map, and type.</p>
3185
3186 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]3187<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickInverseFourierTransformImage">MagickInverseFourierTransformImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]3188<div class="doc-section">
3189
3190<p>MagickInverseFourierTransformImage() implements the inverse discrete Fourier transform (DFT) of the image either as a magnitude / phase or real / imaginary image pair.</p>
3191
3192<p>The format of the MagickInverseFourierTransformImage method is:</p>
3193
3194<pre class="code">
3195 MagickBooleanType MagickInverseFourierTransformImage(
3196 MagickWand *magnitude_wand,MagickWand *phase_wand,
3197 const MagickBooleanType magnitude)
3198</pre>
3199
3200<p>A description of each parameter follows:</p>
3201
3202<h5>magnitude_wand</h5>
3203<p>the magnitude or real wand.</p>
3204
3205<h5>phase_wand</h5>
3206<p>the phase or imaginary wand.</p>
3207
3208<h5>magnitude</h5>
3209<p>if true, return as magnitude / phase pair otherwise a real / imaginary image pair.</p>
3210
3211 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]3212<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickLabelImage">MagickLabelImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]3213<div class="doc-section">
3214
3215<p>MagickLabelImage() adds a label to your image.</p>
3216
3217<p>The format of the MagickLabelImage method is:</p>
3218
3219<pre class="code">
3220 MagickBooleanType MagickLabelImage(MagickWand *wand,const char *label)
3221</pre>
3222
3223<p>A description of each parameter follows:</p>
3224
3225<h5>wand</h5>
3226<p>the magick wand.</p>
3227
3228<h5>label</h5>
3229<p>the image label.</p>
3230
3231 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]3232<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickLevelImage">MagickLevelImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]3233<div class="doc-section">
3234
3235<p>MagickLevelImage() adjusts the levels of an image by scaling the colors falling between specified white and black points to the full available quantum range. The parameters provided represent the black, mid, and white points. The black point specifies the darkest color in the image. Colors darker than the black point are set to zero. Mid point specifies a gamma correction to apply to the image. White point specifies the lightest color in the image. Colors brighter than the white point are set to the maximum quantum value.</p>
3236
3237<p>The format of the MagickLevelImage method is:</p>
3238
3239<pre class="code">
3240 MagickBooleanType MagickLevelImage(MagickWand *wand,
3241 const double black_point,const double gamma,const double white_point)
3242 MagickBooleanType MagickLevelImageChannel(MagickWand *wand,
3243 const ChannelType channel,const double black_point,const double gamma,
3244 const double white_point)
3245</pre>
3246
3247<p>A description of each parameter follows:</p>
3248
3249<h5>wand</h5>
3250<p>the magick wand.</p>
3251
3252<h5>channel</h5>
3253<p>Identify which channel to level: RedChannel, GreenChannel,</p>
3254
3255<h5>black_point</h5>
3256<p>the black point.</p>
3257
3258<h5>gamma</h5>
3259<p>the gamma.</p>
3260
3261<h5>white_point</h5>
3262<p>the white point.</p>
3263
3264 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]3265<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickLinearStretchImage">MagickLinearStretchImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]3266<div class="doc-section">
3267
3268<p>MagickLinearStretchImage() stretches with saturation the image intensity.</p>
3269
3270<p>You can also reduce the influence of a particular channel with a gamma value of 0.</p>
3271
3272<p>The format of the MagickLinearStretchImage method is:</p>
3273
3274<pre class="code">
3275 MagickBooleanType MagickLinearStretchImage(MagickWand *wand,
3276 const double black_point,const double white_point)
3277</pre>
3278
3279<p>A description of each parameter follows:</p>
3280
3281<h5>wand</h5>
3282<p>the magick wand.</p>
3283
3284<h5>black_point</h5>
3285<p>the black point.</p>
3286
3287<h5>white_point</h5>
3288<p>the white point.</p>
3289
3290 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]3291<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickLiquidRescaleImage">MagickLiquidRescaleImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]3292<div class="doc-section">
3293
3294<p>MagickLiquidRescaleImage() rescales image with seam carving.</p>
3295
3296<p>MagickBooleanType MagickLiquidRescaleImage(MagickWand *wand, const size_t columns,const size_t rows, const double delta_x,const double rigidity)</p>
3297
3298<p>A description of each parameter follows:</p>
3299
3300<h5>wand</h5>
3301<p>the magick wand.</p>
3302
3303<h5>columns</h5>
3304<p>the number of columns in the scaled image.</p>
3305
3306<h5>rows</h5>
3307<p>the number of rows in the scaled image.</p>
3308
3309<h5>delta_x</h5>
3310<p>maximum seam transversal step (0 means straight seams).</p>
3311
3312<h5>rigidity</h5>
3313<p>introduce a bias for non-straight seams (typically 0).</p>
3314
3315 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]3316<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickMagnifyImage">MagickMagnifyImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]3317<div class="doc-section">
3318
3319<p>MagickMagnifyImage() is a convenience method that scales an image proportionally to twice its original size.</p>
3320
3321<p>The format of the MagickMagnifyImage method is:</p>
3322
3323<pre class="code">
3324 MagickBooleanType MagickMagnifyImage(MagickWand *wand)
3325</pre>
3326
3327<p>A description of each parameter follows:</p>
3328
3329<h5>wand</h5>
3330<p>the magick wand.</p>
3331
3332 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]3333<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickMergeImageLayers">MagickMergeImageLayers</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]3334<div class="doc-section">
3335
3336<p>MagickMergeImageLayers() composes all the image layers from the current given image onward to produce a single image of the merged layers.</p>
3337
3338<p>The inital canvas's size depends on the given ImageLayerMethod, and is initialized using the first images background color. The images are then compositied onto that image in sequence using the given composition that has been assigned to each individual image.</p>
3339
3340<p>The format of the MagickMergeImageLayers method is:</p>
3341
3342<pre class="code">
3343 MagickWand *MagickMergeImageLayers(MagickWand *wand,
3344 const ImageLayerMethod method)
3345</pre>
3346
3347<p>A description of each parameter follows:</p>
3348
3349<h5>wand</h5>
3350<p>the magick wand.</p>
3351
3352<h5>method</h5>
3353<p>the method of selecting the size of the initial canvas.</p>
3354
3355<p>MergeLayer: Merge all layers onto a canvas just large enough to hold all the actual images. The virtual canvas of the first image is preserved but otherwise ignored.</p>
3356
3357<p>FlattenLayer: Use the virtual canvas size of first image. Images which fall outside this canvas is clipped. This can be used to 'fill out' a given virtual canvas.</p>
3358
3359<p>MosaicLayer: Start with the virtual canvas of the first image, enlarging left and right edges to contain all images. Images with negative offsets will be clipped.</p>
3360
3361 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]3362<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickMinifyImage">MagickMinifyImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]3363<div class="doc-section">
3364
3365<p>MagickMinifyImage() is a convenience method that scales an image proportionally to one-half its original size</p>
3366
3367<p>The format of the MagickMinifyImage method is:</p>
3368
3369<pre class="code">
3370 MagickBooleanType MagickMinifyImage(MagickWand *wand)
3371</pre>
3372
3373<p>A description of each parameter follows:</p>
3374
3375<h5>wand</h5>
3376<p>the magick wand.</p>
3377
3378 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]3379<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickModulateImage">MagickModulateImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]3380<div class="doc-section">
3381
3382<p>MagickModulateImage() lets you control the brightness, saturation, and hue of an image. Hue is the percentage of absolute rotation from the current position. For example 50 results in a counter-clockwise rotation of 90 degrees, 150 results in a clockwise rotation of 90 degrees, with 0 and 200 both resulting in a rotation of 180 degrees.</p>
3383
3384<p>To increase the color brightness by 20 and decrease the color saturation by 10 and leave the hue unchanged, use: 120,90,100.</p>
3385
3386<p>The format of the MagickModulateImage method is:</p>
3387
3388<pre class="code">
3389 MagickBooleanType MagickModulateImage(MagickWand *wand,
3390 const double brightness,const double saturation,const double hue)
3391</pre>
3392
3393<p>A description of each parameter follows:</p>
3394
3395<h5>wand</h5>
3396<p>the magick wand.</p>
3397
3398<h5>brightness</h5>
3399<p>the percent change in brighness.</p>
3400
3401<h5>saturation</h5>
3402<p>the percent change in saturation.</p>
3403
3404<h5>hue</h5>
3405<p>the percent change in hue.</p>
3406
3407 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]3408<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickMontageImage">MagickMontageImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]3409<div class="doc-section">
3410
3411<p>MagickMontageImage() creates a composite image by combining several separate images. The images are tiled on the composite image with the name of the image optionally appearing just below the individual tile.</p>
3412
3413<p>The format of the MagickMontageImage method is:</p>
3414
3415<pre class="code">
3416 MagickWand *MagickMontageImage(MagickWand *wand,
3417 const DrawingWand drawing_wand,const char *tile_geometry,
3418 const char *thumbnail_geometry,const MontageMode mode,
3419 const char *frame)
3420</pre>
3421
3422<p>A description of each parameter follows:</p>
3423
3424<h5>wand</h5>
3425<p>the magick wand.</p>
3426
3427<h5>drawing_wand</h5>
3428<p>the drawing wand. The font name, size, and color are obtained from this wand.</p>
3429
3430<h5>tile_geometry</h5>
3431<p>the number of tiles per row and page (e.g. 6x4+0+0).</p>
3432
3433<h5>thumbnail_geometry</h5>
3434<p>Preferred image size and border size of each thumbnail (e.g. 120x120+4+3>).</p>
3435
3436<h5>mode</h5>
3437<p>Thumbnail framing mode: Frame, Unframe, or Concatenate.</p>
3438
3439<h5>frame</h5>
3440<p>Surround the image with an ornamental border (e.g. 15x15+3+3). The frame color is that of the thumbnail's matte color.</p>
3441
3442 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]3443<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickMorphImages">MagickMorphImages</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]3444<div class="doc-section">
3445
3446<p>MagickMorphImages() method morphs a set of images. Both the image pixels and size are linearly interpolated to give the appearance of a meta-morphosis from one image to the next.</p>
3447
3448<p>The format of the MagickMorphImages method is:</p>
3449
3450<pre class="code">
3451 MagickWand *MagickMorphImages(MagickWand *wand,
3452 const size_t number_frames)
3453</pre>
3454
3455<p>A description of each parameter follows:</p>
3456
3457<h5>wand</h5>
3458<p>the magick wand.</p>
3459
3460<h5>number_frames</h5>
3461<p>the number of in-between images to generate.</p>
3462
3463 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]3464<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickMorphologyImage">MagickMorphologyImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]3465<div class="doc-section">
3466
3467<p>MagickMorphologyImage() applies a user supplied kernel to the image according to the given mophology method.</p>
3468
3469<p>The format of the MagickMorphologyImage method is:</p>
3470
3471<pre class="code">
3472 MagickBooleanType MagickMorphologyImage(MagickWand *wand,
3473 MorphologyMethod method,const ssize_t iterations,KernelInfo *kernel)
3474 MagickBooleanType MagickMorphologyImageChannel(MagickWand *wand,
3475 ChannelType channel,MorphologyMethod method,const ssize_t iterations,
3476 KernelInfo *kernel)
3477</pre>
3478
3479<p>A description of each parameter follows:</p>
3480
3481<h5>wand</h5>
3482<p>the magick wand.</p>
3483
3484<h5>channel</h5>
3485<p>the image channel(s).</p>
3486
3487<h5>method</h5>
3488<p>the morphology method to be applied.</p>
3489
3490<h5>iterations</h5>
3491<p>apply the operation this many times (or no change). A value of -1 means loop until no change found. How this is applied may depend on the morphology method. Typically this is a value of 1.</p>
3492
3493<h5>kernel</h5>
3494<p>An array of doubles representing the morphology kernel.</p>
3495
3496 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]3497<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickMotionBlurImage">MagickMotionBlurImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]3498<div class="doc-section">
3499
3500<p>MagickMotionBlurImage() simulates motion blur. We convolve the image with a Gaussian operator of the given radius and standard deviation (sigma). For reasonable results, radius should be larger than sigma. Use a radius of 0 and MotionBlurImage() selects a suitable radius for you. Angle gives the angle of the blurring motion.</p>
3501
3502<p>The format of the MagickMotionBlurImage method is:</p>
3503
3504<pre class="code">
3505 MagickBooleanType MagickMotionBlurImage(MagickWand *wand,
3506 const double radius,const double sigma,const double angle)
3507 MagickBooleanType MagickMotionBlurImageChannel(MagickWand *wand,
3508 const ChannelType channel,const double radius,const double sigma,
3509 const double angle)
3510</pre>
3511
3512<p>A description of each parameter follows:</p>
3513
3514<h5>wand</h5>
3515<p>the magick wand.</p>
3516
3517<h5>channel</h5>
3518<p>the image channel(s).</p>
3519
3520<h5>radius</h5>
3521<p>the radius of the Gaussian, in pixels, not counting the center pixel.</p>
3522
3523<h5>sigma</h5>
3524<p>the standard deviation of the Gaussian, in pixels.</p>
3525
3526<h5>angle</h5>
3527<p>Apply the effect along this angle.</p>
3528
3529 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]3530<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickNegateImage">MagickNegateImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]3531<div class="doc-section">
3532
3533<p>MagickNegateImage() negates the colors in the reference image. The Grayscale option means that only grayscale values within the image are negated.</p>
3534
3535<p>You can also reduce the influence of a particular channel with a gamma value of 0.</p>
3536
3537<p>The format of the MagickNegateImage method is:</p>
3538
3539<pre class="code">
3540 MagickBooleanType MagickNegateImage(MagickWand *wand,
3541 const MagickBooleanType gray)
3542 MagickBooleanType MagickNegateImage(MagickWand *wand,
3543 const ChannelType channel,const MagickBooleanType gray)
3544</pre>
3545
3546<p>A description of each parameter follows:</p>
3547
3548<h5>wand</h5>
3549<p>the magick wand.</p>
3550
3551<h5>channel</h5>
3552<p>the image channel(s).</p>
3553
3554<h5>gray</h5>
3555<p>If MagickTrue, only negate grayscale pixels within the image.</p>
3556
3557 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]3558<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickNewImage">MagickNewImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]3559<div class="doc-section">
3560
3561<p>MagickNewImage() adds a blank image canvas of the specified size and background color to the wand.</p>
3562
3563<p>The format of the MagickNewImage method is:</p>
3564
3565<pre class="code">
3566 MagickBooleanType MagickNewImage(MagickWand *wand,
3567 const size_t columns,const size_t rows,
3568 const PixelWand *background)
3569</pre>
3570
3571<p>A description of each parameter follows:</p>
3572
3573<h5>wand</h5>
3574<p>the magick wand.</p>
3575
3576<h5>width</h5>
3577<p>the image width.</p>
3578
3579<h5>height</h5>
3580<p>the image height.</p>
3581
3582<h5>background</h5>
3583<p>the image color.</p>
3584
3585 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]3586<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickNextImage">MagickNextImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]3587<div class="doc-section">
3588
3589<p>MagickNextImage() associates the next image in the image list with a magick wand.</p>
3590
3591<p>The format of the MagickNextImage method is:</p>
3592
3593<pre class="code">
3594 MagickBooleanType MagickNextImage(MagickWand *wand)
3595</pre>
3596
3597<p>A description of each parameter follows:</p>
3598
3599<h5>wand</h5>
3600<p>the magick wand.</p>
3601
3602 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]3603<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickNormalizeImage">MagickNormalizeImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]3604<div class="doc-section">
3605
3606<p>MagickNormalizeImage() enhances the contrast of a color image by adjusting the pixels color to span the entire range of colors available</p>
3607
3608<p>You can also reduce the influence of a particular channel with a gamma value of 0.</p>
3609
3610<p>The format of the MagickNormalizeImage method is:</p>
3611
3612<pre class="code">
3613 MagickBooleanType MagickNormalizeImage(MagickWand *wand)
3614 MagickBooleanType MagickNormalizeImageChannel(MagickWand *wand,
3615 const ChannelType channel)
3616</pre>
3617
3618<p>A description of each parameter follows:</p>
3619
3620<h5>wand</h5>
3621<p>the magick wand.</p>
3622
3623<h5>channel</h5>
3624<p>the image channel(s).</p>
3625
3626 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]3627<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickOilPaintImage">MagickOilPaintImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]3628<div class="doc-section">
3629
3630<p>MagickOilPaintImage() applies a special effect filter that simulates an oil painting. Each pixel is replaced by the most frequent color occurring in a circular region defined by radius.</p>
3631
3632<p>The format of the MagickOilPaintImage method is:</p>
3633
3634<pre class="code">
3635 MagickBooleanType MagickOilPaintImage(MagickWand *wand,
3636 const double radius)
3637</pre>
3638
3639<p>A description of each parameter follows:</p>
3640
3641<h5>wand</h5>
3642<p>the magick wand.</p>
3643
3644<h5>radius</h5>
3645<p>the radius of the circular neighborhood.</p>
3646
3647 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]3648<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickOpaquePaintImage">MagickOpaquePaintImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]3649<div class="doc-section">
3650
3651<p>MagickOpaquePaintImage() changes any pixel that matches color with the color defined by fill.</p>
3652
3653<p>The format of the MagickOpaquePaintImage method is:</p>
3654
3655<pre class="code">
3656 MagickBooleanType MagickOpaquePaintImage(MagickWand *wand,
3657 const PixelWand *target,const PixelWand *fill,const double fuzz,
3658 const MagickBooleanType invert)
3659 MagickBooleanType MagickOpaquePaintImageChannel(MagickWand *wand,
3660 const ChannelType channel,const PixelWand *target,
3661 const PixelWand *fill,const double fuzz,const MagickBooleanType invert)
3662</pre>
3663
3664<p>A description of each parameter follows:</p>
3665
3666<h5>wand</h5>
3667<p>the magick wand.</p>
3668
3669<h5>channel</h5>
3670<p>the channel(s).</p>
3671
3672<h5>target</h5>
3673<p>Change this target color to the fill color within the image.</p>
3674
3675<h5>fill</h5>
3676<p>the fill pixel wand.</p>
3677
3678<h5>fuzz</h5>
3679<p>By default target must match a particular pixel color exactly. However, in many cases two colors may differ by a small amount. The fuzz member of image defines how much tolerance is acceptable to consider two colors as the same. For example, set fuzz to 10 and the color red at intensities of 100 and 102 respectively are now interpreted as the same color for the purposes of the floodfill.</p>
3680
3681<h5>invert</h5>
3682<p>paint any pixel that does not match the target color.</p>
3683
3684 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]3685<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickOptimizeImageLayers">MagickOptimizeImageLayers</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]3686<div class="doc-section">
3687
3688<p>MagickOptimizeImageLayers() compares each image the GIF disposed forms of the previous image in the sequence. From this it attempts to select the smallest cropped image to replace each frame, while preserving the results of the animation.</p>
3689
3690<p>The format of the MagickOptimizeImageLayers method is:</p>
3691
3692<pre class="code">
3693 MagickWand *MagickOptimizeImageLayers(MagickWand *wand)
3694</pre>
3695
3696<p>A description of each parameter follows:</p>
3697
3698<h5>wand</h5>
3699<p>the magick wand.</p>
3700
3701 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]3702<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickOrderedPosterizeImage">MagickOrderedPosterizeImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]3703<div class="doc-section">
3704
3705<p>MagickOrderedPosterizeImage() performs an ordered dither based on a number of pre-defined dithering threshold maps, but over multiple intensity levels, which can be different for different channels, according to the input arguments.</p>
3706
3707<p>The format of the MagickOrderedPosterizeImage method is:</p>
3708
3709<pre class="code">
3710 MagickBooleanType MagickOrderedPosterizeImage(MagickWand *wand,
3711 const char *threshold_map)
3712 MagickBooleanType MagickOrderedPosterizeImageChannel(MagickWand *wand,
3713 const ChannelType channel,const char *threshold_map)
3714</pre>
3715
3716<p>A description of each parameter follows:</p>
3717
3718<h5>image</h5>
3719<p>the image.</p>
3720
3721<h5>channel</h5>
3722<p>the channel or channels to be thresholded.</p>
3723
3724<h5>threshold_map</h5>
3725<p>A string containing the name of the threshold dither map to use, followed by zero or more numbers representing the number of color levels tho dither between.</p>
3726
cristybaacd172011-04-30 23:11:03 +0000[diff] [blame]3727<p>Any level number less than 2 is equivalent to 2, and means only binary dithering will be applied to each color channel.</p>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]3728
3729<p>No numbers also means a 2 level (bitmap) dither will be applied to all channels, while a single number is the number of levels applied to each channel in sequence. More numbers will be applied in turn to each of the color channels.</p>
3730
3731<p>For example: "o3x3,6" generates a 6 level posterization of the image with a ordered 3x3 diffused pixel dither being applied between each level. While checker,8,8,4 will produce a 332 colormaped image with only a single checkerboard hash pattern (50 grey) between each color level, to basically double the number of color levels with a bare minimim of dithering.</p>
3732
3733 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]3734<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickPingImage">MagickPingImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]3735<div class="doc-section">
3736
3737<p>MagickPingImage() is like MagickReadImage() except the only valid information returned is the image width, height, size, and format. It is designed to efficiently obtain this information from a file without reading the entire image sequence into memory.</p>
3738
3739<p>The format of the MagickPingImage method is:</p>
3740
3741<pre class="code">
3742 MagickBooleanType MagickPingImage(MagickWand *wand,const char *filename)
3743</pre>
3744
3745<p>A description of each parameter follows:</p>
3746
3747<h5>wand</h5>
3748<p>the magick wand.</p>
3749
3750<h5>filename</h5>
3751<p>the image filename.</p>
3752
3753 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]3754<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickPingImageBlob">MagickPingImageBlob</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]3755<div class="doc-section">
3756
3757<p>MagickPingImageBlob() pings an image or image sequence from a blob.</p>
3758
3759<p>The format of the MagickPingImageBlob method is:</p>
3760
3761<pre class="code">
3762 MagickBooleanType MagickPingImageBlob(MagickWand *wand,
3763 const void *blob,const size_t length)
3764</pre>
3765
3766<p>A description of each parameter follows:</p>
3767
3768<h5>wand</h5>
3769<p>the magick wand.</p>
3770
3771<h5>blob</h5>
3772<p>the blob.</p>
3773
3774<h5>length</h5>
3775<p>the blob length.</p>
3776
3777 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]3778<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickPingImageFile">MagickPingImageFile</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]3779<div class="doc-section">
3780
3781<p>MagickPingImageFile() pings an image or image sequence from an open file descriptor.</p>
3782
3783<p>The format of the MagickPingImageFile method is:</p>
3784
3785<pre class="code">
3786 MagickBooleanType MagickPingImageFile(MagickWand *wand,FILE *file)
3787</pre>
3788
3789<p>A description of each parameter follows:</p>
3790
3791<h5>wand</h5>
3792<p>the magick wand.</p>
3793
3794<h5>file</h5>
3795<p>the file descriptor.</p>
3796
3797 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]3798<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickPolaroidImage">MagickPolaroidImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]3799<div class="doc-section">
3800
3801<p>MagickPolaroidImage() simulates a Polaroid picture.</p>
3802
3803<p>The format of the MagickPolaroidImage method is:</p>
3804
3805<pre class="code">
3806 MagickBooleanType MagickPolaroidImage(MagickWand *wand,
3807 const DrawingWand *drawing_wand,const double angle)
3808</pre>
3809
3810<p>A description of each parameter follows:</p>
3811
3812<h5>wand</h5>
3813<p>the magick wand.</p>
3814
3815<h5>drawing_wand</h5>
3816<p>the draw wand.</p>
3817
3818<h5>angle</h5>
3819<p>Apply the effect along this angle.</p>
3820
3821 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]3822<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickPosterizeImage">MagickPosterizeImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]3823<div class="doc-section">
3824
3825<p>MagickPosterizeImage() reduces the image to a limited number of color level.</p>
3826
3827<p>The format of the MagickPosterizeImage method is:</p>
3828
3829<pre class="code">
3830 MagickBooleanType MagickPosterizeImage(MagickWand *wand,
3831 const unsigned levels,const MagickBooleanType dither)
3832</pre>
3833
3834<p>A description of each parameter follows:</p>
3835
3836<h5>wand</h5>
3837<p>the magick wand.</p>
3838
3839<h5>levels</h5>
3840<p>Number of color levels allowed in each channel. Very low values (2, 3, or 4) have the most visible effect.</p>
3841
3842<h5>dither</h5>
3843<p>Set this integer value to something other than zero to dither the mapped image.</p>
3844
3845 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]3846<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickPreviewImages">MagickPreviewImages</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]3847<div class="doc-section">
3848
3849<p>MagickPreviewImages() tiles 9 thumbnails of the specified image with an image processing operation applied at varying strengths. This helpful to quickly pin-point an appropriate parameter for an image processing operation.</p>
3850
3851<p>The format of the MagickPreviewImages method is:</p>
3852
3853<pre class="code">
3854 MagickWand *MagickPreviewImages(MagickWand *wand,
3855 const PreviewType preview)
3856</pre>
3857
3858<p>A description of each parameter follows:</p>
3859
3860<h5>wand</h5>
3861<p>the magick wand.</p>
3862
3863<h5>preview</h5>
3864<p>the preview type.</p>
3865
3866 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]3867<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickPreviousImage">MagickPreviousImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]3868<div class="doc-section">
3869
3870<p>MagickPreviousImage() assocates the previous image in an image list with the magick wand.</p>
3871
3872<p>The format of the MagickPreviousImage method is:</p>
3873
3874<pre class="code">
3875 MagickBooleanType MagickPreviousImage(MagickWand *wand)
3876</pre>
3877
3878<p>A description of each parameter follows:</p>
3879
3880<h5>wand</h5>
3881<p>the magick wand.</p>
3882
3883 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]3884<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickQuantizeImage">MagickQuantizeImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]3885<div class="doc-section">
3886
3887<p>MagickQuantizeImage() analyzes the colors within a reference image and chooses a fixed number of colors to represent the image. The goal of the algorithm is to minimize the color difference between the input and output image while minimizing the processing time.</p>
3888
3889<p>The format of the MagickQuantizeImage method is:</p>
3890
3891<pre class="code">
3892 MagickBooleanType MagickQuantizeImage(MagickWand *wand,
3893 const size_t number_colors,const ColorspaceType colorspace,
3894 const size_t treedepth,const MagickBooleanType dither,
3895 const MagickBooleanType measure_error)
3896</pre>
3897
3898<p>A description of each parameter follows:</p>
3899
3900<h5>wand</h5>
3901<p>the magick wand.</p>
3902
3903<h5>number_colors</h5>
3904<p>the number of colors.</p>
3905
3906<h5>colorspace</h5>
3907<p>Perform color reduction in this colorspace, typically RGBColorspace.</p>
3908
3909<h5>treedepth</h5>
3910<p>Normally, this integer value is zero or one. A zero or one tells Quantize to choose a optimal tree depth of Log4(number_colors). A tree of this depth generally allows the best representation of the reference image with the least amount of memory and the fastest computational speed. In some cases, such as an image with low color dispersion (a few number of colors), a value other than Log4(number_colors) is required. To expand the color tree completely, use a value of 8.</p>
3911
3912<h5>dither</h5>
3913<p>A value other than zero distributes the difference between an original image and the corresponding color reduced image to neighboring pixels along a Hilbert curve.</p>
3914
3915<h5>measure_error</h5>
3916<p>A value other than zero measures the difference between the original and quantized images. This difference is the total quantization error. The error is computed by summing over all pixels in an image the distance squared in RGB space between each reference pixel value and its quantized value.</p>
3917
3918 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]3919<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickQuantizeImages">MagickQuantizeImages</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]3920<div class="doc-section">
3921
3922<p>MagickQuantizeImages() analyzes the colors within a sequence of images and chooses a fixed number of colors to represent the image. The goal of the algorithm is to minimize the color difference between the input and output image while minimizing the processing time.</p>
3923
3924<p>The format of the MagickQuantizeImages method is:</p>
3925
3926<pre class="code">
3927 MagickBooleanType MagickQuantizeImages(MagickWand *wand,
3928 const size_t number_colors,const ColorspaceType colorspace,
3929 const size_t treedepth,const MagickBooleanType dither,
3930 const MagickBooleanType measure_error)
3931</pre>
3932
3933<p>A description of each parameter follows:</p>
3934
3935<h5>wand</h5>
3936<p>the magick wand.</p>
3937
3938<h5>number_colors</h5>
3939<p>the number of colors.</p>
3940
3941<h5>colorspace</h5>
3942<p>Perform color reduction in this colorspace, typically RGBColorspace.</p>
3943
3944<h5>treedepth</h5>
3945<p>Normally, this integer value is zero or one. A zero or one tells Quantize to choose a optimal tree depth of Log4(number_colors). A tree of this depth generally allows the best representation of the reference image with the least amount of memory and the fastest computational speed. In some cases, such as an image with low color dispersion (a few number of colors), a value other than Log4(number_colors) is required. To expand the color tree completely, use a value of 8.</p>
3946
3947<h5>dither</h5>
3948<p>A value other than zero distributes the difference between an original image and the corresponding color reduced algorithm to neighboring pixels along a Hilbert curve.</p>
3949
3950<h5>measure_error</h5>
3951<p>A value other than zero measures the difference between the original and quantized images. This difference is the total quantization error. The error is computed by summing over all pixels in an image the distance squared in RGB space between each reference pixel value and its quantized value.</p>
3952
3953 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]3954<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickRadialBlurImage">MagickRadialBlurImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]3955<div class="doc-section">
3956
3957<p>MagickRadialBlurImage() radial blurs an image.</p>
3958
3959<p>The format of the MagickRadialBlurImage method is:</p>
3960
3961<pre class="code">
3962 MagickBooleanType MagickRadialBlurImage(MagickWand *wand,
3963 const double angle)
3964 MagickBooleanType MagickRadialBlurImageChannel(MagickWand *wand,
3965 const ChannelType channel,const double angle)
3966</pre>
3967
3968<p>A description of each parameter follows:</p>
3969
3970<h5>wand</h5>
3971<p>the magick wand.</p>
3972
3973<h5>channel</h5>
3974<p>the image channel(s).</p>
3975
3976<h5>angle</h5>
3977<p>the angle of the blur in degrees.</p>
3978
3979 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]3980<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickRaiseImage">MagickRaiseImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]3981<div class="doc-section">
3982
3983<p>MagickRaiseImage() creates a simulated three-dimensional button-like effect by lightening and darkening the edges of the image. Members width and height of raise_info define the width of the vertical and horizontal edge of the effect.</p>
3984
3985<p>The format of the MagickRaiseImage method is:</p>
3986
3987<pre class="code">
3988 MagickBooleanType MagickRaiseImage(MagickWand *wand,
3989 const size_t width,const size_t height,const ssize_t x,
3990 const ssize_t y,const MagickBooleanType raise)
3991</pre>
3992
3993<p>A description of each parameter follows:</p>
3994
3995<h5>wand</h5>
3996<p>the magick wand.</p>
3997
3998<h5>width,height,x,y</h5>
3999<p>Define the dimensions of the area to raise.</p>
4000
4001<h5>raise</h5>
4002<p>A value other than zero creates a 3-D raise effect, otherwise it has a lowered effect.</p>
4003
4004 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]4005<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickRandomThresholdImage">MagickRandomThresholdImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]4006<div class="doc-section">
4007
4008<p>MagickRandomThresholdImage() changes the value of individual pixels based on the intensity of each pixel compared to threshold. The result is a high-contrast, two color image.</p>
4009
4010<p>The format of the MagickRandomThresholdImage method is:</p>
4011
4012<pre class="code">
4013 MagickBooleanType MagickRandomThresholdImage(MagickWand *wand,
4014 const double low,const double high)
4015 MagickBooleanType MagickRandomThresholdImageChannel(MagickWand *wand,
4016 const ChannelType channel,const double low,const double high)
4017</pre>
4018
4019<p>A description of each parameter follows:</p>
4020
4021<h5>wand</h5>
4022<p>the magick wand.</p>
4023
4024<h5>channel</h5>
4025<p>the image channel(s).</p>
4026
4027<h5>low,high</h5>
4028<p>Specify the high and low thresholds. These values range from 0 to QuantumRange.</p>
4029
4030 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]4031<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickReadImage">MagickReadImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]4032<div class="doc-section">
4033
4034<p>MagickReadImage() reads an image or image sequence. The images are inserted at the current image pointer position. Use MagickSetFirstIterator(), MagickSetLastIterator, or MagickSetImageIndex() to specify the current image pointer position at the beginning of the image list, the end, or anywhere in-between respectively.</p>
4035
4036<p>The format of the MagickReadImage method is:</p>
4037
4038<pre class="code">
4039 MagickBooleanType MagickReadImage(MagickWand *wand,const char *filename)
4040</pre>
4041
4042<p>A description of each parameter follows:</p>
4043
4044<h5>wand</h5>
4045<p>the magick wand.</p>
4046
4047<h5>filename</h5>
4048<p>the image filename.</p>
4049
4050 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]4051<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickReadImageBlob">MagickReadImageBlob</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]4052<div class="doc-section">
4053
4054<p>MagickReadImageBlob() reads an image or image sequence from a blob.</p>
4055
4056<p>The format of the MagickReadImageBlob method is:</p>
4057
4058<pre class="code">
4059 MagickBooleanType MagickReadImageBlob(MagickWand *wand,
4060 const void *blob,const size_t length)
4061</pre>
4062
4063<p>A description of each parameter follows:</p>
4064
4065<h5>wand</h5>
4066<p>the magick wand.</p>
4067
4068<h5>blob</h5>
4069<p>the blob.</p>
4070
4071<h5>length</h5>
4072<p>the blob length.</p>
4073
4074 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]4075<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickReadImageFile">MagickReadImageFile</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]4076<div class="doc-section">
4077
4078<p>MagickReadImageFile() reads an image or image sequence from an open file descriptor.</p>
4079
4080<p>The format of the MagickReadImageFile method is:</p>
4081
4082<pre class="code">
4083 MagickBooleanType MagickReadImageFile(MagickWand *wand,FILE *file)
4084</pre>
4085
4086<p>A description of each parameter follows:</p>
4087
4088<h5>wand</h5>
4089<p>the magick wand.</p>
4090
4091<h5>file</h5>
4092<p>the file descriptor.</p>
4093
4094 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]4095<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickRemapImage">MagickRemapImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]4096<div class="doc-section">
4097
4098<p>MagickRemapImage() replaces the colors of an image with the closest color from a reference image.</p>
4099
4100<p>The format of the MagickRemapImage method is:</p>
4101
4102<pre class="code">
4103 MagickBooleanType MagickRemapImage(MagickWand *wand,
4104 const MagickWand *remap_wand,const DitherMethod method)
4105</pre>
4106
4107<p>A description of each parameter follows:</p>
4108
4109<h5>wand</h5>
4110<p>the magick wand.</p>
4111
4112<h5>affinity</h5>
4113<p>the affinity wand.</p>
4114
4115<h5>method</h5>
4116<p>choose from these dither methods: NoDitherMethod, RiemersmaDitherMethod, or FloydSteinbergDitherMethod.</p>
4117
4118 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]4119<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickRemoveImage">MagickRemoveImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]4120<div class="doc-section">
4121
4122<p>MagickRemoveImage() removes an image from the image list.</p>
4123
4124<p>The format of the MagickRemoveImage method is:</p>
4125
4126<pre class="code">
4127 MagickBooleanType MagickRemoveImage(MagickWand *wand)
4128</pre>
4129
4130<p>A description of each parameter follows:</p>
4131
4132<h5>wand</h5>
4133<p>the magick wand.</p>
4134
4135<h5>insert</h5>
4136<p>the splice wand.</p>
4137
4138 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]4139<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickResampleImage">MagickResampleImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]4140<div class="doc-section">
4141
4142<p>MagickResampleImage() resample image to desired resolution.</p>
4143
4144<p>Bessel Blackman Box Catrom Cubic Gaussian Hanning Hermite Lanczos Mitchell Point Quandratic Sinc Triangle</p>
4145
4146<p>Most of the filters are FIR (finite impulse response), however, Bessel, Gaussian, and Sinc are IIR (infinite impulse response). Bessel and Sinc are windowed (brought down to zero) with the Blackman filter.</p>
4147
4148<p>The format of the MagickResampleImage method is:</p>
4149
4150<pre class="code">
4151 MagickBooleanType MagickResampleImage(MagickWand *wand,
4152 const double x_resolution,const double y_resolution,
4153 const FilterTypes filter,const double blur)
4154</pre>
4155
4156<p>A description of each parameter follows:</p>
4157
4158<h5>wand</h5>
4159<p>the magick wand.</p>
4160
4161<h5>x_resolution</h5>
4162<p>the new image x resolution.</p>
4163
4164<h5>y_resolution</h5>
4165<p>the new image y resolution.</p>
4166
4167<h5>filter</h5>
4168<p>Image filter to use.</p>
4169
4170<h5>blur</h5>
4171<p>the blur factor where > 1 is blurry, < 1 is sharp.</p>
4172
4173 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]4174<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickResetImagePage">MagickResetImagePage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]4175<div class="doc-section">
4176
4177<p>MagickResetImagePage() resets the Wand page canvas and position.</p>
4178
4179<p>The format of the MagickResetImagePage method is:</p>
4180
4181<pre class="code">
4182 MagickBooleanType MagickResetImagePage(MagickWand *wand,
4183 const char *page)
4184</pre>
4185
4186<p>A description of each parameter follows:</p>
4187
4188<h5>wand</h5>
4189<p>the magick wand.</p>
4190
4191<h5>page</h5>
4192<p>the relative page specification.</p>
4193
4194 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]4195<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickResizeImage">MagickResizeImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]4196<div class="doc-section">
4197
4198<p>MagickResizeImage() scales an image to the desired dimensions with one of these filters:</p>
4199
4200<pre class="text">
4201 Bessel Blackman Box
4202 Catrom CubicGaussian
4203 Hanning Hermite Lanczos
4204 Mitchell PointQuandratic
4205 Sinc Triangle
4206</pre>
4207
4208<p>Most of the filters are FIR (finite impulse response), however, Bessel, Gaussian, and Sinc are IIR (infinite impulse response). Bessel and Sinc are windowed (brought down to zero) with the Blackman filter.</p>
4209
4210<p>The format of the MagickResizeImage method is:</p>
4211
4212<pre class="code">
4213 MagickBooleanType MagickResizeImage(MagickWand *wand,
4214 const size_t columns,const size_t rows,
4215 const FilterTypes filter,const double blur)
4216</pre>
4217
4218<p>A description of each parameter follows:</p>
4219
4220<h5>wand</h5>
4221<p>the magick wand.</p>
4222
4223<h5>columns</h5>
4224<p>the number of columns in the scaled image.</p>
4225
4226<h5>rows</h5>
4227<p>the number of rows in the scaled image.</p>
4228
4229<h5>filter</h5>
4230<p>Image filter to use.</p>
4231
4232<h5>blur</h5>
4233<p>the blur factor where > 1 is blurry, < 1 is sharp.</p>
4234
4235 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]4236<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickRollImage">MagickRollImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]4237<div class="doc-section">
4238
4239<p>MagickRollImage() offsets an image as defined by x and y.</p>
4240
4241<p>The format of the MagickRollImage method is:</p>
4242
4243<pre class="code">
4244 MagickBooleanType MagickRollImage(MagickWand *wand,const ssize_t x,
4245 const size_t y)
4246</pre>
4247
4248<p>A description of each parameter follows:</p>
4249
4250<h5>wand</h5>
4251<p>the magick wand.</p>
4252
4253<h5>x</h5>
4254<p>the x offset.</p>
4255
4256<h5>y</h5>
4257<p>the y offset.</p>
4258
4259
4260 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]4261<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickRotateImage">MagickRotateImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]4262<div class="doc-section">
4263
4264<p>MagickRotateImage() rotates an image the specified number of degrees. Empty triangles left over from rotating the image are filled with the background color.</p>
4265
4266<p>The format of the MagickRotateImage method is:</p>
4267
4268<pre class="code">
4269 MagickBooleanType MagickRotateImage(MagickWand *wand,
4270 const PixelWand *background,const double degrees)
4271</pre>
4272
4273<p>A description of each parameter follows:</p>
4274
4275<h5>wand</h5>
4276<p>the magick wand.</p>
4277
4278<h5>background</h5>
4279<p>the background pixel wand.</p>
4280
4281<h5>degrees</h5>
4282<p>the number of degrees to rotate the image.</p>
4283
4284
4285 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]4286<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickSampleImage">MagickSampleImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]4287<div class="doc-section">
4288
4289<p>MagickSampleImage() scales an image to the desired dimensions with pixel sampling. Unlike other scaling methods, this method does not introduce any additional color into the scaled image.</p>
4290
4291<p>The format of the MagickSampleImage method is:</p>
4292
4293<pre class="code">
4294 MagickBooleanType MagickSampleImage(MagickWand *wand,
4295 const size_t columns,const size_t rows)
4296</pre>
4297
4298<p>A description of each parameter follows:</p>
4299
4300<h5>wand</h5>
4301<p>the magick wand.</p>
4302
4303<h5>columns</h5>
4304<p>the number of columns in the scaled image.</p>
4305
4306<h5>rows</h5>
4307<p>the number of rows in the scaled image.</p>
4308
4309
4310 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]4311<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickScaleImage">MagickScaleImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]4312<div class="doc-section">
4313
4314<p>MagickScaleImage() scales the size of an image to the given dimensions.</p>
4315
4316<p>The format of the MagickScaleImage method is:</p>
4317
4318<pre class="code">
4319 MagickBooleanType MagickScaleImage(MagickWand *wand,
4320 const size_t columns,const size_t rows)
4321</pre>
4322
4323<p>A description of each parameter follows:</p>
4324
4325<h5>wand</h5>
4326<p>the magick wand.</p>
4327
4328<h5>columns</h5>
4329<p>the number of columns in the scaled image.</p>
4330
4331<h5>rows</h5>
4332<p>the number of rows in the scaled image.</p>
4333
4334
4335 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]4336<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickSegmentImage">MagickSegmentImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]4337<div class="doc-section">
4338
4339<p>MagickSegmentImage() segments an image by analyzing the histograms of the color components and identifying units that are homogeneous with the fuzzy C-means technique.</p>
4340
4341<p>The format of the SegmentImage method is:</p>
4342
4343<pre class="code">
4344 MagickBooleanType MagickSegmentImage(MagickWand *wand,
4345 const ColorspaceType colorspace,const MagickBooleanType verbose,
4346 const double cluster_threshold,const double smooth_threshold)
4347</pre>
4348
4349<p>A description of each parameter follows.</p>
4350
4351<h5>wand</h5>
4352<p>the wand.</p>
4353
4354<h5>colorspace</h5>
4355<p>the image colorspace.</p>
4356
4357<h5>verbose</h5>
4358<p>Set to MagickTrue to print detailed information about the identified classes.</p>
4359
4360<h5>cluster_threshold</h5>
4361<p>This represents the minimum number of pixels contained in a hexahedra before it can be considered valid (expressed as a percentage).</p>
4362
4363<h5>smooth_threshold</h5>
4364<p>the smoothing threshold eliminates noise in the second derivative of the histogram. As the value is increased, you can expect a smoother second derivative.</p>
4365
4366 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]4367<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickSelectiveBlurImage">MagickSelectiveBlurImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]4368<div class="doc-section">
4369
4370<p>MagickSelectiveBlurImage() selectively blur an image within a contrast threshold. It is similar to the unsharpen mask that sharpens everything with contrast above a certain threshold.</p>
4371
4372<p>The format of the MagickSelectiveBlurImage method is:</p>
4373
4374<pre class="code">
4375 MagickBooleanType MagickSelectiveBlurImage(MagickWand *wand,
4376 const double radius,const double sigma,const double threshold)
4377 MagickBooleanType MagickSelectiveBlurImageChannel(MagickWand *wand,
4378 const ChannelType channel,const double radius,const double sigma,
4379 const double threshold)
4380</pre>
4381
4382<p>A description of each parameter follows:</p>
4383
4384<h5>wand</h5>
4385<p>the magick wand.</p>
4386
4387<h5>channel</h5>
4388<p>the image channel(s).</p>
4389
4390<h5>radius</h5>
4391<p>the radius of the gaussian, in pixels, not counting the center pixel.</p>
4392
4393<h5>sigma</h5>
4394<p>the standard deviation of the gaussian, in pixels.</p>
4395
4396<h5>threshold</h5>
4397<p>only pixels within this contrast threshold are included in the blur operation.</p>
4398
4399 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]4400<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickSeparateImageChannel">MagickSeparateImageChannel</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]4401<div class="doc-section">
4402
4403<p>MagickSeparateImageChannel() separates a channel from the image and returns a grayscale image. A channel is a particular color component of each pixel in the image.</p>
4404
4405<p>The format of the MagickSeparateImageChannel method is:</p>
4406
4407<pre class="code">
4408 MagickBooleanType MagickSeparateImageChannel(MagickWand *wand,
4409 const ChannelType channel)
4410</pre>
4411
4412<p>A description of each parameter follows:</p>
4413
4414<h5>wand</h5>
4415<p>the magick wand.</p>
4416
4417<h5>channel</h5>
4418<p>the image channel(s).</p>
4419
4420 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]4421<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickSepiaToneImage">MagickSepiaToneImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]4422<div class="doc-section">
4423
4424<p>MagickSepiaToneImage() applies a special effect to the image, similar to the effect achieved in a photo darkroom by sepia toning. Threshold ranges from 0 to QuantumRange and is a measure of the extent of the sepia toning. A threshold of 80 is a good starting point for a reasonable tone.</p>
4425
4426<p>The format of the MagickSepiaToneImage method is:</p>
4427
4428<pre class="code">
4429 MagickBooleanType MagickSepiaToneImage(MagickWand *wand,
4430 const double threshold)
4431</pre>
4432
4433<p>A description of each parameter follows:</p>
4434
4435<h5>wand</h5>
4436<p>the magick wand.</p>
4437
4438<h5>threshold</h5>
4439<p>Define the extent of the sepia toning.</p>
4440
4441 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]4442<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickSetImage">MagickSetImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]4443<div class="doc-section">
4444
4445<p>MagickSetImage() replaces the last image returned by MagickSetImageIndex(), MagickNextImage(), MagickPreviousImage() with the images from the specified wand.</p>
4446
4447<p>The format of the MagickSetImage method is:</p>
4448
4449<pre class="code">
4450 MagickBooleanType MagickSetImage(MagickWand *wand,
4451 const MagickWand *set_wand)
4452</pre>
4453
4454<p>A description of each parameter follows:</p>
4455
4456<h5>wand</h5>
4457<p>the magick wand.</p>
4458
4459<h5>set_wand</h5>
4460<p>the set_wand wand.</p>
4461
4462 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]4463<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickSetImageAlphaChannel">MagickSetImageAlphaChannel</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]4464<div class="doc-section">
4465
4466<p>MagickSetImageAlphaChannel() activates, deactivates, resets, or sets the alpha channel.</p>
4467
4468<p>The format of the MagickSetImageAlphaChannel method is:</p>
4469
4470<pre class="code">
4471 MagickBooleanType MagickSetImageAlphaChannel(MagickWand *wand,
4472 const AlphaChannelType alpha_type)
4473</pre>
4474
4475<p>A description of each parameter follows:</p>
4476
4477<h5>wand</h5>
4478<p>the magick wand.</p>
4479
4480<h5>alpha_type</h5>
4481<p>the alpha channel type: ActivateAlphaChannel, DeactivateAlphaChannel, OpaqueAlphaChannel, or SetAlphaChannel.</p>
4482
4483 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]4484<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickSetImageBackgroundColor">MagickSetImageBackgroundColor</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]4485<div class="doc-section">
4486
4487<p>MagickSetImageBackgroundColor() sets the image background color.</p>
4488
4489<p>The format of the MagickSetImageBackgroundColor method is:</p>
4490
4491<pre class="code">
4492 MagickBooleanType MagickSetImageBackgroundColor(MagickWand *wand,
4493 const PixelWand *background)
4494</pre>
4495
4496<p>A description of each parameter follows:</p>
4497
4498<h5>wand</h5>
4499<p>the magick wand.</p>
4500
4501<h5>background</h5>
4502<p>the background pixel wand.</p>
4503
4504 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]4505<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickSetImageBias">MagickSetImageBias</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]4506<div class="doc-section">
4507
4508<p>MagickSetImageBias() sets the image bias for any method that convolves an image (e.g. MagickConvolveImage()).</p>
4509
4510<p>The format of the MagickSetImageBias method is:</p>
4511
4512<pre class="code">
4513 MagickBooleanType MagickSetImageBias(MagickWand *wand,
4514 const double bias)
4515</pre>
4516
4517<p>A description of each parameter follows:</p>
4518
4519<h5>wand</h5>
4520<p>the magick wand.</p>
4521
4522<h5>bias</h5>
4523<p>the image bias.</p>
4524
4525 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]4526<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickSetImageBluePrimary">MagickSetImageBluePrimary</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]4527<div class="doc-section">
4528
4529<p>MagickSetImageBluePrimary() sets the image chromaticity blue primary point.</p>
4530
4531<p>The format of the MagickSetImageBluePrimary method is:</p>
4532
4533<pre class="code">
4534 MagickBooleanType MagickSetImageBluePrimary(MagickWand *wand,
4535 const double x,const double y)
4536</pre>
4537
4538<p>A description of each parameter follows:</p>
4539
4540<h5>wand</h5>
4541<p>the magick wand.</p>
4542
4543<h5>x</h5>
4544<p>the blue primary x-point.</p>
4545
4546<h5>y</h5>
4547<p>the blue primary y-point.</p>
4548
4549 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]4550<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickSetImageBorderColor">MagickSetImageBorderColor</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]4551<div class="doc-section">
4552
4553<p>MagickSetImageBorderColor() sets the image border color.</p>
4554
4555<p>The format of the MagickSetImageBorderColor method is:</p>
4556
4557<pre class="code">
4558 MagickBooleanType MagickSetImageBorderColor(MagickWand *wand,
4559 const PixelWand *border)
4560</pre>
4561
4562<p>A description of each parameter follows:</p>
4563
4564<h5>wand</h5>
4565<p>the magick wand.</p>
4566
4567<h5>border</h5>
4568<p>the border pixel wand.</p>
4569
4570 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]4571<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickSetImageChannelDepth">MagickSetImageChannelDepth</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]4572<div class="doc-section">
4573
4574<p>MagickSetImageChannelDepth() sets the depth of a particular image channel.</p>
4575
4576<p>The format of the MagickSetImageChannelDepth method is:</p>
4577
4578<pre class="code">
4579 MagickBooleanType MagickSetImageChannelDepth(MagickWand *wand,
4580 const ChannelType channel,const size_t depth)
4581</pre>
4582
4583<p>A description of each parameter follows:</p>
4584
4585<h5>wand</h5>
4586<p>the magick wand.</p>
4587
4588<h5>channel</h5>
4589<p>the image channel(s).</p>
4590
4591<h5>depth</h5>
4592<p>the image depth in bits.</p>
4593
4594 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]4595<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickSetImageClipMask">MagickSetImageClipMask</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]4596<div class="doc-section">
4597
4598<p>MagickSetImageClipMask() sets image clip mask.</p>
4599
4600<p>The format of the MagickSetImageClipMask method is:</p>
4601
4602<pre class="code">
4603 MagickBooleanType MagickSetImageClipMask(MagickWand *wand,
4604 const MagickWand *clip_mask)
4605</pre>
4606
4607<p>A description of each parameter follows:</p>
4608
4609<h5>wand</h5>
4610<p>the magick wand.</p>
4611
4612<h5>clip_mask</h5>
4613<p>the clip_mask wand.</p>
4614
4615 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]4616<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickSetImageColor">MagickSetImageColor</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]4617<div class="doc-section">
4618
4619<p>MagickSetImageColor() set the entire wand canvas to the specified color.</p>
4620
4621<p>The format of the MagickSetImageColor method is:</p>
4622
4623<pre class="code">
4624 MagickBooleanType MagickSetImageColor(MagickWand *wand,
4625 const PixelWand *color)
4626</pre>
4627
4628<p>A description of each parameter follows:</p>
4629
4630<h5>wand</h5>
4631<p>the magick wand.</p>
4632
4633<h5>background</h5>
4634<p>the image color.</p>
4635
4636 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]4637<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickSetImageColormapColor">MagickSetImageColormapColor</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]4638<div class="doc-section">
4639
4640<p>MagickSetImageColormapColor() sets the color of the specified colormap index.</p>
4641
4642<p>The format of the MagickSetImageColormapColor method is:</p>
4643
4644<pre class="code">
4645 MagickBooleanType MagickSetImageColormapColor(MagickWand *wand,
4646 const size_t index,const PixelWand *color)
4647</pre>
4648
4649<p>A description of each parameter follows:</p>
4650
4651<h5>wand</h5>
4652<p>the magick wand.</p>
4653
4654<h5>index</h5>
4655<p>the offset into the image colormap.</p>
4656
4657<h5>color</h5>
4658<p>Return the colormap color in this wand.</p>
4659
4660 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]4661<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickSetImageColorspace">MagickSetImageColorspace</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]4662<div class="doc-section">
4663
4664<p>MagickSetImageColorspace() sets the image colorspace.</p>
4665
4666<p>The format of the MagickSetImageColorspace method is:</p>
4667
4668<pre class="code">
4669 MagickBooleanType MagickSetImageColorspace(MagickWand *wand,
4670 const ColorspaceType colorspace)
4671</pre>
4672
4673<p>A description of each parameter follows:</p>
4674
4675<h5>wand</h5>
4676<p>the magick wand.</p>
4677
4678<h5>colorspace</h5>
4679<p>the image colorspace: UndefinedColorspace, RGBColorspace, GRAYColorspace, TransparentColorspace, OHTAColorspace, XYZColorspace, YCbCrColorspace, YCCColorspace, YIQColorspace, YPbPrColorspace, YPbPrColorspace, YUVColorspace, CMYKColorspace, sRGBColorspace, HSLColorspace, or HWBColorspace.</p>
4680
4681 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]4682<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickSetImageCompose">MagickSetImageCompose</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]4683<div class="doc-section">
4684
4685<p>MagickSetImageCompose() sets the image composite operator, useful for specifying how to composite the image thumbnail when using the MagickMontageImage() method.</p>
4686
4687<p>The format of the MagickSetImageCompose method is:</p>
4688
4689<pre class="code">
4690 MagickBooleanType MagickSetImageCompose(MagickWand *wand,
4691 const CompositeOperator compose)
4692</pre>
4693
4694<p>A description of each parameter follows:</p>
4695
4696<h5>wand</h5>
4697<p>the magick wand.</p>
4698
4699<h5>compose</h5>
4700<p>the image composite operator.</p>
4701
4702 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]4703<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickSetImageCompression">MagickSetImageCompression</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]4704<div class="doc-section">
4705
4706<p>MagickSetImageCompression() sets the image compression.</p>
4707
4708<p>The format of the MagickSetImageCompression method is:</p>
4709
4710<pre class="code">
4711 MagickBooleanType MagickSetImageCompression(MagickWand *wand,
4712 const CompressionType compression)
4713</pre>
4714
4715<p>A description of each parameter follows:</p>
4716
4717<h5>wand</h5>
4718<p>the magick wand.</p>
4719
4720<h5>compression</h5>
4721<p>the image compression type.</p>
4722
4723 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]4724<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickSetImageCompressionQuality">MagickSetImageCompressionQuality</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]4725<div class="doc-section">
4726
4727<p>MagickSetImageCompressionQuality() sets the image compression quality.</p>
4728
4729<p>The format of the MagickSetImageCompressionQuality method is:</p>
4730
4731<pre class="code">
4732 MagickBooleanType MagickSetImageCompressionQuality(MagickWand *wand,
4733 const size_t quality)
4734</pre>
4735
4736<p>A description of each parameter follows:</p>
4737
4738<h5>wand</h5>
4739<p>the magick wand.</p>
4740
4741<h5>quality</h5>
4742<p>the image compression tlityype.</p>
4743
4744 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]4745<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickSetImageDelay">MagickSetImageDelay</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]4746<div class="doc-section">
4747
4748<p>MagickSetImageDelay() sets the image delay.</p>
4749
4750<p>The format of the MagickSetImageDelay method is:</p>
4751
4752<pre class="code">
4753 MagickBooleanType MagickSetImageDelay(MagickWand *wand,
4754 const size_t delay)
4755</pre>
4756
4757<p>A description of each parameter follows:</p>
4758
4759<h5>wand</h5>
4760<p>the magick wand.</p>
4761
4762<h5>delay</h5>
4763<p>the image delay in ticks-per-second units.</p>
4764
4765 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]4766<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickSetImageDepth">MagickSetImageDepth</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]4767<div class="doc-section">
4768
4769<p>MagickSetImageDepth() sets the image depth.</p>
4770
4771<p>The format of the MagickSetImageDepth method is:</p>
4772
4773<pre class="code">
4774 MagickBooleanType MagickSetImageDepth(MagickWand *wand,
4775 const size_t depth)
4776</pre>
4777
4778<p>A description of each parameter follows:</p>
4779
4780<h5>wand</h5>
4781<p>the magick wand.</p>
4782
4783<h5>depth</h5>
4784<p>the image depth in bits: 8, 16, or 32.</p>
4785
4786 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]4787<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickSetImageDispose">MagickSetImageDispose</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]4788<div class="doc-section">
4789
4790<p>MagickSetImageDispose() sets the image disposal method.</p>
4791
4792<p>The format of the MagickSetImageDispose method is:</p>
4793
4794<pre class="code">
4795 MagickBooleanType MagickSetImageDispose(MagickWand *wand,
4796 const DisposeType dispose)
4797</pre>
4798
4799<p>A description of each parameter follows:</p>
4800
4801<h5>wand</h5>
4802<p>the magick wand.</p>
4803
4804<h5>dispose</h5>
4805<p>the image disposeal type.</p>
4806
4807 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]4808<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickSetImageExtent">MagickSetImageExtent</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]4809<div class="doc-section">
4810
4811<p>MagickSetImageExtent() sets the image size (i.e. columns & rows).</p>
4812
4813<p>The format of the MagickSetImageExtent method is:</p>
4814
4815<pre class="code">
4816 MagickBooleanType MagickSetImageExtent(MagickWand *wand,
4817 const size_t columns,const unsigned rows)
4818</pre>
4819
4820<p>A description of each parameter follows:</p>
4821
4822<h5>wand</h5>
4823<p>the magick wand.</p>
4824
4825<h5>columns</h5>
4826<p>The image width in pixels.</p>
4827
4828<h5>rows</h5>
4829<p>The image height in pixels.</p>
4830
4831 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]4832<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickSetImageFilename">MagickSetImageFilename</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]4833<div class="doc-section">
4834
4835<p>MagickSetImageFilename() sets the filename of a particular image in a sequence.</p>
4836
4837<p>The format of the MagickSetImageFilename method is:</p>
4838
4839<pre class="code">
4840 MagickBooleanType MagickSetImageFilename(MagickWand *wand,
4841 const char *filename)
4842</pre>
4843
4844<p>A description of each parameter follows:</p>
4845
4846<h5>wand</h5>
4847<p>the magick wand.</p>
4848
4849<h5>filename</h5>
4850<p>the image filename.</p>
4851
4852 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]4853<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickSetImageFormat">MagickSetImageFormat</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]4854<div class="doc-section">
4855
4856<p>MagickSetImageFormat() sets the format of a particular image in a sequence.</p>
4857
4858<p>The format of the MagickSetImageFormat method is:</p>
4859
4860<pre class="code">
4861 MagickBooleanType MagickSetImageFormat(MagickWand *wand,
4862 const char *format)
4863</pre>
4864
4865<p>A description of each parameter follows:</p>
4866
4867<h5>wand</h5>
4868<p>the magick wand.</p>
4869
4870<h5>format</h5>
4871<p>the image format.</p>
4872
4873 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]4874<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickSetImageFuzz">MagickSetImageFuzz</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]4875<div class="doc-section">
4876
4877<p>MagickSetImageFuzz() sets the image fuzz.</p>
4878
4879<p>The format of the MagickSetImageFuzz method is:</p>
4880
4881<pre class="code">
4882 MagickBooleanType MagickSetImageFuzz(MagickWand *wand,
4883 const double fuzz)
4884</pre>
4885
4886<p>A description of each parameter follows:</p>
4887
4888<h5>wand</h5>
4889<p>the magick wand.</p>
4890
4891<h5>fuzz</h5>
4892<p>the image fuzz.</p>
4893
4894 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]4895<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickSetImageGamma">MagickSetImageGamma</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]4896<div class="doc-section">
4897
4898<p>MagickSetImageGamma() sets the image gamma.</p>
4899
4900<p>The format of the MagickSetImageGamma method is:</p>
4901
4902<pre class="code">
4903 MagickBooleanType MagickSetImageGamma(MagickWand *wand,
4904 const double gamma)
4905</pre>
4906
4907<p>A description of each parameter follows:</p>
4908
4909<h5>wand</h5>
4910<p>the magick wand.</p>
4911
4912<h5>gamma</h5>
4913<p>the image gamma.</p>
4914
4915 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]4916<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickSetImageGravity">MagickSetImageGravity</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]4917<div class="doc-section">
4918
4919<p>MagickSetImageGravity() sets the image gravity type.</p>
4920
4921<p>The format of the MagickSetImageGravity method is:</p>
4922
4923<pre class="code">
4924 MagickBooleanType MagickSetImageGravity(MagickWand *wand,
4925 const GravityType gravity)
4926</pre>
4927
4928<p>A description of each parameter follows:</p>
4929
4930<h5>wand</h5>
4931<p>the magick wand.</p>
4932
4933<h5>gravity</h5>
4934<p>the image interlace scheme: NoInterlace, LineInterlace, PlaneInterlace, PartitionInterlace.</p>
4935
4936 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]4937<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickSetImageGreenPrimary">MagickSetImageGreenPrimary</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]4938<div class="doc-section">
4939
4940<p>MagickSetImageGreenPrimary() sets the image chromaticity green primary point.</p>
4941
4942<p>The format of the MagickSetImageGreenPrimary method is:</p>
4943
4944<pre class="code">
4945 MagickBooleanType MagickSetImageGreenPrimary(MagickWand *wand,
4946 const double x,const double y)
4947</pre>
4948
4949<p>A description of each parameter follows:</p>
4950
4951<h5>wand</h5>
4952<p>the magick wand.</p>
4953
4954<h5>x</h5>
4955<p>the green primary x-point.</p>
4956
4957<h5>y</h5>
4958<p>the green primary y-point.</p>
4959
4960
4961 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]4962<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickSetImageInterlaceScheme">MagickSetImageInterlaceScheme</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]4963<div class="doc-section">
4964
4965<p>MagickSetImageInterlaceScheme() sets the image interlace scheme.</p>
4966
4967<p>The format of the MagickSetImageInterlaceScheme method is:</p>
4968
4969<pre class="code">
4970 MagickBooleanType MagickSetImageInterlaceScheme(MagickWand *wand,
4971 const InterlaceType interlace)
4972</pre>
4973
4974<p>A description of each parameter follows:</p>
4975
4976<h5>wand</h5>
4977<p>the magick wand.</p>
4978
4979<h5>interlace</h5>
4980<p>the image interlace scheme: NoInterlace, LineInterlace, PlaneInterlace, PartitionInterlace.</p>
4981
4982 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]4983<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickSetImageInterpolateMethod">MagickSetImageInterpolateMethod</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]4984<div class="doc-section">
4985
4986<p>MagickSetImageInterpolateMethod() sets the image interpolate pixel method.</p>
4987
4988<p>The format of the MagickSetImageInterpolateMethod method is:</p>
4989
4990<pre class="code">
4991 MagickBooleanType MagickSetImageInterpolateMethod(MagickWand *wand,
4992 const InterpolatePixelMethod method)
4993</pre>
4994
4995<p>A description of each parameter follows:</p>
4996
4997<h5>wand</h5>
4998<p>the magick wand.</p>
4999
5000<h5>method</h5>
5001<p>the image interpole pixel methods: choose from Undefined, Average, Bicubic, Bilinear, Filter, Integer, Mesh, NearestNeighbor.</p>
5002
5003 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]5004<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickSetImageIterations">MagickSetImageIterations</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]5005<div class="doc-section">
5006
5007<p>MagickSetImageIterations() sets the image iterations.</p>
5008
5009<p>The format of the MagickSetImageIterations method is:</p>
5010
5011<pre class="code">
5012 MagickBooleanType MagickSetImageIterations(MagickWand *wand,
5013 const size_t iterations)
5014</pre>
5015
5016<p>A description of each parameter follows:</p>
5017
5018<h5>wand</h5>
5019<p>the magick wand.</p>
5020
5021<h5>delay</h5>
5022<p>the image delay in 1/100th of a second.</p>
5023
5024 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]5025<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickSetImageMatte">MagickSetImageMatte</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]5026<div class="doc-section">
5027
5028<p>MagickSetImageMatte() sets the image matte channel.</p>
5029
5030<p>The format of the MagickSetImageMatteColor method is:</p>
5031
5032<pre class="code">
5033 MagickBooleanType MagickSetImageMatteColor(MagickWand *wand,
5034 const MagickBooleanType *matte)
5035</pre>
5036
5037<p>A description of each parameter follows:</p>
5038
5039<h5>wand</h5>
5040<p>the magick wand.</p>
5041
5042<h5>matte</h5>
5043<p>Set to MagickTrue to enable the image matte channel otherwise MagickFalse.</p>
5044
5045 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]5046<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickSetImageMatteColor">MagickSetImageMatteColor</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]5047<div class="doc-section">
5048
5049<p>MagickSetImageMatteColor() sets the image matte color.</p>
5050
5051<p>The format of the MagickSetImageMatteColor method is:</p>
5052
5053<pre class="code">
5054 MagickBooleanType MagickSetImageMatteColor(MagickWand *wand,
5055 const PixelWand *matte)
5056</pre>
5057
5058<p>A description of each parameter follows:</p>
5059
5060<h5>wand</h5>
5061<p>the magick wand.</p>
5062
5063<h5>matte</h5>
5064<p>the matte pixel wand.</p>
5065
5066 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]5067<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickSetImageOpacity">MagickSetImageOpacity</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]5068<div class="doc-section">
5069
5070<p>MagickSetImageOpacity() sets the image to the specified opacity level.</p>
5071
5072<p>The format of the MagickSetImageOpacity method is:</p>
5073
5074<pre class="code">
5075 MagickBooleanType MagickSetImageOpacity(MagickWand *wand,
5076 const double alpha)
5077</pre>
5078
5079<p>A description of each parameter follows:</p>
5080
5081<h5>wand</h5>
5082<p>the magick wand.</p>
5083
5084<h5>alpha</h5>
5085<p>the level of transparency: 1.0 is fully opaque and 0.0 is fully transparent.</p>
5086
5087 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]5088<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickSetImageOrientation">MagickSetImageOrientation</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]5089<div class="doc-section">
5090
5091<p>MagickSetImageOrientation() sets the image orientation.</p>
5092
5093<p>The format of the MagickSetImageOrientation method is:</p>
5094
5095<pre class="code">
5096 MagickBooleanType MagickSetImageOrientation(MagickWand *wand,
5097 const OrientationType orientation)
5098</pre>
5099
5100<p>A description of each parameter follows:</p>
5101
5102<h5>wand</h5>
5103<p>the magick wand.</p>
5104
5105<h5>orientation</h5>
5106<p>the image orientation type.</p>
5107
5108 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]5109<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickSetImagePage">MagickSetImagePage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]5110<div class="doc-section">
5111
5112<p>MagickSetImagePage() sets the page geometry of the image.</p>
5113
5114<p>The format of the MagickSetImagePage method is:</p>
5115
5116<pre class="code">
5117 MagickBooleanType MagickSetImagePage(MagickWand *wand,
5118 const size_t width,const size_t height,const ssize_t x,
5119 const ssize_t y)
5120</pre>
5121
5122<p>A description of each parameter follows:</p>
5123
5124<h5>wand</h5>
5125<p>the magick wand.</p>
5126
5127<h5>width</h5>
5128<p>the page width.</p>
5129
5130<h5>height</h5>
5131<p>the page height.</p>
5132
5133<h5>x</h5>
5134<p>the page x-offset.</p>
5135
5136<h5>y</h5>
5137<p>the page y-offset.</p>
5138
5139 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]5140<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickSetImageProgressMonitor">MagickSetImageProgressMonitor</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]5141<div class="doc-section">
5142
5143<p>MagickSetImageProgressMonitor() sets the wand image progress monitor to the specified method and returns the previous progress monitor if any. The progress monitor method looks like this:</p>
5144
5145<pre class="text">
5146 MagickBooleanType MagickProgressMonitor(const char *text,
5147 const MagickOffsetType offset,const MagickSizeType span,
5148 void *client_data)
5149</pre>
5150
5151<p>If the progress monitor returns MagickFalse, the current operation is interrupted.</p>
5152
5153<p>The format of the MagickSetImageProgressMonitor method is:</p>
5154
5155<pre class="code">
5156 MagickProgressMonitor MagickSetImageProgressMonitor(MagickWand *wand
5157 const MagickProgressMonitor progress_monitor,void *client_data)
5158</pre>
5159
5160<p>A description of each parameter follows:</p>
5161
5162<h5>wand</h5>
5163<p>the magick wand.</p>
5164
5165<h5>progress_monitor</h5>
5166<p>Specifies a pointer to a method to monitor progress of an image operation.</p>
5167
5168<h5>client_data</h5>
5169<p>Specifies a pointer to any client data.</p>
5170
5171 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]5172<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickSetImageRedPrimary">MagickSetImageRedPrimary</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]5173<div class="doc-section">
5174
5175<p>MagickSetImageRedPrimary() sets the image chromaticity red primary point.</p>
5176
5177<p>The format of the MagickSetImageRedPrimary method is:</p>
5178
5179<pre class="code">
5180 MagickBooleanType MagickSetImageRedPrimary(MagickWand *wand,
5181 const double x,const double y)
5182</pre>
5183
5184<p>A description of each parameter follows:</p>
5185
5186<h5>wand</h5>
5187<p>the magick wand.</p>
5188
5189<h5>x</h5>
5190<p>the red primary x-point.</p>
5191
5192<h5>y</h5>
5193<p>the red primary y-point.</p>
5194
5195 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]5196<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickSetImageRenderingIntent">MagickSetImageRenderingIntent</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]5197<div class="doc-section">
5198
5199<p>MagickSetImageRenderingIntent() sets the image rendering intent.</p>
5200
5201<p>The format of the MagickSetImageRenderingIntent method is:</p>
5202
5203<pre class="code">
5204 MagickBooleanType MagickSetImageRenderingIntent(MagickWand *wand,
5205 const RenderingIntent rendering_intent)
5206</pre>
5207
5208<p>A description of each parameter follows:</p>
5209
5210<h5>wand</h5>
5211<p>the magick wand.</p>
5212
5213<h5>rendering_intent</h5>
5214<p>the image rendering intent: UndefinedIntent, SaturationIntent, PerceptualIntent, AbsoluteIntent, or RelativeIntent.</p>
5215
5216 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]5217<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickSetImageResolution">MagickSetImageResolution</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]5218<div class="doc-section">
5219
5220<p>MagickSetImageResolution() sets the image resolution.</p>
5221
5222<p>The format of the MagickSetImageResolution method is:</p>
5223
5224<pre class="code">
5225 MagickBooleanType MagickSetImageResolution(MagickWand *wand,
5226 const double x_resolution,const doubtl y_resolution)
5227</pre>
5228
5229<p>A description of each parameter follows:</p>
5230
5231<h5>wand</h5>
5232<p>the magick wand.</p>
5233
5234<h5>x_resolution</h5>
5235<p>the image x resolution.</p>
5236
5237<h5>y_resolution</h5>
5238<p>the image y resolution.</p>
5239
5240 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]5241<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickSetImageScene">MagickSetImageScene</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]5242<div class="doc-section">
5243
5244<p>MagickSetImageScene() sets the image scene.</p>
5245
5246<p>The format of the MagickSetImageScene method is:</p>
5247
5248<pre class="code">
5249 MagickBooleanType MagickSetImageScene(MagickWand *wand,
5250 const size_t scene)
5251</pre>
5252
5253<p>A description of each parameter follows:</p>
5254
5255<h5>wand</h5>
5256<p>the magick wand.</p>
5257
5258<h5>delay</h5>
5259<p>the image scene number.</p>
5260
5261 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]5262<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickSetImageTicksPerSecond">MagickSetImageTicksPerSecond</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]5263<div class="doc-section">
5264
5265<p>MagickSetImageTicksPerSecond() sets the image ticks-per-second.</p>
5266
5267<p>The format of the MagickSetImageTicksPerSecond method is:</p>
5268
5269<pre class="code">
5270 MagickBooleanType MagickSetImageTicksPerSecond(MagickWand *wand,
5271 const ssize_t ticks_per-second)
5272</pre>
5273
5274<p>A description of each parameter follows:</p>
5275
5276<h5>wand</h5>
5277<p>the magick wand.</p>
5278
5279<h5>ticks_per_second</h5>
5280<p>the units to use for the image delay.</p>
5281
5282 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]5283<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickSetImageType">MagickSetImageType</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]5284<div class="doc-section">
5285
5286<p>MagickSetImageType() sets the image type.</p>
5287
5288<p>The format of the MagickSetImageType method is:</p>
5289
5290<pre class="code">
5291 MagickBooleanType MagickSetImageType(MagickWand *wand,
5292 const ImageType image_type)
5293</pre>
5294
5295<p>A description of each parameter follows:</p>
5296
5297<h5>wand</h5>
5298<p>the magick wand.</p>
5299
5300<h5>image_type</h5>
5301<p>the image type: UndefinedType, BilevelType, GrayscaleType, GrayscaleMatteType, PaletteType, PaletteMatteType, TrueColorType, TrueColorMatteType, ColorSeparationType, ColorSeparationMatteType, or OptimizeType.</p>
5302
5303 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]5304<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickSetImageUnits">MagickSetImageUnits</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]5305<div class="doc-section">
5306
5307<p>MagickSetImageUnits() sets the image units of resolution.</p>
5308
5309<p>The format of the MagickSetImageUnits method is:</p>
5310
5311<pre class="code">
5312 MagickBooleanType MagickSetImageUnits(MagickWand *wand,
5313 const ResolutionType units)
5314</pre>
5315
5316<p>A description of each parameter follows:</p>
5317
5318<h5>wand</h5>
5319<p>the magick wand.</p>
5320
5321<h5>units</h5>
5322<p>the image units of resolution : UndefinedResolution, PixelsPerInchResolution, or PixelsPerCentimeterResolution.</p>
5323
5324 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]5325<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickSetImageVirtualPixelMethod">MagickSetImageVirtualPixelMethod</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]5326<div class="doc-section">
5327
5328<p>MagickSetImageVirtualPixelMethod() sets the image virtual pixel method.</p>
5329
5330<p>The format of the MagickSetImageVirtualPixelMethod method is:</p>
5331
5332<pre class="code">
5333 VirtualPixelMethod MagickSetImageVirtualPixelMethod(MagickWand *wand,
5334 const VirtualPixelMethod method)
5335</pre>
5336
5337<p>A description of each parameter follows:</p>
5338
5339<h5>wand</h5>
5340<p>the magick wand.</p>
5341
5342<h5>method</h5>
5343<p>the image virtual pixel method : UndefinedVirtualPixelMethod, ConstantVirtualPixelMethod, EdgeVirtualPixelMethod, MirrorVirtualPixelMethod, or TileVirtualPixelMethod.</p>
5344
5345 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]5346<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickSetImageWhitePoint">MagickSetImageWhitePoint</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]5347<div class="doc-section">
5348
5349<p>MagickSetImageWhitePoint() sets the image chromaticity white point.</p>
5350
5351<p>The format of the MagickSetImageWhitePoint method is:</p>
5352
5353<pre class="code">
5354 MagickBooleanType MagickSetImageWhitePoint(MagickWand *wand,
5355 const double x,const double y)
5356</pre>
5357
5358<p>A description of each parameter follows:</p>
5359
5360<h5>wand</h5>
5361<p>the magick wand.</p>
5362
5363<h5>x</h5>
5364<p>the white x-point.</p>
5365
5366<h5>y</h5>
5367<p>the white y-point.</p>
5368
5369 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]5370<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickShadeImage">MagickShadeImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]5371<div class="doc-section">
5372
5373<p>MagickShadeImage() shines a distant light on an image to create a three-dimensional effect. You control the positioning of the light with azimuth and elevation; azimuth is measured in degrees off the x axis and elevation is measured in pixels above the Z axis.</p>
5374
5375<p>The format of the MagickShadeImage method is:</p>
5376
5377<pre class="code">
5378 MagickBooleanType MagickShadeImage(MagickWand *wand,
5379 const MagickBooleanType gray,const double azimuth,
5380 const double elevation)
5381</pre>
5382
5383<p>A description of each parameter follows:</p>
5384
5385<h5>wand</h5>
5386<p>the magick wand.</p>
5387
5388<h5>gray</h5>
5389<p>A value other than zero shades the intensity of each pixel.</p>
5390
5391<h5>azimuth, elevation</h5>
5392<p>Define the light source direction.</p>
5393
5394 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]5395<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickShadowImage">MagickShadowImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]5396<div class="doc-section">
5397
5398<p>MagickShadowImage() simulates an image shadow.</p>
5399
5400<p>The format of the MagickShadowImage method is:</p>
5401
5402<pre class="code">
5403 MagickBooleanType MagickShadowImage(MagickWand *wand,
5404 const double opacity,const double sigma,const ssize_t x,const ssize_t y)
5405</pre>
5406
5407<p>A description of each parameter follows:</p>
5408
5409<h5>wand</h5>
5410<p>the magick wand.</p>
5411
5412<h5>opacity</h5>
5413<p>percentage transparency.</p>
5414
5415<h5>sigma</h5>
5416<p>the standard deviation of the Gaussian, in pixels.</p>
5417
5418<h5>x</h5>
5419<p>the shadow x-offset.</p>
5420
5421<h5>y</h5>
5422<p>the shadow y-offset.</p>
5423
5424 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]5425<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickSharpenImage">MagickSharpenImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]5426<div class="doc-section">
5427
5428<p>MagickSharpenImage() sharpens an image. We convolve the image with a Gaussian operator of the given radius and standard deviation (sigma). For reasonable results, the radius should be larger than sigma. Use a radius of 0 and MagickSharpenImage() selects a suitable radius for you.</p>
5429
5430<p>The format of the MagickSharpenImage method is:</p>
5431
5432<pre class="code">
5433 MagickBooleanType MagickSharpenImage(MagickWand *wand,
5434 const double radius,const double sigma)
5435 MagickBooleanType MagickSharpenImageChannel(MagickWand *wand,
5436 const ChannelType channel,const double radius,const double sigma)
5437</pre>
5438
5439<p>A description of each parameter follows:</p>
5440
5441<h5>wand</h5>
5442<p>the magick wand.</p>
5443
5444<h5>channel</h5>
5445<p>the image channel(s).</p>
5446
5447<h5>radius</h5>
5448<p>the radius of the Gaussian, in pixels, not counting the center pixel.</p>
5449
5450<h5>sigma</h5>
5451<p>the standard deviation of the Gaussian, in pixels.</p>
5452
5453 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]5454<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickShaveImage">MagickShaveImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]5455<div class="doc-section">
5456
5457<p>MagickShaveImage() shaves pixels from the image edges. It allocates the memory necessary for the new Image structure and returns a pointer to the new image.</p>
5458
5459<p>The format of the MagickShaveImage method is:</p>
5460
5461<pre class="code">
5462 MagickBooleanType MagickShaveImage(MagickWand *wand,
5463 const size_t columns,const size_t rows)
5464</pre>
5465
5466<p>A description of each parameter follows:</p>
5467
5468<h5>wand</h5>
5469<p>the magick wand.</p>
5470
5471<h5>columns</h5>
5472<p>the number of columns in the scaled image.</p>
5473
5474<h5>rows</h5>
5475<p>the number of rows in the scaled image.</p>
5476
5477
5478 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]5479<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickShearImage">MagickShearImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]5480<div class="doc-section">
5481
5482<p>MagickShearImage() slides one edge of an image along the X or Y axis, creating a parallelogram. An X direction shear slides an edge along the X axis, while a Y direction shear slides an edge along the Y axis. The amount of the shear is controlled by a shear angle. For X direction shears, x_shear is measured relative to the Y axis, and similarly, for Y direction shears y_shear is measured relative to the X axis. Empty triangles left over from shearing the image are filled with the background color.</p>
5483
5484<p>The format of the MagickShearImage method is:</p>
5485
5486<pre class="code">
5487 MagickBooleanType MagickShearImage(MagickWand *wand,
5488 const PixelWand *background,const double x_shear,onst double y_shear)
5489</pre>
5490
5491<p>A description of each parameter follows:</p>
5492
5493<h5>wand</h5>
5494<p>the magick wand.</p>
5495
5496<h5>background</h5>
5497<p>the background pixel wand.</p>
5498
5499<h5>x_shear</h5>
5500<p>the number of degrees to shear the image.</p>
5501
5502<h5>y_shear</h5>
5503<p>the number of degrees to shear the image.</p>
5504
5505 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]5506<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickSigmoidalContrastImage">MagickSigmoidalContrastImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]5507<div class="doc-section">
5508
5509<p>MagickSigmoidalContrastImage() adjusts the contrast of an image with a non-linear sigmoidal contrast algorithm. Increase the contrast of the image using a sigmoidal transfer function without saturating highlights or shadows. Contrast indicates how much to increase the contrast (0 is none; 3 is typical; 20 is pushing it); mid-point indicates where midtones fall in the resultant image (0 is white; 50 is middle-gray; 100 is black). Set sharpen to MagickTrue to increase the image contrast otherwise the contrast is reduced.</p>
5510
5511<p>The format of the MagickSigmoidalContrastImage method is:</p>
5512
5513<pre class="code">
5514 MagickBooleanType MagickSigmoidalContrastImage(MagickWand *wand,
5515 const MagickBooleanType sharpen,const double alpha,const double beta)
5516 MagickBooleanType MagickSigmoidalContrastImageChannel(MagickWand *wand,
5517 const ChannelType channel,const MagickBooleanType sharpen,
5518 const double alpha,const double beta)
5519</pre>
5520
5521<p>A description of each parameter follows:</p>
5522
5523<h5>wand</h5>
5524<p>the magick wand.</p>
5525
5526<h5>channel</h5>
5527<p>Identify which channel to level: RedChannel, GreenChannel,</p>
5528
5529<h5>sharpen</h5>
5530<p>Increase or decrease image contrast.</p>
5531
5532<h5>alpha</h5>
5533<p>strength of the contrast, the larger the number the more 'threshold-like' it becomes.</p>
5534
5535<h5>beta</h5>
5536<p>midpoint of the function as a color value 0 to QuantumRange.</p>
5537
5538 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]5539<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickSimilarityImage">MagickSimilarityImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]5540<div class="doc-section">
5541
5542<p>MagickSimilarityImage() 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>
5543
5544<p>The format of the MagickSimilarityImage method is:</p>
5545
5546<pre class="code">
5547 MagickWand *MagickSimilarityImage(MagickWand *wand,
5548 const MagickWand *reference,RectangeInfo *offset,double *similarity)
5549</pre>
5550
5551<p>A description of each parameter follows:</p>
5552
5553<h5>wand</h5>
5554<p>the magick wand.</p>
5555
5556<h5>reference</h5>
5557<p>the reference wand.</p>
5558
5559<h5>offset</h5>
5560<p>the best match offset of the reference image within the image.</p>
5561
5562<h5>similarity</h5>
5563<p>the computed similarity between the images.</p>
5564
5565 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]5566<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickSketchImage">MagickSketchImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]5567<div class="doc-section">
5568
5569<p>MagickSketchImage() simulates a pencil sketch. We convolve the image with a Gaussian operator of the given radius and standard deviation (sigma). For reasonable results, radius should be larger than sigma. Use a radius of 0 and SketchImage() selects a suitable radius for you. Angle gives the angle of the blurring motion.</p>
5570
5571<p>The format of the MagickSketchImage method is:</p>
5572
5573<pre class="code">
5574 MagickBooleanType MagickSketchImage(MagickWand *wand,
5575 const double radius,const double sigma,const double angle)
5576</pre>
5577
5578<p>A description of each parameter follows:</p>
5579
5580<h5>wand</h5>
5581<p>the magick wand.</p>
5582
5583<h5>radius</h5>
5584<p>the radius of the Gaussian, in pixels, not counting the center pixel.</p>
5585
5586<h5>sigma</h5>
5587<p>the standard deviation of the Gaussian, in pixels.</p>
5588
5589<h5>angle</h5>
5590<p>Apply the effect along this angle.</p>
5591
5592 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]5593<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickSmushImages">MagickSmushImages</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]5594<div class="doc-section">
5595
5596<p>MagickSmushImages() takes all images from the current image pointer to the end of the image list and smushs them to each other top-to-bottom if the stack parameter is true, otherwise left-to-right.</p>
5597
5598<p>The format of the MagickSmushImages method is:</p>
5599
5600<pre class="code">
5601 MagickWand *MagickSmushImages(MagickWand *wand,
5602 const MagickBooleanType stack,const ssize_t offset)
5603</pre>
5604
5605<p>A description of each parameter follows:</p>
5606
5607<h5>wand</h5>
5608<p>the magick wand.</p>
5609
5610<h5>stack</h5>
5611<p>By default, images are stacked left-to-right. Set stack to MagickTrue to stack them top-to-bottom.</p>
5612
5613<h5>offset</h5>
5614<p>minimum distance in pixels between images.</p>
5615
5616 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]5617<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickSolarizeImage">MagickSolarizeImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]5618<div class="doc-section">
5619
5620<p>MagickSolarizeImage() applies a special effect to the image, similar to the effect achieved in a photo darkroom by selectively exposing areas of photo sensitive paper to light. Threshold ranges from 0 to QuantumRange and is a measure of the extent of the solarization.</p>
5621
5622<p>The format of the MagickSolarizeImage method is:</p>
5623
5624<pre class="code">
5625 MagickBooleanType MagickSolarizeImage(MagickWand *wand,
5626 const double threshold)
5627</pre>
5628
5629<p>A description of each parameter follows:</p>
5630
5631<h5>wand</h5>
5632<p>the magick wand.</p>
5633
5634<h5>threshold</h5>
5635<p>Define the extent of the solarization.</p>
5636
5637 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]5638<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickSparseColorImage">MagickSparseColorImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]5639<div class="doc-section">
5640
5641<p>MagickSparseColorImage(), given a set of coordinates, interpolates the colors found at those coordinates, across the whole image, using various methods.</p>
5642
5643<p>The format of the MagickSparseColorImage method is:</p>
5644
5645<pre class="code">
5646 MagickBooleanType MagickSparseColorImage(MagickWand *wand,
5647 const ChannelType channel,const SparseColorMethod method,
5648 const size_t number_arguments,const double *arguments)
5649</pre>
5650
5651<p>A description of each parameter follows:</p>
5652
5653<h5>image</h5>
5654<p>the image to be sparseed.</p>
5655
5656<h5>method</h5>
5657<p>the method of image sparseion.</p>
5658
5659<p>ArcSparseColorion will always ignore source image offset, and always 'bestfit' the destination image with the top left corner offset relative to the polar mapping center.</p>
5660
5661<p>Bilinear has no simple inverse mapping so will not allow 'bestfit' style of image sparseion.</p>
5662
5663<p>Affine, Perspective, and Bilinear, will do least squares fitting of the distrotion when more than the minimum number of control point pairs are provided.</p>
5664
5665<p>Perspective, and Bilinear, will fall back to a Affine sparseion when less than 4 control point pairs are provided. While Affine sparseions will let you use any number of control point pairs, that is Zero pairs is a No-Op (viewport only) distrotion, one pair is a translation and two pairs of control points will do a scale-rotate-translate, without any shearing.</p>
5666
5667<h5>number_arguments</h5>
5668<p>the number of arguments given for this sparseion method.</p>
5669
5670<h5>arguments</h5>
5671<p>the arguments for this sparseion method.</p>
5672
5673 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]5674<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickSpliceImage">MagickSpliceImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]5675<div class="doc-section">
5676
5677<p>MagickSpliceImage() splices a solid color into the image.</p>
5678
5679<p>The format of the MagickSpliceImage method is:</p>
5680
5681<pre class="code">
5682 MagickBooleanType MagickSpliceImage(MagickWand *wand,
5683 const size_t width,const size_t height,const ssize_t x,
5684 const ssize_t y)
5685</pre>
5686
5687<p>A description of each parameter follows:</p>
5688
5689<h5>wand</h5>
5690<p>the magick wand.</p>
5691
5692<h5>width</h5>
5693<p>the region width.</p>
5694
5695<h5>height</h5>
5696<p>the region height.</p>
5697
5698<h5>x</h5>
5699<p>the region x offset.</p>
5700
5701<h5>y</h5>
5702<p>the region y offset.</p>
5703
5704 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]5705<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickSpreadImage">MagickSpreadImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]5706<div class="doc-section">
5707
5708<p>MagickSpreadImage() is a special effects method that randomly displaces each pixel in a block defined by the radius parameter.</p>
5709
5710<p>The format of the MagickSpreadImage method is:</p>
5711
5712<pre class="code">
5713 MagickBooleanType MagickSpreadImage(MagickWand *wand,const double radius)
5714</pre>
5715
5716<p>A description of each parameter follows:</p>
5717
5718<h5>wand</h5>
5719<p>the magick wand.</p>
5720
5721<h5>radius</h5>
5722<p>Choose a random pixel in a neighborhood of this extent.</p>
5723
5724 </div>
cristyb52981c2011-03-19 17:09:31 +0000[diff] [blame]5725<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickStatisticImage">MagickStatisticImage</a></h2>
5726<div class="doc-section">
5727
5728<p>MagickStatisticImage() replace each pixel with corresponding statistic from the neighborhood of the specified width and height.</p>
5729
5730<p>The format of the MagickStatisticImage method is:</p>
5731
5732<pre class="code">
5733 MagickBooleanType MagickStatisticImage(MagickWand *wand,
5734 const StatisticType type,const double width,const size_t height)
5735 MagickBooleanType MagickStatisticImageChannel(MagickWand *wand,
5736 const ChannelType channel,const StatisticType type,const double width,
5737 const size_t height)
5738</pre>
5739
5740<p>A description of each parameter follows:</p>
5741
5742<h5>wand</h5>
5743<p>the magick wand.</p>
5744
5745<h5>channel</h5>
5746<p>the image channel(s).</p>
5747
5748<h5>type</h5>
5749<p>the statistic type (e.g. median, mode, etc.).</p>
5750
5751<h5>width</h5>
5752<p>the width of the pixel neighborhood.</p>
5753
5754<h5>height</h5>
5755<p>the height of the pixel neighborhood.</p>
5756
5757 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]5758<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickSteganoImage">MagickSteganoImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]5759<div class="doc-section">
5760
5761<p>MagickSteganoImage() hides a digital watermark within the image. Recover the hidden watermark later to prove that the authenticity of an image. Offset defines the start position within the image to hide the watermark.</p>
5762
5763<p>The format of the MagickSteganoImage method is:</p>
5764
5765<pre class="code">
5766 MagickWand *MagickSteganoImage(MagickWand *wand,
5767 const MagickWand *watermark_wand,const ssize_t offset)
5768</pre>
5769
5770<p>A description of each parameter follows:</p>
5771
5772<h5>wand</h5>
5773<p>the magick wand.</p>
5774
5775<h5>watermark_wand</h5>
5776<p>the watermark wand.</p>
5777
5778<h5>offset</h5>
5779<p>Start hiding at this offset into the image.</p>
5780
5781 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]5782<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickStereoImage">MagickStereoImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]5783<div class="doc-section">
5784
5785<p>MagickStereoImage() composites two images and produces a single image that is the composite of a left and right image of a stereo pair</p>
5786
5787<p>The format of the MagickStereoImage method is:</p>
5788
5789<pre class="code">
5790 MagickWand *MagickStereoImage(MagickWand *wand,
5791 const MagickWand *offset_wand)
5792</pre>
5793
5794<p>A description of each parameter follows:</p>
5795
5796<h5>wand</h5>
5797<p>the magick wand.</p>
5798
5799<h5>offset_wand</h5>
5800<p>Another image wand.</p>
5801
5802 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]5803<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickStripImage">MagickStripImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]5804<div class="doc-section">
5805
5806<p>MagickStripImage() strips an image of all profiles and comments.</p>
5807
5808<p>The format of the MagickStripImage method is:</p>
5809
5810<pre class="code">
5811 MagickBooleanType MagickStripImage(MagickWand *wand)
5812</pre>
5813
5814<p>A description of each parameter follows:</p>
5815
5816<h5>wand</h5>
5817<p>the magick wand.</p>
5818
5819 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]5820<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickSwirlImage">MagickSwirlImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]5821<div class="doc-section">
5822
5823<p>MagickSwirlImage() swirls the pixels about the center of the image, where degrees indicates the sweep of the arc through which each pixel is moved. You get a more dramatic effect as the degrees move from 1 to 360.</p>
5824
5825<p>The format of the MagickSwirlImage method is:</p>
5826
5827<pre class="code">
5828 MagickBooleanType MagickSwirlImage(MagickWand *wand,const double degrees)
5829</pre>
5830
5831<p>A description of each parameter follows:</p>
5832
5833<h5>wand</h5>
5834<p>the magick wand.</p>
5835
5836<h5>degrees</h5>
5837<p>Define the tightness of the swirling effect.</p>
5838
5839 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]5840<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickTextureImage">MagickTextureImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]5841<div class="doc-section">
5842
5843<p>MagickTextureImage() repeatedly tiles the texture image across and down the image canvas.</p>
5844
5845<p>The format of the MagickTextureImage method is:</p>
5846
5847<pre class="code">
5848 MagickWand *MagickTextureImage(MagickWand *wand,
5849 const MagickWand *texture_wand)
5850</pre>
5851
5852<p>A description of each parameter follows:</p>
5853
5854<h5>wand</h5>
5855<p>the magick wand.</p>
5856
5857<h5>texture_wand</h5>
5858<p>the texture wand</p>
5859
5860 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]5861<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickThresholdImage">MagickThresholdImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]5862<div class="doc-section">
5863
5864<p>MagickThresholdImage() changes the value of individual pixels based on the intensity of each pixel compared to threshold. The result is a high-contrast, two color image.</p>
5865
5866<p>The format of the MagickThresholdImage method is:</p>
5867
5868<pre class="code">
5869 MagickBooleanType MagickThresholdImage(MagickWand *wand,
5870 const double threshold)
5871 MagickBooleanType MagickThresholdImageChannel(MagickWand *wand,
5872 const ChannelType channel,const double threshold)
5873</pre>
5874
5875<p>A description of each parameter follows:</p>
5876
5877<h5>wand</h5>
5878<p>the magick wand.</p>
5879
5880<h5>channel</h5>
5881<p>the image channel(s).</p>
5882
5883<h5>threshold</h5>
5884<p>Define the threshold value.</p>
5885
5886 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]5887<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickThumbnailImage">MagickThumbnailImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]5888<div class="doc-section">
5889
5890<p>MagickThumbnailImage() changes the size of an image to the given dimensions and removes any associated profiles. The goal is to produce small low cost thumbnail images suited for display on the Web.</p>
5891
5892<p>The format of the MagickThumbnailImage method is:</p>
5893
5894<pre class="code">
5895 MagickBooleanType MagickThumbnailImage(MagickWand *wand,
5896 const size_t columns,const size_t rows)
5897</pre>
5898
5899<p>A description of each parameter follows:</p>
5900
5901<h5>wand</h5>
5902<p>the magick wand.</p>
5903
5904<h5>columns</h5>
5905<p>the number of columns in the scaled image.</p>
5906
5907<h5>rows</h5>
5908<p>the number of rows in the scaled image.</p>
5909
5910 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]5911<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickTintImage">MagickTintImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]5912<div class="doc-section">
5913
5914<p>MagickTintImage() applies a color vector to each pixel in the image. The length of the vector is 0 for black and white and at its maximum for the midtones. The vector weighting function is f(x)=(1-(4.0*((x-0.5)*(x-0.5)))).</p>
5915
5916<p>The format of the MagickTintImage method is:</p>
5917
5918<pre class="code">
5919 MagickBooleanType MagickTintImage(MagickWand *wand,
5920 const PixelWand *tint,const PixelWand *opacity)
5921</pre>
5922
5923<p>A description of each parameter follows:</p>
5924
5925<h5>wand</h5>
5926<p>the magick wand.</p>
5927
5928<h5>tint</h5>
5929<p>the tint pixel wand.</p>
5930
5931<h5>opacity</h5>
5932<p>the opacity pixel wand.</p>
5933
5934 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]5935<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickTransformImage">MagickTransformImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]5936<div class="doc-section">
5937
5938<p>MagickTransformImage() is a convenience method that behaves like MagickResizeImage() or MagickCropImage() but accepts scaling and/or cropping information as a region geometry specification. If the operation fails, a NULL image handle is returned.</p>
5939
5940<p>The format of the MagickTransformImage method is:</p>
5941
5942<pre class="code">
5943 MagickWand *MagickTransformImage(MagickWand *wand,const char *crop,
5944 const char *geometry)
5945</pre>
5946
5947<p>A description of each parameter follows:</p>
5948
5949<h5>wand</h5>
5950<p>the magick wand.</p>
5951
5952<h5>crop</h5>
5953<p>A crop geometry string. This geometry defines a subregion of the image to crop.</p>
5954
5955<h5>geometry</h5>
5956<p>An image geometry string. This geometry defines the final size of the image.</p>
5957
5958 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]5959<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickTransformImageColorspace">MagickTransformImageColorspace</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]5960<div class="doc-section">
5961
5962<p>MagickTransformImageColorspace() transform the image colorspace.</p>
5963
5964<p>The format of the MagickTransformImageColorspace method is:</p>
5965
5966<pre class="code">
5967 MagickBooleanType MagickTransformImageColorspace(MagickWand *wand,
5968 const ColorspaceType colorspace)
5969</pre>
5970
5971<p>A description of each parameter follows:</p>
5972
5973<h5>wand</h5>
5974<p>the magick wand.</p>
5975
5976<h5>colorspace</h5>
5977<p>the image colorspace: UndefinedColorspace, RGBColorspace, GRAYColorspace, TransparentColorspace, OHTAColorspace, XYZColorspace, YCbCrColorspace, YCCColorspace, YIQColorspace, YPbPrColorspace, YPbPrColorspace, YUVColorspace, CMYKColorspace, sRGBColorspace, HSLColorspace, or HWBColorspace.</p>
5978
5979 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]5980<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickTransparentPaintImage">MagickTransparentPaintImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]5981<div class="doc-section">
5982
5983<p>MagickTransparentPaintImage() changes any pixel that matches color with the color defined by fill.</p>
5984
5985<p>The format of the MagickTransparentPaintImage method is:</p>
5986
5987<pre class="code">
5988 MagickBooleanType MagickTransparentPaintImage(MagickWand *wand,
5989 const PixelWand *target,const double alpha,const double fuzz,
5990 const MagickBooleanType invert)
5991</pre>
5992
5993<p>A description of each parameter follows:</p>
5994
5995<h5>wand</h5>
5996<p>the magick wand.</p>
5997
5998<h5>target</h5>
5999<p>Change this target color to specified opacity value within the image.</p>
6000
6001<h5>alpha</h5>
6002<p>the level of transparency: 1.0 is fully opaque and 0.0 is fully transparent.</p>
6003
6004<h5>fuzz</h5>
6005<p>By default target must match a particular pixel color exactly. However, in many cases two colors may differ by a small amount. The fuzz member of image defines how much tolerance is acceptable to consider two colors as the same. For example, set fuzz to 10 and the color red at intensities of 100 and 102 respectively are now interpreted as the same color for the purposes of the floodfill.</p>
6006
6007<h5>invert</h5>
6008<p>paint any pixel that does not match the target color.</p>
6009
6010 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]6011<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickTransposeImage">MagickTransposeImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]6012<div class="doc-section">
6013
6014<p>MagickTransposeImage() creates a vertical mirror image by reflecting the pixels around the central x-axis while rotating them 90-degrees.</p>
6015
6016<p>The format of the MagickTransposeImage method is:</p>
6017
6018<pre class="code">
6019 MagickBooleanType MagickTransposeImage(MagickWand *wand)
6020</pre>
6021
6022<p>A description of each parameter follows:</p>
6023
6024<h5>wand</h5>
6025<p>the magick wand.</p>
6026
6027 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]6028<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickTransverseImage">MagickTransverseImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]6029<div class="doc-section">
6030
6031<p>MagickTransverseImage() creates a horizontal mirror image by reflecting the pixels around the central y-axis while rotating them 270-degrees.</p>
6032
6033<p>The format of the MagickTransverseImage method is:</p>
6034
6035<pre class="code">
6036 MagickBooleanType MagickTransverseImage(MagickWand *wand)
6037</pre>
6038
6039<p>A description of each parameter follows:</p>
6040
6041<h5>wand</h5>
6042<p>the magick wand.</p>
6043
6044 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]6045<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickTrimImage">MagickTrimImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]6046<div class="doc-section">
6047
6048<p>MagickTrimImage() remove edges that are the background color from the image.</p>
6049
6050<p>The format of the MagickTrimImage method is:</p>
6051
6052<pre class="code">
6053 MagickBooleanType MagickTrimImage(MagickWand *wand,const double fuzz)
6054</pre>
6055
6056<p>A description of each parameter follows:</p>
6057
6058<h5>wand</h5>
6059<p>the magick wand.</p>
6060
6061<h5>fuzz</h5>
6062<p>By default target must match a particular pixel color exactly. However, in many cases two colors may differ by a small amount. The fuzz member of image defines how much tolerance is acceptable to consider two colors as the same. For example, set fuzz to 10 and the color red at intensities of 100 and 102 respectively are now interpreted as the same color for the purposes of the floodfill.</p>
6063
6064 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]6065<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickUniqueImageColors">MagickUniqueImageColors</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]6066<div class="doc-section">
6067
6068<p>MagickUniqueImageColors() discards all but one of any pixel color.</p>
6069
6070<p>The format of the MagickUniqueImageColors method is:</p>
6071
6072<pre class="code">
6073 MagickBooleanType MagickUniqueImageColors(MagickWand *wand)
6074</pre>
6075
6076<p>A description of each parameter follows:</p>
6077
6078<h5>wand</h5>
6079<p>the magick wand.</p>
6080
6081 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]6082<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickUnsharpMaskImage">MagickUnsharpMaskImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]6083<div class="doc-section">
6084
6085<p>MagickUnsharpMaskImage() sharpens an image. We convolve the image with a Gaussian operator of the given radius and standard deviation (sigma). For reasonable results, radius should be larger than sigma. Use a radius of 0 and UnsharpMaskImage() selects a suitable radius for you.</p>
6086
6087<p>The format of the MagickUnsharpMaskImage method is:</p>
6088
6089<pre class="code">
6090 MagickBooleanType MagickUnsharpMaskImage(MagickWand *wand,
6091 const double radius,const double sigma,const double amount,
6092 const double threshold)
6093 MagickBooleanType MagickUnsharpMaskImageChannel(MagickWand *wand,
6094 const ChannelType channel,const double radius,const double sigma,
6095 const double amount,const double threshold)
6096</pre>
6097
6098<p>A description of each parameter follows:</p>
6099
6100<h5>wand</h5>
6101<p>the magick wand.</p>
6102
6103<h5>channel</h5>
6104<p>the image channel(s).</p>
6105
6106<h5>radius</h5>
6107<p>the radius of the Gaussian, in pixels, not counting the center pixel.</p>
6108
6109<h5>sigma</h5>
6110<p>the standard deviation of the Gaussian, in pixels.</p>
6111
6112<h5>amount</h5>
6113<p>the percentage of the difference between the original and the blur image that is added back into the original.</p>
6114
6115<h5>threshold</h5>
6116<p>the threshold in pixels needed to apply the diffence amount.</p>
6117
6118 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]6119<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickVignetteImage">MagickVignetteImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]6120<div class="doc-section">
6121
6122<p>MagickVignetteImage() softens the edges of the image in vignette style.</p>
6123
6124<p>The format of the MagickVignetteImage method is:</p>
6125
6126<pre class="code">
6127 MagickBooleanType MagickVignetteImage(MagickWand *wand,
6128 const double black_point,const double white_point,const ssize_t x,
6129 const ssize_t y)
6130</pre>
6131
6132<p>A description of each parameter follows:</p>
6133
6134<h5>wand</h5>
6135<p>the magick wand.</p>
6136
6137<h5>black_point</h5>
6138<p>the black point.</p>
6139
6140<h5>white_point</h5>
6141<p>the white point.</p>
6142
6143<h5>x, y</h5>
6144<p>Define the x and y ellipse offset.</p>
6145
6146 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]6147<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickWaveImage">MagickWaveImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]6148<div class="doc-section">
6149
6150<p>MagickWaveImage() creates a "ripple" effect in the image by shifting the pixels vertically along a sine wave whose amplitude and wavelength is specified by the given parameters.</p>
6151
6152<p>The format of the MagickWaveImage method is:</p>
6153
6154<pre class="code">
6155 MagickBooleanType MagickWaveImage(MagickWand *wand,const double amplitude,
6156 const double wave_length)
6157</pre>
6158
6159<p>A description of each parameter follows:</p>
6160
6161<h5>wand</h5>
6162<p>the magick wand.</p>
6163
6164<h5>amplitude, wave_length</h5>
6165<p>Define the amplitude and wave length of the sine wave.</p>
6166
6167 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]6168<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickWhiteThresholdImage">MagickWhiteThresholdImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]6169<div class="doc-section">
6170
6171<p>MagickWhiteThresholdImage() is like ThresholdImage() but force all pixels above the threshold into white while leaving all pixels below the threshold unchanged.</p>
6172
6173<p>The format of the MagickWhiteThresholdImage method is:</p>
6174
6175<pre class="code">
6176 MagickBooleanType MagickWhiteThresholdImage(MagickWand *wand,
6177 const PixelWand *threshold)
6178</pre>
6179
6180<p>A description of each parameter follows:</p>
6181
6182<h5>wand</h5>
6183<p>the magick wand.</p>
6184
6185<h5>threshold</h5>
6186<p>the pixel wand.</p>
6187
6188 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]6189<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickWriteImage">MagickWriteImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]6190<div class="doc-section">
6191
6192<p>MagickWriteImage() writes an image to the specified filename. If the filename parameter is NULL, the image is written to the filename set by MagickReadImage() or MagickSetImageFilename().</p>
6193
6194<p>The format of the MagickWriteImage method is:</p>
6195
6196<pre class="code">
6197 MagickBooleanType MagickWriteImage(MagickWand *wand,
6198 const char *filename)
6199</pre>
6200
6201<p>A description of each parameter follows:</p>
6202
6203<h5>wand</h5>
6204<p>the magick wand.</p>
6205
6206<h5>filename</h5>
6207<p>the image filename.</p>
6208
6209
6210 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]6211<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickWriteImageFile">MagickWriteImageFile</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]6212<div class="doc-section">
6213
6214<p>MagickWriteImageFile() writes an image to an open file descriptor.</p>
6215
6216<p>The format of the MagickWriteImageFile method is:</p>
6217
6218<pre class="code">
6219 MagickBooleanType MagickWriteImageFile(MagickWand *wand,FILE *file)
6220</pre>
6221
6222<p>A description of each parameter follows:</p>
6223
6224<h5>wand</h5>
6225<p>the magick wand.</p>
6226
6227<h5>file</h5>
6228<p>the file descriptor.</p>
6229
6230 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]6231<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickWriteImages">MagickWriteImages</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]6232<div class="doc-section">
6233
6234<p>MagickWriteImages() writes an image or image sequence.</p>
6235
6236<p>The format of the MagickWriteImages method is:</p>
6237
6238<pre class="code">
6239 MagickBooleanType MagickWriteImages(MagickWand *wand,
6240 const char *filename,const MagickBooleanType adjoin)
6241</pre>
6242
6243<p>A description of each parameter follows:</p>
6244
6245<h5>wand</h5>
6246<p>the magick wand.</p>
6247
6248<h5>filename</h5>
6249<p>the image filename.</p>
6250
6251<h5>adjoin</h5>
6252<p>join images into a single multi-image file.</p>
6253
6254 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]6255<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image_8c.html" id="MagickWriteImagesFile">MagickWriteImagesFile</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]6256<div class="doc-section">
6257
6258<p>MagickWriteImagesFile() writes an image sequence to an open file descriptor.</p>
6259
6260<p>The format of the MagickWriteImagesFile method is:</p>
6261
6262<pre class="code">
6263 MagickBooleanType MagickWriteImagesFile(MagickWand *wand,FILE *file)
6264</pre>
6265
6266<p>A description of each parameter follows:</p>
6267
6268<h5>wand</h5>
6269<p>the magick wand.</p>
6270
6271<h5>file</h5>
6272<p>the file descriptor.</p>
6273
6274 </div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]6275
6276</div>
6277
6278<div id="linkbar">
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]6279 <span id="linkbar-west">&nbsp;</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]6280 <span id="linkbar-center">
6281 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
cristya8902942010-07-30 00:49:52 +0000[diff] [blame]6282 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]6283 </span>
6284 <span id="linkbar-east">&nbsp;</span>
6285 </div>
6286 <div class="footer">
cristy4103d562010-12-10 01:38:54 +0000[diff] [blame]6287 <span id="footer-west">&copy; 1999-2011 ImageMagick Studio LLC</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]6288 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
6289 </div>
6290 <div style="clear: both; margin: 0; width: 100%; "></div>
cristya8902942010-07-30 00:49:52 +0000[diff] [blame]6291 <script type="text/javascript">
6292 var _gaq = _gaq || [];
6293 _gaq.push(['_setAccount', 'UA-17690367-1']);
6294 _gaq.push(['_trackPageview']);
6295
6296 (function() {
6297 var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
6298 ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
6299 var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
6300 })();
6301 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]6302</body>
6303</html>