rmagick 1.13.0 → 1.14.0

data/doc/imageattrs.html

@@ -53,6 +53,11 @@
 
           <li><a href="#base_rows">base_rows</a></li>
 
+          <li><a href="#bias">bias</a></li>
+
+          <li><a href=
+          "#black_point_compensation">black_point_compensation</a></li>
+
           <li><a href="#blur">blur</a></li>
 
           <li><a href="#border_color">border_color</a></li>
@@ -63,8 +68,6 @@
 
           <li><a href="#class_type">class_type</a></li>
 
-          <li><a href="#clip_mask">clip_mask</a></li>
-
           <li><a href="#color_profile">color_profile</a></li>
 
           <li><a href="#colors">colors</a></li>
@@ -113,6 +116,10 @@
 
           <li><a href="#interlace">interlace</a></li>
 
+          <li><a href="#iptc_profile">iptc_profile</a></li>
+
+          <li><a href="#mask">mask</a></li>
+
           <li><a href="#matte">matte</a></li>
 
           <li><a href=
@@ -123,14 +130,14 @@
           <li><a href="#monitor">monitor</a></li>
 
           <li><a href="#montage">montage</a></li>
-
-          <li><a href=
-          "#normalized_mean_error">normalized_mean_error</a></li>
         </ul>
       </div>
 
       <div class="toccol">
         <ul>
+          <li><a href=
+          "#normalized_mean_error">normalized_mean_error</a></li>
+
           <li><a href=
           "#normalized_maximum_error">normalized_maximum_error</a></li>
 
@@ -138,12 +145,15 @@
 
           <li><a href="#offset">offset</a></li>
 
-          <li><a href="#opacity_eq">opacity</a></li>
+          <li><a href="#opacity">opacity</a></li>
 
           <li><a href="#orientation">orientation</a></li>
 
           <li><a href="#page">page</a></li>
 
+          <li><a href=
+          "#pixel_interpolation_method">pixel_interpolation_method</a></li>
+
           <li><a href="#quality">quality</a></li>
 
           <li><a href="#quantum_depth">quantum_depth</a></li>
@@ -241,6 +251,45 @@
     Get-only.</p>
   </div>
 
+  <div class="sig">
+    <h3 id="bias">bias</h3>
+
+    <p><span class="arg">image</span>.bias -&gt; bias<br />
+    <span class="arg">image</span>.bias = <span class=
+    "arg">aFloat</span><br />
+    <span class="arg">image</span>.bias = <span class=
+    "arg">aString</span></p>
+  </div>
+
+  <div class="desc">
+    <h4>Description</h4>
+
+    <p class="imquote">Add bias when convolving an image</p>
+
+    <h4>Argument</h4>
+
+    <p>Either a number between 0.0 and 1.0 or a string in the form
+    "NN%".</p>
+  </div>
+
+  <div class="sig">
+    <h3 id="black_point_compensation">black_point_compensation</h3>
+
+    <p><span class="arg">image</span>.black_point_compensation
+    -&gt; <code>true</code> or <code>false</code><br />
+    <span class="arg">image</span>.black_point_compensation =
+    <code>true</code> or <code>false</code> -&gt; <em>self</em></p>
+  </div>
+
+  <div class="desc">
+    <h4>Description</h4>
+
+    <p>Use black point compensation. Typically used in CMYK-to-RGB
+    conversion along with <code>image.</code><a href=
+    "#rendering_intent">rendering_intent</a>=<a href=
+    "constants.html#RenderingIntent">Magick::RelativeIntent</a></p>
+  </div>
+
   <div class="sig">
     <h3 id="blur">blur</h3>
 
@@ -253,6 +302,10 @@
   <div class="desc">
     <h4>Description</h4>The blur factor to use when resizing. See
     <a href="image3.html#resize">resize</a>.
+
+    <h4>Argument</h4>
+
+    <p>&gt; 1.0 is blurry, &lt; 1.0 is sharp.</p>
   </div>
 
   <div class="sig">
@@ -356,29 +409,6 @@
     constant.</p>
   </div>
 
