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