rmagick 1.10.1 → 1.11.0

data/doc/image1.html

@@ -121,13 +121,13 @@ float: left;
           <li><a href="#changed_q">changed?</a></li>
 
           <li><a href="#channel">channel</a></li>
+
+          <li><a href="#channel_depth">channel_depth</a></li>
         </ul>
       </div>
 
       <div class="toccol">
         <ul>
-          <li><a href="#channel_depth">channel_depth</a></li>
-
           <li><a href="#channel_extrema">channel_extrema</a></li>
 
           <li><a href="#channel_mean">channel_mean</a></li>
@@ -163,12 +163,15 @@ float: left;
 
           <li><a href=
           "#compress_colormap_bang">compress_colormap!</a></li>
+
+          <li><a href="#contrast">contrast</a></li>
         </ul>
       </div>
 
       <div class="toccol">
         <ul>
-          <li><a href="#contrast">contrast</a></li>
+          <li><a href=
+          "#contrast_stretch_channel">contrast_stretch_channel</a></li>
 
           <li><a href="#convolve">convolve</a></li>
 
@@ -2321,6 +2324,8 @@ f.colors &raquo; 108
     <h4>See also</h4>
 
     <p><a href=
+    "#contrast_stretch_channel">contrast_stretch_channel</a>,
+    <a href=
     "image3.html#sigmoidal_contrast_channel">sigmoidal_contrast_channel</a></p>
 
     <h4>Magick API</h4>
@@ -2328,10 +2333,70 @@ f.colors &raquo; 108
     <p>ContrastImage</p>
   </div>
 
+  <div class="sig">
+    <h3 id="contrast_stretch_channel">contrast_stretch_channel</h3>
+
+    <p><span class=
+    "arg">image</span>.contrast_stretch_channel(<span class=
+    "arg">black_point</span> [, <span class=
+    "arg">white_point</span>] [, <span class=
+    "arg">channel</span>...]) -&gt; <span class=
+    "arg">anImage</span></p>
+  </div>
+
+  <div class="desc">
+    <h4>Description</h4>
+
+    <p>This method <span class="imquote">is a simple image
+    enhancement technique that attempts to improve the contrast in
+    an image by `stretching' the range of intensity values it
+    contains to span a desired range of values. It differs from the
+    more sophisticated histogram equalization in that it can only
+    apply a linear scaling function to the image pixel values. As a
+    result the `enhancement' is less harsh.</span></p>
+
+    <h4>Arguments</h4>
+
+    <dl>
+      <dt>black_point</dt>
+
+      <dd>black out at most this many pixels. Specify an absolute
+      number of pixels as a numeric value, or a percentage as a
+      string in the form 'NN%'.</dd>
+
+      <dt>white_point</dt>
+
+      <dd>burn at most this many pixels. Specify an absolute number
+      of pixels as a numeric value, or a percentage as a string in
+      the form 'NN%'. This argument is optional. If not specified
+      the default is <code>all pixels - black_point
+      pixels</code>.</dd>
+
+      <dt>channel...</dt>
+
+      <dd>0 or more <a href=
+      "constants.html#ChannelType">ChannelType</a> arguments. If no
+      channels are specified all channels are included.</dd>
+    </dl>
+
+    <h4>Returns</h4>
+
+    <p>A new image</p>
+
+    <h4>See also</h4>
+
+    <p><a href="#contrast">contrast</a>, <a href=
+    "image2.html#equalize">equalize</a></p>
+
+    <h4>Magick API</h4>
+
+    <p>ContrastStretchImage (available in ImageMagick 6.2.6)</p>
+  </div>
+
   <div class="sig">
     <h3 id="convolve">convolve</h3>
 
-    <p>&gt;<span class="arg">image</span>.convolve(<span class=
+    <p><span class="arg">image</span>.convolve(<span class=
     "arg">order</span>, <span class="arg">kernel</span>) -&gt;
     <em>anImage</em></p>
   </div>

data/doc/image2.html

@@ -1241,9 +1241,8 @@ f.inspect » "images/Flower_Hat.jpg JPEG 200x250 DirectClass 8-bit 9kb"
 
     <p><span class="arg">image</span>.level(<span class=
     "arg">black_point</span>=<code>0.0</code>, <span class=
-    "arg">mid_point</span>=<code>1.0</code>, <span class=
-    "arg">white_point</span>=<code>MaxRGB</code>) -&gt;
-    <em>anImage</em></p>
+    "arg">white_point</span>=<code>MaxRGB</code>, <span class=
+    "arg">gamma</span>=<code>1.0</code>) -&gt; <em>anImage</em></p>
   </div>
 
   <div class="desc">