-  <div class="sig">
-    <h3 id="clip_mask">clip_mask</h3>
-
-    <p><span class="arg">image.</span>clip_mask = <span class=
-    "arg">anImage</span> or <span class="arg">anImageList</span> or
-    <span class="arg"><code>nil</code></span></p>
-  </div>
-
-  <div class="desc">
-    <h4>Description</h4>
-
-    <p>Associates a clip mask with the image. The clip mask must
-    have the same dimensions as the image. <span class=
-    "imquote">Set any pixel component of the clip mask to
-    TransparentOpacity to prevent that corresponding image pixel
-    component from being updated.</span> Set-only.</p>
-
-    <h4>Arguments</h4>
-
-    <p>If an imagelist, uses the current image as the clip mask.
-    Assign <code>nil</code> to remove the clip mask.</p>
-  </div>
-
   <div class="sig">
     <h3 id="color_profile">color_profile</h3>
 
@@ -396,12 +426,27 @@
 
     <h4>Arguments</h4>
 
-    <p>A color profile is represented as a string.</p>
+    <p>A color profile is represented as a string. If the argument
+    is <code>nil</code> instead of <span class="arg">aString</span>
+    then any ICC color profile present in the image is deleted.</p>
+
+    <p>The setter form of this attribute deletes any existing ICC
+    color profile(s) before adding the new one. If you need to add
+    both source and destination profiles use <a href=
+    "image1.html#add_profile">add_profile</a> or <a href=
+    "image3.html#profile_bang">profile!</a>.</p>
 
     <h4>Returns</h4>
 
     <p>The current color profile, or <code>nil</code> if there is
     no profile.</p>
+
+    <h4>See also</h4>
+
+    <p><a href="image1.html#add_profile">add_profile</a>, <a href=
+    "image1.html#delete_profile">delete_profile</a>, <a href=
+    "image1.html#each_profile">each_profile</a>, <a href=
+    "image3.html#profile_bang">profile!</a></p>
   </div>
 
   <div class="sig">
@@ -895,14 +940,102 @@
     constant.</p>
   </div>
 
+  <div class="sig">
+    <h3 id="iptc_profile">iptc_profile</h3>
+
+    <p><span class="arg">image.</span>iptc_profile -&gt;
+    <em>aString</em><br />
+    <span class="arg">image.</span>iptc_profile = <span class=
+    "arg">aString</span></p>
+  </div>
+
+  <div class="desc">
+    <h4>Description</h4>
+
+    <p>The <a href="http://www.iptc.org/IIM/">International Press
+    Telecommunications Council profile</a>.</p>
+
+    <h4>Arguments</h4>
+
+    <p>A IPTC profile is represented as a string. If the argument
+    is <code>nil</code> instead of <span class="arg">aString</span>
+    then any IPTC profile present in the image is deleted.</p>
+
+    <h4>Returns</h4>
+
+    <p>The current IPTC profile, or <code>nil</code> if there is no
+    profile.</p>
+
+    <h4>See also</h4>
+
+    <p><a href="image1.html#add_profile">add_profile</a>, <a href=
+    "image1.html#delete_profile">delete_profile</a>, <a href=
+    "image1.html#each_profile">each_profile</a>. <a href=
+    "image3.html#profile_bang">profile!</a></p>
+  </div>
+
+  <div class="sig">
+    <h3 id="mask">mask</h3>
+
+    <p><span class="arg">image</span>.mask -&gt; <em>anImage</em>
+    or <code>nil</code><br />
+    <span class="arg">image.</span>mask = <em>anImage</em> or
+    <em>anImageList</em> or <code>nil</code></p>
+  </div>
+
+  <div class="desc">
+    <h4>Description</h4>
+
+    <p>The <code>mask=</code> attribute writer sets an image clip
+    mask created from the specified mask image. <span class=
+    "imquote">The mask image must have the same dimensions as the
+    image being masked.</span> If not, the mask image is resized to
+    match. <span class="imquote">If the mask image has an alpha
+    channel the opacity of each pixel is used to define the mask.
+    Otherwise, the intensity (gray level) of each pixel is
+    used.</span></p>
+
+    <p>In general, if the mask image does not have an alpha
+    channel, a white pixel in the mask prevents changes to the
+    corresponding pixel in the image being masked, while a black
+    pixel allows changes. A pixel that is neither black nor white
+    will allow partial changes depending on its intensity.</p>
+
+    <p>Use <a href="#matte">matte=</a> to specify whether or not
+    the mask image has an alpha channel.</p>
+
+    <p>The <code>mask</code> attribute reader returns a copy of the
+    clip mask. This is <em>not</em> a copy of the mask image that
+    was used to create the clip mask, nor is it the clip mask image
+    itself. Therefore, modifying the image returned by
+    <code>mask</code> does not change the clip mask itself. To
+    change the clip mask you must assign a new image to the
+    <code>mask=</code> attribute writer.</p>
+
+    <h4>Arguments</h4>
+
+    <p>If the value is an imagelist, uses the current image as the
+    mask image. Assign <code>nil</code> to remove the clip
+    mask.</p>
+
+    <h4>Example</h4>
+
+    <p class="rollover"><a href=
+    "javascript:popup('mask.rb.html')"><img src="ex/mask.jpg" alt=
+    "mask example" title="Click to see the example script"
+    onmouseover="this.src='ex/images/Flower_Hat.jpg'" onmouseout=
+    "this.src='ex/mask.jpg'" /></a> <img src="ex/images/spin.gif"
+    alt="" class="spin" title=
+    "Mouse over the example to see the original image" /></p>
+  </div>
+
   <div class="sig">
     <h3 id="matte">matte</h3>
 
     <p><span class="arg">image.</span>matte -&gt; <code>true</code>
     <em>or</em> <code>false</code><br />
