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