@@ -1254,10 +1253,10 @@ f.inspect &raquo; "images/Flower_Hat.jpg JPEG 200x250 DirectClass 8-bit 9kb"
     the full available quantum range. The parameters provided
     represent the black, mid, and white points. The black point
     specifies the darkest color in the image. Colors darker than
-    the black point are set to zero. Mid point specifies a gamma
+    the black point are set to zero. Gamma specifies a gamma
     correction to apply to the image. White point specifies the
     lightest color in the image. Colors brighter than the white
-    point are set to the maximum quantum value.</p>
+    point are set to the maximum quantum value</p>
 
     <h4>Arguments</h4>
 
@@ -1268,12 +1267,13 @@ f.inspect &raquo; "images/Flower_Hat.jpg JPEG 200x250 DirectClass 8-bit 9kb"
 
       <dt>mid_point</dt>
 
-      <dd>The mid-point level. The default is 1.0.</dd>
+      <dd>The white point level. The default is <a href=
+      "constants.html#Miscellaneous_constants">MaxRGB</a> -
+      <span class="arg">black_point</span>.</dd>
 
-      <dt>white_point</dt>
+      <dt>gamma</dt>
 
-      <dd>The white point level. The default is <a href=
-      "constants.html#Miscellaneous_constants">MaxRGB</a>.</dd>
+      <dd>The gamma correction. The default is 1.0.</dd>
     </dl>
 
     <h4>Returns</h4>
@@ -1306,9 +1306,9 @@ f.inspect &raquo; "images/Flower_Hat.jpg JPEG 200x250 DirectClass 8-bit 9kb"
 
     <p><span class="arg">image</span>.level_channel(<span class=
     "arg">channel</span>, <span class=
-    "arg">black_point</span>=<code>0.0</code>, <span class=
-    "arg">mid_point</span>=<code>1.0</code>, <span class=
-    "arg">white_point</span>=<code>MaxRGB</code>) -&gt;
+    "arg">black_point</span>=<code>0</code>, <span class=
+    "arg">white_point</span>=<code>MaxRGB</code>-<code>black_point</code>,
+    <span class="arg">gamma</span>=<code>1.0</code>) -&gt;
     <em>anImage</em></p>
   </div>
 
@@ -1330,12 +1330,13 @@ f.inspect &raquo; "images/Flower_Hat.jpg JPEG 200x250 DirectClass 8-bit 9kb"
 
       <dt>mid_point</dt>
 
-      <dd>The mid-point level. The default is 1.0.</dd>
+      <dd>The white point level. The default is <a href=
+      "constants.html#Miscellaneous_constants">MaxRGB</a> -
+      <span class="arg">black_point</span>.</dd>
 
-      <dt>white_point</dt>
+      <dt>gamma</dt>
 
-      <dd>The white point level. The default is <a href=
-      "constants.html#Miscellaneous_constants">MaxRGB</a>.</dd>
+      <dd>The gamma correction. The default is 1.0.</dd>
     </dl>
 
     <h4>Returns</h4>

data/doc/image3.html

@@ -94,6 +94,10 @@
 
           <li><a href="#resize_bang">resize!</a></li>
 
+          <li><a href="#resize_to_fit">resize_to_fit</a></li>
+
+          <li><a href="#resize_to_fit_bang">resize_to_fit!</a></li>
+
           <li><a href="#roll">roll</a></li>
 
           <li><a href="#rotate">rotate</a></li>
@@ -875,7 +879,7 @@ random_threshold_channel(geom, RedChannel)
 
     <h4>See also</h4>
 
