Skip to content
Browse files

document Image#function_channel

  • Loading branch information...
1 parent 06883b2 commit fdab272012b47f5327dd85c721b90fbacf8dec99 rmagick committed Sep 15, 2009
Showing with 99 additions and 9 deletions.
  1. +75 −1 doc/image2.html
  2. +4 −1 doc/image3.html
  3. +4 −2 doc/optequiv.html
  4. +16 −5 doc/usage.html
View
76 doc/image2.html
@@ -4,7 +4,7 @@
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta name="generator" content=
- "HTML Tidy for Linux/x86 (vers 6 November 2007), see www.w3.org" />
+ "HTML Tidy for Linux/x86 (vers 7 December 2008), see www.w3.org" />
<title>RMagick 0.0.0: class Image (instance methods e-o)</title>
<meta http-equiv="Content-Type" content=
@@ -113,6 +113,8 @@ <h6 id="header">RMagick 0.0.0 User's Guide and Reference</h6>
<li><a href="#frame">frame</a></li>
<li><a href="#freeze">freeze</a></li>
+
+ <li><a href="#function_channel">function_channel</a></li>
</ul>
</div>
@@ -1073,6 +1075,78 @@ <h3 id="freeze">freeze</h3>
</div>
<div class="sig">
+ <h3 id="function_channel">function_channel</h3>
+
+ <p><span class="arg">img</span>.function_channel(<span class=
+ "arg">function</span> [, <span class=
+ "arg">parameters</span>...][, <span class=
+ "arg">channel</span>...]) -&lt; <em>image</em></p>
+ </div>
+
+ <div class="desc">
+ <h4>Description</h4>
+
+ <p><span class="imquote">Apply a function to channel
+ values.</span> This method is equivalent to the <a href=
+ "http://www.imagemagick.org/script/command-line-options.php#function">
+ convert -function</a> option. See the ImageMagick documentation
+ for more information.</p>
+
+ <h4>Arguments</h4>
+
+ <dl>
+ <dt>function</dt>
+
+ <dd>
+ One of the following values.
+
+ <ul>
+ <li><code>PolynomialFunction</code></li>
+
+ <li><code>SinusoidFunction</code></li>
+
+ <li><code>ArcsinFunction</code></li>
+
+ <li><code>ArctanFunction</code></li>
+ </ul>Some of these values are not available in earlier
+ versions of ImageMagick. To find out which values are
+ available, enter the following statement in irb:
+ <pre>
+Magick::MagickFunction.values {|value| p value}
+</pre>
+ </dd>
+
+ <dt>parameters</dt>
+
+ <dd>One or more floating-point numbers. The number of
+ parameters depends on the function. See the ImageMagick
+ documentation for details.</dd>
+
+ <dt>channel...</dt>
+
+ <dd>0 or more <a href=
+ "constants.html#ChannelType">ChannelType</a> arguments. If no
+ channels are specified, the red, green, and blue channels are
+ used.</dd>
+ </dl>
+
+ <h4>Returns</h4>
+
+ <p>A new image</p>
+
+ <h4>Example</h4>
+ <pre>
+img2 = img.function_channel(Magick::PolynomialFunction,
+ -25, 53, -36, 8.3, 0.2)
+</pre>
+
+ <h4>See also</h4>
+
+ <p><a href=
+ "image3.html#quantum_operator">quantum_operator</a></p>
+ </div>
+
+ <div class="sig">
<h3 id="gamma_channel">gamma_channel</h3>
<p><span class="arg">img</span>.gamma_channel(<span class=
View
5 doc/image3.html
@@ -4,7 +4,7 @@
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta name="generator" content=
- "HTML Tidy for Linux/x86 (vers 6 November 2007), see www.w3.org" />
+ "HTML Tidy for Linux/x86 (vers 7 December 2008), see www.w3.org" />
<title>RMagick 0.0.0: class Image (instance methods p-w)</title>
<meta http-equiv="Content-Type" content=
@@ -920,6 +920,9 @@ <h3 id="quantum_operator">quantum_operator</h3>
<h4>See also</h4>
+ <p><a href=
+ "image2.html#function_channel">function_channel</a></p>
+
<p>The <a href="struct.html#view">Image:View</a> class supports
operations on individual pixels and collections of pixels, as
well as operations on channels within pixels. See <a href=
View
6 doc/optequiv.html
@@ -886,9 +886,11 @@ <h2 class="methods" id="convert">convert, mogrify</h2>
</tr>
<tr>
- <td>-function <em>function parameters</em></td>
+ <td>-function <em>function arguments</em></td>
- <td>No equivalent</td>
+ <td>Image#<a href=
+ "image2.html#function_channel">function_channel</a>(<em>function</em>,
+ <em>arguments</em>)</td>
</tr>
<tr>
View
21 doc/usage.html
@@ -1025,6 +1025,16 @@ <h2 id="modifying">Examining and modifying images</h2>
<dd>Apply a histogram equalization to the image</dd>
<dt><a href=
+ "image2.html#function_channel">function_channel</a></dt>
+
+ <dd>Apply a function to selected channel values</dd>
+
+ <dt class="ilist"><a href="ilist.html#fx">fx</a></dt>
+
+ <dd class="ilist">Apply a mathematical expression to an
+ image</dd>
+
+ <dt><a href=
"image1.html#auto_gamma_channel">auto_gamma_channel</a>,
<a href="image2.html#gamma_correct">gamma_correct</a>,
<a href="image2.html#gamma_channel">gamma_channel</a></dt>
@@ -1067,6 +1077,12 @@ <h2 id="modifying">Examining and modifying images</h2>
<dd>Enhance the contrast of the image</dd>
+ <dt><a href=
+ "image3.html#quantum_operator">quantum_operator</a></dt>
+
+ <dd>Performs an integer arithmetic operation on selected
+ channels values</dd>
+
<dt><a href="image3.html#reduce_noise">reduce_noise</a></dt>
<dd>Smooth the contours of an image while still preserving
@@ -1143,11 +1159,6 @@ <h2 id="modifying">Examining and modifying images</h2>
<dd>Apply a custom convolution kernel to the image</dd>
- <dt class="ilist"><a href="ilist.html#fx">fx</a></dt>
-
- <dd class="ilist">apply a mathematical expression to an
- image</dd>
-
<dt><a href="image3.html#segment">segment</a></dt>
<dd>Segment an image by analyzing the histograms of the color

0 comments on commit fdab272

Please sign in to comment.
Something went wrong with that request. Please try again.