|
|
| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
|
| "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
| <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en" dir="ltr">
|
| <head>
|
| <meta http-equiv="content-type" content="text/html; charset=utf-8"/>
|
| <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U=" />
|
| <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf" />
|
| <style type="text/css" media="all">
|
| @import url("../www/magick.css");
|
| </style>
|
| <link rel="shortcut icon" href="../images/wand.ico" type="images/vnd.microsoft.icon"/> |
| <title>ImageMagick: MagickWand, C API for ImageMagick</title> |
| <meta http-equiv="Content-Language" content="en-US"/> |
| <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/> |
| <meta http-equiv="Reply-to" content="magick-users@imagemagick.org"/> |
| <meta name="Generator" content="PHP"/> |
| <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"/> |
| <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."/> |
| <meta name="Rating" content="GENERAL"/> |
| <meta name="Robots" content="INDEX, FOLLOW"/> |
| <meta name="Generator" content="ImageMagick Studio LLC"/> |
| <meta name="Author" content="ImageMagick Studio LLC"/> |
| <meta name="Revisit-after" content="2 DAYS"/> |
| <meta name="Resource-type" content="document"/> |
| <meta name="Copyright" content="Copyright (c) 1999-2010 ImageMagick Studio LLC"/> |
| <meta name="Distribution" content="Global"/> |
| </head>
|
|
|
| <body id="www-imagemagick-org">
|
| <div class="titlebar">
|
| <a href="../index.html">
|
| <img src="../images/script.png" alt="[ImageMagick]"
|
| style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>
|
| <a href="http://www.networkredux.com">
|
| <img src="../images/networkredux.png" alt="[sponsor]"
|
| style="margin: 45px auto; border: 0px; float: left;" /></a>
|
| <a href="http://www.imagemagick.org/discourse-server/">
|
| <img src="../images/logo.jpg" alt=""
|
| style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
|
| <a href="../index.html">
|
| <img src="../images/sprite.jpg" alt=""
|
| style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
|
| </div>
|
|
|
| <div class="eastbar">
|
|
|
| <div class="menu"> |
| <a title="About ImageMagick" href="../index.html">About ImageMagick</a> |
| </div> |
| <div class="sep"></div>
|
| <div class="menu"> |
| <a title="Binary Releases" href="../www/binary-releases.html">Binary Releases</a> |
| </div> |
| <div class="sub"> |
| <a title="Binary Release: Unix" href="../www/binary-releases.html#unix">Unix</a> |
| </div> |
| <div class="sub"> |
| <a title="Binary Release: MacOS X" href="../www/binary-releases.html#macosx">Mac OS X</a> |
| </div> |
| <div class="sub"> |
| <a title="Binary Release: Windows" href="../www/binary-releases.html#windows">Windows</a> |
| </div> |
| <div class="sep"></div>
|
| <div class="menu"> |
| <a title="Command-line Tools" href="../www/command-line-tools.html">Command-line Tools</a> |
| </div> |
| <div class="sub"> |
| <a title="Command-line Tools: Processing" href="../www/command-line-processing.html">Processing</a> |
| </div> |
| <div class="sub"> |
| <a title="Command-line Tools: Options" href="../www/command-line-options.html">Options</a> |
| </div> |
| <div class="sub"> |
| <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a> |
| </div> |
| <div class="menu"> |
| <a title="Program Interfaces" href="../www/api.html">Program Interfaces</a> |
| </div> |
| <div class="sub"> |
| <a title="Program Interface: MagickWand" href="../www/magick-wand.html">MagickWand</a> |
| </div> |
| <div class="sub"> |
| <a title="Program Interface: MagickCore" href="../www/magick-core.html">MagickCore</a> |
| </div> |
| <div class="sub"> |
| <a title="Program Interface: PerlMagick" href="../www/perl-magick.html">PerlMagick</a> |
| </div> |
| <div class="sub"> |
| <a title="Program Interface: Magick++" href="../Magick++/">Magick++</a> |
| </div> |
| <div class="sep"></div>
|
| <div class="menu"> |
| <a title="Install from Source" href="../www/install-source.html">Install from Source</a> |
| </div> |
| <div class="sub"> |
| <a title="Install from Source: Unix" href="../www/install-source.html#unix">Unix</a> |
| </div> |
| <div class="sub"> |
| <a title="Install from Source: Windows" href="../www/install-source.html#windows">Windows</a> |
| </div> |
| <div class="menu"> |
| <a title="Resources" href="../www/resources.html">Resources</a> |
| </div> |
| <div class="menu"> |
| <a title="Architecture" href="../www/architecture.html">Architecture</a> |
| </div> |
| <div class="menu"> |
| <a title="Download" href="../www/download.html">Download</a> |
| </div> |
| <div class="sep"></div>
|
| <div class="menu"> |
| <a title="Search" href="http://www.imagemagick.org/script/search.php">Search</a> |
| </div> |
| <div class="sep"></div>
|
| <div class="menu"> |
| <a title="Site Map"href="../www/sitemap.html">Site Map</a> |
| </div> |
| <div class="sub"> |
| <a title="Site Map: Links"href="../www/links.html">Links</a> |
| </div> |
| <div class="sep"></div>
|
| <div class="menu"> |
| <a title="Sponsors" href="../www/sponsors.html">Sponsors:</a> |
| |
| <div class="sponsbox"> |
| <div class="sponsor"> |
| <a title="Sponsor: Webdesign Agentur" href="http://www.ventzke-partner.de">Webdesign Agentur</a><!-- 201101010480 invendio.de--> |
| </div> |
| <div class="sponsor"> |
| <a title="Sponsor: LVM Versicherung" href="http://www.neu-reich.de">LVM Versicherung</a><!-- 201101010480 --> |
| </div> |
| <div class="sponsor"> |
| <a title="Sponsor: Deko.net" href="http://www.deko.net">Deko.net</a><!-- 201101010600 Peterssen--> |
| </div> |
| <div class="sponsor"> |
| <a title="Sponsor: Kredit" href="http://www.online-kredit-index.de">Kredit</a><!-- 201007010120 Buchhorn --> |
| </div> |
| <div class="sponsor"> |
| <a title="Sponsor: Druckerei" href="http://www.print24.de/">Druckerei</a><!-- 201009010720 --> |
| </div> |
| <div class="sponsor"> |
| <a title="Sponsor: Druckerei Online" href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012011200 allesdruck.de--> |
| </div> |
| <div class="sponsor"> |
| <a title="Sponsor: Online-Magazin" href="http://www.unkostenbeitrag.de/" title="Online-Magazin">Online-Magazin</a><!-- 20101101000200 --> |
| </div> |
| </div> |
| </div> |
|
|
|
|
| </div>
|
|
|
| <div class="main">
|
|
|
| <p class="navigation-index"></p> |
| |
| <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> |
| |
| <ul> |
| <li><a href="../www/api/magick-wand.html">Magick Wand Methods</a></li> |
| <li><a href="../www/api/magick-property.html">Set or Get Magick Wand Properties</a></li> |
| <li><a href="../www/api/magick-image.html">Magick Wand Image Methods</a></li> |
| <li><a href="../www/api/pixel-iterator.html">Pixel Iterator Methods</a></li> |
| <li><a href="../www/api/pixel-wand.html">Pixel Wand Methods</a></li> |
| <li><a href="../www/api/drawing-wand.html">Image Vector Drawing</a></li> |
| <li><a href="../www/api/wand-view.html">Wand View Methods</a></li> |
| <li><a href="../www/api/magick-deprecate.html">Deprecated Methods</a></li> |
| <li><a href="../www/exception.html">Error and Warning Codes</a></li> |
| </li> |
| </ul> |
| |
| <p>After you write your MagickWand program, compile it like this:</p> |
| |
| <p class='crt'><span class="crtprompt"> $magick> </span><span class='crtin'>cc `MagickWand-config --cflags --cppflags` -o wand wand.c \ <br/> `MagickWand-config --ldflags --libs`</span></p> |
| <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> |
| |
| <div class="viewport"> |
| <pre class="code"> |
| #include <stdio.h> |
| #include <stdlib.h> |
| #include <wand/MagickWand.h> |
| |
| int main(int argc,char **argv) |
| { |
| #define ThrowWandException(wand) \ |
| { \ |
| char \ |
| *description; \ |
| \ |
| ExceptionType \ |
| severity; \ |
| \ |
| description=MagickGetException(wand,&severity); \ |
| (void) fprintf(stderr,"%s %s %u %s\n",GetMagickModule(),description); \ |
| description=(char *) MagickRelinquishMemory(description); \ |
| exit(-1); \ |
| } |
| |
| MagickBooleanType |
| status; |
| |
| MagickWand |
| *magick_wand; |
| |
| if (argc != 3) |
| { |
| (void) fprintf(stdout,"Usage: %s image thumbnail\n",argv[0]); |
| exit(0); |
| } |
| /* |
| Read an image. |
| */ |
| MagickWandGenesis(); |
| magick_wand=NewMagickWand(); |
| status=MagickReadImage(magick_wand,argv[1]); |
| if (status == MagickFalse) |
| ThrowWandException(magick_wand); |
| /* |
| Turn the images into a thumbnail sequence. |
| */ |
| MagickResetIterator(magick_wand); |
| while (MagickNextImage(magick_wand) != MagickFalse) |
| MagickResizeImage(magick_wand,106,80,LanczosFilter,1.0); |
| /* |
| Write the image then destroy it. |
| */ |
| status=MagickWriteImages(magick_wand,argv[2],MagickTrue); |
| if (status == MagickFalse) |
| ThrowWandException(magick_wand); |
| magick_wand=DestroyMagickWand(magick_wand); |
| MagickWandTerminus(); |
| return(0); |
| } |
| </pre> |
| </div> |
| |
| <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> |
| |
| <div class="viewport"> |
| <pre class="code"> |
| #include <stdio.h> |
| #include <stdlib.h> |
| #include <math.h> |
| #include <wand/MagickWand.h> |
| |
| int main(int argc,char **argv) |
| { |
| #define QuantumScale ((MagickRealType) 1.0/(MagickRealType) QuantumRange) |
| #define SigmoidalContrast(x) \ |
| (QuantumRange*(1.0/(1+exp(10.0*(0.5-QuantumScale*x)))-0.0066928509)*1.0092503) |
| #define ThrowWandException(wand) \ |
| { \ |
| char \ |
| *description; \ |
| \ |
| ExceptionType \ |
| severity; \ |
| \ |
| description=MagickGetException(wand,&severity); \ |
| (void) fprintf(stderr,"%s %s %lu %s\n",GetMagickModule(),description); \ |
| description=(char *) MagickRelinquishMemory(description); \ |
| exit(-1); \ |
| } |
| |
| long |
| y; |
| |
| MagickBooleanType |
| status; |
| |
| MagickPixelPacket |
| pixel; |
| |
| MagickWand |
| *contrast_wand, |
| *image_wand; |
| |
| PixelIterator |
| *contrast_iterator, |
| *iterator; |
| |
| PixelWand |
| **contrast_pixels, |
| **pixels; |
| |
| register long |
| x; |
| |
| unsigned long |
| width; |
| |
| if (argc != 3) |
| { |
| (void) fprintf(stdout,"Usage: %s image sigmoidal-image\n",argv[0]); |
| exit(0); |
| } |
| /* |
| Read an image. |
| */ |
| MagickWandGenesis(); |
| image_wand=NewMagickWand(); |
| status=MagickReadImage(image_wand,argv[1]); |
| if (status == MagickFalse) |
| ThrowWandException(image_wand); |
| contrast_wand=CloneMagickWand(image_wand); |
| /* |
| Sigmoidal non-linearity contrast control. |
| */ |
| iterator=NewPixelIterator(image_wand); |
| contrast_iterator=NewPixelIterator(contrast_wand); |
| if ((iterator == (PixelIterator *) NULL) || |
| (contrast_iterator == (PixelIterator *) NULL)) |
| ThrowWandException(image_wand); |
| for (y=0; y < (long) MagickGetImageHeight(image_wand); y++) |
| { |
| pixels=PixelGetNextIteratorRow(iterator,&width); |
| contrast_pixels=PixelGetNextIteratorRow(contrast_iterator,&width); |
| if ((pixels == (PixelWand **) NULL) || |
| (contrast_pixels == (PixelWand **) NULL)) |
| break; |
| for (x=0; x < (long) width; x++) |
| { |
| PixelGetMagickColor(pixels[x],&pixel); |
| pixel.red=SigmoidalContrast(pixel.red); |
| pixel.green=SigmoidalContrast(pixel.green); |
| pixel.blue=SigmoidalContrast(pixel.blue); |
| pixel.index=SigmoidalContrast(pixel.index); |
| PixelSetMagickColor(contrast_pixels[x],&pixel); |
| } |
| (void) PixelSyncIterator(contrast_iterator); |
| } |
| if (y < (long) MagickGetImageHeight(image_wand)) |
| ThrowWandException(image_wand); |
| contrast_iterator=DestroyPixelIterator(contrast_iterator); |
| iterator=DestroyPixelIterator(iterator); |
| image_wand=DestroyMagickWand(image_wand); |
| /* |
| Write the image then destroy it. |
| */ |
| status=MagickWriteImages(contrast_wand,argv[2],MagickTrue); |
| if (status == MagickFalse) |
| ThrowWandException(image_wand); |
| contrast_wand=DestroyMagickWand(contrast_wand); |
| MagickWandTerminus(); |
| return(0); |
| } |
| </pre> |
| </div> |
| <p><a name="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> |
| |
| <div class="viewport"> |
| <pre class="code"> |
| #include <stdio.h> |
| #include <stdlib.h> |
| #include <math.h> |
| #include <wand/MagickWand.h> |
| |
| static MagickBooleanType SigmoidalContrast(WandView *pixel_view, |
| const ssize_t y,const int id,void *context) |
| { |
| #define QuantumScale ((MagickRealType) 1.0/(MagickRealType) QuantumRange) |
| #define SigmoidalContrast(x) \ |
| (QuantumRange*(1.0/(1+exp(10.0*(0.5-QuantumScale*x)))-0.0066928509)*1.0092503) |
| |
| RectangleInfo |
| extent; |
| |
| MagickPixelPacket |
| pixel; |
| |
| PixelWand |
| **pixels; |
| |
| register long |
| x; |
| |
| extent=GetWandViewExtent(contrast_view); |
| pixels=GetWandViewPixels(contrast_view); |
| for (x=0; x < (long) (extent.width-extent.height); x++) |
| { |
| PixelGetMagickColor(pixels[x],&pixel); |
| pixel.red=SigmoidalContrast(pixel.red); |
| pixel.green=SigmoidalContrast(pixel.green); |
| pixel.blue=SigmoidalContrast(pixel.blue); |
| pixel.index=SigmoidalContrast(pixel.index); |
| PixelSetMagickColor(contrast_pixels[x],&pixel); |
| } |
| return(MagickTrue); |
| } |
| |
| int main(int argc,char **argv) |
| { |
| #define ThrowViewException(view) \ |
| { \ |
| description=GetWandViewException(view,&severity); \ |
| (void) fprintf(stderr,"%s %s %lu %s\n",GetMagickModule(),description); \ |
| description=(char *) MagickRelinquishMemory(description); \ |
| exit(-1); \ |
| } |
| #define ThrowWandException(wand) \ |
| { \ |
| description=MagickGetException(wand,&severity); \ |
| (void) fprintf(stderr,"%s %s %lu %s\n",GetMagickModule(),description); \ |
| description=(char *) MagickRelinquishMemory(description); \ |
| exit(-1); \ |
| } |
| |
| char |
| *description; |
| |
| ExceptionType |
| severity; |
| |
| MagickBooleanType |
| status; |
| |
| MagickPixelPacket |
| pixel; |
| |
| MagickWand |
| *contrast_wand; |
| |
| WandView |
| *contrast_view; |
| |
| if (argc != 3) |
| { |
| (void) fprintf(stdout,"Usage: %s image sigmoidal-image\n",argv[0]); |
| exit(0); |
| } |
| /* |
| Read an image. |
| */ |
| MagickWandGenesis(); |
| contrast_wand=NewMagickWand(); |
| status=MagickReadImage(contrast_wand,argv[1]); |
| if (status == MagickFalse) |
| ThrowWandException(contrast_wand); |
| /* |
| Sigmoidal non-linearity contrast control. |
| */ |
| contrast_view=NewWandView(contrast_wand); |
| if (contrast_view == (WandView *) NULL) |
| ThrowWandException(contrast_wand); |
| status=UpdateWandViewIterator(contrast_view,SigmoidalContrast,(void *) NULL); |
| if (status == MagickFalse) |
| ThrowWandException(contrast_wand); |
| contrast_view=DestroyWandView(contrast_view); |
| /* |
| Write the image then destroy it. |
| */ |
| status=MagickWriteImages(contrast_wand,argv[2],MagickTrue); |
| if (status == MagickFalse) |
| ThrowWandException(contrast_wand); |
| contrast_wand=DestroyMagickWand(contrast_wand); |
| MagickWandTerminus(); |
| return(0); |
| } |
| </pre> |
| </div> |
|
|
| </div>
|
|
|
| <div id="linkbar">
|
| <!-- <span id="linkbar-west"> </span> -->
|
| <span id="linkbar-center">
|
| <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> •
|
| <a href="http://studio.webbyland.com/ImageMagick/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
|
| </span>
|
| <span id="linkbar-east"> </span>
|
| </div>
|
| <div class="footer">
|
| <span id="footer-west">© 1999-2010 ImageMagick Studio LLC</span>
|
| <span id="footer-east"> <a href="http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
|
| </div>
|
| <div style="clear: both; margin: 0; width: 100%; "></div>
|
| </body>
|
| </html>
|