]> granicus.if.org Git - imagemagick/blobdiff - www/magick-wand.html
(no commit message)
[imagemagick] / www / magick-wand.html
index 82dd30387ecf0dc3acbdbeb6704c0b37501e4a67..f565f2316caf8a9c3ba956b487b079d958831de9 100644 (file)
@@ -3,20 +3,17 @@
     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">\r
 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en" dir="ltr">\r
 <head>\r
-  <meta http-equiv="content-type" content="text/html; charset=UTF-8"/>\r
-  <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U=" />\r
-  <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf" />\r
-  <style type="text/css" media="screen,projection"><!--\r
-    @import url("../www/magick.css");\r
-  --></style>\r
-  <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-Type" content="text/html; charset=UTF-8"/>\r
+  <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U="/>\r
+  <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="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="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="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="Resource-type" content="document"/>
   <meta name="Copyright" content="Copyright (c) 1999-2010 ImageMagick Studio LLC"/>
   <meta name="Distribution" content="Global"/>
+  <link rel="icon" href="../images/wand.png"  sizes="32x32"/>
+  <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"/>\r
+  <style type="text/css" media="all">\r
+    @import url("../www/magick.css");\r
+  </style>\r
 </head>\r
 \r
 <body id="www-imagemagick-org">\r
   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
 </div>\r
 \r
-<div class="eastbar">\r
+<div class="westbar">\r
 \r
 <div class="menu">
-  <a href="../index.html">About ImageMagick</a>
+  <a title="About ImageMagick" href="../index.html">About ImageMagick</a>
 </div>
 <div class="sep"></div>\r
 <div class="menu">
-  <a href="../www/command-line-tools.html">Command-line Tools</a>
+  <a title="Binary Releases" href="../www/binary-releases.html">Binary Releases</a>
 </div>
 <div class="sub">
-    <a href="../www/command-line-processing.html">Processing</a>
+    <a title="Binary Release: Unix" href="../www/binary-releases.html#unix">Unix</a>
 </div>
 <div class="sub">
-    <a href="../www/command-line-options.html">Options</a>
+    <a title="Binary Release: MacOS X" href="../www/binary-releases.html#macosx">Mac OS X</a>
 </div>
 <div class="sub">
-    <a href="http://www.imagemagick.org/Usage/">Usage</a>
+    <a title="Binary Release: Windows" href="../www/binary-releases.html#windows">Windows</a>
 </div>
+<div class="sep"></div>\r
 <div class="menu">
-  <a href="../www/api.html">Program Interfaces</a>
-</div>
-<div class="sub">
-    <a href="../www/magick-wand.html">MagickWand</a>
+  <a title="Command-line Tools" href="../www/command-line-tools.html">Command-line Tools</a>
 </div>
 <div class="sub">
-    <a href="../www/magick-core.html">MagickCore</a>
+    <a title="Command-line Tools: Processing" href="../www/command-line-processing.html">Processing</a>
 </div>
 <div class="sub">
-    <a href="../www/perl-magick.html">PerlMagick</a>
+    <a title="Command-line Tools: Options" href="../www/command-line-options.html">Options</a>
 </div>
 <div class="sub">
-    <a href="../Magick++/">Magick++</a>
+    <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
 </div>
 <div class="menu">
-  <a href="../www/architecture.html">Architecture</a>
+  <a title="Program Interfaces" href="../www/api.html">Program Interfaces</a>
 </div>
-<div class="sep"></div>\r
-<div  class="menu">
-   <a href="../www/install-source.html">Install from Source</a>
+<div class="sub">
+    <a title="Program Interface: MagickWand" href="../www/magick-wand.html">MagickWand</a>
 </div>
 <div class="sub">
-    <a href="../www/install-source.html#unix">Unix</a>
+    <a title="Program Interface: MagickCore" href="../www/magick-core.html">MagickCore</a>
 </div>
 <div class="sub">
-    <a href="../www/install-source.html#windows">Windows</a>
- </div>
-<div class="menu">
-  <a href="../www/binary-releases.html">Binary Releases</a>
+    <a title="Program Interface: PerlMagick" href="../www/perl-magick.html">PerlMagick</a>
 </div>
 <div class="sub">