-    <p><a href="image1.html#change_geometry">change_geometry</a>
+    <p><a href="image1.html#change_geometry">change_geometry</a>,
     <a href="#resize_bang">resize!</a>, <a href=
     "image2.html#magnify">magnify</a>, <a href=
     "image2.html#minify">minify</a>, <a href="#sample">sample</a>,
@@ -901,7 +905,59 @@ random_threshold_channel(geom, RedChannel)
   <div class="desc">
     <h4>Description</h4>
 
-    <p>In-place form of <a href="#Image.resize">resize</a>.</p>
+    <p>In-place form of <a href="#resize">resize</a>.</p>
+
+    <h4>Returns</h4>
+
+    <p>self</p>
+  </div>
+
+  <div class="sig">
+    <h3 id="resize_to_fit">resize_to_fit</h3>
+
+    <p><em>image</em>.resize_to_fit(<em>new_width</em>,
+    <em>new_height</em>) -&gt; <em>anImage</em></p>
+  </div>
+
+  <div class="desc">
+    <h4>Description</h4>
+
+    <p>A convenience method. Resize the image to fit within the
+    specified dimensions while retaining the original aspect
+    ratio.</p>
+
+    <h4>Arguments</h4>
+
+    <dl>
+      <dt>new_width, new_height</dt>
+
+      <dd>The maximum width and height of the resized image. In
+      order to retain the aspect ratio of the input image, the
+      actual dimensions of the resized image may be different but
+      will not be larger than the specified values.</dd>
+    </dl>
+
+    <h4>Returns</h4>
+
+    <p>A new image</p>
+
+    <h4>See also</h4><a href=
+    "image1.html#change_geometry">change_geometry</a>, <a href=
+    "#resize">resize</a>
+  </div>
+
+  <div class="sig">
+    <h3 id="resize_to_fit_bang">resize_to_fit!</h3>
+
+    <p><em>image</em>.resize_to_fit!(<em>new_width</em>,
+    <em>new_height</em>) -&gt; <em>image</em></p>
+  </div>
+
+  <div class="desc">
+    <h4>Description</h4>
+
+    <p>In-place form of <a href=
+    "#resize_to_fit">resize_to_fit</a>.</p>
 
     <h4>Returns</h4>
 
@@ -1445,7 +1501,7 @@ random_threshold_channel(geom, RedChannel)
     id="shadowed" onmouseover=
     "this.style.display='none';shadowless.style.display='';" src=
     "ex/shadow_after.gif" alt="shadow example"
-    /></a> <img src="ex/images/spin.gif" alt="" style=
+     /></a> <img src="ex/images/spin.gif" alt="" style=
     "margin-bottom: 120px" title=
     "Mouse over the example to see the original image" /></p>
 
@@ -1663,7 +1719,7 @@ random_threshold_channel(geom, RedChannel)
      <img id="sheared" onmouseover=
     "this.style.display='none'; noshear.style.display='';" src=
     "ex/shear.jpg" alt="shear example"
-    /></a><img src="ex/images/spin.gif" alt="" class=
+     /></a><img src="ex/images/spin.gif" alt="" class=
     "spin" style="left: 253px; top: 34px" title=
     "Mouse over the example to see the original image" /></p>
 

data/doc/index.html

@@ -115,7 +115,7 @@
     <ul>
       <li><a href="#introduction">Introduction</a></li>
 
-      <li>Usage Guide</li>
+      <li>User's Guide</li>
 
       <li style="list-style: none">
         <ul>
@@ -312,7 +312,7 @@
   <h3>About this document</h3>
 
   <p>This document is divided into 4 parts. The first is this page.
-  The second part is a usage guide covering both RMagick and
+  The second part is a user's guide covering both RMagick and
   ImageMagick/GraphicsMagick usage and conventions. The third part
   is a reference guide to the ImageList, Image, and Draw classes.
   This guide includes many examples.</p>
@@ -398,7 +398,7 @@
   &times;Magick's version number. Simply bring up irb and run this
   command: <code>ruby -r RMagick -e "puts Magick::Long_version"</code></p>
   <pre class="example" id="version">
