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