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