-This is RMagick 1.10.0 ($Date: 2006/01/08 00:21:58 $) Copyright (C) 2006 by Timothy P. Hunter
+This is RMagick 1.10.0 ($Date: 2006/03/26 22:05:56 $) Copyright (C) 2006 by Timothy P. Hunter
 Built with ImageMagick 6.2.6 01/03/06 Q8 http://www.imagemagick.org
 Built for ruby 1.8.3 (2005-09-21) [i686-linux]
 Web page: http://rmagick.rubyforge.org

data/doc/magick.html

@@ -4,7 +4,7 @@
 <html xmlns="http://www.w3.org/1999/xhtml">
 <head>
   <meta name="generator" content=
-  "HTML Tidy for Linux/x86 (vers 1st March 2005), see www.w3.org" />
+  "HTML Tidy for Linux/x86 (vers 1st December 2004), see www.w3.org" />
 
   <title>RMagick: module Magick</title>
   <meta http-equiv="Content-Type" content=
@@ -46,6 +46,8 @@
 
       <li><a href="#formats">formats</a></li>
 
+      <li><a href="#limit_resource">limit_resource</a></li>
+
       <li><a href=
       "#set_cache_threshold">set_cache_threshold</a></li>
 
@@ -322,6 +324,59 @@ p Magick.formats &raquo;
     your system administrator.</p>
   </div>
 
+  <div class="sig">
+    <h3 id="limit_resource">limit_resource</h3>
+
+    <p>Magick.limit_resource(<span class="arg">resource_type</span>
+    [, <span class="arg">limit</span>]) -&gt; <span class=
+    "arg">old_limit</span></p>
+  </div>
+
+  <div class="desc">
+    <h4>Description</h4>
+
+    <p>Sets a limit to the amount of a resource, or gets the
+    current limit for the resource. <span class="imquote">When the
+    limit is reached, &times;Magick will fail in some fashion or
+    take compensating actions if possible.</span> The default
+    limits vary according to the platform. See the &times;Magick
+    documentation for the <em>-limit</em> option for more
+    information.</p>
+
+    <h4>Arguments</h4>This method may be called with one or two
+    arguments. The first argument identifies the resource. If
+    specified, the second argument is the limit.
+
+    <dl>
+      <dt>resource_type</dt>
+
+      <dd>One of the symbols <code>:disk</code>,
+      <code>:file</code>, <code>:map</code>, or
+      <code>:memory</code>. You may use a string instead of a
+      symbol.</dd>
+
+      <dt>limit</dt>
+
+      <dd>If present, the limit for the resource. This argument is
+      always an integer number. If the resource_type is
+      <code>:file</code>, the limit is the number of open files. If
+      <code>:memory</code> or <code>:map</code>, the limit is
+      measured megabytes. If <code>:disk</code>, the limit is
+      measured in gigabytes. If this argument is omitted the limit is not
+      changed.</dd>
+    </dl>
+
+    <h4>Returns</h4>
+
+    <p>The current resource limit. If a new limit is specified this
+    is the limit <em>before</em> the change.</p>
+
+    <h4>Notes</h4>
+
+    <p>This method supercedes <a href=
+    "#set_cache_threshold">set_cache_threshold</a>.</p>
+  </div>
+
   <div class="sig">
     <h3 id="set_cache_threshold">set_cache_threshold</h3>
 
@@ -344,6 +399,20 @@ p Magick.formats &raquo;
     <pre>
 # set the cache threshold to 10Mb
 Magick.set_cache_threshold(10)
+</pre>
+
+    <h4>Notes</h4>
+
+    <p>This method is obsolete. Use <a href=
+    "#limit_resource">limit_resource</a> instead. The code:</p>
+    <pre>
+Magick.limit_resource(:memory, n)
+Magick.imit_resource(:map, 2*n)
+</pre>
+
+    <p>is equivalent to</p>
+    <pre>
+Magick.set_cache_threshold(n)
 </pre>
   </div>
 

data/doc/usage.html

@@ -80,6 +80,10 @@
   #footnotes h5 {
     display: none;
   }
+  .sup {
+    vertical-align: super;
+    font-size: x-small;
+}
 
   /*]]>*/
 </style>
@@ -123,8 +127,8 @@
 
   <p>Let's look at the RMagick equivalent of "Hello, world". This
   program reads an image file named "Cheetah.jpg" and