-    <span class="arg">image.</span>matte = <span class=
-    "arg"><code>true</code></span> or <span class=
-    "arg"><code>false</code></span></p>
+    <span class="arg">image.</span>matte = <code>true</code> or
+    <code>false</code></p>
   </div>
 
   <div class="desc">
@@ -1199,6 +1332,40 @@ blur_image is 100% complete.
     <p>A <a href="struct.html#Rectangle">Rectangle</a> object.</p>
   </div>
 
+  <div class="sig">
+    <h3 id="pixel_interpolation_method">
+    pixel_interpolation_method</h3>
+
+    <p><span class="arg">image</span>.pixel_interpolation_method
+    -&gt; <em>anInterpolatePixelMethod</em><br />
+    <span class="arg">image</span>.pixel_interpolation_method =
+    <span class="arg">anInterpolatePixelMethod</span></p>
+  </div>
+
+  <div class="desc">
+    <h4>Description</h4>
+
+    <p>Get/set the pixel color interpolation method. Some methods
+    (such as <a href="image3.html#wave">wave</a>, <a href=
+    "image3.html#swirl">swirl</a>, <a href=
+    "image2.html#implode">implode</a>, and <a href=
+    "image1.html#composite">composite</a>) use the pixel color
+    interpolation method to determine how to blend adjacent
+    pixels.</p>
+
+    <h4>Argument</h4>
+
+    <p>An <a href=
+    "constants.html#InterpolatePixelMethod">InterpolatePixelMethod</a>
+    enum value.</p>
+
+    <h4>Returns</h4>
+
+    <p>An <a href=
+    "constants.html#InterpolatePixelMethod">InterpolatePixelMethod</a>
+    enum value.</p>
+  </div>
+
   <div class="sig">
     <h3 id="quality">quality</h3>
 
@@ -1207,10 +1374,12 @@ blur_image is 100% complete.
   </div>
 
   <div class="desc">
-    <h4>Description</h4>For JPEG images, returns the Independent
-    JPEG Group quality value. This number is a measurement of the
-    amount of compression used when the image was saved. Lower
-    numbers mean higher compression.
+    <h4>Description</h4>
+
+    <p>For JPEG images, returns the Independent JPEG Group quality
+    value. This number is a measurement of the amount of
+    compression used when the image was saved. Lower numbers mean
+    higher compression.</p>
 
     <h4>Returns</h4>
 
@@ -1249,7 +1418,9 @@ blur_image is 100% complete.
   <div class="desc">
     <h4>Description</h4>
 
-    <p class="imquote">The type of rendering intent.</p>
+    <p class="imquote">The type of rendering intent. See <a href=
+    "http://www.cambridgeincolour.com/tutorials/color-space-conversion.htm">
+    http://www.cambridgeincolour.com/tutorials/color-space-conversion.htm</a></p>
 
     <h4>Arguments</h4>
 
@@ -1296,9 +1467,8 @@ blur_image is 100% complete.
 
     <p><span class="arg">image.</span>start_loop -&gt;
     <code>true</code> or <code>false</code><br />
-    <span class="arg">image.</span>start_loop = <span class=
-    "arg"><code>true</code></span> or <span class=
-    "arg"><code>false</code></span></p>
+    <span class="arg">image.</span>start_loop = <code>true</code>
+    or <code>false</code></p>
   </div>
 
   <div class="desc">

