2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
\r
3 "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
\r
4 <html version="-//W3C//DTD XHTML 1.1//EN"
\r
5 xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"
\r
6 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
\r
7 xsi:schemaLocation="http://www.w3.org/1999/xhtml
\r
8 http://www.w3.org/MarkUp/SCHEMA/xhtml11.xsd">
\r
10 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
\r
11 <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U="/>
\r
12 <title>ImageMagick: MagickWand, C API for ImageMagick</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="Application-name" content="ImageMagick"/>
17 <meta name="Description" content="Use ImageMagick to convert, edit, or compose bitmap images in a variety of formats. In addition resize, rotate, shear, distort and transform images automagically."/>
18 <meta name="Application-url" content="http://www.imagemagick.org"/>
19 <meta name="Generator" content="PHP"/>
20 <meta name="Keywords" content="magickwc, api, for, imagemagick, ImageMagick, ImageMagic, MagickCore, MagickWand, PerlMagick, Magick++, RMagick, PythonMagick, JMagick, TclMagick, Image, Magick, Magic, Wand, ImageMagickObject, Image, Processing, Automagically"/>
21 <meta name="Rating" content="GENERAL"/>
22 <meta name="Robots" content="INDEX, FOLLOW"/>
23 <meta name="Generator" content="ImageMagick Studio LLC"/>
24 <meta name="Author" content="ImageMagick Studio LLC"/>
25 <meta name="Revisit-after" content="2 DAYS"/>
26 <meta name="Resource-type" content="document"/>
27 <meta name="Copyright" content="Copyright (c) 1999-2011 ImageMagick Studio LLC"/>
28 <meta name="Distribution" content="Global"/>
29 <link rel="icon" href="../images/wand.png"/>
30 <link rel="shortcut icon" href="../images/wand.ico" type="images/x-icon"/>
31 <link rel="canonical" href="http://www.imagemagick.org" />
\r
32 <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf"/>
\r
33 <link rel="stylesheet" href="http://www.google.com/cse/style/look/default.css" type="text/css" />
\r
34 <link rel="stylesheet" type="text/css" href="../fancybox/jquery.fancybox-1.3.4.css" media="screen" />
\r
35 <style type="text/css" media="all">
\r
36 @import url("../www/magick.css");
\r
38 <script type="text/javascript" src="https://apis.google.com/js/plusone.js"></script>
\r
39 <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.4/jquery.min.js"></script>
\r
40 <script type="text/javascript" src="../fancybox/jquery.fancybox-1.3.4.pack.js"></script>
\r
41 <script type="text/javascript">
\r
42 $(document).ready(function() {
\r
43 $("a[href$=.jpg],a[href$=.png],a[href$=.gif]").fancybox({
\r
44 'transitionIn' : 'elastic',
\r
45 'transitionOut' : 'elastic',
\r
46 'overlayShow' : false,
\r
53 <body id="www-imagemagick-org">
\r
54 <div class="titlebar">
\r
55 <div style="margin: 17px auto; float: left;">
\r
56 <script type="text/javascript">
\r
58 google_ad_client = "pub-3129977114552745";
\r
59 google_ad_slot = "5439289906";
\r
60 google_ad_width = 728;
\r
61 google_ad_height = 90;
\r
64 <script type="text/javascript"
\r
65 src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
\r
68 <a href="http://www.imagemagick.org/discourse-server/">
\r
69 <img src="../images/logo.jpg"
\r
70 alt="ImageMagick Logo"
\r
71 style="width: 123px; height: 118px; border: 0px; float: right;" /></a>
\r
72 <a href="../index.html">
\r
73 <img src="../images/sprite.jpg"
\r
74 alt="ImageMagick Sprite"
\r
75 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
\r
78 <div class="westbar">
\r
81 <a title="About ImageMagick" href="../index.html">About ImageMagick</a>
84 <a title="Binary Releases" href="../www/binary-releases.html">Binary Releases</a>
87 <a title="Binary Release: Unix" href="../www/binary-releases.html#unix">Unix</a>
90 <a title="Binary Release: MacOS X" href="../www/binary-releases.html#macosx">Mac OS X</a>
93 <a title="Binary Release: iOS" href="../www/binary-releases.html#iOS">iOS</a>
96 <a title="Binary Release: Windows" href="../www/binary-releases.html#windows">Windows</a>
98 <div class="sep"></div>
\r
100 <a title="Command-line Tools" href="../www/command-line-tools.html">Command-line Tools</a>
103 <a title="Command-line Tools: Processing" href="../www/command-line-processing.html">Processing</a>
106 <a title="Command-line Tools: Options" href="../www/command-line-options.html">Options</a>
109 <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
112 <a title="Program Interfaces" href="../www/api.html">Program Interfaces</a>
115 <a title="Program Interface: MagickWand" href="../www/magick-wand.html">MagickWand</a>
118 <a title="Program Interface: MagickCore" href="../www/magick-core.html">MagickCore</a>
121 <a title="Program Interface: PerlMagick" href="../www/perl-magick.html">PerlMagick</a>
124 <a title="Program Interface: Magick++" href="../www/magick++.html">Magick++</a>
126 <div class="sep"></div>
\r
128 <a title="Install from Source" href="../www/install-source.html">Install from Source</a>
131 <a title="Install from Source: Unix" href="../www/install-source.html#unix">Unix</a>
134 <a title="Install from Source: Windows" href="../www/install-source.html#windows">Windows</a>
137 <a title="Resources" href="../www/resources.html">Resources</a>
140 <a title="Architecture" href="../www/architecture.html">Architecture</a>
143 <a title="Download" href="../www/download.html">Download</a>
145 <div class="sep"></div>
\r
147 <a title="Search" href="../www/search.html">Search</a>
149 <div class="sep"></div>
\r
151 <a title="Site Map" href="../www/sitemap.html">Site Map</a>
154 <a title="Site Map: Links" href="../www/links.html">Links</a>
156 <div class="sep"></div>
\r
158 <a rel="follow" title="Sponsors" href="../www/sponsors.html">Sponsors:</a>
160 <a href="http://www.networkredux.com">
161 <img src="../images/networkredux.png" alt="[sponsor]"
162 style="margin-top: 4px; margin-left: 4px; border: 0px; float: left;" /></a>
163 <div class="sponsbox">
164 <div class="sponsor">
165 <a rel="follow" title="Sponsor: Web Hosting" href="http://www.micfo.com">Web Hosting</a><!-- 209901010090s golestan -->
167 <div class="sponsor">
168 <a rel="follow" title="Sponsor: Search engine optimisation" href="http://www.seomoves.com.au">Search engine optimisation</a><!-- 201110010090s jen@seo lowprofilelinks -->
170 <div class="sponsor">
171 <a rel="follow" title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 -->
173 <div class="sponsor">
174 <a rel="follow" title="Sponsor: Web Hosting Deals" href="http://www.webhostingdeals.org">Web Hosting Deals</a><!-- 201111010270 chee.hoa darin -->
176 <div class="sponsor">
177 <a rel="follow" title="Sponsor: Web Hosting Reviews" href="http://www.webhostingsecretrevealed.com">Web Hosting Secret Revealed</a><!-- 201204010540 iamchee jerry -->
179 <div class="sponsor">
180 <a rel="follow" title="Sponsor: Web Hosting Break" href="http://www.webhostingbreak.com">Web Hosting Break</a><!-- 201109010090 ian@ian-m... -->
182 <div class="sponsor">
183 <a rel="follow" title="Sponsor: Druckerei" href="http://www.allesdruck.de">Druckerei</a><!-- 201303011500 r.leo -->
185 <div class="sponsor">
186 <a rel="follow" title="Sponsor: Website Hosting" href="http://www.hostreviewgeeks.com">Website Hosting</a><!-- 201110010090 alexanian media -->
188 <div class="sponsor">
189 <a rel="follow" title="Sponsor: Hotel München" href="http://www.messehotel-erb-muenchen.de">Hotel München</a><!-- 201111010450 cerb -->
191 <div class="sponsor">
192 <a rel="follow" title="Sponsor: Best Web Hosting" href="http://webhostinggeeks.com">Best Web Hosting</a><!-- 201110010720 -->
194 <div class="sponsor">
195 <a rel="follow" title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
197 <div class="sponsor">
198 <a rel="follow" title="Sponsor: Web Hosting Ratings" href="http://webhostingrating.com">Web Hosting Ratings</a><!-- 201110010720 -->
200 <div class="sponsor">
201 <a rel="follow" title="Sponsor: Free Catalogs" href="http://www.who-sells-it.com/">Free Catalogs</a><!-- 20120801000600 -->
207 <div class="eastbar">
\r
208 <div style="margin: 9pt 9pt 9pt 9pt;">
\r
209 <div class="g-plusone" data-size="standard" data-count="false"></div>
\r
215 <h1>MagickWand C API</h1>
217 <div class="doc-section">
218 <p>The <a href="../www/api/MagickWand/index.html">MagickWand API</a> is the recommended interface between the C programming language and the ImageMagick image processing libraries. Unlike the <a href="../www/magick-core.html">MagickCore</a> C API, MagickWand uses only a few opaque types. Accessors are available to set or get important wand properties. A description of the MagickWand public methods are found here:</p>
221 <li><a href="../www/api/magick-wand.html">Magick Wand Methods</a></li>
222 <li><a href="../www/api/magick-property.html">Set or Get Magick Wand Properties</a></li>
223 <li><a href="../www/api/magick-image.html">Magick Wand Image Methods</a></li>
224 <li><a href="../www/api/pixel-iterator.html">Pixel Iterator Methods</a></li>
225 <li><a href="../www/api/pixel-wand.html">Pixel Wand Methods</a></li>
226 <li><a href="../www/api/drawing-wand.html">Image Vector Drawing</a></li>
227 <li><a href="../www/api/mogrify.html">Command-line Interface</a></li>
228 <li><a href="../www/api/wand-view.html">Wand View Methods</a></li>
229 <li><a href="../www/api/magick-deprecate.html">Deprecated Methods</a></li>
230 <li><a href="../www/exception.html">Error and Warning Codes</a></li>
233 <p>After you write your MagickWand program, compile it like this:</p>
235 <p class='crt'><span class="crtprompt"> $magick> </span><span class='crtin'>cc `MagickWand-config --cflags --cppflags` -O2 -o wand wand.c \ <br/> `MagickWand-config --ldflags --libs`</span></p>
236 <p>Here is a example program that utilizes the MagickWand API to get you started, <a href="../www/source/wand.c">wand.c</a>. It reads an image, creates a thumbnail, and writes the result to disk.</p>
238 <div class="viewport">
239 #include <stdio.h>
240 #include <stdlib.h>
241 #include <wand/MagickWand.h>
243 int main(int argc,char **argv)
245 #define ThrowWandException(wand) \
253 description=MagickGetException(wand,&severity); \
254 (void) fprintf(stderr,"%s %s %lu %s\n",GetMagickModule(),description); \
255 description=(char *) MagickRelinquishMemory(description); \
267 (void) fprintf(stdout,"Usage: %s image thumbnail\n",argv[0]);
274 magick_wand=NewMagickWand();
275 status=MagickReadImage(magick_wand,argv[1]);
276 if (status == MagickFalse)
277 ThrowWandException(magick_wand);
279 Turn the images into a thumbnail sequence.
281 MagickResetIterator(magick_wand);
282 while (MagickNextImage(magick_wand) != MagickFalse)
283 MagickResizeImage(magick_wand,106,80,LanczosFilter,1.0);
285 Write the image then destroy it.
287 status=MagickWriteImages(magick_wand,argv[2],MagickTrue);
288 if (status == MagickFalse)
289 ThrowWandException(magick_wand);
290 magick_wand=DestroyMagickWand(magick_wand);
291 MagickWandTerminus();
296 <p>Here is another program that shows one way to get and set image pixels with the MagickWand API, <a href="../www/source/contrast.c">contrast.c</a>. It reads an image, applies sigmoidal non-linearity contrast control, and writes the result to disk.</p>
298 <div class="viewport">
299 #include <stdio.h>
300 #include <stdlib.h>
302 #include <wand/MagickWand.h>
304 int main(int argc,char **argv)
306 #define QuantumScale ((MagickRealType) 1.0/(MagickRealType) QuantumRange)
307 #define SigmoidalContrast(x) \
308 (QuantumRange*(1.0/(1+exp(10.0*(0.5-QuantumScale*x)))-0.0066928509)*1.0092503)
309 #define ThrowWandException(wand) \
317 description=MagickGetException(wand,&severity); \
318 (void) fprintf(stderr,"%s %s %lu %s\n",GetMagickModule(),description); \
319 description=(char *) MagickRelinquishMemory(description); \
352 (void) fprintf(stdout,"Usage: %s image sigmoidal-image\n",argv[0]);
359 image_wand=NewMagickWand();
360 status=MagickReadImage(image_wand,argv[1]);
361 if (status == MagickFalse)
362 ThrowWandException(image_wand);
363 contrast_wand=CloneMagickWand(image_wand);
365 Sigmoidal non-linearity contrast control.
367 iterator=NewPixelIterator(image_wand);
368 contrast_iterator=NewPixelIterator(contrast_wand);
369 if ((iterator == (PixelIterator *) NULL) ||
370 (contrast_iterator == (PixelIterator *) NULL))
371 ThrowWandException(image_wand);
372 for (y=0; y < (long) MagickGetImageHeight(image_wand); y++)
374 pixels=PixelGetNextIteratorRow(iterator,&width);
375 contrast_pixels=PixelGetNextIteratorRow(contrast_iterator,&width);
376 if ((pixels == (PixelWand **) NULL) ||
377 (contrast_pixels == (PixelWand **) NULL))
379 for (x=0; x < (long) width; x++)
381 PixelGetMagickColor(pixels[x],&pixel);
382 pixel.red=SigmoidalContrast(pixel.red);
383 pixel.green=SigmoidalContrast(pixel.green);
384 pixel.blue=SigmoidalContrast(pixel.blue);
385 pixel.index=SigmoidalContrast(pixel.index);
386 PixelSetMagickColor(contrast_pixels[x],&pixel);
388 (void) PixelSyncIterator(contrast_iterator);
390 if (y < (long) MagickGetImageHeight(image_wand))
391 ThrowWandException(image_wand);
392 contrast_iterator=DestroyPixelIterator(contrast_iterator);
393 iterator=DestroyPixelIterator(iterator);
394 image_wand=DestroyMagickWand(image_wand);
396 Write the image then destroy it.
398 status=MagickWriteImages(contrast_wand,argv[2],MagickTrue);
399 if (status == MagickFalse)
400 ThrowWandException(image_wand);
401 contrast_wand=DestroyMagickWand(contrast_wand);
402 MagickWandTerminus();
406 <p><a id="wand-view"></a>Now lets perform the same contrast enhancement while taking advantage of our dual or quad-core processing system by running the algorithm in parallel utilizing wand views. The <a href="../www/source/wand/sigmoidal-contrast.c">sigmoidal-contrast.c</a> module reads an image, applies sigmoidal non-linearity contrast control, and writes the result to disk just like the previous contrast enhancement program, but now it does its work in parallel (assumes ImageMagick is built with OpenMP support).</p>
408 <div class="viewport">
409 #include <stdio.h>
410 #include <stdlib.h>
412 #include <wand/MagickWand.h>
414 static MagickBooleanType SigmoidalContrast(WandView *pixel_view,
415 const ssize_t y,const int id,void *context)
417 #define QuantumScale ((MagickRealType) 1.0/(MagickRealType) QuantumRange)
418 #define SigmoidalContrast(x) \
419 (QuantumRange*(1.0/(1+exp(10.0*(0.5-QuantumScale*x)))-0.0066928509)*1.0092503)
433 extent=GetWandViewExtent(contrast_view);
434 pixels=GetWandViewPixels(contrast_view);
435 for (x=0; x < (long) (extent.width-extent.height); x++)
437 PixelGetMagickColor(pixels[x],&pixel);
438 pixel.red=SigmoidalContrast(pixel.red);
439 pixel.green=SigmoidalContrast(pixel.green);
440 pixel.blue=SigmoidalContrast(pixel.blue);
441 pixel.index=SigmoidalContrast(pixel.index);
442 PixelSetMagickColor(contrast_pixels[x],&pixel);
447 int main(int argc,char **argv)
449 #define ThrowViewException(view) \
451 description=GetWandViewException(view,&severity); \
452 (void) fprintf(stderr,"%s %s %lu %s\n",GetMagickModule(),description); \
453 description=(char *) MagickRelinquishMemory(description); \
456 #define ThrowWandException(wand) \
458 description=MagickGetException(wand,&severity); \
459 (void) fprintf(stderr,"%s %s %lu %s\n",GetMagickModule(),description); \
460 description=(char *) MagickRelinquishMemory(description); \
484 (void) fprintf(stdout,"Usage: %s image sigmoidal-image\n",argv[0]);
491 contrast_wand=NewMagickWand();
492 status=MagickReadImage(contrast_wand,argv[1]);
493 if (status == MagickFalse)
494 ThrowWandException(contrast_wand);
496 Sigmoidal non-linearity contrast control.
498 contrast_view=NewWandView(contrast_wand);
499 if (contrast_view == (WandView *) NULL)
500 ThrowWandException(contrast_wand);
501 status=UpdateWandViewIterator(contrast_view,SigmoidalContrast,(void *) NULL);
502 if (status == MagickFalse)
503 ThrowWandException(contrast_wand);
504 contrast_view=DestroyWandView(contrast_view);
506 Write the image then destroy it.
508 status=MagickWriteImages(contrast_wand,argv[2],MagickTrue);
509 if (status == MagickFalse)
510 ThrowWandException(contrast_wand);
511 contrast_wand=DestroyMagickWand(contrast_wand);
512 MagickWandTerminus();
521 <span id="linkbar-west"> </span>
\r
522 <span id="linkbar-center">
\r
523 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> •
\r
524 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
\r
526 <span id="linkbar-east"> </span>
\r
528 <div class="footer">
\r
529 <span id="footer-west">© 1999-2011 ImageMagick Studio LLC</span>
\r
530 <span id="footer-east"> <a href="http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
\r
532 <div style="clear: both; margin: 0; width: 100%; "></div>
\r
533 <script type="text/javascript">
\r
534 var _gaq = _gaq || [];
\r
535 _gaq.push(['_setAccount', 'UA-17690367-1']);
\r
536 _gaq.push(['_trackPageview']);
\r
539 var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
\r
540 ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
\r
541 var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
\r