Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ImageMagick / 70b59b620e2f9d41ca4610abcd6482f6e775a41b / . / www / api / magick-image.html
blob: 33e8539b2b30108cf5c7e60cd6ead90e8d4e2c20 [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">
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" dir="ltr">
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]4<head>
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]5 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
6 <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U="/>
cristyffb69ed2010-12-25 00:06:48 +0000[diff] [blame]7 <title>ImageMagick: MagickWand, C API for ImageMagick: Image Methods</title>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]8 <meta http-equiv="Content-Language" content="en-US"/>
9 <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
10 <meta http-equiv="Reply-to" content="magick-users@imagemagick.org"/>
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]11 <meta name="Application-name" content="ImageMagick"/>
cristyaf8d6652011-02-04 21:57:45 +0000[diff] [blame]12 <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]13 <meta name="Application-url" content="http://www.imagemagick.org"/>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]14 <meta name="Generator" content="PHP"/>
15 <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]16 <meta name="Rating" content="GENERAL"/>
17 <meta name="Robots" content="INDEX, FOLLOW"/>
18 <meta name="Generator" content="ImageMagick Studio LLC"/>
19 <meta name="Author" content="ImageMagick Studio LLC"/>
20 <meta name="Revisit-after" content="2 DAYS"/>
21 <meta name="Resource-type" content="document"/>
cristy4103d562010-12-10 01:38:54 +0000[diff] [blame]22 <meta name="Copyright" content="Copyright (c) 1999-2011 ImageMagick Studio LLC"/>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]23 <meta name="Distribution" content="Global"/>
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]24 <link rel="icon" href="../../images/wand.png"/>
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]25 <link rel="shortcut icon" href="../../images/wand.ico" type="images/x-icon"/>
26 <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf"/>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]27 <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]28 <style type="text/css" media="all">
29 @import url("../../www/magick.css");
30 </style>
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]31 <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]32 <script type="text/javascript" src="../fancybox/jquery.fancybox-1.3.4.pack.js"></script>
33 <link rel="stylesheet" type="text/css" href="../fancybox/jquery.fancybox-1.3.4.css" media="screen" />
34 <script type="text/javascript">
35 $(document).ready(function() {
36 $("a[href$=.jpg],a[href$=.png],a[href$=.gif]").fancybox({
37 'transitionIn' : 'elastic',
38 'transitionOut' : 'elastic',
39 'overlayShow' : false,
40 'opacity' : true
41 });
42 });
43 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]44</head>
45
46<body id="www-imagemagick-org">
47<div class="titlebar">
48<a href="../../index.html">
49 <img src="../../images/script.png" alt="[ImageMagick]"
50 style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>
51<a href="http://www.networkredux.com">
52 <img src="../../images/networkredux.png" alt="[sponsor]"
cristy52923442011-01-15 22:54:31 +0000[diff] [blame]53 style="margin-top: 42px; border: 0px; float: left;" /></a>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]54<a href="http://www.imagemagick.org/discourse-server/">
cristyaf8d6652011-02-04 21:57:45 +0000[diff] [blame]55 <img src="../../images/logo.jpg"
56 alt="ImageMagick Logo"
cristy178edaf2011-01-23 03:42:39 +0000[diff] [blame]57 style="width: 123px; height: 118px; border: 0px; float: right;" /></a>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]58<a href="../../index.html">
cristyaf8d6652011-02-04 21:57:45 +0000[diff] [blame]59 <img src="../../images/sprite.jpg"
60 alt="ImageMagick Sprite"
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]61 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
62</div>
63
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]64<div class="westbar">
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]65
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]66<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]67 <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]68</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]69<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]70<div class="menu">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]71 <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
72</div>
73<div class="sub">
74 <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
75</div>
76<div class="sub">
77 <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
78</div>
79<div class="sub">
80 <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
81</div>
82<div class="sep"></div>
83<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]84 <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]85</div>
86<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]87 <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]88</div>
89<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]90 <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]91</div>
92<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]93 <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]94</div>
95<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]96 <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]97</div>
98<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]99 <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]100</div>
101<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]102 <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]103</div>
104<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]105 <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]106</div>
107<div class="sub">
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]108 <a title="Program Interface: Magick++" href="../../www/magick++.html">Magick++</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]109</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]110<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]111<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]112 <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]113</div>
114<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]115 <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]116</div>
117<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]118 <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]119 </div>
120<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]121 <a title="Resources" href="../../www/resources.html">Resources</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]122</div>
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]123<div class="menu">
124 <a title="Architecture" href="../../www/architecture.html">Architecture</a>
125</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]126<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]127 <a title="Download" href="../../www/download.html">Download</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]128</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]129<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]130<div class="menu">
cristy52923442011-01-15 22:54:31 +0000[diff] [blame]131 <a title="Search" href="../../www/search.html">Search</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]132</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]133<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]134<div class="menu">
cristyffb69ed2010-12-25 00:06:48 +0000[diff] [blame]135 <a title="Site Map" href="../../www/sitemap.html">Site Map</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]136</div>
137<div class="sub">
cristyffb69ed2010-12-25 00:06:48 +0000[diff] [blame]138 <a title="Site Map: Links" href="../../www/links.html">Links</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">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]142 <a title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]143
144<div class="sponsbox">
cristy178edaf2011-01-23 03:42:39 +0000[diff] [blame]145<div class="sponsor">
cristyaf8d6652011-02-04 21:57:45 +0000[diff] [blame]146 <a title="Sponsor: Best Web Hosting" href="http://webhostinggeeks.com">Best Web Hosting</a><!-- 201110010720 -->
147</div>
148<div class="sponsor">
149 <a title="Sponsor: Web Hosting Ratings" href="http://webhostingrating.com">Web Hosting Ratings</a><!-- 201110010720 -->
150</div>
151<div class="sponsor">
cristy178edaf2011-01-23 03:42:39 +0000[diff] [blame]152 <a title="Sponsor: Druckerei" href="http://www.allesdruck.de">Druckerei</a><!-- 201106010240 -->
153</div>
cristyec6b4752011-01-08 03:16:23 +0000[diff] [blame]154<div class="sponsor">
cristy52923442011-01-15 22:54:31 +0000[diff] [blame]155 <a title="Sponsor: Web Hosting" href="http://www.bodhost.com/hosting.shtml">Web Hosting</a><!-- 201104010090 -->
cristy73fd1cd2010-09-12 19:14:25 +0000[diff] [blame]156</div>
157<div class="sponsor">
cristyc5baf4f2010-08-31 15:05:33 +0000[diff] [blame]158 <a title="Sponsor: Image Converter" href="http://www.batchphoto.com">Image Converter</a><!-- 201103010900 Bits Coffee-->
159</div>
160<div class="sponsor">
cristy851dbce2010-08-06 21:40:00 +0000[diff] [blame]161 <a title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
162</div>
cristyec6b4752011-01-08 03:16:23 +0000[diff] [blame]163<div class="sponsor">
cristy178edaf2011-01-23 03:42:39 +0000[diff] [blame]164 <a title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 -->
165</div>
166<div class="sponsor">
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]167 <a title="Sponsor: Custom T-Shirts" href="http://www.ooshirts.com">Custom T-Shirts</a><!-- 2011050100030 ooshirts.com-->
cristyec6b4752011-01-08 03:16:23 +0000[diff] [blame]168</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]169</div>
170</div>
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]171</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]172
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]173<div class="eastbar">
174 <script type="text/javascript">
175 <!--
176 google_ad_client = "pub-3129977114552745";
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]177 google_ad_slot = "0574824969";
178 google_ad_width = 160;
179 google_ad_height = 600;
180 //-->
181 </script>
182 <script type="text/javascript"
183 src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
184 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]185</div>
186
187<div class="main">
188
cristy307ba182010-12-25 01:00:34 +0000[diff] [blame]189<h1>Module magick-image
190 Methods</h1>
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]191<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="#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]192
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]193<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]194_8c.html" id="GetImageFromMagickWand">GetImageFromMagickWand</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]195<div class="doc-section">
196
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]197<p>GetImageFromMagickWand() returns the current image from the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]198
199<p>The format of the GetImageFromMagickWand method is:</p>
200
201<pre class="code">
202 Image *GetImageFromMagickWand(const MagickWand *wand)
203</pre>
204
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]205<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]206
207<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]208<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]209
210 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]211<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]212_8c.html" id="MagickAdaptiveBlurImage">MagickAdaptiveBlurImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]213<div class="doc-section">
214
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]215<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]216
217<p>The format of the MagickAdaptiveBlurImage method is:</p>
218
219<pre class="code">
220 MagickBooleanType MagickAdaptiveBlurImage(MagickWand *wand,
221 const double radius,const double sigma)
222 MagickBooleanType MagickAdaptiveBlurImageChannel(MagickWand *wand,
223 const ChannelType channel,const double radius,const double sigma)
224</pre>
225
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]226<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]227
228<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]229<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]230
231<h5>channel</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]232<p>the image channel(s).</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]233
234<h5>radius</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]235<p>the radius of the Gaussian, in pixels, not counting the center pixel.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]236
237<h5>sigma</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]238<p>the standard deviation of the Gaussian, in pixels.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]239
240 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]241<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]242_8c.html" id="MagickAdaptiveResizeImage">MagickAdaptiveResizeImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]243<div class="doc-section">
244
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]245<p>MagickAdaptiveResizeImage() adaptively resize image with data dependent triangulation.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]246
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]247<p>MagickBooleanType MagickAdaptiveResizeImage(MagickWand *wand, const size_t columns,const size_t rows)</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]248
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]249<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]250
251<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]252<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]253
254<h5>columns</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]255<p>the number of columns in the scaled image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]256
257<h5>rows</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]258<p>the number of rows in the scaled image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]259
260 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]261<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]262_8c.html" id="MagickAdaptiveSharpenImage">MagickAdaptiveSharpenImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]263<div class="doc-section">
264
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]265<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]266
267<p>The format of the MagickAdaptiveSharpenImage method is:</p>
268
269<pre class="code">
270 MagickBooleanType MagickAdaptiveSharpenImage(MagickWand *wand,
271 const double radius,const double sigma)
272 MagickBooleanType MagickAdaptiveSharpenImageChannel(MagickWand *wand,
273 const ChannelType channel,const double radius,const double sigma)
274</pre>
275
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]276<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]277
278<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]279<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]280
281<h5>channel</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]282<p>the image channel(s).</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]283
284<h5>radius</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]285<p>the radius of the Gaussian, in pixels, not counting the center pixel.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]286
287<h5>sigma</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]288<p>the standard deviation of the Gaussian, in pixels.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]289
290 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]291<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]292_8c.html" id="MagickAdaptiveThresholdImage">MagickAdaptiveThresholdImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]293<div class="doc-section">
294
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]295<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]296
297<p>The format of the AdaptiveThresholdImage method is:</p>
298
299<pre class="code">
300 MagickBooleanType MagickAdaptiveThresholdImage(MagickWand *wand,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]301 const size_t width,const size_t height,const ssize_t offset)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]302</pre>
303
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]304<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]305
306<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]307<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]308
309<h5>width</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]310<p>the width of the local neighborhood.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]311
312<h5>height</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]313<p>the height of the local neighborhood.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]314
315<h5>offset</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]316<p>the mean offset.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]317
318 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]319<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]320_8c.html" id="MagickAddImage">MagickAddImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]321<div class="doc-section">
322
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]323<p>MagickAddImage() adds the specified images at the current image location.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]324
325<p>The format of the MagickAddImage method is:</p>
326
327<pre class="code">
328 MagickBooleanType MagickAddImage(MagickWand *wand,
329 const MagickWand *add_wand)
330</pre>
331
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]332<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]333
334<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]335<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]336
337<h5>add_wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]338<p>A wand that contains images to add at the current image location.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]339
340 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]341<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]342_8c.html" id="MagickAddNoiseImage">MagickAddNoiseImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]343<div class="doc-section">
344
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]345<p>MagickAddNoiseImage() adds random noise to the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]346
347<p>The format of the MagickAddNoiseImage method is:</p>
348
349<pre class="code">
350 MagickBooleanType MagickAddNoiseImage(MagickWand *wand,
351 const NoiseType noise_type)
352 MagickBooleanType MagickAddNoiseImageChannel(MagickWand *wand,
353 const ChannelType channel,const NoiseType noise_type)
354</pre>
355
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]356<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]357
358<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]359<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]360
361<h5>channel</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]362<p>the image channel(s).</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]363
364<h5>noise_type</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]365<p>The type of noise: Uniform, Gaussian, Multiplicative, Impulse, Laplacian, or Poisson.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]366
367 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]368<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]369_8c.html" id="MagickAffineTransformImage">MagickAffineTransformImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]370<div class="doc-section">
371
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]372<p>MagickAffineTransformImage() transforms an image as dictated by the affine matrix of the drawing wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]373
374<p>The format of the MagickAffineTransformImage method is:</p>
375
376<pre class="code">
377 MagickBooleanType MagickAffineTransformImage(MagickWand *wand,
378 const DrawingWand *drawing_wand)
379</pre>
380
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]381<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]382
383<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]384<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]385
386<h5>drawing_wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]387<p>the draw wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]388
389 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]390<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]391_8c.html" id="MagickAnnotateImage">MagickAnnotateImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]392<div class="doc-section">
393
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]394<p>MagickAnnotateImage() annotates an image with text.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]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
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]404<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]405
406<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]407<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]408
409<h5>drawing_wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]410<p>the draw wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]411
412<h5>x</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]413<p>x ordinate to left of text</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]414
415<h5>y</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]416<p>y ordinate to text baseline</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]417
418<h5>angle</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]419<p>rotate text relative to this angle.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]420
421<h5>text</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]422<p>text to draw</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]423
424 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]425<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]426_8c.html" id="MagickAnimateImages">MagickAnimateImages</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]427<div class="doc-section">
428
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]429<p>MagickAnimateImages() animates an image or image sequence.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]430
431<p>The format of the MagickAnimateImages method is:</p>
432
433<pre class="code">
434 MagickBooleanType MagickAnimateImages(MagickWand *wand,
435 const char *server_name)
436</pre>
437
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]438<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]439
440<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]441<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]442
443<h5>server_name</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]444<p>the X server name.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]445
446 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]447<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]448_8c.html" id="MagickAppendImages">MagickAppendImages</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]449<div class="doc-section">
450
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]451<p>MagickAppendImages() append a set of images.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]452
453<p>The format of the MagickAppendImages method is:</p>
454
455<pre class="code">
456 MagickWand *MagickAppendImages(MagickWand *wand,
457 const MagickBooleanType stack)
458</pre>
459
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]460<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]461
462<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]463<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]464
465<h5>stack</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]466<p>By default, images are stacked left-to-right. Set stack to MagickTrue to stack them top-to-bottom.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]467
468 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]469<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]470_8c.html" id="MagickAutoGammaImage">MagickAutoGammaImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]471<div class="doc-section">
472
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]473<p>MagickAutoGammaImage() extracts the 'mean' from the image and adjust the image to try make set its gamma appropriatally.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]474
475<p>The format of the MagickAutoGammaImage method is:</p>
476
477<pre class="code">
478 MagickBooleanType MagickAutoGammaImage(MagickWand *wand)
479 MagickBooleanType MagickAutoGammaImageChannel(MagickWand *wand,
480 const ChannelType channel)
481</pre>
482
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]483<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]484
485<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]486<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]487
488<h5>channel</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]489<p>the image channel(s).</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]490
491 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]492<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]493_8c.html" id="MagickAutoLevelImage">MagickAutoLevelImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]494<div class="doc-section">
495
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]496<p>MagickAutoLevelImage() adjusts the levels of a particular image channel by scaling the minimum and maximum values to the full quantum range.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]497
498<p>The format of the MagickAutoLevelImage method is:</p>
499
500<pre class="code">
501 MagickBooleanType MagickAutoLevelImage(MagickWand *wand)
502 MagickBooleanType MagickAutoLevelImageChannel(MagickWand *wand,
503 const ChannelType channel)
504</pre>
505
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]506<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]507
508<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]509<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]510
511<h5>channel</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]512<p>the image channel(s).</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]513
514 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]515<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]516_8c.html" id="MagickBlackThresholdImage">MagickBlackThresholdImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]517<div class="doc-section">
518
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]519<p>MagickBlackThresholdImage() is like MagickThresholdImage() but forces all pixels below the threshold into black while leaving all pixels above the threshold unchanged.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]520
521<p>The format of the MagickBlackThresholdImage method is:</p>
522
523<pre class="code">
524 MagickBooleanType MagickBlackThresholdImage(MagickWand *wand,
525 const PixelWand *threshold)
526</pre>
527
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]528<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]529
530<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]531<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]532
533<h5>threshold</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]534<p>the pixel wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]535
536 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]537<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]538_8c.html" id="MagickBlueShiftImage">MagickBlueShiftImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]539<div class="doc-section">
540
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]541<p>MagickBlueShiftImage() mutes the colors of the image to simulate a scene at nighttime in the moonlight.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]542
543<p>The format of the MagickBlueShiftImage method is:</p>
544
545<pre class="code">
546 MagickBooleanType MagickBlueShiftImage(MagickWand *wand,
547 const double factor)
548</pre>
549
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]550<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]551
552<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]553<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]554
555<h5>factor</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]556<p>the blue shift factor (default 1.5)</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]557
558 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]559<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]560_8c.html" id="MagickBlurImage">MagickBlurImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]561<div class="doc-section">
562
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]563<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]564
565<p>The format of the MagickBlurImage method is:</p>
566
567<pre class="code">
568 MagickBooleanType MagickBlurImage(MagickWand *wand,const double radius,
569 const double sigma)
570 MagickBooleanType MagickBlurImageChannel(MagickWand *wand,
571 const ChannelType channel,const double radius,const double sigma)
572</pre>
573
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]574<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]575
576<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]577<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]578
579<h5>channel</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]580<p>the image channel(s).</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]581
582<h5>radius</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]583<p>the radius of the , in pixels, not counting the center pixel.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]584
585<h5>sigma</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]586<p>the standard deviation of the , in pixels.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]587
588 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]589<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]590_8c.html" id="MagickBorderImage">MagickBorderImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]591<div class="doc-section">
592
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]593<p>MagickBorderImage() surrounds the image with a border of the color defined by the bordercolor pixel wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]594
595<p>The format of the MagickBorderImage method is:</p>
596
597<pre class="code">
598 MagickBooleanType MagickBorderImage(MagickWand *wand,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]599 const PixelWand *bordercolor,const size_t width,
600 const size_t height)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]601</pre>
602
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]603<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]604
605<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]606<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]607
608<h5>bordercolor</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]609<p>the border color pixel wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]610
611<h5>width</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]612<p>the border width.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]613
614<h5>height</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]615<p>the border height.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]616
617 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]618<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]619_8c.html" id="Use_MagickBrightnessContrastImage">Use MagickBrightnessContrastImage</a></h2>
cristy16ff93c2010-01-13 23:18:07 +0000[diff] [blame]620<div class="doc-section">
621
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]622<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>
cristy16ff93c2010-01-13 23:18:07 +0000[diff] [blame]623
624
625<p>The format of the MagickBrightnessContrastImage method is:</p>
626
627<pre class="code">
628 MagickBooleanType MagickBrightnessContrastImage(MagickWand *wand,
629 const double brightness,const double contrast)
630 MagickBooleanType MagickBrightnessContrastImageChannel(MagickWand *wand,
631 const ChannelType channel,const double brightness,
632 const double contrast)
633</pre>
634
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]635<p>A description of each parameter follows:</p>
cristy16ff93c2010-01-13 23:18:07 +0000[diff] [blame]636
637<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]638<p>the magick wand.</p>
cristy16ff93c2010-01-13 23:18:07 +0000[diff] [blame]639
640<h5>channel</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]641<p>the image channel(s).</p>
cristy16ff93c2010-01-13 23:18:07 +0000[diff] [blame]642
643<h5>brightness</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]644<p>the brightness percent (-100 .. 100).</p>
cristy16ff93c2010-01-13 23:18:07 +0000[diff] [blame]645
646<h5>contrast</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]647<p>the contrast percent (-100 .. 100).</p>
cristy16ff93c2010-01-13 23:18:07 +0000[diff] [blame]648
649 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]650<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]651_8c.html" id="MagickCharcoalImage">MagickCharcoalImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]652<div class="doc-section">
653
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]654<p>MagickCharcoalImage() simulates a charcoal drawing.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]655
656<p>The format of the MagickCharcoalImage method is:</p>
657
658<pre class="code">
659 MagickBooleanType MagickCharcoalImage(MagickWand *wand,
660 const double radius,const double sigma)
661</pre>
662
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]663<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]664
665<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]666<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]667
668<h5>radius</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]669<p>the radius of the Gaussian, in pixels, not counting the center pixel.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]670
671<h5>sigma</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]672<p>the standard deviation of the Gaussian, in pixels.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]673
674 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]675<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]676_8c.html" id="MagickChopImage">MagickChopImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]677<div class="doc-section">
678
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]679<p>MagickChopImage() removes a region of an image and collapses the image to occupy the removed portion</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]680
681<p>The format of the MagickChopImage method is:</p>
682
683<pre class="code">
684 MagickBooleanType MagickChopImage(MagickWand *wand,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]685 const size_t width,const size_t height,const ssize_t x,
686 const ssize_t y)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]687</pre>
688
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]689<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]690
691<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]692<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]693
694<h5>width</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]695<p>the region width.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]696
697<h5>height</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]698<p>the region height.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]699
700<h5>x</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]701<p>the region x offset.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]702
703<h5>y</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]704<p>the region y offset.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]705
706
707 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]708<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]709_8c.html" id="MagickClampImage">MagickClampImage</a></h2>
cristyb4c03bb2009-09-27 13:55:46 +0000[diff] [blame]710<div class="doc-section">
711
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]712<p>MagickClampImage() restricts the color range from 0 to the quantum depth.</p>
cristyb4c03bb2009-09-27 13:55:46 +0000[diff] [blame]713
714<p>The format of the MagickClampImage method is:</p>
715
716<pre class="code">
717 MagickBooleanType MagickClampImage(MagickWand *wand)
718 MagickBooleanType MagickClampImageChannel(MagickWand *wand,
719 const ChannelType channel)
720</pre>
721
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]722<p>A description of each parameter follows:</p>
cristyb4c03bb2009-09-27 13:55:46 +0000[diff] [blame]723
724<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]725<p>the magick wand.</p>
cristyb4c03bb2009-09-27 13:55:46 +0000[diff] [blame]726
727<h5>channel</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]728<p>the channel.</p>
cristyb4c03bb2009-09-27 13:55:46 +0000[diff] [blame]729
730 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]731<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]732_8c.html" id="MagickClipImage">MagickClipImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]733<div class="doc-section">
734
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]735<p>MagickClipImage() clips along the first path from the 8BIM profile, if present.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]736
737<p>The format of the MagickClipImage method is:</p>
738
739<pre class="code">
740 MagickBooleanType MagickClipImage(MagickWand *wand)
741</pre>
742
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]743<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]744
745<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]746<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]747
748 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]749<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]750_8c.html" id="MagickClipImagePath">MagickClipImagePath</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]751<div class="doc-section">
752
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]753<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]754
755<p>The format of the MagickClipImagePath method is:</p>
756
757<pre class="code">
758 MagickBooleanType MagickClipImagePath(MagickWand *wand,
759 const char *pathname,const MagickBooleanType inside)
760</pre>
761
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]762<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]763
764<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]765<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]766
767<h5>pathname</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]768<p>name of clipping path resource. If name is preceded by #, use clipping path numbered by name.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]769
770<h5>inside</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]771<p>if non-zero, later operations take effect inside clipping path. Otherwise later operations take effect outside clipping path.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]772
773 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]774<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]775_8c.html" id="MagickClutImage">MagickClutImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]776<div class="doc-section">
777
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]778<p>MagickClutImage() replaces colors in the image from a color lookup table.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]779
780<p>The format of the MagickClutImage method is:</p>
781
782<pre class="code">
783 MagickBooleanType MagickClutImage(MagickWand *wand,
784 const MagickWand *clut_wand)
785 MagickBooleanType MagickClutImageChannel(MagickWand *wand,
786 const ChannelType channel,const MagickWand *clut_wand)
787</pre>
788
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]789<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]790
791<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]792<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]793
794<h5>clut_image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]795<p>the clut image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]796
797 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]798<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]799_8c.html" id="MagickCoalesceImages">MagickCoalesceImages</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]800<div class="doc-section">
801
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]802<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]803
804<p>The format of the MagickCoalesceImages method is:</p>
805
806<pre class="code">
807 MagickWand *MagickCoalesceImages(MagickWand *wand)
808</pre>
809
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]810<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]811
812<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]813<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]814
815 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]816<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]817_8c.html" id="MagickColorDecisionListImage">MagickColorDecisionListImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]818<div class="doc-section">
819
820<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>
821
822<pre class="text">
823 <ColorCorrectionCollection xmlns="urn:ASC:CDL:v1.2">
824 <ColorCorrection id="cc03345">
825 <SOPNode>
826 <Slope> 0.9 1.2 0.5 </Slope>
827 <Offset> 0.4 -0.5 0.6 </Offset>
828 <Power> 1.0 0.8 1.5 </Power>
829 </SOPNode>
830 <SATNode>
831 <Saturation> 0.85 </Saturation>
832 </SATNode>
833 </ColorCorrection>
834 </ColorCorrectionCollection>
835</pre>
836
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]837<p>which includes the offset, slope, and power for each of the RGB channels as well as the saturation.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]838
839<p>The format of the MagickColorDecisionListImage method is:</p>
840
841<pre class="code">
842 MagickBooleanType MagickColorDecisionListImage(MagickWand *wand,
843 const double gamma)
844</pre>
845
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]846<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]847
848<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]849<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]850
851<h5>color_correction_collection</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]852<p>the color correction collection in XML.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]853
854 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]855<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]856_8c.html" id="MagickColorizeImage">MagickColorizeImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]857<div class="doc-section">
858
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]859<p>MagickColorizeImage() blends the fill color with each pixel in the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]860
861<p>The format of the MagickColorizeImage method is:</p>
862
863<pre class="code">
864 MagickBooleanType MagickColorizeImage(MagickWand *wand,
865 const PixelWand *colorize,const PixelWand *opacity)
866</pre>
867
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]868<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]869
870<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]871<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]872
873<h5>colorize</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]874<p>the colorize pixel wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]875
876<h5>opacity</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]877<p>the opacity pixel wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]878
879 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]880<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]881_8c.html" id="MagickColorMatrixImage">MagickColorMatrixImage</a></h2>
cristy0291e2d2010-04-04 17:50:18 +0000[diff] [blame]882<div class="doc-section">
883
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]884<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>
cristy0291e2d2010-04-04 17:50:18 +0000[diff] [blame]885
886<p>The format of the MagickColorMatrixImage method is:</p>
887
888<pre class="code">
889 MagickBooleanType MagickColorMatrixImage(MagickWand *wand,
890 const KernelInfo *color_matrix)
891</pre>
892
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]893<p>A description of each parameter follows:</p>
cristy0291e2d2010-04-04 17:50:18 +0000[diff] [blame]894
895<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]896<p>the magick wand.</p>
cristy0291e2d2010-04-04 17:50:18 +0000[diff] [blame]897
898<h5>color_matrix</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]899<p>the color matrix.</p>
cristy0291e2d2010-04-04 17:50:18 +0000[diff] [blame]900
901 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]902<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]903_8c.html" id="MagickCombineImages">MagickCombineImages</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]904<div class="doc-section">
905
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]906<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]907
908<p>The format of the MagickCombineImages method is:</p>
909
910<pre class="code">
911 MagickWand *MagickCombineImages(MagickWand *wand,
912 const ChannelType channel)
913</pre>
914
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]915<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]916
917<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]918<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]919
920<h5>channel</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]921<p>the channel.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]922
923 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]924<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]925_8c.html" id="MagickCommentImage">MagickCommentImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]926<div class="doc-section">
927
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]928<p>MagickCommentImage() adds a comment to your image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]929
930<p>The format of the MagickCommentImage method is:</p>
931
932<pre class="code">
933 MagickBooleanType MagickCommentImage(MagickWand *wand,
934 const char *comment)
935</pre>
936
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]937<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]938
939<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]940<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]941
942<h5>comment</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]943<p>the image comment.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]944
945 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]946<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]947_8c.html" id="MagickCompareImageChannels">MagickCompareImageChannels</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]948<div class="doc-section">
949
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]950<p>MagickCompareImageChannels() compares one or more image channels of an image to a reconstructed image and returns the difference image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]951
952<p>The format of the MagickCompareImageChannels method is:</p>
953
954<pre class="code">
955 MagickWand *MagickCompareImageChannels(MagickWand *wand,
956 const MagickWand *reference,const ChannelType channel,
957 const MetricType metric,double *distortion)
958</pre>
959
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]960<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]961
962<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]963<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]964
965<h5>reference</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]966<p>the reference wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]967
968<h5>channel</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]969<p>the channel.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]970
971<h5>metric</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]972<p>the metric.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]973
974<h5>distortion</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]975<p>the computed distortion between the images.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]976
977 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]978<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]979_8c.html" id="MagickCompareImageLayers">MagickCompareImageLayers</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]980<div class="doc-section">
981
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]982<p>MagickCompareImageLayers() compares each image with the next in a sequence and returns the maximum bounding region of any pixel differences it discovers.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]983
984<p>The format of the MagickCompareImageLayers method is:</p>
985
986<pre class="code">
987 MagickWand *MagickCompareImageLayers(MagickWand *wand,
988 const ImageLayerMethod method)
989</pre>
990
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]991<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]992
993<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]994<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]995
996<h5>method</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]997<p>the compare method.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]998
999 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]1000<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1001_8c.html" id="MagickCompareImages">MagickCompareImages</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1002<div class="doc-section">
1003
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1004<p>MagickCompareImages() compares an image to a reconstructed image and returns the specified difference image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1005
1006<p>The format of the MagickCompareImages method is:</p>
1007
1008<pre class="code">
1009 MagickWand *MagickCompareImages(MagickWand *wand,
1010 const MagickWand *reference,const MetricType metric,
1011 double *distortion)
1012</pre>
1013
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1014<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1015
1016<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1017<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1018
1019<h5>reference</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1020<p>the reference wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1021
1022<h5>metric</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1023<p>the metric.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1024
1025<h5>distortion</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1026<p>the computed distortion between the images.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1027
1028 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]1029<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1030_8c.html" id="MagickCompositeImage">MagickCompositeImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1031<div class="doc-section">
1032
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1033<p>MagickCompositeImage() composite one image onto another at the specified offset.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1034
1035<p>The format of the MagickCompositeImage method is:</p>
1036
1037<pre class="code">
1038 MagickBooleanType MagickCompositeImage(MagickWand *wand,
1039 const MagickWand *composite_wand,const CompositeOperator compose,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]1040 const ssize_t x,const ssize_t y)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1041 MagickBooleanType MagickCompositeImageChannel(MagickWand *wand,
1042 const ChannelType channel,const MagickWand *composite_wand,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]1043 const CompositeOperator compose,const ssize_t x,const ssize_t y)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1044</pre>
1045
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1046<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1047
1048<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1049<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1050
1051<h5>composite_image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1052<p>the composite image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1053
1054<h5>compose</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1055<p>This operator affects how the composite is applied to the image. The default is Over. Choose from these operators:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1056
1057<pre class="text">
1058 OverCompositeOp InCompositeOp OutCompositeOp
1059 AtopCompositeOp XorCompositeOp PlusCompositeOp
1060 MinusCompositeOp AddCompositeOp SubtractCompositeOp
1061 DifferenceCompositeOp BumpmapCompositeOp CopyCompositeOp
1062 DisplaceCompositeOp
1063</pre>
1064
1065<h5>x</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1066<p>the column offset of the composited image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1067
1068<h5>y</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1069<p>the row offset of the composited image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1070
1071 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]1072<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1073_8c.html" id="MagickContrastImage">MagickContrastImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1074<div class="doc-section">
1075
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1076<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1077
1078<p>The format of the MagickContrastImage method is:</p>
1079
1080<pre class="code">
1081 MagickBooleanType MagickContrastImage(MagickWand *wand,
1082 const MagickBooleanType sharpen)
1083</pre>
1084
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1085<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1086
1087<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1088<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1089
1090<h5>sharpen</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1091<p>Increase or decrease image contrast.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1092
1093
1094 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]1095<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1096_8c.html" id="MagickContrastStretchImage">MagickContrastStretchImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1097<div class="doc-section">
1098
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1099<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1100
1101<p>The format of the MagickContrastStretchImage method is:</p>
1102
1103<pre class="code">
1104 MagickBooleanType MagickContrastStretchImage(MagickWand *wand,
1105 const double black_point,const double white_point)
1106 MagickBooleanType MagickContrastStretchImageChannel(MagickWand *wand,
1107 const ChannelType channel,const double black_point,
1108 const double white_point)
1109</pre>
1110
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1111<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1112
1113<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1114<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1115
1116<h5>channel</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1117<p>the image channel(s).</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1118
1119<h5>black_point</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1120<p>the black point.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1121
1122<h5>white_point</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1123<p>the white point.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1124
1125 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]1126<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1127_8c.html" id="MagickConvolveImage">MagickConvolveImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1128<div class="doc-section">
1129
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1130<p>MagickConvolveImage() applies a custom convolution kernel to the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1131
1132<p>The format of the MagickConvolveImage method is:</p>
1133
1134<pre class="code">
1135 MagickBooleanType MagickConvolveImage(MagickWand *wand,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]1136 const size_t order,const double *kernel)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1137 MagickBooleanType MagickConvolveImageChannel(MagickWand *wand,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]1138 const ChannelType channel,const size_t order,
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1139 const double *kernel)
1140</pre>
1141
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1142<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1143
1144<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1145<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1146
1147<h5>channel</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1148<p>the image channel(s).</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1149
1150<h5>order</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1151<p>the number of columns and rows in the filter kernel.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1152
1153<h5>kernel</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1154<p>An array of doubles representing the convolution kernel.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1155
1156 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]1157<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1158_8c.html" id="MagickCropImage">MagickCropImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1159<div class="doc-section">
1160
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1161<p>MagickCropImage() extracts a region of the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1162
1163<p>The format of the MagickCropImage method is:</p>
1164
1165<pre class="code">
1166 MagickBooleanType MagickCropImage(MagickWand *wand,
cristy85278ed2010-05-31 15:10:05 +0000[diff] [blame]1167 const size_t width,const size_t height,const ssize_t x,const ssize_t y)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1168</pre>
1169
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1170<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1171
1172<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1173<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1174
1175<h5>width</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1176<p>the region width.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1177
1178<h5>height</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1179<p>the region height.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1180
1181<h5>x</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1182<p>the region x-offset.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1183
1184<h5>y</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1185<p>the region y-offset.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1186
1187 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]1188<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1189_8c.html" id="MagickCycleColormapImage">MagickCycleColormapImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1190<div class="doc-section">
1191
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1192<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1193
1194<p>The format of the MagickCycleColormapImage method is:</p>
1195
1196<pre class="code">
1197 MagickBooleanType MagickCycleColormapImage(MagickWand *wand,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]1198 const ssize_t displace)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1199</pre>
1200
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1201<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1202
1203<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1204<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1205
1206<h5>pixel_wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1207<p>the pixel wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1208
1209 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]1210<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1211_8c.html" id="MagickConstituteImage">MagickConstituteImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1212<div class="doc-section">
1213
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1214<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1215
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1216<p>MagickConstituteImage(wand,640,640,"RGB",CharPixel,pixels);</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1217
1218<p>The format of the MagickConstituteImage method is:</p>
1219
1220<pre class="code">
1221 MagickBooleanType MagickConstituteImage(MagickWand *wand,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]1222 const size_t columns,const size_t rows,const char *map,
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1223 const StorageType storage,void *pixels)
1224</pre>
1225
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1226<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1227
1228<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1229<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1230
1231<h5>columns</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1232<p>width in pixels of the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1233
1234<h5>rows</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1235<p>height in pixels of the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1236
1237<h5>map</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1238<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1239
1240<h5>storage</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1241<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1242
1243<h5>pixels</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1244<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1245
1246
1247 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]1248<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1249_8c.html" id="MagickDecipherImage">MagickDecipherImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1250<div class="doc-section">
1251
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1252<p>MagickDecipherImage() converts cipher pixels to plain pixels.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1253
1254<p>The format of the MagickDecipherImage method is:</p>
1255
1256<pre class="code">
1257 MagickBooleanType MagickDecipherImage(MagickWand *wand,
1258 const char *passphrase)
1259</pre>
1260
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1261<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1262
1263<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1264<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1265
1266<h5>passphrase</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1267<p>the passphrase.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1268
1269 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]1270<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1271_8c.html" id="MagickDeconstructImages">MagickDeconstructImages</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1272<div class="doc-section">
1273
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1274<p>MagickDeconstructImages() compares each image with the next in a sequence and returns the maximum bounding region of any pixel differences it discovers.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1275
1276<p>The format of the MagickDeconstructImages method is:</p>
1277
1278<pre class="code">
1279 MagickWand *MagickDeconstructImages(MagickWand *wand)
1280</pre>
1281
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1282<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1283
1284<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1285<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1286
1287 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]1288<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1289_8c.html" id="MagickDeskewImage">MagickDeskewImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1290<div class="doc-section">
1291
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1292<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1293
1294<p>The format of the MagickDeskewImage method is:</p>
1295
1296<pre class="code">
1297 MagickBooleanType MagickDeskewImage(MagickWand *wand,
1298 const double threshold)
1299</pre>
1300
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1301<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1302
1303<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1304<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1305
1306<h5>threshold</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1307<p>separate background from foreground.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1308
1309 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]1310<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1311_8c.html" id="MagickDespeckleImage">MagickDespeckleImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1312<div class="doc-section">
1313
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1314<p>MagickDespeckleImage() reduces the speckle noise in an image while perserving the edges of the original image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1315
1316<p>The format of the MagickDespeckleImage method is:</p>
1317
1318<pre class="code">
1319 MagickBooleanType MagickDespeckleImage(MagickWand *wand)
1320</pre>
1321
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1322<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1323
1324<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1325<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1326
1327 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]1328<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1329_8c.html" id="MagickDestroyImage">MagickDestroyImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1330<div class="doc-section">
1331
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1332<p>MagickDestroyImage() dereferences an image, deallocating memory associated with the image if the reference count becomes zero.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1333
1334<p>The format of the MagickDestroyImage method is:</p>
1335
1336<pre class="code">
1337 Image *MagickDestroyImage(Image *image)
1338</pre>
1339
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1340<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1341
1342<h5>image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1343<p>the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1344
1345 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]1346<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1347_8c.html" id="MagickDisplayImage">MagickDisplayImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1348<div class="doc-section">
1349
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1350<p>MagickDisplayImage() displays an image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1351
1352<p>The format of the MagickDisplayImage method is:</p>
1353
1354<pre class="code">
1355 MagickBooleanType MagickDisplayImage(MagickWand *wand,
1356 const char *server_name)
1357</pre>
1358
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1359<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1360
1361<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1362<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1363
1364<h5>server_name</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1365<p>the X server name.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1366
1367 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]1368<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1369_8c.html" id="MagickDisplayImages">MagickDisplayImages</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1370<div class="doc-section">
1371
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1372<p>MagickDisplayImages() displays an image or image sequence.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1373
1374<p>The format of the MagickDisplayImages method is:</p>
1375
1376<pre class="code">
1377 MagickBooleanType MagickDisplayImages(MagickWand *wand,
1378 const char *server_name)
1379</pre>
1380
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1381<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1382
1383<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1384<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1385
1386<h5>server_name</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1387<p>the X server name.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1388
1389 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]1390<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1391_8c.html" id="MagickDistortImage">MagickDistortImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1392<div class="doc-section">
1393
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1394<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1395
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1396<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1397
1398<p>The format of the MagickDistortImage method is:</p>
1399
1400<pre class="code">
1401 MagickBooleanType MagickDistortImage(MagickWand *wand,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]1402 const DistortImageMethod method,const size_t number_arguments,
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1403 const double *arguments,const MagickBooleanType bestfit)
1404</pre>
1405
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1406<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1407
1408<h5>image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1409<p>the image to be distorted.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1410
1411<h5>method</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1412<p>the method of image distortion.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1413
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1414<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1415
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1416<p>Bilinear has no simple inverse mapping so it does not allow 'bestfit' style of image distortion.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1417
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1418<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1419
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1420<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1421
1422<h5>number_arguments</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1423<p>the number of arguments given for this distortion method.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1424
1425<h5>arguments</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1426<p>the arguments for this distortion method.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1427
1428<h5>bestfit</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1429<p>Attempt to resize destination to fit distorted source.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1430
1431 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]1432<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1433_8c.html" id="MagickDrawImage">MagickDrawImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1434<div class="doc-section">
1435
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1436<p>MagickDrawImage() renders the drawing wand on the current image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1437
1438<p>The format of the MagickDrawImage method is:</p>
1439
1440<pre class="code">
1441 MagickBooleanType MagickDrawImage(MagickWand *wand,
1442 const DrawingWand *drawing_wand)
1443</pre>
1444
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1445<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1446
1447<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1448<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1449
1450<h5>drawing_wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1451<p>the draw wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1452
1453 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]1454<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1455_8c.html" id="MagickEdgeImage">MagickEdgeImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1456<div class="doc-section">
1457
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1458<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1459
1460<p>The format of the MagickEdgeImage method is:</p>
1461
1462<pre class="code">
1463 MagickBooleanType MagickEdgeImage(MagickWand *wand,const double radius)
1464</pre>
1465
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1466<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1467
1468<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1469<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1470
1471<h5>radius</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1472<p>the radius of the pixel neighborhood.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1473
1474 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]1475<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1476_8c.html" id="MagickEmbossImage">MagickEmbossImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1477<div class="doc-section">
1478
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1479<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1480
1481<p>The format of the MagickEmbossImage method is:</p>
1482
1483<pre class="code">
1484 MagickBooleanType MagickEmbossImage(MagickWand *wand,const double radius,
1485 const double sigma)
1486</pre>
1487
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1488<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1489
1490<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1491<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1492
1493<h5>radius</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1494<p>the radius of the Gaussian, in pixels, not counting the center pixel.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1495
1496<h5>sigma</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1497<p>the standard deviation of the Gaussian, in pixels.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1498
1499 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]1500<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1501_8c.html" id="MagickEncipherImage">MagickEncipherImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1502<div class="doc-section">
1503
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1504<p>MagickEncipherImage() converts plaint pixels to cipher pixels.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1505
1506<p>The format of the MagickEncipherImage method is:</p>
1507
1508<pre class="code">
1509 MagickBooleanType MagickEncipherImage(MagickWand *wand,
1510 const char *passphrase)
1511</pre>
1512
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1513<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1514
1515<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1516<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1517
1518<h5>passphrase</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1519<p>the passphrase.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1520
1521 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]1522<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1523_8c.html" id="MagickEnhanceImage">MagickEnhanceImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1524<div class="doc-section">
1525
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1526<p>MagickEnhanceImage() applies a digital filter that improves the quality of a noisy image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1527
1528<p>The format of the MagickEnhanceImage method is:</p>
1529
1530<pre class="code">
1531 MagickBooleanType MagickEnhanceImage(MagickWand *wand)
1532</pre>
1533
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1534<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1535
1536<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1537<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1538
1539 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]1540<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1541_8c.html" id="MagickEqualizeImage">MagickEqualizeImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1542<div class="doc-section">
1543
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1544<p>MagickEqualizeImage() equalizes the image histogram.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1545
1546<p>The format of the MagickEqualizeImage method is:</p>
1547
1548<pre class="code">
1549 MagickBooleanType MagickEqualizeImage(MagickWand *wand)
1550 MagickBooleanType MagickEqualizeImageChannel(MagickWand *wand,
1551 const ChannelType channel)
1552</pre>
1553
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1554<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1555
1556<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1557<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1558
1559<h5>channel</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1560<p>the image channel(s).</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1561
1562 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]1563<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1564_8c.html" id="MagickEvaluateImage">MagickEvaluateImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1565<div class="doc-section">
1566
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1567<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1568
1569<p>The format of the MagickEvaluateImage method is:</p>
1570
1571<pre class="code">
1572 MagickBooleanType MagickEvaluateImage(MagickWand *wand,
1573 const MagickEvaluateOperator operator,const double value)
cristy63fed272010-03-07 19:08:45 +0000[diff] [blame]1574 MagickBooleanType MagickEvaluateImages(MagickWand *wand,
1575 const MagickEvaluateOperator operator)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1576 MagickBooleanType MagickEvaluateImageChannel(MagickWand *wand,
1577 const ChannelType channel,const MagickEvaluateOperator op,
1578 const double value)
1579</pre>
1580
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1581<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1582
1583<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1584<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1585
1586<h5>channel</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1587<p>the channel(s).</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1588
1589<h5>op</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1590<p>A channel operator.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1591
1592<h5>value</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1593<p>A value value.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1594
1595 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]1596<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1597_8c.html" id="MagickExportImagePixels">MagickExportImagePixels</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1598<div class="doc-section">
1599
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1600<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1601
1602<p>Suppose you want to extract the first scanline of a 640x480 image as character data in red-green-blue order:</p>
1603
1604<pre class="text">
1605 MagickExportImagePixels(wand,0,0,640,1,"RGB",CharPixel,pixels);
1606</pre>
1607
1608<p>The format of the MagickExportImagePixels method is:</p>
1609
1610<pre class="code">
1611 MagickBooleanType MagickExportImagePixels(MagickWand *wand,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]1612 const ssize_t x,const ssize_t y,const size_t columns,
1613 const size_t rows,const char *map,const StorageType storage,
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1614 void *pixels)
1615</pre>
1616
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1617<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1618
1619<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1620<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1621
1622<h5>x, y, columns, rows</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1623<p>These values define the perimeter of a region of pixels you want to extract.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1624
1625<h5>map</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1626<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1627
1628<h5>storage</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1629<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1630
1631<h5>pixels</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1632<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1633
1634 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]1635<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1636_8c.html" id="MagickExtentImage">MagickExtentImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1637<div class="doc-section">
1638
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1639<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1640
1641<p>The format of the MagickExtentImage method is:</p>
1642
1643<pre class="code">
1644 MagickBooleanType MagickExtentImage(MagickWand *wand,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]1645 const size_t width,const size_t height,const ssize_t x,
1646 const ssize_t y)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1647</pre>
1648
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1649<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1650
1651<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1652<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1653
1654<h5>width</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1655<p>the region width.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1656
1657<h5>height</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1658<p>the region height.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1659
1660<h5>x</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1661<p>the region x offset.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1662
1663<h5>y</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1664<p>the region y offset.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1665
1666 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]1667<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1668_8c.html" id="MagickFilterImage">MagickFilterImage</a></h2>
cristy16ff93c2010-01-13 23:18:07 +0000[diff] [blame]1669<div class="doc-section">
1670
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1671<p>MagickFilterImage() applies a custom convolution kernel to the image.</p>
cristy16ff93c2010-01-13 23:18:07 +0000[diff] [blame]1672
1673<p>The format of the MagickFilterImage method is:</p>
1674
1675<pre class="code">
1676 MagickBooleanType MagickFilterImage(MagickWand *wand,
cristy488844c2010-01-22 14:02:05 +0000[diff] [blame]1677 const KernelInfo *kernel)
cristy16ff93c2010-01-13 23:18:07 +0000[diff] [blame]1678 MagickBooleanType MagickFilterImageChannel(MagickWand *wand,
cristy488844c2010-01-22 14:02:05 +0000[diff] [blame]1679 const ChannelType channel,const KernelInfo *kernel)
cristy16ff93c2010-01-13 23:18:07 +0000[diff] [blame]1680</pre>
1681
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1682<p>A description of each parameter follows:</p>
cristy16ff93c2010-01-13 23:18:07 +0000[diff] [blame]1683
1684<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1685<p>the magick wand.</p>
cristy16ff93c2010-01-13 23:18:07 +0000[diff] [blame]1686
1687<h5>channel</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1688<p>the image channel(s).</p>
cristy16ff93c2010-01-13 23:18:07 +0000[diff] [blame]1689
1690<h5>kernel</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1691<p>An array of doubles representing the convolution kernel.</p>
cristy16ff93c2010-01-13 23:18:07 +0000[diff] [blame]1692
1693 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]1694<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1695_8c.html" id="MagickFlipImage">MagickFlipImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1696<div class="doc-section">
1697
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1698<p>MagickFlipImage() creates a vertical mirror image by reflecting the pixels around the central x-axis.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1699
1700<p>The format of the MagickFlipImage method is:</p>
1701
1702<pre class="code">
1703 MagickBooleanType MagickFlipImage(MagickWand *wand)
1704</pre>
1705
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1706<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1707
1708<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1709<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1710
1711 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]1712<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1713_8c.html" id="MagickFloodfillPaintImage">MagickFloodfillPaintImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1714<div class="doc-section">
1715
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1716<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1717
1718<p>The format of the MagickFloodfillPaintImage method is:</p>
1719
1720<pre class="code">
1721 MagickBooleanType MagickFloodfillPaintImage(MagickWand *wand,
1722 const ChannelType channel,const PixelWand *fill,const double fuzz,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]1723 const PixelWand *bordercolor,const ssize_t x,const ssize_t y,
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1724 const MagickBooleanType invert)
1725</pre>
1726
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1727<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1728
1729<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1730<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1731
1732<h5>channel</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1733<p>the channel(s).</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1734
1735<h5>fill</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1736<p>the floodfill color pixel wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1737
1738<h5>fuzz</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1739<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1740
1741<h5>bordercolor</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1742<p>the border color pixel wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1743
1744<h5>x,y</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1745<p>the starting location of the operation.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1746
1747<h5>invert</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1748<p>paint any pixel that does not match the target color.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1749
1750 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]1751<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1752_8c.html" id="MagickFlopImage">MagickFlopImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1753<div class="doc-section">
1754
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1755<p>MagickFlopImage() creates a horizontal mirror image by reflecting the pixels around the central y-axis.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1756
1757<p>The format of the MagickFlopImage method is:</p>
1758
1759<pre class="code">
1760 MagickBooleanType MagickFlopImage(MagickWand *wand)
1761</pre>
1762
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1763<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1764
1765<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1766<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1767
1768 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]1769<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1770_8c.html" id="MagickForwardFourierTransformImage">MagickForwardFourierTransformImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1771<div class="doc-section">
1772
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1773<p>MagickForwardFourierTransformImage() implements the discrete Fourier transform (DFT) of the image either as a magnitude / phase or real / imaginary image pair.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1774
1775<p>The format of the MagickForwardFourierTransformImage method is:</p>
1776
1777<pre class="code">
1778 MagickBooleanType MagickForwardFourierTransformImage(MagickWand *wand,
1779 const MagickBooleanType magnitude)
1780</pre>
1781
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1782<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1783
1784<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1785<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1786
1787<h5>magnitude</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1788<p>if true, return as magnitude / phase pair otherwise a real / imaginary image pair.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1789
1790 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]1791<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1792_8c.html" id="MagickFrameImage">MagickFrameImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1793<div class="doc-section">
1794
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1795<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1796
1797<p>The format of the MagickFrameImage method is:</p>
1798
1799<pre class="code">
1800 MagickBooleanType MagickFrameImage(MagickWand *wand,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]1801 const PixelWand *matte_color,const size_t width,
1802 const size_t height,const ssize_t inner_bevel,
1803 const ssize_t outer_bevel)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1804</pre>
1805
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1806<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1807
1808<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1809<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1810
1811<h5>matte_color</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1812<p>the frame color pixel wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1813
1814<h5>width</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1815<p>the border width.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1816
1817<h5>height</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1818<p>the border height.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1819
1820<h5>inner_bevel</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1821<p>the inner bevel width.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1822
1823<h5>outer_bevel</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1824<p>the outer bevel width.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1825
1826 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]1827<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1828_8c.html" id="MagickFunctionImage">MagickFunctionImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1829<div class="doc-section">
1830
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1831<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1832
1833<p>The format of the MagickFunctionImage method is:</p>
1834
1835<pre class="code">
1836 MagickBooleanType MagickFunctionImage(MagickWand *wand,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]1837 const MagickFunction function,const size_t number_arguments,
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1838 const double *arguments)
1839 MagickBooleanType MagickFunctionImageChannel(MagickWand *wand,
1840 const ChannelType channel,const MagickFunction function,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]1841 const size_t number_arguments,const double *arguments)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1842</pre>
1843
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1844<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1845
1846<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1847<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1848
1849<h5>channel</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1850<p>the channel(s).</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1851
1852<h5>function</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1853<p>the image function.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1854
1855<h5>number_arguments</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1856<p>the number of function arguments.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1857
1858<h5>arguments</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1859<p>the function arguments.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1860
1861 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]1862<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1863_8c.html" id="MagickFxImage">MagickFxImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1864<div class="doc-section">
1865
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1866<p>MagickFxImage() evaluate expression for each pixel in the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1867
1868<p>The format of the MagickFxImage method is:</p>
1869
1870<pre class="code">
1871 MagickWand *MagickFxImage(MagickWand *wand,const char *expression)
1872 MagickWand *MagickFxImageChannel(MagickWand *wand,
1873 const ChannelType channel,const char *expression)
1874</pre>
1875
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1876<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1877
1878<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1879<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1880
1881<h5>channel</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1882<p>the image channel(s).</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1883
1884<h5>expression</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1885<p>the expression.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1886
1887 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]1888<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1889_8c.html" id="MagickGammaImage">MagickGammaImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1890<div class="doc-section">
1891
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1892<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1893
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1894<p>You can also reduce the influence of a particular channel with a gamma value of 0.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1895
1896<p>The format of the MagickGammaImage method is:</p>
1897
1898<pre class="code">
1899 MagickBooleanType MagickGammaImage(MagickWand *wand,const double gamma)
1900 MagickBooleanType MagickGammaImageChannel(MagickWand *wand,
1901 const ChannelType channel,const double gamma)
1902</pre>
1903
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1904<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1905
1906<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1907<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1908
1909<h5>channel</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1910<p>the channel.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1911
1912<h5>level</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1913<p>Define the level of gamma correction.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1914
1915 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]1916<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1917_8c.html" id="MagickGaussianBlurImage">MagickGaussianBlurImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1918<div class="doc-section">
1919
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1920<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1921
1922<p>The format of the MagickGaussianBlurImage method is:</p>
1923
1924<pre class="code">
1925 MagickBooleanType MagickGaussianBlurImage(MagickWand *wand,
1926 const double radius,const double sigma)
1927 MagickBooleanType MagickGaussianBlurImageChannel(MagickWand *wand,
1928 const ChannelType channel,const double radius,const double sigma)
1929</pre>
1930
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1931<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1932
1933<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1934<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1935
1936<h5>channel</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1937<p>the image channel(s).</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1938
1939<h5>radius</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1940<p>the radius of the Gaussian, in pixels, not counting the center pixel.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1941
1942<h5>sigma</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1943<p>the standard deviation of the Gaussian, in pixels.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1944
1945 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]1946<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1947_8c.html" id="MagickGetImage">MagickGetImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1948<div class="doc-section">
1949
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1950<p>MagickGetImage() gets the image at the current image index.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1951
1952<p>The format of the MagickGetImage method is:</p>
1953
1954<pre class="code">
1955 MagickWand *MagickGetImage(MagickWand *wand)
1956</pre>
1957
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1958<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1959
1960<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1961<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1962
1963 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]1964<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1965_8c.html" id="MagickGetImageAlphaChannel">MagickGetImageAlphaChannel</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1966<div class="doc-section">
1967
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1968<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1969
1970<p>The format of the MagickGetImageAlphaChannel method is:</p>
1971
1972<pre class="code">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]1973 size_t MagickGetImageAlphaChannel(MagickWand *wand)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1974</pre>
1975
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1976<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1977
1978<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1979<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1980
1981 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]1982<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1983_8c.html" id="MagickGetImageClipMask">MagickGetImageClipMask</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1984<div class="doc-section">
1985
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1986<p>MagickGetImageClipMask() gets the image clip mask at the current image index.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1987
1988<p>The format of the MagickGetImageClipMask method is:</p>
1989
1990<pre class="code">
1991 MagickWand *MagickGetImageClipMask(MagickWand *wand)
1992</pre>
1993
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1994<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1995
1996<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1997<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1998
1999 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]2000<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2001_8c.html" id="MagickGetImageBackgroundColor">MagickGetImageBackgroundColor</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2002<div class="doc-section">
2003
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2004<p>MagickGetImageBackgroundColor() returns the image background color.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2005
2006<p>The format of the MagickGetImageBackgroundColor method is:</p>
2007
2008<pre class="code">
2009 MagickBooleanType MagickGetImageBackgroundColor(MagickWand *wand,
2010 PixelWand *background_color)
2011</pre>
2012
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2013<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2014
2015<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2016<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2017
2018<h5>background_color</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2019<p>Return the background color.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2020
2021 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]2022<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2023_8c.html" id="MagickGetImageBlob">MagickGetImageBlob</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2024<div class="doc-section">
2025
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2026<p>MagickGetImageBlob() implements direct to memory image formats. It returns the image as a blob and its length. Use MagickSetFormat() to set the format of the returned blob (GIF, JPEG, PNG, etc.).</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2027
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2028<p>Use MagickRelinquishMemory() to free the blob when you are done with it.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2029
2030<p>The format of the MagickGetImageBlob method is:</p>
2031
2032<pre class="code">
2033 unsigned char *MagickGetImageBlob(MagickWand *wand,size_t *length)
2034</pre>
2035
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2036<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2037
2038<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2039<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2040
2041<h5>length</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2042<p>the length of the blob.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2043
2044 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]2045<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2046_8c.html" id="MagickGetImageBlob">MagickGetImageBlob</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2047<div class="doc-section">
2048
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2049<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2050
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2051<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2052
2053<p>The format of the MagickGetImagesBlob method is:</p>
2054
2055<pre class="code">
2056 unsigned char *MagickGetImagesBlob(MagickWand *wand,size_t *length)
2057</pre>
2058
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2059<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2060
2061<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2062<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2063
2064<h5>length</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2065<p>the length of the blob.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2066
2067 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]2068<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2069_8c.html" id="MagickGetImageBluePrimary">MagickGetImageBluePrimary</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2070<div class="doc-section">
2071
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2072<p>MagickGetImageBluePrimary() returns the chromaticy blue primary point for the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2073
2074<p>The format of the MagickGetImageBluePrimary method is:</p>
2075
2076<pre class="code">
2077 MagickBooleanType MagickGetImageBluePrimary(MagickWand *wand,double *x,
2078 double *y)
2079</pre>
2080
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2081<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2082
2083<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2084<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2085
2086<h5>x</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2087<p>the chromaticity blue primary x-point.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2088
2089<h5>y</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2090<p>the chromaticity blue primary y-point.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2091
2092 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]2093<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2094_8c.html" id="MagickGetImageBorderColor">MagickGetImageBorderColor</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2095<div class="doc-section">
2096
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2097<p>MagickGetImageBorderColor() returns the image border color.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2098
2099<p>The format of the MagickGetImageBorderColor method is:</p>
2100
2101<pre class="code">
2102 MagickBooleanType MagickGetImageBorderColor(MagickWand *wand,
2103 PixelWand *border_color)
2104</pre>
2105
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2106<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2107
2108<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2109<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2110
2111<h5>border_color</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2112<p>Return the border color.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2113
2114 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]2115<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2116_8c.html" id="MagickGetImageChannelDepth">MagickGetImageChannelDepth</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2117<div class="doc-section">
2118
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2119<p>MagickGetImageChannelDepth() gets the depth for one or more image channels.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2120
2121<p>The format of the MagickGetImageChannelDepth method is:</p>
2122
2123<pre class="code">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]2124 size_t MagickGetImageChannelDepth(MagickWand *wand,
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2125 const ChannelType channel)
2126</pre>
2127
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2128<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2129
2130<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2131<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2132
2133<h5>channel</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2134<p>the image channel(s).</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2135
2136 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]2137<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2138_8c.html" id="MagickGetImageChannelDistortion">MagickGetImageChannelDistortion</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2139<div class="doc-section">
2140
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2141<p>MagickGetImageChannelDistortion() compares one or more image channels of an image to a reconstructed image and returns the specified distortion metric.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2142
2143<p>The format of the MagickGetImageChannelDistortion method is:</p>
2144
2145<pre class="code">
2146 MagickBooleanType MagickGetImageChannelDistortion(MagickWand *wand,
2147 const MagickWand *reference,const ChannelType channel,
2148 const MetricType metric,double *distortion)
2149</pre>
2150
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2151<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2152
2153<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2154<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2155
2156<h5>reference</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2157<p>the reference wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2158
2159<h5>channel</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2160<p>the channel.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2161
2162<h5>metric</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2163<p>the metric.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2164
2165<h5>distortion</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2166<p>the computed distortion between the images.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2167
2168 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]2169<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2170_8c.html" id="MagickGetImageChannelDistortions">MagickGetImageChannelDistortions</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2171<div class="doc-section">
2172
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2173<p>MagickGetImageChannelDistortions() compares one or more image channels of an image to a reconstructed image and returns the specified distortion metrics.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2174
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2175<p>Use MagickRelinquishMemory() to free the metrics when you are done with them.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2176
2177<p>The format of the MagickGetImageChannelDistortion method is:</p>
2178
2179<pre class="code">
2180 double *MagickGetImageChannelDistortion(MagickWand *wand,
2181 const MagickWand *reference,const MetricType metric)
2182</pre>
2183
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2184<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2185
2186<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2187<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2188
2189<h5>reference</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2190<p>the reference wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2191
2192<h5>metric</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2193<p>the metric.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2194
2195 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]2196<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2197_8c.html" id="MagickGetImageChannelFeatures">MagickGetImageChannelFeatures</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2198<div class="doc-section">
2199
cristy7396d882010-01-27 02:37:56 +0000[diff] [blame]2200<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2201
cristy7396d882010-01-27 02:37:56 +0000[diff] [blame]2202<pre class="text">
2203 channel_features=MagickGetImageChannelFeatures(wand,1);
2204 contrast=channel_features[RedChannel].contrast[0];
2205</pre>
2206
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2207<p>Use MagickRelinquishMemory() to free the statistics buffer.</p>
cristy7396d882010-01-27 02:37:56 +0000[diff] [blame]2208
2209<p>The format of the MagickGetImageChannelFeatures method is:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2210
2211<pre class="code">
cristy7396d882010-01-27 02:37:56 +0000[diff] [blame]2212 ChannelFeatures *MagickGetImageChannelFeatures(MagickWand *wand,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]2213 const size_t distance)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2214</pre>
2215
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2216<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2217
2218<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2219<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2220
cristy7396d882010-01-27 02:37:56 +0000[diff] [blame]2221<h5>distance</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2222<p>the distance.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2223
2224 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]2225<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2226_8c.html" id="MagickGetImageChannelKurtosis">MagickGetImageChannelKurtosis</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2227<div class="doc-section">
2228
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2229<p>MagickGetImageChannelKurtosis() gets the kurtosis and skewness of one or more image channels.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2230
2231<p>The format of the MagickGetImageChannelKurtosis method is:</p>
2232
2233<pre class="code">
2234 MagickBooleanType MagickGetImageChannelKurtosis(MagickWand *wand,
2235 const ChannelType channel,double *kurtosis,double *skewness)
2236</pre>
2237
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2238<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2239
2240<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2241<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2242
2243<h5>channel</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2244<p>the image channel(s).</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2245
2246<h5>kurtosis</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2247<p>The kurtosis for the specified channel(s).</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2248
2249<h5>skewness</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2250<p>The skewness for the specified channel(s).</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2251
2252 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]2253<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2254_8c.html" id="MagickGetImageChannelMean">MagickGetImageChannelMean</a></h2>
cristy7396d882010-01-27 02:37:56 +0000[diff] [blame]2255<div class="doc-section">
2256
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2257<p>MagickGetImageChannelMean() gets the mean and standard deviation of one or more image channels.</p>
cristy7396d882010-01-27 02:37:56 +0000[diff] [blame]2258
2259<p>The format of the MagickGetImageChannelMean method is:</p>
2260
2261<pre class="code">
2262 MagickBooleanType MagickGetImageChannelMean(MagickWand *wand,
2263 const ChannelType channel,double *mean,double *standard_deviation)
2264</pre>
2265
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2266<p>A description of each parameter follows:</p>
cristy7396d882010-01-27 02:37:56 +0000[diff] [blame]2267
2268<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2269<p>the magick wand.</p>
cristy7396d882010-01-27 02:37:56 +0000[diff] [blame]2270
2271<h5>channel</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2272<p>the image channel(s).</p>
cristy7396d882010-01-27 02:37:56 +0000[diff] [blame]2273
2274<h5>mean</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2275<p>The mean pixel value for the specified channel(s).</p>
cristy7396d882010-01-27 02:37:56 +0000[diff] [blame]2276
2277<h5>standard_deviation</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2278<p>The standard deviation for the specified channel(s).</p>
cristy7396d882010-01-27 02:37:56 +0000[diff] [blame]2279
2280 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]2281<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2282_8c.html" id="MagickGetImageChannelRange">MagickGetImageChannelRange</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2283<div class="doc-section">
2284
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2285<p>MagickGetImageChannelRange() gets the range for one or more image channels.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2286
2287<p>The format of the MagickGetImageChannelRange method is:</p>
2288
2289<pre class="code">
2290 MagickBooleanType MagickGetImageChannelRange(MagickWand *wand,
2291 const ChannelType channel,double *minima,double *maxima)
2292</pre>
2293
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2294<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2295
2296<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2297<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2298
2299<h5>channel</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2300<p>the image channel(s).</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2301
2302<h5>minima</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2303<p>The minimum pixel value for the specified channel(s).</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2304
2305<h5>maxima</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2306<p>The maximum pixel value for the specified channel(s).</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2307
2308 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]2309<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2310_8c.html" id="MagickGetImageChannelStatistics">MagickGetImageChannelStatistics</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2311<div class="doc-section">
2312
2313<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>
2314
2315<pre class="text">
cristy7396d882010-01-27 02:37:56 +0000[diff] [blame]2316 channel_statistics=MagickGetImageChannelStatistics(wand);
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2317 red_mean=channel_statistics[RedChannel].mean;
2318</pre>
2319
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2320<p>Use MagickRelinquishMemory() to free the statistics buffer.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2321
2322<p>The format of the MagickGetImageChannelStatistics method is:</p>
2323
2324<pre class="code">
2325 ChannelStatistics *MagickGetImageChannelStatistics(MagickWand *wand)
2326</pre>
2327
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2328<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2329
2330<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2331<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2332
2333 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]2334<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2335_8c.html" id="MagickGetImageColormapColor">MagickGetImageColormapColor</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2336<div class="doc-section">
2337
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2338<p>MagickGetImageColormapColor() returns the color of the specified colormap index.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2339
2340<p>The format of the MagickGetImageColormapColor method is:</p>
2341
2342<pre class="code">
2343 MagickBooleanType MagickGetImageColormapColor(MagickWand *wand,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]2344 const size_t index,PixelWand *color)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2345</pre>
2346
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2347<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2348
2349<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2350<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2351
2352<h5>index</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2353<p>the offset into the image colormap.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2354
2355<h5>color</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2356<p>Return the colormap color in this wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2357
2358 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]2359<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2360_8c.html" id="MagickGetImageColors">MagickGetImageColors</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2361<div class="doc-section">
2362
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2363<p>MagickGetImageColors() gets the number of unique colors in the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2364
2365<p>The format of the MagickGetImageColors method is:</p>
2366
2367<pre class="code">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]2368 size_t MagickGetImageColors(MagickWand *wand)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2369</pre>
2370
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2371<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2372
2373<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2374<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2375
2376 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]2377<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2378_8c.html" id="MagickGetImageColorspace">MagickGetImageColorspace</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2379<div class="doc-section">
2380
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2381<p>MagickGetImageColorspace() gets the image colorspace.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2382
2383<p>The format of the MagickGetImageColorspace method is:</p>
2384
2385<pre class="code">
2386 ColorspaceType MagickGetImageColorspace(MagickWand *wand)
2387</pre>
2388
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2389<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2390
2391<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2392<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2393
2394 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]2395<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2396_8c.html" id="MagickGetImageCompose">MagickGetImageCompose</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2397<div class="doc-section">
2398
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2399<p>MagickGetImageCompose() returns the composite operator associated with the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2400
2401<p>The format of the MagickGetImageCompose method is:</p>
2402
2403<pre class="code">
2404 CompositeOperator MagickGetImageCompose(MagickWand *wand)
2405</pre>
2406
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2407<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2408
2409<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2410<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2411
2412 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]2413<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2414_8c.html" id="MagickGetImageCompression">MagickGetImageCompression</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2415<div class="doc-section">
2416
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2417<p>MagickGetImageCompression() gets the image compression.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2418
2419<p>The format of the MagickGetImageCompression method is:</p>
2420
2421<pre class="code">
2422 CompressionType MagickGetImageCompression(MagickWand *wand)
2423</pre>
2424
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2425<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2426
2427<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2428<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2429
2430 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]2431<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2432_8c.html" id="MagickGetImageCompression">MagickGetImageCompression</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2433<div class="doc-section">
2434
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2435<p>MagickGetImageCompression() gets the image compression quality.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2436
2437<p>The format of the MagickGetImageCompression method is:</p>
2438
2439<pre class="code">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]2440 size_t MagickGetImageCompression(MagickWand *wand)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2441</pre>
2442
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2443<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2444
2445<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2446<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2447
2448 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]2449<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2450_8c.html" id="MagickGetImageDelay">MagickGetImageDelay</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2451<div class="doc-section">
2452
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2453<p>MagickGetImageDelay() gets the image delay.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2454
2455<p>The format of the MagickGetImageDelay method is:</p>
2456
2457<pre class="code">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]2458 size_t MagickGetImageDelay(MagickWand *wand)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2459</pre>
2460
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2461<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2462
2463<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2464<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2465
2466 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]2467<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2468_8c.html" id="MagickGetImageDepth">MagickGetImageDepth</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2469<div class="doc-section">
2470
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2471<p>MagickGetImageDepth() gets the image depth.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2472
2473<p>The format of the MagickGetImageDepth method is:</p>
2474
2475<pre class="code">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]2476 size_t MagickGetImageDepth(MagickWand *wand)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2477</pre>
2478
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2479<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2480
2481<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2482<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2483
2484 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]2485<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2486_8c.html" id="MagickGetImageDistortion">MagickGetImageDistortion</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2487<div class="doc-section">
2488
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2489<p>MagickGetImageDistortion() compares an image to a reconstructed image and returns the specified distortion metric.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2490
2491<p>The format of the MagickGetImageDistortion method is:</p>
2492
2493<pre class="code">
2494 MagickBooleanType MagickGetImageDistortion(MagickWand *wand,
2495 const MagickWand *reference,const MetricType metric,
2496 double *distortion)
2497</pre>
2498
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2499<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2500
2501<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2502<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2503
2504<h5>reference</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2505<p>the reference wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2506
2507<h5>metric</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2508<p>the metric.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2509
2510<h5>distortion</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2511<p>the computed distortion between the images.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2512
2513 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]2514<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2515_8c.html" id="MagickGetImageDispose">MagickGetImageDispose</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2516<div class="doc-section">
2517
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2518<p>MagickGetImageDispose() gets the image disposal method.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2519
2520<p>The format of the MagickGetImageDispose method is:</p>
2521
2522<pre class="code">
2523 DisposeType MagickGetImageDispose(MagickWand *wand)
2524</pre>
2525
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2526<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2527
2528<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2529<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2530
2531 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]2532<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2533_8c.html" id="MagickGetImageFilename">MagickGetImageFilename</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2534<div class="doc-section">
2535
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2536<p>MagickGetImageFilename() returns the filename of a particular image in a sequence.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2537
2538<p>The format of the MagickGetImageFilename method is:</p>
2539
2540<pre class="code">
2541 char *MagickGetImageFilename(MagickWand *wand)
2542</pre>
2543
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2544<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2545
2546<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2547<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2548
2549 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]2550<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2551_8c.html" id="MagickGetImageFormat">MagickGetImageFormat</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2552<div class="doc-section">
2553
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2554<p>MagickGetImageFormat() returns the format of a particular image in a sequence.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2555
2556<p>The format of the MagickGetImageFormat method is:</p>
2557
2558<pre class="code">
cristya8902942010-07-30 00:49:52 +0000[diff] [blame]2559 const char *MagickGetImageFormat(MagickWand *wand)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2560</pre>
2561
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2562<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2563
2564<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2565<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2566
2567 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]2568<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2569_8c.html" id="MagickGetImageFuzz">MagickGetImageFuzz</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2570<div class="doc-section">
2571
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2572<p>MagickGetImageFuzz() gets the image fuzz.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2573
2574<p>The format of the MagickGetImageFuzz method is:</p>
2575
2576<pre class="code">
2577 double MagickGetImageFuzz(MagickWand *wand)
2578</pre>
2579
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2580<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2581
2582<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2583<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2584
2585 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]2586<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2587_8c.html" id="MagickGetImageGamma">MagickGetImageGamma</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2588<div class="doc-section">
2589
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2590<p>MagickGetImageGamma() gets the image gamma.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2591
2592<p>The format of the MagickGetImageGamma method is:</p>
2593
2594<pre class="code">
2595 double MagickGetImageGamma(MagickWand *wand)
2596</pre>
2597
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2598<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2599
2600<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2601<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2602
2603 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]2604<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2605_8c.html" id="MagickGetImageGravity">MagickGetImageGravity</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2606<div class="doc-section">
2607
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2608<p>MagickGetImageGravity() gets the image gravity.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2609
2610<p>The format of the MagickGetImageGravity method is:</p>
2611
2612<pre class="code">
2613 GravityType MagickGetImageGravity(MagickWand *wand)
2614</pre>
2615
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2616<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2617
2618<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2619<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2620
2621 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]2622<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2623_8c.html" id="MagickGetImageGreenPrimary">MagickGetImageGreenPrimary</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2624<div class="doc-section">
2625
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2626<p>MagickGetImageGreenPrimary() returns the chromaticy green primary point.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2627
2628<p>The format of the MagickGetImageGreenPrimary method is:</p>
2629
2630<pre class="code">
2631 MagickBooleanType MagickGetImageGreenPrimary(MagickWand *wand,double *x,
2632 double *y)
2633</pre>
2634
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2635<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2636
2637<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2638<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2639
2640<h5>x</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2641<p>the chromaticity green primary x-point.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2642
2643<h5>y</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2644<p>the chromaticity green primary y-point.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2645
2646 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]2647<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2648_8c.html" id="MagickGetImageHeight">MagickGetImageHeight</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2649<div class="doc-section">
2650
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2651<p>MagickGetImageHeight() returns the image height.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2652
2653<p>The format of the MagickGetImageHeight method is:</p>
2654
2655<pre class="code">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]2656 size_t MagickGetImageHeight(MagickWand *wand)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2657</pre>
2658
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2659<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2660
2661<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2662<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2663
2664 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]2665<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2666_8c.html" id="MagickGetImageHistogram">MagickGetImageHistogram</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2667<div class="doc-section">
2668
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2669<p>MagickGetImageHistogram() returns the image histogram as an array of PixelWand wands.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2670
2671<p>The format of the MagickGetImageHistogram method is:</p>
2672
2673<pre class="code">
2674 PixelWand **MagickGetImageHistogram(MagickWand *wand,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]2675 size_t *number_colors)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2676</pre>
2677
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2678<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2679
2680<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2681<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2682
2683<h5>number_colors</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2684<p>the number of unique colors in the image and the number of pixel wands returned.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2685
2686 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]2687<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2688_8c.html" id="MagickGetImageInterlaceScheme">MagickGetImageInterlaceScheme</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2689<div class="doc-section">
2690
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2691<p>MagickGetImageInterlaceScheme() gets the image interlace scheme.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2692
2693<p>The format of the MagickGetImageInterlaceScheme method is:</p>
2694
2695<pre class="code">
2696 InterlaceType MagickGetImageInterlaceScheme(MagickWand *wand)
2697</pre>
2698
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2699<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2700
2701<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2702<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2703
2704 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]2705<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2706_8c.html" id="MagickGetImageInterpolateMethod">MagickGetImageInterpolateMethod</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2707<div class="doc-section">
2708
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2709<p>MagickGetImageInterpolateMethod() returns the interpolation method for the sepcified image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2710
2711<p>The format of the MagickGetImageInterpolateMethod method is:</p>
2712
2713<pre class="code">
2714 InterpolatePixelMethod MagickGetImageInterpolateMethod(MagickWand *wand)
2715</pre>
2716
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2717<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2718
2719<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2720<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2721
2722 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]2723<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2724_8c.html" id="MagickGetImageIterations">MagickGetImageIterations</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2725<div class="doc-section">
2726
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2727<p>MagickGetImageIterations() gets the image iterations.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2728
2729<p>The format of the MagickGetImageIterations method is:</p>
2730
2731<pre class="code">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]2732 size_t MagickGetImageIterations(MagickWand *wand)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2733</pre>
2734
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2735<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2736
2737<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2738<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2739
2740 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]2741<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2742_8c.html" id="MagickGetImageLength">MagickGetImageLength</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2743<div class="doc-section">
2744
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2745<p>MagickGetImageLength() returns the image length in bytes.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2746
2747<p>The format of the MagickGetImageLength method is:</p>
2748
2749<pre class="code">
2750 MagickBooleanType MagickGetImageLength(MagickWand *wand,
2751 MagickSizeType *length)
2752</pre>
2753
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2754<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2755
2756<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2757<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2758
2759<h5>length</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2760<p>the image length in bytes.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2761
2762 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]2763<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2764_8c.html" id="MagickGetImageMatteColor">MagickGetImageMatteColor</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2765<div class="doc-section">
2766
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2767<p>MagickGetImageMatteColor() returns the image matte color.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2768
2769<p>The format of the MagickGetImageMatteColor method is:</p>
2770
2771<pre class="code">
2772 MagickBooleanType MagickGetImagematteColor(MagickWand *wand,
2773 PixelWand *matte_color)
2774</pre>
2775
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2776<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2777
2778<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2779<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2780
2781<h5>matte_color</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2782<p>Return the matte color.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2783
2784 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]2785<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2786_8c.html" id="MagickGetImageOrientation">MagickGetImageOrientation</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2787<div class="doc-section">
2788
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2789<p>MagickGetImageOrientation() returns the image orientation.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2790
2791<p>The format of the MagickGetImageOrientation method is:</p>
2792
2793<pre class="code">
2794 OrientationType MagickGetImageOrientation(MagickWand *wand)
2795</pre>
2796
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2797<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2798
2799<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2800<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2801
2802 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]2803<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2804_8c.html" id="MagickGetImagePage">MagickGetImagePage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2805<div class="doc-section">
2806
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2807<p>MagickGetImagePage() returns the page geometry associated with the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2808
2809<p>The format of the MagickGetImagePage method is:</p>
2810
2811<pre class="code">
2812 MagickBooleanType MagickGetImagePage(MagickWand *wand,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]2813 size_t *width,size_t *height,ssize_t *x,ssize_t *y)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2814</pre>
2815
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2816<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2817
2818<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2819<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2820
2821<h5>width</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2822<p>the page width.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2823
2824<h5>height</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2825<p>the page height.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2826
2827<h5>x</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2828<p>the page x-offset.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2829
2830<h5>y</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2831<p>the page y-offset.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2832
2833 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]2834<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2835_8c.html" id="MagickGetImagePixelColor">MagickGetImagePixelColor</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2836<div class="doc-section">
2837
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2838<p>MagickGetImagePixelColor() returns the color of the specified pixel.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2839
2840<p>The format of the MagickGetImagePixelColor method is:</p>
2841
2842<pre class="code">
2843 MagickBooleanType MagickGetImagePixelColor(MagickWand *wand,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]2844 const ssize_t x,const ssize_t y,PixelWand *color)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2845</pre>
2846
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2847<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2848
2849<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2850<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2851
2852<h5>x,y</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2853<p>the pixel offset into the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2854
2855<h5>color</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2856<p>Return the colormap color in this wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2857
2858 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]2859<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2860_8c.html" id="MagickGetImageRedPrimary">MagickGetImageRedPrimary</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2861<div class="doc-section">
2862
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2863<p>MagickGetImageRedPrimary() returns the chromaticy red primary point.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2864
2865<p>The format of the MagickGetImageRedPrimary method is:</p>
2866
2867<pre class="code">
2868 MagickBooleanType MagickGetImageRedPrimary(MagickWand *wand,double *x,
2869 double *y)
2870</pre>
2871
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2872<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2873
2874<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2875<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2876
2877<h5>x</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2878<p>the chromaticity red primary x-point.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2879
2880<h5>y</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2881<p>the chromaticity red primary y-point.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2882
2883 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]2884<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2885_8c.html" id="MagickGetImageRegion">MagickGetImageRegion</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2886<div class="doc-section">
2887
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2888<p>MagickGetImageRegion() extracts a region of the image and returns it as a a new wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2889
2890<p>The format of the MagickGetImageRegion method is:</p>
2891
2892<pre class="code">
2893 MagickWand *MagickGetImageRegion(MagickWand *wand,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]2894 const size_t width,const size_t height,const ssize_t x,
2895 const ssize_t y)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2896</pre>
2897
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2898<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2899
2900<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2901<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2902
2903<h5>width</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2904<p>the region width.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2905
2906<h5>height</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2907<p>the region height.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2908
2909<h5>x</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2910<p>the region x offset.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2911
2912<h5>y</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2913<p>the region y offset.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2914
2915 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]2916<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2917_8c.html" id="MagickGetImageRenderingIntent">MagickGetImageRenderingIntent</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2918<div class="doc-section">
2919
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2920<p>MagickGetImageRenderingIntent() gets the image rendering intent.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2921
2922<p>The format of the MagickGetImageRenderingIntent method is:</p>
2923
2924<pre class="code">
2925 RenderingIntent MagickGetImageRenderingIntent(MagickWand *wand)
2926</pre>
2927
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2928<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2929
2930<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2931<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2932
2933 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]2934<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2935_8c.html" id="MagickGetImageResolution">MagickGetImageResolution</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2936<div class="doc-section">
2937
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2938<p>MagickGetImageResolution() gets the image X and Y resolution.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2939
2940<p>The format of the MagickGetImageResolution method is:</p>
2941
2942<pre class="code">
2943 MagickBooleanType MagickGetImageResolution(MagickWand *wand,double *x,
2944 double *y)
2945</pre>
2946
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2947<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2948
2949<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2950<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2951
2952<h5>x</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2953<p>the image x-resolution.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2954
2955<h5>y</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2956<p>the image y-resolution.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2957
2958 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]2959<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2960_8c.html" id="MagickGetImageScene">MagickGetImageScene</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2961<div class="doc-section">
2962
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2963<p>MagickGetImageScene() gets the image scene.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2964
2965<p>The format of the MagickGetImageScene method is:</p>
2966
2967<pre class="code">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]2968 size_t MagickGetImageScene(MagickWand *wand)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2969</pre>
2970
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2971<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2972
2973<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2974<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2975
2976 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]2977<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2978_8c.html" id="MagickGetImageSignature">MagickGetImageSignature</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2979<div class="doc-section">
2980
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2981<p>MagickGetImageSignature() generates an SHA-256 message digest for the image pixel stream.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2982
2983<p>The format of the MagickGetImageSignature method is:</p>
2984
2985<pre class="code">
2986 const char MagickGetImageSignature(MagickWand *wand)
2987</pre>
2988
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2989<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2990
2991<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2992<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2993
2994 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]2995<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2996_8c.html" id="MagickGetImageTicksPerSecond">MagickGetImageTicksPerSecond</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2997<div class="doc-section">
2998
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2999<p>MagickGetImageTicksPerSecond() gets the image ticks-per-second.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3000
3001<p>The format of the MagickGetImageTicksPerSecond method is:</p>
3002
3003<pre class="code">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]3004 size_t MagickGetImageTicksPerSecond(MagickWand *wand)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3005</pre>
3006
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3007<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3008
3009<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3010<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3011
3012 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]3013<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3014_8c.html" id="MagickGetImageType">MagickGetImageType</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3015<div class="doc-section">
3016
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3017<p>MagickGetImageType() gets the potential image type:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3018
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3019<p>Bilevel Grayscale GrayscaleMatte Palette PaletteMatte TrueColor TrueColorMatte ColorSeparation ColorSeparationMatte</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3020
3021<p>To ensure the image type matches its potential, use MagickSetImageType():</p>
3022
3023<pre class="text">
3024 (void) MagickSetImageType(wand,MagickGetImageType(wand));
3025</pre>
3026
3027<p>The format of the MagickGetImageType method is:</p>
3028
3029<pre class="code">
3030 ImageType MagickGetImageType(MagickWand *wand)
3031</pre>
3032
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3033<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3034
3035<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3036<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3037
3038 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]3039<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3040_8c.html" id="MagickGetImageUnits">MagickGetImageUnits</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3041<div class="doc-section">
3042
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3043<p>MagickGetImageUnits() gets the image units of resolution.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3044
3045<p>The format of the MagickGetImageUnits method is:</p>
3046
3047<pre class="code">
3048 ResolutionType MagickGetImageUnits(MagickWand *wand)
3049</pre>
3050
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3051<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3052
3053<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3054<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3055
3056 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]3057<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3058_8c.html" id="MagickGetImageVirtualPixelMethod">MagickGetImageVirtualPixelMethod</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3059<div class="doc-section">
3060
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3061<p>MagickGetImageVirtualPixelMethod() returns the virtual pixel method for the sepcified image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3062
3063<p>The format of the MagickGetImageVirtualPixelMethod method is:</p>
3064
3065<pre class="code">
3066 VirtualPixelMethod MagickGetImageVirtualPixelMethod(MagickWand *wand)
3067</pre>
3068
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3069<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3070
3071<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3072<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3073
3074 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]3075<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3076_8c.html" id="MagickGetImageWhitePoint">MagickGetImageWhitePoint</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3077<div class="doc-section">
3078
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3079<p>MagickGetImageWhitePoint() returns the chromaticy white point.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3080
3081<p>The format of the MagickGetImageWhitePoint method is:</p>
3082
3083<pre class="code">
3084 MagickBooleanType MagickGetImageWhitePoint(MagickWand *wand,double *x,
3085 double *y)
3086</pre>
3087
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3088<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3089
3090<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3091<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3092
3093<h5>x</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3094<p>the chromaticity white x-point.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3095
3096<h5>y</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3097<p>the chromaticity white y-point.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3098
3099 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]3100<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3101_8c.html" id="MagickGetImageWidth">MagickGetImageWidth</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3102<div class="doc-section">
3103
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3104<p>MagickGetImageWidth() returns the image width.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3105
3106<p>The format of the MagickGetImageWidth method is:</p>
3107
3108<pre class="code">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]3109 size_t MagickGetImageWidth(MagickWand *wand)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3110</pre>
3111
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3112<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3113
3114<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3115<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3116
3117 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]3118<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3119_8c.html" id="MagickGetNumberImages">MagickGetNumberImages</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3120<div class="doc-section">
3121
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3122<p>MagickGetNumberImages() returns the number of images associated with a magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3123
3124<p>The format of the MagickGetNumberImages method is:</p>
3125
3126<pre class="code">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]3127 size_t MagickGetNumberImages(MagickWand *wand)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3128</pre>
3129
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3130<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3131
3132<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3133<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3134
3135 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]3136<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3137_8c.html" id="MagickGetImageTotalInkDensity">MagickGetImageTotalInkDensity</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3138<div class="doc-section">
3139
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3140<p>MagickGetImageTotalInkDensity() gets the image total ink density.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3141
3142<p>The format of the MagickGetImageTotalInkDensity method is:</p>
3143
3144<pre class="code">
3145 double MagickGetImageTotalInkDensity(MagickWand *wand)
3146</pre>
3147
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3148<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3149
3150<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3151<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3152
3153 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]3154<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3155_8c.html" id="MagickHaldClutImage">MagickHaldClutImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3156<div class="doc-section">
3157
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3158<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3159
3160<p>The format of the MagickHaldClutImage method is:</p>
3161
3162<pre class="code">
3163 MagickBooleanType MagickHaldClutImage(MagickWand *wand,
3164 const MagickWand *hald_wand)
3165 MagickBooleanType MagickHaldClutImageChannel(MagickWand *wand,
3166 const ChannelType channel,const MagickWand *hald_wand)
3167</pre>
3168
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3169<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3170
3171<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3172<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3173
3174<h5>hald_image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3175<p>the hald CLUT image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3176
3177 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]3178<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3179_8c.html" id="MagickHasNextImage">MagickHasNextImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3180<div class="doc-section">
3181
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3182<p>MagickHasNextImage() returns MagickTrue if the wand has more images when traversing the list in the forward direction</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3183
3184<p>The format of the MagickHasNextImage method is:</p>
3185
3186<pre class="code">
3187 MagickBooleanType MagickHasNextImage(MagickWand *wand)
3188</pre>
3189
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3190<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3191
3192<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3193<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3194
3195 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]3196<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3197_8c.html" id="MagickHasPreviousImage">MagickHasPreviousImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3198<div class="doc-section">
3199
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3200<p>MagickHasPreviousImage() returns MagickTrue if the wand has more images when traversing the list in the reverse direction</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3201
3202<p>The format of the MagickHasPreviousImage method is:</p>
3203
3204<pre class="code">
3205 MagickBooleanType MagickHasPreviousImage(MagickWand *wand)
3206</pre>
3207
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3208<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3209
3210<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3211<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3212
3213 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]3214<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3215_8c.html" id="MagickIdentifyImage">MagickIdentifyImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3216<div class="doc-section">
3217
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3218<p>MagickIdentifyImage() identifies an image by printing its attributes to the file. Attributes include the image width, height, size, and others.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3219
3220<p>The format of the MagickIdentifyImage method is:</p>
3221
3222<pre class="code">
3223 const char *MagickIdentifyImage(MagickWand *wand)
3224</pre>
3225
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3226<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3227
3228<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3229<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3230
3231 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]3232<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3233_8c.html" id="MagickImplodeImage">MagickImplodeImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3234<div class="doc-section">
3235
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3236<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3237
3238<p>The format of the MagickImplodeImage method is:</p>
3239
3240<pre class="code">
3241 MagickBooleanType MagickImplodeImage(MagickWand *wand,
3242 const double radius)
3243</pre>
3244
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3245<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3246
3247<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3248<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3249
3250<h5>amount</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3251<p>Define the extent of the implosion.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3252
3253 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]3254<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3255_8c.html" id="MagickImportImagePixels">MagickImportImagePixels</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3256<div class="doc-section">
3257
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3258<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3259
3260<p>Suppose your want to upload the first scanline of a 640x480 image from character data in red-green-blue order:</p>
3261
3262<pre class="text">
3263 MagickImportImagePixels(wand,0,0,640,1,"RGB",CharPixel,pixels);
3264</pre>
3265
3266<p>The format of the MagickImportImagePixels method is:</p>
3267
3268<pre class="code">
3269 MagickBooleanType MagickImportImagePixels(MagickWand *wand,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]3270 const ssize_t x,const ssize_t y,const size_t columns,
3271 const size_t rows,const char *map,const StorageType storage,
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3272 const void *pixels)
3273</pre>
3274
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3275<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3276
3277<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3278<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3279
3280<h5>x, y, columns, rows</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3281<p>These values define the perimeter of a region of pixels you want to define.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3282
3283<h5>map</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3284<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3285
3286<h5>storage</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3287<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3288
3289<h5>pixels</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3290<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3291
3292 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]3293<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3294_8c.html" id="MagickInverseFourierTransformImage">MagickInverseFourierTransformImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3295<div class="doc-section">
3296
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3297<p>MagickInverseFourierTransformImage() implements the inverse discrete Fourier transform (DFT) of the image either as a magnitude / phase or real / imaginary image pair.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3298
3299<p>The format of the MagickInverseFourierTransformImage method is:</p>
3300
3301<pre class="code">
3302 MagickBooleanType MagickInverseFourierTransformImage(
cristy5f2356f2009-11-16 00:40:46 +0000[diff] [blame]3303 MagickWand *magnitude_wand,MagickWand *phase_wand,
3304 const MagickBooleanType magnitude)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3305</pre>
3306
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3307<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3308
cristy5f2356f2009-11-16 00:40:46 +0000[diff] [blame]3309<h5>magnitude_wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3310<p>the magnitude or real wand.</p>
cristy5f2356f2009-11-16 00:40:46 +0000[diff] [blame]3311
3312<h5>phase_wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3313<p>the phase or imaginary wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3314
3315<h5>magnitude</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3316<p>if true, return as magnitude / phase pair otherwise a real / imaginary image pair.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3317
3318 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]3319<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3320_8c.html" id="MagickLabelImage">MagickLabelImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3321<div class="doc-section">
3322
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3323<p>MagickLabelImage() adds a label to your image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3324
3325<p>The format of the MagickLabelImage method is:</p>
3326
3327<pre class="code">
3328 MagickBooleanType MagickLabelImage(MagickWand *wand,const char *label)
3329</pre>
3330
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3331<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3332
3333<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3334<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3335
3336<h5>label</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3337<p>the image label.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3338
3339 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]3340<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3341_8c.html" id="MagickLevelImage">MagickLevelImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3342<div class="doc-section">
3343
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3344<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3345
3346<p>The format of the MagickLevelImage method is:</p>
3347
3348<pre class="code">
3349 MagickBooleanType MagickLevelImage(MagickWand *wand,
3350 const double black_point,const double gamma,const double white_point)
3351 MagickBooleanType MagickLevelImageChannel(MagickWand *wand,
3352 const ChannelType channel,const double black_point,const double gamma,
3353 const double white_point)
3354</pre>
3355
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3356<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3357
3358<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3359<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3360
3361<h5>channel</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3362<p>Identify which channel to level: RedChannel, GreenChannel,</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3363
3364<h5>black_point</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3365<p>the black point.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3366
3367<h5>gamma</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3368<p>the gamma.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3369
3370<h5>white_point</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3371<p>the white point.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3372
3373 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]3374<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3375_8c.html" id="MagickLinearStretchImage">MagickLinearStretchImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3376<div class="doc-section">
3377
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3378<p>MagickLinearStretchImage() stretches with saturation the image intensity.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3379
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3380<p>You can also reduce the influence of a particular channel with a gamma value of 0.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3381
3382<p>The format of the MagickLinearStretchImage method is:</p>
3383
3384<pre class="code">
3385 MagickBooleanType MagickLinearStretchImage(MagickWand *wand,
3386 const double black_point,const double white_point)
3387</pre>
3388
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3389<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3390
3391<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3392<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3393
3394<h5>black_point</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3395<p>the black point.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3396
3397<h5>white_point</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3398<p>the white point.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3399
3400 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]3401<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3402_8c.html" id="MagickLiquidRescaleImage">MagickLiquidRescaleImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3403<div class="doc-section">
3404
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3405<p>MagickLiquidRescaleImage() rescales image with seam carving.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3406
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3407<p>MagickBooleanType MagickLiquidRescaleImage(MagickWand *wand, const size_t columns,const size_t rows, const double delta_x,const double rigidity)</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3408
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3409<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3410
3411<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3412<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3413
3414<h5>columns</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3415<p>the number of columns in the scaled image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3416
3417<h5>rows</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3418<p>the number of rows in the scaled image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3419
3420<h5>delta_x</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3421<p>maximum seam transversal step (0 means straight seams).</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3422
3423<h5>rigidity</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3424<p>introduce a bias for non-straight seams (typically 0).</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3425
3426 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]3427<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3428_8c.html" id="MagickMagnifyImage">MagickMagnifyImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3429<div class="doc-section">
3430
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3431<p>MagickMagnifyImage() is a convenience method that scales an image proportionally to twice its original size.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3432
3433<p>The format of the MagickMagnifyImage method is:</p>
3434
3435<pre class="code">
3436 MagickBooleanType MagickMagnifyImage(MagickWand *wand)
3437</pre>
3438
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3439<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3440
3441<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3442<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3443
3444 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]3445<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3446_8c.html" id="MagickMedianFilterImage">MagickMedianFilterImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3447<div class="doc-section">
3448
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3449<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3450
3451<p>The format of the MagickMedianFilterImage method is:</p>
3452
3453<pre class="code">
3454 MagickBooleanType MagickMedianFilterImage(MagickWand *wand,
3455 const double radius)
3456</pre>
3457
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3458<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3459
3460<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3461<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3462
3463<h5>radius</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3464<p>the radius of the pixel neighborhood.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3465
3466 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]3467<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3468_8c.html" id="MagickMergeImageLayers">MagickMergeImageLayers</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3469<div class="doc-section">
3470
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3471<p>MagickMergeImageLayers() composes all the image layers from the current given image onward to produce a single image of the merged layers.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3472
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3473<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3474
3475<p>The format of the MagickMergeImageLayers method is:</p>
3476
3477<pre class="code">
3478 MagickWand *MagickMergeImageLayers(MagickWand *wand,
3479 const ImageLayerMethod method)
3480</pre>
3481
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3482<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3483
3484<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3485<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3486
3487<h5>method</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3488<p>the method of selecting the size of the initial canvas.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3489
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3490<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3491
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3492<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3493
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3494<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3495
3496 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]3497<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3498_8c.html" id="MagickMinifyImage">MagickMinifyImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3499<div class="doc-section">
3500
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3501<p>MagickMinifyImage() is a convenience method that scales an image proportionally to one-half its original size</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3502
3503<p>The format of the MagickMinifyImage method is:</p>
3504
3505<pre class="code">
3506 MagickBooleanType MagickMinifyImage(MagickWand *wand)
3507</pre>
3508
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3509<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3510
3511<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3512<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3513
3514 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]3515<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3516_8c.html" id="MagickModulateImage">MagickModulateImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3517<div class="doc-section">
3518
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3519<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3520
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3521<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3522
3523<p>The format of the MagickModulateImage method is:</p>
3524
3525<pre class="code">
3526 MagickBooleanType MagickModulateImage(MagickWand *wand,
3527 const double brightness,const double saturation,const double hue)
3528</pre>
3529
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3530<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3531
3532<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3533<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3534
3535<h5>brightness</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3536<p>the percent change in brighness.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3537
3538<h5>saturation</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3539<p>the percent change in saturation.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3540
3541<h5>hue</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3542<p>the percent change in hue.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3543
3544 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]3545<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3546_8c.html" id="MagickMontageImage">MagickMontageImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3547<div class="doc-section">
3548
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3549<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3550
3551<p>The format of the MagickMontageImage method is:</p>
3552
3553<pre class="code">
3554 MagickWand *MagickMontageImage(MagickWand *wand,
3555 const DrawingWand drawing_wand,const char *tile_geometry,
3556 const char *thumbnail_geometry,const MontageMode mode,
3557 const char *frame)
3558</pre>
3559
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3560<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3561
3562<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3563<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3564
3565<h5>drawing_wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3566<p>the drawing wand. The font name, size, and color are obtained from this wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3567
3568<h5>tile_geometry</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3569<p>the number of tiles per row and page (e.g. 6x4+0+0).</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3570
3571<h5>thumbnail_geometry</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3572<p>Preferred image size and border size of each thumbnail (e.g. 120x120+4+3>).</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3573
3574<h5>mode</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3575<p>Thumbnail framing mode: Frame, Unframe, or Concatenate.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3576
3577<h5>frame</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3578<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3579
3580 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]3581<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3582_8c.html" id="MagickMorphImages">MagickMorphImages</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3583<div class="doc-section">
3584
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3585<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3586
3587<p>The format of the MagickMorphImages method is:</p>
3588
3589<pre class="code">
3590 MagickWand *MagickMorphImages(MagickWand *wand,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]3591 const size_t number_frames)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3592</pre>
3593
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3594<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3595
3596<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3597<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3598
3599<h5>number_frames</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3600<p>the number of in-between images to generate.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3601
3602 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]3603<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3604_8c.html" id="MagickMorphologyImage">MagickMorphologyImage</a></h2>
cristy488844c2010-01-22 14:02:05 +0000[diff] [blame]3605<div class="doc-section">
3606
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3607<p>MagickMorphologyImage() applies a user supplied kernel to the image according to the given mophology method.</p>
cristy488844c2010-01-22 14:02:05 +0000[diff] [blame]3608
3609<p>The format of the MagickMorphologyImage method is:</p>
3610
3611<pre class="code">
3612 MagickBooleanType MagickMorphologyImage(MagickWand *wand,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]3613 MorphologyMethod method,const ssize_t iterations,KernelInfo *kernel)
cristy488844c2010-01-22 14:02:05 +0000[diff] [blame]3614 MagickBooleanType MagickMorphologyImageChannel(MagickWand *wand,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]3615 ChannelType channel,MorphologyMethod method,const ssize_t iterations,
cristy488844c2010-01-22 14:02:05 +0000[diff] [blame]3616 KernelInfo *kernel)
3617</pre>
3618
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3619<p>A description of each parameter follows:</p>
cristy488844c2010-01-22 14:02:05 +0000[diff] [blame]3620
3621<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3622<p>the magick wand.</p>
cristy488844c2010-01-22 14:02:05 +0000[diff] [blame]3623
3624<h5>channel</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3625<p>the image channel(s).</p>
cristy488844c2010-01-22 14:02:05 +0000[diff] [blame]3626
3627<h5>method</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3628<p>the morphology method to be applied.</p>
cristy488844c2010-01-22 14:02:05 +0000[diff] [blame]3629
3630<h5>iterations</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3631<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>
cristy488844c2010-01-22 14:02:05 +0000[diff] [blame]3632
3633<h5>kernel</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3634<p>An array of doubles representing the morphology kernel.</p>
cristy488844c2010-01-22 14:02:05 +0000[diff] [blame]3635
3636 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]3637<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3638_8c.html" id="MagickMotionBlurImage">MagickMotionBlurImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3639<div class="doc-section">
3640
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3641<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3642
3643<p>The format of the MagickMotionBlurImage method is:</p>
3644
3645<pre class="code">
3646 MagickBooleanType MagickMotionBlurImage(MagickWand *wand,
3647 const double radius,const double sigma,const double angle)
3648 MagickBooleanType MagickMotionBlurImageChannel(MagickWand *wand,
3649 const ChannelType channel,const double radius,const double sigma,
3650 const double angle)
3651</pre>
3652
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3653<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3654
3655<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3656<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3657
3658<h5>channel</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3659<p>the image channel(s).</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3660
3661<h5>radius</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3662<p>the radius of the Gaussian, in pixels, not counting the center pixel.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3663
3664<h5>sigma</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3665<p>the standard deviation of the Gaussian, in pixels.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3666
3667<h5>angle</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3668<p>Apply the effect along this angle.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3669
3670 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]3671<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3672_8c.html" id="MagickNegateImage">MagickNegateImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3673<div class="doc-section">
3674
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3675<p>MagickNegateImage() negates the colors in the reference image. The Grayscale option means that only grayscale values within the image are negated.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3676
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3677<p>You can also reduce the influence of a particular channel with a gamma value of 0.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3678
3679<p>The format of the MagickNegateImage method is:</p>
3680
3681<pre class="code">
3682 MagickBooleanType MagickNegateImage(MagickWand *wand,
3683 const MagickBooleanType gray)
3684 MagickBooleanType MagickNegateImage(MagickWand *wand,
3685 const ChannelType channel,const MagickBooleanType gray)
3686</pre>
3687
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3688<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3689
3690<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3691<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3692
3693<h5>channel</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3694<p>the image channel(s).</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3695
3696<h5>gray</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3697<p>If MagickTrue, only negate grayscale pixels within the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3698
3699 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]3700<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3701_8c.html" id="MagickNewImage">MagickNewImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3702<div class="doc-section">
3703
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3704<p>MagickNewImage() adds a blank image canvas of the specified size and background color to the wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3705
3706<p>The format of the MagickNewImage method is:</p>
3707
3708<pre class="code">
3709 MagickBooleanType MagickNewImage(MagickWand *wand,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]3710 const size_t columns,const size_t rows,
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3711 const PixelWand *background)
3712</pre>
3713
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3714<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3715
3716<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3717<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3718
3719<h5>width</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3720<p>the image width.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3721
3722<h5>height</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3723<p>the image height.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3724
3725<h5>background</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3726<p>the image color.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3727
3728 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]3729<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3730_8c.html" id="MagickNextImage">MagickNextImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3731<div class="doc-section">
3732
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3733<p>MagickNextImage() associates the next image in the image list with a magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3734
3735<p>The format of the MagickNextImage method is:</p>
3736
3737<pre class="code">
3738 MagickBooleanType MagickNextImage(MagickWand *wand)
3739</pre>
3740
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3741<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3742
3743<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3744<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3745
3746 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]3747<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3748_8c.html" id="MagickNormalizeImage">MagickNormalizeImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3749<div class="doc-section">
3750
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3751<p>MagickNormalizeImage() enhances the contrast of a color image by adjusting the pixels color to span the entire range of colors available</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3752
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3753<p>You can also reduce the influence of a particular channel with a gamma value of 0.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3754
3755<p>The format of the MagickNormalizeImage method is:</p>
3756
3757<pre class="code">
3758 MagickBooleanType MagickNormalizeImage(MagickWand *wand)
3759 MagickBooleanType MagickNormalizeImageChannel(MagickWand *wand,
3760 const ChannelType channel)
3761</pre>
3762
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3763<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3764
3765<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3766<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3767
3768<h5>channel</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3769<p>the image channel(s).</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3770
3771 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]3772<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3773_8c.html" id="MagickOilPaintImage">MagickOilPaintImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3774<div class="doc-section">
3775
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3776<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3777
3778<p>The format of the MagickOilPaintImage method is:</p>
3779
3780<pre class="code">
3781 MagickBooleanType MagickOilPaintImage(MagickWand *wand,
3782 const double radius)
3783</pre>
3784
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3785<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3786
3787<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3788<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3789
3790<h5>radius</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3791<p>the radius of the circular neighborhood.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3792
3793 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]3794<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3795_8c.html" id="MagickOpaquePaintImage">MagickOpaquePaintImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3796<div class="doc-section">
3797
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3798<p>MagickOpaquePaintImage() changes any pixel that matches color with the color defined by fill.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3799
3800<p>The format of the MagickOpaquePaintImage method is:</p>
3801
3802<pre class="code">
3803 MagickBooleanType MagickOpaquePaintImage(MagickWand *wand,
3804 const PixelWand *target,const PixelWand *fill,const double fuzz,
3805 const MagickBooleanType invert)
3806 MagickBooleanType MagickOpaquePaintImageChannel(MagickWand *wand,
3807 const ChannelType channel,const PixelWand *target,
3808 const PixelWand *fill,const double fuzz,const MagickBooleanType invert)
3809</pre>
3810
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3811<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3812
3813<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3814<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3815
3816<h5>channel</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3817<p>the channel(s).</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3818
3819<h5>target</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3820<p>Change this target color to the fill color within the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3821
3822<h5>fill</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3823<p>the fill pixel wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3824
3825<h5>fuzz</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3826<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3827
3828<h5>invert</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3829<p>paint any pixel that does not match the target color.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3830
3831 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]3832<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3833_8c.html" id="MagickOptimizeImageLayers">MagickOptimizeImageLayers</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3834<div class="doc-section">
3835
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3836<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3837
3838<p>The format of the MagickOptimizeImageLayers method is:</p>
3839
3840<pre class="code">
3841 MagickWand *MagickOptimizeImageLayers(MagickWand *wand)
3842</pre>
3843
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3844<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3845
3846<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3847<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3848
3849 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]3850<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3851_8c.html" id="MagickOrderedPosterizeImage">MagickOrderedPosterizeImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3852<div class="doc-section">
3853
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3854<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3855
3856<p>The format of the MagickOrderedPosterizeImage method is:</p>
3857
3858<pre class="code">
3859 MagickBooleanType MagickOrderedPosterizeImage(MagickWand *wand,
3860 const char *threshold_map)
3861 MagickBooleanType MagickOrderedPosterizeImageChannel(MagickWand *wand,
3862 const ChannelType channel,const char *threshold_map)
3863</pre>
3864
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3865<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3866
3867<h5>image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3868<p>the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3869
3870<h5>channel</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3871<p>the channel or channels to be thresholded.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3872
3873<h5>threshold_map</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3874<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3875
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3876<p>Any level number less than 2 is equivelent to 2, and means only binary dithering will be applied to each color channel.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3877
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3878<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3879
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3880<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3881
3882 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]3883<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3884_8c.html" id="MagickPingImage">MagickPingImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3885<div class="doc-section">
3886
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3887<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3888
3889<p>The format of the MagickPingImage method is:</p>
3890
3891<pre class="code">
3892 MagickBooleanType MagickPingImage(MagickWand *wand,const char *filename)
3893</pre>
3894
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3895<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3896
3897<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3898<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3899
3900<h5>filename</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3901<p>the image filename.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3902
3903 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]3904<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3905_8c.html" id="MagickPingImageBlob">MagickPingImageBlob</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3906<div class="doc-section">
3907
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3908<p>MagickPingImageBlob() pings an image or image sequence from a blob.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3909
3910<p>The format of the MagickPingImageBlob method is:</p>
3911
3912<pre class="code">
3913 MagickBooleanType MagickPingImageBlob(MagickWand *wand,
3914 const void *blob,const size_t length)
3915</pre>
3916
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3917<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3918
3919<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3920<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3921
3922<h5>blob</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3923<p>the blob.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3924
3925<h5>length</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3926<p>the blob length.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3927
3928 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]3929<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3930_8c.html" id="MagickPingImageFile">MagickPingImageFile</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3931<div class="doc-section">
3932
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3933<p>MagickPingImageFile() pings an image or image sequence from an open file descriptor.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3934
3935<p>The format of the MagickPingImageFile method is:</p>
3936
3937<pre class="code">
3938 MagickBooleanType MagickPingImageFile(MagickWand *wand,FILE *file)
3939</pre>
3940
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3941<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3942
3943<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3944<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3945
3946<h5>file</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3947<p>the file descriptor.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3948
3949 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]3950<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3951_8c.html" id="MagickPolaroidImage">MagickPolaroidImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3952<div class="doc-section">
3953
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3954<p>MagickPolaroidImage() simulates a Polaroid picture.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3955
3956<p>The format of the MagickPolaroidImage method is:</p>
3957
3958<pre class="code">
3959 MagickBooleanType MagickPolaroidImage(MagickWand *wand,
3960 const DrawingWand *drawing_wand,const double angle)
3961</pre>
3962
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3963<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3964
3965<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3966<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3967
3968<h5>drawing_wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3969<p>the draw wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3970
3971<h5>angle</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3972<p>Apply the effect along this angle.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3973
3974 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]3975<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3976_8c.html" id="MagickPosterizeImage">MagickPosterizeImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3977<div class="doc-section">
3978
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3979<p>MagickPosterizeImage() reduces the image to a limited number of color level.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3980
3981<p>The format of the MagickPosterizeImage method is:</p>
3982
3983<pre class="code">
3984 MagickBooleanType MagickPosterizeImage(MagickWand *wand,
3985 const unsigned levels,const MagickBooleanType dither)
3986</pre>
3987
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3988<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3989
3990<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3991<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3992
3993<h5>levels</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3994<p>Number of color levels allowed in each channel. Very low values (2, 3, or 4) have the most visible effect.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3995
3996<h5>dither</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3997<p>Set this integer value to something other than zero to dither the mapped image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3998
3999 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]4000<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4001_8c.html" id="MagickPreviewImages">MagickPreviewImages</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4002<div class="doc-section">
4003
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4004<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4005
4006<p>The format of the MagickPreviewImages method is:</p>
4007
4008<pre class="code">
4009 MagickWand *MagickPreviewImages(MagickWand *wand,
4010 const PreviewType preview)
4011</pre>
4012
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4013<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4014
4015<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4016<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4017
4018<h5>preview</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4019<p>the preview type.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4020
4021 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]4022<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4023_8c.html" id="MagickPreviousImage">MagickPreviousImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4024<div class="doc-section">
4025
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4026<p>MagickPreviousImage() assocates the previous image in an image list with the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4027
4028<p>The format of the MagickPreviousImage method is:</p>
4029
4030<pre class="code">
4031 MagickBooleanType MagickPreviousImage(MagickWand *wand)
4032</pre>
4033
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4034<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4035
4036<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4037<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4038
4039 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]4040<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4041_8c.html" id="MagickQuantizeImage">MagickQuantizeImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4042<div class="doc-section">
4043
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4044<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4045
4046<p>The format of the MagickQuantizeImage method is:</p>
4047
4048<pre class="code">
4049 MagickBooleanType MagickQuantizeImage(MagickWand *wand,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]4050 const size_t number_colors,const ColorspaceType colorspace,
4051 const size_t treedepth,const MagickBooleanType dither,
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4052 const MagickBooleanType measure_error)
4053</pre>
4054
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4055<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4056
4057<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4058<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4059
4060<h5>number_colors</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4061<p>the number of colors.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4062
4063<h5>colorspace</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4064<p>Perform color reduction in this colorspace, typically RGBColorspace.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4065
4066<h5>treedepth</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4067<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4068
4069<h5>dither</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4070<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4071
4072<h5>measure_error</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4073<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4074
4075 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]4076<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4077_8c.html" id="MagickQuantizeImages">MagickQuantizeImages</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4078<div class="doc-section">
4079
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4080<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4081
4082<p>The format of the MagickQuantizeImages method is:</p>
4083
4084<pre class="code">
4085 MagickBooleanType MagickQuantizeImages(MagickWand *wand,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]4086 const size_t number_colors,const ColorspaceType colorspace,
4087 const size_t treedepth,const MagickBooleanType dither,
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4088 const MagickBooleanType measure_error)
4089</pre>
4090
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4091<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4092
4093<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4094<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4095
4096<h5>number_colors</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4097<p>the number of colors.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4098
4099<h5>colorspace</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4100<p>Perform color reduction in this colorspace, typically RGBColorspace.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4101
4102<h5>treedepth</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4103<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4104
4105<h5>dither</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4106<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4107
4108<h5>measure_error</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4109<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4110
4111 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]4112<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4113_8c.html" id="MagickRadialBlurImage">MagickRadialBlurImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4114<div class="doc-section">
4115
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4116<p>MagickRadialBlurImage() radial blurs an image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4117
4118<p>The format of the MagickRadialBlurImage method is:</p>
4119
4120<pre class="code">
4121 MagickBooleanType MagickRadialBlurImage(MagickWand *wand,
4122 const double angle)
4123 MagickBooleanType MagickRadialBlurImageChannel(MagickWand *wand,
4124 const ChannelType channel,const double angle)
4125</pre>
4126
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4127<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4128
4129<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4130<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4131
4132<h5>channel</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4133<p>the image channel(s).</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4134
4135<h5>angle</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4136<p>the angle of the blur in degrees.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4137
4138 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]4139<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4140_8c.html" id="MagickRaiseImage">MagickRaiseImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4141<div class="doc-section">
4142
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4143<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4144
4145<p>The format of the MagickRaiseImage method is:</p>
4146
4147<pre class="code">
4148 MagickBooleanType MagickRaiseImage(MagickWand *wand,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]4149 const size_t width,const size_t height,const ssize_t x,
4150 const ssize_t y,const MagickBooleanType raise)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4151</pre>
4152
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4153<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4154
4155<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4156<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4157
4158<h5>width,height,x,y</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4159<p>Define the dimensions of the area to raise.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4160
4161<h5>raise</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4162<p>A value other than zero creates a 3-D raise effect, otherwise it has a lowered effect.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4163
4164 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]4165<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4166_8c.html" id="MagickRandomThresholdImage">MagickRandomThresholdImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4167<div class="doc-section">
4168
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4169<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4170
4171<p>The format of the MagickRandomThresholdImage method is:</p>
4172
4173<pre class="code">
4174 MagickBooleanType MagickRandomThresholdImage(MagickWand *wand,
4175 const double low,const double high)
4176 MagickBooleanType MagickRandomThresholdImageChannel(MagickWand *wand,
4177 const ChannelType channel,const double low,const double high)
4178</pre>
4179
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4180<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4181
4182<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4183<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4184
4185<h5>channel</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4186<p>the image channel(s).</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4187
4188<h5>low,high</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4189<p>Specify the high and low thresholds. These values range from 0 to QuantumRange.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4190
4191 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]4192<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4193_8c.html" id="MagickReadImage">MagickReadImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4194<div class="doc-section">
4195
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4196<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4197
4198<p>The format of the MagickReadImage method is:</p>
4199
4200<pre class="code">
4201 MagickBooleanType MagickReadImage(MagickWand *wand,const char *filename)
4202</pre>
4203
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4204<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4205
4206<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4207<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4208
4209<h5>filename</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4210<p>the image filename.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4211
4212 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]4213<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4214_8c.html" id="MagickReadImageBlob">MagickReadImageBlob</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4215<div class="doc-section">
4216
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4217<p>MagickReadImageBlob() reads an image or image sequence from a blob.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4218
4219<p>The format of the MagickReadImageBlob method is:</p>
4220
4221<pre class="code">
4222 MagickBooleanType MagickReadImageBlob(MagickWand *wand,
4223 const void *blob,const size_t length)
4224</pre>
4225
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4226<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4227
4228<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4229<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4230
4231<h5>blob</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4232<p>the blob.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4233
4234<h5>length</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4235<p>the blob length.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4236
4237 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]4238<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4239_8c.html" id="MagickReadImageFile">MagickReadImageFile</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4240<div class="doc-section">
4241
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4242<p>MagickReadImageFile() reads an image or image sequence from an open file descriptor.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4243
4244<p>The format of the MagickReadImageFile method is:</p>
4245
4246<pre class="code">
4247 MagickBooleanType MagickReadImageFile(MagickWand *wand,FILE *file)
4248</pre>
4249
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4250<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4251
4252<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4253<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4254
4255<h5>file</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4256<p>the file descriptor.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4257
4258 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]4259<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4260_8c.html" id="MagickReduceNoiseImage">MagickReduceNoiseImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4261<div class="doc-section">
4262
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4263<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4264
4265<p>The format of the MagickReduceNoiseImage method is:</p>
4266
4267<pre class="code">
4268 MagickBooleanType MagickReduceNoiseImage(MagickWand *wand,
4269 const double radius)
4270</pre>
4271
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4272<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4273
4274<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4275<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4276
4277<h5>radius</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4278<p>the radius of the pixel neighborhood.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4279
4280 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]4281<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4282_8c.html" id="MagickRemapImage">MagickRemapImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4283<div class="doc-section">
4284
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4285<p>MagickRemapImage() replaces the colors of an image with the closest color from a reference image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4286
4287<p>The format of the MagickRemapImage method is:</p>
4288
4289<pre class="code">
4290 MagickBooleanType MagickRemapImage(MagickWand *wand,
4291 const MagickWand *remap_wand,const DitherMethod method)
4292</pre>
4293
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4294<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4295
4296<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4297<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4298
4299<h5>affinity</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4300<p>the affinity wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4301
4302<h5>method</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4303<p>choose from these dither methods: NoDitherMethod, RiemersmaDitherMethod, or FloydSteinbergDitherMethod.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4304
4305 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]4306<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4307_8c.html" id="MagickRemoveImage">MagickRemoveImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4308<div class="doc-section">
4309
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4310<p>MagickRemoveImage() removes an image from the image list.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4311
4312<p>The format of the MagickRemoveImage method is:</p>
4313
4314<pre class="code">
4315 MagickBooleanType MagickRemoveImage(MagickWand *wand)
4316</pre>
4317
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4318<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4319
4320<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4321<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4322
4323<h5>insert</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4324<p>the splice wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4325
4326 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]4327<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4328_8c.html" id="MagickResampleImage">MagickResampleImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4329<div class="doc-section">
4330
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4331<p>MagickResampleImage() resample image to desired resolution.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4332
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4333<p>Bessel Blackman Box Catrom Cubic Gaussian Hanning Hermite Lanczos Mitchell Point Quandratic Sinc Triangle</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4334
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4335<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4336
4337<p>The format of the MagickResampleImage method is:</p>
4338
4339<pre class="code">
4340 MagickBooleanType MagickResampleImage(MagickWand *wand,
4341 const double x_resolution,const double y_resolution,
4342 const FilterTypes filter,const double blur)
4343</pre>
4344
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4345<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4346
4347<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4348<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4349
4350<h5>x_resolution</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4351<p>the new image x resolution.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4352
4353<h5>y_resolution</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4354<p>the new image y resolution.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4355
4356<h5>filter</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4357<p>Image filter to use.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4358
4359<h5>blur</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4360<p>the blur factor where > 1 is blurry, < 1 is sharp.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4361
4362 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]4363<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4364_8c.html" id="MagickResetImagePage">MagickResetImagePage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4365<div class="doc-section">
4366
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4367<p>MagickResetImagePage() resets the Wand page canvas and position.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4368
4369<p>The format of the MagickResetImagePage method is:</p>
4370
4371<pre class="code">
4372 MagickBooleanType MagickResetImagePage(MagickWand *wand,
4373 const char *page)
4374</pre>
4375
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4376<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4377
4378<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4379<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4380
4381<h5>page</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4382<p>the relative page specification.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4383
4384 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]4385<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4386_8c.html" id="MagickResizeImage">MagickResizeImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4387<div class="doc-section">
4388
4389<p>MagickResizeImage() scales an image to the desired dimensions with one of these filters:</p>
4390
4391<pre class="text">
4392 Bessel Blackman Box
4393 Catrom CubicGaussian
4394 Hanning Hermite Lanczos
4395 Mitchell PointQuandratic
4396 Sinc Triangle
4397</pre>
4398
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4399<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4400
4401<p>The format of the MagickResizeImage method is:</p>
4402
4403<pre class="code">
4404 MagickBooleanType MagickResizeImage(MagickWand *wand,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]4405 const size_t columns,const size_t rows,
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4406 const FilterTypes filter,const double blur)
4407</pre>
4408
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4409<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4410
4411<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4412<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4413
4414<h5>columns</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4415<p>the number of columns in the scaled image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4416
4417<h5>rows</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4418<p>the number of rows in the scaled image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4419
4420<h5>filter</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4421<p>Image filter to use.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4422
4423<h5>blur</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4424<p>the blur factor where > 1 is blurry, < 1 is sharp.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4425
4426 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]4427<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4428_8c.html" id="MagickRollImage">MagickRollImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4429<div class="doc-section">
4430
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4431<p>MagickRollImage() offsets an image as defined by x and y.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4432
4433<p>The format of the MagickRollImage method is:</p>
4434
4435<pre class="code">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]4436 MagickBooleanType MagickRollImage(MagickWand *wand,const ssize_t x,
4437 const size_t y)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4438</pre>
4439
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4440<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4441
4442<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4443<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4444
4445<h5>x</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4446<p>the x offset.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4447
4448<h5>y</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4449<p>the y offset.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4450
4451
4452 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]4453<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4454_8c.html" id="MagickRotateImage">MagickRotateImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4455<div class="doc-section">
4456
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4457<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4458
4459<p>The format of the MagickRotateImage method is:</p>
4460
4461<pre class="code">
4462 MagickBooleanType MagickRotateImage(MagickWand *wand,
4463 const PixelWand *background,const double degrees)
4464</pre>
4465
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4466<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4467
4468<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4469<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4470
4471<h5>background</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4472<p>the background pixel wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4473
4474<h5>degrees</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4475<p>the number of degrees to rotate the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4476
4477
4478 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]4479<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4480_8c.html" id="MagickSampleImage">MagickSampleImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4481<div class="doc-section">
4482
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4483<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4484
4485<p>The format of the MagickSampleImage method is:</p>
4486
4487<pre class="code">
4488 MagickBooleanType MagickSampleImage(MagickWand *wand,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]4489 const size_t columns,const size_t rows)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4490</pre>
4491
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4492<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4493
4494<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4495<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4496
4497<h5>columns</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4498<p>the number of columns in the scaled image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4499
4500<h5>rows</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4501<p>the number of rows in the scaled image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4502
4503
4504 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]4505<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4506_8c.html" id="MagickScaleImage">MagickScaleImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4507<div class="doc-section">
4508
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4509<p>MagickScaleImage() scales the size of an image to the given dimensions.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4510
4511<p>The format of the MagickScaleImage method is:</p>
4512
4513<pre class="code">
4514 MagickBooleanType MagickScaleImage(MagickWand *wand,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]4515 const size_t columns,const size_t rows)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4516</pre>
4517
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4518<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4519
4520<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4521<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4522
4523<h5>columns</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4524<p>the number of columns in the scaled image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4525
4526<h5>rows</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4527<p>the number of rows in the scaled image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4528
4529
4530 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]4531<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4532_8c.html" id="MagickSegmentImage">MagickSegmentImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4533<div class="doc-section">
4534
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4535<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4536
4537<p>The format of the SegmentImage method is:</p>
4538
4539<pre class="code">
4540 MagickBooleanType MagickSegmentImage(MagickWand *wand,
4541 const ColorspaceType colorspace,const MagickBooleanType verbose,
4542 const double cluster_threshold,const double smooth_threshold)
4543</pre>
4544
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4545<p>A description of each parameter follows.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4546
4547<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4548<p>the wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4549
4550<h5>colorspace</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4551<p>the image colorspace.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4552
4553<h5>verbose</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4554<p>Set to MagickTrue to print detailed information about the identified classes.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4555
4556<h5>cluster_threshold</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4557<p>This represents the minimum number of pixels contained in a hexahedra before it can be considered valid (expressed as a percentage).</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4558
4559<h5>smooth_threshold</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4560<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4561
4562 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]4563<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4564_8c.html" id="MagickSelectiveBlurImage">MagickSelectiveBlurImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4565<div class="doc-section">
4566
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4567<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4568
4569<p>The format of the MagickSelectiveBlurImage method is:</p>
4570
4571<pre class="code">
4572 MagickBooleanType MagickSelectiveBlurImage(MagickWand *wand,
4573 const double radius,const double sigma,const double threshold)
4574 MagickBooleanType MagickSelectiveBlurImageChannel(MagickWand *wand,
4575 const ChannelType channel,const double radius,const double sigma,
4576 const double threshold)
4577</pre>
4578
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4579<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4580
4581<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4582<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4583
4584<h5>channel</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4585<p>the image channel(s).</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4586
4587<h5>radius</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4588<p>the radius of the gaussian, in pixels, not counting the center pixel.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4589
4590<h5>sigma</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4591<p>the standard deviation of the gaussian, in pixels.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4592
4593<h5>threshold</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4594<p>only pixels within this contrast threshold are included in the blur operation.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4595
4596 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]4597<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4598_8c.html" id="MagickSeparateImageChannel">MagickSeparateImageChannel</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4599<div class="doc-section">
4600
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4601<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4602
4603<p>The format of the MagickSeparateImageChannel method is:</p>
4604
4605<pre class="code">
4606 MagickBooleanType MagickSeparateImageChannel(MagickWand *wand,
4607 const ChannelType channel)
4608</pre>
4609
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4610<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4611
4612<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4613<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4614
4615<h5>channel</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4616<p>the image channel(s).</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4617
4618 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]4619<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4620_8c.html" id="MagickSepiaToneImage">MagickSepiaToneImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4621<div class="doc-section">
4622
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4623<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4624
4625<p>The format of the MagickSepiaToneImage method is:</p>
4626
4627<pre class="code">
4628 MagickBooleanType MagickSepiaToneImage(MagickWand *wand,
4629 const double threshold)
4630</pre>
4631
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4632<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4633
4634<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4635<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4636
4637<h5>threshold</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4638<p>Define the extent of the sepia toning.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4639
4640 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]4641<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4642_8c.html" id="MagickSetImage">MagickSetImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4643<div class="doc-section">
4644
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4645<p>MagickSetImage() replaces the last image returned by MagickSetImageIndex(), MagickNextImage(), MagickPreviousImage() with the images from the specified wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4646
4647<p>The format of the MagickSetImage method is:</p>
4648
4649<pre class="code">
4650 MagickBooleanType MagickSetImage(MagickWand *wand,
4651 const MagickWand *set_wand)
4652</pre>
4653
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4654<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4655
4656<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4657<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4658
4659<h5>set_wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4660<p>the set_wand wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4661
4662 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]4663<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4664_8c.html" id="MagickSetImageAlphaChannel">MagickSetImageAlphaChannel</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4665<div class="doc-section">
4666
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4667<p>MagickSetImageAlphaChannel() activates, deactivates, resets, or sets the alpha channel.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4668
4669<p>The format of the MagickSetImageAlphaChannel method is:</p>
4670
4671<pre class="code">
4672 MagickBooleanType MagickSetImageAlphaChannel(MagickWand *wand,
4673 const AlphaChannelType alpha_type)
4674</pre>
4675
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4676<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4677
4678<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4679<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4680
4681<h5>alpha_type</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4682<p>the alpha channel type: ActivateAlphaChannel, DeactivateAlphaChannel, OpaqueAlphaChannel, or SetAlphaChannel.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4683
4684 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]4685<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4686_8c.html" id="MagickSetImageBackgroundColor">MagickSetImageBackgroundColor</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4687<div class="doc-section">
4688
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4689<p>MagickSetImageBackgroundColor() sets the image background color.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4690
4691<p>The format of the MagickSetImageBackgroundColor method is:</p>
4692
4693<pre class="code">
4694 MagickBooleanType MagickSetImageBackgroundColor(MagickWand *wand,
4695 const PixelWand *background)
4696</pre>
4697
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4698<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4699
4700<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4701<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4702
4703<h5>background</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4704<p>the background pixel wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4705
4706 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]4707<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4708_8c.html" id="MagickSetImageBias">MagickSetImageBias</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4709<div class="doc-section">
4710
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4711<p>MagickSetImageBias() sets the image bias for any method that convolves an image (e.g. MagickConvolveImage()).</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4712
4713<p>The format of the MagickSetImageBias method is:</p>
4714
4715<pre class="code">
4716 MagickBooleanType MagickSetImageBias(MagickWand *wand,
4717 const double bias)
4718</pre>
4719
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4720<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4721
4722<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4723<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4724
4725<h5>bias</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4726<p>the image bias.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4727
4728 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]4729<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4730_8c.html" id="MagickSetImageBluePrimary">MagickSetImageBluePrimary</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4731<div class="doc-section">
4732
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4733<p>MagickSetImageBluePrimary() sets the image chromaticity blue primary point.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4734
4735<p>The format of the MagickSetImageBluePrimary method is:</p>
4736
4737<pre class="code">
4738 MagickBooleanType MagickSetImageBluePrimary(MagickWand *wand,
4739 const double x,const double y)
4740</pre>
4741
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4742<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4743
4744<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4745<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4746
4747<h5>x</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4748<p>the blue primary x-point.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4749
4750<h5>y</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4751<p>the blue primary y-point.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4752
4753 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]4754<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4755_8c.html" id="MagickSetImageBorderColor">MagickSetImageBorderColor</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4756<div class="doc-section">
4757
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4758<p>MagickSetImageBorderColor() sets the image border color.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4759
4760<p>The format of the MagickSetImageBorderColor method is:</p>
4761
4762<pre class="code">
4763 MagickBooleanType MagickSetImageBorderColor(MagickWand *wand,
4764 const PixelWand *border)
4765</pre>
4766
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4767<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4768
4769<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4770<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4771
4772<h5>border</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4773<p>the border pixel wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4774
4775 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]4776<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4777_8c.html" id="MagickSetImageChannelDepth">MagickSetImageChannelDepth</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4778<div class="doc-section">
4779
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4780<p>MagickSetImageChannelDepth() sets the depth of a particular image channel.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4781
4782<p>The format of the MagickSetImageChannelDepth method is:</p>
4783
4784<pre class="code">
4785 MagickBooleanType MagickSetImageChannelDepth(MagickWand *wand,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]4786 const ChannelType channel,const size_t depth)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4787</pre>
4788
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4789<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4790
4791<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4792<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4793
4794<h5>channel</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4795<p>the image channel(s).</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4796
4797<h5>depth</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4798<p>the image depth in bits.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4799
4800 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]4801<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4802_8c.html" id="MagickSetImageClipMask">MagickSetImageClipMask</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4803<div class="doc-section">
4804
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4805<p>MagickSetImageClipMask() sets image clip mask.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4806
4807<p>The format of the MagickSetImageClipMask method is:</p>
4808
4809<pre class="code">
4810 MagickBooleanType MagickSetImageClipMask(MagickWand *wand,
4811 const MagickWand *clip_mask)
4812</pre>
4813
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4814<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4815
4816<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4817<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4818
4819<h5>clip_mask</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4820<p>the clip_mask wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4821
4822 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]4823<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4824_8c.html" id="MagickSetImageColor">MagickSetImageColor</a></h2>
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]4825<div class="doc-section">
4826
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4827<p>MagickSetImageColor() set the entire wand canvas to the specified color.</p>
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]4828
4829<p>The format of the MagickSetImageColor method is:</p>
4830
4831<pre class="code">
4832 MagickBooleanType MagickSetImageColor(MagickWand *wand,
4833 const PixelWand *color)
4834</pre>
4835
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4836<p>A description of each parameter follows:</p>
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]4837
4838<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4839<p>the magick wand.</p>
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]4840
4841<h5>background</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4842<p>the image color.</p>
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]4843
4844 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]4845<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4846_8c.html" id="MagickSetImageColormapColor">MagickSetImageColormapColor</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4847<div class="doc-section">
4848
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4849<p>MagickSetImageColormapColor() sets the color of the specified colormap index.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4850
4851<p>The format of the MagickSetImageColormapColor method is:</p>
4852
4853<pre class="code">
4854 MagickBooleanType MagickSetImageColormapColor(MagickWand *wand,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]4855 const size_t index,const PixelWand *color)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4856</pre>
4857
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4858<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4859
4860<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4861<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4862
4863<h5>index</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4864<p>the offset into the image colormap.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4865
4866<h5>color</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4867<p>Return the colormap color in this wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4868
4869 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]4870<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4871_8c.html" id="MagickSetImageColorspace">MagickSetImageColorspace</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4872<div class="doc-section">
4873
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4874<p>MagickSetImageColorspace() sets the image colorspace.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4875
4876<p>The format of the MagickSetImageColorspace method is:</p>
4877
4878<pre class="code">
4879 MagickBooleanType MagickSetImageColorspace(MagickWand *wand,
4880 const ColorspaceType colorspace)
4881</pre>
4882
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4883<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4884
4885<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4886<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4887
4888<h5>colorspace</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4889<p>the image colorspace: UndefinedColorspace, RGBColorspace, GRAYColorspace, TransparentColorspace, OHTAColorspace, XYZColorspace, YCbCrColorspace, YCCColorspace, YIQColorspace, YPbPrColorspace, YPbPrColorspace, YUVColorspace, CMYKColorspace, sRGBColorspace, HSLColorspace, or HWBColorspace.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4890
4891 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]4892<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4893_8c.html" id="MagickSetImageCompose">MagickSetImageCompose</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4894<div class="doc-section">
4895
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4896<p>MagickSetImageCompose() sets the image composite operator, useful for specifying how to composite the image thumbnail when using the MagickMontageImage() method.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4897
4898<p>The format of the MagickSetImageCompose method is:</p>
4899
4900<pre class="code">
4901 MagickBooleanType MagickSetImageCompose(MagickWand *wand,
4902 const CompositeOperator compose)
4903</pre>
4904
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4905<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4906
4907<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4908<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4909
4910<h5>compose</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4911<p>the image composite operator.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4912
4913 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]4914<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4915_8c.html" id="MagickSetImageCompression">MagickSetImageCompression</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4916<div class="doc-section">
4917
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4918<p>MagickSetImageCompression() sets the image compression.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4919
4920<p>The format of the MagickSetImageCompression method is:</p>
4921
4922<pre class="code">
4923 MagickBooleanType MagickSetImageCompression(MagickWand *wand,
4924 const CompressionType compression)
4925</pre>
4926
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4927<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4928
4929<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4930<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4931
4932<h5>compression</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4933<p>the image compression type.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4934
4935 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]4936<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4937_8c.html" id="MagickSetImageCompressionQuality">MagickSetImageCompressionQuality</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4938<div class="doc-section">
4939
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4940<p>MagickSetImageCompressionQuality() sets the image compression quality.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4941
4942<p>The format of the MagickSetImageCompressionQuality method is:</p>
4943
4944<pre class="code">
4945 MagickBooleanType MagickSetImageCompressionQuality(MagickWand *wand,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]4946 const size_t quality)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4947</pre>
4948
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4949<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4950
4951<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4952<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4953
4954<h5>quality</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4955<p>the image compression tlityype.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4956
4957 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]4958<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4959_8c.html" id="MagickSetImageDelay">MagickSetImageDelay</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4960<div class="doc-section">
4961
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4962<p>MagickSetImageDelay() sets the image delay.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4963
4964<p>The format of the MagickSetImageDelay method is:</p>
4965
4966<pre class="code">
4967 MagickBooleanType MagickSetImageDelay(MagickWand *wand,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]4968 const size_t delay)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4969</pre>
4970
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4971<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4972
4973<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4974<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4975
4976<h5>delay</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4977<p>the image delay in ticks-per-second units.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4978
4979 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]4980<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4981_8c.html" id="MagickSetImageDepth">MagickSetImageDepth</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4982<div class="doc-section">
4983
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4984<p>MagickSetImageDepth() sets the image depth.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4985
4986<p>The format of the MagickSetImageDepth method is:</p>
4987
4988<pre class="code">
4989 MagickBooleanType MagickSetImageDepth(MagickWand *wand,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]4990 const size_t depth)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4991</pre>
4992
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4993<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4994
4995<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4996<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4997
4998<h5>depth</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4999<p>the image depth in bits: 8, 16, or 32.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5000
5001 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]5002<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5003_8c.html" id="MagickSetImageDispose">MagickSetImageDispose</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5004<div class="doc-section">
5005
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5006<p>MagickSetImageDispose() sets the image disposal method.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5007
5008<p>The format of the MagickSetImageDispose method is:</p>
5009
5010<pre class="code">
5011 MagickBooleanType MagickSetImageDispose(MagickWand *wand,
5012 const DisposeType dispose)
5013</pre>
5014
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5015<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5016
5017<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5018<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5019
5020<h5>dispose</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5021<p>the image disposeal type.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5022
5023 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]5024<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5025_8c.html" id="MagickSetImageExtent">MagickSetImageExtent</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5026<div class="doc-section">
5027
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5028<p>MagickSetImageExtent() sets the image size (i.e. columns & rows).</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5029
5030<p>The format of the MagickSetImageExtent method is:</p>
5031
5032<pre class="code">
5033 MagickBooleanType MagickSetImageExtent(MagickWand *wand,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]5034 const size_t columns,const unsigned rows)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5035</pre>
5036
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5037<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5038
5039<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5040<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5041
5042<h5>columns</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5043<p>The image width in pixels.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5044
5045<h5>rows</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5046<p>The image height in pixels.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5047
5048 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]5049<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5050_8c.html" id="MagickSetImageFilename">MagickSetImageFilename</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5051<div class="doc-section">
5052
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5053<p>MagickSetImageFilename() sets the filename of a particular image in a sequence.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5054
5055<p>The format of the MagickSetImageFilename method is:</p>
5056
5057<pre class="code">
5058 MagickBooleanType MagickSetImageFilename(MagickWand *wand,
5059 const char *filename)
5060</pre>
5061
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5062<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5063
5064<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5065<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5066
5067<h5>filename</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5068<p>the image filename.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5069
5070 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]5071<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5072_8c.html" id="MagickSetImageFormat">MagickSetImageFormat</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5073<div class="doc-section">
5074
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5075<p>MagickSetImageFormat() sets the format of a particular image in a sequence.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5076
5077<p>The format of the MagickSetImageFormat method is:</p>
5078
5079<pre class="code">
5080 MagickBooleanType MagickSetImageFormat(MagickWand *wand,
5081 const char *format)
5082</pre>
5083
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5084<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5085
5086<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5087<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5088
5089<h5>format</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5090<p>the image format.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5091
5092 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]5093<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5094_8c.html" id="MagickSetImageFuzz">MagickSetImageFuzz</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5095<div class="doc-section">
5096
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5097<p>MagickSetImageFuzz() sets the image fuzz.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5098
5099<p>The format of the MagickSetImageFuzz method is:</p>
5100
5101<pre class="code">
5102 MagickBooleanType MagickSetImageFuzz(MagickWand *wand,
5103 const double fuzz)
5104</pre>
5105
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5106<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5107
5108<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5109<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5110
5111<h5>fuzz</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5112<p>the image fuzz.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5113
5114 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]5115<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5116_8c.html" id="MagickSetImageGamma">MagickSetImageGamma</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5117<div class="doc-section">
5118
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5119<p>MagickSetImageGamma() sets the image gamma.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5120
5121<p>The format of the MagickSetImageGamma method is:</p>
5122
5123<pre class="code">
5124 MagickBooleanType MagickSetImageGamma(MagickWand *wand,
5125 const double gamma)
5126</pre>
5127
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5128<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5129
5130<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5131<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5132
5133<h5>gamma</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5134<p>the image gamma.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5135
5136 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]5137<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5138_8c.html" id="MagickSetImageGravity">MagickSetImageGravity</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5139<div class="doc-section">
5140
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5141<p>MagickSetImageGravity() sets the image gravity type.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5142
5143<p>The format of the MagickSetImageGravity method is:</p>
5144
5145<pre class="code">
5146 MagickBooleanType MagickSetImageGravity(MagickWand *wand,
5147 const GravityType gravity)
5148</pre>
5149
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5150<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5151
5152<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5153<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5154
5155<h5>gravity</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5156<p>the image interlace scheme: NoInterlace, LineInterlace, PlaneInterlace, PartitionInterlace.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5157
5158 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]5159<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5160_8c.html" id="MagickSetImageGreenPrimary">MagickSetImageGreenPrimary</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5161<div class="doc-section">
5162
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5163<p>MagickSetImageGreenPrimary() sets the image chromaticity green primary point.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5164
5165<p>The format of the MagickSetImageGreenPrimary method is:</p>
5166
5167<pre class="code">
5168 MagickBooleanType MagickSetImageGreenPrimary(MagickWand *wand,
5169 const double x,const double y)
5170</pre>
5171
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5172<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5173
5174<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5175<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5176
5177<h5>x</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5178<p>the green primary x-point.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5179
5180<h5>y</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5181<p>the green primary y-point.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5182
5183
5184 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]5185<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5186_8c.html" id="MagickSetImageInterlaceScheme">MagickSetImageInterlaceScheme</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5187<div class="doc-section">
5188
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5189<p>MagickSetImageInterlaceScheme() sets the image interlace scheme.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5190
5191<p>The format of the MagickSetImageInterlaceScheme method is:</p>
5192
5193<pre class="code">
5194 MagickBooleanType MagickSetImageInterlaceScheme(MagickWand *wand,
5195 const InterlaceType interlace)
5196</pre>
5197
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5198<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5199
5200<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5201<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5202
5203<h5>interlace</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5204<p>the image interlace scheme: NoInterlace, LineInterlace, PlaneInterlace, PartitionInterlace.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5205
5206 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]5207<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5208_8c.html" id="MagickSetImageInterpolateMethod">MagickSetImageInterpolateMethod</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5209<div class="doc-section">
5210
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5211<p>MagickSetImageInterpolateMethod() sets the image interpolate pixel method.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5212
5213<p>The format of the MagickSetImageInterpolateMethod method is:</p>
5214
5215<pre class="code">
5216 MagickBooleanType MagickSetImageInterpolateMethod(MagickWand *wand,
5217 const InterpolatePixelMethod method)
5218</pre>
5219
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5220<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5221
5222<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5223<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5224
5225<h5>method</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5226<p>the image interpole pixel methods: choose from Undefined, Average, Bicubic, Bilinear, Filter, Integer, Mesh, NearestNeighbor.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5227
5228 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]5229<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5230_8c.html" id="MagickSetImageIterations">MagickSetImageIterations</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5231<div class="doc-section">
5232
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5233<p>MagickSetImageIterations() sets the image iterations.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5234
5235<p>The format of the MagickSetImageIterations method is:</p>
5236
5237<pre class="code">
5238 MagickBooleanType MagickSetImageIterations(MagickWand *wand,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]5239 const size_t iterations)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5240</pre>
5241
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5242<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5243
5244<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5245<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5246
5247<h5>delay</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5248<p>the image delay in 1/100th of a second.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5249
5250 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]5251<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5252_8c.html" id="MagickSetImageMatte">MagickSetImageMatte</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5253<div class="doc-section">
5254
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5255<p>MagickSetImageMatte() sets the image matte channel.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5256
5257<p>The format of the MagickSetImageMatteColor method is:</p>
5258
5259<pre class="code">
5260 MagickBooleanType MagickSetImageMatteColor(MagickWand *wand,
5261 const MagickBooleanType *matte)
5262</pre>
5263
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5264<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5265
5266<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5267<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5268
5269<h5>matte</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5270<p>Set to MagickTrue to enable the image matte channel otherwise MagickFalse.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5271
5272 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]5273<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5274_8c.html" id="MagickSetImageMatteColor">MagickSetImageMatteColor</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5275<div class="doc-section">
5276
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5277<p>MagickSetImageMatteColor() sets the image matte color.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5278
5279<p>The format of the MagickSetImageMatteColor method is:</p>
5280
5281<pre class="code">
5282 MagickBooleanType MagickSetImageMatteColor(MagickWand *wand,
5283 const PixelWand *matte)
5284</pre>
5285
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5286<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5287
5288<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5289<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5290
5291<h5>matte</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5292<p>the matte pixel wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5293
5294 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]5295<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5296_8c.html" id="MagickSetImageOpacity">MagickSetImageOpacity</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5297<div class="doc-section">
5298
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5299<p>MagickSetImageOpacity() sets the image to the specified opacity level.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5300
5301<p>The format of the MagickSetImageOpacity method is:</p>
5302
5303<pre class="code">
5304 MagickBooleanType MagickSetImageOpacity(MagickWand *wand,
5305 const double alpha)
5306</pre>
5307
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5308<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5309
5310<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5311<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5312
5313<h5>alpha</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5314<p>the level of transparency: 1.0 is fully opaque and 0.0 is fully transparent.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5315
5316 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]5317<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5318_8c.html" id="MagickSetImageOrientation">MagickSetImageOrientation</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5319<div class="doc-section">
5320
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5321<p>MagickSetImageOrientation() sets the image orientation.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5322
5323<p>The format of the MagickSetImageOrientation method is:</p>
5324
5325<pre class="code">
5326 MagickBooleanType MagickSetImageOrientation(MagickWand *wand,
5327 const OrientationType orientation)
5328</pre>
5329
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5330<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5331
5332<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5333<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5334
5335<h5>orientation</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5336<p>the image orientation type.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5337
5338 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]5339<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5340_8c.html" id="MagickSetImagePage">MagickSetImagePage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5341<div class="doc-section">
5342
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5343<p>MagickSetImagePage() sets the page geometry of the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5344
5345<p>The format of the MagickSetImagePage method is:</p>
5346
5347<pre class="code">
5348 MagickBooleanType MagickSetImagePage(MagickWand *wand,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]5349 const size_t width,const size_t height,const ssize_t x,
5350 const ssize_t y)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5351</pre>
5352
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5353<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5354
5355<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5356<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5357
5358<h5>width</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5359<p>the page width.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5360
5361<h5>height</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5362<p>the page height.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5363
5364<h5>x</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5365<p>the page x-offset.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5366
5367<h5>y</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5368<p>the page y-offset.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5369
5370 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]5371<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5372_8c.html" id="MagickSetImageProgressMonitor">MagickSetImageProgressMonitor</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5373<div class="doc-section">
5374
5375<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>
5376
5377<pre class="text">
5378 MagickBooleanType MagickProgressMonitor(const char *text,
5379 const MagickOffsetType offset,const MagickSizeType span,
5380 void *client_data)
5381</pre>
5382
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5383<p>If the progress monitor returns MagickFalse, the current operation is interrupted.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5384
5385<p>The format of the MagickSetImageProgressMonitor method is:</p>
5386
5387<pre class="code">
5388 MagickProgressMonitor MagickSetImageProgressMonitor(MagickWand *wand
5389 const MagickProgressMonitor progress_monitor,void *client_data)
5390</pre>
5391
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5392<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5393
5394<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5395<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5396
5397<h5>progress_monitor</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5398<p>Specifies a pointer to a method to monitor progress of an image operation.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5399
5400<h5>client_data</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5401<p>Specifies a pointer to any client data.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5402
5403 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]5404<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5405_8c.html" id="MagickSetImageRedPrimary">MagickSetImageRedPrimary</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5406<div class="doc-section">
5407
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5408<p>MagickSetImageRedPrimary() sets the image chromaticity red primary point.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5409
5410<p>The format of the MagickSetImageRedPrimary method is:</p>
5411
5412<pre class="code">
5413 MagickBooleanType MagickSetImageRedPrimary(MagickWand *wand,
5414 const double x,const double y)
5415</pre>
5416
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5417<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5418
5419<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5420<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5421
5422<h5>x</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5423<p>the red primary x-point.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5424
5425<h5>y</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5426<p>the red primary y-point.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5427
5428 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]5429<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5430_8c.html" id="MagickSetImageRenderingIntent">MagickSetImageRenderingIntent</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5431<div class="doc-section">
5432
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5433<p>MagickSetImageRenderingIntent() sets the image rendering intent.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5434
5435<p>The format of the MagickSetImageRenderingIntent method is:</p>
5436
5437<pre class="code">
5438 MagickBooleanType MagickSetImageRenderingIntent(MagickWand *wand,
5439 const RenderingIntent rendering_intent)
5440</pre>
5441
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5442<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5443
5444<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5445<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5446
5447<h5>rendering_intent</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5448<p>the image rendering intent: UndefinedIntent, SaturationIntent, PerceptualIntent, AbsoluteIntent, or RelativeIntent.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5449
5450 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]5451<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5452_8c.html" id="MagickSetImageResolution">MagickSetImageResolution</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5453<div class="doc-section">
5454
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5455<p>MagickSetImageResolution() sets the image resolution.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5456
5457<p>The format of the MagickSetImageResolution method is:</p>
5458
5459<pre class="code">
5460 MagickBooleanType MagickSetImageResolution(MagickWand *wand,
5461 const double x_resolution,const doubtl y_resolution)
5462</pre>
5463
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5464<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5465
5466<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5467<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5468
5469<h5>x_resolution</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5470<p>the image x resolution.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5471
5472<h5>y_resolution</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5473<p>the image y resolution.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5474
5475 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]5476<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5477_8c.html" id="MagickSetImageScene">MagickSetImageScene</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5478<div class="doc-section">
5479
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5480<p>MagickSetImageScene() sets the image scene.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5481
5482<p>The format of the MagickSetImageScene method is:</p>
5483
5484<pre class="code">
5485 MagickBooleanType MagickSetImageScene(MagickWand *wand,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]5486 const size_t scene)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5487</pre>
5488
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5489<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5490
5491<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5492<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5493
5494<h5>delay</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5495<p>the image scene number.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5496
5497 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]5498<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5499_8c.html" id="MagickSetImageTicksPerSecond">MagickSetImageTicksPerSecond</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5500<div class="doc-section">
5501
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5502<p>MagickSetImageTicksPerSecond() sets the image ticks-per-second.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5503
5504<p>The format of the MagickSetImageTicksPerSecond method is:</p>
5505
5506<pre class="code">
5507 MagickBooleanType MagickSetImageTicksPerSecond(MagickWand *wand,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]5508 const ssize_t ticks_per-second)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5509</pre>
5510
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5511<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5512
5513<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5514<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5515
5516<h5>ticks_per_second</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5517<p>the units to use for the image delay.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5518
5519 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]5520<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5521_8c.html" id="MagickSetImageType">MagickSetImageType</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5522<div class="doc-section">
5523
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5524<p>MagickSetImageType() sets the image type.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5525
5526<p>The format of the MagickSetImageType method is:</p>
5527
5528<pre class="code">
5529 MagickBooleanType MagickSetImageType(MagickWand *wand,
5530 const ImageType image_type)
5531</pre>
5532
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5533<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5534
5535<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5536<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5537
5538<h5>image_type</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5539<p>the image type: UndefinedType, BilevelType, GrayscaleType, GrayscaleMatteType, PaletteType, PaletteMatteType, TrueColorType, TrueColorMatteType, ColorSeparationType, ColorSeparationMatteType, or OptimizeType.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5540
5541 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]5542<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5543_8c.html" id="MagickSetImageUnits">MagickSetImageUnits</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5544<div class="doc-section">
5545
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5546<p>MagickSetImageUnits() sets the image units of resolution.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5547
5548<p>The format of the MagickSetImageUnits method is:</p>
5549
5550<pre class="code">
5551 MagickBooleanType MagickSetImageUnits(MagickWand *wand,
5552 const ResolutionType units)
5553</pre>
5554
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5555<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5556
5557<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5558<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5559
5560<h5>units</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5561<p>the image units of resolution : UndefinedResolution, PixelsPerInchResolution, or PixelsPerCentimeterResolution.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5562
5563 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]5564<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5565_8c.html" id="MagickSetImageVirtualPixelMethod">MagickSetImageVirtualPixelMethod</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5566<div class="doc-section">
5567
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5568<p>MagickSetImageVirtualPixelMethod() sets the image virtual pixel method.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5569
5570<p>The format of the MagickSetImageVirtualPixelMethod method is:</p>
5571
5572<pre class="code">
5573 VirtualPixelMethod MagickSetImageVirtualPixelMethod(MagickWand *wand,
5574 const VirtualPixelMethod method)
5575</pre>
5576
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5577<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5578
5579<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5580<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5581
5582<h5>method</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5583<p>the image virtual pixel method : UndefinedVirtualPixelMethod, ConstantVirtualPixelMethod, EdgeVirtualPixelMethod, MirrorVirtualPixelMethod, or TileVirtualPixelMethod.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5584
5585 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]5586<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5587_8c.html" id="MagickSetImageWhitePoint">MagickSetImageWhitePoint</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5588<div class="doc-section">
5589
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5590<p>MagickSetImageWhitePoint() sets the image chromaticity white point.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5591
5592<p>The format of the MagickSetImageWhitePoint method is:</p>
5593
5594<pre class="code">
5595 MagickBooleanType MagickSetImageWhitePoint(MagickWand *wand,
5596 const double x,const double y)
5597</pre>
5598
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5599<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5600
5601<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5602<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5603
5604<h5>x</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5605<p>the white x-point.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5606
5607<h5>y</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5608<p>the white y-point.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5609
5610 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]5611<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5612_8c.html" id="MagickShadeImage">MagickShadeImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5613<div class="doc-section">
5614
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5615<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5616
5617<p>The format of the MagickShadeImage method is:</p>
5618
5619<pre class="code">
5620 MagickBooleanType MagickShadeImage(MagickWand *wand,
5621 const MagickBooleanType gray,const double azimuth,
5622 const double elevation)
5623</pre>
5624
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5625<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5626
5627<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5628<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5629
5630<h5>gray</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5631<p>A value other than zero shades the intensity of each pixel.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5632
5633<h5>azimuth, elevation</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5634<p>Define the light source direction.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5635
5636 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]5637<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5638_8c.html" id="MagickShadowImage">MagickShadowImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5639<div class="doc-section">
5640
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5641<p>MagickShadowImage() simulates an image shadow.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5642
5643<p>The format of the MagickShadowImage method is:</p>
5644
5645<pre class="code">
5646 MagickBooleanType MagickShadowImage(MagickWand *wand,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]5647 const double opacity,const double sigma,const ssize_t x,const ssize_t y)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5648</pre>
5649
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5650<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5651
5652<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5653<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5654
5655<h5>opacity</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5656<p>percentage transparency.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5657
5658<h5>sigma</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5659<p>the standard deviation of the Gaussian, in pixels.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5660
5661<h5>x</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5662<p>the shadow x-offset.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5663
5664<h5>y</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5665<p>the shadow y-offset.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5666
5667 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]5668<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5669_8c.html" id="MagickSharpenImage">MagickSharpenImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5670<div class="doc-section">
5671
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5672<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5673
5674<p>The format of the MagickSharpenImage method is:</p>
5675
5676<pre class="code">
5677 MagickBooleanType MagickSharpenImage(MagickWand *wand,
5678 const double radius,const double sigma)
5679 MagickBooleanType MagickSharpenImageChannel(MagickWand *wand,
5680 const ChannelType channel,const double radius,const double sigma)
5681</pre>
5682
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5683<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5684
5685<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5686<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5687
5688<h5>channel</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5689<p>the image channel(s).</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5690
5691<h5>radius</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5692<p>the radius of the Gaussian, in pixels, not counting the center pixel.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5693
5694<h5>sigma</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5695<p>the standard deviation of the Gaussian, in pixels.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5696
5697 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]5698<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5699_8c.html" id="MagickShaveImage">MagickShaveImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5700<div class="doc-section">
5701
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5702<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5703
5704<p>The format of the MagickShaveImage method is:</p>
5705
5706<pre class="code">
5707 MagickBooleanType MagickShaveImage(MagickWand *wand,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]5708 const size_t columns,const size_t rows)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5709</pre>
5710
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5711<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5712
5713<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5714<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5715
5716<h5>columns</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5717<p>the number of columns in the scaled image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5718
5719<h5>rows</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5720<p>the number of rows in the scaled image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5721
5722
5723 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]5724<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5725_8c.html" id="MagickShearImage">MagickShearImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5726<div class="doc-section">
5727
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5728<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5729
5730<p>The format of the MagickShearImage method is:</p>
5731
5732<pre class="code">
5733 MagickBooleanType MagickShearImage(MagickWand *wand,
5734 const PixelWand *background,const double x_shear,onst double y_shear)
5735</pre>
5736
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5737<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5738
5739<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5740<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5741
5742<h5>background</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5743<p>the background pixel wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5744
5745<h5>x_shear</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5746<p>the number of degrees to shear the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5747
5748<h5>y_shear</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5749<p>the number of degrees to shear the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5750
5751 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]5752<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5753_8c.html" id="MagickSigmoidalContrastImage">MagickSigmoidalContrastImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5754<div class="doc-section">
5755
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5756<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5757
5758<p>The format of the MagickSigmoidalContrastImage method is:</p>
5759
5760<pre class="code">
5761 MagickBooleanType MagickSigmoidalContrastImage(MagickWand *wand,
5762 const MagickBooleanType sharpen,const double alpha,const double beta)
5763 MagickBooleanType MagickSigmoidalContrastImageChannel(MagickWand *wand,
5764 const ChannelType channel,const MagickBooleanType sharpen,
5765 const double alpha,const double beta)
5766</pre>
5767
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5768<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5769
5770<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5771<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5772
5773<h5>channel</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5774<p>Identify which channel to level: RedChannel, GreenChannel,</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5775
5776<h5>sharpen</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5777<p>Increase or decrease image contrast.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5778
5779<h5>alpha</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5780<p>strength of the contrast, the larger the number the more 'threshold-like' it becomes.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5781
5782<h5>beta</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5783<p>midpoint of the function as a color value 0 to QuantumRange.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5784
5785 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]5786<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5787_8c.html" id="MagickSimilarityImage">MagickSimilarityImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5788<div class="doc-section">
5789
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5790<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5791
5792<p>The format of the MagickSimilarityImage method is:</p>
5793
5794<pre class="code">
5795 MagickWand *MagickSimilarityImage(MagickWand *wand,
5796 const MagickWand *reference,RectangeInfo *offset,double *similarity)
5797</pre>
5798
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5799<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5800
5801<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5802<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5803
5804<h5>reference</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5805<p>the reference wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5806
5807<h5>offset</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5808<p>the best match offset of the reference image within the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5809
5810<h5>similarity</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5811<p>the computed similarity between the images.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5812
5813 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]5814<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5815_8c.html" id="MagickSketchImage">MagickSketchImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5816<div class="doc-section">
5817
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5818<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5819
5820<p>The format of the MagickSketchImage method is:</p>
5821
5822<pre class="code">
5823 MagickBooleanType MagickSketchImage(MagickWand *wand,
5824 const double radius,const double sigma,const double angle)
5825</pre>
5826
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5827<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5828
5829<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5830<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5831
5832<h5>radius</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5833<p>the radius of the Gaussian, in pixels, not counting the center pixel.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5834
5835<h5>sigma</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5836<p>the standard deviation of the Gaussian, in pixels.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5837
5838<h5>angle</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5839<p>Apply the effect along this angle.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5840
5841 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]5842<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5843_8c.html" id="MagickSolarizeImage">MagickSolarizeImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5844<div class="doc-section">
5845
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5846<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5847
5848<p>The format of the MagickSolarizeImage method is:</p>
5849
5850<pre class="code">
5851 MagickBooleanType MagickSolarizeImage(MagickWand *wand,
5852 const double threshold)
5853</pre>
5854
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5855<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5856
5857<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5858<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5859
5860<h5>threshold</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5861<p>Define the extent of the solarization.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5862
5863 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]5864<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5865_8c.html" id="MagickSparseColorImage">MagickSparseColorImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5866<div class="doc-section">
5867
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5868<p>MagickSparseColorImage(), given a set of coordinates, interpolates the colors found at those coordinates, across the whole image, using various methods.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5869
5870<p>The format of the MagickSparseColorImage method is:</p>
5871
5872<pre class="code">
5873 MagickBooleanType MagickSparseColorImage(MagickWand *wand,
5874 const ChannelType channel,const SparseColorMethod method,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]5875 const size_t number_arguments,const double *arguments)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5876</pre>
5877
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5878<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5879
5880<h5>image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5881<p>the image to be sparseed.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5882
5883<h5>method</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5884<p>the method of image sparseion.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5885
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5886<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5887
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5888<p>Bilinear has no simple inverse mapping so will not allow 'bestfit' style of image sparseion.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5889
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5890<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5891
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5892<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5893
5894<h5>number_arguments</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5895<p>the number of arguments given for this sparseion method.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5896
5897<h5>arguments</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5898<p>the arguments for this sparseion method.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5899
5900 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]5901<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5902_8c.html" id="MagickSpliceImage">MagickSpliceImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5903<div class="doc-section">
5904
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5905<p>MagickSpliceImage() splices a solid color into the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5906
5907<p>The format of the MagickSpliceImage method is:</p>
5908
5909<pre class="code">
5910 MagickBooleanType MagickSpliceImage(MagickWand *wand,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]5911 const size_t width,const size_t height,const ssize_t x,
5912 const ssize_t y)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5913</pre>
5914
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5915<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5916
5917<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5918<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5919
5920<h5>width</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5921<p>the region width.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5922
5923<h5>height</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5924<p>the region height.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5925
5926<h5>x</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5927<p>the region x offset.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5928
5929<h5>y</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5930<p>the region y offset.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5931
5932 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]5933<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5934_8c.html" id="MagickSpreadImage">MagickSpreadImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5935<div class="doc-section">
5936
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5937<p>MagickSpreadImage() is a special effects method that randomly displaces each pixel in a block defined by the radius parameter.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5938
5939<p>The format of the MagickSpreadImage method is:</p>
5940
5941<pre class="code">
5942 MagickBooleanType MagickSpreadImage(MagickWand *wand,const double radius)
5943</pre>
5944
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5945<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5946
5947<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5948<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5949
5950<h5>radius</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5951<p>Choose a random pixel in a neighborhood of this extent.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5952
5953 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]5954<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5955_8c.html" id="MagickSteganoImage">MagickSteganoImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5956<div class="doc-section">
5957
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5958<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5959
5960<p>The format of the MagickSteganoImage method is:</p>
5961
5962<pre class="code">
5963 MagickWand *MagickSteganoImage(MagickWand *wand,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]5964 const MagickWand *watermark_wand,const ssize_t offset)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5965</pre>
5966
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5967<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5968
5969<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5970<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5971
5972<h5>watermark_wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5973<p>the watermark wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5974
5975<h5>offset</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5976<p>Start hiding at this offset into the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5977
5978 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]5979<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5980_8c.html" id="MagickStereoImage">MagickStereoImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5981<div class="doc-section">
5982
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5983<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5984
5985<p>The format of the MagickStereoImage method is:</p>
5986
5987<pre class="code">
5988 MagickWand *MagickStereoImage(MagickWand *wand,
5989 const MagickWand *offset_wand)
5990</pre>
5991
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5992<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5993
5994<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5995<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5996
5997<h5>offset_wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5998<p>Another image wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5999
6000 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]6001<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6002_8c.html" id="MagickStripImage">MagickStripImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6003<div class="doc-section">
6004
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6005<p>MagickStripImage() strips an image of all profiles and comments.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6006
6007<p>The format of the MagickStripImage method is:</p>
6008
6009<pre class="code">
6010 MagickBooleanType MagickStripImage(MagickWand *wand)
6011</pre>
6012
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6013<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6014
6015<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6016<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6017
6018 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]6019<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6020_8c.html" id="MagickSwirlImage">MagickSwirlImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6021<div class="doc-section">
6022
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6023<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6024
6025<p>The format of the MagickSwirlImage method is:</p>
6026
6027<pre class="code">
6028 MagickBooleanType MagickSwirlImage(MagickWand *wand,const double degrees)
6029</pre>
6030
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6031<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6032
6033<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6034<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6035
6036<h5>degrees</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6037<p>Define the tightness of the swirling effect.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6038
6039 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]6040<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6041_8c.html" id="MagickTextureImage">MagickTextureImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6042<div class="doc-section">
6043
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6044<p>MagickTextureImage() repeatedly tiles the texture image across and down the image canvas.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6045
6046<p>The format of the MagickTextureImage method is:</p>
6047
6048<pre class="code">
6049 MagickWand *MagickTextureImage(MagickWand *wand,
6050 const MagickWand *texture_wand)
6051</pre>
6052
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6053<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6054
6055<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6056<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6057
6058<h5>texture_wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6059<p>the texture wand</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6060
6061 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]6062<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6063_8c.html" id="MagickThresholdImage">MagickThresholdImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6064<div class="doc-section">
6065
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6066<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6067
6068<p>The format of the MagickThresholdImage method is:</p>
6069
6070<pre class="code">
6071 MagickBooleanType MagickThresholdImage(MagickWand *wand,
6072 const double threshold)
6073 MagickBooleanType MagickThresholdImageChannel(MagickWand *wand,
6074 const ChannelType channel,const double threshold)
6075</pre>
6076
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6077<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6078
6079<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6080<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6081
6082<h5>channel</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6083<p>the image channel(s).</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6084
6085<h5>threshold</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6086<p>Define the threshold value.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6087
6088 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]6089<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6090_8c.html" id="MagickThumbnailImage">MagickThumbnailImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6091<div class="doc-section">
6092
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6093<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6094
6095<p>The format of the MagickThumbnailImage method is:</p>
6096
6097<pre class="code">
6098 MagickBooleanType MagickThumbnailImage(MagickWand *wand,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]6099 const size_t columns,const size_t rows)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6100</pre>
6101
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6102<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6103
6104<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6105<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6106
6107<h5>columns</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6108<p>the number of columns in the scaled image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6109
6110<h5>rows</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6111<p>the number of rows in the scaled image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6112
6113 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]6114<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6115_8c.html" id="MagickTintImage">MagickTintImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6116<div class="doc-section">
6117
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6118<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6119
6120<p>The format of the MagickTintImage method is:</p>
6121
6122<pre class="code">
6123 MagickBooleanType MagickTintImage(MagickWand *wand,
6124 const PixelWand *tint,const PixelWand *opacity)
6125</pre>
6126
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6127<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6128
6129<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6130<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6131
6132<h5>tint</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6133<p>the tint pixel wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6134
6135<h5>opacity</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6136<p>the opacity pixel wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6137
6138 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]6139<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6140_8c.html" id="MagickTransformImage">MagickTransformImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6141<div class="doc-section">
6142
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6143<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6144
6145<p>The format of the MagickTransformImage method is:</p>
6146
6147<pre class="code">
6148 MagickWand *MagickTransformImage(MagickWand *wand,const char *crop,
6149 const char *geometry)
6150</pre>
6151
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6152<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6153
6154<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6155<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6156
6157<h5>crop</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6158<p>A crop geometry string. This geometry defines a subregion of the image to crop.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6159
6160<h5>geometry</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6161<p>An image geometry string. This geometry defines the final size of the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6162
6163 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]6164<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6165_8c.html" id="MagickTransformImageColorspace">MagickTransformImageColorspace</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6166<div class="doc-section">
6167
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6168<p>MagickTransformImageColorspace() transform the image colorspace.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6169
6170<p>The format of the MagickTransformImageColorspace method is:</p>
6171
6172<pre class="code">
6173 MagickBooleanType MagickTransformImageColorspace(MagickWand *wand,
6174 const ColorspaceType colorspace)
6175</pre>
6176
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6177<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6178
6179<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6180<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6181
6182<h5>colorspace</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6183<p>the image colorspace: UndefinedColorspace, RGBColorspace, GRAYColorspace, TransparentColorspace, OHTAColorspace, XYZColorspace, YCbCrColorspace, YCCColorspace, YIQColorspace, YPbPrColorspace, YPbPrColorspace, YUVColorspace, CMYKColorspace, sRGBColorspace, HSLColorspace, or HWBColorspace.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6184
6185 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]6186<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6187_8c.html" id="MagickTransparentPaintImage">MagickTransparentPaintImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6188<div class="doc-section">
6189
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6190<p>MagickTransparentPaintImage() changes any pixel that matches color with the color defined by fill.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6191
6192<p>The format of the MagickTransparentPaintImage method is:</p>
6193
6194<pre class="code">
6195 MagickBooleanType MagickTransparentPaintImage(MagickWand *wand,
6196 const PixelWand *target,const double alpha,const double fuzz,
6197 const MagickBooleanType invert)
6198</pre>
6199
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6200<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6201
6202<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6203<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6204
6205<h5>target</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6206<p>Change this target color to specified opacity value within the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6207
6208<h5>alpha</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6209<p>the level of transparency: 1.0 is fully opaque and 0.0 is fully transparent.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6210
6211<h5>fuzz</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6212<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6213
6214<h5>invert</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6215<p>paint any pixel that does not match the target color.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6216
6217 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]6218<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6219_8c.html" id="MagickTransposeImage">MagickTransposeImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6220<div class="doc-section">
6221
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6222<p>MagickTransposeImage() creates a vertical mirror image by reflecting the pixels around the central x-axis while rotating them 90-degrees.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6223
6224<p>The format of the MagickTransposeImage method is:</p>
6225
6226<pre class="code">
6227 MagickBooleanType MagickTransposeImage(MagickWand *wand)
6228</pre>
6229
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6230<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6231
6232<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6233<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6234
6235 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]6236<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6237_8c.html" id="MagickTransverseImage">MagickTransverseImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6238<div class="doc-section">
6239
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6240<p>MagickTransverseImage() creates a horizontal mirror image by reflecting the pixels around the central y-axis while rotating them 270-degrees.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6241
6242<p>The format of the MagickTransverseImage method is:</p>
6243
6244<pre class="code">
6245 MagickBooleanType MagickTransverseImage(MagickWand *wand)
6246</pre>
6247
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6248<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6249
6250<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6251<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6252
6253 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]6254<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6255_8c.html" id="MagickTrimImage">MagickTrimImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6256<div class="doc-section">
6257
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6258<p>MagickTrimImage() remove edges that are the background color from the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6259
6260<p>The format of the MagickTrimImage method is:</p>
6261
6262<pre class="code">
6263 MagickBooleanType MagickTrimImage(MagickWand *wand,const double fuzz)
6264</pre>
6265
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6266<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6267
6268<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6269<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6270
6271<h5>fuzz</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6272<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6273
6274 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]6275<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6276_8c.html" id="MagickUniqueImageColors">MagickUniqueImageColors</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6277<div class="doc-section">
6278
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6279<p>MagickUniqueImageColors() discards all but one of any pixel color.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6280
6281<p>The format of the MagickUniqueImageColors method is:</p>
6282
6283<pre class="code">
6284 MagickBooleanType MagickUniqueImageColors(MagickWand *wand)
6285</pre>
6286
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6287<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6288
6289<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6290<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6291
6292 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]6293<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6294_8c.html" id="MagickUnsharpMaskImage">MagickUnsharpMaskImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6295<div class="doc-section">
6296
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6297<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6298
6299<p>The format of the MagickUnsharpMaskImage method is:</p>
6300
6301<pre class="code">
6302 MagickBooleanType MagickUnsharpMaskImage(MagickWand *wand,
6303 const double radius,const double sigma,const double amount,
6304 const double threshold)
6305 MagickBooleanType MagickUnsharpMaskImageChannel(MagickWand *wand,
6306 const ChannelType channel,const double radius,const double sigma,
6307 const double amount,const double threshold)
6308</pre>
6309
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6310<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6311
6312<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6313<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6314
6315<h5>channel</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6316<p>the image channel(s).</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6317
6318<h5>radius</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6319<p>the radius of the Gaussian, in pixels, not counting the center pixel.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6320
6321<h5>sigma</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6322<p>the standard deviation of the Gaussian, in pixels.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6323
6324<h5>amount</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6325<p>the percentage of the difference between the original and the blur image that is added back into the original.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6326
6327<h5>threshold</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6328<p>the threshold in pixels needed to apply the diffence amount.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6329
6330 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]6331<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6332_8c.html" id="MagickVignetteImage">MagickVignetteImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6333<div class="doc-section">
6334
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6335<p>MagickVignetteImage() softens the edges of the image in vignette style.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6336
6337<p>The format of the MagickVignetteImage method is:</p>
6338
6339<pre class="code">
6340 MagickBooleanType MagickVignetteImage(MagickWand *wand,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]6341 const double black_point,const double white_point,const ssize_t x,
6342 const ssize_t y)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6343</pre>
6344
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6345<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6346
6347<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6348<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6349
6350<h5>black_point</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6351<p>the black point.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6352
6353<h5>white_point</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6354<p>the white point.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6355
6356<h5>x, y</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6357<p>Define the x and y ellipse offset.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6358
6359 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]6360<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6361_8c.html" id="MagickWaveImage">MagickWaveImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6362<div class="doc-section">
6363
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6364<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6365
6366<p>The format of the MagickWaveImage method is:</p>
6367
6368<pre class="code">
6369 MagickBooleanType MagickWaveImage(MagickWand *wand,const double amplitude,
6370 const double wave_length)
6371</pre>
6372
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6373<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6374
6375<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6376<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6377
6378<h5>amplitude, wave_length</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6379<p>Define the amplitude and wave length of the sine wave.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6380
6381 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]6382<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6383_8c.html" id="MagickWhiteThresholdImage">MagickWhiteThresholdImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6384<div class="doc-section">
6385
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6386<p>MagickWhiteThresholdImage() is like ThresholdImage() but force all pixels above the threshold into white while leaving all pixels below the threshold unchanged.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6387
6388<p>The format of the MagickWhiteThresholdImage method is:</p>
6389
6390<pre class="code">
6391 MagickBooleanType MagickWhiteThresholdImage(MagickWand *wand,
6392 const PixelWand *threshold)
6393</pre>
6394
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6395<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6396
6397<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6398<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6399
6400<h5>threshold</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6401<p>the pixel wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6402
6403 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]6404<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6405_8c.html" id="MagickWriteImage">MagickWriteImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6406<div class="doc-section">
6407
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6408<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6409
6410<p>The format of the MagickWriteImage method is:</p>
6411
6412<pre class="code">
6413 MagickBooleanType MagickWriteImage(MagickWand *wand,
6414 const char *filename)
6415</pre>
6416
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6417<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6418
6419<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6420<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6421
6422<h5>filename</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6423<p>the image filename.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6424
6425
6426 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]6427<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6428_8c.html" id="MagickWriteImageFile">MagickWriteImageFile</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6429<div class="doc-section">
6430
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6431<p>MagickWriteImageFile() writes an image to an open file descriptor.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6432
6433<p>The format of the MagickWriteImageFile method is:</p>
6434
6435<pre class="code">
6436 MagickBooleanType MagickWriteImageFile(MagickWand *wand,FILE *file)
6437</pre>
6438
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6439<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6440
6441<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6442<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6443
6444<h5>file</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6445<p>the file descriptor.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6446
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6447 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]6448<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6449_8c.html" id="MagickWriteImages">MagickWriteImages</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6450<div class="doc-section">
6451
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6452<p>MagickWriteImages() writes an image or image sequence.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6453
6454<p>The format of the MagickWriteImages method is:</p>
6455
6456<pre class="code">
6457 MagickBooleanType MagickWriteImages(MagickWand *wand,
6458 const char *filename,const MagickBooleanType adjoin)
6459</pre>
6460
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6461<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6462
6463<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6464<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6465
6466<h5>filename</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6467<p>the image filename.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6468
6469<h5>adjoin</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6470<p>join images into a single multi-image file.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6471
6472 </div>
cristy70b59b62011-02-07 19:09:57 +0000[diff] [blame^]6473<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-image
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6474_8c.html" id="MagickWriteImagesFile">MagickWriteImagesFile</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6475<div class="doc-section">
6476
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6477<p>MagickWriteImagesFile() writes an image sequence to an open file descriptor.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6478
6479<p>The format of the MagickWriteImagesFile method is:</p>
6480
6481<pre class="code">
6482 MagickBooleanType MagickWriteImagesFile(MagickWand *wand,FILE *file)
6483</pre>
6484
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6485<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6486
6487<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6488<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6489
6490<h5>file</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6491<p>the file descriptor.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6492
6493 </div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]6494
6495</div>
6496
6497<div id="linkbar">
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]6498 <span id="linkbar-west">&nbsp;</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]6499 <span id="linkbar-center">
6500 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
cristya8902942010-07-30 00:49:52 +0000[diff] [blame]6501 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]6502 </span>
6503 <span id="linkbar-east">&nbsp;</span>
6504 </div>
6505 <div class="footer">
cristy4103d562010-12-10 01:38:54 +0000[diff] [blame]6506 <span id="footer-west">&copy; 1999-2011 ImageMagick Studio LLC</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]6507 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
6508 </div>
6509 <div style="clear: both; margin: 0; width: 100%; "></div>
cristya8902942010-07-30 00:49:52 +0000[diff] [blame]6510 <script type="text/javascript">
6511 var _gaq = _gaq || [];
6512 _gaq.push(['_setAccount', 'UA-17690367-1']);
6513 _gaq.push(['_trackPageview']);
6514
6515 (function() {
6516 var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
6517 ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
6518 var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
6519 })();
6520 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]6521</body>
6522</html>