granicus.if.org Git - imagemagick/blob - www/magick-wand.html

   1 \r
   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" dir="ltr">\r
   5 <head>\r
   6   <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>\r
   7   <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U="/>\r
   8   <title>ImageMagick: MagickWand, C API for ImageMagick</title/>
   9   <meta http-equiv="Content-Language" content="en-US"/>
  10   <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
  11   <meta http-equiv="Reply-to" content="magick-users@imagemagick.org"/>
  12   <meta name="Application-name" content="ImageMagick"/>
  13   <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."/>
  14   <meta name="Application-url" content="http://www.imagemagick.org"/>
  15   <meta name="Generator" content="PHP"/>
  16   <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"/>
  17   <meta name="Rating" content="GENERAL"/>
  18   <meta name="Robots" content="INDEX, FOLLOW"/>
  19   <meta name="Generator" content="ImageMagick Studio LLC"/>
  20   <meta name="Author" content="ImageMagick Studio LLC"/>
  21   <meta name="Revisit-after" content="2 DAYS"/>
  22   <meta name="Resource-type" content="document"/>
  23   <meta name="Copyright" content="Copyright (c) 1999-2010 ImageMagick Studio LLC"/>
  24   <meta name="Distribution" content="Global"/>
  25   <link rel="icon" href="../images/wand.png"  sizes="32x32"/>
  26   <link rel="shortcut icon" href="../images/wand.ico"  type="images/x-icon"/>
  27   <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf"/>\r
  28   <style type="text/css" media="all">\r
  29     @import url("../www/magick.css");\r
  30   </style>\r
  31 </head>\r
  32 \r
  33 <body id="www-imagemagick-org">\r
  34 <div class="titlebar">\r
  35 <a href="../index.html">\r
  36   <img src="../images/script.png" alt="[ImageMagick]"\r
  37   style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>\r
  38 <a href="http://www.networkredux.com">\r
  39   <img src="../images/networkredux.png" alt="[sponsor]"\r
  40   style="margin: 45px auto; border: 0px; float: left;" /></a>\r
  41 <a href="http://www.imagemagick.org/discourse-server/">\r
  42   <img src="../images/logo.jpg" alt=""\r
  43   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
  44 <a href="../index.html">\r
  45   <img src="../images/sprite.jpg" alt=""\r
  46   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
  47 </div>\r
  48 \r
  49 <div class="westbar">\r
  50 \r
  51 <div class="menu">
  52   <a title="About ImageMagick" href="../index.html">About ImageMagick</a>
  53 </div>
  54 <div class="sep"></div>\r
  55 <div class="menu">
  56   <a title="Binary Releases" href="../www/binary-releases.html">Binary Releases</a>
  57 </div>
  58 <div class="sub">
  59     <a title="Binary Release: Unix" href="../www/binary-releases.html#unix">Unix</a>
  60 </div>
  61 <div class="sub">
  62     <a title="Binary Release: MacOS X" href="../www/binary-releases.html#macosx">Mac OS X</a>
  63 </div>
  64 <div class="sub">
  65     <a title="Binary Release: Windows" href="../www/binary-releases.html#windows">Windows</a>
  66 </div>
  67 <div class="sep"></div>\r
  68 <div class="menu">
  69   <a title="Command-line Tools" href="../www/command-line-tools.html">Command-line Tools</a>
  70 </div>
  71 <div class="sub">
  72     <a title="Command-line Tools: Processing" href="../www/command-line-processing.html">Processing</a>
  73 </div>
  74 <div class="sub">
  75     <a title="Command-line Tools: Options" href="../www/command-line-options.html">Options</a>
  76 </div>
  77 <div class="sub">
  78     <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
  79 </div>
  80 <div class="menu">
  81   <a title="Program Interfaces" href="../www/api.html">Program Interfaces</a>
  82 </div>
  83 <div class="sub">
  84     <a title="Program Interface: MagickWand" href="../www/magick-wand.html">MagickWand</a>
  85 </div>
  86 <div class="sub">
  87     <a title="Program Interface: MagickCore" href="../www/magick-core.html">MagickCore</a>
  88 </div>
  89 <div class="sub">
  90     <a title="Program Interface: PerlMagick" href="../www/perl-magick.html">PerlMagick</a>
  91 </div>
  92 <div class="sub">
  93     <a title="Program Interface: Magick++" href="../Magick++/">Magick++</a>
  94 </div>
  95 <div class="sep"></div>\r
  96 <div  class="menu">
  97    <a title="Install from Source" href="../www/install-source.html">Install from Source</a>
  98 </div>
  99 <div class="sub">
 100     <a title="Install from Source: Unix" href="../www/install-source.html#unix">Unix</a>
 101 </div>
 102 <div class="sub">
 103     <a title="Install from Source: Windows" href="../www/install-source.html#windows">Windows</a>
 104  </div>
 105 <div class="menu">
 106   <a title="Resources" href="../www/resources.html">Resources</a>
 107 </div>
 108 <div class="menu">
 109   <a title="Architecture" href="../www/architecture.html">Architecture</a>
 110 </div>
 111 <div class="menu">
 112   <a title="Download" href="../www/download.html">Download</a>
 113 </div>
 114 <div class="sep"></div>\r
 115 <div class="menu">
 116   <a title="Search" href="http://www.imagemagick.org/script/search.php">Search</a>
 117 </div>
 118 <div class="sep"></div>\r
 119 <div class="menu">
 120   <a title="Site Map"href="../www/sitemap.html">Site Map</a>
 121 </div>
 122 <div  class="sub">
 123     <a title="Site Map: Links"href="../www/links.html">Links</a>
 124 </div>
 125 <div class="sep"></div>\r
 126 <div  class="menu">
 127   <a title="Sponsors" href="../www/sponsors.html">Sponsors:</a>
 128
 129 <div class="sponsbox">
 130 <div  class="sponsor">
 131    <a title="Sponsor: Free Catalogs" href="http://www.who-sells-it.com/">Free Catalogs</a><!-- 20120801000600 -->
 132 </div>
 133 <div  class="sponsor">
 134   <a title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 -->
 135 </div>
 136 <div  class="sponsor">
 137   <a title="Sponsor: Image Converter" href="http://www.batchphoto.com">Image Converter</a><!-- 201103010900 Bits Coffee-->
 138 </div>
 139 <div  class="sponsor">
 140   <a title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
 141 </div>
 142 <div  class="sponsor">
 143   <a title="Sponsor: Webdesign Agentur" href="http://www.ventzke-partner.de">Webdesign Agentur</a><!-- 201101010480 invendio.de-->
 144 </div>
 145 <div  class="sponsor">
 146   <a title="Sponsor: LVM Versicherung" href="http://www.neu-reich.de">LVM Versicherung</a><!-- 201101010480 -->
 147 </div>
 148 <div  class="sponsor">
 149   <a title="Sponsor: Diamonds are a Girls Best Friend" href="http://www.schmuck.org">Diamonds are a Girls Best Friend</a><!-- 201101010600 Peterssen-->
 150 </div>
 151 </div>
 152 </div>
 153 </div>\r
 154 \r
 155 <div class="eastbar">\r
 156   <script type="text/javascript">\r
 157   <!--\r
 158     google_ad_client = "pub-3129977114552745";\r
 159     google_ad_slot = "0574824969";\r
 160     google_ad_width = 160;\r
 161     google_ad_height = 600;\r
 162   //-->\r
 163   </script>\r
 164   <script type="text/javascript"\r
 165     src="http://pagead2.googlesyndication.com/pagead/show_ads.js">\r
 166   </script>\r
 167 </div>\r
 168 \r
 169 <div class="main">\r
 170 \r
 171 <p class="navigation-index"></p>
 172
 173 <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>
 174
 175 <ul>
 176   <li><a href="../www/api/magick-wand.html">Magick Wand Methods</a></li>
 177   <li><a href="../www/api/magick-property.html">Set or Get Magick Wand Properties</a></li>
 178   <li><a href="../www/api/magick-image.html">Magick Wand Image Methods</a></li>
 179   <li><a href="../www/api/pixel-iterator.html">Pixel Iterator Methods</a></li>
 180   <li><a href="../www/api/pixel-wand.html">Pixel Wand Methods</a></li>
 181   <li><a href="../www/api/drawing-wand.html">Image Vector Drawing</a></li>
 182   <li><a href="../www/api/mogrify.html">Command-line Interface</a></li>
 183   <li><a href="../www/api/wand-view.html">Wand View Methods</a></li>
 184   <li><a href="../www/api/magick-deprecate.html">Deprecated Methods</a></li>
 185   <li><a href="../www/exception.html">Error and Warning Codes</a></li>
 186 </li>
 187 </ul>
 188
 189 <p>After you write your MagickWand program, compile it like this:</p>
 190
 191 <p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>cc `MagickWand-config --cflags --cppflags` -O2 -o wand wand.c  \ <br/> `MagickWand-config --ldflags --libs`</span></p>
 192 <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>
 193
 194 <div class="viewport">
 195 <pre class="code">
 196 #include &lt;stdio.h>
 197 #include &lt;stdlib.h>
 198 #include &lt;wand/MagickWand.h>
 199
 200 int main(int argc,char **argv)
 201 {
 202 #define ThrowWandException(wand) \
 203 { \
 204   char \
 205     *description; \
 206  \
 207   ExceptionType \
 208     severity; \
 209  \
 210   description=MagickGetException(wand,&amp;severity); \
 211   (void) fprintf(stderr,"%s %s %u %s\n",GetMagickModule(),description); \
 212   description=(char *) MagickRelinquishMemory(description); \
 213   exit(-1); \
 214 }
 215
 216   MagickBooleanType
 217     status;
 218
 219   MagickWand
 220     *magick_wand;
 221
 222   if (argc != 3)
 223     {
 224       (void) fprintf(stdout,"Usage: %s image thumbnail\n",argv[0]);
 225       exit(0);
 226     }
 227   /*
 228     Read an image.
 229   */
 230   MagickWandGenesis();
 231   magick_wand=NewMagickWand();
 232   status=MagickReadImage(magick_wand,argv[1]);
 233   if (status == MagickFalse)
 234     ThrowWandException(magick_wand);
 235   /*
 236     Turn the images into a thumbnail sequence.
 237   */
 238   MagickResetIterator(magick_wand);
 239   while (MagickNextImage(magick_wand) != MagickFalse)
 240     MagickResizeImage(magick_wand,106,80,LanczosFilter,1.0);
 241   /*
 242     Write the image then destroy it.
 243   */
 244   status=MagickWriteImages(magick_wand,argv[2],MagickTrue);
 245   if (status == MagickFalse)
 246     ThrowWandException(magick_wand);
 247   magick_wand=DestroyMagickWand(magick_wand);
 248   MagickWandTerminus();
 249   return(0);
 250 }
 251 </pre>
 252 </div>
 253
 254 <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>
 255
 256 <div class="viewport">
 257 <pre class="code">
 258 #include &lt;stdio.h>
 259 #include &lt;stdlib.h>
 260 #include &lt;math.h>
 261 #include &lt;wand/MagickWand.h>
 262
 263 int main(int argc,char **argv)
 264 {
 265 #define QuantumScale  ((MagickRealType) 1.0/(MagickRealType) QuantumRange)
 266 #define SigmoidalContrast(x) \
 267   (QuantumRange*(1.0/(1+exp(10.0*(0.5-QuantumScale*x)))-0.0066928509)*1.0092503)
 268 #define ThrowWandException(wand) \
 269 { \
 270   char \
 271     *description; \
 272  \
 273   ExceptionType \
 274     severity; \
 275  \
 276   description=MagickGetException(wand,&amp;severity); \
 277   (void) fprintf(stderr,"%s %s %lu %s\n",GetMagickModule(),description); \
 278   description=(char *) MagickRelinquishMemory(description); \
 279   exit(-1); \
 280 }
 281
 282   long
 283     y;
 284
 285   MagickBooleanType
 286     status;
 287
 288   MagickPixelPacket
 289     pixel;
 290
 291   MagickWand
 292     *contrast_wand,
 293     *image_wand;
 294
 295   PixelIterator
 296     *contrast_iterator,
 297     *iterator;
 298
 299   PixelWand
 300     **contrast_pixels,
 301     **pixels;
 302
 303   register long
 304     x;
 305
 306   unsigned long
 307     width;
 308
 309   if (argc != 3)
 310     {
 311       (void) fprintf(stdout,"Usage: %s image sigmoidal-image\n",argv[0]);
 312       exit(0);
 313     }
 314   /*
 315     Read an image.
 316   */
 317   MagickWandGenesis();
 318   image_wand=NewMagickWand();
 319   status=MagickReadImage(image_wand,argv[1]);
 320   if (status == MagickFalse)
 321     ThrowWandException(image_wand);
 322   contrast_wand=CloneMagickWand(image_wand);
 323   /*
 324     Sigmoidal non-linearity contrast control.
 325   */
 326   iterator=NewPixelIterator(image_wand);
 327   contrast_iterator=NewPixelIterator(contrast_wand);
 328   if ((iterator == (PixelIterator *) NULL) ||
 329       (contrast_iterator == (PixelIterator *) NULL))
 330     ThrowWandException(image_wand);
 331   for (y=0; y &lt; (long) MagickGetImageHeight(image_wand); y++)
 332   {
 333     pixels=PixelGetNextIteratorRow(iterator,&amp;width);
 334     contrast_pixels=PixelGetNextIteratorRow(contrast_iterator,&amp;width);
 335     if ((pixels == (PixelWand **) NULL) ||
 336         (contrast_pixels == (PixelWand **) NULL))
 337       break;
 338     for (x=0; x &lt; (long) width; x++)
 339     {
 340       PixelGetMagickColor(pixels[x],&amp;pixel);
 341       pixel.red=SigmoidalContrast(pixel.red);
 342       pixel.green=SigmoidalContrast(pixel.green);
 343       pixel.blue=SigmoidalContrast(pixel.blue);
 344       pixel.index=SigmoidalContrast(pixel.index);
 345       PixelSetMagickColor(contrast_pixels[x],&amp;pixel);
 346     }
 347     (void) PixelSyncIterator(contrast_iterator);
 348   }
 349   if (y &lt; (long) MagickGetImageHeight(image_wand))
 350     ThrowWandException(image_wand);
 351   contrast_iterator=DestroyPixelIterator(contrast_iterator);
 352   iterator=DestroyPixelIterator(iterator);
 353   image_wand=DestroyMagickWand(image_wand);
 354   /*
 355     Write the image then destroy it.
 356   */
 357   status=MagickWriteImages(contrast_wand,argv[2],MagickTrue);
 358   if (status == MagickFalse)
 359     ThrowWandException(image_wand);
 360   contrast_wand=DestroyMagickWand(contrast_wand);
 361   MagickWandTerminus();
 362   return(0);
 363 }
 364 </pre>
 365 </div>
 366 <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>
 367
 368 <div class="viewport">
 369 <pre class="code">
 370 #include &lt;stdio.h>
 371 #include &lt;stdlib.h>
 372 #include &lt;math.h>
 373 #include &lt;wand/MagickWand.h>
 374
 375 static MagickBooleanType SigmoidalContrast(WandView *pixel_view,
 376   const ssize_t y,const int id,void *context)
 377 {
 378 #define QuantumScale  ((MagickRealType) 1.0/(MagickRealType) QuantumRange)
 379 #define SigmoidalContrast(x) \
 380   (QuantumRange*(1.0/(1+exp(10.0*(0.5-QuantumScale*x)))-0.0066928509)*1.0092503)
 381
 382   RectangleInfo
 383     extent;
 384
 385   MagickPixelPacket
 386     pixel;
 387
 388   PixelWand
 389     **pixels;
 390
 391   register long
 392     x;
 393
 394   extent=GetWandViewExtent(contrast_view);
 395   pixels=GetWandViewPixels(contrast_view);
 396   for (x=0; x &lt; (long) (extent.width-extent.height); x++)
 397   {
 398     PixelGetMagickColor(pixels[x],&amp;pixel);
 399     pixel.red=SigmoidalContrast(pixel.red);
 400     pixel.green=SigmoidalContrast(pixel.green);
 401     pixel.blue=SigmoidalContrast(pixel.blue);
 402     pixel.index=SigmoidalContrast(pixel.index);
 403     PixelSetMagickColor(contrast_pixels[x],&amp;pixel);
 404   }
 405   return(MagickTrue);
 406 }
 407
 408 int main(int argc,char **argv)
 409 {
 410 #define ThrowViewException(view) \
 411 { \
 412   description=GetWandViewException(view,&severity); \
 413   (void) fprintf(stderr,"%s %s %lu %s\n",GetMagickModule(),description); \
 414   description=(char *) MagickRelinquishMemory(description); \
 415   exit(-1); \
 416 }
 417 #define ThrowWandException(wand) \
 418 { \
 419   description=MagickGetException(wand,&severity); \
 420   (void) fprintf(stderr,"%s %s %lu %s\n",GetMagickModule(),description); \
 421   description=(char *) MagickRelinquishMemory(description); \
 422   exit(-1); \
 423 }
 424
 425   char
 426     *description;
 427
 428   ExceptionType
 429     severity;
 430
 431   MagickBooleanType
 432     status;
 433
 434   MagickPixelPacket
 435     pixel;
 436
 437   MagickWand
 438     *contrast_wand;
 439
 440   WandView
 441     *contrast_view;
 442
 443   if (argc != 3)
 444     {
 445       (void) fprintf(stdout,"Usage: %s image sigmoidal-image\n",argv[0]);
 446       exit(0);
 447     }
 448   /*
 449     Read an image.
 450   */
 451   MagickWandGenesis();
 452   contrast_wand=NewMagickWand();
 453   status=MagickReadImage(contrast_wand,argv[1]);
 454   if (status == MagickFalse)
 455     ThrowWandException(contrast_wand);
 456   /*
 457     Sigmoidal non-linearity contrast control.
 458   */
 459   contrast_view=NewWandView(contrast_wand);
 460   if (contrast_view == (WandView *) NULL)
 461     ThrowWandException(contrast_wand);
 462   status=UpdateWandViewIterator(contrast_view,SigmoidalContrast,(void *) NULL);
 463   if (status == MagickFalse)
 464     ThrowWandException(contrast_wand);
 465   contrast_view=DestroyWandView(contrast_view);
 466   /*
 467     Write the image then destroy it.
 468   */
 469   status=MagickWriteImages(contrast_wand,argv[2],MagickTrue);
 470   if (status == MagickFalse)
 471     ThrowWandException(contrast_wand);
 472   contrast_wand=DestroyMagickWand(contrast_wand);
 473   MagickWandTerminus();
 474   return(0);
 475 }
 476 </pre>
 477 </div>
 478 \r
 479 </div>\r
 480 \r
 481 <div id="linkbar">\r
 482     <span id="linkbar-west">&nbsp;</span>\r
 483     <span id="linkbar-center">\r
 484       <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;\r
 485       <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>\r
 486     </span>\r
 487     <span id="linkbar-east">&nbsp;</span>\r
 488   </div>\r
 489   <div class="footer">\r
 490     <span id="footer-west">&copy; 1999-2010 ImageMagick Studio LLC</span>\r
 491     <span id="footer-east"> <a href="http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>\r
 492   </div>\r
 493   <div style="clear: both; margin: 0; width: 100%; "></div>\r
 494   <script type="text/javascript">\r
 495     var _gaq = _gaq || [];\r
 496     _gaq.push(['_setAccount', 'UA-17690367-1']);\r
 497     _gaq.push(['_trackPageview']);\r
 498 \r
 499     (function() {\r
 500       var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;\r
 501       ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';\r
 502       var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);\r
 503     })();\r
 504   </script>\r
 505 </body>\r
 506 </html>\r