-    <a href="../www/binary-releases.html#unix">Unix</a>
+    <a title="Program Interface: Magick++" href="../Magick++/">Magick++</a>
+</div>
+<div class="sep"></div>\r
+<div  class="menu">
+   <a title="Install from Source" href="../www/install-source.html">Install from Source</a>
 </div>
 <div class="sub">
-    <a href="../www/binary-releases.html#macosx">Mac OS X</a>
+    <a title="Install from Source: Unix" href="../www/install-source.html#unix">Unix</a>
 </div>
 <div class="sub">
-    <a href="../www/binary-releases.html#windows">Windows</a>
+    <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 href="../www/resources.html">Resources</a>
+  <a title="Architecture" href="../www/architecture.html">Architecture</a>
 </div>
-<div class="sep"></div>\r
 <div class="menu">
-  <a href="../www/download.html">Download</a>
+  <a title="Download" href="../www/download.html">Download</a>
 </div>
 <div class="sep"></div>\r
 <div class="menu">
-  <a href="http://www.imagemagick.org/script/search.php">Search</a>
+  <a title="Search" href="http://www.imagemagick.org/script/search.php">Search</a>
 </div>
 <div class="sep"></div>\r
 <div class="menu">
-  <a href="../www/sitemap.html">Site Map</a>
+  <a title="Site Map"href="../www/sitemap.html">Site Map</a>
 </div>
 <div  class="sub">
-    <a href="../www/links.html">Links</a>
+    <a title="Site Map: Links"href="../www/links.html">Links</a>
 </div>
 <div class="sep"></div>\r
 <div  class="menu">
-  <a href="../www/sponsors.html">Sponsors:</a>
+  <a title="Sponsors" href="../www/sponsors.html">Sponsors:</a>
 
 <div class="sponsbox">
 <div  class="sponsor">
-   <a href="http://www.abi-stoff.de/abizeitung/" title="Abibuch">Abizeitung</a><!-- 20101101000200 -->
+   <a title="Sponsor: Free Catalogs" href="http://www.who-sells-it.com/">Free Catalogs</a><!-- 20120801000600 -->
 </div>
 <div  class="sponsor">
-  <a href="http://www.deko.net">Deko.net</a><!-- 201101010600 Peterssen-->
+  <a title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 -->
 </div>
 <div  class="sponsor">
-  <a href="http://www.tomsgutscheine.de">Tom's Gutscheine</a><!-- 201005010360 invendio.de-->
+  <a title="Sponsor: Image Converter" href="http://www.batchphoto.com">Image Converter</a><!-- 201103010900 Bits Coffee-->
 </div>
 <div  class="sponsor">
-  <a href="http://www.online-kredit-index.de">Kredit</a><!-- 201007010120 Buchhorn -->
+  <a title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
 </div>
 <div  class="sponsor">
-  <a href="http://www.blumenversender.com">Blumenversand</a><!-- 201005010120 -->
+  <a title="Sponsor: Webdesign Agentur" href="http://www.ventzke-partner.de">Webdesign Agentur</a><!-- 201101010480 invendio.de-->
 </div>
 <div  class="sponsor">
-  <a href="http://www.print24.de/">Druckerei</a><!-- 201009010720 -->
+  <a title="Sponsor: LVM Versicherung" href="http://www.neu-reich.de">LVM Versicherung</a><!-- 201101010480 -->
 </div>
 <div  class="sponsor">
-   <a href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012011200 allesdruck.de-->
+  <a title="Sponsor: Diamonds are a Girls Best Friend" href="http://www.schmuck.org">Diamonds are a Girls Best Friend</a><!-- 201101010600 Peterssen-->
 </div>
 </div>
 </div>
+</div>\r
 \r
-\r
+<div class="eastbar">\r
+  <script type="text/javascript">\r
+  <!--\r
+    google_ad_client = "pub-3129977114552745";\r
+    google_ad_slot = "0574824969";\r
+    google_ad_width = 160;\r
+    google_ad_height = 600;\r
+  //-->\r
+  </script>\r
+  <script type="text/javascript"\r
+    src="http://pagead2.googlesyndication.com/pagead/show_ads.js">\r
+  </script>\r
 </div>\r
 \r
 <div class="main">\r
   <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-view.html">Pixel View 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>
 </li>
 
 <p>After you write your MagickWand program, compile it like this:</p>
 
