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