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