]> granicus.if.org Git - imagemagick/blob - www/fx.html
(no commit message)
[imagemagick] / www / fx.html
1 \r
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" \r
3   "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">\r
4 <html version="-//W3C//DTD XHTML 1.1//EN"\r
5       xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"\r
6       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"\r
7       xsi:schemaLocation="http://www.w3.org/1999/xhtml\r
8                           http://www.w3.org/MarkUp/SCHEMA/xhtml11.xsd">\r
9 <head>\r
10   <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>\r
11   <meta name="google-site-verification" content="MxsMq6bdLOx0KSuz1MY6yG9ZTIJ7_7DVRfl5NCAT5Yg"/>\r
12   <title>ImageMagick: The Fx Special Effects Image Operator</title>
13   <meta http-equiv="Content-Language" content="en-US"/>
14   <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
15   <meta http-equiv="Reply-to" content="magick-users@imagemagick.org"/>
16   <meta name="Application-name" content="ImageMagick"/>
17   <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 automagically."/>
18   <meta name="Application-url" content="http://www.imagemagick.org"/>
19   <meta name="Generator" content="PHP"/>
20   <meta name="Keywords" content="the, fx, special, effects, image, operator, ImageMagick, PerlMagick, image processing, OpenMP, software development library, image, photo, software, Magick++, MagickWand"/>
21   <meta name="Rating" content="GENERAL"/>
22   <meta name="Robots" content="INDEX, FOLLOW"/>
23   <meta name="Generator" content="ImageMagick Studio LLC"/>
24   <meta name="Author" content="ImageMagick Studio LLC"/>
25   <meta name="Revisit-after" content="2 DAYS"/>
26   <meta name="Resource-type" content="document"/>
27   <meta name="Copyright" content="Copyright (c) 1999-2012 ImageMagick Studio LLC"/>
28   <meta name="Distribution" content="Global"/>
29   <link rel="icon" href="../images/wand.png"/>
30   <link rel="shortcut icon" href="../images/wand.ico"  type="images/x-icon"/>
31   <link rel="canonical" href="http://www.imagemagick.org" />\r
32   <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf"/>\r
33   <!-- Add jQuery library -->\r
34   <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.7/jquery.min.js"></script>\r
35   \r
36   <!-- Optionaly include easing and/or mousewheel plugins -->\r
37   <script type="text/javascript" src="http://www.imagemagick.org/fancybox/jquery.easing-1.3.pack.js"></script>\r
38   <script type="text/javascript" src="http://www.imagemagick.org/fancybox/jquery.mousewheel-3.0.6.pack.js"></script>\r
39   \r
40   <!-- Add fancyBox -->\r
41   <link rel="stylesheet" href="http://www.imagemagick.org/fancybox/jquery.fancybox.css?v=2.0.3" type="text/css" media="screen" />\r
42   <script type="text/javascript" src="http://www.imagemagick.org/fancybox/jquery.fancybox.pack.js?v=2.0.3"></script>\r
43   \r
44   <!-- Optionaly include button and/or thumbnail helpers -->\r
45   <link rel="stylesheet" href="http://www.imagemagick.org/fancybox/helpers/jquery.fancybox-buttons.css?v=2.0.3" type="text/css" media="screen" />\r
46   <script type="text/javascript" src="http://www.imagemagick.org/fancybox/helpers/jquery.fancybox-buttons.js?v=2.0.3"></script>\r
47   \r
48   <link rel="stylesheet" href="http://www.imagemagick.org/fancybox/helpers/jquery.fancybox-thumbs.css?v=2.0.3" type="text/css" media="screen" />\r
49   <script type="text/javascript" src="http://www.imagemagick.org/fancybox/helpers/jquery.fancybox-thumbs.js?v=2.0.3"></script>\r
50   <script type="text/javascript">\r
51         $(document).ready(function() {\r
52                 $(".fancybox").fancybox();\r
53         });\r
54   </script>\r
55   <!-- ImageMagick style -->\r
56   <link rel="stylesheet" href="http://www.google.com/cse/style/look/default.css" type="text/css" />\r
57   <style type="text/css" media="all">\r
58     @import url("../www/magick.css");\r
59   </style>\r
60 </head>\r
61 \r
62 <body id="www-imagemagick-org">\r
63 <div class="titlebar">\r
64 <div style="margin: 17px auto; float: left;">\r
65   <script type="text/javascript">\r
66   <!--\r
67     google_ad_client = "pub-3129977114552745";\r
68     google_ad_slot = "5439289906";\r
69     google_ad_width = 728;\r
70     google_ad_height = 90;\r
71   //-->\r
72   </script>\r
73   <script type="text/javascript"\r
74     src="http://pagead2.googlesyndication.com/pagead/show_ads.js">\r
75   </script>\r
76 </div>\r
77 <a href="http://www.imagemagick.org/discourse-server/">\r
78   <img src="../images/logo.jpg"\r
79   alt="ImageMagick Logo"\r
80   style="width: 123px; height: 118px; border: 0px; float: right;" /></a>\r
81 <a href="../index.html">\r
82   <img src="../images/sprite.jpg"\r
83   alt="ImageMagick Sprite"\r
84   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
85 </div>\r
86 \r
87 <div class="westbar">\r
88 \r
89 <div class="menu">
90   <a title="About ImageMagick" href="../index.html">About ImageMagick</a>
91 </div>
92 <div class="menu">
93   <a title="Binary Releases" href="../www/binary-releases.html">Binary Releases</a>
94 </div>
95 <div class="sub">
96     <a title="Binary Release: Unix" href="../www/binary-releases.html#unix">Unix</a>
97 </div>
98 <div class="sub">
99     <a title="Binary Release: MacOS X" href="../www/binary-releases.html#macosx">Mac OS X</a>
100 </div>
101 <div class="sub">
102     <a title="Binary Release: iOS" href="../www/binary-releases.html#iOS">iOS</a>
103 </div>
104 <div class="sub">
105     <a title="Binary Release: Windows" href="../www/binary-releases.html#windows">Windows</a>
106 </div>
107 <div class="sep"></div>\r
108 <div class="menu">
109   <a title="Command-line Tools" href="../www/command-line-tools.html">Command-line Tools</a>
110 </div>
111 <div class="sub">
112     <a title="Command-line Tools: Processing" href="../www/command-line-processing.html">Processing</a>
113 </div>
114 <div class="sub">
115     <a title="Command-line Tools: Options" href="../www/command-line-options.html">Options</a>
116 </div>
117 <div class="sub">
118     <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
119 </div>
120 <div class="menu">
121   <a title="Program Interfaces" href="../www/api.html">Program Interfaces</a>
122 </div>
123 <div class="sub">
124     <a title="Program Interface: MagickWand" href="../www/magick-wand.html">MagickWand</a>
125 </div>
126 <div class="sub">
127     <a title="Program Interface: MagickCore" href="../www/magick-core.html">MagickCore</a>
128 </div>
129 <div class="sub">
130     <a title="Program Interface: PerlMagick" href="../www/perl-magick.html">PerlMagick</a>
131 </div>
132 <div class="sub">
133     <a title="Program Interface: Magick++" href="../www/magick++.html">Magick++</a>
134 </div>
135 <div class="sep"></div>\r
136 <div  class="menu">
137    <a title="Install from Source" href="../www/install-source.html">Install from Source</a>
138 </div>
139 <div class="sub">
140     <a title="Install from Source: Unix" href="../www/install-source.html#unix">Unix</a>
141 </div>
142 <div class="sub">
143     <a title="Install from Source: Windows" href="../www/install-source.html#windows">Windows</a>
144  </div>
145 <div class="menu">
146   <a title="Resources" href="../www/resources.html">Resources</a>
147 </div>
148 <div class="menu">
149   <a title="Architecture" href="../www/architecture.html">Architecture</a>
150 </div>
151 <div class="menu">
152   <a title="Download" href="../www/download.html">Download</a>
153 </div>
154 <div class="sep"></div>\r
155 <div class="menu">
156   <a title="Search" href="../www/search.html">Search</a>
157 </div>
158 <div class="sep"></div>\r
159 <div class="menu">
160   <a title="Site Map" href="../www/sitemap.html">Site Map</a>
161 </div>
162 <div  class="sub">
163   <a title="Site Map: Links" href="../www/links.html">Links</a>
164 </div>
165 <div class="sep"></div>\r
166 <div class="menu">
167   <a rel="follow" title="Sponsors" href="../www/sponsors.html">Sponsors:</a>
168
169   <a href="http://www.networkredux.com"> <img src="../images/networkredux.png" width="140" height="31" alt="[sponsor]" style="margin-top: 4px; margin-left: 4px; border: 0px; float: left;" /></a>
170   <a href="http://www.dinodirect.com/ipads-tablets/"> <img src="../images/dino-direct.jpg" width="140" height="90" alt="[sponsor]" style="margin-top: 4px; margin-left: 4px; border: 0px; float: left;" /></a><!-- 201204010120 mickey@163... -->
171 <div class="sponsbox">
172 <div class="sponsor">
173   <a rel="follow" title="Android Tablet" href="http://www.dinodirect.com/ipads-tablets/">Android Tablet</a><!-- 201204010120 mickey@163... -->
174 </div>
175 <div class="sponsor">
176   <a rel="follow" title="Sponsor: Web Hosting" href="http://www.micfo.com">Web Hosting</a><!-- 209901010090s golestan -->
177 </div>
178 <div class="sponsor">
179   <a rel="follow" title="Sponsor: Autos Part" href="http://www.pkwteile.de/autoteile">Autos Part</a><!-- 201203010270 info@pkwte... -->
180 </div>
181 <div class="sponsor">
182   <a rel="follow" title="Sponsor: Web Site Hosting" href="http://webhostinggeeks.com">Web Site Hosting</a><!-- 201302010900 funds@enmob... -->
183 </div>
184 <div class="sponsor">
185   <a rel="follow" title="Sponsor: Tenant Check" href="http://www.rentmethod.com/">Tenant Check</a><!-- 201203010090 chris@rentm... -->
186 </div>
187 <div class="sponsor">
188   <a rel="follow" title="Sponsor: VPS" href="http://www.interdominios.com/vps">VPS</a><!-- 201204010090 barsh@inter... -->
189 </div>
190 <div class="sponsor">
191    <a rel="follow" title="Sponsor: Premium Quality Stock Photos" href="http://www.f1online.pro/en/">Premium Quality Stock Photos</a><!-- 2012080100540 ... -->
192 </div>
193 <div class="sponsor">
194   <a rel="follow" title="Sponsor: Search engine optimisation" href="http://www.seomoves.com.au">Search engine optimisation</a><!-- 201301010090s jen@seo lowprofilelinks -->
195 </div>
196 <div class="sponsor">
197    <a rel="follow" title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 2012070100250 ... -->
198 </div>
199 <div class="sponsor">
200   <a rel="follow" title="Sponsor: Managed Server" href="http://www.robhost.de">Managed Server</a><!-- 201210010720 klikics... -->
201 </div>
202 <div class="sponsor">
203    <a rel="follow" title="Sponsor: Stock Photography" href="http://www.fotosearch.com/">Stock Photography</a><!-- 2012040100250 ... -->
204 </div>
205 <div class="sponsor">
206   <a rel="follow" title="Sponsor: Autoteile" href="http://www.q11-shop.de">Autoteile</a><!-- 201205010540 suvalj -->
207 </div>
208 <div class="sponsor">
209    <a rel="follow" title="Sponsor: Royalty Free Stock Images" href="http://www.canstockphoto.com/">Royalty Free Stock Images</a><!-- 2012050100360 support@can -->
210 </div>
211 <div class="sponsor">
212   <a rel="follow" title="Sponsor: Web Hosting Reviews" href="http://www.webhostingsecretrevealed.com">Web Hosting Secret Revealed</a><!-- 201204010540 iamchee jerry -->
213 </div>
214 <div class="sponsor">
215   <a rel="follow" title="Sponsor: Druckerei" href="http://www.allesdruck.de">Druckerei</a><!-- 201303011500 r.leo -->
216 </div>
217 <div class="sponsor">
218    <a rel="follow" title="Sponsor: Free Catalogs" href="http://www.who-sells-it.com/">Free Catalogs</a><!-- 20120801000600 -->
219 </div>
220 <div class="sponsor">
221    <a rel="follow" title="Sponsor: Best Web Hosting" href="http://www.webhostingclue.com">Best Web Hosting</a><!-- 2012030100300 accounting@webhostingclue -->
222 </div>
223 </div>
224 </div>
225 </div>\r
226 \r
227 <div class="eastbar">\r
228   <div class="g-plusone" data-size="standard" data-count="false"></div>\r
229   <script type="text/javascript">\r
230     window.___gcfg = {\r
231       lang: 'en-US'\r
232     };\r
233 \r
234     (function() {\r
235       var po = document.createElement('script'); po.type = 'text/javascript'; po.async = true;\r
236       po.src = 'https://apis.google.com/js/plusone.js';\r
237       var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(po, s);\r
238     })();\r
239   </script>\r
240 </div>\r
241 \r
242 <div class="main">\r
243 \r
244 <h1>Apply Special Effects to an Image with an Fx Expression</h1>
245 <p class="navigation-index">[<a href="#fx">The Fx Special Effects Image Operator</a> &bull; <a href="#anatomy">The Anatomy of an Fx Expression</a>]</p>
246
247 <a id="fx"></a>
248 <div class="doc-section">
249
250 <p>Use the Fx special effects image operator to apply a mathematical expression to an image or image channels.  Use Fx to:</p>
251
252 <ul>
253   <li>create canvases, gradients, mathematical colormaps</li>
254   <li>move color values between images and channels</li>
255   <li>translate, flip, mirror, rotate, scale, shear and generally distort images</li>
256   <li>merge or composite multiple images together</li>
257   <li>convolve or merge neighboring pixels together</li>
258   <li>generate image metrics or 'fingerprints'</li>
259 </ul>
260
261 <p>The expression can be simple:</p>
262
263 <p class='crt'><span class="crtprompt"> $ </span><span class='crtin'>convert -size 64x64 canvas:black -channel blue -fx "1/2" fx_navy.png</span></p>
264 <p>Here, we convert a black to a navy blue image:</p>
265
266 <p class="image">
267   <a href="../images/black.png"><img src="../images/black.png" width="64" height="64" alt="black" /></a>
268   <img style="margin-top:22px; margin-bottom:22px;" src="../images/right.gif" width="20" height="20" alt="==>" />
269   <a href="../images/navy.png"><img src="../images/navy.png" width="64" height="64" alt="navy" /></a>
270 </p>
271
272 <p>Or the expression can be complex:</p>
273
274 <p class='crt'><span class="crtprompt"> $ </span><span class='crtin'>convert rose.jpg \  <br/>
275           -fx "(1.0/(1.0+exp(10.0*(0.5-u)))-0.006693)*1.0092503" \ <br/>
276           rose-sigmoidal.png</span></p>
277 <p>This expression results in a high contrast version of the image:</p>
278
279 <p class="image">
280   <a href="../images/rose.jpg"><img src="../images/rose.jpg" width="70" height="46" alt="rose" /></a>
281   <img style="margin-top:13px; margin-bottom:13px;" src="../images/right.gif" width="20" height="20" alt="==>" />
282   <a href="../images/rose-sigmoidal.png"><img src="../images/rose-sigmoidal.png" width="70" height="46" alt="rose-sigmoidal" /></a>
283 </p>
284
285 <p>The expression can include variable assignments.  Assignments, in most cases, reduce the complexity of an expression and permit some operations that might not be possible any other way.  For example, lets create a radial gradient:</p>
286
287 <p class='crt'><span class="crtprompt"> $ </span><span class='crtin'>convert -size 70x70 canvas: \  <br/>
288           -fx "Xi=i-w/2; Yj=j-h/2; 1.2*(0.5-hypot(Xi,Yj)/70.0)+0.5" \ <br/>
289           radial-gradient.png</span></p>
290 <p>The command above returns this image:</p>
291
292 <p class="image">
293   <a href="../images/radial-gradient.png"><img src="../images/radial-gradient.png" width="70" height="70" alt="radial-gradient" /></a>
294 </p>
295
296 <p>This FX expression adds random noise to an image:</p>
297
298 <p class='crt'><span class="crtprompt"> $ </span><span class='crtin'>convert photo.jpg -fx 'iso=32; rone=rand(); rtwo=rand(); \<br />
299      myn=sqrt(-2*ln(rone))*cos(2*Pi*rtwo); myntwo=sqrt(-2*ln(rtwo))* \<br />
300      cos(2*Pi*rone); pnoise=sqrt(p)*myn*sqrt(iso)* \ <br />
301      channel(4.28,3.86,6.68,0)/255; max(0,p+pnoise)' noisy.png</span></p>
302 <p>See <a href="http://www.imagemagick.org/Usage/transform/index.html#fx">Using FX, The Special Effects Image Operator</a> for more examples.</p>
303
304 <p>The next section discusses the Fx expression language.</p>
305
306 </div>
307
308 <h2><a id="anatomy"></a>The Anatomy of an Fx Expression</h2>
309 <div class="doc-section">
310
311 <h3>The Fx Expression Language</h3>
312 <div class="doc-section">
313
314 <p>The formal Fx expression language is defined here:</p>
315
316 <dl class="doc">
317   <dt class="doc"> numbers:</dt>
318         <dd> integer, floating point, scientfic notation (+/- required, e.g. 3.81469e-06), International System number postfixes (.e.g KB, Mib, GB, etc.)</dd>
319   <dt class="doc"> constants: </dt>
320     <dd> E (Euler's number), Epsilon, QuantumRange, QuantumScale, Opaque, Phi (golden ratio), Pi, Transparent</dd>
321   <dt class="doc"> Fx operators (in order of precedence): </dt>
322      <dd> ^ (power), unary -, *, /, % (modulo), +, -,
323      &lt;&lt;, &gt;&gt;, &lt;, &lt;=, &gt;, &gt;=, ==, !=,
324      &amp; (bitwise AND),   | (bitwise OR),
325      &amp;&amp; (logical AND),  || (logical OR),
326      ~ (logical NOT),  ?: (ternary conditional)</dd>
327   <dt class="doc"> math functions: </dt>
328      <dd> abs(), acos(), acosh(), airy(), alt(), asin(), asinh(), atan(), atanh(), atan2(), ceil(), cos(), cosh(), debug(), drc(), exp(), floor(), gauss(), gcd(), hypot(), int(), isnan(), j0(), j1(), jinc(), ln(), log(), logtwo(), max(), min(), mod(), not(), pow(), rand(), round(), sign(), sin(), sinc(), sinh(), sqrt(), squish(), tan(), tanh(), trunc()</dd>
329   <dt class="doc"> channel functions: </dt>
330     <dd> channel(r,g,b,a), channel(c,m,y,k,a)</dd>
331   <dt class="doc"> color names:</dt>
332     <dd> red, cyan, black, etc.</dd>
333   <dt class="doc"> color functions:</dt>
334     <dd> rgb(), rgba(), cmyk(), cmyka(), hsl(), hsla()</dd>
335   <dt class="doc"> color hex values:</dt>
336     <dd> #ccc, #cbfed0, #b9e1cc00</dd>
337   <dt class="doc"> symbols:</dt>
338      <dd style="white-space:pre">
339      s = current image in sequence
340      t = scene number of current image in sequence
341      u = first image in sequence
342      v = second image in sequence
343      n = number of images in sequence
344
345      i = column offset
346      j = row offset
347      p = pixel to use (absolute or relative to current pixel)
348
349      w = width of this image
350      h = height of this image
351      z = channel depth
352
353      r = red value (from RGBA), of a specific or current pixel
354      g = green    ''
355      b = blue     ''
356      a = alpha    ''
357      o = opacity  ''
358
359      c = cyan value of CMYK color of pixel
360      y = yellow   ''
361      m = magenta  ''
362      k = black    ''
363
364      intensity = pixel intensity
365
366      hue = pixel hue
367      saturation = pixel saturation
368      lightness = pixel lightness
369      luminance = pixel luminance
370
371      page.width = page width
372      page.height = page height
373      page.x = page x offset
374      page.y = page y offset
375
376      resolution.x = x resolution
377      resolution.y = y resolution
378
379      depth = image depth
380      minima = image minima
381      maxima = image maxima
382      mean = image mean
383      standard_deviation = image standard deviation
384      kurtosis = image kurtosis
385      skewness = image skewness
386        (add a channel specifier to compute a statistic for that channel, e.g. depth.r)
387      </dd>
388   <dt class="doc"> iterators:</dt>
389     <dd> while()</dd>
390 </dl>
391
392 </div>
393
394 <h3>The Fx Expression</h3>
395 <div class="doc-section">
396
397 <p>An Fx expression may include any combination of the following:</p>
398 <ul>
399 <li> <em>x</em> <kbd>^</kbd> <em>y</em>:  exponentiation (<em>x<sup>y</sup></em>)</li>
400 <li> <kbd>(</kbd> ... <kbd>)</kbd>:  grouping</li>
401 <li> <em>x</em> <kbd>*</kbd> <em>y</em>:  multiplication (the asterisk <kbd>*</kbd> is optional, for example, <kbd>2u</kbd> or <kbd>2(x+y)</kbd> are acceptable)</li>
402 <li> <em>x</em> <kbd>/</kbd> <em>y</em>:  division</li>
403 <li> <em>x</em> <kbd>%</kbd> <em>y</em>:  modulo</li>
404 <li> <em>x</em> <kbd>+</kbd> <em>y</em>:  addition</li>
405 <li> <em>x</em> <kbd>-</kbd> <em>y</em>:  subtraction</li>
406 <li> <em>x</em> <kbd>&lt;&lt;</kbd> <em>y</em>:  left shift</li>
407 <li> <em>x</em> <kbd>&gt;&gt;</kbd> <em>y</em>:  right shift</li>
408 <li> <em>x</em> <kbd>&lt;</kbd> <em>y</em>:  boolean relation, return value 1.0 if <em>x</em> &lt; <em>y</em>,  otherwise 0.0</li>
409 <li> <em>x</em> <kbd>&lt;=</kbd> <em>y</em>:  boolean relation, return value 1.0 if <em>x</em> &lt;= <em>y</em>,  otherwise 0.0</li>
410 <li> <em>x</em> <kbd>&gt;</kbd> <em>y</em>:  boolean relation, return value 1.0 if <em>x</em> &gt; <em>y</em>,  otherwise 0.0</li>
411 <li> <em>x</em> <kbd>&gt;=</kbd> <em>y</em>:  boolean relation, return value 1.0 if <em>x</em> &gt;= <em>y</em>,  otherwise 0.0</li>
412 <li> <em>x</em> <kbd>==</kbd> <em>y</em>:  boolean relation, return value 1.0 if <em>x </em>==<em> y</em>, otherwise 0.0</li>
413 <li> <em>x</em> <kbd>!=</kbd> <em>y</em>:  boolean relation, return value 1.0 if <em>x </em>!=<em> y</em>, otherwise 0.0</li>
414 <li> <em>x</em> <kbd>&amp;</kbd> <em>y</em>:  binary AND</li>
415 <li> <em>x</em> <kbd>|</kbd> <em>y</em>:  binary OR</li>
416 <li> <em>x</em> <kbd>&amp;&amp;</kbd> <em>y</em>:  logical AND connective, return value 1.0 if <em>x</em> &gt; 0 and <em>y</em> &gt; 0,  otherwise 0.0</li>
417 <li> <em>x</em> <kbd>||</kbd> <em>y</em>:  logical OR connective (inclusive), return value 1.0 if <em>x</em> &gt; 0 or <em>y</em> &gt; 0 (or both),  otherwise 0.0</li>
418 <li> <kbd>~</kbd><em>x</em>:  logical NOT operator, return value 1.0 if <em>not</em> <em>x</em> &gt; 0,  otherwise 0.0</li>
419 <li> <kbd>+</kbd><em>x</em>:  unary plus, return 1.0*value</li>
420 <li> <kbd>-</kbd><em>x</em>:  unary minus, return -1.0*value</li>
421 <li> <em>x</em> <kbd>?</kbd> <em>y</em> : <em>z</em>: ternary conditional expression, return value <em>y</em> if <em>x</em> != 0, otherwise <em>z</em>; only one ternary conditional permitted per statement</li>
422 <li> <em>x</em> <kbd>=</kbd> <em>y</em>: assignment; assignment variables are restricted to letter combinations only (e.g. Xi not X1)</li>
423 <li> <em>x</em> <kbd>;</kbd> <em>y</em>: statement separator </li>
424 <li> <kbd>phi</kbd>:  constant (1.618034...)</li>
425 <li> <kbd>pi</kbd>:  constant (3.141659...)</li>
426 <li> <kbd>e</kbd>:  constant (2.71828...)</li>
427 <li> <kbd>QuantumRange</kbd>:  constant maximum pixel value (255 for Q8, 65535 for Q16)</li>
428 <li> <kbd>QuantumScale</kbd>:  constant 1.0/<kbd>QuantumRange</kbd></li>
429 <li> <kbd>intensity</kbd>:  pixel intensity; equivalent to 0.299*red+0.587*green+0.114*blue</li>
430 <li> <kbd>hue</kbd>:  pixel hue</li>
431 <li> <kbd>saturation</kbd>:  pixel saturation</li>
432 <li> <kbd>lightness</kbd>:  pixel lightness; equivalent to 0.5*max(red,green,blue) + 0.5*min(red,green,blue)</li>
433 <li> <kbd>luminance</kbd>:  pixel luminance; equivalent to 0.2126*red + 0.7152*green + 0.0722*blue</li>
434 <li> <kbd>red, green, blue</kbd>, etc.:  color names</li>
435 <li> <kbd>#ccc, #cbfed0, #b9e1cc00</kbd>, etc.:  color hex values</li>
436 <li> <kbd>rgb(), rgba(), cmyk(), cmyka(), hsl(), hsla()</kbd>:  color functions</li>
437 <li> <kbd>s, t, u, v, n, i, j, w, h, z, r, g, b, a, o, c, y, m, k</kbd>:  symbols</li>
438 <li> <kbd>abs(</kbd><em>x</em><kbd>)</kbd>:  absolute value function</li>
439 <li> <kbd>acos(</kbd><em>x</em><kbd>)</kbd>:  arc cosine function</li>
440 <li> <kbd>acosh(</kbd><em>x</em><kbd>)</kbd>:  inverse hyperbolic cosine function</li>
441 <li> <kbd>airy(</kbd><em>x</em><kbd>)</kbd>:  Airy function (max=1, min=0); airy(<em>x</em>)=[jinc(<em>x</em>)]<sup>2</sup>=[2*j1(<em>pi*x</em>)/(<em>pi*x</em>)]<sup>2</sup></li>
442 <li> <kbd>alt(</kbd><em>x</em><kbd>)</kbd>:  sign alternation function (return 1.0 if int(<em>x</em>) is even, -1.0 if int(<em>x</em>) is odd)</li>
443 <li> <kbd>asin(</kbd><em>x</em><kbd>)</kbd>:  arc sine function</li>
444 <li> <kbd>asinh(</kbd><em>x</em><kbd>)</kbd>:  inverse hyperbolic sine function</li>
445 <li> <kbd>atan(</kbd><em>x</em><kbd>)</kbd>:  arc tangent function</li>
446 <li> <kbd>atanh(</kbd><em>x</em><kbd>)</kbd>:  inverse hyperbolic tangent function</li>
447 <li> <kbd>atan2(</kbd><em>y</em>,<em>x</em><kbd>)</kbd>:  arc tangent function of two variables</li>
448 <li> <kbd>ceil(</kbd><em>x</em><kbd>)</kbd>: smallest integral value not less than argument</li>
449 <li> <kbd>channel(</kbd><em>r</em>,<em>g</em>,<em>b</em>,<em>a</em><kbd>)</kbd>: select numeric argument based on current channel</li>
450 <li> <kbd>channel(</kbd><em>c</em>,<em>m</em>,<em>y</em>,<em>k</em>,<em>a</em><kbd>)</kbd>: select numeric argument based on current channel</li>
451 <li> <kbd>cos(</kbd><em>x</em><kbd>)</kbd>:  cosine function</li>
452 <li> <kbd>cosh(</kbd><em>x</em><kbd>)</kbd>:  hyperbolic cosine function</li>
453 <li> <kbd>debug(</kbd><em>x</em><kbd>)</kbd>:  print <em>x</em> (useful for debugging your expression)</li>
454 <li> <kbd>drc(</kbd><em>x</em>,<em>y</em><kbd>)</kbd>:  dynamic range compression (knee curve); drc(<em>x</em>,<em>y</em>)=(<em>x</em>)/(<em>y</em>*(<em>x</em>-1)+1); -1&lt;<em>y</em>&lt;1 </li>
455 <li> <kbd>exp(</kbd><em>x</em><kbd>)</kbd>:  natural exponential function (<em>e<sup>x</sup></em>)</li>
456 <li> <kbd>floor(</kbd><em>x</em><kbd>)</kbd>:  largest integral value not greater than argument</li>
457 <li> <kbd>gauss(</kbd><em>x</em><kbd>)</kbd>:  gaussian function; gauss(<em>x</em>)=exp(<em>-x*x/2</em>)/sqrt(2*pi)</li>
458 <li> <kbd>gcd(</kbd><em>x</em>,<em>y</em><kbd>)</kbd>:  greatest common denominator</li>
459 <li> <kbd>hypot(</kbd><em>x</em>,<em>y</em><kbd>)</kbd>:  the square root of x<sup>2</sup>+y<sup>2</sup></li>
460 <li> <kbd>int(</kbd><em>x</em><kbd>)</kbd>:  greatest integer function (return greatest integer less than or equal to <em>x</em>)</li>
461 <li> <kbd>isnan(</kbd><em>x</em><kbd>)</kbd>: return 1.0 if <em>x</em> is NAN, 0.0 otherwise</li>
462 <li> <kbd>j0(</kbd><em>x</em><kbd>)</kbd>:  Bessel functions of <em>x</em> of the first kind of order 0</li>
463 <li> <kbd>j1(</kbd><em>x</em><kbd>)</kbd>:  Bessel functions of <em>x</em> of the first kind of order 1</li>
464 <li> <kbd>jinc(</kbd><em>x</em><kbd>)</kbd>:  jinc function (max=1, min=-0.1323); jinc(<em>x</em>)=2*j1(pi*<em>x</em>)/(pi*<em>*x</em>)</li>
465 <li> <kbd>ln(</kbd><em>x</em><kbd>)</kbd>:  natural logarithm function</li>
466 <li> <kbd>log(</kbd><em>x</em><kbd>)</kbd>:  logarithm base 10</li>
467 <li> <kbd>logtwo(</kbd><em>x</em><kbd>)</kbd>:  logarithm base 2</li>
468 <li> <kbd>ln(</kbd><em>x</em><kbd>)</kbd>:  natural logarithm</li>
469 <li> <kbd>max(</kbd><em>x</em>, <em>y</em><kbd>)</kbd>:  maximum of <em>x</em> and <em>y</em></li>
470 <li> <kbd>min(</kbd><em>x</em>, <em>y</em><kbd>)</kbd>:  minimum of <em>x</em> and <em>y</em></li>
471 <li> <kbd>mod(</kbd><em>x</em>, <em>y</em><kbd>)</kbd>:  floating-point remainder function</li>
472 <li> <kbd>not(</kbd><em>x</em><kbd>)</kbd>:  return 1.0 if <em>x</em> is zero, 0.0 otherwise</li>
473 <li> <kbd>pow(</kbd><em>x</em>,<em>y</em><kbd>)</kbd>:  power function (<em>x<sup>y</sup></em>)</li>
474 <li> <kbd>rand()</kbd>:  value uniformly distributed over the interval [0.0, 1.0) with a 2 to the 128th-1 period</li>
475 <li> <kbd>round()</kbd>:  round to integral value, regardless of rounding direction</li>
476 <li> <kbd>sign(</kbd><em>x</em><kbd>)</kbd>:  return -1.0 if <em>x</em> is less than 0.0 otherwise 1.0</li>
477 <li> <kbd>sin(</kbd><em>x</em><kbd>)</kbd>:  sine function</li>
478 <li> <kbd>sinc(</kbd><em>x</em><kbd>)</kbd>:  sinc function (max=1, min=-0.21); sinc(<em>x</em>)=sin(<em>pi*x</em>)/(<em>pi*x</em>)</li>
479 <li> <kbd>squish(</kbd><em>x</em><kbd>)</kbd>:  squish function; squish(<em>x</em>)=1.0/(1.0+exp(<em>4.0*x</em>))</li>
480 <li> <kbd>sinh(</kbd><em>x</em><kbd>)</kbd>:  hyperbolic sine function</li>
481 <li> <kbd>sqrt(</kbd><em>x</em><kbd>)</kbd>:  square root function</li>
482 <li> <kbd>tan(</kbd><em>x</em><kbd>)</kbd>:  tangent function</li>
483 <li> <kbd>tanh(</kbd><em>x</em><kbd>)</kbd>:  hyperbolic tangent function</li>
484 <li> <kbd>trunc(</kbd><em>x</em><kbd>)</kbd>:  round to integer, towards zero</li>
485 <li> <kbd>while(</kbd><em>condition</em>,<em>expression</em><kbd>)</kbd>:  interate while the condition is not equal to 0</li>
486 </ul>
487
488 <p>The expression semantics include these rules:</p>
489
490 <ul>
491 <li>symbols are case insensitive</li>
492 <li>only one ternary conditional (e.g. x ? y : z) per statement</li>
493 <li>statements are assignments or the final expression to return</li>
494 <li>an assignment starts a statement, it is not an operator</li>
495 <li>assignments to built-ins do not throw an exception and have no effect;  e.g. <kbd>r=3.0; r</kbd> returns the pixel red color value, not 3.0</li>
496 <li>Unary operators have a lower priority than binary operators, that is, the unary minus (negation) has lower precedence than exponentiation, so -3^2 is interpreted as -(3^2) = -9.  Use parentheses to clarify your intent (e.g. (-3)^2 = 9).</li>
497 <li>Similarly, care must be exercised when using the slash ('/') symbol. The string of characters <em>1/2x</em> is interpreted as (1/2)x. The contrary interpretation should be written explicitly as 1/(2x). Again, the use of parentheses helps clarify the meaning and should be used whenever there is any chance of misinterpretation.</li>
498 </ul>
499
500
501 </div>
502
503 <h3>Source Images</h3>
504 <div class="doc-section">
505
506 <p>The symbols <kbd>u</kbd> and <kbd>v</kbd> refer to the first and second images, respectively, in the current image sequence.  Refer to a particular image in a sequence by appending its index to any image reference (usually <kbd>u</kbd>), with a zero index for the beginning of the sequence. A negative index counts from the end.  For example, <kbd>u[0]</kbd> is the first image in the sequence, <kbd>u[2]</kbd> is the third, <kbd>u[-1]</kbd> is the last image, and <kbd>u[t]</kbd> is the current image. The current image can also be referenced by <kbd>s</kbd>. If the sequence number exceeds the length of the sequence, the count is wrapped. Thus in a 3-image sequence,  <kbd>u[-1]</kbd>, <kbd>u[2]</kbd>, and <kbd>u[5]</kbd> all refer to the same (third) image.</p>
507
508 <p>As an example, we form an image by averaging the first image and third images:</p>
509
510 <p class='crt'><span class="crtprompt"> $ </span><span class='crtin'>convert image1.jpg image2.jpg image3.jpg -fx "(u+u[2])/2.0" image.jpg</span></p>
511 <p>By default, the image to which <kbd>p</kbd>, <kbd>r</kbd>, <kbd>g</kbd>, <kbd>b</kbd>, <kbd>a</kbd>, etc., are applied is the first image <kbd>u</kbd> in the image list, which may also be referenced using <kbd>s</kbd>. </p>
512
513 <p>It is important to note the special role played by the first image. This is the only image in the image sequence that is modified, other images are used only for their data. As an illustrative example, consider the following, and note that the setting <a href="../www/command-line-options.html#channel">-channel red</a> instructs <a href="../www/command-line-options.html#fx">-fx</a> to modify only the red channel; nothing in the green or blue channels will change. It is instructive to ponder why the result is not symmetric.</p>
514
515 <p class='crt'><span class="crtprompt"> $ </span><span class='crtin'>convert -channel red logo: -flop logo: -resize "20%"  -fx "(u+v)/2" image.jpg</span></p>
516 <div class="image">
517   <a href="../images/logo-sm-flop.png"><img src="../images/logo-sm-flop.png" width="128" height="96" alt="logo-sm-flop.png" /></a>
518   <a href="../images/logo-sm.png"><img src="../images/logo-sm.png" width="128" height="96" alt="logo-sm.png" /></a>
519 <img style="margin-top:38px; margin-bottom:38px;" src="../images/right.gif" width="20" height="20" alt="==>" />
520   <a href="../images/logo-sm-fx.png"><img src="../images/logo-sm-fx.png" width="128" height="96" alt="logo-sm-fx.png" /></a>
521 </div>
522
523
524 </div>
525
526 <h3>Accessing Pixels</h3>
527 <div class="doc-section">
528
529 <p>All color values are normalized to the range of 0.0 to 1.0.  The alpha channel ranges from 0.0 (fully transparent) to 1.0 (fully opaque).</p>
530
531 <p>The pixels are processed one at a time, but a different pixel of an image can be specified using a pixel index represented by <kbd>p</kbd>. For example,</p>
532
533 <pre class="text">
534    p[-1].g      green value of pixel to the immediate left of the current pixel
535    p[-1,-1].r   red value of the pixel diagonally left and up from current pixel
536 </pre>
537
538 <p>To specify an absolute position, use braces, rather than brackets.</p>
539
540 <pre class="text">
541   p{0,0}.r     red value of the pixel in the upper left corner of the image
542   p{12,34}.b   blue pixel value at column number 12, row 34 of the image
543 </pre>
544
545 <p>Integer values of the position retrieve the color of the pixel referenced, while non-integer position values return a blended color according to the current <a href="../www/command-line-options.html#interpolate">-interpolate</a> setting.</p>
546
547 <p>A position outside the boundary of the image retrieves a value dictated by the <a href="../www/command-line-options.html#virtual-pixel">-virtual-pixel</a> option setting.</p>
548
549 </div>
550
551 <h3>Apply an Expression to Select Image Channels</h3>
552 <div class="doc-section">
553
554 <p>Use the <a href="../www/command-line-options.html#channel">-channel</a> setting to specify the output channel of the result. If no output channel is given, the result is set over all channels except the opacity channel. For example, to replace the red channel of <kbd>alpha.png</kbd> with the average of the green channels from the images <kbd>alpha.png</kbd> and <kbd>beta.png</kbd>, use:</p>
555
556 <p class='crt'><span class="crtprompt"> $ </span><span class='crtin'>convert alpha.png beta.png -channel red -fx "(u.g+v.g)/2" gamma.png</span></p>
557 </div>
558
559 <h3>Results</h3>
560 <div class="doc-section">
561
562 <p>The <a href="../www/command-line-options.html#fx">-fx</a> operator evaluates the given expression for each channel (set by <a href="../www/command-line-options.html#channel">-channel</a>) of each pixel in the first image (<kbd>u</kbd>) in the sequence. The computed values are temporarily stored in a copy (clone) of that first image until all the pixels have been processed, after which this single new image replaces the list of images in the current image sequence.  As such, in the previous example the updated version of <kbd>alpha.png</kbd> replaces both of the original images, <kbd>alpha.png</kbd> and <kbd>beta.png</kbd>, before being saved as <kbd>gamma.png</kbd>.</p>
563
564 <p>The current image <kbd>s</kbd> is set to the first image in the sequence (<kbd>u</kbd>), and <kbd>t</kbd> to its index, 0.  The symbols <kbd>i</kbd> and <kbd>j</kbd> reference the current pixel being processed.</p>
565
566
567 <p>For use with <a href="../www/command-line-options.html#format_identify_">-format</a>, the value-escape <kbd>%[fx: ]</kbd> is evaluated just once for each image in the current image sequence. As each image in the sequence is being evaluated, <kbd>s</kbd> and <kbd>t</kbd> successively refer to the current image and its index, while <kbd>i</kbd> and <kbd>j</kbd> are set to zero, and the current channel set to red (<a href="../www/command-line-options.html#channel">-channel</a> is ignored). An example:</p>
568
569 <p class='crt'><span class="crtprompt"> $ </span><span class='crtin'>convert  canvas:'rgb(25%,50%,75%)' rose: -colorspace rgb  \ <br/>
570   -format 'Red channel of NW corner of image #%[fx:t] is %[fx: s]' info:</span><span class='crtout'>Red channel of NW corner of image #0 is 0.453758 <br/>
571   Red channel of NW corner of image #1 is 0.184588</span></p>
572 <p>Here we use the image indexes to <em>rotate</em> each image differently, and use <kbd>-set</kbd> with the image index to set a different <em>pause delay</em> on the first image in the animation:</p>
573
574 <p class='crt'><span class="crtprompt"> $ </span><span class='crtin'>convert rose: -duplicate 29 -virtual-pixel Gray -distort SRT '%[fx:360.0*t/n]' \ <br />
575     -set delay '%[fx:t == 0 ? 240 : 10]' -loop 0 rose.gif</span></p><p>The color-escape <kbd>%[pixel: ]</kbd> is evaluated once per image and per color channel in that image (<a href="../www/command-line-options.html#channel">-channel</a> is ignored), The values generated are then converted into a color string (a named color or hex color value).  The symbols <kbd>i</kbd> and <kbd>j</kbd> are set to zero, and <kbd>s</kbd> and <kbd>t</kbd> refer to each successively current image and index.</p>
576
577 </div>
578 </div>
579 \r
580 </div>\r
581 \r
582 <div id="linkbar">\r
583     <span id="linkbar-west">&nbsp;</span>\r
584     <span id="linkbar-center">\r
585       <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;\r
586       <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>\r
587     </span>\r
588     <span id="linkbar-east">&nbsp;</span>\r
589   </div>\r
590   <div class="footer">\r
591     <span id="footer-west">&copy; 1999-2011 ImageMagick Studio LLC</span>\r
592     <span id="footer-east"> <a href="http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>\r
593   </div>\r
594   <div style="clear: both; margin: 0; width: 100%; "></div>\r
595   <script type="text/javascript">\r
596     var _gaq = _gaq || [];\r
597     _gaq.push(['_setAccount', 'UA-17690367-1']);\r
598     _gaq.push(['_trackPageview']);\r
599 \r
600     (function() {\r
601       var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;\r
602       ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';\r
603       var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);\r
604     })();\r
605   </script>\r
606 </body>\r
607 </html>\r