data/doc/imusage.html

@@ -74,7 +74,7 @@
   <div class="nav">
     &laquo;&nbsp;<a href="usage.html">Prev</a> | <a href=
     "index.html">Contents</a> | <a href=
-    "comtasks.html">Next</a>&nbsp;&raquo;
+    "optequiv.html">Next</a>&nbsp;&raquo;
   </div>
 
   <h1>RMagick: ImageMagick/GraphicsMagick Conventions</h1>
@@ -85,6 +85,9 @@
     <ul style="margin-left: 15px; padding-top: 1em">
       <li><a href="#formats">Image formats and filenames</a></li>
 
+      <li><a href="#frames">Selecting frames from a multi-frame
+      image file</a></li>
+
       <li><a href="#color_names">Color names</a></li>
 
       <li><a href="#geometry">The geometry string</a></li>
@@ -119,6 +122,42 @@
   <p><em>Note:</em> Keep in mind that files in some formats may
   only be read by &times;Magick, not written.</p>
 
+  <h2 id="frames">Selecting frames from a multi-frame image
+  file</h2>
+
+  <p>When reading a multi-frame image file such as an AVI you can
+  specify the subset of frames by adding a list of frame number(s)
+  to the end of the file name enclosed in square brackets. For
+  example, "my_movie.avi[0]" tells &times;Magick to read only the
+  first frame. In general,</p>
+
+  <dl>
+    <dt>[N]</dt>
+
+    <dd>identifies a single frame. Frame numbers start at 0.
+    Negative numbers cause frames to be selected from the end of
+    the image file.</dd>
+
+    <dt>[M,N,O]</dt>
+
+    <dd>identifies multiple non-sequential frame numbers.</dd>
+
+    <dt>[N-M]</dt>
+
+    <dd>identifies the sequence of frames numbered N through
+    M.</dd>
+
+    <dt>[M,N-O,P]</dt>
+
+    <dd>identifies both non-sequential and sequential frame
+    numbers</dd>
+  </dl>
+
+  <p>Note that the entire image file will be read into memory
+  before the frames are selected. See <a href=
+  "http://www.cit.gu.edu.au/~anthony/graphics/imagick6/files/#read">
+  this page</a> for additional uses of the [] modifier.</p>
+
   <h2 id="color_names">Color names</h2>
 
   <p>Many RMagick methods expect color name arguments or return
@@ -456,7 +495,7 @@ i = Image.read("gradient:red-blue") { self.size = "100x200" }
 
   <div class="nav">
     &laquo; <a href="usage.html">Prev</a> | <a href=
-    "index.html">Contents</a> | <a href="comtasks.html">Next</a>
+    "index.html">Contents</a> | <a href="optequiv.html">Next</a>
     &raquo;
   </div>
 </body>

data/doc/index.html

@@ -124,6 +124,8 @@
           <li><a href="imusage.html">ImageMagick and GraphicsMagick
           Conventions</a></li>
 
+        <li><a href="optequiv.html">Magick Command Options and Their Equivalent Methods</a></li>
+
           <li><a href="comtasks.html">Common Tasks</a></li>
         </ul>
       </li>
@@ -398,9 +400,9 @@
   &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/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]
+This is RMagick 1.13.0 ($Date: 2006/09/05 23:11:25 $) Copyright (C) 2006 by Timothy P. Hunter
+Built with ImageMagick 6.2.9 08/21/06 Q8 http://www.imagemagick.org
+Built for ruby 1.8.5 (2006-08-25) [i686-linux]
 Web page: http://rmagick.rubyforge.org
 Email: rmagick@rubyforge.org
 </pre>
@@ -437,12 +439,12 @@ Email: rmagick@rubyforge.org
   Notices</a></h3>
 
   <ul>
-    <li>RMagick is copyright &copy; 2006 by Timothy P. Hunter.</li>
+    <li>RMagick is copyrighted by Timothy P. Hunter.</li>
 
-    <li>ImageMagick is copyright &copy; 2005 ImageMagick
+    <li>ImageMagick is copyrighted by ImageMagick
     Studio.</li>
 
-    <li>GraphicsMagick is copyright &copy; 2005 GraphicsMagick
+    <li>GraphicsMagick is copyrighted by the GraphicsMagick
     Group.</li>
 
     <li>Ruby is copyrighted free software by Yukihiro