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