doc/imageattrs.html in rmagick-1.13.0 vs doc/imageattrs.html in rmagick-1.14.0
- old
+ new
@@ -51,22 +51,25 @@
<li><a href="#base_filename">base_filename</a></li>
<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>
<li><a href="#bounding_box">bounding_box</a></li>
<li><a href="#chromaticity">chromaticity</a></li>
<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>
<li><a href="#colorspace">colorspace</a></li>
@@ -111,41 +114,48 @@
<li><a href="#image_type">image_type</a></li>
<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=
"#mean_error_per_pixel">mean_error_per_pixel</a></li>
<li><a href="#mime_type">mime_type</a></li>
<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>
<li><a href="#number_colors">number_colors</a></li>
<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>
<li><a href="#rendering_intent">rendering_intent</a></li>
@@ -240,10 +250,49 @@
<p>The number of rows in the image before any transformations.
Get-only.</p>
</div>
<div class="sig">
+ <h3 id="bias">bias</h3>
+
+ <p><span class="arg">image</span>.bias -> 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
+ -> <code>true</code> or <code>false</code><br />
+ <span class="arg">image</span>.black_point_compensation =
+ <code>true</code> or <code>false</code> -> <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>
<p><span class="arg">image.</span>blur ->
<em>aFloat</em><br />
<span class="arg">image.</span>blur = <span class=
@@ -251,10 +300,14 @@
</div>
<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>> 1.0 is blurry, < 1.0 is sharp.</p>
</div>
<div class="sig">
<h3 id="border_color">border_color</h3>
@@ -355,33 +408,10 @@
<p>A <a href="constants.html#ClassType">ClassType</a>
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>
<p><span class="arg">image.</span>color_profile ->
<em>aString</em><br />
<span class="arg">image.</span>color_profile = <span class=
@@ -394,16 +424,31 @@
<p>The <a href="http://www.color.org/icc_specs2.html">ICC color
profile</a>.</p>
<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">
<h3 id="colors">colors</h3>
@@ -894,17 +939,105 @@
<p>An <a href="constants.html#InterlaceType">InterlaceType</a>
constant.</p>
</div>
<div class="sig">
+ <h3 id="iptc_profile">iptc_profile</h3>
+
+ <p><span class="arg">image.</span>iptc_profile ->
+ <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 -> <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 -> <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">
<h4>Description</h4>
@@ -1198,22 +1331,58 @@
<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
+ -> <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>
<p><span class="arg">image</span>.quality ->
<em>aFixnum</em></p>
</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>
<p>A number between 0-100.</p>
<h4>Notes</h4>
@@ -1247,11 +1416,13 @@
</div>
<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>
<p>A <a href=
"constants.html#RenderingIntent">RenderingIntent</a>
@@ -1294,12 +1465,11 @@
<div class="sig">
<h3 id="start_loop">start_loop</h3>
<p><span class="arg">image.</span>start_loop ->
<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">
<h4>Description</h4>