<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Applies a function on the image</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="imagick.frameimage.html">Imagick::frameImage</a></div>
<div class="next" style="text-align: right; float: right;"><a href="imagick.fximage.html">Imagick::fxImage</a></div>
<div class="up"><a href="class.imagick.html">Imagick</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="imagick.functionimage" class="refentry">
<div class="refnamediv">
<h1 class="refname">Imagick::functionImage</h1>
<p class="verinfo">(No version information available, might only be in Git)</p><p class="refpurpose"><span class="refname">Imagick::functionImage</span> — <span class="dc-title">Applies a function on the image</span></p>
</div>
<div class="refsect1 description" id="refsect1-imagick.functionimage-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><strong>Imagick::functionImage</strong></span>
( <span class="methodparam"><span class="type">int</span> <code class="parameter">$function</code></span>
, <span class="methodparam"><span class="type">array</span> <code class="parameter">$arguments</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$channel</code><span class="initializer"> = Imagick::CHANNEL_DEFAULT</span></span>
] )</div>
<p class="para rdfs-comment">
Applies an arithmetic, relational, or logical expression to a pseudo image.
</p>
<p class="para">
See also <a href="http://www.imagemagick.org/Usage/transform/#function" class="link external">» ImageMagick
v6 Examples - Image Transformations — Function, Multi-Argument Evaluate</a>
</p>
<p class="para">
This method is available if Imagick has been compiled against ImageMagick version 6.4.9 or newer.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-imagick.functionimage-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<code class="parameter">function</code></dt>
<dd>
<p class="para">
Refer to this list of <a href="imagick.constants.html#imagick.constants.function" class="link">function constants</a>
</p>
</dd>
<dt>
<code class="parameter">arguments</code></dt>
<dd>
<p class="para">
Array of arguments to pass to this function.
</p>
</dd>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-imagick.functionimage-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <strong><code>TRUE</code></strong> on success.
</p>
</div>
<div class="refsect1 errors" id="refsect1-imagick.functionimage-errors">
<h3 class="title">Errors/Exceptions</h3>
<p class="para">
Throws ImagickException on error.
</p>
</div>
<div class="refsect1 examples" id="refsect1-imagick.functionimage-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-3918">
<p><strong>Example #1 Create a sinusoidal gradient</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$imagick </span><span style="color: #007700">= new </span><span style="color: #0000BB">Imagick</span><span style="color: #007700">();<br /></span><span style="color: #0000BB">$imagick</span><span style="color: #007700">-></span><span style="color: #0000BB">newPseudoImage</span><span style="color: #007700">(</span><span style="color: #0000BB">200</span><span style="color: #007700">, </span><span style="color: #0000BB">200</span><span style="color: #007700">, </span><span style="color: #DD0000">'gradient:black-white'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$arguments </span><span style="color: #007700">= array(</span><span style="color: #0000BB">3</span><span style="color: #007700">, -</span><span style="color: #0000BB">90</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$imagick</span><span style="color: #007700">-></span><span style="color: #0000BB">functionImage</span><span style="color: #007700">(</span><span style="color: #0000BB">Imagick</span><span style="color: #007700">::</span><span style="color: #0000BB">FUNCTION_SINUSOID</span><span style="color: #007700">, </span><span style="color: #0000BB">$arguments</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">header</span><span style="color: #007700">(</span><span style="color: #DD0000">"Content-Type: image/png"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$imagick</span><span style="color: #007700">-></span><span style="color: #0000BB">setImageFormat</span><span style="color: #007700">(</span><span style="color: #DD0000">"png"</span><span style="color: #007700">);<br />echo </span><span style="color: #0000BB">$imagick</span><span style="color: #007700">-></span><span style="color: #0000BB">getImageBlob</span><span style="color: #007700">();<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
<div class="example-contents"><p>The above example will output
something similar to:</p></div>
<div class="mediaobject">
<div class="imageobject">
<img src="images/c0d23d2d6769e53e24a1b3136c064577-functionImage_sinusoidal.png" alt="Output of create a sinusoidal gradient" width="200" height="200" />
</div>
</div>
</div>
<div class="example" id="example-3919">
<p><strong>Example #2 Create a gradient from the polynomial (4x^2 - 4x + 1) </strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$imagick </span><span style="color: #007700">= new </span><span style="color: #0000BB">Imagick</span><span style="color: #007700">();<br /></span><span style="color: #0000BB">$imagick</span><span style="color: #007700">-></span><span style="color: #0000BB">newPseudoImage</span><span style="color: #007700">(</span><span style="color: #0000BB">200</span><span style="color: #007700">, </span><span style="color: #0000BB">200</span><span style="color: #007700">, </span><span style="color: #DD0000">'gradient:black-white'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$arguments </span><span style="color: #007700">= array(</span><span style="color: #0000BB">4</span><span style="color: #007700">, -</span><span style="color: #0000BB">4</span><span style="color: #007700">, </span><span style="color: #0000BB">1</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$imagick</span><span style="color: #007700">-></span><span style="color: #0000BB">functionImage</span><span style="color: #007700">(</span><span style="color: #0000BB">Imagick</span><span style="color: #007700">::</span><span style="color: #0000BB">FUNCTION_POLYNOMIAL</span><span style="color: #007700">, </span><span style="color: #0000BB">$arguments</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">header</span><span style="color: #007700">(</span><span style="color: #DD0000">"Content-Type: image/png"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$imagick</span><span style="color: #007700">-></span><span style="color: #0000BB">setimageformat</span><span style="color: #007700">(</span><span style="color: #DD0000">"png"</span><span style="color: #007700">);<br />echo </span><span style="color: #0000BB">$imagick</span><span style="color: #007700">-></span><span style="color: #0000BB">getImageBlob</span><span style="color: #007700">();<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
<div class="example-contents"><p>The above example will output
something similar to:</p></div>
<div class="mediaobject">
<div class="imageobject">
<img src="images/c0d23d2d6769e53e24a1b3136c064577-functionImage_polynomial.png" alt="Output of create a polynomial gradient" width="200" height="200" />
</div>
</div>
</div>
<div class="example" id="example-3920">
<p><strong>Example #3 Create a complex gradient from the polynomial (4x^2 - 4x^2 + 1) modulated by a sinusoidal gradient </strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$imagick1 </span><span style="color: #007700">= new </span><span style="color: #0000BB">Imagick</span><span style="color: #007700">();<br /></span><span style="color: #0000BB">$imagick1</span><span style="color: #007700">-></span><span style="color: #0000BB">newPseudoImage</span><span style="color: #007700">(</span><span style="color: #0000BB">200</span><span style="color: #007700">, </span><span style="color: #0000BB">200</span><span style="color: #007700">, </span><span style="color: #DD0000">'gradient:black-white'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$arguments </span><span style="color: #007700">= array(</span><span style="color: #0000BB">9</span><span style="color: #007700">, -</span><span style="color: #0000BB">90</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$imagick1</span><span style="color: #007700">-></span><span style="color: #0000BB">functionImage</span><span style="color: #007700">(</span><span style="color: #0000BB">Imagick</span><span style="color: #007700">::</span><span style="color: #0000BB">FUNCTION_SINUSOID</span><span style="color: #007700">, </span><span style="color: #0000BB">$arguments</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$imagick2 </span><span style="color: #007700">= new </span><span style="color: #0000BB">Imagick</span><span style="color: #007700">();<br /></span><span style="color: #0000BB">$imagick2</span><span style="color: #007700">-></span><span style="color: #0000BB">newPseudoImage</span><span style="color: #007700">(</span><span style="color: #0000BB">200</span><span style="color: #007700">, </span><span style="color: #0000BB">200</span><span style="color: #007700">, </span><span style="color: #DD0000">'gradient:black-white'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$arguments </span><span style="color: #007700">= array(</span><span style="color: #0000BB">0.5</span><span style="color: #007700">, </span><span style="color: #0000BB">0</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$imagick2</span><span style="color: #007700">-></span><span style="color: #0000BB">functionImage</span><span style="color: #007700">(</span><span style="color: #0000BB">Imagick</span><span style="color: #007700">::</span><span style="color: #0000BB">FUNCTION_SINUSOID</span><span style="color: #007700">, </span><span style="color: #0000BB">$arguments</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$imagick1</span><span style="color: #007700">-></span><span style="color: #0000BB">compositeimage</span><span style="color: #007700">(</span><span style="color: #0000BB">$imagick2</span><span style="color: #007700">, </span><span style="color: #0000BB">Imagick</span><span style="color: #007700">::</span><span style="color: #0000BB">COMPOSITE_MULTIPLY</span><span style="color: #007700">, </span><span style="color: #0000BB">0</span><span style="color: #007700">, </span><span style="color: #0000BB">0</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">header</span><span style="color: #007700">(</span><span style="color: #DD0000">"Content-Type: image/png"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$imagick1</span><span style="color: #007700">-></span><span style="color: #0000BB">setImageFormat</span><span style="color: #007700">(</span><span style="color: #DD0000">"png"</span><span style="color: #007700">);<br />echo </span><span style="color: #0000BB">$imagick1</span><span style="color: #007700">-></span><span style="color: #0000BB">getImageBlob</span><span style="color: #007700">();<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
<div class="example-contents"><p>The above example will output
something similar to:</p></div>
<div class="mediaobject">
<div class="imageobject">
<img src="images/c0d23d2d6769e53e24a1b3136c064577-functionImage_multiplied.png" alt="Output of create complex gradient" width="200" height="200" />
</div>
</div>
</div>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="imagick.frameimage.html">Imagick::frameImage</a></div>
<div class="next" style="text-align: right; float: right;"><a href="imagick.fximage.html">Imagick::fxImage</a></div>
<div class="up"><a href="class.imagick.html">Imagick</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