-<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>cc `MagickWand-config --cflags --cppflags` -o wand wand.c  \ <br/> `MagickWand-config --ldflags --libs`</span></p>
+<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>
 <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">
@@ -192,7 +208,7 @@ int main(int argc,char **argv)
     severity; \
  \
   description=MagickGetException(wand,&amp;severity); \
-  (void) fprintf(stderr,"%s %s %lu %s\n",GetMagickModule(),description); \
+  (void) fprintf(stderr,"%s %s %u %s\n",GetMagickModule(),description); \
   description=(char *) MagickRelinquishMemory(description); \
   exit(-1); \
 }
@@ -347,7 +363,7 @@ int main(int argc,char **argv)
 }
 </pre>
 </div>
-<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>
+<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">
@@ -356,13 +372,16 @@ int main(int argc,char **argv)
 #include &lt;math.h>
 #include &lt;wand/MagickWand.h>
 
-static MagickBooleanType SigmoidalContrast(PixelView *pixel_view,
-  void *context)
+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;
 
@@ -372,8 +391,9 @@ static MagickBooleanType SigmoidalContrast(PixelView *pixel_view,
   register long
     x;
 
-  pixels=GetPixelViewPixels(contrast_view);
-  for (x=0; x &lt; (long) GetPixelViewWidth(contrast_view); x++)
+  extent=GetWandViewExtent(contrast_view);
+  pixels=GetWandViewPixels(contrast_view);
+  for (x=0; x &lt; (long) (extent.width-extent.height); x++)
   {
     PixelGetMagickColor(pixels[x],&amp;pixel);
     pixel.red=SigmoidalContrast(pixel.red);
@@ -387,20 +407,27 @@ static MagickBooleanType SigmoidalContrast(PixelView *pixel_view,
 
 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) \
 { \
-  char \
-    *description; \
- \
-  ExceptionType \
-    severity; \
- \
-  description=MagickGetException(wand,&amp;severity); \
+  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;
 
@@ -410,7 +437,7 @@ int main(int argc,char **argv)
   MagickWand
     *contrast_wand;
 
-  PixelView
+  WandView
     *contrast_view;
 
   if (argc != 3)
@@ -429,13 +456,13 @@ int main(int argc,char **argv)
   /*
     Sigmoidal non-linearity contrast control.
   */
-  contrast_view=NewPixelView(contrast_wand);
-  if (contrast_view == (PixelView *) NULL)
+  contrast_view=NewWandView(contrast_wand);
+  if (contrast_view == (WandView *) NULL)
     ThrowWandException(contrast_wand);
-  status=UpdatePixelViewIterator(contrast_view,SigmoidalContrast,(void *) NULL);
+  status=UpdateWandViewIterator(contrast_view,SigmoidalContrast,(void *) NULL);
   if (status == MagickFalse)
     ThrowWandException(contrast_wand);
-  contrast_view=DestroyPixelView(contrast_view);
+  contrast_view=DestroyWandView(contrast_view);
   /*
     Write the image then destroy it.
   */
@@ -452,10 +479,10 @@ int main(int argc,char **argv)
 </div>\r
 \r
 <div id="linkbar">\r
<!--    <span id="linkbar-west">&nbsp;</span>  -->\r
   <span id="linkbar-west">&nbsp;</span>\r
     <span id="linkbar-center">\r
       <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;\r
-    <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>\r
+      <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>\r
     </span>\r
     <span id="linkbar-east">&nbsp;</span>\r
   </div>\r
@@ -464,5 +491,16 @@ int main(int argc,char **argv)
     <span id="footer-east"> <a href="http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>\r
   </div>\r
   <div style="clear: both; margin: 0; width: 100%; "></div>\r
+  <script type="text/javascript">\r
+    var _gaq = _gaq || [];\r
+    _gaq.push(['_setAccount', 'UA-17690367-1']);\r
+    _gaq.push(['_trackPageview']);\r
+\r
+    (function() {\r
+      var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;\r
+      ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';\r
+      var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);\r
+    })();\r
+  </script>\r
 </body>\r
 </html>\r