Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ImageMagick / d0083a691be4f20dbc31bc86ee9fda8b9f2b0f40 / . / www / api / magick-image.html
blob: 29cde0e01abed77a5a825c9963d8fac0b40dd6db [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"/>
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]12 <meta name="Description" content="ImageMagick is a software suite to create, edit, compose, or convert bitmap images in a variety of formats. Use ImageMagick to scale, 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/">
55 <img src="../../images/logo.jpg" alt=""
cristy178edaf2011-01-23 03:42:39 +0000[diff] [blame]56 style="width: 123px; height: 118px; border: 0px; float: right;" /></a>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]57<a href="../../index.html">
58 <img src="../../images/sprite.jpg" alt=""
59 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
60</div>
61
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]62<div class="westbar">
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]63
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]64<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]65 <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]66</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]67<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]68<div class="menu">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]69 <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
70</div>
71<div class="sub">
72 <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
73</div>
74<div class="sub">
75 <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
76</div>
77<div class="sub">
78 <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
79</div>
80<div class="sep"></div>
81<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]82 <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]83</div>
84<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]85 <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]86</div>
87<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]88 <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]89</div>
90<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]91 <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]92</div>
93<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]94 <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]95</div>
96<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]97 <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]98</div>
99<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]100 <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]101</div>
102<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]103 <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]104</div>
105<div class="sub">
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]106 <a title="Program Interface: Magick++" href="../../www/magick++.html">Magick++</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]107</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]108<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]109<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]110 <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]111</div>
112<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]113 <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]114</div>
115<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]116 <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]117 </div>
118<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]119 <a title="Resources" href="../../www/resources.html">Resources</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]120</div>
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]121<div class="menu">
122 <a title="Architecture" href="../../www/architecture.html">Architecture</a>
123</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]124<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]125 <a title="Download" href="../../www/download.html">Download</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]126</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]127<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]128<div class="menu">
cristy52923442011-01-15 22:54:31 +0000[diff] [blame]129 <a title="Search" href="../../www/search.html">Search</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]130</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]131<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]132<div class="menu">
cristyffb69ed2010-12-25 00:06:48 +0000[diff] [blame]133 <a title="Site Map" href="../../www/sitemap.html">Site Map</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]134</div>
135<div class="sub">
cristyffb69ed2010-12-25 00:06:48 +0000[diff] [blame]136 <a title="Site Map: Links" href="../../www/links.html">Links</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]137</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]138<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]139<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]140 <a title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]141
142<div class="sponsbox">
cristy178edaf2011-01-23 03:42:39 +0000[diff] [blame]143<div class="sponsor">
144 <a title="Sponsor: Druckerei" href="http://www.allesdruck.de">Druckerei</a><!-- 201106010240 -->
145</div>
cristyec6b4752011-01-08 03:16:23 +0000[diff] [blame]146<div class="sponsor">
cristy52923442011-01-15 22:54:31 +0000[diff] [blame]147 <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]148</div>
149<div class="sponsor">
cristyc5baf4f2010-08-31 15:05:33 +0000[diff] [blame]150 <a title="Sponsor: Image Converter" href="http://www.batchphoto.com">Image Converter</a><!-- 201103010900 Bits Coffee-->
151</div>
152<div class="sponsor">
cristy851dbce2010-08-06 21:40:00 +0000[diff] [blame]153 <a title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
154</div>
cristyec6b4752011-01-08 03:16:23 +0000[diff] [blame]155<div class="sponsor">
cristy178edaf2011-01-23 03:42:39 +0000[diff] [blame]156 <a title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 -->
157</div>
158<div class="sponsor">
cristyc7a6e3e2011-01-26 16:54:03 +0000[diff] [blame]159 <a title="Sponsor: Fernsehdienst Berlin" href="http://www.atlas-multimedia.de">Fernsehdienst Berlin</a><!-- 2011050100025 atlas.multimedia-->
cristyec6b4752011-01-08 03:16:23 +0000[diff] [blame]160</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]161</div>
162</div>
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]163</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]164
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]165<div class="eastbar">
166 <script type="text/javascript">
167 <!--
168 google_ad_client = "pub-3129977114552745";
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]169 google_ad_slot = "0574824969";
170 google_ad_width = 160;
171 google_ad_height = 600;
172 //-->
173 </script>
174 <script type="text/javascript"
175 src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
176 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]177</div>
178
179<div class="main">
180
cristy307ba182010-12-25 01:00:34 +0000[diff] [blame]181<h1>Module magick-image
182 Methods</h1>
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]183<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]184
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]185<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
186_8c.html" id="GetImageFromMagickWand">GetImageFromMagickWand</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]187<div class="doc-section">
188
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]189<p>GetImageFromMagickWand() returns the current image from the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]190
191<p>The format of the GetImageFromMagickWand method is:</p>
192
193<pre class="code">
194 Image *GetImageFromMagickWand(const MagickWand *wand)
195</pre>
196
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]197<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]198
199<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]200<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]201
202 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]203<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
204_8c.html" id="MagickAdaptiveBlurImage">MagickAdaptiveBlurImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]205<div class="doc-section">
206
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]207<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]208
209<p>The format of the MagickAdaptiveBlurImage method is:</p>
210
211<pre class="code">
212 MagickBooleanType MagickAdaptiveBlurImage(MagickWand *wand,
213 const double radius,const double sigma)
214 MagickBooleanType MagickAdaptiveBlurImageChannel(MagickWand *wand,
215 const ChannelType channel,const double radius,const double sigma)
216</pre>
217
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]218<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]219
220<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]221<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]222
223<h5>channel</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]224<p>the image channel(s).</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]225
226<h5>radius</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]227<p>the radius of the Gaussian, in pixels, not counting the center pixel.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]228
229<h5>sigma</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]230<p>the standard deviation of the Gaussian, in pixels.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]231
232 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]233<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
234_8c.html" id="MagickAdaptiveResizeImage">MagickAdaptiveResizeImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]235<div class="doc-section">
236
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]237<p>MagickAdaptiveResizeImage() adaptively resize image with data dependent triangulation.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]238
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]239<p>MagickBooleanType MagickAdaptiveResizeImage(MagickWand *wand, const size_t columns,const size_t rows)</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]240
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]241<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]242
243<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]244<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]245
246<h5>columns</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]247<p>the number of columns in the scaled image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]248
249<h5>rows</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]250<p>the number of rows in the scaled image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]251
252 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]253<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
254_8c.html" id="MagickAdaptiveSharpenImage">MagickAdaptiveSharpenImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]255<div class="doc-section">
256
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]257<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]258
259<p>The format of the MagickAdaptiveSharpenImage method is:</p>
260
261<pre class="code">
262 MagickBooleanType MagickAdaptiveSharpenImage(MagickWand *wand,
263 const double radius,const double sigma)
264 MagickBooleanType MagickAdaptiveSharpenImageChannel(MagickWand *wand,
265 const ChannelType channel,const double radius,const double sigma)
266</pre>
267
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]268<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]269
270<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]271<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]272
273<h5>channel</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]274<p>the image channel(s).</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]275
276<h5>radius</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]277<p>the radius of the Gaussian, in pixels, not counting the center pixel.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]278
279<h5>sigma</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]280<p>the standard deviation of the Gaussian, in pixels.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]281
282 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]283<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
284_8c.html" id="MagickAdaptiveThresholdImage">MagickAdaptiveThresholdImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]285<div class="doc-section">
286
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]287<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]288
289<p>The format of the AdaptiveThresholdImage method is:</p>
290
291<pre class="code">
292 MagickBooleanType MagickAdaptiveThresholdImage(MagickWand *wand,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]293 const size_t width,const size_t height,const ssize_t offset)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]294</pre>
295
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]296<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]297
298<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]299<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]300
301<h5>width</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]302<p>the width of the local neighborhood.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]303
304<h5>height</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]305<p>the height of the local neighborhood.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]306
307<h5>offset</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]308<p>the mean offset.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]309
310 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]311<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
312_8c.html" id="MagickAddImage">MagickAddImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]313<div class="doc-section">
314
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]315<p>MagickAddImage() adds the specified images at the current image location.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]316
317<p>The format of the MagickAddImage method is:</p>
318
319<pre class="code">
320 MagickBooleanType MagickAddImage(MagickWand *wand,
321 const MagickWand *add_wand)
322</pre>
323
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]324<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]325
326<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]327<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]328
329<h5>add_wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]330<p>A wand that contains images to add at the current image location.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]331
332 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]333<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
334_8c.html" id="MagickAddNoiseImage">MagickAddNoiseImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]335<div class="doc-section">
336
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]337<p>MagickAddNoiseImage() adds random noise to the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]338
339<p>The format of the MagickAddNoiseImage method is:</p>
340
341<pre class="code">
342 MagickBooleanType MagickAddNoiseImage(MagickWand *wand,
343 const NoiseType noise_type)
344 MagickBooleanType MagickAddNoiseImageChannel(MagickWand *wand,
345 const ChannelType channel,const NoiseType noise_type)
346</pre>
347
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]348<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]349
350<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]351<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]352
353<h5>channel</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]354<p>the image channel(s).</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]355
356<h5>noise_type</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]357<p>The type of noise: Uniform, Gaussian, Multiplicative, Impulse, Laplacian, or Poisson.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]358
359 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]360<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
361_8c.html" id="MagickAffineTransformImage">MagickAffineTransformImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]362<div class="doc-section">
363
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]364<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]365
366<p>The format of the MagickAffineTransformImage method is:</p>
367
368<pre class="code">
369 MagickBooleanType MagickAffineTransformImage(MagickWand *wand,
370 const DrawingWand *drawing_wand)
371</pre>
372
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]373<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]374
375<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]376<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]377
378<h5>drawing_wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]379<p>the draw wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]380
381 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]382<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
383_8c.html" id="MagickAnnotateImage">MagickAnnotateImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]384<div class="doc-section">
385
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]386<p>MagickAnnotateImage() annotates an image with text.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]387
388<p>The format of the MagickAnnotateImage method is:</p>
389
390<pre class="code">
391 MagickBooleanType MagickAnnotateImage(MagickWand *wand,
392 const DrawingWand *drawing_wand,const double x,const double y,
393 const double angle,const char *text)
394</pre>
395
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]396<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]397
398<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]399<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]400
401<h5>drawing_wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]402<p>the draw wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]403
404<h5>x</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]405<p>x ordinate to left of text</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]406
407<h5>y</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]408<p>y ordinate to text baseline</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]409
410<h5>angle</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]411<p>rotate text relative to this angle.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]412
413<h5>text</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]414<p>text to draw</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]415
416 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]417<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
418_8c.html" id="MagickAnimateImages">MagickAnimateImages</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]419<div class="doc-section">
420
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]421<p>MagickAnimateImages() animates an image or image sequence.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]422
423<p>The format of the MagickAnimateImages method is:</p>
424
425<pre class="code">
426 MagickBooleanType MagickAnimateImages(MagickWand *wand,
427 const char *server_name)
428</pre>
429
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]430<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]431
432<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]433<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]434
435<h5>server_name</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]436<p>the X server name.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]437
438 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]439<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
440_8c.html" id="MagickAppendImages">MagickAppendImages</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]441<div class="doc-section">
442
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]443<p>MagickAppendImages() append a set of images.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]444
445<p>The format of the MagickAppendImages method is:</p>
446
447<pre class="code">
448 MagickWand *MagickAppendImages(MagickWand *wand,
449 const MagickBooleanType stack)
450</pre>
451
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]452<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]453
454<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]455<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]456
457<h5>stack</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]458<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]459
460 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]461<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
462_8c.html" id="MagickAutoGammaImage">MagickAutoGammaImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]463<div class="doc-section">
464
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]465<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]466
467<p>The format of the MagickAutoGammaImage method is:</p>
468
469<pre class="code">
470 MagickBooleanType MagickAutoGammaImage(MagickWand *wand)
471 MagickBooleanType MagickAutoGammaImageChannel(MagickWand *wand,
472 const ChannelType channel)
473</pre>
474
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]475<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]476
477<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]478<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]479
480<h5>channel</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]481<p>the image channel(s).</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]482
483 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]484<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
485_8c.html" id="MagickAutoLevelImage">MagickAutoLevelImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]486<div class="doc-section">
487
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]488<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]489
490<p>The format of the MagickAutoLevelImage method is:</p>
491
492<pre class="code">
493 MagickBooleanType MagickAutoLevelImage(MagickWand *wand)
494 MagickBooleanType MagickAutoLevelImageChannel(MagickWand *wand,
495 const ChannelType channel)
496</pre>
497
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]498<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]499
500<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]501<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]502
503<h5>channel</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]504<p>the image channel(s).</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]505
506 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]507<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
508_8c.html" id="MagickBlackThresholdImage">MagickBlackThresholdImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]509<div class="doc-section">
510
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]511<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]512
513<p>The format of the MagickBlackThresholdImage method is:</p>
514
515<pre class="code">
516 MagickBooleanType MagickBlackThresholdImage(MagickWand *wand,
517 const PixelWand *threshold)
518</pre>
519
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]520<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]521
522<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]523<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]524
525<h5>threshold</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]526<p>the pixel wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]527
528 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]529<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
530_8c.html" id="MagickBlueShiftImage">MagickBlueShiftImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]531<div class="doc-section">
532
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]533<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]534
535<p>The format of the MagickBlueShiftImage method is:</p>
536
537<pre class="code">
538 MagickBooleanType MagickBlueShiftImage(MagickWand *wand,
539 const double factor)
540</pre>
541
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]542<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]543
544<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]545<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]546
547<h5>factor</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]548<p>the blue shift factor (default 1.5)</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]549
550 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]551<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
552_8c.html" id="MagickBlurImage">MagickBlurImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]553<div class="doc-section">
554
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]555<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]556
557<p>The format of the MagickBlurImage method is:</p>
558
559<pre class="code">
560 MagickBooleanType MagickBlurImage(MagickWand *wand,const double radius,
561 const double sigma)
562 MagickBooleanType MagickBlurImageChannel(MagickWand *wand,
563 const ChannelType channel,const double radius,const double sigma)
564</pre>
565
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]566<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]567
568<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]569<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]570
571<h5>channel</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]572<p>the image channel(s).</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]573
574<h5>radius</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]575<p>the radius of the , in pixels, not counting the center pixel.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]576
577<h5>sigma</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]578<p>the standard deviation of the , in pixels.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]579
580 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]581<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
582_8c.html" id="MagickBorderImage">MagickBorderImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]583<div class="doc-section">
584
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]585<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]586
587<p>The format of the MagickBorderImage method is:</p>
588
589<pre class="code">
590 MagickBooleanType MagickBorderImage(MagickWand *wand,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]591 const PixelWand *bordercolor,const size_t width,
592 const size_t height)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]593</pre>
594
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]595<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]596
597<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]598<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]599
600<h5>bordercolor</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]601<p>the border color pixel wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]602
603<h5>width</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]604<p>the border width.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]605
606<h5>height</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]607<p>the border height.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]608
609 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]610<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
611_8c.html" id="Use_MagickBrightnessContrastImage">Use MagickBrightnessContrastImage</a></h2>
cristy16ff93c2010-01-13 23:18:07 +0000[diff] [blame]612<div class="doc-section">
613
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]614<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]615
616
617<p>The format of the MagickBrightnessContrastImage method is:</p>
618
619<pre class="code">
620 MagickBooleanType MagickBrightnessContrastImage(MagickWand *wand,
621 const double brightness,const double contrast)
622 MagickBooleanType MagickBrightnessContrastImageChannel(MagickWand *wand,
623 const ChannelType channel,const double brightness,
624 const double contrast)
625</pre>
626
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]627<p>A description of each parameter follows:</p>
cristy16ff93c2010-01-13 23:18:07 +0000[diff] [blame]628
629<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]630<p>the magick wand.</p>
cristy16ff93c2010-01-13 23:18:07 +0000[diff] [blame]631
632<h5>channel</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]633<p>the image channel(s).</p>
cristy16ff93c2010-01-13 23:18:07 +0000[diff] [blame]634
635<h5>brightness</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]636<p>the brightness percent (-100 .. 100).</p>
cristy16ff93c2010-01-13 23:18:07 +0000[diff] [blame]637
638<h5>contrast</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]639<p>the contrast percent (-100 .. 100).</p>
cristy16ff93c2010-01-13 23:18:07 +0000[diff] [blame]640
641 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]642<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
643_8c.html" id="MagickCharcoalImage">MagickCharcoalImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]644<div class="doc-section">
645
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]646<p>MagickCharcoalImage() simulates a charcoal drawing.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]647
648<p>The format of the MagickCharcoalImage method is:</p>
649
650<pre class="code">
651 MagickBooleanType MagickCharcoalImage(MagickWand *wand,
652 const double radius,const double sigma)
653</pre>
654
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]655<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]656
657<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]658<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]659
660<h5>radius</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]661<p>the radius of the Gaussian, in pixels, not counting the center pixel.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]662
663<h5>sigma</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]664<p>the standard deviation of the Gaussian, in pixels.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]665
666 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]667<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
668_8c.html" id="MagickChopImage">MagickChopImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]669<div class="doc-section">
670
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]671<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]672
673<p>The format of the MagickChopImage method is:</p>
674
675<pre class="code">
676 MagickBooleanType MagickChopImage(MagickWand *wand,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]677 const size_t width,const size_t height,const ssize_t x,
678 const ssize_t y)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]679</pre>
680
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]681<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]682
683<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]684<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]685
686<h5>width</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]687<p>the region width.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]688
689<h5>height</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]690<p>the region height.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]691
692<h5>x</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]693<p>the region x offset.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]694
695<h5>y</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]696<p>the region y offset.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]697
698
699 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]700<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
701_8c.html" id="MagickClampImage">MagickClampImage</a></h2>
cristyb4c03bb2009-09-27 13:55:46 +0000[diff] [blame]702<div class="doc-section">
703
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]704<p>MagickClampImage() restricts the color range from 0 to the quantum depth.</p>
cristyb4c03bb2009-09-27 13:55:46 +0000[diff] [blame]705
706<p>The format of the MagickClampImage method is:</p>
707
708<pre class="code">
709 MagickBooleanType MagickClampImage(MagickWand *wand)
710 MagickBooleanType MagickClampImageChannel(MagickWand *wand,
711 const ChannelType channel)
712</pre>
713
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]714<p>A description of each parameter follows:</p>
cristyb4c03bb2009-09-27 13:55:46 +0000[diff] [blame]715
716<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]717<p>the magick wand.</p>
cristyb4c03bb2009-09-27 13:55:46 +0000[diff] [blame]718
719<h5>channel</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]720<p>the channel.</p>
cristyb4c03bb2009-09-27 13:55:46 +0000[diff] [blame]721
722 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]723<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
724_8c.html" id="MagickClipImage">MagickClipImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]725<div class="doc-section">
726
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]727<p>MagickClipImage() clips along the first path from the 8BIM profile, if present.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]728
729<p>The format of the MagickClipImage method is:</p>
730
731<pre class="code">
732 MagickBooleanType MagickClipImage(MagickWand *wand)
733</pre>
734
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]735<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]736
737<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]738<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]739
740 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]741<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
742_8c.html" id="MagickClipImagePath">MagickClipImagePath</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]743<div class="doc-section">
744
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]745<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]746
747<p>The format of the MagickClipImagePath method is:</p>
748
749<pre class="code">
750 MagickBooleanType MagickClipImagePath(MagickWand *wand,
751 const char *pathname,const MagickBooleanType inside)
752</pre>
753
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]754<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]755
756<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]757<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]758
759<h5>pathname</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]760<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]761
762<h5>inside</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]763<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]764
765 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]766<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
767_8c.html" id="MagickClutImage">MagickClutImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]768<div class="doc-section">
769
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]770<p>MagickClutImage() replaces colors in the image from a color lookup table.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]771
772<p>The format of the MagickClutImage method is:</p>
773
774<pre class="code">
775 MagickBooleanType MagickClutImage(MagickWand *wand,
776 const MagickWand *clut_wand)
777 MagickBooleanType MagickClutImageChannel(MagickWand *wand,
778 const ChannelType channel,const MagickWand *clut_wand)
779</pre>
780
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]781<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]782
783<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]784<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]785
786<h5>clut_image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]787<p>the clut image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]788
789 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]790<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
791_8c.html" id="MagickCoalesceImages">MagickCoalesceImages</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]792<div class="doc-section">
793
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]794<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]795
796<p>The format of the MagickCoalesceImages method is:</p>
797
798<pre class="code">
799 MagickWand *MagickCoalesceImages(MagickWand *wand)
800</pre>
801
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]802<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]803
804<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]805<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]806
807 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]808<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
809_8c.html" id="MagickColorDecisionListImage">MagickColorDecisionListImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]810<div class="doc-section">
811
812<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>
813
814<pre class="text">
815 <ColorCorrectionCollection xmlns="urn:ASC:CDL:v1.2">
816 <ColorCorrection id="cc03345">
817 <SOPNode>
818 <Slope> 0.9 1.2 0.5 </Slope>
819 <Offset> 0.4 -0.5 0.6 </Offset>
820 <Power> 1.0 0.8 1.5 </Power>
821 </SOPNode>
822 <SATNode>
823 <Saturation> 0.85 </Saturation>
824 </SATNode>
825 </ColorCorrection>
826 </ColorCorrectionCollection>
827</pre>
828
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]829<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]830
831<p>The format of the MagickColorDecisionListImage method is:</p>
832
833<pre class="code">
834 MagickBooleanType MagickColorDecisionListImage(MagickWand *wand,
835 const double gamma)
836</pre>
837
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]838<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]839
840<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]841<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]842
843<h5>color_correction_collection</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]844<p>the color correction collection in XML.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]845
846 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]847<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
848_8c.html" id="MagickColorizeImage">MagickColorizeImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]849<div class="doc-section">
850
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]851<p>MagickColorizeImage() blends the fill color with each pixel in the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]852
853<p>The format of the MagickColorizeImage method is:</p>
854
855<pre class="code">
856 MagickBooleanType MagickColorizeImage(MagickWand *wand,
857 const PixelWand *colorize,const PixelWand *opacity)
858</pre>
859
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]860<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]861
862<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]863<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]864
865<h5>colorize</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]866<p>the colorize pixel wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]867
868<h5>opacity</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]869<p>the opacity pixel wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]870
871 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]872<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
873_8c.html" id="MagickColorMatrixImage">MagickColorMatrixImage</a></h2>
cristy0291e2d2010-04-04 17:50:18 +0000[diff] [blame]874<div class="doc-section">
875
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]876<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]877
878<p>The format of the MagickColorMatrixImage method is:</p>
879
880<pre class="code">
881 MagickBooleanType MagickColorMatrixImage(MagickWand *wand,
882 const KernelInfo *color_matrix)
883</pre>
884
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]885<p>A description of each parameter follows:</p>
cristy0291e2d2010-04-04 17:50:18 +0000[diff] [blame]886
887<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]888<p>the magick wand.</p>
cristy0291e2d2010-04-04 17:50:18 +0000[diff] [blame]889
890<h5>color_matrix</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]891<p>the color matrix.</p>
cristy0291e2d2010-04-04 17:50:18 +0000[diff] [blame]892
893 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]894<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
895_8c.html" id="MagickCombineImages">MagickCombineImages</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]896<div class="doc-section">
897
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]898<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]899
900<p>The format of the MagickCombineImages method is:</p>
901
902<pre class="code">
903 MagickWand *MagickCombineImages(MagickWand *wand,
904 const ChannelType channel)
905</pre>
906
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]907<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]908
909<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]910<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]911
912<h5>channel</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]913<p>the channel.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]914
915 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]916<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
917_8c.html" id="MagickCommentImage">MagickCommentImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]918<div class="doc-section">
919
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]920<p>MagickCommentImage() adds a comment to your image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]921
922<p>The format of the MagickCommentImage method is:</p>
923
924<pre class="code">
925 MagickBooleanType MagickCommentImage(MagickWand *wand,
926 const char *comment)
927</pre>
928
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]929<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]930
931<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]932<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]933
934<h5>comment</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]935<p>the image comment.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]936
937 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]938<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
939_8c.html" id="MagickCompareImageChannels">MagickCompareImageChannels</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]940<div class="doc-section">
941
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]942<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]943
944<p>The format of the MagickCompareImageChannels method is:</p>
945
946<pre class="code">
947 MagickWand *MagickCompareImageChannels(MagickWand *wand,
948 const MagickWand *reference,const ChannelType channel,
949 const MetricType metric,double *distortion)
950</pre>
951
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]952<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]953
954<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]955<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]956
957<h5>reference</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]958<p>the reference wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]959
960<h5>channel</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]961<p>the channel.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]962
963<h5>metric</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]964<p>the metric.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]965
966<h5>distortion</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]967<p>the computed distortion between the images.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]968
969 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]970<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
971_8c.html" id="MagickCompareImageLayers">MagickCompareImageLayers</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]972<div class="doc-section">
973
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]974<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]975
976<p>The format of the MagickCompareImageLayers method is:</p>
977
978<pre class="code">
979 MagickWand *MagickCompareImageLayers(MagickWand *wand,
980 const ImageLayerMethod method)
981</pre>
982
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]983<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]984
985<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]986<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]987
988<h5>method</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]989<p>the compare method.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]990
991 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]992<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
993_8c.html" id="MagickCompareImages">MagickCompareImages</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]994<div class="doc-section">
995
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]996<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]997
998<p>The format of the MagickCompareImages method is:</p>
999
1000<pre class="code">
1001 MagickWand *MagickCompareImages(MagickWand *wand,
1002 const MagickWand *reference,const MetricType metric,
1003 double *distortion)
1004</pre>
1005
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1006<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1007
1008<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1009<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1010
1011<h5>reference</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1012<p>the reference wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1013
1014<h5>metric</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1015<p>the metric.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1016
1017<h5>distortion</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1018<p>the computed distortion between the images.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1019
1020 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1021<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
1022_8c.html" id="MagickCompositeImage">MagickCompositeImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1023<div class="doc-section">
1024
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1025<p>MagickCompositeImage() composite one image onto another at the specified offset.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1026
1027<p>The format of the MagickCompositeImage method is:</p>
1028
1029<pre class="code">
1030 MagickBooleanType MagickCompositeImage(MagickWand *wand,
1031 const MagickWand *composite_wand,const CompositeOperator compose,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]1032 const ssize_t x,const ssize_t y)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1033 MagickBooleanType MagickCompositeImageChannel(MagickWand *wand,
1034 const ChannelType channel,const MagickWand *composite_wand,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]1035 const CompositeOperator compose,const ssize_t x,const ssize_t y)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1036</pre>
1037
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1038<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1039
1040<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1041<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1042
1043<h5>composite_image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1044<p>the composite image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1045
1046<h5>compose</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1047<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]1048
1049<pre class="text">
1050 OverCompositeOp InCompositeOp OutCompositeOp
1051 AtopCompositeOp XorCompositeOp PlusCompositeOp
1052 MinusCompositeOp AddCompositeOp SubtractCompositeOp
1053 DifferenceCompositeOp BumpmapCompositeOp CopyCompositeOp
1054 DisplaceCompositeOp
1055</pre>
1056
1057<h5>x</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1058<p>the column offset of the composited image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1059
1060<h5>y</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1061<p>the row offset of the composited image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1062
1063 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1064<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
1065_8c.html" id="MagickContrastImage">MagickContrastImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1066<div class="doc-section">
1067
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1068<p>MagickContrastImage() enhances the intensity differences between the lighter and darker elements of the image. Set sharpen to a value other than 0 to increase the image contrast otherwise the contrast is reduced.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1069
1070<p>The format of the MagickContrastImage method is:</p>
1071
1072<pre class="code">
1073 MagickBooleanType MagickContrastImage(MagickWand *wand,
1074 const MagickBooleanType sharpen)
1075</pre>
1076
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1077<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1078
1079<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1080<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1081
1082<h5>sharpen</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1083<p>Increase or decrease image contrast.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1084
1085
1086 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1087<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
1088_8c.html" id="MagickContrastStretchImage">MagickContrastStretchImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1089<div class="doc-section">
1090
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1091<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]1092
1093<p>The format of the MagickContrastStretchImage method is:</p>
1094
1095<pre class="code">
1096 MagickBooleanType MagickContrastStretchImage(MagickWand *wand,
1097 const double black_point,const double white_point)
1098 MagickBooleanType MagickContrastStretchImageChannel(MagickWand *wand,
1099 const ChannelType channel,const double black_point,
1100 const double white_point)
1101</pre>
1102
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1103<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1104
1105<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1106<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1107
1108<h5>channel</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1109<p>the image channel(s).</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1110
1111<h5>black_point</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1112<p>the black point.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1113
1114<h5>white_point</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1115<p>the white point.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1116
1117 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1118<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
1119_8c.html" id="MagickConvolveImage">MagickConvolveImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1120<div class="doc-section">
1121
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1122<p>MagickConvolveImage() applies a custom convolution kernel to the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1123
1124<p>The format of the MagickConvolveImage method is:</p>
1125
1126<pre class="code">
1127 MagickBooleanType MagickConvolveImage(MagickWand *wand,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]1128 const size_t order,const double *kernel)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1129 MagickBooleanType MagickConvolveImageChannel(MagickWand *wand,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]1130 const ChannelType channel,const size_t order,
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1131 const double *kernel)
1132</pre>
1133
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1134<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1135
1136<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1137<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1138
1139<h5>channel</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1140<p>the image channel(s).</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1141
1142<h5>order</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1143<p>the number of columns and rows in the filter kernel.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1144
1145<h5>kernel</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1146<p>An array of doubles representing the convolution kernel.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1147
1148 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1149<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
1150_8c.html" id="MagickCropImage">MagickCropImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1151<div class="doc-section">
1152
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1153<p>MagickCropImage() extracts a region of the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1154
1155<p>The format of the MagickCropImage method is:</p>
1156
1157<pre class="code">
1158 MagickBooleanType MagickCropImage(MagickWand *wand,
cristy85278ed2010-05-31 15:10:05 +0000[diff] [blame]1159 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]1160</pre>
1161
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1162<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1163
1164<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1165<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1166
1167<h5>width</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1168<p>the region width.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1169
1170<h5>height</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1171<p>the region height.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1172
1173<h5>x</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1174<p>the region x-offset.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1175
1176<h5>y</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1177<p>the region y-offset.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1178
1179 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1180<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
1181_8c.html" id="MagickCycleColormapImage">MagickCycleColormapImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1182<div class="doc-section">
1183
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1184<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]1185
1186<p>The format of the MagickCycleColormapImage method is:</p>
1187
1188<pre class="code">
1189 MagickBooleanType MagickCycleColormapImage(MagickWand *wand,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]1190 const ssize_t displace)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1191</pre>
1192
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1193<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1194
1195<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1196<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1197
1198<h5>pixel_wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1199<p>the pixel wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1200
1201 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1202<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
1203_8c.html" id="MagickConstituteImage">MagickConstituteImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1204<div class="doc-section">
1205
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1206<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]1207
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1208<p>MagickConstituteImage(wand,640,640,"RGB",CharPixel,pixels);</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1209
1210<p>The format of the MagickConstituteImage method is:</p>
1211
1212<pre class="code">
1213 MagickBooleanType MagickConstituteImage(MagickWand *wand,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]1214 const size_t columns,const size_t rows,const char *map,
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1215 const StorageType storage,void *pixels)
1216</pre>
1217
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1218<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1219
1220<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1221<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1222
1223<h5>columns</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1224<p>width in pixels of the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1225
1226<h5>rows</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1227<p>height in pixels of the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1228
1229<h5>map</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1230<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]1231
1232<h5>storage</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1233<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]1234
1235<h5>pixels</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1236<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]1237
1238
1239 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1240<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
1241_8c.html" id="MagickDecipherImage">MagickDecipherImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1242<div class="doc-section">
1243
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1244<p>MagickDecipherImage() converts cipher pixels to plain pixels.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1245
1246<p>The format of the MagickDecipherImage method is:</p>
1247
1248<pre class="code">
1249 MagickBooleanType MagickDecipherImage(MagickWand *wand,
1250 const char *passphrase)
1251</pre>
1252
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1253<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1254
1255<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1256<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1257
1258<h5>passphrase</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1259<p>the passphrase.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1260
1261 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1262<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
1263_8c.html" id="MagickDeconstructImages">MagickDeconstructImages</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1264<div class="doc-section">
1265
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1266<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]1267
1268<p>The format of the MagickDeconstructImages method is:</p>
1269
1270<pre class="code">
1271 MagickWand *MagickDeconstructImages(MagickWand *wand)
1272</pre>
1273
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1274<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1275
1276<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1277<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1278
1279 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1280<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
1281_8c.html" id="MagickDeskewImage">MagickDeskewImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1282<div class="doc-section">
1283
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1284<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]1285
1286<p>The format of the MagickDeskewImage method is:</p>
1287
1288<pre class="code">
1289 MagickBooleanType MagickDeskewImage(MagickWand *wand,
1290 const double threshold)
1291</pre>
1292
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1293<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1294
1295<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1296<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1297
1298<h5>threshold</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1299<p>separate background from foreground.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1300
1301 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1302<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
1303_8c.html" id="MagickDespeckleImage">MagickDespeckleImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1304<div class="doc-section">
1305
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1306<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]1307
1308<p>The format of the MagickDespeckleImage method is:</p>
1309
1310<pre class="code">
1311 MagickBooleanType MagickDespeckleImage(MagickWand *wand)
1312</pre>
1313
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1314<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1315
1316<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1317<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1318
1319 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1320<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
1321_8c.html" id="MagickDestroyImage">MagickDestroyImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1322<div class="doc-section">
1323
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1324<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]1325
1326<p>The format of the MagickDestroyImage method is:</p>
1327
1328<pre class="code">
1329 Image *MagickDestroyImage(Image *image)
1330</pre>
1331
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1332<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1333
1334<h5>image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1335<p>the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1336
1337 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1338<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
1339_8c.html" id="MagickDisplayImage">MagickDisplayImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1340<div class="doc-section">
1341
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1342<p>MagickDisplayImage() displays an image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1343
1344<p>The format of the MagickDisplayImage method is:</p>
1345
1346<pre class="code">
1347 MagickBooleanType MagickDisplayImage(MagickWand *wand,
1348 const char *server_name)
1349</pre>
1350
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1351<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1352
1353<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1354<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1355
1356<h5>server_name</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1357<p>the X server name.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1358
1359 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1360<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
1361_8c.html" id="MagickDisplayImages">MagickDisplayImages</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1362<div class="doc-section">
1363
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1364<p>MagickDisplayImages() displays an image or image sequence.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1365
1366<p>The format of the MagickDisplayImages method is:</p>
1367
1368<pre class="code">
1369 MagickBooleanType MagickDisplayImages(MagickWand *wand,
1370 const char *server_name)
1371</pre>
1372
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1373<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1374
1375<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1376<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1377
1378<h5>server_name</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1379<p>the X server name.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1380
1381 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1382<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
1383_8c.html" id="MagickDistortImage">MagickDistortImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1384<div class="doc-section">
1385
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1386<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]1387
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1388<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]1389
1390<p>The format of the MagickDistortImage method is:</p>
1391
1392<pre class="code">
1393 MagickBooleanType MagickDistortImage(MagickWand *wand,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]1394 const DistortImageMethod method,const size_t number_arguments,
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1395 const double *arguments,const MagickBooleanType bestfit)
1396</pre>
1397
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1398<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1399
1400<h5>image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1401<p>the image to be distorted.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1402
1403<h5>method</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1404<p>the method of image distortion.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1405
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1406<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]1407
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1408<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]1409
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1410<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]1411
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1412<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]1413
1414<h5>number_arguments</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1415<p>the number of arguments given for this distortion method.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1416
1417<h5>arguments</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1418<p>the arguments for this distortion method.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1419
1420<h5>bestfit</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1421<p>Attempt to resize destination to fit distorted source.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1422
1423 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1424<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
1425_8c.html" id="MagickDrawImage">MagickDrawImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1426<div class="doc-section">
1427
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1428<p>MagickDrawImage() renders the drawing wand on the current image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1429
1430<p>The format of the MagickDrawImage method is:</p>
1431
1432<pre class="code">
1433 MagickBooleanType MagickDrawImage(MagickWand *wand,
1434 const DrawingWand *drawing_wand)
1435</pre>
1436
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1437<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1438
1439<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1440<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1441
1442<h5>drawing_wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1443<p>the draw wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1444
1445 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1446<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
1447_8c.html" id="MagickEdgeImage">MagickEdgeImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1448<div class="doc-section">
1449
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1450<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]1451
1452<p>The format of the MagickEdgeImage method is:</p>
1453
1454<pre class="code">
1455 MagickBooleanType MagickEdgeImage(MagickWand *wand,const double radius)
1456</pre>
1457
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1458<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1459
1460<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1461<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1462
1463<h5>radius</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1464<p>the radius of the pixel neighborhood.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1465
1466 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1467<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
1468_8c.html" id="MagickEmbossImage">MagickEmbossImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1469<div class="doc-section">
1470
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1471<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]1472
1473<p>The format of the MagickEmbossImage method is:</p>
1474
1475<pre class="code">
1476 MagickBooleanType MagickEmbossImage(MagickWand *wand,const double radius,
1477 const double sigma)
1478</pre>
1479
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1480<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1481
1482<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1483<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1484
1485<h5>radius</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1486<p>the radius of the Gaussian, in pixels, not counting the center pixel.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1487
1488<h5>sigma</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1489<p>the standard deviation of the Gaussian, in pixels.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1490
1491 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1492<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
1493_8c.html" id="MagickEncipherImage">MagickEncipherImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1494<div class="doc-section">
1495
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1496<p>MagickEncipherImage() converts plaint pixels to cipher pixels.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1497
1498<p>The format of the MagickEncipherImage method is:</p>
1499
1500<pre class="code">
1501 MagickBooleanType MagickEncipherImage(MagickWand *wand,
1502 const char *passphrase)
1503</pre>
1504
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1505<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1506
1507<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1508<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1509
1510<h5>passphrase</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1511<p>the passphrase.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1512
1513 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1514<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
1515_8c.html" id="MagickEnhanceImage">MagickEnhanceImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1516<div class="doc-section">
1517
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1518<p>MagickEnhanceImage() applies a digital filter that improves the quality of a noisy image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1519
1520<p>The format of the MagickEnhanceImage method is:</p>
1521
1522<pre class="code">
1523 MagickBooleanType MagickEnhanceImage(MagickWand *wand)
1524</pre>
1525
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1526<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1527
1528<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1529<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1530
1531 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1532<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
1533_8c.html" id="MagickEqualizeImage">MagickEqualizeImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1534<div class="doc-section">
1535
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1536<p>MagickEqualizeImage() equalizes the image histogram.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1537
1538<p>The format of the MagickEqualizeImage method is:</p>
1539
1540<pre class="code">
1541 MagickBooleanType MagickEqualizeImage(MagickWand *wand)
1542 MagickBooleanType MagickEqualizeImageChannel(MagickWand *wand,
1543 const ChannelType channel)
1544</pre>
1545
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1546<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1547
1548<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1549<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1550
1551<h5>channel</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1552<p>the image channel(s).</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1553
1554 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1555<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
1556_8c.html" id="MagickEvaluateImage">MagickEvaluateImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1557<div class="doc-section">
1558
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1559<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]1560
1561<p>The format of the MagickEvaluateImage method is:</p>
1562
1563<pre class="code">
1564 MagickBooleanType MagickEvaluateImage(MagickWand *wand,
1565 const MagickEvaluateOperator operator,const double value)
cristy63fed272010-03-07 19:08:45 +0000[diff] [blame]1566 MagickBooleanType MagickEvaluateImages(MagickWand *wand,
1567 const MagickEvaluateOperator operator)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1568 MagickBooleanType MagickEvaluateImageChannel(MagickWand *wand,
1569 const ChannelType channel,const MagickEvaluateOperator op,
1570 const double value)
1571</pre>
1572
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1573<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1574
1575<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1576<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1577
1578<h5>channel</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1579<p>the channel(s).</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1580
1581<h5>op</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1582<p>A channel operator.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1583
1584<h5>value</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1585<p>A value value.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1586
1587 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1588<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
1589_8c.html" id="MagickExportImagePixels">MagickExportImagePixels</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1590<div class="doc-section">
1591
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1592<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]1593
1594<p>Suppose you want to extract the first scanline of a 640x480 image as character data in red-green-blue order:</p>
1595
1596<pre class="text">
1597 MagickExportImagePixels(wand,0,0,640,1,"RGB",CharPixel,pixels);
1598</pre>
1599
1600<p>The format of the MagickExportImagePixels method is:</p>
1601
1602<pre class="code">
1603 MagickBooleanType MagickExportImagePixels(MagickWand *wand,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]1604 const ssize_t x,const ssize_t y,const size_t columns,
1605 const size_t rows,const char *map,const StorageType storage,
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1606 void *pixels)
1607</pre>
1608
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1609<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1610
1611<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1612<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1613
1614<h5>x, y, columns, rows</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1615<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]1616
1617<h5>map</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1618<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]1619
1620<h5>storage</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1621<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]1622
1623<h5>pixels</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1624<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]1625
1626 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1627<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
1628_8c.html" id="MagickExtentImage">MagickExtentImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1629<div class="doc-section">
1630
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1631<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]1632
1633<p>The format of the MagickExtentImage method is:</p>
1634
1635<pre class="code">
1636 MagickBooleanType MagickExtentImage(MagickWand *wand,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]1637 const size_t width,const size_t height,const ssize_t x,
1638 const ssize_t y)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1639</pre>
1640
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1641<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1642
1643<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1644<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1645
1646<h5>width</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1647<p>the region width.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1648
1649<h5>height</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1650<p>the region height.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1651
1652<h5>x</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1653<p>the region x offset.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1654
1655<h5>y</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1656<p>the region y offset.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1657
1658 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1659<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
1660_8c.html" id="MagickFilterImage">MagickFilterImage</a></h2>
cristy16ff93c2010-01-13 23:18:07 +0000[diff] [blame]1661<div class="doc-section">
1662
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1663<p>MagickFilterImage() applies a custom convolution kernel to the image.</p>
cristy16ff93c2010-01-13 23:18:07 +0000[diff] [blame]1664
1665<p>The format of the MagickFilterImage method is:</p>
1666
1667<pre class="code">
1668 MagickBooleanType MagickFilterImage(MagickWand *wand,
cristy488844c2010-01-22 14:02:05 +0000[diff] [blame]1669 const KernelInfo *kernel)
cristy16ff93c2010-01-13 23:18:07 +0000[diff] [blame]1670 MagickBooleanType MagickFilterImageChannel(MagickWand *wand,
cristy488844c2010-01-22 14:02:05 +0000[diff] [blame]1671 const ChannelType channel,const KernelInfo *kernel)
cristy16ff93c2010-01-13 23:18:07 +0000[diff] [blame]1672</pre>
1673
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1674<p>A description of each parameter follows:</p>
cristy16ff93c2010-01-13 23:18:07 +0000[diff] [blame]1675
1676<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1677<p>the magick wand.</p>
cristy16ff93c2010-01-13 23:18:07 +0000[diff] [blame]1678
1679<h5>channel</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1680<p>the image channel(s).</p>
cristy16ff93c2010-01-13 23:18:07 +0000[diff] [blame]1681
1682<h5>kernel</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1683<p>An array of doubles representing the convolution kernel.</p>
cristy16ff93c2010-01-13 23:18:07 +0000[diff] [blame]1684
1685 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1686<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
1687_8c.html" id="MagickFlipImage">MagickFlipImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1688<div class="doc-section">
1689
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1690<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]1691
1692<p>The format of the MagickFlipImage method is:</p>
1693
1694<pre class="code">
1695 MagickBooleanType MagickFlipImage(MagickWand *wand)
1696</pre>
1697
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1698<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1699
1700<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1701<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1702
1703 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1704<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
1705_8c.html" id="MagickFloodfillPaintImage">MagickFloodfillPaintImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1706<div class="doc-section">
1707
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1708<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]1709
1710<p>The format of the MagickFloodfillPaintImage method is:</p>
1711
1712<pre class="code">
1713 MagickBooleanType MagickFloodfillPaintImage(MagickWand *wand,
1714 const ChannelType channel,const PixelWand *fill,const double fuzz,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]1715 const PixelWand *bordercolor,const ssize_t x,const ssize_t y,
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1716 const MagickBooleanType invert)
1717</pre>
1718
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1719<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1720
1721<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1722<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1723
1724<h5>channel</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1725<p>the channel(s).</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1726
1727<h5>fill</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1728<p>the floodfill color pixel wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1729
1730<h5>fuzz</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1731<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]1732
1733<h5>bordercolor</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1734<p>the border color pixel wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1735
1736<h5>x,y</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1737<p>the starting location of the operation.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1738
1739<h5>invert</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1740<p>paint any pixel that does not match the target color.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1741
1742 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1743<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
1744_8c.html" id="MagickFlopImage">MagickFlopImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1745<div class="doc-section">
1746
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1747<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]1748
1749<p>The format of the MagickFlopImage method is:</p>
1750
1751<pre class="code">
1752 MagickBooleanType MagickFlopImage(MagickWand *wand)
1753</pre>
1754
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1755<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1756
1757<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1758<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1759
1760 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1761<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
1762_8c.html" id="MagickForwardFourierTransformImage">MagickForwardFourierTransformImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1763<div class="doc-section">
1764
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1765<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]1766
1767<p>The format of the MagickForwardFourierTransformImage method is:</p>
1768
1769<pre class="code">
1770 MagickBooleanType MagickForwardFourierTransformImage(MagickWand *wand,
1771 const MagickBooleanType magnitude)
1772</pre>
1773
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1774<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1775
1776<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1777<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1778
1779<h5>magnitude</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1780<p>if true, return as magnitude / phase pair otherwise a real / imaginary image pair.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1781
1782 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1783<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
1784_8c.html" id="MagickFrameImage">MagickFrameImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1785<div class="doc-section">
1786
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1787<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]1788
1789<p>The format of the MagickFrameImage method is:</p>
1790
1791<pre class="code">
1792 MagickBooleanType MagickFrameImage(MagickWand *wand,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]1793 const PixelWand *matte_color,const size_t width,
1794 const size_t height,const ssize_t inner_bevel,
1795 const ssize_t outer_bevel)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1796</pre>
1797
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1798<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1799
1800<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1801<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1802
1803<h5>matte_color</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1804<p>the frame color pixel wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1805
1806<h5>width</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1807<p>the border width.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1808
1809<h5>height</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1810<p>the border height.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1811
1812<h5>inner_bevel</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1813<p>the inner bevel width.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1814
1815<h5>outer_bevel</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1816<p>the outer bevel width.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1817
1818 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1819<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
1820_8c.html" id="MagickFunctionImage">MagickFunctionImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1821<div class="doc-section">
1822
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1823<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]1824
1825<p>The format of the MagickFunctionImage method is:</p>
1826
1827<pre class="code">
1828 MagickBooleanType MagickFunctionImage(MagickWand *wand,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]1829 const MagickFunction function,const size_t number_arguments,
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1830 const double *arguments)
1831 MagickBooleanType MagickFunctionImageChannel(MagickWand *wand,
1832 const ChannelType channel,const MagickFunction function,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]1833 const size_t number_arguments,const double *arguments)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1834</pre>
1835
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1836<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1837
1838<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1839<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1840
1841<h5>channel</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1842<p>the channel(s).</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1843
1844<h5>function</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1845<p>the image function.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1846
1847<h5>number_arguments</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1848<p>the number of function arguments.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1849
1850<h5>arguments</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1851<p>the function arguments.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1852
1853 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1854<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
1855_8c.html" id="MagickFxImage">MagickFxImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1856<div class="doc-section">
1857
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1858<p>MagickFxImage() evaluate expression for each pixel in the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1859
1860<p>The format of the MagickFxImage method is:</p>
1861
1862<pre class="code">
1863 MagickWand *MagickFxImage(MagickWand *wand,const char *expression)
1864 MagickWand *MagickFxImageChannel(MagickWand *wand,
1865 const ChannelType channel,const char *expression)
1866</pre>
1867
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1868<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1869
1870<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1871<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1872
1873<h5>channel</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1874<p>the image channel(s).</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1875
1876<h5>expression</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1877<p>the expression.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1878
1879 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1880<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
1881_8c.html" id="MagickGammaImage">MagickGammaImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1882<div class="doc-section">
1883
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1884<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]1885
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1886<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]1887
1888<p>The format of the MagickGammaImage method is:</p>
1889
1890<pre class="code">
1891 MagickBooleanType MagickGammaImage(MagickWand *wand,const double gamma)
1892 MagickBooleanType MagickGammaImageChannel(MagickWand *wand,
1893 const ChannelType channel,const double gamma)
1894</pre>
1895
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1896<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1897
1898<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1899<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1900
1901<h5>channel</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1902<p>the channel.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1903
1904<h5>level</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1905<p>Define the level of gamma correction.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1906
1907 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1908<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
1909_8c.html" id="MagickGaussianBlurImage">MagickGaussianBlurImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1910<div class="doc-section">
1911
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1912<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]1913
1914<p>The format of the MagickGaussianBlurImage method is:</p>
1915
1916<pre class="code">
1917 MagickBooleanType MagickGaussianBlurImage(MagickWand *wand,
1918 const double radius,const double sigma)
1919 MagickBooleanType MagickGaussianBlurImageChannel(MagickWand *wand,
1920 const ChannelType channel,const double radius,const double sigma)
1921</pre>
1922
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1923<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1924
1925<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1926<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1927
1928<h5>channel</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1929<p>the image channel(s).</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1930
1931<h5>radius</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1932<p>the radius of the Gaussian, in pixels, not counting the center pixel.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1933
1934<h5>sigma</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1935<p>the standard deviation of the Gaussian, in pixels.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1936
1937 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1938<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
1939_8c.html" id="MagickGetImage">MagickGetImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1940<div class="doc-section">
1941
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1942<p>MagickGetImage() gets the image at the current image index.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1943
1944<p>The format of the MagickGetImage method is:</p>
1945
1946<pre class="code">
1947 MagickWand *MagickGetImage(MagickWand *wand)
1948</pre>
1949
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1950<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1951
1952<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1953<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1954
1955 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1956<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
1957_8c.html" id="MagickGetImageAlphaChannel">MagickGetImageAlphaChannel</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1958<div class="doc-section">
1959
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1960<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]1961
1962<p>The format of the MagickGetImageAlphaChannel method is:</p>
1963
1964<pre class="code">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]1965 size_t MagickGetImageAlphaChannel(MagickWand *wand)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1966</pre>
1967
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1968<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1969
1970<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1971<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1972
1973 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1974<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
1975_8c.html" id="MagickGetImageClipMask">MagickGetImageClipMask</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1976<div class="doc-section">
1977
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1978<p>MagickGetImageClipMask() gets the image clip mask at the current image index.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1979
1980<p>The format of the MagickGetImageClipMask method is:</p>
1981
1982<pre class="code">
1983 MagickWand *MagickGetImageClipMask(MagickWand *wand)
1984</pre>
1985
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1986<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1987
1988<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1989<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1990
1991 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1992<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
1993_8c.html" id="MagickGetImageBackgroundColor">MagickGetImageBackgroundColor</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1994<div class="doc-section">
1995
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]1996<p>MagickGetImageBackgroundColor() returns the image background color.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1997
1998<p>The format of the MagickGetImageBackgroundColor method is:</p>
1999
2000<pre class="code">
2001 MagickBooleanType MagickGetImageBackgroundColor(MagickWand *wand,
2002 PixelWand *background_color)
2003</pre>
2004
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2005<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2006
2007<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2008<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2009
2010<h5>background_color</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2011<p>Return the background color.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2012
2013 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2014<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
2015_8c.html" id="MagickGetImageBlob">MagickGetImageBlob</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2016<div class="doc-section">
2017
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2018<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]2019
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2020<p>Use MagickRelinquishMemory() to free the blob when you are done with it.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2021
2022<p>The format of the MagickGetImageBlob method is:</p>
2023
2024<pre class="code">
2025 unsigned char *MagickGetImageBlob(MagickWand *wand,size_t *length)
2026</pre>
2027
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2028<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2029
2030<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2031<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2032
2033<h5>length</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2034<p>the length of the blob.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2035
2036 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2037<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
2038_8c.html" id="MagickGetImageBlob">MagickGetImageBlob</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2039<div class="doc-section">
2040
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2041<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]2042
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2043<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]2044
2045<p>The format of the MagickGetImagesBlob method is:</p>
2046
2047<pre class="code">
2048 unsigned char *MagickGetImagesBlob(MagickWand *wand,size_t *length)
2049</pre>
2050
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2051<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2052
2053<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2054<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2055
2056<h5>length</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2057<p>the length of the blob.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2058
2059 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2060<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
2061_8c.html" id="MagickGetImageBluePrimary">MagickGetImageBluePrimary</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2062<div class="doc-section">
2063
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2064<p>MagickGetImageBluePrimary() returns the chromaticy blue primary point for the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2065
2066<p>The format of the MagickGetImageBluePrimary method is:</p>
2067
2068<pre class="code">
2069 MagickBooleanType MagickGetImageBluePrimary(MagickWand *wand,double *x,
2070 double *y)
2071</pre>
2072
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2073<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2074
2075<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2076<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2077
2078<h5>x</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2079<p>the chromaticity blue primary x-point.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2080
2081<h5>y</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2082<p>the chromaticity blue primary y-point.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2083
2084 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2085<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
2086_8c.html" id="MagickGetImageBorderColor">MagickGetImageBorderColor</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2087<div class="doc-section">
2088
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2089<p>MagickGetImageBorderColor() returns the image border color.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2090
2091<p>The format of the MagickGetImageBorderColor method is:</p>
2092
2093<pre class="code">
2094 MagickBooleanType MagickGetImageBorderColor(MagickWand *wand,
2095 PixelWand *border_color)
2096</pre>
2097
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2098<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2099
2100<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2101<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2102
2103<h5>border_color</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2104<p>Return the border color.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2105
2106 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2107<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
2108_8c.html" id="MagickGetImageChannelDepth">MagickGetImageChannelDepth</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2109<div class="doc-section">
2110
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2111<p>MagickGetImageChannelDepth() gets the depth for one or more image channels.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2112
2113<p>The format of the MagickGetImageChannelDepth method is:</p>
2114
2115<pre class="code">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]2116 size_t MagickGetImageChannelDepth(MagickWand *wand,
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2117 const ChannelType channel)
2118</pre>
2119
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2120<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2121
2122<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2123<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2124
2125<h5>channel</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2126<p>the image channel(s).</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2127
2128 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2129<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
2130_8c.html" id="MagickGetImageChannelDistortion">MagickGetImageChannelDistortion</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2131<div class="doc-section">
2132
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2133<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]2134
2135<p>The format of the MagickGetImageChannelDistortion method is:</p>
2136
2137<pre class="code">
2138 MagickBooleanType MagickGetImageChannelDistortion(MagickWand *wand,
2139 const MagickWand *reference,const ChannelType channel,
2140 const MetricType metric,double *distortion)
2141</pre>
2142
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2143<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2144
2145<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2146<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2147
2148<h5>reference</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2149<p>the reference wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2150
2151<h5>channel</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2152<p>the channel.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2153
2154<h5>metric</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2155<p>the metric.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2156
2157<h5>distortion</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2158<p>the computed distortion between the images.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2159
2160 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2161<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
2162_8c.html" id="MagickGetImageChannelDistortions">MagickGetImageChannelDistortions</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2163<div class="doc-section">
2164
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2165<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]2166
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2167<p>Use MagickRelinquishMemory() to free the metrics when you are done with them.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2168
2169<p>The format of the MagickGetImageChannelDistortion method is:</p>
2170
2171<pre class="code">
2172 double *MagickGetImageChannelDistortion(MagickWand *wand,
2173 const MagickWand *reference,const MetricType metric)
2174</pre>
2175
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2176<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2177
2178<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2179<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2180
2181<h5>reference</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2182<p>the reference wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2183
2184<h5>metric</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2185<p>the metric.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2186
2187 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2188<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
2189_8c.html" id="MagickGetImageChannelFeatures">MagickGetImageChannelFeatures</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2190<div class="doc-section">
2191
cristy7396d882010-01-27 02:37:56 +0000[diff] [blame]2192<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]2193
cristy7396d882010-01-27 02:37:56 +0000[diff] [blame]2194<pre class="text">
2195 channel_features=MagickGetImageChannelFeatures(wand,1);
2196 contrast=channel_features[RedChannel].contrast[0];
2197</pre>
2198
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2199<p>Use MagickRelinquishMemory() to free the statistics buffer.</p>
cristy7396d882010-01-27 02:37:56 +0000[diff] [blame]2200
2201<p>The format of the MagickGetImageChannelFeatures method is:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2202
2203<pre class="code">
cristy7396d882010-01-27 02:37:56 +0000[diff] [blame]2204 ChannelFeatures *MagickGetImageChannelFeatures(MagickWand *wand,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]2205 const size_t distance)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2206</pre>
2207
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2208<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2209
2210<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2211<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2212
cristy7396d882010-01-27 02:37:56 +0000[diff] [blame]2213<h5>distance</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2214<p>the distance.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2215
2216 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2217<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
2218_8c.html" id="MagickGetImageChannelKurtosis">MagickGetImageChannelKurtosis</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2219<div class="doc-section">
2220
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2221<p>MagickGetImageChannelKurtosis() gets the kurtosis and skewness of one or more image channels.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2222
2223<p>The format of the MagickGetImageChannelKurtosis method is:</p>
2224
2225<pre class="code">
2226 MagickBooleanType MagickGetImageChannelKurtosis(MagickWand *wand,
2227 const ChannelType channel,double *kurtosis,double *skewness)
2228</pre>
2229
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2230<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2231
2232<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2233<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2234
2235<h5>channel</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2236<p>the image channel(s).</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2237
2238<h5>kurtosis</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2239<p>The kurtosis for the specified channel(s).</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2240
2241<h5>skewness</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2242<p>The skewness for the specified channel(s).</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2243
2244 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2245<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
2246_8c.html" id="MagickGetImageChannelMean">MagickGetImageChannelMean</a></h2>
cristy7396d882010-01-27 02:37:56 +0000[diff] [blame]2247<div class="doc-section">
2248
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2249<p>MagickGetImageChannelMean() gets the mean and standard deviation of one or more image channels.</p>
cristy7396d882010-01-27 02:37:56 +0000[diff] [blame]2250
2251<p>The format of the MagickGetImageChannelMean method is:</p>
2252
2253<pre class="code">
2254 MagickBooleanType MagickGetImageChannelMean(MagickWand *wand,
2255 const ChannelType channel,double *mean,double *standard_deviation)
2256</pre>
2257
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2258<p>A description of each parameter follows:</p>
cristy7396d882010-01-27 02:37:56 +0000[diff] [blame]2259
2260<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2261<p>the magick wand.</p>
cristy7396d882010-01-27 02:37:56 +0000[diff] [blame]2262
2263<h5>channel</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2264<p>the image channel(s).</p>
cristy7396d882010-01-27 02:37:56 +0000[diff] [blame]2265
2266<h5>mean</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2267<p>The mean pixel value for the specified channel(s).</p>
cristy7396d882010-01-27 02:37:56 +0000[diff] [blame]2268
2269<h5>standard_deviation</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2270<p>The standard deviation for the specified channel(s).</p>
cristy7396d882010-01-27 02:37:56 +0000[diff] [blame]2271
2272 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2273<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
2274_8c.html" id="MagickGetImageChannelRange">MagickGetImageChannelRange</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2275<div class="doc-section">
2276
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2277<p>MagickGetImageChannelRange() gets the range for one or more image channels.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2278
2279<p>The format of the MagickGetImageChannelRange method is:</p>
2280
2281<pre class="code">
2282 MagickBooleanType MagickGetImageChannelRange(MagickWand *wand,
2283 const ChannelType channel,double *minima,double *maxima)
2284</pre>
2285
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2286<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2287
2288<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2289<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2290
2291<h5>channel</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2292<p>the image channel(s).</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2293
2294<h5>minima</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2295<p>The minimum pixel value for the specified channel(s).</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2296
2297<h5>maxima</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2298<p>The maximum pixel value for the specified channel(s).</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2299
2300 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2301<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
2302_8c.html" id="MagickGetImageChannelStatistics">MagickGetImageChannelStatistics</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2303<div class="doc-section">
2304
2305<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>
2306
2307<pre class="text">
cristy7396d882010-01-27 02:37:56 +0000[diff] [blame]2308 channel_statistics=MagickGetImageChannelStatistics(wand);
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2309 red_mean=channel_statistics[RedChannel].mean;
2310</pre>
2311
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2312<p>Use MagickRelinquishMemory() to free the statistics buffer.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2313
2314<p>The format of the MagickGetImageChannelStatistics method is:</p>
2315
2316<pre class="code">
2317 ChannelStatistics *MagickGetImageChannelStatistics(MagickWand *wand)
2318</pre>
2319
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2320<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2321
2322<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2323<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2324
2325 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2326<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
2327_8c.html" id="MagickGetImageColormapColor">MagickGetImageColormapColor</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2328<div class="doc-section">
2329
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2330<p>MagickGetImageColormapColor() returns the color of the specified colormap index.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2331
2332<p>The format of the MagickGetImageColormapColor method is:</p>
2333
2334<pre class="code">
2335 MagickBooleanType MagickGetImageColormapColor(MagickWand *wand,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]2336 const size_t index,PixelWand *color)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2337</pre>
2338
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2339<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2340
2341<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2342<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2343
2344<h5>index</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2345<p>the offset into the image colormap.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2346
2347<h5>color</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2348<p>Return the colormap color in this wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2349
2350 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2351<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
2352_8c.html" id="MagickGetImageColors">MagickGetImageColors</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2353<div class="doc-section">
2354
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2355<p>MagickGetImageColors() gets the number of unique colors in the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2356
2357<p>The format of the MagickGetImageColors method is:</p>
2358
2359<pre class="code">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]2360 size_t MagickGetImageColors(MagickWand *wand)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2361</pre>
2362
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2363<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2364
2365<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2366<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2367
2368 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2369<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
2370_8c.html" id="MagickGetImageColorspace">MagickGetImageColorspace</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2371<div class="doc-section">
2372
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2373<p>MagickGetImageColorspace() gets the image colorspace.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2374
2375<p>The format of the MagickGetImageColorspace method is:</p>
2376
2377<pre class="code">
2378 ColorspaceType MagickGetImageColorspace(MagickWand *wand)
2379</pre>
2380
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2381<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2382
2383<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2384<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2385
2386 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2387<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
2388_8c.html" id="MagickGetImageCompose">MagickGetImageCompose</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2389<div class="doc-section">
2390
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2391<p>MagickGetImageCompose() returns the composite operator associated with the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2392
2393<p>The format of the MagickGetImageCompose method is:</p>
2394
2395<pre class="code">
2396 CompositeOperator MagickGetImageCompose(MagickWand *wand)
2397</pre>
2398
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2399<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2400
2401<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2402<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2403
2404 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2405<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
2406_8c.html" id="MagickGetImageCompression">MagickGetImageCompression</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2407<div class="doc-section">
2408
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2409<p>MagickGetImageCompression() gets the image compression.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2410
2411<p>The format of the MagickGetImageCompression method is:</p>
2412
2413<pre class="code">
2414 CompressionType MagickGetImageCompression(MagickWand *wand)
2415</pre>
2416
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2417<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2418
2419<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2420<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2421
2422 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2423<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
2424_8c.html" id="MagickGetImageCompression">MagickGetImageCompression</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2425<div class="doc-section">
2426
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2427<p>MagickGetImageCompression() gets the image compression quality.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2428
2429<p>The format of the MagickGetImageCompression method is:</p>
2430
2431<pre class="code">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]2432 size_t MagickGetImageCompression(MagickWand *wand)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2433</pre>
2434
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2435<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2436
2437<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2438<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2439
2440 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2441<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
2442_8c.html" id="MagickGetImageDelay">MagickGetImageDelay</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2443<div class="doc-section">
2444
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2445<p>MagickGetImageDelay() gets the image delay.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2446
2447<p>The format of the MagickGetImageDelay method is:</p>
2448
2449<pre class="code">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]2450 size_t MagickGetImageDelay(MagickWand *wand)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2451</pre>
2452
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2453<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2454
2455<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2456<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2457
2458 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2459<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
2460_8c.html" id="MagickGetImageDepth">MagickGetImageDepth</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2461<div class="doc-section">
2462
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2463<p>MagickGetImageDepth() gets the image depth.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2464
2465<p>The format of the MagickGetImageDepth method is:</p>
2466
2467<pre class="code">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]2468 size_t MagickGetImageDepth(MagickWand *wand)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2469</pre>
2470
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2471<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2472
2473<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2474<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2475
2476 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2477<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
2478_8c.html" id="MagickGetImageDistortion">MagickGetImageDistortion</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2479<div class="doc-section">
2480
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2481<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]2482
2483<p>The format of the MagickGetImageDistortion method is:</p>
2484
2485<pre class="code">
2486 MagickBooleanType MagickGetImageDistortion(MagickWand *wand,
2487 const MagickWand *reference,const MetricType metric,
2488 double *distortion)
2489</pre>
2490
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2491<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2492
2493<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2494<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2495
2496<h5>reference</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2497<p>the reference wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2498
2499<h5>metric</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2500<p>the metric.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2501
2502<h5>distortion</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2503<p>the computed distortion between the images.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2504
2505 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2506<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
2507_8c.html" id="MagickGetImageDispose">MagickGetImageDispose</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2508<div class="doc-section">
2509
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2510<p>MagickGetImageDispose() gets the image disposal method.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2511
2512<p>The format of the MagickGetImageDispose method is:</p>
2513
2514<pre class="code">
2515 DisposeType MagickGetImageDispose(MagickWand *wand)
2516</pre>
2517
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2518<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2519
2520<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2521<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2522
2523 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2524<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
2525_8c.html" id="MagickGetImageFilename">MagickGetImageFilename</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2526<div class="doc-section">
2527
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2528<p>MagickGetImageFilename() returns the filename of a particular image in a sequence.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2529
2530<p>The format of the MagickGetImageFilename method is:</p>
2531
2532<pre class="code">
2533 char *MagickGetImageFilename(MagickWand *wand)
2534</pre>
2535
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2536<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2537
2538<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2539<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2540
2541 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2542<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
2543_8c.html" id="MagickGetImageFormat">MagickGetImageFormat</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2544<div class="doc-section">
2545
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2546<p>MagickGetImageFormat() returns the format of a particular image in a sequence.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2547
2548<p>The format of the MagickGetImageFormat method is:</p>
2549
2550<pre class="code">
cristya8902942010-07-30 00:49:52 +0000[diff] [blame]2551 const char *MagickGetImageFormat(MagickWand *wand)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2552</pre>
2553
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2554<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2555
2556<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2557<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2558
2559 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2560<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
2561_8c.html" id="MagickGetImageFuzz">MagickGetImageFuzz</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2562<div class="doc-section">
2563
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2564<p>MagickGetImageFuzz() gets the image fuzz.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2565
2566<p>The format of the MagickGetImageFuzz method is:</p>
2567
2568<pre class="code">
2569 double MagickGetImageFuzz(MagickWand *wand)
2570</pre>
2571
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2572<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2573
2574<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2575<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2576
2577 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2578<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
2579_8c.html" id="MagickGetImageGamma">MagickGetImageGamma</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2580<div class="doc-section">
2581
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2582<p>MagickGetImageGamma() gets the image gamma.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2583
2584<p>The format of the MagickGetImageGamma method is:</p>
2585
2586<pre class="code">
2587 double MagickGetImageGamma(MagickWand *wand)
2588</pre>
2589
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2590<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2591
2592<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2593<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2594
2595 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2596<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
2597_8c.html" id="MagickGetImageGravity">MagickGetImageGravity</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2598<div class="doc-section">
2599
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2600<p>MagickGetImageGravity() gets the image gravity.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2601
2602<p>The format of the MagickGetImageGravity method is:</p>
2603
2604<pre class="code">
2605 GravityType MagickGetImageGravity(MagickWand *wand)
2606</pre>
2607
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2608<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2609
2610<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2611<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2612
2613 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2614<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
2615_8c.html" id="MagickGetImageGreenPrimary">MagickGetImageGreenPrimary</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2616<div class="doc-section">
2617
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2618<p>MagickGetImageGreenPrimary() returns the chromaticy green primary point.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2619
2620<p>The format of the MagickGetImageGreenPrimary method is:</p>
2621
2622<pre class="code">
2623 MagickBooleanType MagickGetImageGreenPrimary(MagickWand *wand,double *x,
2624 double *y)
2625</pre>
2626
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2627<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2628
2629<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2630<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2631
2632<h5>x</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2633<p>the chromaticity green primary x-point.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2634
2635<h5>y</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2636<p>the chromaticity green primary y-point.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2637
2638 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2639<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
2640_8c.html" id="MagickGetImageHeight">MagickGetImageHeight</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2641<div class="doc-section">
2642
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2643<p>MagickGetImageHeight() returns the image height.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2644
2645<p>The format of the MagickGetImageHeight method is:</p>
2646
2647<pre class="code">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]2648 size_t MagickGetImageHeight(MagickWand *wand)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2649</pre>
2650
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2651<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2652
2653<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2654<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2655
2656 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2657<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
2658_8c.html" id="MagickGetImageHistogram">MagickGetImageHistogram</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2659<div class="doc-section">
2660
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2661<p>MagickGetImageHistogram() returns the image histogram as an array of PixelWand wands.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2662
2663<p>The format of the MagickGetImageHistogram method is:</p>
2664
2665<pre class="code">
2666 PixelWand **MagickGetImageHistogram(MagickWand *wand,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]2667 size_t *number_colors)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2668</pre>
2669
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2670<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2671
2672<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2673<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2674
2675<h5>number_colors</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2676<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]2677
2678 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2679<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
2680_8c.html" id="MagickGetImageInterlaceScheme">MagickGetImageInterlaceScheme</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2681<div class="doc-section">
2682
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2683<p>MagickGetImageInterlaceScheme() gets the image interlace scheme.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2684
2685<p>The format of the MagickGetImageInterlaceScheme method is:</p>
2686
2687<pre class="code">
2688 InterlaceType MagickGetImageInterlaceScheme(MagickWand *wand)
2689</pre>
2690
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2691<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2692
2693<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2694<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2695
2696 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2697<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
2698_8c.html" id="MagickGetImageInterpolateMethod">MagickGetImageInterpolateMethod</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2699<div class="doc-section">
2700
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2701<p>MagickGetImageInterpolateMethod() returns the interpolation method for the sepcified image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2702
2703<p>The format of the MagickGetImageInterpolateMethod method is:</p>
2704
2705<pre class="code">
2706 InterpolatePixelMethod MagickGetImageInterpolateMethod(MagickWand *wand)
2707</pre>
2708
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2709<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2710
2711<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2712<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2713
2714 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2715<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
2716_8c.html" id="MagickGetImageIterations">MagickGetImageIterations</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2717<div class="doc-section">
2718
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2719<p>MagickGetImageIterations() gets the image iterations.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2720
2721<p>The format of the MagickGetImageIterations method is:</p>
2722
2723<pre class="code">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]2724 size_t MagickGetImageIterations(MagickWand *wand)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2725</pre>
2726
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2727<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2728
2729<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2730<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2731
2732 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2733<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
2734_8c.html" id="MagickGetImageLength">MagickGetImageLength</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2735<div class="doc-section">
2736
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2737<p>MagickGetImageLength() returns the image length in bytes.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2738
2739<p>The format of the MagickGetImageLength method is:</p>
2740
2741<pre class="code">
2742 MagickBooleanType MagickGetImageLength(MagickWand *wand,
2743 MagickSizeType *length)
2744</pre>
2745
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2746<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2747
2748<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2749<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2750
2751<h5>length</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2752<p>the image length in bytes.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2753
2754 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2755<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
2756_8c.html" id="MagickGetImageMatteColor">MagickGetImageMatteColor</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2757<div class="doc-section">
2758
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2759<p>MagickGetImageMatteColor() returns the image matte color.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2760
2761<p>The format of the MagickGetImageMatteColor method is:</p>
2762
2763<pre class="code">
2764 MagickBooleanType MagickGetImagematteColor(MagickWand *wand,
2765 PixelWand *matte_color)
2766</pre>
2767
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2768<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2769
2770<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2771<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2772
2773<h5>matte_color</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2774<p>Return the matte color.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2775
2776 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2777<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
2778_8c.html" id="MagickGetImageOrientation">MagickGetImageOrientation</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2779<div class="doc-section">
2780
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2781<p>MagickGetImageOrientation() returns the image orientation.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2782
2783<p>The format of the MagickGetImageOrientation method is:</p>
2784
2785<pre class="code">
2786 OrientationType MagickGetImageOrientation(MagickWand *wand)
2787</pre>
2788
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2789<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2790
2791<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2792<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2793
2794 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2795<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
2796_8c.html" id="MagickGetImagePage">MagickGetImagePage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2797<div class="doc-section">
2798
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2799<p>MagickGetImagePage() returns the page geometry associated with the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2800
2801<p>The format of the MagickGetImagePage method is:</p>
2802
2803<pre class="code">
2804 MagickBooleanType MagickGetImagePage(MagickWand *wand,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]2805 size_t *width,size_t *height,ssize_t *x,ssize_t *y)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2806</pre>
2807
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2808<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2809
2810<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2811<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2812
2813<h5>width</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2814<p>the page width.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2815
2816<h5>height</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2817<p>the page height.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2818
2819<h5>x</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2820<p>the page x-offset.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2821
2822<h5>y</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2823<p>the page y-offset.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2824
2825 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2826<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
2827_8c.html" id="MagickGetImagePixelColor">MagickGetImagePixelColor</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2828<div class="doc-section">
2829
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2830<p>MagickGetImagePixelColor() returns the color of the specified pixel.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2831
2832<p>The format of the MagickGetImagePixelColor method is:</p>
2833
2834<pre class="code">
2835 MagickBooleanType MagickGetImagePixelColor(MagickWand *wand,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]2836 const ssize_t x,const ssize_t y,PixelWand *color)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2837</pre>
2838
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2839<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2840
2841<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2842<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2843
2844<h5>x,y</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2845<p>the pixel offset into the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2846
2847<h5>color</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2848<p>Return the colormap color in this wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2849
2850 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2851<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
2852_8c.html" id="MagickGetImageRedPrimary">MagickGetImageRedPrimary</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2853<div class="doc-section">
2854
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2855<p>MagickGetImageRedPrimary() returns the chromaticy red primary point.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2856
2857<p>The format of the MagickGetImageRedPrimary method is:</p>
2858
2859<pre class="code">
2860 MagickBooleanType MagickGetImageRedPrimary(MagickWand *wand,double *x,
2861 double *y)
2862</pre>
2863
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2864<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2865
2866<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2867<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2868
2869<h5>x</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2870<p>the chromaticity red primary x-point.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2871
2872<h5>y</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2873<p>the chromaticity red primary y-point.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2874
2875 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2876<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
2877_8c.html" id="MagickGetImageRegion">MagickGetImageRegion</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2878<div class="doc-section">
2879
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2880<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]2881
2882<p>The format of the MagickGetImageRegion method is:</p>
2883
2884<pre class="code">
2885 MagickWand *MagickGetImageRegion(MagickWand *wand,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]2886 const size_t width,const size_t height,const ssize_t x,
2887 const ssize_t y)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2888</pre>
2889
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2890<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2891
2892<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2893<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2894
2895<h5>width</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2896<p>the region width.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2897
2898<h5>height</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2899<p>the region height.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2900
2901<h5>x</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2902<p>the region x offset.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2903
2904<h5>y</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2905<p>the region y offset.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2906
2907 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2908<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
2909_8c.html" id="MagickGetImageRenderingIntent">MagickGetImageRenderingIntent</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2910<div class="doc-section">
2911
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2912<p>MagickGetImageRenderingIntent() gets the image rendering intent.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2913
2914<p>The format of the MagickGetImageRenderingIntent method is:</p>
2915
2916<pre class="code">
2917 RenderingIntent MagickGetImageRenderingIntent(MagickWand *wand)
2918</pre>
2919
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2920<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2921
2922<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2923<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2924
2925 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2926<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
2927_8c.html" id="MagickGetImageResolution">MagickGetImageResolution</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2928<div class="doc-section">
2929
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2930<p>MagickGetImageResolution() gets the image X and Y resolution.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2931
2932<p>The format of the MagickGetImageResolution method is:</p>
2933
2934<pre class="code">
2935 MagickBooleanType MagickGetImageResolution(MagickWand *wand,double *x,
2936 double *y)
2937</pre>
2938
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2939<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2940
2941<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2942<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2943
2944<h5>x</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2945<p>the image x-resolution.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2946
2947<h5>y</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2948<p>the image y-resolution.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2949
2950 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2951<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
2952_8c.html" id="MagickGetImageScene">MagickGetImageScene</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2953<div class="doc-section">
2954
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2955<p>MagickGetImageScene() gets the image scene.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2956
2957<p>The format of the MagickGetImageScene method is:</p>
2958
2959<pre class="code">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]2960 size_t MagickGetImageScene(MagickWand *wand)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2961</pre>
2962
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2963<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2964
2965<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2966<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2967
2968 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2969<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
2970_8c.html" id="MagickGetImageSignature">MagickGetImageSignature</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2971<div class="doc-section">
2972
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2973<p>MagickGetImageSignature() generates an SHA-256 message digest for the image pixel stream.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2974
2975<p>The format of the MagickGetImageSignature method is:</p>
2976
2977<pre class="code">
2978 const char MagickGetImageSignature(MagickWand *wand)
2979</pre>
2980
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2981<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2982
2983<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2984<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2985
2986 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2987<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
2988_8c.html" id="MagickGetImageTicksPerSecond">MagickGetImageTicksPerSecond</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2989<div class="doc-section">
2990
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2991<p>MagickGetImageTicksPerSecond() gets the image ticks-per-second.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2992
2993<p>The format of the MagickGetImageTicksPerSecond method is:</p>
2994
2995<pre class="code">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]2996 size_t MagickGetImageTicksPerSecond(MagickWand *wand)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2997</pre>
2998
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]2999<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3000
3001<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3002<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3003
3004 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3005<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
3006_8c.html" id="MagickGetImageType">MagickGetImageType</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3007<div class="doc-section">
3008
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3009<p>MagickGetImageType() gets the potential image type:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3010
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3011<p>Bilevel Grayscale GrayscaleMatte Palette PaletteMatte TrueColor TrueColorMatte ColorSeparation ColorSeparationMatte</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3012
3013<p>To ensure the image type matches its potential, use MagickSetImageType():</p>
3014
3015<pre class="text">
3016 (void) MagickSetImageType(wand,MagickGetImageType(wand));
3017</pre>
3018
3019<p>The format of the MagickGetImageType method is:</p>
3020
3021<pre class="code">
3022 ImageType MagickGetImageType(MagickWand *wand)
3023</pre>
3024
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3025<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3026
3027<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3028<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3029
3030 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3031<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
3032_8c.html" id="MagickGetImageUnits">MagickGetImageUnits</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3033<div class="doc-section">
3034
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3035<p>MagickGetImageUnits() gets the image units of resolution.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3036
3037<p>The format of the MagickGetImageUnits method is:</p>
3038
3039<pre class="code">
3040 ResolutionType MagickGetImageUnits(MagickWand *wand)
3041</pre>
3042
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3043<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3044
3045<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3046<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3047
3048 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3049<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
3050_8c.html" id="MagickGetImageVirtualPixelMethod">MagickGetImageVirtualPixelMethod</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3051<div class="doc-section">
3052
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3053<p>MagickGetImageVirtualPixelMethod() returns the virtual pixel method for the sepcified image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3054
3055<p>The format of the MagickGetImageVirtualPixelMethod method is:</p>
3056
3057<pre class="code">
3058 VirtualPixelMethod MagickGetImageVirtualPixelMethod(MagickWand *wand)
3059</pre>
3060
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3061<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3062
3063<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3064<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3065
3066 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3067<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
3068_8c.html" id="MagickGetImageWhitePoint">MagickGetImageWhitePoint</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3069<div class="doc-section">
3070
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3071<p>MagickGetImageWhitePoint() returns the chromaticy white point.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3072
3073<p>The format of the MagickGetImageWhitePoint method is:</p>
3074
3075<pre class="code">
3076 MagickBooleanType MagickGetImageWhitePoint(MagickWand *wand,double *x,
3077 double *y)
3078</pre>
3079
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3080<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3081
3082<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3083<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3084
3085<h5>x</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3086<p>the chromaticity white x-point.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3087
3088<h5>y</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3089<p>the chromaticity white y-point.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3090
3091 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3092<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
3093_8c.html" id="MagickGetImageWidth">MagickGetImageWidth</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3094<div class="doc-section">
3095
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3096<p>MagickGetImageWidth() returns the image width.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3097
3098<p>The format of the MagickGetImageWidth method is:</p>
3099
3100<pre class="code">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]3101 size_t MagickGetImageWidth(MagickWand *wand)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3102</pre>
3103
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3104<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3105
3106<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3107<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3108
3109 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3110<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
3111_8c.html" id="MagickGetNumberImages">MagickGetNumberImages</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3112<div class="doc-section">
3113
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3114<p>MagickGetNumberImages() returns the number of images associated with a magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3115
3116<p>The format of the MagickGetNumberImages method is:</p>
3117
3118<pre class="code">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]3119 size_t MagickGetNumberImages(MagickWand *wand)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3120</pre>
3121
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3122<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3123
3124<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3125<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3126
3127 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3128<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
3129_8c.html" id="MagickGetImageTotalInkDensity">MagickGetImageTotalInkDensity</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3130<div class="doc-section">
3131
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3132<p>MagickGetImageTotalInkDensity() gets the image total ink density.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3133
3134<p>The format of the MagickGetImageTotalInkDensity method is:</p>
3135
3136<pre class="code">
3137 double MagickGetImageTotalInkDensity(MagickWand *wand)
3138</pre>
3139
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3140<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3141
3142<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3143<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3144
3145 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3146<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
3147_8c.html" id="MagickHaldClutImage">MagickHaldClutImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3148<div class="doc-section">
3149
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3150<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]3151
3152<p>The format of the MagickHaldClutImage method is:</p>
3153
3154<pre class="code">
3155 MagickBooleanType MagickHaldClutImage(MagickWand *wand,
3156 const MagickWand *hald_wand)
3157 MagickBooleanType MagickHaldClutImageChannel(MagickWand *wand,
3158 const ChannelType channel,const MagickWand *hald_wand)
3159</pre>
3160
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3161<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3162
3163<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3164<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3165
3166<h5>hald_image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3167<p>the hald CLUT image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3168
3169 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3170<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
3171_8c.html" id="MagickHasNextImage">MagickHasNextImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3172<div class="doc-section">
3173
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3174<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]3175
3176<p>The format of the MagickHasNextImage method is:</p>
3177
3178<pre class="code">
3179 MagickBooleanType MagickHasNextImage(MagickWand *wand)
3180</pre>
3181
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3182<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3183
3184<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3185<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3186
3187 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3188<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
3189_8c.html" id="MagickHasPreviousImage">MagickHasPreviousImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3190<div class="doc-section">
3191
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3192<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]3193
3194<p>The format of the MagickHasPreviousImage method is:</p>
3195
3196<pre class="code">
3197 MagickBooleanType MagickHasPreviousImage(MagickWand *wand)
3198</pre>
3199
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3200<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3201
3202<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3203<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3204
3205 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3206<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
3207_8c.html" id="MagickIdentifyImage">MagickIdentifyImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3208<div class="doc-section">
3209
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3210<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]3211
3212<p>The format of the MagickIdentifyImage method is:</p>
3213
3214<pre class="code">
3215 const char *MagickIdentifyImage(MagickWand *wand)
3216</pre>
3217
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3218<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3219
3220<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3221<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3222
3223 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3224<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
3225_8c.html" id="MagickImplodeImage">MagickImplodeImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3226<div class="doc-section">
3227
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3228<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]3229
3230<p>The format of the MagickImplodeImage method is:</p>
3231
3232<pre class="code">
3233 MagickBooleanType MagickImplodeImage(MagickWand *wand,
3234 const double radius)
3235</pre>
3236
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3237<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3238
3239<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3240<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3241
3242<h5>amount</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3243<p>Define the extent of the implosion.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3244
3245 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3246<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
3247_8c.html" id="MagickImportImagePixels">MagickImportImagePixels</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3248<div class="doc-section">
3249
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3250<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]3251
3252<p>Suppose your want to upload the first scanline of a 640x480 image from character data in red-green-blue order:</p>
3253
3254<pre class="text">
3255 MagickImportImagePixels(wand,0,0,640,1,"RGB",CharPixel,pixels);
3256</pre>
3257
3258<p>The format of the MagickImportImagePixels method is:</p>
3259
3260<pre class="code">
3261 MagickBooleanType MagickImportImagePixels(MagickWand *wand,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]3262 const ssize_t x,const ssize_t y,const size_t columns,
3263 const size_t rows,const char *map,const StorageType storage,
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3264 const void *pixels)
3265</pre>
3266
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3267<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3268
3269<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3270<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3271
3272<h5>x, y, columns, rows</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3273<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]3274
3275<h5>map</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3276<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]3277
3278<h5>storage</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3279<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]3280
3281<h5>pixels</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3282<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]3283
3284 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3285<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
3286_8c.html" id="MagickInverseFourierTransformImage">MagickInverseFourierTransformImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3287<div class="doc-section">
3288
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3289<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]3290
3291<p>The format of the MagickInverseFourierTransformImage method is:</p>
3292
3293<pre class="code">
3294 MagickBooleanType MagickInverseFourierTransformImage(
cristy5f2356f2009-11-16 00:40:46 +0000[diff] [blame]3295 MagickWand *magnitude_wand,MagickWand *phase_wand,
3296 const MagickBooleanType magnitude)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3297</pre>
3298
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3299<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3300
cristy5f2356f2009-11-16 00:40:46 +0000[diff] [blame]3301<h5>magnitude_wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3302<p>the magnitude or real wand.</p>
cristy5f2356f2009-11-16 00:40:46 +0000[diff] [blame]3303
3304<h5>phase_wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3305<p>the phase or imaginary wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3306
3307<h5>magnitude</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3308<p>if true, return as magnitude / phase pair otherwise a real / imaginary image pair.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3309
3310 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3311<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
3312_8c.html" id="MagickLabelImage">MagickLabelImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3313<div class="doc-section">
3314
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3315<p>MagickLabelImage() adds a label to your image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3316
3317<p>The format of the MagickLabelImage method is:</p>
3318
3319<pre class="code">
3320 MagickBooleanType MagickLabelImage(MagickWand *wand,const char *label)
3321</pre>
3322
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3323<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3324
3325<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3326<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3327
3328<h5>label</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3329<p>the image label.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3330
3331 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3332<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
3333_8c.html" id="MagickLevelImage">MagickLevelImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3334<div class="doc-section">
3335
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3336<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]3337
3338<p>The format of the MagickLevelImage method is:</p>
3339
3340<pre class="code">
3341 MagickBooleanType MagickLevelImage(MagickWand *wand,
3342 const double black_point,const double gamma,const double white_point)
3343 MagickBooleanType MagickLevelImageChannel(MagickWand *wand,
3344 const ChannelType channel,const double black_point,const double gamma,
3345 const double white_point)
3346</pre>
3347
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3348<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3349
3350<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3351<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3352
3353<h5>channel</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3354<p>Identify which channel to level: RedChannel, GreenChannel,</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3355
3356<h5>black_point</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3357<p>the black point.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3358
3359<h5>gamma</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3360<p>the gamma.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3361
3362<h5>white_point</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3363<p>the white point.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3364
3365 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3366<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
3367_8c.html" id="MagickLinearStretchImage">MagickLinearStretchImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3368<div class="doc-section">
3369
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3370<p>MagickLinearStretchImage() stretches with saturation the image intensity.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3371
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3372<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]3373
3374<p>The format of the MagickLinearStretchImage method is:</p>
3375
3376<pre class="code">
3377 MagickBooleanType MagickLinearStretchImage(MagickWand *wand,
3378 const double black_point,const double white_point)
3379</pre>
3380
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3381<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3382
3383<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3384<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3385
3386<h5>black_point</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3387<p>the black point.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3388
3389<h5>white_point</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3390<p>the white point.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3391
3392 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3393<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
3394_8c.html" id="MagickLiquidRescaleImage">MagickLiquidRescaleImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3395<div class="doc-section">
3396
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3397<p>MagickLiquidRescaleImage() rescales image with seam carving.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3398
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3399<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]3400
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3401<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3402
3403<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3404<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3405
3406<h5>columns</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3407<p>the number of columns in the scaled image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3408
3409<h5>rows</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3410<p>the number of rows in the scaled image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3411
3412<h5>delta_x</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3413<p>maximum seam transversal step (0 means straight seams).</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3414
3415<h5>rigidity</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3416<p>introduce a bias for non-straight seams (typically 0).</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3417
3418 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3419<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
3420_8c.html" id="MagickMagnifyImage">MagickMagnifyImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3421<div class="doc-section">
3422
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3423<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]3424
3425<p>The format of the MagickMagnifyImage method is:</p>
3426
3427<pre class="code">
3428 MagickBooleanType MagickMagnifyImage(MagickWand *wand)
3429</pre>
3430
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3431<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3432
3433<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3434<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3435
3436 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3437<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
3438_8c.html" id="MagickMedianFilterImage">MagickMedianFilterImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3439<div class="doc-section">
3440
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3441<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]3442
3443<p>The format of the MagickMedianFilterImage method is:</p>
3444
3445<pre class="code">
3446 MagickBooleanType MagickMedianFilterImage(MagickWand *wand,
3447 const double radius)
3448</pre>
3449
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3450<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3451
3452<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3453<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3454
3455<h5>radius</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3456<p>the radius of the pixel neighborhood.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3457
3458 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3459<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
3460_8c.html" id="MagickMergeImageLayers">MagickMergeImageLayers</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3461<div class="doc-section">
3462
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3463<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]3464
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3465<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]3466
3467<p>The format of the MagickMergeImageLayers method is:</p>
3468
3469<pre class="code">
3470 MagickWand *MagickMergeImageLayers(MagickWand *wand,
3471 const ImageLayerMethod method)
3472</pre>
3473
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3474<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3475
3476<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3477<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3478
3479<h5>method</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3480<p>the method of selecting the size of the initial canvas.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3481
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3482<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]3483
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3484<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]3485
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3486<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]3487
3488 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3489<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
3490_8c.html" id="MagickMinifyImage">MagickMinifyImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3491<div class="doc-section">
3492
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3493<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]3494
3495<p>The format of the MagickMinifyImage method is:</p>
3496
3497<pre class="code">
3498 MagickBooleanType MagickMinifyImage(MagickWand *wand)
3499</pre>
3500
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3501<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3502
3503<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3504<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3505
3506 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3507<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
3508_8c.html" id="MagickModulateImage">MagickModulateImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3509<div class="doc-section">
3510
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3511<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]3512
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3513<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]3514
3515<p>The format of the MagickModulateImage method is:</p>
3516
3517<pre class="code">
3518 MagickBooleanType MagickModulateImage(MagickWand *wand,
3519 const double brightness,const double saturation,const double hue)
3520</pre>
3521
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3522<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3523
3524<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3525<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3526
3527<h5>brightness</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3528<p>the percent change in brighness.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3529
3530<h5>saturation</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3531<p>the percent change in saturation.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3532
3533<h5>hue</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3534<p>the percent change in hue.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3535
3536 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3537<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
3538_8c.html" id="MagickMontageImage">MagickMontageImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3539<div class="doc-section">
3540
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3541<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]3542
3543<p>The format of the MagickMontageImage method is:</p>
3544
3545<pre class="code">
3546 MagickWand *MagickMontageImage(MagickWand *wand,
3547 const DrawingWand drawing_wand,const char *tile_geometry,
3548 const char *thumbnail_geometry,const MontageMode mode,
3549 const char *frame)
3550</pre>
3551
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3552<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3553
3554<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3555<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3556
3557<h5>drawing_wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3558<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]3559
3560<h5>tile_geometry</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3561<p>the number of tiles per row and page (e.g. 6x4+0+0).</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3562
3563<h5>thumbnail_geometry</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3564<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]3565
3566<h5>mode</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3567<p>Thumbnail framing mode: Frame, Unframe, or Concatenate.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3568
3569<h5>frame</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3570<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]3571
3572 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3573<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
3574_8c.html" id="MagickMorphImages">MagickMorphImages</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3575<div class="doc-section">
3576
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3577<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]3578
3579<p>The format of the MagickMorphImages method is:</p>
3580
3581<pre class="code">
3582 MagickWand *MagickMorphImages(MagickWand *wand,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]3583 const size_t number_frames)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3584</pre>
3585
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3586<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3587
3588<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3589<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3590
3591<h5>number_frames</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3592<p>the number of in-between images to generate.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3593
3594 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3595<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
3596_8c.html" id="MagickMorphologyImage">MagickMorphologyImage</a></h2>
cristy488844c2010-01-22 14:02:05 +0000[diff] [blame]3597<div class="doc-section">
3598
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3599<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]3600
3601<p>The format of the MagickMorphologyImage method is:</p>
3602
3603<pre class="code">
3604 MagickBooleanType MagickMorphologyImage(MagickWand *wand,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]3605 MorphologyMethod method,const ssize_t iterations,KernelInfo *kernel)
cristy488844c2010-01-22 14:02:05 +0000[diff] [blame]3606 MagickBooleanType MagickMorphologyImageChannel(MagickWand *wand,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]3607 ChannelType channel,MorphologyMethod method,const ssize_t iterations,
cristy488844c2010-01-22 14:02:05 +0000[diff] [blame]3608 KernelInfo *kernel)
3609</pre>
3610
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3611<p>A description of each parameter follows:</p>
cristy488844c2010-01-22 14:02:05 +0000[diff] [blame]3612
3613<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3614<p>the magick wand.</p>
cristy488844c2010-01-22 14:02:05 +0000[diff] [blame]3615
3616<h5>channel</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3617<p>the image channel(s).</p>
cristy488844c2010-01-22 14:02:05 +0000[diff] [blame]3618
3619<h5>method</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3620<p>the morphology method to be applied.</p>
cristy488844c2010-01-22 14:02:05 +0000[diff] [blame]3621
3622<h5>iterations</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3623<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]3624
3625<h5>kernel</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3626<p>An array of doubles representing the morphology kernel.</p>
cristy488844c2010-01-22 14:02:05 +0000[diff] [blame]3627
3628 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3629<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
3630_8c.html" id="MagickMotionBlurImage">MagickMotionBlurImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3631<div class="doc-section">
3632
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3633<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]3634
3635<p>The format of the MagickMotionBlurImage method is:</p>
3636
3637<pre class="code">
3638 MagickBooleanType MagickMotionBlurImage(MagickWand *wand,
3639 const double radius,const double sigma,const double angle)
3640 MagickBooleanType MagickMotionBlurImageChannel(MagickWand *wand,
3641 const ChannelType channel,const double radius,const double sigma,
3642 const double angle)
3643</pre>
3644
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3645<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3646
3647<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3648<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3649
3650<h5>channel</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3651<p>the image channel(s).</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3652
3653<h5>radius</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3654<p>the radius of the Gaussian, in pixels, not counting the center pixel.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3655
3656<h5>sigma</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3657<p>the standard deviation of the Gaussian, in pixels.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3658
3659<h5>angle</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3660<p>Apply the effect along this angle.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3661
3662 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3663<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
3664_8c.html" id="MagickNegateImage">MagickNegateImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3665<div class="doc-section">
3666
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3667<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]3668
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3669<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]3670
3671<p>The format of the MagickNegateImage method is:</p>
3672
3673<pre class="code">
3674 MagickBooleanType MagickNegateImage(MagickWand *wand,
3675 const MagickBooleanType gray)
3676 MagickBooleanType MagickNegateImage(MagickWand *wand,
3677 const ChannelType channel,const MagickBooleanType gray)
3678</pre>
3679
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3680<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3681
3682<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3683<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3684
3685<h5>channel</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3686<p>the image channel(s).</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3687
3688<h5>gray</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3689<p>If MagickTrue, only negate grayscale pixels within the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3690
3691 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3692<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
3693_8c.html" id="MagickNewImage">MagickNewImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3694<div class="doc-section">
3695
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3696<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]3697
3698<p>The format of the MagickNewImage method is:</p>
3699
3700<pre class="code">
3701 MagickBooleanType MagickNewImage(MagickWand *wand,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]3702 const size_t columns,const size_t rows,
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3703 const PixelWand *background)
3704</pre>
3705
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3706<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3707
3708<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3709<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3710
3711<h5>width</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3712<p>the image width.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3713
3714<h5>height</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3715<p>the image height.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3716
3717<h5>background</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3718<p>the image color.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3719
3720 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3721<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
3722_8c.html" id="MagickNextImage">MagickNextImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3723<div class="doc-section">
3724
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3725<p>MagickNextImage() associates the next image in the image list with a magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3726
3727<p>The format of the MagickNextImage method is:</p>
3728
3729<pre class="code">
3730 MagickBooleanType MagickNextImage(MagickWand *wand)
3731</pre>
3732
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3733<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3734
3735<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3736<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3737
3738 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3739<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
3740_8c.html" id="MagickNormalizeImage">MagickNormalizeImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3741<div class="doc-section">
3742
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3743<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]3744
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3745<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]3746
3747<p>The format of the MagickNormalizeImage method is:</p>
3748
3749<pre class="code">
3750 MagickBooleanType MagickNormalizeImage(MagickWand *wand)
3751 MagickBooleanType MagickNormalizeImageChannel(MagickWand *wand,
3752 const ChannelType channel)
3753</pre>
3754
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3755<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3756
3757<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3758<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3759
3760<h5>channel</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3761<p>the image channel(s).</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3762
3763 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3764<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
3765_8c.html" id="MagickOilPaintImage">MagickOilPaintImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3766<div class="doc-section">
3767
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3768<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]3769
3770<p>The format of the MagickOilPaintImage method is:</p>
3771
3772<pre class="code">
3773 MagickBooleanType MagickOilPaintImage(MagickWand *wand,
3774 const double radius)
3775</pre>
3776
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3777<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3778
3779<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3780<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3781
3782<h5>radius</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3783<p>the radius of the circular neighborhood.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3784
3785 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3786<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
3787_8c.html" id="MagickOpaquePaintImage">MagickOpaquePaintImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3788<div class="doc-section">
3789
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3790<p>MagickOpaquePaintImage() changes any pixel that matches color with the color defined by fill.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3791
3792<p>The format of the MagickOpaquePaintImage method is:</p>
3793
3794<pre class="code">
3795 MagickBooleanType MagickOpaquePaintImage(MagickWand *wand,
3796 const PixelWand *target,const PixelWand *fill,const double fuzz,
3797 const MagickBooleanType invert)
3798 MagickBooleanType MagickOpaquePaintImageChannel(MagickWand *wand,
3799 const ChannelType channel,const PixelWand *target,
3800 const PixelWand *fill,const double fuzz,const MagickBooleanType invert)
3801</pre>
3802
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3803<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3804
3805<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3806<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3807
3808<h5>channel</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3809<p>the channel(s).</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3810
3811<h5>target</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3812<p>Change this target color to the fill color within the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3813
3814<h5>fill</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3815<p>the fill pixel wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3816
3817<h5>fuzz</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3818<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]3819
3820<h5>invert</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3821<p>paint any pixel that does not match the target color.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3822
3823 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3824<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
3825_8c.html" id="MagickOptimizeImageLayers">MagickOptimizeImageLayers</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3826<div class="doc-section">
3827
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3828<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]3829
3830<p>The format of the MagickOptimizeImageLayers method is:</p>
3831
3832<pre class="code">
3833 MagickWand *MagickOptimizeImageLayers(MagickWand *wand)
3834</pre>
3835
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3836<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3837
3838<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3839<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3840
3841 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3842<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
3843_8c.html" id="MagickOrderedPosterizeImage">MagickOrderedPosterizeImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3844<div class="doc-section">
3845
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3846<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]3847
3848<p>The format of the MagickOrderedPosterizeImage method is:</p>
3849
3850<pre class="code">
3851 MagickBooleanType MagickOrderedPosterizeImage(MagickWand *wand,
3852 const char *threshold_map)
3853 MagickBooleanType MagickOrderedPosterizeImageChannel(MagickWand *wand,
3854 const ChannelType channel,const char *threshold_map)
3855</pre>
3856
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3857<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3858
3859<h5>image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3860<p>the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3861
3862<h5>channel</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3863<p>the channel or channels to be thresholded.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3864
3865<h5>threshold_map</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3866<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]3867
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3868<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]3869
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3870<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]3871
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3872<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]3873
3874 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3875<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
3876_8c.html" id="MagickPingImage">MagickPingImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3877<div class="doc-section">
3878
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3879<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]3880
3881<p>The format of the MagickPingImage method is:</p>
3882
3883<pre class="code">
3884 MagickBooleanType MagickPingImage(MagickWand *wand,const char *filename)
3885</pre>
3886
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3887<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3888
3889<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3890<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3891
3892<h5>filename</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3893<p>the image filename.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3894
3895 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3896<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
3897_8c.html" id="MagickPingImageBlob">MagickPingImageBlob</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3898<div class="doc-section">
3899
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3900<p>MagickPingImageBlob() pings an image or image sequence from a blob.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3901
3902<p>The format of the MagickPingImageBlob method is:</p>
3903
3904<pre class="code">
3905 MagickBooleanType MagickPingImageBlob(MagickWand *wand,
3906 const void *blob,const size_t length)
3907</pre>
3908
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3909<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3910
3911<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3912<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3913
3914<h5>blob</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3915<p>the blob.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3916
3917<h5>length</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3918<p>the blob length.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3919
3920 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3921<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
3922_8c.html" id="MagickPingImageFile">MagickPingImageFile</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3923<div class="doc-section">
3924
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3925<p>MagickPingImageFile() pings an image or image sequence from an open file descriptor.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3926
3927<p>The format of the MagickPingImageFile method is:</p>
3928
3929<pre class="code">
3930 MagickBooleanType MagickPingImageFile(MagickWand *wand,FILE *file)
3931</pre>
3932
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3933<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3934
3935<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3936<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3937
3938<h5>file</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3939<p>the file descriptor.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3940
3941 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3942<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
3943_8c.html" id="MagickPolaroidImage">MagickPolaroidImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3944<div class="doc-section">
3945
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3946<p>MagickPolaroidImage() simulates a Polaroid picture.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3947
3948<p>The format of the MagickPolaroidImage method is:</p>
3949
3950<pre class="code">
3951 MagickBooleanType MagickPolaroidImage(MagickWand *wand,
3952 const DrawingWand *drawing_wand,const double angle)
3953</pre>
3954
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3955<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3956
3957<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3958<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3959
3960<h5>drawing_wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3961<p>the draw wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3962
3963<h5>angle</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3964<p>Apply the effect along this angle.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3965
3966 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3967<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
3968_8c.html" id="MagickPosterizeImage">MagickPosterizeImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3969<div class="doc-section">
3970
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3971<p>MagickPosterizeImage() reduces the image to a limited number of color level.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3972
3973<p>The format of the MagickPosterizeImage method is:</p>
3974
3975<pre class="code">
3976 MagickBooleanType MagickPosterizeImage(MagickWand *wand,
3977 const unsigned levels,const MagickBooleanType dither)
3978</pre>
3979
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3980<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3981
3982<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3983<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3984
3985<h5>levels</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3986<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]3987
3988<h5>dither</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3989<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]3990
3991 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3992<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
3993_8c.html" id="MagickPreviewImages">MagickPreviewImages</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3994<div class="doc-section">
3995
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]3996<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]3997
3998<p>The format of the MagickPreviewImages method is:</p>
3999
4000<pre class="code">
4001 MagickWand *MagickPreviewImages(MagickWand *wand,
4002 const PreviewType preview)
4003</pre>
4004
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4005<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4006
4007<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4008<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4009
4010<h5>preview</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4011<p>the preview type.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4012
4013 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4014<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
4015_8c.html" id="MagickPreviousImage">MagickPreviousImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4016<div class="doc-section">
4017
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4018<p>MagickPreviousImage() assocates the previous image in an image list with the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4019
4020<p>The format of the MagickPreviousImage method is:</p>
4021
4022<pre class="code">
4023 MagickBooleanType MagickPreviousImage(MagickWand *wand)
4024</pre>
4025
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4026<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4027
4028<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4029<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4030
4031 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4032<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
4033_8c.html" id="MagickQuantizeImage">MagickQuantizeImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4034<div class="doc-section">
4035
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4036<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]4037
4038<p>The format of the MagickQuantizeImage method is:</p>
4039
4040<pre class="code">
4041 MagickBooleanType MagickQuantizeImage(MagickWand *wand,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]4042 const size_t number_colors,const ColorspaceType colorspace,
4043 const size_t treedepth,const MagickBooleanType dither,
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4044 const MagickBooleanType measure_error)
4045</pre>
4046
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4047<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4048
4049<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4050<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4051
4052<h5>number_colors</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4053<p>the number of colors.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4054
4055<h5>colorspace</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4056<p>Perform color reduction in this colorspace, typically RGBColorspace.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4057
4058<h5>treedepth</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4059<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]4060
4061<h5>dither</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4062<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]4063
4064<h5>measure_error</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4065<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]4066
4067 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4068<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
4069_8c.html" id="MagickQuantizeImages">MagickQuantizeImages</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4070<div class="doc-section">
4071
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4072<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]4073
4074<p>The format of the MagickQuantizeImages method is:</p>
4075
4076<pre class="code">
4077 MagickBooleanType MagickQuantizeImages(MagickWand *wand,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]4078 const size_t number_colors,const ColorspaceType colorspace,
4079 const size_t treedepth,const MagickBooleanType dither,
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4080 const MagickBooleanType measure_error)
4081</pre>
4082
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4083<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4084
4085<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4086<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4087
4088<h5>number_colors</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4089<p>the number of colors.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4090
4091<h5>colorspace</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4092<p>Perform color reduction in this colorspace, typically RGBColorspace.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4093
4094<h5>treedepth</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4095<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]4096
4097<h5>dither</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4098<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]4099
4100<h5>measure_error</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4101<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]4102
4103 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4104<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
4105_8c.html" id="MagickRadialBlurImage">MagickRadialBlurImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4106<div class="doc-section">
4107
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4108<p>MagickRadialBlurImage() radial blurs an image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4109
4110<p>The format of the MagickRadialBlurImage method is:</p>
4111
4112<pre class="code">
4113 MagickBooleanType MagickRadialBlurImage(MagickWand *wand,
4114 const double angle)
4115 MagickBooleanType MagickRadialBlurImageChannel(MagickWand *wand,
4116 const ChannelType channel,const double angle)
4117</pre>
4118
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4119<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4120
4121<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4122<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4123
4124<h5>channel</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4125<p>the image channel(s).</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4126
4127<h5>angle</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4128<p>the angle of the blur in degrees.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4129
4130 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4131<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
4132_8c.html" id="MagickRaiseImage">MagickRaiseImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4133<div class="doc-section">
4134
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4135<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]4136
4137<p>The format of the MagickRaiseImage method is:</p>
4138
4139<pre class="code">
4140 MagickBooleanType MagickRaiseImage(MagickWand *wand,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]4141 const size_t width,const size_t height,const ssize_t x,
4142 const ssize_t y,const MagickBooleanType raise)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4143</pre>
4144
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4145<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4146
4147<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4148<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4149
4150<h5>width,height,x,y</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4151<p>Define the dimensions of the area to raise.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4152
4153<h5>raise</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4154<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]4155
4156 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4157<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
4158_8c.html" id="MagickRandomThresholdImage">MagickRandomThresholdImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4159<div class="doc-section">
4160
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4161<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]4162
4163<p>The format of the MagickRandomThresholdImage method is:</p>
4164
4165<pre class="code">
4166 MagickBooleanType MagickRandomThresholdImage(MagickWand *wand,
4167 const double low,const double high)
4168 MagickBooleanType MagickRandomThresholdImageChannel(MagickWand *wand,
4169 const ChannelType channel,const double low,const double high)
4170</pre>
4171
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4172<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4173
4174<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4175<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4176
4177<h5>channel</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4178<p>the image channel(s).</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4179
4180<h5>low,high</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4181<p>Specify the high and low thresholds. These values range from 0 to QuantumRange.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4182
4183 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4184<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
4185_8c.html" id="MagickReadImage">MagickReadImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4186<div class="doc-section">
4187
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4188<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]4189
4190<p>The format of the MagickReadImage method is:</p>
4191
4192<pre class="code">
4193 MagickBooleanType MagickReadImage(MagickWand *wand,const char *filename)
4194</pre>
4195
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4196<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4197
4198<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4199<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4200
4201<h5>filename</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4202<p>the image filename.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4203
4204 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4205<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
4206_8c.html" id="MagickReadImageBlob">MagickReadImageBlob</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4207<div class="doc-section">
4208
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4209<p>MagickReadImageBlob() reads an image or image sequence from a blob.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4210
4211<p>The format of the MagickReadImageBlob method is:</p>
4212
4213<pre class="code">
4214 MagickBooleanType MagickReadImageBlob(MagickWand *wand,
4215 const void *blob,const size_t length)
4216</pre>
4217
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4218<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4219
4220<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4221<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4222
4223<h5>blob</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4224<p>the blob.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4225
4226<h5>length</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4227<p>the blob length.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4228
4229 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4230<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
4231_8c.html" id="MagickReadImageFile">MagickReadImageFile</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4232<div class="doc-section">
4233
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4234<p>MagickReadImageFile() reads an image or image sequence from an open file descriptor.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4235
4236<p>The format of the MagickReadImageFile method is:</p>
4237
4238<pre class="code">
4239 MagickBooleanType MagickReadImageFile(MagickWand *wand,FILE *file)
4240</pre>
4241
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4242<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4243
4244<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4245<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4246
4247<h5>file</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4248<p>the file descriptor.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4249
4250 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4251<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
4252_8c.html" id="MagickReduceNoiseImage">MagickReduceNoiseImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4253<div class="doc-section">
4254
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4255<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]4256
4257<p>The format of the MagickReduceNoiseImage method is:</p>
4258
4259<pre class="code">
4260 MagickBooleanType MagickReduceNoiseImage(MagickWand *wand,
4261 const double radius)
4262</pre>
4263
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4264<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4265
4266<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4267<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4268
4269<h5>radius</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4270<p>the radius of the pixel neighborhood.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4271
4272 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4273<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
4274_8c.html" id="MagickRemapImage">MagickRemapImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4275<div class="doc-section">
4276
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4277<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]4278
4279<p>The format of the MagickRemapImage method is:</p>
4280
4281<pre class="code">
4282 MagickBooleanType MagickRemapImage(MagickWand *wand,
4283 const MagickWand *remap_wand,const DitherMethod method)
4284</pre>
4285
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4286<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4287
4288<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4289<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4290
4291<h5>affinity</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4292<p>the affinity wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4293
4294<h5>method</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4295<p>choose from these dither methods: NoDitherMethod, RiemersmaDitherMethod, or FloydSteinbergDitherMethod.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4296
4297 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4298<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
4299_8c.html" id="MagickRemoveImage">MagickRemoveImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4300<div class="doc-section">
4301
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4302<p>MagickRemoveImage() removes an image from the image list.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4303
4304<p>The format of the MagickRemoveImage method is:</p>
4305
4306<pre class="code">
4307 MagickBooleanType MagickRemoveImage(MagickWand *wand)
4308</pre>
4309
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4310<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4311
4312<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4313<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4314
4315<h5>insert</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4316<p>the splice wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4317
4318 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4319<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
4320_8c.html" id="MagickResampleImage">MagickResampleImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4321<div class="doc-section">
4322
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4323<p>MagickResampleImage() resample image to desired resolution.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4324
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4325<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]4326
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4327<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]4328
4329<p>The format of the MagickResampleImage method is:</p>
4330
4331<pre class="code">
4332 MagickBooleanType MagickResampleImage(MagickWand *wand,
4333 const double x_resolution,const double y_resolution,
4334 const FilterTypes filter,const double blur)
4335</pre>
4336
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4337<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4338
4339<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4340<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4341
4342<h5>x_resolution</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4343<p>the new image x resolution.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4344
4345<h5>y_resolution</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4346<p>the new image y resolution.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4347
4348<h5>filter</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4349<p>Image filter to use.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4350
4351<h5>blur</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4352<p>the blur factor where > 1 is blurry, < 1 is sharp.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4353
4354 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4355<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
4356_8c.html" id="MagickResetImagePage">MagickResetImagePage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4357<div class="doc-section">
4358
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4359<p>MagickResetImagePage() resets the Wand page canvas and position.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4360
4361<p>The format of the MagickResetImagePage method is:</p>
4362
4363<pre class="code">
4364 MagickBooleanType MagickResetImagePage(MagickWand *wand,
4365 const char *page)
4366</pre>
4367
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4368<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4369
4370<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4371<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4372
4373<h5>page</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4374<p>the relative page specification.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4375
4376 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4377<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
4378_8c.html" id="MagickResizeImage">MagickResizeImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4379<div class="doc-section">
4380
4381<p>MagickResizeImage() scales an image to the desired dimensions with one of these filters:</p>
4382
4383<pre class="text">
4384 Bessel Blackman Box
4385 Catrom CubicGaussian
4386 Hanning Hermite Lanczos
4387 Mitchell PointQuandratic
4388 Sinc Triangle
4389</pre>
4390
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4391<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]4392
4393<p>The format of the MagickResizeImage method is:</p>
4394
4395<pre class="code">
4396 MagickBooleanType MagickResizeImage(MagickWand *wand,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]4397 const size_t columns,const size_t rows,
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4398 const FilterTypes filter,const double blur)
4399</pre>
4400
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4401<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4402
4403<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4404<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4405
4406<h5>columns</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4407<p>the number of columns in the scaled image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4408
4409<h5>rows</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4410<p>the number of rows in the scaled image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4411
4412<h5>filter</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4413<p>Image filter to use.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4414
4415<h5>blur</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4416<p>the blur factor where > 1 is blurry, < 1 is sharp.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4417
4418 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4419<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
4420_8c.html" id="MagickRollImage">MagickRollImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4421<div class="doc-section">
4422
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4423<p>MagickRollImage() offsets an image as defined by x and y.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4424
4425<p>The format of the MagickRollImage method is:</p>
4426
4427<pre class="code">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]4428 MagickBooleanType MagickRollImage(MagickWand *wand,const ssize_t x,
4429 const size_t y)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4430</pre>
4431
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4432<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4433
4434<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4435<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4436
4437<h5>x</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4438<p>the x offset.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4439
4440<h5>y</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4441<p>the y offset.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4442
4443
4444 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4445<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
4446_8c.html" id="MagickRotateImage">MagickRotateImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4447<div class="doc-section">
4448
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4449<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]4450
4451<p>The format of the MagickRotateImage method is:</p>
4452
4453<pre class="code">
4454 MagickBooleanType MagickRotateImage(MagickWand *wand,
4455 const PixelWand *background,const double degrees)
4456</pre>
4457
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4458<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4459
4460<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4461<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4462
4463<h5>background</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4464<p>the background pixel wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4465
4466<h5>degrees</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4467<p>the number of degrees to rotate the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4468
4469
4470 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4471<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
4472_8c.html" id="MagickSampleImage">MagickSampleImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4473<div class="doc-section">
4474
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4475<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]4476
4477<p>The format of the MagickSampleImage method is:</p>
4478
4479<pre class="code">
4480 MagickBooleanType MagickSampleImage(MagickWand *wand,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]4481 const size_t columns,const size_t rows)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4482</pre>
4483
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4484<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4485
4486<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4487<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4488
4489<h5>columns</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4490<p>the number of columns in the scaled image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4491
4492<h5>rows</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4493<p>the number of rows in the scaled image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4494
4495
4496 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4497<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
4498_8c.html" id="MagickScaleImage">MagickScaleImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4499<div class="doc-section">
4500
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4501<p>MagickScaleImage() scales the size of an image to the given dimensions.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4502
4503<p>The format of the MagickScaleImage method is:</p>
4504
4505<pre class="code">
4506 MagickBooleanType MagickScaleImage(MagickWand *wand,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]4507 const size_t columns,const size_t rows)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4508</pre>
4509
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4510<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4511
4512<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4513<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4514
4515<h5>columns</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4516<p>the number of columns in the scaled image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4517
4518<h5>rows</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4519<p>the number of rows in the scaled image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4520
4521
4522 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4523<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
4524_8c.html" id="MagickSegmentImage">MagickSegmentImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4525<div class="doc-section">
4526
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4527<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]4528
4529<p>The format of the SegmentImage method is:</p>
4530
4531<pre class="code">
4532 MagickBooleanType MagickSegmentImage(MagickWand *wand,
4533 const ColorspaceType colorspace,const MagickBooleanType verbose,
4534 const double cluster_threshold,const double smooth_threshold)
4535</pre>
4536
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4537<p>A description of each parameter follows.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4538
4539<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4540<p>the wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4541
4542<h5>colorspace</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4543<p>the image colorspace.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4544
4545<h5>verbose</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4546<p>Set to MagickTrue to print detailed information about the identified classes.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4547
4548<h5>cluster_threshold</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4549<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]4550
4551<h5>smooth_threshold</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4552<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]4553
4554 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4555<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
4556_8c.html" id="MagickSelectiveBlurImage">MagickSelectiveBlurImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4557<div class="doc-section">
4558
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4559<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]4560
4561<p>The format of the MagickSelectiveBlurImage method is:</p>
4562
4563<pre class="code">
4564 MagickBooleanType MagickSelectiveBlurImage(MagickWand *wand,
4565 const double radius,const double sigma,const double threshold)
4566 MagickBooleanType MagickSelectiveBlurImageChannel(MagickWand *wand,
4567 const ChannelType channel,const double radius,const double sigma,
4568 const double threshold)
4569</pre>
4570
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4571<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4572
4573<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4574<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4575
4576<h5>channel</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4577<p>the image channel(s).</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4578
4579<h5>radius</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4580<p>the radius of the gaussian, in pixels, not counting the center pixel.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4581
4582<h5>sigma</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4583<p>the standard deviation of the gaussian, in pixels.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4584
4585<h5>threshold</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4586<p>only pixels within this contrast threshold are included in the blur operation.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4587
4588 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4589<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
4590_8c.html" id="MagickSeparateImageChannel">MagickSeparateImageChannel</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4591<div class="doc-section">
4592
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4593<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]4594
4595<p>The format of the MagickSeparateImageChannel method is:</p>
4596
4597<pre class="code">
4598 MagickBooleanType MagickSeparateImageChannel(MagickWand *wand,
4599 const ChannelType channel)
4600</pre>
4601
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4602<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4603
4604<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4605<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4606
4607<h5>channel</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4608<p>the image channel(s).</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4609
4610 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4611<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
4612_8c.html" id="MagickSepiaToneImage">MagickSepiaToneImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4613<div class="doc-section">
4614
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4615<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]4616
4617<p>The format of the MagickSepiaToneImage method is:</p>
4618
4619<pre class="code">
4620 MagickBooleanType MagickSepiaToneImage(MagickWand *wand,
4621 const double threshold)
4622</pre>
4623
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4624<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4625
4626<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4627<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4628
4629<h5>threshold</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4630<p>Define the extent of the sepia toning.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4631
4632 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4633<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
4634_8c.html" id="MagickSetImage">MagickSetImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4635<div class="doc-section">
4636
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4637<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]4638
4639<p>The format of the MagickSetImage method is:</p>
4640
4641<pre class="code">
4642 MagickBooleanType MagickSetImage(MagickWand *wand,
4643 const MagickWand *set_wand)
4644</pre>
4645
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4646<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4647
4648<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4649<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4650
4651<h5>set_wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4652<p>the set_wand wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4653
4654 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4655<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
4656_8c.html" id="MagickSetImageAlphaChannel">MagickSetImageAlphaChannel</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4657<div class="doc-section">
4658
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4659<p>MagickSetImageAlphaChannel() activates, deactivates, resets, or sets the alpha channel.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4660
4661<p>The format of the MagickSetImageAlphaChannel method is:</p>
4662
4663<pre class="code">
4664 MagickBooleanType MagickSetImageAlphaChannel(MagickWand *wand,
4665 const AlphaChannelType alpha_type)
4666</pre>
4667
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4668<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4669
4670<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4671<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4672
4673<h5>alpha_type</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4674<p>the alpha channel type: ActivateAlphaChannel, DeactivateAlphaChannel, OpaqueAlphaChannel, or SetAlphaChannel.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4675
4676 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4677<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
4678_8c.html" id="MagickSetImageBackgroundColor">MagickSetImageBackgroundColor</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4679<div class="doc-section">
4680
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4681<p>MagickSetImageBackgroundColor() sets the image background color.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4682
4683<p>The format of the MagickSetImageBackgroundColor method is:</p>
4684
4685<pre class="code">
4686 MagickBooleanType MagickSetImageBackgroundColor(MagickWand *wand,
4687 const PixelWand *background)
4688</pre>
4689
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4690<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4691
4692<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4693<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4694
4695<h5>background</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4696<p>the background pixel wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4697
4698 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4699<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
4700_8c.html" id="MagickSetImageBias">MagickSetImageBias</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4701<div class="doc-section">
4702
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4703<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]4704
4705<p>The format of the MagickSetImageBias method is:</p>
4706
4707<pre class="code">
4708 MagickBooleanType MagickSetImageBias(MagickWand *wand,
4709 const double bias)
4710</pre>
4711
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4712<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4713
4714<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4715<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4716
4717<h5>bias</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4718<p>the image bias.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4719
4720 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4721<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
4722_8c.html" id="MagickSetImageBluePrimary">MagickSetImageBluePrimary</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4723<div class="doc-section">
4724
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4725<p>MagickSetImageBluePrimary() sets the image chromaticity blue primary point.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4726
4727<p>The format of the MagickSetImageBluePrimary method is:</p>
4728
4729<pre class="code">
4730 MagickBooleanType MagickSetImageBluePrimary(MagickWand *wand,
4731 const double x,const double y)
4732</pre>
4733
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4734<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4735
4736<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4737<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4738
4739<h5>x</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4740<p>the blue primary x-point.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4741
4742<h5>y</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4743<p>the blue primary y-point.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4744
4745 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4746<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
4747_8c.html" id="MagickSetImageBorderColor">MagickSetImageBorderColor</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4748<div class="doc-section">
4749
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4750<p>MagickSetImageBorderColor() sets the image border color.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4751
4752<p>The format of the MagickSetImageBorderColor method is:</p>
4753
4754<pre class="code">
4755 MagickBooleanType MagickSetImageBorderColor(MagickWand *wand,
4756 const PixelWand *border)
4757</pre>
4758
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4759<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4760
4761<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4762<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4763
4764<h5>border</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4765<p>the border pixel wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4766
4767 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4768<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
4769_8c.html" id="MagickSetImageChannelDepth">MagickSetImageChannelDepth</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4770<div class="doc-section">
4771
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4772<p>MagickSetImageChannelDepth() sets the depth of a particular image channel.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4773
4774<p>The format of the MagickSetImageChannelDepth method is:</p>
4775
4776<pre class="code">
4777 MagickBooleanType MagickSetImageChannelDepth(MagickWand *wand,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]4778 const ChannelType channel,const size_t depth)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4779</pre>
4780
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4781<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4782
4783<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4784<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4785
4786<h5>channel</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4787<p>the image channel(s).</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4788
4789<h5>depth</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4790<p>the image depth in bits.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4791
4792 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4793<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
4794_8c.html" id="MagickSetImageClipMask">MagickSetImageClipMask</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4795<div class="doc-section">
4796
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4797<p>MagickSetImageClipMask() sets image clip mask.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4798
4799<p>The format of the MagickSetImageClipMask method is:</p>
4800
4801<pre class="code">
4802 MagickBooleanType MagickSetImageClipMask(MagickWand *wand,
4803 const MagickWand *clip_mask)
4804</pre>
4805
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4806<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4807
4808<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4809<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4810
4811<h5>clip_mask</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4812<p>the clip_mask wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4813
4814 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4815<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
4816_8c.html" id="MagickSetImageColor">MagickSetImageColor</a></h2>
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]4817<div class="doc-section">
4818
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4819<p>MagickSetImageColor() set the entire wand canvas to the specified color.</p>
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]4820
4821<p>The format of the MagickSetImageColor method is:</p>
4822
4823<pre class="code">
4824 MagickBooleanType MagickSetImageColor(MagickWand *wand,
4825 const PixelWand *color)
4826</pre>
4827
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4828<p>A description of each parameter follows:</p>
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]4829
4830<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4831<p>the magick wand.</p>
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]4832
4833<h5>background</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4834<p>the image color.</p>
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]4835
4836 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4837<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
4838_8c.html" id="MagickSetImageColormapColor">MagickSetImageColormapColor</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4839<div class="doc-section">
4840
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4841<p>MagickSetImageColormapColor() sets the color of the specified colormap index.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4842
4843<p>The format of the MagickSetImageColormapColor method is:</p>
4844
4845<pre class="code">
4846 MagickBooleanType MagickSetImageColormapColor(MagickWand *wand,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]4847 const size_t index,const PixelWand *color)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4848</pre>
4849
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4850<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4851
4852<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4853<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4854
4855<h5>index</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4856<p>the offset into the image colormap.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4857
4858<h5>color</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4859<p>Return the colormap color in this wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4860
4861 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4862<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
4863_8c.html" id="MagickSetImageColorspace">MagickSetImageColorspace</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4864<div class="doc-section">
4865
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4866<p>MagickSetImageColorspace() sets the image colorspace.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4867
4868<p>The format of the MagickSetImageColorspace method is:</p>
4869
4870<pre class="code">
4871 MagickBooleanType MagickSetImageColorspace(MagickWand *wand,
4872 const ColorspaceType colorspace)
4873</pre>
4874
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4875<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4876
4877<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4878<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4879
4880<h5>colorspace</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4881<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]4882
4883 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4884<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
4885_8c.html" id="MagickSetImageCompose">MagickSetImageCompose</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4886<div class="doc-section">
4887
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4888<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]4889
4890<p>The format of the MagickSetImageCompose method is:</p>
4891
4892<pre class="code">
4893 MagickBooleanType MagickSetImageCompose(MagickWand *wand,
4894 const CompositeOperator compose)
4895</pre>
4896
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4897<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4898
4899<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4900<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4901
4902<h5>compose</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4903<p>the image composite operator.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4904
4905 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4906<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
4907_8c.html" id="MagickSetImageCompression">MagickSetImageCompression</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4908<div class="doc-section">
4909
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4910<p>MagickSetImageCompression() sets the image compression.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4911
4912<p>The format of the MagickSetImageCompression method is:</p>
4913
4914<pre class="code">
4915 MagickBooleanType MagickSetImageCompression(MagickWand *wand,
4916 const CompressionType compression)
4917</pre>
4918
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4919<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4920
4921<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4922<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4923
4924<h5>compression</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4925<p>the image compression type.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4926
4927 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4928<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
4929_8c.html" id="MagickSetImageCompressionQuality">MagickSetImageCompressionQuality</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4930<div class="doc-section">
4931
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4932<p>MagickSetImageCompressionQuality() sets the image compression quality.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4933
4934<p>The format of the MagickSetImageCompressionQuality method is:</p>
4935
4936<pre class="code">
4937 MagickBooleanType MagickSetImageCompressionQuality(MagickWand *wand,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]4938 const size_t quality)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4939</pre>
4940
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4941<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4942
4943<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4944<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4945
4946<h5>quality</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4947<p>the image compression tlityype.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4948
4949 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4950<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
4951_8c.html" id="MagickSetImageDelay">MagickSetImageDelay</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4952<div class="doc-section">
4953
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4954<p>MagickSetImageDelay() sets the image delay.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4955
4956<p>The format of the MagickSetImageDelay method is:</p>
4957
4958<pre class="code">
4959 MagickBooleanType MagickSetImageDelay(MagickWand *wand,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]4960 const size_t delay)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4961</pre>
4962
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4963<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4964
4965<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4966<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4967
4968<h5>delay</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4969<p>the image delay in ticks-per-second units.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4970
4971 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4972<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
4973_8c.html" id="MagickSetImageDepth">MagickSetImageDepth</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4974<div class="doc-section">
4975
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4976<p>MagickSetImageDepth() sets the image depth.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4977
4978<p>The format of the MagickSetImageDepth method is:</p>
4979
4980<pre class="code">
4981 MagickBooleanType MagickSetImageDepth(MagickWand *wand,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]4982 const size_t depth)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4983</pre>
4984
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4985<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4986
4987<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4988<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4989
4990<h5>depth</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4991<p>the image depth in bits: 8, 16, or 32.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4992
4993 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4994<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
4995_8c.html" id="MagickSetImageDispose">MagickSetImageDispose</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4996<div class="doc-section">
4997
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]4998<p>MagickSetImageDispose() sets the image disposal method.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]4999
5000<p>The format of the MagickSetImageDispose method is:</p>
5001
5002<pre class="code">
5003 MagickBooleanType MagickSetImageDispose(MagickWand *wand,
5004 const DisposeType dispose)
5005</pre>
5006
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5007<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5008
5009<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5010<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5011
5012<h5>dispose</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5013<p>the image disposeal type.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5014
5015 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5016<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
5017_8c.html" id="MagickSetImageExtent">MagickSetImageExtent</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5018<div class="doc-section">
5019
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5020<p>MagickSetImageExtent() sets the image size (i.e. columns & rows).</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5021
5022<p>The format of the MagickSetImageExtent method is:</p>
5023
5024<pre class="code">
5025 MagickBooleanType MagickSetImageExtent(MagickWand *wand,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]5026 const size_t columns,const unsigned rows)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5027</pre>
5028
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5029<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5030
5031<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5032<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5033
5034<h5>columns</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5035<p>The image width in pixels.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5036
5037<h5>rows</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5038<p>The image height in pixels.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5039
5040 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5041<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
5042_8c.html" id="MagickSetImageFilename">MagickSetImageFilename</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5043<div class="doc-section">
5044
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5045<p>MagickSetImageFilename() sets the filename of a particular image in a sequence.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5046
5047<p>The format of the MagickSetImageFilename method is:</p>
5048
5049<pre class="code">
5050 MagickBooleanType MagickSetImageFilename(MagickWand *wand,
5051 const char *filename)
5052</pre>
5053
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5054<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5055
5056<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5057<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5058
5059<h5>filename</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5060<p>the image filename.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5061
5062 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5063<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
5064_8c.html" id="MagickSetImageFormat">MagickSetImageFormat</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5065<div class="doc-section">
5066
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5067<p>MagickSetImageFormat() sets the format of a particular image in a sequence.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5068
5069<p>The format of the MagickSetImageFormat method is:</p>
5070
5071<pre class="code">
5072 MagickBooleanType MagickSetImageFormat(MagickWand *wand,
5073 const char *format)
5074</pre>
5075
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5076<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5077
5078<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5079<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5080
5081<h5>format</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5082<p>the image format.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5083
5084 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5085<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
5086_8c.html" id="MagickSetImageFuzz">MagickSetImageFuzz</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5087<div class="doc-section">
5088
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5089<p>MagickSetImageFuzz() sets the image fuzz.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5090
5091<p>The format of the MagickSetImageFuzz method is:</p>
5092
5093<pre class="code">
5094 MagickBooleanType MagickSetImageFuzz(MagickWand *wand,
5095 const double fuzz)
5096</pre>
5097
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5098<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5099
5100<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5101<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5102
5103<h5>fuzz</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5104<p>the image fuzz.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5105
5106 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5107<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
5108_8c.html" id="MagickSetImageGamma">MagickSetImageGamma</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5109<div class="doc-section">
5110
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5111<p>MagickSetImageGamma() sets the image gamma.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5112
5113<p>The format of the MagickSetImageGamma method is:</p>
5114
5115<pre class="code">
5116 MagickBooleanType MagickSetImageGamma(MagickWand *wand,
5117 const double gamma)
5118</pre>
5119
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5120<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5121
5122<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5123<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5124
5125<h5>gamma</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5126<p>the image gamma.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5127
5128 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5129<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
5130_8c.html" id="MagickSetImageGravity">MagickSetImageGravity</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5131<div class="doc-section">
5132
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5133<p>MagickSetImageGravity() sets the image gravity type.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5134
5135<p>The format of the MagickSetImageGravity method is:</p>
5136
5137<pre class="code">
5138 MagickBooleanType MagickSetImageGravity(MagickWand *wand,
5139 const GravityType gravity)
5140</pre>
5141
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5142<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5143
5144<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5145<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5146
5147<h5>gravity</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5148<p>the image interlace scheme: NoInterlace, LineInterlace, PlaneInterlace, PartitionInterlace.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5149
5150 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5151<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
5152_8c.html" id="MagickSetImageGreenPrimary">MagickSetImageGreenPrimary</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5153<div class="doc-section">
5154
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5155<p>MagickSetImageGreenPrimary() sets the image chromaticity green primary point.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5156
5157<p>The format of the MagickSetImageGreenPrimary method is:</p>
5158
5159<pre class="code">
5160 MagickBooleanType MagickSetImageGreenPrimary(MagickWand *wand,
5161 const double x,const double y)
5162</pre>
5163
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5164<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5165
5166<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5167<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5168
5169<h5>x</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5170<p>the green primary x-point.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5171
5172<h5>y</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5173<p>the green primary y-point.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5174
5175
5176 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5177<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
5178_8c.html" id="MagickSetImageInterlaceScheme">MagickSetImageInterlaceScheme</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5179<div class="doc-section">
5180
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5181<p>MagickSetImageInterlaceScheme() sets the image interlace scheme.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5182
5183<p>The format of the MagickSetImageInterlaceScheme method is:</p>
5184
5185<pre class="code">
5186 MagickBooleanType MagickSetImageInterlaceScheme(MagickWand *wand,
5187 const InterlaceType interlace)
5188</pre>
5189
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5190<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5191
5192<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5193<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5194
5195<h5>interlace</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5196<p>the image interlace scheme: NoInterlace, LineInterlace, PlaneInterlace, PartitionInterlace.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5197
5198 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5199<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
5200_8c.html" id="MagickSetImageInterpolateMethod">MagickSetImageInterpolateMethod</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5201<div class="doc-section">
5202
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5203<p>MagickSetImageInterpolateMethod() sets the image interpolate pixel method.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5204
5205<p>The format of the MagickSetImageInterpolateMethod method is:</p>
5206
5207<pre class="code">
5208 MagickBooleanType MagickSetImageInterpolateMethod(MagickWand *wand,
5209 const InterpolatePixelMethod method)
5210</pre>
5211
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5212<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5213
5214<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5215<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5216
5217<h5>method</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5218<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]5219
5220 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5221<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
5222_8c.html" id="MagickSetImageIterations">MagickSetImageIterations</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5223<div class="doc-section">
5224
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5225<p>MagickSetImageIterations() sets the image iterations.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5226
5227<p>The format of the MagickSetImageIterations method is:</p>
5228
5229<pre class="code">
5230 MagickBooleanType MagickSetImageIterations(MagickWand *wand,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]5231 const size_t iterations)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5232</pre>
5233
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5234<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5235
5236<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5237<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5238
5239<h5>delay</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5240<p>the image delay in 1/100th of a second.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5241
5242 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5243<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
5244_8c.html" id="MagickSetImageMatte">MagickSetImageMatte</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5245<div class="doc-section">
5246
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5247<p>MagickSetImageMatte() sets the image matte channel.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5248
5249<p>The format of the MagickSetImageMatteColor method is:</p>
5250
5251<pre class="code">
5252 MagickBooleanType MagickSetImageMatteColor(MagickWand *wand,
5253 const MagickBooleanType *matte)
5254</pre>
5255
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5256<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5257
5258<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5259<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5260
5261<h5>matte</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5262<p>Set to MagickTrue to enable the image matte channel otherwise MagickFalse.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5263
5264 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5265<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
5266_8c.html" id="MagickSetImageMatteColor">MagickSetImageMatteColor</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5267<div class="doc-section">
5268
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5269<p>MagickSetImageMatteColor() sets the image matte color.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5270
5271<p>The format of the MagickSetImageMatteColor method is:</p>
5272
5273<pre class="code">
5274 MagickBooleanType MagickSetImageMatteColor(MagickWand *wand,
5275 const PixelWand *matte)
5276</pre>
5277
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5278<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5279
5280<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5281<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5282
5283<h5>matte</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5284<p>the matte pixel wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5285
5286 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5287<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
5288_8c.html" id="MagickSetImageOpacity">MagickSetImageOpacity</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5289<div class="doc-section">
5290
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5291<p>MagickSetImageOpacity() sets the image to the specified opacity level.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5292
5293<p>The format of the MagickSetImageOpacity method is:</p>
5294
5295<pre class="code">
5296 MagickBooleanType MagickSetImageOpacity(MagickWand *wand,
5297 const double alpha)
5298</pre>
5299
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5300<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5301
5302<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5303<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5304
5305<h5>alpha</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5306<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]5307
5308 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5309<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
5310_8c.html" id="MagickSetImageOrientation">MagickSetImageOrientation</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5311<div class="doc-section">
5312
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5313<p>MagickSetImageOrientation() sets the image orientation.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5314
5315<p>The format of the MagickSetImageOrientation method is:</p>
5316
5317<pre class="code">
5318 MagickBooleanType MagickSetImageOrientation(MagickWand *wand,
5319 const OrientationType orientation)
5320</pre>
5321
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5322<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5323
5324<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5325<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5326
5327<h5>orientation</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5328<p>the image orientation type.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5329
5330 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5331<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
5332_8c.html" id="MagickSetImagePage">MagickSetImagePage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5333<div class="doc-section">
5334
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5335<p>MagickSetImagePage() sets the page geometry of the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5336
5337<p>The format of the MagickSetImagePage method is:</p>
5338
5339<pre class="code">
5340 MagickBooleanType MagickSetImagePage(MagickWand *wand,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]5341 const size_t width,const size_t height,const ssize_t x,
5342 const ssize_t y)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5343</pre>
5344
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5345<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5346
5347<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5348<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5349
5350<h5>width</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5351<p>the page width.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5352
5353<h5>height</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5354<p>the page height.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5355
5356<h5>x</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5357<p>the page x-offset.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5358
5359<h5>y</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5360<p>the page y-offset.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5361
5362 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5363<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
5364_8c.html" id="MagickSetImageProgressMonitor">MagickSetImageProgressMonitor</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5365<div class="doc-section">
5366
5367<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>
5368
5369<pre class="text">
5370 MagickBooleanType MagickProgressMonitor(const char *text,
5371 const MagickOffsetType offset,const MagickSizeType span,
5372 void *client_data)
5373</pre>
5374
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5375<p>If the progress monitor returns MagickFalse, the current operation is interrupted.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5376
5377<p>The format of the MagickSetImageProgressMonitor method is:</p>
5378
5379<pre class="code">
5380 MagickProgressMonitor MagickSetImageProgressMonitor(MagickWand *wand
5381 const MagickProgressMonitor progress_monitor,void *client_data)
5382</pre>
5383
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5384<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5385
5386<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5387<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5388
5389<h5>progress_monitor</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5390<p>Specifies a pointer to a method to monitor progress of an image operation.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5391
5392<h5>client_data</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5393<p>Specifies a pointer to any client data.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5394
5395 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5396<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
5397_8c.html" id="MagickSetImageRedPrimary">MagickSetImageRedPrimary</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5398<div class="doc-section">
5399
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5400<p>MagickSetImageRedPrimary() sets the image chromaticity red primary point.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5401
5402<p>The format of the MagickSetImageRedPrimary method is:</p>
5403
5404<pre class="code">
5405 MagickBooleanType MagickSetImageRedPrimary(MagickWand *wand,
5406 const double x,const double y)
5407</pre>
5408
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5409<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5410
5411<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5412<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5413
5414<h5>x</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5415<p>the red primary x-point.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5416
5417<h5>y</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5418<p>the red primary y-point.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5419
5420 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5421<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
5422_8c.html" id="MagickSetImageRenderingIntent">MagickSetImageRenderingIntent</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5423<div class="doc-section">
5424
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5425<p>MagickSetImageRenderingIntent() sets the image rendering intent.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5426
5427<p>The format of the MagickSetImageRenderingIntent method is:</p>
5428
5429<pre class="code">
5430 MagickBooleanType MagickSetImageRenderingIntent(MagickWand *wand,
5431 const RenderingIntent rendering_intent)
5432</pre>
5433
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5434<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5435
5436<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5437<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5438
5439<h5>rendering_intent</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5440<p>the image rendering intent: UndefinedIntent, SaturationIntent, PerceptualIntent, AbsoluteIntent, or RelativeIntent.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5441
5442 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5443<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
5444_8c.html" id="MagickSetImageResolution">MagickSetImageResolution</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5445<div class="doc-section">
5446
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5447<p>MagickSetImageResolution() sets the image resolution.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5448
5449<p>The format of the MagickSetImageResolution method is:</p>
5450
5451<pre class="code">
5452 MagickBooleanType MagickSetImageResolution(MagickWand *wand,
5453 const double x_resolution,const doubtl y_resolution)
5454</pre>
5455
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5456<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5457
5458<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5459<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5460
5461<h5>x_resolution</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5462<p>the image x resolution.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5463
5464<h5>y_resolution</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5465<p>the image y resolution.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5466
5467 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5468<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
5469_8c.html" id="MagickSetImageScene">MagickSetImageScene</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5470<div class="doc-section">
5471
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5472<p>MagickSetImageScene() sets the image scene.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5473
5474<p>The format of the MagickSetImageScene method is:</p>
5475
5476<pre class="code">
5477 MagickBooleanType MagickSetImageScene(MagickWand *wand,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]5478 const size_t scene)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5479</pre>
5480
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5481<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5482
5483<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5484<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5485
5486<h5>delay</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5487<p>the image scene number.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5488
5489 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5490<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
5491_8c.html" id="MagickSetImageTicksPerSecond">MagickSetImageTicksPerSecond</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5492<div class="doc-section">
5493
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5494<p>MagickSetImageTicksPerSecond() sets the image ticks-per-second.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5495
5496<p>The format of the MagickSetImageTicksPerSecond method is:</p>
5497
5498<pre class="code">
5499 MagickBooleanType MagickSetImageTicksPerSecond(MagickWand *wand,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]5500 const ssize_t ticks_per-second)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5501</pre>
5502
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5503<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5504
5505<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5506<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5507
5508<h5>ticks_per_second</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5509<p>the units to use for the image delay.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5510
5511 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5512<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
5513_8c.html" id="MagickSetImageType">MagickSetImageType</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5514<div class="doc-section">
5515
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5516<p>MagickSetImageType() sets the image type.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5517
5518<p>The format of the MagickSetImageType method is:</p>
5519
5520<pre class="code">
5521 MagickBooleanType MagickSetImageType(MagickWand *wand,
5522 const ImageType image_type)
5523</pre>
5524
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5525<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5526
5527<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5528<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5529
5530<h5>image_type</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5531<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]5532
5533 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5534<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
5535_8c.html" id="MagickSetImageUnits">MagickSetImageUnits</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5536<div class="doc-section">
5537
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5538<p>MagickSetImageUnits() sets the image units of resolution.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5539
5540<p>The format of the MagickSetImageUnits method is:</p>
5541
5542<pre class="code">
5543 MagickBooleanType MagickSetImageUnits(MagickWand *wand,
5544 const ResolutionType units)
5545</pre>
5546
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5547<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5548
5549<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5550<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5551
5552<h5>units</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5553<p>the image units of resolution : UndefinedResolution, PixelsPerInchResolution, or PixelsPerCentimeterResolution.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5554
5555 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5556<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
5557_8c.html" id="MagickSetImageVirtualPixelMethod">MagickSetImageVirtualPixelMethod</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5558<div class="doc-section">
5559
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5560<p>MagickSetImageVirtualPixelMethod() sets the image virtual pixel method.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5561
5562<p>The format of the MagickSetImageVirtualPixelMethod method is:</p>
5563
5564<pre class="code">
5565 VirtualPixelMethod MagickSetImageVirtualPixelMethod(MagickWand *wand,
5566 const VirtualPixelMethod method)
5567</pre>
5568
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5569<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5570
5571<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5572<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5573
5574<h5>method</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5575<p>the image virtual pixel method : UndefinedVirtualPixelMethod, ConstantVirtualPixelMethod, EdgeVirtualPixelMethod, MirrorVirtualPixelMethod, or TileVirtualPixelMethod.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5576
5577 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5578<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
5579_8c.html" id="MagickSetImageWhitePoint">MagickSetImageWhitePoint</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5580<div class="doc-section">
5581
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5582<p>MagickSetImageWhitePoint() sets the image chromaticity white point.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5583
5584<p>The format of the MagickSetImageWhitePoint method is:</p>
5585
5586<pre class="code">
5587 MagickBooleanType MagickSetImageWhitePoint(MagickWand *wand,
5588 const double x,const double y)
5589</pre>
5590
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5591<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5592
5593<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5594<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5595
5596<h5>x</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5597<p>the white x-point.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5598
5599<h5>y</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5600<p>the white y-point.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5601
5602 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5603<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
5604_8c.html" id="MagickShadeImage">MagickShadeImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5605<div class="doc-section">
5606
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5607<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]5608
5609<p>The format of the MagickShadeImage method is:</p>
5610
5611<pre class="code">
5612 MagickBooleanType MagickShadeImage(MagickWand *wand,
5613 const MagickBooleanType gray,const double azimuth,
5614 const double elevation)
5615</pre>
5616
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5617<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5618
5619<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5620<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5621
5622<h5>gray</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5623<p>A value other than zero shades the intensity of each pixel.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5624
5625<h5>azimuth, elevation</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5626<p>Define the light source direction.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5627
5628 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5629<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
5630_8c.html" id="MagickShadowImage">MagickShadowImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5631<div class="doc-section">
5632
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5633<p>MagickShadowImage() simulates an image shadow.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5634
5635<p>The format of the MagickShadowImage method is:</p>
5636
5637<pre class="code">
5638 MagickBooleanType MagickShadowImage(MagickWand *wand,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]5639 const double opacity,const double sigma,const ssize_t x,const ssize_t y)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5640</pre>
5641
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5642<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5643
5644<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5645<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5646
5647<h5>opacity</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5648<p>percentage transparency.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5649
5650<h5>sigma</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5651<p>the standard deviation of the Gaussian, in pixels.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5652
5653<h5>x</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5654<p>the shadow x-offset.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5655
5656<h5>y</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5657<p>the shadow y-offset.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5658
5659 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5660<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
5661_8c.html" id="MagickSharpenImage">MagickSharpenImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5662<div class="doc-section">
5663
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5664<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]5665
5666<p>The format of the MagickSharpenImage method is:</p>
5667
5668<pre class="code">
5669 MagickBooleanType MagickSharpenImage(MagickWand *wand,
5670 const double radius,const double sigma)
5671 MagickBooleanType MagickSharpenImageChannel(MagickWand *wand,
5672 const ChannelType channel,const double radius,const double sigma)
5673</pre>
5674
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5675<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5676
5677<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5678<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5679
5680<h5>channel</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5681<p>the image channel(s).</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5682
5683<h5>radius</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5684<p>the radius of the Gaussian, in pixels, not counting the center pixel.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5685
5686<h5>sigma</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5687<p>the standard deviation of the Gaussian, in pixels.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5688
5689 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5690<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
5691_8c.html" id="MagickShaveImage">MagickShaveImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5692<div class="doc-section">
5693
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5694<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]5695
5696<p>The format of the MagickShaveImage method is:</p>
5697
5698<pre class="code">
5699 MagickBooleanType MagickShaveImage(MagickWand *wand,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]5700 const size_t columns,const size_t rows)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5701</pre>
5702
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5703<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5704
5705<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5706<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5707
5708<h5>columns</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5709<p>the number of columns in the scaled image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5710
5711<h5>rows</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5712<p>the number of rows in the scaled image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5713
5714
5715 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5716<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
5717_8c.html" id="MagickShearImage">MagickShearImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5718<div class="doc-section">
5719
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5720<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]5721
5722<p>The format of the MagickShearImage method is:</p>
5723
5724<pre class="code">
5725 MagickBooleanType MagickShearImage(MagickWand *wand,
5726 const PixelWand *background,const double x_shear,onst double y_shear)
5727</pre>
5728
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5729<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5730
5731<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5732<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5733
5734<h5>background</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5735<p>the background pixel wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5736
5737<h5>x_shear</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5738<p>the number of degrees to shear the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5739
5740<h5>y_shear</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5741<p>the number of degrees to shear the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5742
5743 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5744<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
5745_8c.html" id="MagickSigmoidalContrastImage">MagickSigmoidalContrastImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5746<div class="doc-section">
5747
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5748<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]5749
5750<p>The format of the MagickSigmoidalContrastImage method is:</p>
5751
5752<pre class="code">
5753 MagickBooleanType MagickSigmoidalContrastImage(MagickWand *wand,
5754 const MagickBooleanType sharpen,const double alpha,const double beta)
5755 MagickBooleanType MagickSigmoidalContrastImageChannel(MagickWand *wand,
5756 const ChannelType channel,const MagickBooleanType sharpen,
5757 const double alpha,const double beta)
5758</pre>
5759
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5760<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5761
5762<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5763<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5764
5765<h5>channel</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5766<p>Identify which channel to level: RedChannel, GreenChannel,</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5767
5768<h5>sharpen</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5769<p>Increase or decrease image contrast.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5770
5771<h5>alpha</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5772<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]5773
5774<h5>beta</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5775<p>midpoint of the function as a color value 0 to QuantumRange.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5776
5777 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5778<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
5779_8c.html" id="MagickSimilarityImage">MagickSimilarityImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5780<div class="doc-section">
5781
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5782<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]5783
5784<p>The format of the MagickSimilarityImage method is:</p>
5785
5786<pre class="code">
5787 MagickWand *MagickSimilarityImage(MagickWand *wand,
5788 const MagickWand *reference,RectangeInfo *offset,double *similarity)
5789</pre>
5790
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5791<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5792
5793<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5794<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5795
5796<h5>reference</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5797<p>the reference wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5798
5799<h5>offset</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5800<p>the best match offset of the reference image within the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5801
5802<h5>similarity</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5803<p>the computed similarity between the images.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5804
5805 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5806<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
5807_8c.html" id="MagickSketchImage">MagickSketchImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5808<div class="doc-section">
5809
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5810<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]5811
5812<p>The format of the MagickSketchImage method is:</p>
5813
5814<pre class="code">
5815 MagickBooleanType MagickSketchImage(MagickWand *wand,
5816 const double radius,const double sigma,const double angle)
5817</pre>
5818
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5819<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5820
5821<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5822<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5823
5824<h5>radius</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5825<p>the radius of the Gaussian, in pixels, not counting the center pixel.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5826
5827<h5>sigma</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5828<p>the standard deviation of the Gaussian, in pixels.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5829
5830<h5>angle</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5831<p>Apply the effect along this angle.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5832
5833 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5834<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
5835_8c.html" id="MagickSolarizeImage">MagickSolarizeImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5836<div class="doc-section">
5837
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5838<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]5839
5840<p>The format of the MagickSolarizeImage method is:</p>
5841
5842<pre class="code">
5843 MagickBooleanType MagickSolarizeImage(MagickWand *wand,
5844 const double threshold)
5845</pre>
5846
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5847<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5848
5849<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5850<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5851
5852<h5>threshold</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5853<p>Define the extent of the solarization.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5854
5855 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5856<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
5857_8c.html" id="MagickSparseColorImage">MagickSparseColorImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5858<div class="doc-section">
5859
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5860<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]5861
5862<p>The format of the MagickSparseColorImage method is:</p>
5863
5864<pre class="code">
5865 MagickBooleanType MagickSparseColorImage(MagickWand *wand,
5866 const ChannelType channel,const SparseColorMethod method,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]5867 const size_t number_arguments,const double *arguments)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5868</pre>
5869
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5870<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5871
5872<h5>image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5873<p>the image to be sparseed.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5874
5875<h5>method</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5876<p>the method of image sparseion.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5877
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5878<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]5879
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5880<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]5881
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5882<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]5883
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5884<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]5885
5886<h5>number_arguments</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5887<p>the number of arguments given for this sparseion method.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5888
5889<h5>arguments</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5890<p>the arguments for this sparseion method.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5891
5892 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5893<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
5894_8c.html" id="MagickSpliceImage">MagickSpliceImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5895<div class="doc-section">
5896
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5897<p>MagickSpliceImage() splices a solid color into the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5898
5899<p>The format of the MagickSpliceImage method is:</p>
5900
5901<pre class="code">
5902 MagickBooleanType MagickSpliceImage(MagickWand *wand,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]5903 const size_t width,const size_t height,const ssize_t x,
5904 const ssize_t y)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5905</pre>
5906
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5907<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5908
5909<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5910<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5911
5912<h5>width</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5913<p>the region width.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5914
5915<h5>height</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5916<p>the region height.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5917
5918<h5>x</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5919<p>the region x offset.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5920
5921<h5>y</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5922<p>the region y offset.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5923
5924 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5925<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
5926_8c.html" id="MagickSpreadImage">MagickSpreadImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5927<div class="doc-section">
5928
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5929<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]5930
5931<p>The format of the MagickSpreadImage method is:</p>
5932
5933<pre class="code">
5934 MagickBooleanType MagickSpreadImage(MagickWand *wand,const double radius)
5935</pre>
5936
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5937<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5938
5939<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5940<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5941
5942<h5>radius</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5943<p>Choose a random pixel in a neighborhood of this extent.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5944
5945 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5946<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
5947_8c.html" id="MagickSteganoImage">MagickSteganoImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5948<div class="doc-section">
5949
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5950<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]5951
5952<p>The format of the MagickSteganoImage method is:</p>
5953
5954<pre class="code">
5955 MagickWand *MagickSteganoImage(MagickWand *wand,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]5956 const MagickWand *watermark_wand,const ssize_t offset)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5957</pre>
5958
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5959<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5960
5961<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5962<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5963
5964<h5>watermark_wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5965<p>the watermark wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5966
5967<h5>offset</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5968<p>Start hiding at this offset into the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5969
5970 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5971<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
5972_8c.html" id="MagickStereoImage">MagickStereoImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5973<div class="doc-section">
5974
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5975<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]5976
5977<p>The format of the MagickStereoImage method is:</p>
5978
5979<pre class="code">
5980 MagickWand *MagickStereoImage(MagickWand *wand,
5981 const MagickWand *offset_wand)
5982</pre>
5983
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5984<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5985
5986<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5987<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5988
5989<h5>offset_wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5990<p>Another image wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5991
5992 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5993<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
5994_8c.html" id="MagickStripImage">MagickStripImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5995<div class="doc-section">
5996
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]5997<p>MagickStripImage() strips an image of all profiles and comments.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]5998
5999<p>The format of the MagickStripImage method is:</p>
6000
6001<pre class="code">
6002 MagickBooleanType MagickStripImage(MagickWand *wand)
6003</pre>
6004
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6005<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6006
6007<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6008<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6009
6010 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6011<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
6012_8c.html" id="MagickSwirlImage">MagickSwirlImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6013<div class="doc-section">
6014
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6015<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]6016
6017<p>The format of the MagickSwirlImage method is:</p>
6018
6019<pre class="code">
6020 MagickBooleanType MagickSwirlImage(MagickWand *wand,const double degrees)
6021</pre>
6022
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6023<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6024
6025<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6026<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6027
6028<h5>degrees</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6029<p>Define the tightness of the swirling effect.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6030
6031 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6032<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
6033_8c.html" id="MagickTextureImage">MagickTextureImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6034<div class="doc-section">
6035
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6036<p>MagickTextureImage() repeatedly tiles the texture image across and down the image canvas.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6037
6038<p>The format of the MagickTextureImage method is:</p>
6039
6040<pre class="code">
6041 MagickWand *MagickTextureImage(MagickWand *wand,
6042 const MagickWand *texture_wand)
6043</pre>
6044
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6045<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6046
6047<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6048<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6049
6050<h5>texture_wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6051<p>the texture wand</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6052
6053 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6054<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
6055_8c.html" id="MagickThresholdImage">MagickThresholdImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6056<div class="doc-section">
6057
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6058<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]6059
6060<p>The format of the MagickThresholdImage method is:</p>
6061
6062<pre class="code">
6063 MagickBooleanType MagickThresholdImage(MagickWand *wand,
6064 const double threshold)
6065 MagickBooleanType MagickThresholdImageChannel(MagickWand *wand,
6066 const ChannelType channel,const double threshold)
6067</pre>
6068
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6069<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6070
6071<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6072<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6073
6074<h5>channel</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6075<p>the image channel(s).</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6076
6077<h5>threshold</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6078<p>Define the threshold value.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6079
6080 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6081<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
6082_8c.html" id="MagickThumbnailImage">MagickThumbnailImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6083<div class="doc-section">
6084
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6085<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]6086
6087<p>The format of the MagickThumbnailImage method is:</p>
6088
6089<pre class="code">
6090 MagickBooleanType MagickThumbnailImage(MagickWand *wand,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]6091 const size_t columns,const size_t rows)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6092</pre>
6093
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6094<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6095
6096<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6097<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6098
6099<h5>columns</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6100<p>the number of columns in the scaled image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6101
6102<h5>rows</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6103<p>the number of rows in the scaled image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6104
6105 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6106<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
6107_8c.html" id="MagickTintImage">MagickTintImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6108<div class="doc-section">
6109
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6110<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]6111
6112<p>The format of the MagickTintImage method is:</p>
6113
6114<pre class="code">
6115 MagickBooleanType MagickTintImage(MagickWand *wand,
6116 const PixelWand *tint,const PixelWand *opacity)
6117</pre>
6118
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6119<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6120
6121<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6122<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6123
6124<h5>tint</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6125<p>the tint pixel wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6126
6127<h5>opacity</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6128<p>the opacity pixel wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6129
6130 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6131<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
6132_8c.html" id="MagickTransformImage">MagickTransformImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6133<div class="doc-section">
6134
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6135<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]6136
6137<p>The format of the MagickTransformImage method is:</p>
6138
6139<pre class="code">
6140 MagickWand *MagickTransformImage(MagickWand *wand,const char *crop,
6141 const char *geometry)
6142</pre>
6143
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6144<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6145
6146<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6147<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6148
6149<h5>crop</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6150<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]6151
6152<h5>geometry</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6153<p>An image geometry string. This geometry defines the final size of the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6154
6155 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6156<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
6157_8c.html" id="MagickTransformImageColorspace">MagickTransformImageColorspace</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6158<div class="doc-section">
6159
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6160<p>MagickTransformImageColorspace() transform the image colorspace.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6161
6162<p>The format of the MagickTransformImageColorspace method is:</p>
6163
6164<pre class="code">
6165 MagickBooleanType MagickTransformImageColorspace(MagickWand *wand,
6166 const ColorspaceType colorspace)
6167</pre>
6168
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6169<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6170
6171<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6172<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6173
6174<h5>colorspace</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6175<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]6176
6177 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6178<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
6179_8c.html" id="MagickTransparentPaintImage">MagickTransparentPaintImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6180<div class="doc-section">
6181
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6182<p>MagickTransparentPaintImage() changes any pixel that matches color with the color defined by fill.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6183
6184<p>The format of the MagickTransparentPaintImage method is:</p>
6185
6186<pre class="code">
6187 MagickBooleanType MagickTransparentPaintImage(MagickWand *wand,
6188 const PixelWand *target,const double alpha,const double fuzz,
6189 const MagickBooleanType invert)
6190</pre>
6191
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6192<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6193
6194<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6195<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6196
6197<h5>target</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6198<p>Change this target color to specified opacity value within the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6199
6200<h5>alpha</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6201<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]6202
6203<h5>fuzz</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6204<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]6205
6206<h5>invert</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6207<p>paint any pixel that does not match the target color.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6208
6209 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6210<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
6211_8c.html" id="MagickTransposeImage">MagickTransposeImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6212<div class="doc-section">
6213
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6214<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]6215
6216<p>The format of the MagickTransposeImage method is:</p>
6217
6218<pre class="code">
6219 MagickBooleanType MagickTransposeImage(MagickWand *wand)
6220</pre>
6221
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6222<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6223
6224<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6225<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6226
6227 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6228<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
6229_8c.html" id="MagickTransverseImage">MagickTransverseImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6230<div class="doc-section">
6231
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6232<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]6233
6234<p>The format of the MagickTransverseImage method is:</p>
6235
6236<pre class="code">
6237 MagickBooleanType MagickTransverseImage(MagickWand *wand)
6238</pre>
6239
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6240<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6241
6242<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6243<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6244
6245 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6246<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
6247_8c.html" id="MagickTrimImage">MagickTrimImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6248<div class="doc-section">
6249
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6250<p>MagickTrimImage() remove edges that are the background color from the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6251
6252<p>The format of the MagickTrimImage method is:</p>
6253
6254<pre class="code">
6255 MagickBooleanType MagickTrimImage(MagickWand *wand,const double fuzz)
6256</pre>
6257
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6258<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6259
6260<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6261<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6262
6263<h5>fuzz</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6264<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]6265
6266 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6267<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
6268_8c.html" id="MagickUniqueImageColors">MagickUniqueImageColors</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6269<div class="doc-section">
6270
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6271<p>MagickUniqueImageColors() discards all but one of any pixel color.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6272
6273<p>The format of the MagickUniqueImageColors method is:</p>
6274
6275<pre class="code">
6276 MagickBooleanType MagickUniqueImageColors(MagickWand *wand)
6277</pre>
6278
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6279<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6280
6281<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6282<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6283
6284 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6285<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
6286_8c.html" id="MagickUnsharpMaskImage">MagickUnsharpMaskImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6287<div class="doc-section">
6288
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6289<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]6290
6291<p>The format of the MagickUnsharpMaskImage method is:</p>
6292
6293<pre class="code">
6294 MagickBooleanType MagickUnsharpMaskImage(MagickWand *wand,
6295 const double radius,const double sigma,const double amount,
6296 const double threshold)
6297 MagickBooleanType MagickUnsharpMaskImageChannel(MagickWand *wand,
6298 const ChannelType channel,const double radius,const double sigma,
6299 const double amount,const double threshold)
6300</pre>
6301
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6302<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6303
6304<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6305<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6306
6307<h5>channel</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6308<p>the image channel(s).</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6309
6310<h5>radius</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6311<p>the radius of the Gaussian, in pixels, not counting the center pixel.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6312
6313<h5>sigma</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6314<p>the standard deviation of the Gaussian, in pixels.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6315
6316<h5>amount</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6317<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]6318
6319<h5>threshold</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6320<p>the threshold in pixels needed to apply the diffence amount.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6321
6322 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6323<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
6324_8c.html" id="MagickVignetteImage">MagickVignetteImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6325<div class="doc-section">
6326
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6327<p>MagickVignetteImage() softens the edges of the image in vignette style.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6328
6329<p>The format of the MagickVignetteImage method is:</p>
6330
6331<pre class="code">
6332 MagickBooleanType MagickVignetteImage(MagickWand *wand,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]6333 const double black_point,const double white_point,const ssize_t x,
6334 const ssize_t y)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6335</pre>
6336
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6337<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6338
6339<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6340<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6341
6342<h5>black_point</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6343<p>the black point.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6344
6345<h5>white_point</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6346<p>the white point.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6347
6348<h5>x, y</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6349<p>Define the x and y ellipse offset.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6350
6351 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6352<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
6353_8c.html" id="MagickWaveImage">MagickWaveImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6354<div class="doc-section">
6355
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6356<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]6357
6358<p>The format of the MagickWaveImage method is:</p>
6359
6360<pre class="code">
6361 MagickBooleanType MagickWaveImage(MagickWand *wand,const double amplitude,
6362 const double wave_length)
6363</pre>
6364
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6365<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6366
6367<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6368<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6369
6370<h5>amplitude, wave_length</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6371<p>Define the amplitude and wave length of the sine wave.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6372
6373 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6374<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
6375_8c.html" id="MagickWhiteThresholdImage">MagickWhiteThresholdImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6376<div class="doc-section">
6377
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6378<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]6379
6380<p>The format of the MagickWhiteThresholdImage method is:</p>
6381
6382<pre class="code">
6383 MagickBooleanType MagickWhiteThresholdImage(MagickWand *wand,
6384 const PixelWand *threshold)
6385</pre>
6386
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6387<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6388
6389<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6390<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6391
6392<h5>threshold</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6393<p>the pixel wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6394
6395 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6396<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
6397_8c.html" id="MagickWriteImage">MagickWriteImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6398<div class="doc-section">
6399
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6400<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]6401
6402<p>The format of the MagickWriteImage method is:</p>
6403
6404<pre class="code">
6405 MagickBooleanType MagickWriteImage(MagickWand *wand,
6406 const char *filename)
6407</pre>
6408
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6409<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6410
6411<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6412<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6413
6414<h5>filename</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6415<p>the image filename.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6416
6417
6418 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6419<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
6420_8c.html" id="MagickWriteImageFile">MagickWriteImageFile</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6421<div class="doc-section">
6422
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6423<p>MagickWriteImageFile() writes an image to an open file descriptor.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6424
6425<p>The format of the MagickWriteImageFile method is:</p>
6426
6427<pre class="code">
6428 MagickBooleanType MagickWriteImageFile(MagickWand *wand,FILE *file)
6429</pre>
6430
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6431<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6432
6433<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6434<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6435
6436<h5>file</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6437<p>the file descriptor.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6438
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6439 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6440<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
6441_8c.html" id="MagickWriteImages">MagickWriteImages</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6442<div class="doc-section">
6443
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6444<p>MagickWriteImages() writes an image or image sequence.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6445
6446<p>The format of the MagickWriteImages method is:</p>
6447
6448<pre class="code">
6449 MagickBooleanType MagickWriteImages(MagickWand *wand,
6450 const char *filename,const MagickBooleanType adjoin)
6451</pre>
6452
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6453<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6454
6455<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6456<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6457
6458<h5>filename</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6459<p>the image filename.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6460
6461<h5>adjoin</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6462<p>join images into a single multi-image file.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6463
6464 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6465<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-image
6466_8c.html" id="MagickWriteImagesFile">MagickWriteImagesFile</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6467<div class="doc-section">
6468
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6469<p>MagickWriteImagesFile() writes an image sequence to an open file descriptor.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6470
6471<p>The format of the MagickWriteImagesFile method is:</p>
6472
6473<pre class="code">
6474 MagickBooleanType MagickWriteImagesFile(MagickWand *wand,FILE *file)
6475</pre>
6476
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6477<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6478
6479<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6480<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6481
6482<h5>file</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]6483<p>the file descriptor.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]6484
6485 </div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]6486
6487</div>
6488
6489<div id="linkbar">
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]6490 <span id="linkbar-west">&nbsp;</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]6491 <span id="linkbar-center">
6492 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
cristya8902942010-07-30 00:49:52 +0000[diff] [blame]6493 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]6494 </span>
6495 <span id="linkbar-east">&nbsp;</span>
6496 </div>
6497 <div class="footer">
cristy4103d562010-12-10 01:38:54 +0000[diff] [blame]6498 <span id="footer-west">&copy; 1999-2011 ImageMagick Studio LLC</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]6499 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
6500 </div>
6501 <div style="clear: both; margin: 0; width: 100%; "></div>
cristya8902942010-07-30 00:49:52 +0000[diff] [blame]6502 <script type="text/javascript">
6503 var _gaq = _gaq || [];
6504 _gaq.push(['_setAccount', 'UA-17690367-1']);
6505 _gaq.push(['_trackPageview']);
6506
6507 (function() {
6508 var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
6509 ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
6510 var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
6511 })();
6512 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]6513</body>
6514</html>