|
|
| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
|
| "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
|
| <html version="-//W3C//DTD XHTML 1.1//EN"
|
| xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"
|
| xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
| xsi:schemaLocation="http://www.w3.org/1999/xhtml
|
| http://www.w3.org/MarkUp/SCHEMA/xhtml11.xsd">
|
| <head>
|
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
|
| <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U="/>
|
| <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="Application-name" content="ImageMagick"/> |
| <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."/> |
| <meta name="Application-url" content="http://www.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="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-2011 ImageMagick Studio LLC"/> |
| <meta name="Distribution" content="Global"/> |
| <link rel="icon" href="../images/wand.png"/> |
| <link rel="shortcut icon" href="../images/wand.ico" type="images/x-icon"/> |
| <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf"/>
|
| <link rel="stylesheet" href="http://www.google.com/cse/style/look/default.css" type="text/css" />
|
| <style type="text/css" media="all">
|
| @import url("../www/magick.css");
|
| </style>
|
| <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.4/jquery.min.js"></script>
|
| <script type="text/javascript" src="../fancybox/jquery.fancybox-1.3.4.pack.js"></script>
|
| <link rel="stylesheet" type="text/css" href="../fancybox/jquery.fancybox-1.3.4.css" media="screen" />
|
| <script type="text/javascript">
|
| $(document).ready(function() {
|
| $("a[href$=.jpg],a[href$=.png],a[href$=.gif]").fancybox({
|
| 'transitionIn' : 'elastic',
|
| 'transitionOut' : 'elastic',
|
| 'overlayShow' : false,
|
| 'opacity' : true
|
| });
|
| });
|
| </script>
|
| </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-top: 42px; border: 0px; float: left;" /></a>
|
| <a href="http://www.imagemagick.org/discourse-server/">
|
| <img src="../images/logo.jpg"
|
| alt="ImageMagick Logo"
|
| style="width: 123px; height: 118px; border: 0px; float: right;" /></a>
|
| <a href="../index.html">
|
| <img src="../images/sprite.jpg"
|
| alt="ImageMagick Sprite"
|
| style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
|
| </div>
|
|
|
| <div class="westbar">
|
|
|
| <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: iPhone" href="../www/binary-releases.html#iPhone">iPhone</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="../www/magick++.html">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="../www/search.html">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: Best Web Hosting" href="http://webhostinggeeks.com">Best Web Hosting</a><!-- 201110010720 --> |
| </div> |
| <div class="sponsor"> |
| <a title="Sponsor: Web Hosting Ratings" href="http://webhostingrating.com">Web Hosting Ratings</a><!-- 201110010720 --> |
| </div> |
| <div class="sponsor"> |
| <a title="Sponsor: Druckerei" href="http://www.allesdruck.de">Druckerei</a><!-- 201107010240 r.leo --> |
| </div> |
| <div class="sponsor"> |
| <a title="Sponsor: Web Hosting" href="http://www.bodhost.com/hosting.shtml">Web Hosting</a><!-- 201104010090 --> |
| </div> |
| <div class="sponsor"> |
| <a title="Sponsor: Image Converter" href="http://www.batchphoto.com">Image Converter</a><!-- 201103010900 Bits Coffee--> |
| </div> |
| <div class="sponsor"> |
| <a title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter--> |
| </div> |
| <div class="sponsor"> |
| <a title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 --> |
| </div> |
| <div class="sponsor"> |
| <a title="Sponsor: Free Catalogs" href="http://www.who-sells-it.com/">Free Catalogs</a><!-- 20120801000600 --> |
| </div> |
| </div> |
| </div> |
| </div>
|
|
|
| <div class="eastbar">
|
| <script type="text/javascript">
|
| <!--
|
| google_ad_client = "pub-3129977114552745";
|
| google_ad_slot = "0574824969";
|
| google_ad_width = 160;
|
| google_ad_height = 600;
|
| //-->
|
| </script>
|
| <script type="text/javascript"
|
| src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
|
| </script>
|
| </div>
|
|
|
| <div class="main">
|
|
|
| <h1>MagickWand C API</h1> |
| |
| <div class="doc-section"> |
| <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/mogrify.html">Command-line Interface</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> |
| </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` -O2 -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 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> |
| |
| <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>
|
|
|
| <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://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
|
| </span>
|
| <span id="linkbar-east"> </span>
|
| </div>
|
| <div class="footer">
|
| <span id="footer-west">© 1999-2011 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>
|
| <script type="text/javascript">
|
| var _gaq = _gaq || [];
|
| _gaq.push(['_setAccount', 'UA-17690367-1']);
|
| _gaq.push(['_trackPageview']);
|
|
|
| (function() {
|
| var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
|
| ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
|
| var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
|
| })();
|
| </script>
|
| </body>
|
| </html>
|