doc/ilist.html in rmagick-1.10.1 vs doc/ilist.html in rmagick-1.11.0
- old
+ new
@@ -2,38 +2,23 @@
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<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: class ImageList</title>
<meta http-equiv="Content-Type" content=
"text/html; charset=us-ascii" />
<meta name="GENERATOR" content="Quanta Plus" />
<meta name="Copyright" content=
"Copyright (C) 2005 by Timothy P. Hunter" />
<link rel="stylesheet" type="text/css" href="css/doc.css" />
<script type="text/javascript" src="scripts/doc.js">
</script>
-<script type="text/javascript">
- //<![CDATA[
- <!-- Pre-load these images -->
- img = new Image();
- img.src = "ex/average_before.gif";
- img.src = "ex/coalesce_anim.gif";
- img.src = "ex/map_before.jpg";
- img.src = "ex/morph.gif";
- img.src = "ex/quantize-m_before.jpg";
- //]]>
+<script type="text/javascript" src="scripts/doc.js">
</script>
-<style type="text/css">
- /*<![CDATA[*/
-
- /* Styles local to this page. */
- /*]]>*/
-</style>
</head>
<body>
<h6 id="header">RMagick User's Guide and Reference</h6>
@@ -109,21 +94,23 @@
<li><a href="#inspect">inspect</a></li>
<li><a href="#map">map</a></li>
<li><a href="#montage">montage</a></li>
+
+ <li><a href="#morph">morph</a></li>
</ul>
</div>
<div class="toccol">
<ul>
- <li><a href="#morph">morph</a></li>
-
<li><a href="#mosaic">mosaic</a></li>
<li><a href="#new_image">new_image</a></li>
+ <li><a href="#optimize_layers">optimize_layers</a></li>
+
<li><a href="#ping">ping</a></li>
<li><a href="#quantize">quantize</a></li>
<li><a href="#read">read</a></li>
@@ -187,12 +174,12 @@
<p>In conjunction with <a href=
"#ticks_per_second_eq">ticks_per_second</a> sets the length of
time between each image in an animation. The
<code>delay=</code> attribute assigns the same delay to all the
images in the imagelist. Use <a href=
- "imageattrs.html#Image.delay">Image#delay=</a> to set different
- delay values on individual images.</p>
+ "imageattrs.html#delay">Image#delay=</a> to set different delay
+ values on individual images.</p>
<h4>Arguments</h4>
<p>An integer value representing the number of ticks that must
elapse between each image in an animation.</p>
@@ -206,11 +193,11 @@
imagelist.delay = 20 # delay 1/5 of a second between images.
</pre>
<h4>See also</h4>
- <p><a href="imageattrs.html#Image.delay">Image#delay=</a></p>
+ <p><a href="imageattrs.html#delay">Image#delay=</a></p>
</div>
<div class="sig">
<h3 id="iterations_eq">iterations=</h3>
@@ -544,19 +531,20 @@
"javascript:popup('average.rb.html')">
<!-- This img tag displays the original image when the mouse is over -->
<img style="display:none" id="notaveraged" onmouseout=
"this.style.display='none'; averaged.style.display=''; averagedspin.style.display='';"
title="Click to see the example script" src=
- "ex/average_before.gif" alt="average example" /><!--
+ "ex/average_before.gif" alt="average example" /><!--
This img tag displays the averaged image when the mouse is not over
--><img style="display:" id=
"averaged" onmouseover=
"this.style.display='none'; notaveraged.style.display=''; averagedspin.style.display='none';"
- src="ex/average_after.gif" alt="average example" /></a>
- <img src="ex/images/spin.gif" alt="" class="spin" style=
- "left:131px; display:" id="averagedspin" title=
- "Mouse over the example to see the 3 original images" /></p>
+ src="ex/average_after.gif" alt="average example"
+ /></a> <img src="ex/images/spin.gif" alt="" class=
+ "spin" style="left:131px; display:" id="averagedspin" title=
+ "Mouse over the example to see the 3 original images"
+ /></p>
<h4>Magick API</h4>
<p>AverageImages</p>
</div>
@@ -596,15 +584,15 @@
<p>Merges all the images in the imagelist into a new imagelist.
Each image in the new imagelist is formed by flattening all the
previous images.</p>
<p>The length of time between images in the new image is
- specified by the <a href=
- "imageattrs.html#Image.delay">delay</a> attribute of the input
- image. The position of the image on the merged images is
- specified by the <a href="imageattrs.html#Image.page">page</a>
- attribute of the input image.</p>
+ specified by the <a href="imageattrs.html#delay">delay</a>
+ attribute of the input image. The position of the image on the
+ merged images is specified by the <a href=
+ "imageattrs.html#page">page</a> attribute of the input
+ image.</p>
<h4>Returns</h4>
<p>A new imagelist</p>
@@ -711,10 +699,14 @@
<p>A new imagelist</p>
<h4>Magick API</h4>
<p>DeconstructImages</p>
+
+ <h4>See also</h4>
+
+ <p><a href="#optimize_layers">optimize_layers</a></p>
</div>
<div class="sig">
<h3 id="dup">dup</h3>
@@ -758,10 +750,15 @@
<h4>See also</h4>
<p><a href="#animate">animate</a>, <a href=
"image1.html#display">Image#display</a></p>
+ <h4>Note</h4>
+
+ <p>The display method is not supported on native MS
+ Windows.</p>
+
<h4>Magick API</h4>
<p>DisplayImages</p>
</div>
@@ -892,17 +889,16 @@
</pre>
<h4>See also</h4>
<p><a href="image2.html#inspect">Image#inspect</a></p>
-
</div>
<div class="sig">
<h3 id="map">map</h3>
- <p><span class="arg">imagelist.map</span>(<span class=
+ <p><span class="arg">imagelist</span>.map(<span class=
"arg">reference</span>, <span class="arg">dither</span>) ->
<em>anImageList</em></p>
</div>
<div class="desc">
@@ -1005,11 +1001,11 @@
background. The default composition operator is
<code>OverCompositeOp</code>.</dd>
<dd><em>Hint:</em> You can use a different composite operator
for each tile by setting each image's <a href=
- "imageattrs.html#Image.compose">compose=</a> attribute to the
+ "imageattrs.html#compose">compose=</a> attribute to the
desired operator. In the optional arguments block, set
<code>compose</code> to UndefinedCompositeOp.</dd>
<dt>fill=</dt>
@@ -1158,10 +1154,13 @@
display all the tiles.</p>
<h4>Example</h4><a href=
"javascript:popup('demo.rb.html')">demo.rb</a>
+ <h4>Example</h4><a href=
+ "javascript:popup('demo.rb.html')">demo.rb</a>
+
<h4>Magick API</h4>
<p>MontageImages</p>
</div>
@@ -1221,11 +1220,11 @@
<div class="desc">
<h4>Description</h4>
<p>Composites all the images into a single new image. The
location of each image is determined by the value of its
- <a href="imageattrs.html#Image.page">page</a> attribute.</p>
+ <a href="imageattrs.html#page">page</a> attribute.</p>
<h4>Returns</h4>
<p>An image</p>
@@ -1246,13 +1245,13 @@
<div class="sig">
<h3 id="new_image">new_image</h3>
<p><span class="arg">imagelist.</span>new_image(<span class=
- "arg">columns</span>, <span class="arg">rows</span><span class=
- "arg">[, fill]</span>) <span class="arg">[ { optional
- arguments } ]</span> -> <em>self</em></p>
+ "arg">columns</span>, <span class="arg">rows[, fill]</span>)
+ <span class="arg">[ { optional arguments } ]</span>
+ -> <em>self</em></p>
</div>
<div class="desc">
<h4>Description</h4>
@@ -1287,10 +1286,116 @@
imagelist.new_image(100, 100) { self.background_color = "red" }
</pre>
</div>
<div class="sig">
+ <h3 id="optimize_layers">optimize_layers</h3>
+
+ <p><span class=
+ "arg">imagelist</span>.optimize_layers(<span class=
+ "arg">layer_method</span>) -> <em>anImageList</em></p>
+ </div>
+
+ <div class="desc">
+ <h4>Description</h4>
+
+ <p>Optimizes or compares the images in the list. Equivalent to
+ the <code>-layers</code> option in ImageMagick's
+ <code>mogrify</code> command.</p>
+
+ <p>With the CompareAnyLayer, CompareClearLayer, and
+ CompareOverlayLayer arguments, <code>optimize_layers</code>
+ <span class="imquote">compares each image with the next in a
+ sequence and returns the minimum bounding region of all the
+ pixel differences (of the <code>LayerMethod</code> specified)
+ it discovers.</span></p>
+
+ <p class="imquote">The images in the list <span class=
+ "imquote">do NOT have to be the same size, though it is best
+ that all the images are fully 'coalesced' (images are all the
+ same size, on a flattened canvas, and represent how an specific
+ frame should look is animatated)</span></p>
+
+ <p class="imquote">If images are not the same size as the page
+ canvas size of first image, then it is alpha composed using
+ 'Copy' onto the previous frame compared. That is the
+ differences only within the overlay area are looked at.</p>
+
+ <p class="imquote">No dispose methods are applied, though this
+ does not matter for animations which are a fully coalesced
+ sequence of images.</p>
+
+ <p>With OptimizeLayer, <code>optimize_layers</code>
+ <span class="imquote">compares each image the GIF disposed
+ forms of the previous image in the sequence. From this it
+ attempts to select the smallest cropped image to replace each
+ frame, while preserving the results of the
+ animation.</span></p>
+
+ <p>OptimizePlusLayer is the same as OptimizeLayers,
+ <span class="imquote">but may also add or even remove extra
+ frames in the animation, if it improves the total number of
+ pixels in the resulting GIF animation.</span></p>
+
+ <p>With DisposeLayer, <code>optimize_layers</code> <span class=
+ "imquote">returns the coalesced frames of a GIF animation as it
+ would appear after the GIF dispose method of that frame has
+ been applied. That is it returns the appearance of each frame
+ before the next is overlaid.</span></p>
+
+ <p>The <code>optimize_layers</code> method corresponds to the
+ <code>-layers</code> option on ImageMagick's
+ <code>convert</code> and <code>mogrify</code> commands. Anthony
+ Thyssen's excellent <a href=
+ "http://www.cit.gu.edu.au/~anthony/graphics/imagick6">Examples
+ of ImageMagick Usage</a> site has very detailed <a href=
+ "http://www.cit.gu.edu.au/~anthony/graphics/imagick6/anim_basics/#optimize">
+ information and examples</a> of the <code>-layers</code> option
+ and and the optimization methods .</p>
+
+ <h4>Arguments</h4>
+
+ <p>One of the following <code>MagickLayerMethod</code>
+ values:</p>
+
+ <ul>
+ <li>CoalesceLayer</li>
+
+ <li>CompareAnyLayer</li>
+
+ <li>CompareClearLayer</li>
+
+ <li>CompareOverlayLayer</li>
+
+ <li>DisposeLayer</li>
+
+ <li>OptimizeLayer</li>
+
+ <li>OptimizePlusLayer</li>
+ </ul>
+
+ <h4>Returns</h4>
+
+ <p>A new imagelist</p>
+
+ <h4>See also</h4>
+
+ <p><a href="#deconstruct">deconstruct</a> is an alias for
+ <code>optimize_layers</code> with the
+ <code>CompareAnyLayer</code> argument.</p>
+
+ <p><a href="#coalesce">coalesce</a> is an alias for
+ <code>optimize_layers</code> with the
+ <code>CoalesceLayer</code> argument.</p>
+
+ <h4>Magick API</h4>
+
+ <p>OptimizeImageLayers, CompareImageLayers (available in
+ ImageMagick 6.2.6)</p>
+ </div>
+
+ <div class="sig">
<h3 id="ping">ping</h3>
<p><span class="arg">imagelist.</span>ping(<span class=
"arg">filename</span>[, <span class="arg">filename</span>...])
-> <em>self</em><br />
@@ -1390,17 +1495,16 @@
<dt>measure_error</dt>
<dd><span class="imquote">Calculate quantization errors when
quantizing the image.</span> Stores the results for each
image in the imagelist <a href=
- "imageattrs.html#Image.mean_error_per_pixel">mean_error_per_pixel</a>,
+ "imageattrs.html#mean_error_per_pixel">mean_error_per_pixel</a>,
<a href=
- "imageattrs.html#Image.normalized_maximum_error">normalized_maximum_error</a>,
+ "imageattrs.html#normalized_maximum_error">normalized_maximum_error</a>,
and <a href=
- "imageattrs.html#Image.normalized_mean_error">normalized_mean_error</a>
+ "imageattrs.html#normalized_mean_error">normalized_mean_error</a>
attributes. Stores the number of colors used for the image in
- the <a href=
- "imageattrs.html#Image.total_colors">total_colors</a>
+ the <a href="imageattrs.html#total_colors">total_colors</a>
attribute.</dd>
</dl>
<h4>Returns</h4>