Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ImageMagick / 29f2c97f63e6f5a9158d6ea44dc512e3fc70747e / . / www / fx.html
blob: ec76eba202141ad8f4b64c26535b9f848317565a [file] [log] [blame]
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]1<!DOCTYPE html>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2<html lang="en">
cristyad41c0c2012-10-31 00:49:28 +0000[diff] [blame]3<head>
cristy29f2c972015-07-28 13:37:46 +0000[diff] [blame^]4 <title>ImageMagick: The Fx Special Effects Image Operator</title>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]5 <meta http-equiv="content-type" content="text/html; charset=utf-8">
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]6 <meta name="application-name" content="ImageMagick">
7 <meta name="description" content="ImageMagick® is a software suite to create, edit, compose, or convert bitmap images. It can read and write images in a variety of formats (over 200) including PNG, JPEG, JPEG-2000, GIF, WebP, Postscript, PDF, and SVG. Use ImageMagick to resize, flip, mirror, rotate, distort, shear and transform images, adjust image colors, apply various special effects, or draw text, lines, polygons, ellipses and Bézier curves.">
8 <meta name="application-url" content="http://www.imagemagick.org">
9 <meta name="generator" content="PHP">
10 <meta name="keywords" content="the, fx, special, effects, image, operator, ImageMagick, PerlMagick, image processing, image, photo, software, Magick++, OpenMP, convert">
11 <meta name="rating" content="GENERAL">
12 <meta name="robots" content="INDEX, FOLLOW">
13 <meta name="generator" content="ImageMagick Studio LLC">
14 <meta name="author" content="ImageMagick Studio LLC">
15 <meta name="revisit-after" content="2 DAYS">
16 <meta name="resource-type" content="document">
cristy2f563d42015-05-06 23:36:51 +0000[diff] [blame]17 <meta name="copyright" content="Copyright (c) 1999-2015 ImageMagick Studio LLC">
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]18 <meta name="distribution" content="Global">
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]19 <meta name="magick-serial" content="P131-S030410-R485315270133-P82224-A6668-G1245-1">
cristy29f2c972015-07-28 13:37:46 +0000[diff] [blame^]20 <link href="../images/wand.png" rel="icon">
21 <link href="../images/wand.ico" type="images/x-icon" rel="shortcut icon">
22 <link href="../css/magick.html" rel="stylesheet">
cristyad41c0c2012-10-31 00:49:28 +0000[diff] [blame]23</head>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]24<body>
cristyad41c0c2012-10-31 00:49:28 +0000[diff] [blame]25<div class="main">
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]26<div class="magick-masthead">
27 <div class="container">
cristy29f2c972015-07-28 13:37:46 +0000[diff] [blame^]28 <script async src="http://localhost/pagead/js/adsbygoogle.js"></script>
29 <ins class="adsbygoogle" style="display:block" data-ad-client="ca-pub-3129977114552745" data-ad-slot="6345125851" data-ad-format="auto"></ins>
30 <script>
31 (adsbygoogle = window.adsbygoogle || []).push({});
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]32 </script>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]33 <nav class="magick-nav">
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]34 <a class="magick-nav-item " href="../index.html">Home</a>
cristyea2793e2015-05-31 16:52:26 +0000[diff] [blame]35 <a class="magick-nav-item " href="binary-releases.html">Download</a>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]36 <a class="magick-nav-item " href="command-line-tools.html">Tools</a>
37 <a class="magick-nav-item " href="command-line-options.html">Options</a>
cristyea2793e2015-05-31 16:52:26 +0000[diff] [blame]38 <a class="magick-nav-item " href="resources.html">Resources</a>
39 <a class="magick-nav-item " href="api.html">Develop</a>
cristy5b8fe762015-06-09 16:24:03 +0000[diff] [blame]40 <a class="magick-nav-item " href="http://nextgen.imagemagick.org/script/search.php">Search</a>
cristya1890f02015-05-15 23:32:44 +0000[diff] [blame]41 <a class="magick-nav-item pull-right" href="http://www.imagemagick.org/discourse-server/">Community</a>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]42 </nav>
43 </div>
44</div>
45<div class="container">
46<div class="magick-header">
47<p class="text-center"><a href="fx.html#fx">The Fx Special Effects Image Operator</a> • <a href="fx.html#anatomy">The Anatomy of an Fx Expression</a></p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]48
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]49<a id="fx"></a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]50
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]51<p class="lead magick-description">Use the Fx special effects image operator to apply a mathematical expression to an image or image channels. Use Fx to:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]52
53<ul>
54 <li>create canvases, gradients, mathematical colormaps</li>
55 <li>move color values between images and channels</li>
56 <li>translate, flip, mirror, rotate, scale, shear and generally distort images</li>
57 <li>merge or composite multiple images together</li>
58 <li>convolve or merge neighboring pixels together</li>
59 <li>generate image metrics or 'fingerprints'</li>
60</ul>
61
62<p>The expression can be simple:</p>
63
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]64<pre>
65convert -size 64x64 canvas:black -channel blue -fx "1/2" fx_navy.png
66</pre>
67
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]68<p>Here, we convert a black to a navy blue image:</p>
69
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]70<ul>
71 <a href="../images/black.png"><img src="../images/black.png" width="64" height="64" alt="black"></a>
72 <img style="margin-top:22px; margin-bottom:22px;" src="../images/right.gif" width="20" height="20" alt="==&gt;">
73 <a href="../images/navy.png"><img src="../images/navy.png" width="64" height="64" alt="navy"></a>
74</ul>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]75
76<p>Or the expression can be complex:</p>
77
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]78<pre>
79convert rose.jpg \
80 -fx "(1.0/(1.0+exp(10.0*(0.5-u)))-0.006693)*1.0092503" \
81 rose-sigmoidal.png'
82</pre>
83
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]84<p>This expression results in a high contrast version of the image:</p>
85
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]86<ul>
87 <a href="../images/rose.jpg"><img src="../images/rose.jpg" width="70" height="46" alt="rose"></a>
88 <img style="margin-top:13px; margin-bottom:13px;" src="../images/right.gif" width="20" height="20" alt="==&gt;">
89 <a href="../images/rose-sigmoidal.png"><img src="../images/rose-sigmoidal.png" width="70" height="46" alt="rose-sigmoidal"></a>
90</ul>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]91
92<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>
93
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]94<pre>
95convert -size 70x70 canvas: \
cristya1890f02015-05-15 23:32:44 +0000[diff] [blame]96 -fx "Xi=i-w/2; Yj=j-h/2; 1.2*(0.5-hypot(Xi,Yj)/70.0)+0.5"
97 radial-gradient.png'
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]98</pre>
99
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]100<p>The command above returns this image:</p>
101
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]102<ul>
103 <a href="../images/radial-gradient.png"><img src="../images/radial-gradient.png" width="70" height="70" alt="radial-gradient"></a>
104</ul>
cristye9a32c32011-04-07 01:11:05 +0000[diff] [blame]105
106<p>This FX expression adds random noise to an image:</p>
107
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]108<pre>
109convert photo.jpg -fx \'iso=32; rone=rand(); rtwo=rand(); \
110 myn=sqrt(-2*ln(rone))*cos(2*Pi*rtwo); myntwo=sqrt(-2*ln(rtwo))* \
111 cos(2*Pi*rone); pnoise=sqrt(p)*myn*sqrt(iso)* \
112 channel(4.28,3.86,6.68,0)/255; max(0,p+pnoise)\' noisy.png
113</pre>
114
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]115<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>
116
117<p>The next section discusses the Fx expression language.</p>
118
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]119<h2 class="magick-header"><a id="anatomy"></a>The Anatomy of an Fx Expression</h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]120
121<h3>The Fx Expression Language</h3>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]122
123<p>The formal Fx expression language is defined here:</p>
124
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]125<dl class="dl-horizontal">
126 <dt> numbers:</dt>
cristyeed6cb62012-01-28 19:38:34 +0000[diff] [blame]127 <dd> integer, floating point, scientfic notation (+/- required, e.g. 3.81469e-06), International System number postfixes (.e.g KB, Mib, GB, etc.)</dd>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]128 <dt> constants: </dt>
cristyeed6cb62012-01-28 19:38:34 +0000[diff] [blame]129 <dd> E (Euler's number), Epsilon, QuantumRange, QuantumScale, Opaque, Phi (golden ratio), Pi, Transparent</dd>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]130 <dt> Fx operators (in order of precedence): </dt>
cristyd92fed52010-10-25 13:48:19 +0000[diff] [blame]131 <dd> ^ (power), unary -, *, /, % (modulo), +, -,
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]132 &lt;&lt;, &gt;&gt;, &lt;, &lt;=, &gt;, &gt;=, ==, !=,
133 &amp; (bitwise AND), | (bitwise OR),
134 &amp;&amp; (logical AND), || (logical OR),
135 ~ (logical NOT), ?: (ternary conditional)</dd>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]136 <dt> math functions: </dt>
cristy37b3d442015-02-28 14:00:30 +0000[diff] [blame]137 <dd> abs(), acos(), acosh(), airy(), alt(), asin(), asinh(), atan(), atanh(), atan2(), ceil(), clamp(), 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>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]138 <dt> channel functions: </dt>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]139 <dd> channel(r,g,b,a), channel(c,m,y,k,a)</dd>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]140 <dt> color names:</dt>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]141 <dd> red, cyan, black, etc.</dd>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]142 <dt> color functions:</dt>
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]143 <dd> srgb(), srgba(), rgb(), rgba(), cmyk(), cmyka(), hsl(), hsla(), etc.</dd>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]144 <dt> color hex values:</dt>
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]145 <dd> #ccc, #cbfed0, #b9e1cc00, etc.</dd>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]146 <dt> symbols:</dt><dd><dl>
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]147 </dl><li><code>u</code>=&gt; first image in list</li>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]148 <li><code>v</code>=&gt; second image in list</li>
149 <li><code>s</code>=&gt; current image in list (for %[fx:] otherwise = u)</li>
150 <li><code>t</code>=&gt; index of current image (s) in list</li>
151 <li><code>n</code>=&gt; number of images in list</li>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]152
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]153 <li><code>i</code>=&gt; column offset</li>
154 <li><code>j</code>=&gt; row offset</li>
155 <li><code>p</code>=&gt; pixel to use (absolute or relative to current pixel)</li>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]156
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]157 <li><code>w</code>=&gt; width of this image</li>
158 <li><code>h</code>=&gt; height of this image</li>
159 <li><code>z</code>=&gt; channel depth</li>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]160
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]161 <li><code>r</code>=&gt; red value (from RGBA), of a specific or current pixel</li>
162 <li><code>g</code>=&gt; green ''</li>
163 <li><code>b</code>=&gt; blue ''</li>
164 <li><code>a</code>=&gt; alpha ''</li>
165 <li><code>o</code>=&gt; opacity ''</li>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]166
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]167 <li><code>c</code>=&gt; cyan value of CMYK color of pixel</li>
168 <li><code>y</code>=&gt; yellow ''</li>
169 <li><code>m</code>=&gt; magenta ''</li>
170 <li><code>k</code>=&gt; black ''</li>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]171
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]172 <li><code>intensity</code>=&gt; pixel intensity</li>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]173
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]174 <li><code>hue</code>=&gt; pixel hue</li>
175 <li><code>saturation</code>=&gt; pixel saturation</li>
176 <li><code>lightness</code>=&gt; pixel lightness</li>
177 <li><code>luma</code>=&gt; pixel luma</li>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]178
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]179 <li><code>page.width</code>=&gt; page width</li>
180 <li><code>page.height</code>=&gt; page height</li>
181 <li><code>page.x</code>=&gt; page x offset</li>
182 <li><code>page.y</code>=&gt; page y offset</li>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]183
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]184 <li><code>resolution.x</code>=&gt; x resolution</li>
185 <li><code>resolution.y</code>=&gt; y resolution</li>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]186
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]187 <li><code>depth</code>=&gt; image depth</li>
188 <li><code>minima</code>=&gt; image minima</li>
189 <li><code>maxima</code>=&gt; image maxima</li>
190 <li><code>mean</code>=&gt; image mean</li>
191 <li><code>standard_deviation</code>=&gt; image standard deviation</li>
192 <li><code>kurtosis</code>=&gt; image kurtosis</li>
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]193 <li><code>skewness</code>=&gt; image skewness (add a channel specifier to compute a statistic for that channel, e.g. depth.r)</li></dd></dl>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]194 <dt> iterators:</dt>
cristyeed6cb62012-01-28 19:38:34 +0000[diff] [blame]195 <dd> while()</dd>
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]196
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]197
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]198
199<h3>The Fx Expression</h3>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]200
201<p>An Fx expression may include any combination of the following:</p>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]202<dl class="dl-horizontal">
203<dt> <var>x</var> <code>^</code> <var>y</var></dt><dd> exponentiation (<var>x<sup>y</sup></var>)</dd>
204<dt> <code>(</code> ... <code>)</code></dt><dd> grouping</dd>
205<dt> <var>x</var> <code>*</code> <var>y</var></dt><dd> multiplication (the asterisk <code>*</code> is optional, for example, <code>2u</code> or <code>2(x+y)</code> are acceptable)</dd>
206<dt> <var>x</var> <code>/</code> <var>y</var></dt><dd> division</dd>
207<dt> <var>x</var> <code>%</code> <var>y</var></dt><dd> modulo</dd>
208<dt> <var>x</var> <code>+</code> <var>y</var></dt><dd> addition</dd>
209<dt> <var>x</var> <code>-</code> <var>y</var></dt><dd> subtraction</dd>
210<dt> <var>x</var> <code>&lt;&lt;</code> <var>y</var></dt><dd> left shift</dd>
211<dt> <var>x</var> <code>&gt;&gt;</code> <var>y</var></dt><dd> right shift</dd>
212<dt> <var>x</var> <code>&lt;</code> <var>y</var></dt><dd> boolean relation, return value 1.0 if <var>x</var> &lt; <var>y</var>, otherwise 0.0</dd>
213<dt> <var>x</var> <code>&lt;=</code> <var>y</var></dt><dd> boolean relation, return value 1.0 if <var>x</var> &lt;= <var>y</var>, otherwise 0.0</dd>
214<dt> <var>x</var> <code>&gt;</code> <var>y</var></dt><dd> boolean relation, return value 1.0 if <var>x</var> &gt; <var>y</var>, otherwise 0.0</dd>
215<dt> <var>x</var> <code>&gt;=</code> <var>y</var></dt><dd> boolean relation, return value 1.0 if <var>x</var> &gt;= <var>y</var>, otherwise 0.0</dd>
216<dt> <var>x</var> <code>==</code> <var>y</var></dt><dd> boolean relation, return value 1.0 if <var>x </var>==<var> y</var>, otherwise 0.0</dd>
217<dt> <var>x</var> <code>!=</code> <var>y</var></dt><dd> boolean relation, return value 1.0 if <var>x </var>!=<var> y</var>, otherwise 0.0</dd>
218<dt> <var>x</var> <code>&amp;</code> <var>y</var></dt><dd> binary AND</dd>
219<dt> <var>x</var> <code>|</code> <var>y</var></dt><dd> binary OR</dd>
220<dt> <var>x</var> <code>&amp;&amp;</code> <var>y</var></dt><dd> logical AND connective, return value 1.0 if <var>x</var> &gt; 0 and <var>y</var> &gt; 0, otherwise 0.0</dd>
221<dt> <var>x</var> <code>||</code> <var>y</var></dt><dd> logical OR connective (inclusive), return value 1.0 if <var>x</var> &gt; 0 or <var>y</var> &gt; 0 (or both), otherwise 0.0</dd>
222<dt> <code>~</code><var>x</var></dt><dd> logical NOT operator, return value 1.0 if <var>not</var> <var>x</var> &gt; 0, otherwise 0.0</dd>
223<dt> <code>+</code><var>x</var></dt><dd> unary plus, return 1.0*value</dd>
224<dt> <code>-</code><var>x</var></dt><dd> unary minus, return -1.0*value</dd>
225<dt> <var>x</var> <code>?</code> <var>y</var> </dt><dd><var>z</var>: ternary conditional expression, return value <var>y</var> if <var>x</var> != 0, otherwise <var>z</var>; only one ternary conditional permitted per statement</dd>
226<dt> <var>x</var> <code>=</code> <var>y</var></dt><dd>assignment; assignment variables are restricted to letter combinations only (e.g. Xi not X1)</dd>
227<dt> <var>x</var> <code>;</code> <var>y</var></dt><dd>statement separator </dd>
228<dt> <code>phi</code></dt><dd> constant (1.618034...)</dd>
229<dt> <code>pi</code></dt><dd> constant (3.141659...)</dd>
230<dt> <code>e</code></dt><dd> constant (2.71828...)</dd>
231<dt> <code>QuantumRange</code></dt><dd> constant maximum pixel value (255 for Q8, 65535 for Q16)</dd>
232<dt> <code>QuantumScale</code></dt><dd> constant 1.0/<code>QuantumRange</code></dd>
233<dt> <code>intensity</code></dt><dd> pixel intensity; equivalent to 0.299*red+0.587*green+0.114*blue</dd>
234<dt> <code>hue</code></dt><dd> pixel hue</dd>
235<dt> <code>saturation</code></dt><dd> pixel saturation</dd>
236<dt> <code>lightness</code></dt><dd> pixel lightness; equivalent to 0.5*max(red,green,blue) + 0.5*min(red,green,blue)</dd>
237<dt> <code>luminance</code></dt><dd> pixel luminance; equivalent to 0.212656*red + 0.715158*green + 0.072186*blue</dd>
238<dt> <code>red, green, blue</code>, etc.</dt><dd> color names</dd>
239<dt> <code>#ccc, #cbfed0, #b9e1cc00</code>, etc.</dt><dd> color hex values</dd>
240<dt> <code>rgb(), rgba(), cmyk(), cmyka(), hsl(), hsla()</code></dt><dd> color functions</dd>
241<dt> <code>s, t, u, v, n, i, j, w, h, z, r, g, b, a, o, c, y, m, k</code></dt><dd> symbols</dd>
242<dt> <code>abs(</code><var>x</var><code>)</code></dt><dd> absolute value function</dd>
243<dt> <code>acos(</code><var>x</var><code>)</code></dt><dd> arc cosine function</dd>
244<dt> <code>acosh(</code><var>x</var><code>)</code></dt><dd> inverse hyperbolic cosine function</dd>
245<dt> <code>airy(</code><var>x</var><code>)</code></dt><dd> Airy function (max=1, min=0); airy(<var>x</var>)=[jinc(<var>x</var>)]<sup>2</sup>=[2*j1(<var>pi*x</var>)/(<var>pi*x</var>)]<sup>2</sup></dd>
246<dt> <code>alt(</code><var>x</var><code>)</code></dt><dd> sign alternation function (return 1.0 if int(<var>x</var>) is even, -1.0 if int(<var>x</var>) is odd)</dd>
247<dt> <code>asin(</code><var>x</var><code>)</code></dt><dd> arc sine function</dd>
248<dt> <code>asinh(</code><var>x</var><code>)</code></dt><dd> inverse hyperbolic sine function</dd>
249<dt> <code>atan(</code><var>x</var><code>)</code></dt><dd> arc tangent function</dd>
250<dt> <code>atanh(</code><var>x</var><code>)</code></dt><dd> inverse hyperbolic tangent function</dd>
cristy29f2c972015-07-28 13:37:46 +0000[diff] [blame^]251<dt> <code>atan2(</code><var>x</var>,<var>y</var><code>)</code></dt><dd> arc tangent function of two variables</dd>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]252<dt> <code>ceil(</code><var>x</var><code>)</code></dt><dd>smallest integral value not less than argument</dd>
253<dt> <code>channel(</code><var>r</var>,<var>g</var>,<var>b</var>,<var>a</var><code>)</code></dt><dd>select numeric argument based on current channel</dd>
254<dt> <code>channel(</code><var>c</var>,<var>m</var>,<var>y</var>,<var>k</var>,<var>a</var><code>)</code></dt><dd>select numeric argument based on current channel</dd>
255<dt> <code>clamp(</code><var>x</var><code>)</code></dt><dd> clamp value</dd>
256<dt> <code>cos(</code><var>x</var><code>)</code></dt><dd> cosine function</dd>
257<dt> <code>cosh(</code><var>x</var><code>)</code></dt><dd> hyperbolic cosine function</dd>
258<dt> <code>debug(</code><var>x</var><code>)</code></dt><dd> print <var>x</var> (useful for debugging your expression)</dd>
259<dt> <code>drc(</code><var>x</var>,<var>y</var><code>)</code></dt><dd> dynamic range compression (knee curve); drc(<var>x</var>,<var>y</var>)=(<var>x</var>)/(<var>y</var>*(<var>x</var>-1)+1); -1&lt;<var>y</var>&lt;1 </dd>
260<dt> <code>exp(</code><var>x</var><code>)</code></dt><dd> natural exponential function (<var>e<sup>x</sup></var>)</dd>
261<dt> <code>floor(</code><var>x</var><code>)</code></dt><dd> largest integral value not greater than argument</dd>
262<dt> <code>gauss(</code><var>x</var><code>)</code></dt><dd> gaussian function; gauss(<var>x</var>)=exp(<var>-x*x/2</var>)/sqrt(2*pi)</dd>
263<dt> <code>gcd(</code><var>x</var>,<var>y</var><code>)</code></dt><dd> greatest common denominator</dd>
264<dt> <code>hypot(</code><var>x</var>,<var>y</var><code>)</code></dt><dd> the square root of x<sup>2</sup>+y<sup>2</sup></dd>
265<dt> <code>int(</code><var>x</var><code>)</code></dt><dd> greatest integer function (return greatest integer less than or equal to <var>x</var>)</dd>
266<dt> <code>isnan(</code><var>x</var><code>)</code></dt><dd>return 1.0 if <var>x</var> is NAN, 0.0 otherwise</dd>
267<dt> <code>j0(</code><var>x</var><code>)</code></dt><dd> Bessel functions of <var>x</var> of the first kind of order 0</dd>
268<dt> <code>j1(</code><var>x</var><code>)</code></dt><dd> Bessel functions of <var>x</var> of the first kind of order 1</dd>
269<dt> <code>jinc(</code><var>x</var><code>)</code></dt><dd> jinc function (max=1, min=-0.1323); jinc(<var>x</var>)=2*j1(pi*<var>x</var>)/(pi*<var>*x</var>)</dd>
270<dt> <code>ln(</code><var>x</var><code>)</code></dt><dd> natural logarithm function</dd>
271<dt> <code>log(</code><var>x</var><code>)</code></dt><dd> logarithm base 10</dd>
272<dt> <code>logtwo(</code><var>x</var><code>)</code></dt><dd> logarithm base 2</dd>
273<dt> <code>ln(</code><var>x</var><code>)</code></dt><dd> natural logarithm</dd>
274<dt> <code>max(</code><var>x</var>, <var>y</var><code>)</code></dt><dd> maximum of <var>x</var> and <var>y</var></dd>
275<dt> <code>min(</code><var>x</var>, <var>y</var><code>)</code></dt><dd> minimum of <var>x</var> and <var>y</var></dd>
276<dt> <code>mod(</code><var>x</var>, <var>y</var><code>)</code></dt><dd> floating-point remainder function</dd>
277<dt> <code>not(</code><var>x</var><code>)</code></dt><dd> return 1.0 if <var>x</var> is zero, 0.0 otherwise</dd>
278<dt> <code>pow(</code><var>x</var>,<var>y</var><code>)</code></dt><dd> power function (<var>x<sup>y</sup></var>)</dd>
279<dt> <code>rand()</code></dt><dd> value uniformly distributed over the interval [0.0, 1.0) with a 2 to the 128th-1 period</dd>
280<dt> <code>round()</code></dt><dd> round to integral value, regardless of rounding direction</dd>
281<dt> <code>sign(</code><var>x</var><code>)</code></dt><dd> return -1.0 if <var>x</var> is less than 0.0 otherwise 1.0</dd>
282<dt> <code>sin(</code><var>x</var><code>)</code></dt><dd> sine function</dd>
283<dt> <code>sinc(</code><var>x</var><code>)</code></dt><dd> sinc function (max=1, min=-0.21); sinc(<var>x</var>)=sin(<var>pi*x</var>)/(<var>pi*x</var>)</dd>
284<dt> <code>squish(</code><var>x</var><code>)</code></dt><dd> squish function; squish(<var>x</var>)=1.0/(1.0+exp(<var>-x</var>))</dd>
285<dt> <code>sinh(</code><var>x</var><code>)</code></dt><dd> hyperbolic sine function</dd>
286<dt> <code>sqrt(</code><var>x</var><code>)</code></dt><dd> square root function</dd>
287<dt> <code>tan(</code><var>x</var><code>)</code></dt><dd> tangent function</dd>
288<dt> <code>tanh(</code><var>x</var><code>)</code></dt><dd> hyperbolic tangent function</dd>
289<dt> <code>trunc(</code><var>x</var><code>)</code></dt><dd> round to integer, towards zero</dd>
290<dt> <code>while(</code><var>condition</var>,<var>expression</var><code>)</code></dt><dd> interate while the condition is not equal to 0</dd>
291</dl>
292<br>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]293<p>The expression semantics include these rules:</p>
294
295<ul>
296<li>symbols are case insensitive</li>
297<li>only one ternary conditional (e.g. x ? y : z) per statement</li>
298<li>statements are assignments or the final expression to return</li>
299<li>an assignment starts a statement, it is not an operator</li>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]300<li>assignments to built-ins do not throw an exception and have no effect; e.g. <code>r=3.0; r</code> returns the pixel red color value, not 3.0</li>
cristyb7b531e2010-10-24 01:41:05 +0000[diff] [blame]301<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>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]302<li>Similarly, care must be exercised when using the slash ('/') symbol. The string of characters <var>1/2x</var> 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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]303</ul>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]304<br>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]305
cristyce66ab12010-10-21 23:36:32 +0000[diff] [blame]306
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]307<h3>Source Images</h3>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]308
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]309<p>The symbols <code>u</code> and <code>v</code> 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 <code>u</code>), with a zero index for the beginning of the sequence. A negative index counts from the end. For example, <code>u[0]</code> is the first image in the sequence, <code>u[2]</code> is the third, <code>u[-1]</code> is the last image, and <code>u[t]</code> is the current image. The current image can also be referenced by <code>s</code>. If the sequence number exceeds the length of the sequence, the count is wrapped. Thus in a 3-image sequence, <code>u[-1]</code>, <code>u[2]</code>, and <code>u[5]</code> all refer to the same (third) image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]310
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]311<p>As an example, we form an image by averaging the first image and third images (the second (index 1) image is ignored and just junked):</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]312
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]313<pre>
314convert image1.jpg image2.jpg image3.jpg -fx "(u+u[2])/2.0" image.jpg
315</pre>
316
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]317<p>By default, the image to which <code>p</code>, <code>r</code>, <code>g</code>, <code>b</code>, <code>a</code>, etc., are applied is the current image <code>s</code> in the image list. This is equivelent to <code>u</code> except when used in an escape sequence <code>%[fx:...]</code>. </p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]318
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]319<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="command-line-options.html#channel">-channel red</a> instructs <a href="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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]320
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]321<pre>
322convert -channel red logo: -flop logo: -resize "20%" -fx "(u+v)/2" image.jpg
323</pre>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]324
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]325<ul>
326 <a href="../images/logo-sm-flop.png"><img src="../images/logo-sm-flop.png" width="128" height="96" alt="logo-sm-flop.png"></a>
327 <a href="../images/logo-sm.png"><img src="../images/logo-sm.png" width="128" height="96" alt="logo-sm.png"></a>
328<img style="margin-top:38px; margin-bottom:38px;" src="../images/right.gif" width="20" height="20" alt="==&gt;">
329 <a href="../images/logo-sm-fx.png"><img src="../images/logo-sm-fx.png" width="128" height="96" alt="logo-sm-fx.png"></a>
330</ul>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]331
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]332<br>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]333<h3>Accessing Pixels</h3>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]334
335<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>
336
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]337<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 <code>p</code>. For example,</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]338
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]339<pre>
cristya1890f02015-05-15 23:32:44 +0000[diff] [blame]340p[-1].g green value of pixel to the immediate left of the current pixel
341p[-1,-1].r red value of the pixel diagonally left and up from current pixel
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]342</pre>
343
344<p>To specify an absolute position, use braces, rather than brackets.</p>
345
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]346<pre>
cristya1890f02015-05-15 23:32:44 +0000[diff] [blame]347p{0,0}.r red value of the pixel in the upper left corner of the image
348p{12,34}.b blue pixel value at column number 12, row 34 of the image
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]349</pre>
350
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]351<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="command-line-options.html#interpolate">-interpolate</a> setting.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]352
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]353<p>A position outside the boundary of the image retrieves a value dictated by the <a href="command-line-options.html#virtual-pixel">-virtual-pixel</a> option setting.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]354
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]355<h3>Apply an Expression to Select Image Channels</h3>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]356
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]357<p>Use the <a href="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 <code>alpha.png</code> with the average of the green channels from the images <code>alpha.png</code> and <code>beta.png</code>, use:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]358
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]359<pre>
360convert alpha.png beta.png -channel red -fx "(u.g+v.g)/2" gamma.png
361</pre>
362
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]363
364<h3>Results</h3>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]365
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]366<p>The <a href="command-line-options.html#fx">-fx</a> operator evaluates the given expression for each channel (set by <a href="command-line-options.html#channel">-channel</a>) of each pixel in the first image (<code>u</code>) 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 <code>alpha.png</code> replaces both of the original images, <code>alpha.png</code> and <code>beta.png</code>, before being saved as <code>gamma.png</code>.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]367
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]368<p>The current image <code>s</code> is set to the first image in the sequence (<code>u</code>), and <code>t</code> to its index, 0. The symbols <code>i</code> and <code>j</code> reference the current pixel being processed.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]369
370
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]371<p>For use with <a href="command-line-options.html#format_identify_">-format</a>, the value-escape <code>%[fx:]</code> is evaluated just once for each image in the current image sequence. As each image in the sequence is being evaluated, <code>s</code> and <code>t</code> successively refer to the current image and its index, while <code>i</code> and <code>j</code> are set to zero, and the current channel set to red (<a href="command-line-options.html#channel">-channel</a> is ignored). An example:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]372
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]373<pre>
374convert canvas:'rgb(25%,50%,75%)' rose: -colorspace rgb \
375 -format 'Red channel of NW corner of image #%[fx:t] is %[fx:s]' info:
376Red channel of NW corner of image #0 is 0.453758
377Red channel of NW corner of image #1 is 0.184588
378</pre>
cristy3cd7cc92011-04-01 01:00:28 +0000[diff] [blame]379
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]380<p>Here we use the image indexes to <var>rotate</var> each image differently, and use <code>-set</code> with the image index to set a different <var>pause delay</var> on the first image in the animation:</p>
381
382<pre>
383convert rose: -duplicate 29 -virtual-pixel Gray -distort SRT '%[fx:360.0*t/n]' \
384 -set delay '%[fx:t == 0 ? 240 : 10]' -loop 0 rose.gif"
385</pre>
386
387<p>The color-escape <code>%[pixel:]</code> is evaluated once per image and per color channel in that image (<a href="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 <code>i</code> and <code>j</code> are set to zero, and <code>s</code> and <code>t</code> refer to each successively current image and index.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]388
389</div>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]390 <footer class="magick-footer">
cristy29f2c972015-07-28 13:37:46 +0000[diff] [blame^]391 <p><a href="support.html">Donate</a> •
392 <a href="sitemap.html">Sitemap</a> •
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]393 <a href="links.html">Related</a> •
cristy29f2c972015-07-28 13:37:46 +0000[diff] [blame^]394 <a href="architecture.html">Architecture</a>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]395</p>
396 <p><a href="fx.html#">Back to top</a> •
cristyea2793e2015-05-31 16:52:26 +0000[diff] [blame]397 <a href="http://pgp.mit.edu:11371/pks/lookup?op=get&amp;search=0x89AB63D48277377A">Public Key</a> •
cristy5b8fe762015-06-09 16:24:03 +0000[diff] [blame]398 <a href="http://nextgen.imagemagick.org/script/contact.php">Contact Us</a></p>
cristya1890f02015-05-15 23:32:44 +0000[diff] [blame]399 <p><small>© 1999-2015 ImageMagick Studio LLC</small></p>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]400 </footer>
401</div><!-- /.container -->
cristyad41c0c2012-10-31 00:49:28 +0000[diff] [blame]402
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]403 <script src="https://localhost/ajax/libs/jquery/1.11.2/jquery.min.js"></script>
cristy29f2c972015-07-28 13:37:46 +0000[diff] [blame^]404 <script src="http://nextgen.imagemagick.org/js/magick.html"></script>
cristyad41c0c2012-10-31 00:49:28 +0000[diff] [blame]405</div>
cristyad41c0c2012-10-31 00:49:28 +0000[diff] [blame]406</body>
cristy5a367e42015-05-05 12:39:18 +0000[diff] [blame]407</html>