2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
\r
3 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
\r
4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
\r
6 <meta http-equiv="Content-Type" value="application/xhtml+xml" />
\r
7 <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U=" />
\r
8 <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf" />
\r
9 <style type="text/css" media="screen,projection"><!--
\r
10 @import url("../www/magick.css");
\r
12 <link rel="shortcut icon" href="../images/wand.ico" type="images/vnd.microsoft.icon"/>
13 <title>ImageMagick: MagickWand, C API for ImageMagick</title>
14 <meta http-equiv="Content-Language" content="en-US"/>
15 <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
16 <meta http-equiv="Reply-to" content="magick-users@imagemagick.org"/>
17 <meta name="Generator" content="PHP"/>
18 <meta name="Keywords" content="magickwc, api, for, imagemagick, ImageMagick, ImageMagic, MagickCore, MagickWand, PerlMagick, Magick++, RMagick, PythonMagick, JMagick, TclMagick, Image, Magick, Magic, Wand, ImageMagickObject, Swiss, Army, Knife, Image, Processing"/>
19 <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."/>
20 <meta name="Rating" content="GENERAL"/>
21 <meta name="Robots" content="INDEX, FOLLOW"/>
22 <meta name="Generator" content="ImageMagick Studio LLC"/>
23 <meta name="Author" content="ImageMagick Studio LLC"/>
24 <meta name="Revisit-after" content="2 DAYS"/>
25 <meta name="Resource-type" content="document"/>
26 <meta name="Copyright" content="Copyright (c) 1999-2010 ImageMagick Studio LLC"/>
27 <meta name="Distribution" content="Global"/>
30 <body id="www-imagemagick-org">
\r
31 <div class="titlebar">
\r
32 <a href="../index.html">
\r
33 <img src="../images/script.png" alt="[ImageMagick]"
\r
34 style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>
\r
35 <a href="http://www.networkredux.com">
\r
36 <img src="../images/networkredux.png" alt="[sponsor]"
\r
37 style="margin: 45px auto; border: 0px; float: left;" /></a>
\r
38 <a href="http://www.imagemagick.org/discourse-server/">
\r
39 <img src="../images/logo.jpg" alt=""
\r
40 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
\r
41 <a href="../index.html">
\r
42 <img src="../images/sprite.jpg" alt=""
\r
43 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
\r
46 <div class="eastbar">
\r
49 <a href="../index.html">About ImageMagick</a>
51 <div class="sep"></div>
\r
53 <a href="../www/command-line-tools.html">Command-line Tools</a>
56 <a href="../www/command-line-processing.html">Processing</a>
59 <a href="../www/command-line-options.html">Options</a>
62 <a href="http://www.imagemagick.org/Usage/">Usage</a>
65 <a href="../www/api.html">Program Interfaces</a>
68 <a href="../www/magick-wand.html">MagickWand</a>
71 <a href="../www/magick-core.html">MagickCore</a>
74 <a href="../www/perl-magick.html">PerlMagick</a>
77 <a href="../Magick++/">Magick++</a>
80 <a href="../www/architecture.html">Architecture</a>
82 <div class="sep"></div>
\r
84 <a href="../www/install-source.html">Install from Source</a>
87 <a href="../www/install-source.html#unix">Unix</a>
90 <a href="../www/install-source.html#windows">Windows</a>
93 <a href="../www/binary-releases.html">Binary Releases</a>
96 <a href="../www/binary-releases.html#unix">Unix</a>
99 <a href="../www/binary-releases.html#macosx">Mac OS X</a>
102 <a href="../www/binary-releases.html#windows">Windows</a>
105 <a href="../www/resources.html">Resources</a>
107 <div class="sep"></div>
\r
109 <a href="../www/download.html">Download</a>
111 <div class="sep"></div>
\r
113 <a href="http://www.imagemagick.org/script/search.php">Search</a>
115 <div class="sep"></div>
\r
117 <a href="../www/sitemap.html">Site Map</a>
120 <a href="../www/links.html">Links</a>
122 <div class="sep"></div>
\r
124 <a href="../www/sponsors.html">Sponsors:</a>
126 <div class="sponsbox">
127 <div class="sponsor">
128 <a href="http://www.abi-stoff.de/abizeitung/" title="Abibuch">Abizeitung</a><!-- 20101101000200 -->
130 <div class="sponsor">
131 <a href="http://www.tomsgutscheine.de">Tom's Gutscheine</a><!-- 201005010360 invendio.de-->
133 <div class="sponsor">
134 <a href="http://www.online-kredit-index.de">Kredit</a><!-- 201007010120 Buchhorn -->
136 <div class="sponsor">
137 <a href="http://www.blumenversender.com">Blumenversand</a><!-- 201005010120 -->
139 <div class="sponsor">
140 <a href="http://www.print24.de/">Druckerei</a><!-- 201009010720 -->
142 <div class="sponsor">
143 <a href="http://www.goyax.de">Börse</a><!-- 201004010240 Gewiese digital-finance.de -->
145 <div class="sponsor">
146 <a href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012011200 allesdruck.de-->
156 <p class="navigation-index"></p>
158 <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>
161 <li><a href="../www/api/magick-wand.html">Magick Wand Methods</a></li>
162 <li><a href="../www/api/magick-property.html">Set or Get Magick Wand Properties</a></li>
163 <li><a href="../www/api/magick-image.html">Magick Wand Image Methods</a></li>
164 <li><a href="../www/api/pixel-iterator.html">Pixel Iterator Methods</a></li>
165 <li><a href="../www/api/pixel-view.html">Pixel View Methods</a></li>
166 <li><a href="../www/api/pixel-wand.html">Pixel Wand Methods</a></li>
167 <li><a href="../www/api/drawing-wand.html">Image Vector Drawing</a></li>
168 <li><a href="../www/api/magick-deprecate.html">Deprecated Methods</a></li>
169 <li><a href="../www/exception.html">Error and Warning Codes</a></li>
173 <p>After you write your MagickWand program, compile it like this:</p>
175 <p class='crt'><span class="crtprompt"> $magick> </span><span class='crtin'>cc `MagickWand-config --cflags --cppflags` -o wand wand.c `MagickWand-config --ldflags --libs`</span></p>
176 <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>
178 <div class="viewport">
180 #include <stdio.h>
181 #include <stdlib.h>
182 #include <wand/MagickWand.h>
184 int main(int argc,char **argv)
186 #define ThrowWandException(wand) \
194 description=MagickGetException(wand,&severity); \
195 (void) fprintf(stderr,"%s %s %lu %s\n",GetMagickModule(),description); \
196 description=(char *) MagickRelinquishMemory(description); \
208 (void) fprintf(stdout,"Usage: %s image thumbnail\n",argv[0]);
215 magick_wand=NewMagickWand();
216 status=MagickReadImage(magick_wand,argv[1]);
217 if (status == MagickFalse)
218 ThrowWandException(magick_wand);
220 Turn the images into a thumbnail sequence.
222 MagickResetIterator(magick_wand);
223 while (MagickNextImage(magick_wand) != MagickFalse)
224 MagickResizeImage(magick_wand,106,80,LanczosFilter,1.0);
226 Write the image then destroy it.
228 status=MagickWriteImages(magick_wand,argv[2],MagickTrue);
229 if (status == MagickFalse)
230 ThrowWandException(magick_wand);
231 magick_wand=DestroyMagickWand(magick_wand);
232 MagickWandTerminus();
238 <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>
240 <div class="viewport">
242 #include <stdio.h>
243 #include <stdlib.h>
245 #include <wand/MagickWand.h>
247 int main(int argc,char **argv)
249 #define QuantumScale ((MagickRealType) 1.0/(MagickRealType) QuantumRange)
250 #define SigmoidalContrast(x) \
251 (QuantumRange*(1.0/(1+exp(10.0*(0.5-QuantumScale*x)))-0.0066928509)*1.0092503)
252 #define ThrowWandException(wand) \
260 description=MagickGetException(wand,&severity); \
261 (void) fprintf(stderr,"%s %s %lu %s\n",GetMagickModule(),description); \
262 description=(char *) MagickRelinquishMemory(description); \
295 (void) fprintf(stdout,"Usage: %s image sigmoidal-image\n",argv[0]);
302 image_wand=NewMagickWand();
303 status=MagickReadImage(image_wand,argv[1]);
304 if (status == MagickFalse)
305 ThrowWandException(image_wand);
306 contrast_wand=CloneMagickWand(image_wand);
308 Sigmoidal non-linearity contrast control.
310 iterator=NewPixelIterator(image_wand);
311 contrast_iterator=NewPixelIterator(contrast_wand);
312 if ((iterator == (PixelIterator *) NULL) ||
313 (contrast_iterator == (PixelIterator *) NULL))
314 ThrowWandException(image_wand);
315 for (y=0; y < (long) MagickGetImageHeight(image_wand); y++)
317 pixels=PixelGetNextIteratorRow(iterator,&width);
318 contrast_pixels=PixelGetNextIteratorRow(contrast_iterator,&width);
319 if ((pixels == (PixelWand **) NULL) ||
320 (contrast_pixels == (PixelWand **) NULL))
322 for (x=0; x < (long) width; x++)
324 PixelGetMagickColor(pixels[x],&pixel);
325 pixel.red=SigmoidalContrast(pixel.red);
326 pixel.green=SigmoidalContrast(pixel.green);
327 pixel.blue=SigmoidalContrast(pixel.blue);
328 pixel.index=SigmoidalContrast(pixel.index);
329 PixelSetMagickColor(contrast_pixels[x],&pixel);
331 (void) PixelSyncIterator(contrast_iterator);
333 if (y < (long) MagickGetImageHeight(image_wand))
334 ThrowWandException(image_wand);
335 contrast_iterator=DestroyPixelIterator(contrast_iterator);
336 iterator=DestroyPixelIterator(iterator);
337 image_wand=DestroyMagickWand(image_wand);
339 Write the image then destroy it.
341 status=MagickWriteImages(contrast_wand,argv[2],MagickTrue);
342 if (status == MagickFalse)
343 ThrowWandException(image_wand);
344 contrast_wand=DestroyMagickWand(contrast_wand);
345 MagickWandTerminus();
350 <p>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 pixel views. The <a href="../www/source/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>
352 <div class="viewport">
354 #include <stdio.h>
355 #include <stdlib.h>
357 #include <wand/MagickWand.h>
359 static MagickBooleanType SigmoidalContrast(PixelView *pixel_view,
362 #define QuantumScale ((MagickRealType) 1.0/(MagickRealType) QuantumRange)
363 #define SigmoidalContrast(x) \
364 (QuantumRange*(1.0/(1+exp(10.0*(0.5-QuantumScale*x)))-0.0066928509)*1.0092503)
375 pixels=GetPixelViewPixels(contrast_view);
376 for (x=0; x < (long) GetPixelViewWidth(contrast_view); x++)
378 PixelGetMagickColor(pixels[x],&pixel);
379 pixel.red=SigmoidalContrast(pixel.red);
380 pixel.green=SigmoidalContrast(pixel.green);
381 pixel.blue=SigmoidalContrast(pixel.blue);
382 pixel.index=SigmoidalContrast(pixel.index);
383 PixelSetMagickColor(contrast_pixels[x],&pixel);
388 int main(int argc,char **argv)
390 #define ThrowWandException(wand) \
398 description=MagickGetException(wand,&severity); \
399 (void) fprintf(stderr,"%s %s %lu %s\n",GetMagickModule(),description); \
400 description=(char *) MagickRelinquishMemory(description); \
418 (void) fprintf(stdout,"Usage: %s image sigmoidal-image\n",argv[0]);
425 contrast_wand=NewMagickWand();
426 status=MagickReadImage(contrast_wand,argv[1]);
427 if (status == MagickFalse)
428 ThrowWandException(contrast_wand);
430 Sigmoidal non-linearity contrast control.
432 contrast_view=NewPixelView(contrast_wand);
433 if (contrast_view == (PixelView *) NULL)
434 ThrowWandException(contrast_wand);
435 status=UpdatePixelViewIterator(contrast_view,SigmoidalContrast,(void *) NULL);
436 if (status == MagickFalse)
437 ThrowWandException(contrast_wand);
438 contrast_view=DestroyPixelView(contrast_view);
440 Write the image then destroy it.
442 status=MagickWriteImages(contrast_wand,argv[2],MagickTrue);
443 if (status == MagickFalse)
444 ThrowWandException(contrast_wand);
445 contrast_wand=DestroyMagickWand(contrast_wand);
446 MagickWandTerminus();
455 <!-- <span id="linkbar-west"> </span> -->
\r
456 <span id="linkbar-center">
\r
457 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> •
\r
458 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
\r
460 <span id="linkbar-east"> </span>
\r
462 <div class="footer">
\r
463 <span id="footer-west">© 1999-2010 ImageMagick Studio LLC</span>
\r
464 <span id="footer-east"> <a href="http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
\r
466 <div style="clear: both; margin: 0; width: 100%; "></div>
\r