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