-  displays<sup><a href="#display">1</a></sup> it on your
-  monitor.</p>
+  displays<span class="sup"><a href="#display">1</a></span> it on
+  your monitor</p>
   <pre class="example">
 1. require 'RMagick'
 2. include Magick
@@ -140,7 +144,8 @@
   work on native MS Windows. You must use an external viewer to
   view the images you create.</p>
 
-  <p>Line 1 requires the RMagick.rb file, which defines the
+  <p>Line 1 requires <span class="sup"><a href=
+  "#rubygems">2</a></span> the RMagick.rb file, which defines the
   <b>Magick</b> module. The Magick module contains 3 major classes,
   <b>ImageList</b>, <b>Image</b>, and <b>Draw</b>. This section -
   <em>Basic Comcepts</em> - describes the ImageList and Image
@@ -622,6 +627,11 @@ exit
 
       <dd>Resize the image using a filter</dd>
 
+      <dt><a href=
+      "image3.html#resize_to_fit">resize_to_fit</a></dt>
+
+      <dd>Resize the image retaining the aspect ratio</dd>
+
       <dt><a href="image3.html#sample">sample</a></dt>
 
       <dd>Resize the image using pixel sampling</dd>
@@ -810,6 +820,11 @@ exit
       <dd class="ilist">Inlay all the images in the imagelist into
       a single image</dd>
 
+      <dt class="ilist"><a href=
+      "ilist.html#optimize_layers">optimize_layers</a></dt>
+
+      <dd class="ilist">Optimize or compare image layers</dd>
+
       <dt><a href="image3.html#roll">roll</a></dt>
 
       <dd>Offset the image</dd>
@@ -831,6 +846,12 @@ exit
       <dd>Enhance the intensity differences between the lighter and
       darker elements in the image</dd>
 
+      <dt><a href=
+      "image1.html#contrast_stretch_channel">contrast_stretch_channel</a></dt>
+
+      <dd>Improve the contrast in the image by stretching the range
+      of intensity values</dd>
+
       <dt><a href="image1.html#despeckle">despeckle</a></dt>
 
       <dd>Reduce the speckle noise in the image</dd>
@@ -1163,7 +1184,7 @@ exit
       extends to the right. The y axis extends downward. The units
       are pixels. 0&deg; is at 3 o'clock and rotation is clockwise.
       The units of rotation are usually degrees.<sup><a href=
-      "#degrees">2</a></sup></p>
+      "#degrees">3</a></sup></p>
 
       <p>You can change the default coordinate system by specifying
       a <em>scaling</em>, <em>rotation</em>, or
@@ -1346,13 +1367,32 @@ exit
   <div>
     <h5 id="footnotes">Footnotes</h5>
 
-    <p id="display"><sup>1</sup>The <code>display</code> and
-    <code>animate</code> methods do not work on MS Windows. You
-    will have to write the image to a file and view it with a
-    separate image viewer.</p>
+    <p id="display"><span class="sup">1</span>The
+    <code>display</code> and <code>animate</code> methods do not
+    work on MS Windows. You will have to write the image to a file
+    and view it with a separate image viewer.</p>
+
+    <p id="rubygems"><span class="sup">2</span>If you installed
+    RMagick using <a href="http://docs.rubygems.org/">Rubygems</a>
+    you must set up the RubyGems environment before using RMagick.
+    You can do one of</p>
+
+    <ol>
+      <li>add the <code>require 'rubygems'</code> statement to your
+      program</li>
+
+      <li>use the -rubygems command line option</li>
+
+      <li>add <code>rubygems</code> to the RUBYOPT environment
+      variable</li>
+    </ol>
+
+    <p>See the RubyGems <a href=
+    "http://docs.rubygems.org/read/chapter/3#page70">doc</a> for
+    more information.</p>
 
-    <p id="degrees"><sup>2</sup>The rotation attributes
-    <code>rx</code> and <code>ry</code> in the <a href=
+    <p id="degrees"><span class="sup">3</span>The rotation
+    attributes <code>rx</code> and <code>ry</code> in the <a href=
     "struct.html#AffineMatrix"><code>AffineMatrix</code></a> class
     use radians instead of degrees.</p>
   </div>