rmagick 1.7.1
Sign up to get free protection for your applications and to get access to all the features.
Potentially problematic release.
This version of rmagick might be problematic. Click here for more details.
- data/ChangeLog +232 -0
- data/Makefile.in +28 -0
- data/README.html +404 -0
- data/README.txt +397 -0
- data/configure +8554 -0
- data/configure.ac +497 -0
- data/doc/comtasks.html +241 -0
- data/doc/constants.html +1195 -0
- data/doc/css/doc.css +299 -0
- data/doc/css/popup.css +34 -0
- data/doc/draw.html +3108 -0
- data/doc/ex/Adispatch.rb +43 -0
- data/doc/ex/Zconstitute.rb +9 -0
- data/doc/ex/adaptive_threshold.rb +19 -0
- data/doc/ex/add_noise.rb +18 -0
- data/doc/ex/affine.rb +48 -0
- data/doc/ex/affine_transform.rb +20 -0
- data/doc/ex/arc.rb +47 -0
- data/doc/ex/arcpath.rb +33 -0
- data/doc/ex/average.rb +15 -0
- data/doc/ex/axes.rb +64 -0
- data/doc/ex/bilevel_channel.rb +20 -0
- data/doc/ex/blur_image.rb +12 -0
- data/doc/ex/border.rb +10 -0
- data/doc/ex/bounding_box.rb +48 -0
- data/doc/ex/cbezier1.rb +40 -0
- data/doc/ex/cbezier2.rb +40 -0
- data/doc/ex/cbezier3.rb +40 -0
- data/doc/ex/cbezier4.rb +41 -0
- data/doc/ex/cbezier5.rb +41 -0
- data/doc/ex/cbezier6.rb +51 -0
- data/doc/ex/channel.rb +26 -0
- data/doc/ex/channel_threshold.rb +48 -0
- data/doc/ex/charcoal.rb +12 -0
- data/doc/ex/chop.rb +29 -0
- data/doc/ex/circle.rb +31 -0
- data/doc/ex/clip_path.rb +56 -0
- data/doc/ex/coalesce.rb +60 -0
- data/doc/ex/color_fill_to_border.rb +29 -0
- data/doc/ex/color_floodfill.rb +28 -0
- data/doc/ex/color_histogram.rb +60 -0
- data/doc/ex/color_reset.rb +11 -0
- data/doc/ex/colorize.rb +16 -0
- data/doc/ex/colors.rb +65 -0
- data/doc/ex/composite.rb +135 -0
- data/doc/ex/contrast.rb +37 -0
- data/doc/ex/crop.rb +31 -0
- data/doc/ex/crop_with_gravity.rb +46 -0
- data/doc/ex/cycle_colormap.rb +21 -0
- data/doc/ex/demo.rb +324 -0
- data/doc/ex/drawcomp.rb +42 -0
- data/doc/ex/drop_shadow.rb +60 -0
- data/doc/ex/edge.rb +11 -0
- data/doc/ex/ellipse.rb +43 -0
- data/doc/ex/emboss.rb +11 -0
- data/doc/ex/enhance.rb +28 -0
- data/doc/ex/equalize.rb +11 -0
- data/doc/ex/flatten_images.rb +38 -0
- data/doc/ex/flip.rb +11 -0
- data/doc/ex/flop.rb +11 -0
- data/doc/ex/fonts.rb +20 -0
- data/doc/ex/frame.rb +12 -0
- data/doc/ex/gaussian_blur.rb +11 -0
- data/doc/ex/get_multiline_type_metrics.rb +53 -0
- data/doc/ex/get_pixels.rb +48 -0
- data/doc/ex/get_type_metrics.rb +140 -0
- data/doc/ex/gradientfill.rb +27 -0
- data/doc/ex/grav.rb +44 -0
- data/doc/ex/gravity.rb +80 -0
- data/doc/ex/hatchfill.rb +27 -0
- data/doc/ex/images/Ballerina.jpg +0 -0
- data/doc/ex/images/Ballerina3.jpg +0 -0
- data/doc/ex/images/Button_0.gif +0 -0
- data/doc/ex/images/Button_1.gif +0 -0
- data/doc/ex/images/Button_2.gif +0 -0
- data/doc/ex/images/Button_3.gif +0 -0
- data/doc/ex/images/Button_4.gif +0 -0
- data/doc/ex/images/Button_5.gif +0 -0
- data/doc/ex/images/Button_6.gif +0 -0
- data/doc/ex/images/Button_7.gif +0 -0
- data/doc/ex/images/Button_8.gif +0 -0
- data/doc/ex/images/Button_9.gif +0 -0
- data/doc/ex/images/Button_A.gif +0 -0
- data/doc/ex/images/Button_B.gif +0 -0
- data/doc/ex/images/Button_C.gif +0 -0
- data/doc/ex/images/Button_D.gif +0 -0
- data/doc/ex/images/Button_E.gif +0 -0
- data/doc/ex/images/Button_F.gif +0 -0
- data/doc/ex/images/Button_G.gif +0 -0
- data/doc/ex/images/Button_H.gif +0 -0
- data/doc/ex/images/Button_I.gif +0 -0
- data/doc/ex/images/Button_J.gif +0 -0
- data/doc/ex/images/Button_K.gif +0 -0
- data/doc/ex/images/Button_L.gif +0 -0
- data/doc/ex/images/Button_M.gif +0 -0
- data/doc/ex/images/Button_N.gif +0 -0
- data/doc/ex/images/Button_O.gif +0 -0
- data/doc/ex/images/Button_P.gif +0 -0
- data/doc/ex/images/Button_Q.gif +0 -0
- data/doc/ex/images/Button_R.gif +0 -0
- data/doc/ex/images/Button_S.gif +0 -0
- data/doc/ex/images/Button_T.gif +0 -0
- data/doc/ex/images/Button_U.gif +0 -0
- data/doc/ex/images/Button_V.gif +0 -0
- data/doc/ex/images/Button_W.gif +0 -0
- data/doc/ex/images/Button_X.gif +0 -0
- data/doc/ex/images/Button_Y.gif +0 -0
- data/doc/ex/images/Button_Z.gif +0 -0
- data/doc/ex/images/Cheetah.jpg +0 -0
- data/doc/ex/images/Coffee.wmf +0 -0
- data/doc/ex/images/Flower_Hat.jpg +0 -0
- data/doc/ex/images/Gold_Statue.jpg +0 -0
- data/doc/ex/images/Hot_Air_Balloons.jpg +0 -0
- data/doc/ex/images/Hot_Air_Balloons_H.jpg +0 -0
- data/doc/ex/images/No.wmf +0 -0
- data/doc/ex/images/Polynesia.jpg +0 -0
- data/doc/ex/images/Red_Rocks.jpg +0 -0
- data/doc/ex/images/Shorts.jpg +0 -0
- data/doc/ex/images/Snake.wmf +0 -0
- data/doc/ex/images/Violin.jpg +0 -0
- data/doc/ex/images/graydient230x6.gif +0 -0
- data/doc/ex/images/logo400x83.gif +0 -0
- data/doc/ex/images/model.miff +0 -0
- data/doc/ex/images/notimplemented.gif +0 -0
- data/doc/ex/images/smile.miff +0 -0
- data/doc/ex/images/spin.gif +0 -0
- data/doc/ex/implode.rb +32 -0
- data/doc/ex/level.rb +12 -0
- data/doc/ex/level_channel.rb +33 -0
- data/doc/ex/line.rb +40 -0
- data/doc/ex/map.rb +28 -0
- data/doc/ex/map_f.rb +15 -0
- data/doc/ex/matte_fill_to_border.rb +42 -0
- data/doc/ex/matte_floodfill.rb +35 -0
- data/doc/ex/matte_replace.rb +42 -0
- data/doc/ex/median_filter.rb +28 -0
- data/doc/ex/modulate.rb +11 -0
- data/doc/ex/mono.rb +23 -0
- data/doc/ex/morph.rb +26 -0
- data/doc/ex/mosaic.rb +35 -0
- data/doc/ex/motion_blur.rb +11 -0
- data/doc/ex/negate.rb +11 -0
- data/doc/ex/negate_channel.rb +19 -0
- data/doc/ex/normalize.rb +11 -0
- data/doc/ex/oil_paint.rb +11 -0
- data/doc/ex/opacity.rb +38 -0
- data/doc/ex/opaque.rb +14 -0
- data/doc/ex/ordered_dither.rb +11 -0
- data/doc/ex/path.rb +62 -0
- data/doc/ex/pattern1.rb +25 -0
- data/doc/ex/pattern2.rb +26 -0
- data/doc/ex/polygon.rb +24 -0
- data/doc/ex/polyline.rb +23 -0
- data/doc/ex/posterize.rb +19 -0
- data/doc/ex/preview.rb +16 -0
- data/doc/ex/qbezierpath.rb +49 -0
- data/doc/ex/quantize-m.rb +25 -0
- data/doc/ex/radial_blur.rb +19 -0
- data/doc/ex/raise.rb +11 -0
- data/doc/ex/random_channel_threshold.rb +17 -0
- data/doc/ex/random_threshold_channel.rb +18 -0
- data/doc/ex/rectangle.rb +33 -0
- data/doc/ex/reduce_noise.rb +28 -0
- data/doc/ex/roll.rb +9 -0
- data/doc/ex/rotate.rb +43 -0
- data/doc/ex/rotate_f.rb +14 -0
- data/doc/ex/roundrect.rb +32 -0
- data/doc/ex/rubyname.rb +31 -0
- data/doc/ex/segment.rb +11 -0
- data/doc/ex/shade.rb +11 -0
- data/doc/ex/shave.rb +15 -0
- data/doc/ex/shear.rb +10 -0
- data/doc/ex/skewx.rb +50 -0
- data/doc/ex/skewy.rb +45 -0
- data/doc/ex/smile.rb +124 -0
- data/doc/ex/solarize.rb +11 -0
- data/doc/ex/splice.rb +16 -0
- data/doc/ex/spread.rb +11 -0
- data/doc/ex/stegano.rb +50 -0
- data/doc/ex/stroke_dasharray.rb +41 -0
- data/doc/ex/stroke_linecap.rb +44 -0
- data/doc/ex/stroke_linejoin.rb +48 -0
- data/doc/ex/stroke_width.rb +47 -0
- data/doc/ex/swirl.rb +17 -0
- data/doc/ex/text.rb +32 -0
- data/doc/ex/text_align.rb +36 -0
- data/doc/ex/text_antialias.rb +33 -0
- data/doc/ex/text_undercolor.rb +26 -0
- data/doc/ex/texture_fill_to_border.rb +34 -0
- data/doc/ex/texture_floodfill.rb +31 -0
- data/doc/ex/texturefill.rb +25 -0
- data/doc/ex/threshold.rb +13 -0
- data/doc/ex/to_blob.rb +14 -0
- data/doc/ex/translate.rb +37 -0
- data/doc/ex/transparent.rb +38 -0
- data/doc/ex/trim.rb +25 -0
- data/doc/ex/unsharp_mask.rb +28 -0
- data/doc/ex/viewex.rb +36 -0
- data/doc/ex/wave.rb +9 -0
- data/doc/ilist.html +1592 -0
- data/doc/image1.html +3009 -0
- data/doc/image2.html +2169 -0
- data/doc/image3.html +2815 -0
- data/doc/imageattrs.html +1319 -0
- data/doc/imusage.html +403 -0
- data/doc/index.html +418 -0
- data/doc/info.html +949 -0
- data/doc/magick.html +439 -0
- data/doc/scripts/doc.js +9 -0
- data/doc/struct.html +1334 -0
- data/doc/usage.html +1318 -0
- data/examples/describe.rb +44 -0
- data/examples/histogram.rb +289 -0
- data/examples/image_opacity.rb +29 -0
- data/examples/import_export.rb +31 -0
- data/examples/pattern_fill.rb +38 -0
- data/examples/rotating_text.rb +47 -0
- data/examples/thumbnail.rb +65 -0
- data/examples/vignette.rb +79 -0
- data/ext/RMagick/MANIFEST +239 -0
- data/ext/RMagick/extconf.rb.in +21 -0
- data/ext/RMagick/rmagick.h +938 -0
- data/ext/RMagick/rmagick_config.h.in +170 -0
- data/ext/RMagick/rmdraw.c +1308 -0
- data/ext/RMagick/rmfill.c +609 -0
- data/ext/RMagick/rmilist.c +685 -0
- data/ext/RMagick/rmimage.c +7980 -0
- data/ext/RMagick/rminfo.c +982 -0
- data/ext/RMagick/rmmain.c +1497 -0
- data/ext/RMagick/rmutil.c +2685 -0
- data/install.rb +1015 -0
- data/lib/RMagick.rb +1486 -0
- data/metaconfig.in +6 -0
- data/post-clean.rb +12 -0
- data/post-install.rb +36 -0
- data/post-setup.rb +245 -0
- data/rmagick.gemspec +22 -0
- data/uninstall.rb +71 -0
- metadata +286 -0
data/doc/imageattrs.html
ADDED
@@ -0,0 +1,1319 @@
|
|
1
|
+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
|
2
|
+
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
3
|
+
|
4
|
+
<html xmlns="http://www.w3.org/1999/xhtml">
|
5
|
+
<head>
|
6
|
+
<meta name="generator" content=
|
7
|
+
"HTML Tidy for Linux/x86 (vers 1st September 2004), see www.w3.org" />
|
8
|
+
|
9
|
+
<title>RMagick: class Image (attribute methods)</title>
|
10
|
+
<meta http-equiv="Content-Type" content=
|
11
|
+
"text/html; charset=us-ascii" />
|
12
|
+
<meta name="GENERATOR" content="Quanta Plus" />
|
13
|
+
<meta name="Copyright" content=
|
14
|
+
"Copyright (C) 2004 by Timothy P. Hunter" />
|
15
|
+
<link rel="stylesheet" type="text/css" href="css/doc.css" />
|
16
|
+
<script type="text/javascript" src="scripts/doc.js">
|
17
|
+
</script>
|
18
|
+
<style type="text/css">
|
19
|
+
/*<![CDATA[*/
|
20
|
+
|
21
|
+
/* Styles local to this page. */
|
22
|
+
|
23
|
+
/*]]>*/
|
24
|
+
</style>
|
25
|
+
</head>
|
26
|
+
|
27
|
+
<body>
|
28
|
+
<h6 id="header">RMagick User's Guide and Reference</h6>
|
29
|
+
|
30
|
+
<div class="nav">
|
31
|
+
« <a href="ilist.html">Prev</a> | <a href=
|
32
|
+
"index.html">Contents</a> | <a href=
|
33
|
+
"image1.html">Next</a> »
|
34
|
+
</div>
|
35
|
+
|
36
|
+
<h1>class Image <span class="superclass">< Object</span>
|
37
|
+
(attribute methods)<br />
|
38
|
+
<span class="mixin">mixes in Comparable</span></h1>
|
39
|
+
|
40
|
+
<div id="toc">
|
41
|
+
<h2>Table of Contents</h2>
|
42
|
+
|
43
|
+
<h3>attribute methods</h3>
|
44
|
+
|
45
|
+
<div>
|
46
|
+
<div class="toccol">
|
47
|
+
<ul>
|
48
|
+
<li><a href="#background_color">background_color</a></li>
|
49
|
+
|
50
|
+
<li><a href="#base_columns">base_columns</a></li>
|
51
|
+
|
52
|
+
<li><a href="#base_filename">base_filename</a></li>
|
53
|
+
|
54
|
+
<li><a href="#base_rows">base_rows</a></li>
|
55
|
+
|
56
|
+
<li><a href="#blur">blur</a></li>
|
57
|
+
|
58
|
+
<li><a href="#border_color">border_color</a></li>
|
59
|
+
|
60
|
+
<li><a href="#bounding_box">bounding_box</a></li>
|
61
|
+
|
62
|
+
<li><a href="#chromaticity">chromaticity</a></li>
|
63
|
+
|
64
|
+
<li><a href="#class_type">class_type</a></li>
|
65
|
+
|
66
|
+
<li><a href="#clip_mask">clip_mask</a></li>
|
67
|
+
|
68
|
+
<li><a href="#color_profile">color_profile</a></li>
|
69
|
+
|
70
|
+
<li><a href="#colors">colors</a></li>
|
71
|
+
|
72
|
+
<li><a href="#colorspace">colorspace</a></li>
|
73
|
+
|
74
|
+
<li><a href="#columns">columns</a></li>
|
75
|
+
|
76
|
+
<li><a href="#compose">compose</a></li>
|
77
|
+
|
78
|
+
<li><a href="#compression">compression</a></li>
|
79
|
+
|
80
|
+
<li><a href="#delay">delay</a></li>
|
81
|
+
</ul>
|
82
|
+
</div>
|
83
|
+
|
84
|
+
<div class="toccol">
|
85
|
+
<ul>
|
86
|
+
<li><a href="#density">density</a></li>
|
87
|
+
|
88
|
+
<li><a href="#depth">depth</a></li>
|
89
|
+
|
90
|
+
<li><a href="#directory">directory</a></li>
|
91
|
+
|
92
|
+
<li><a href="#dispose">dispose</a></li>
|
93
|
+
|
94
|
+
<li><a href="#endian">endian</a></li>
|
95
|
+
|
96
|
+
<li><a href="#extract_info">extract_info</a></li>
|
97
|
+
|
98
|
+
<li><a href="#filename">filename</a></li>
|
99
|
+
|
100
|
+
<li><a href="#filesize">filesize</a></li>
|
101
|
+
|
102
|
+
<li><a href="#filter">filter</a></li>
|
103
|
+
|
104
|
+
<li><a href="#format">format</a></li>
|
105
|
+
|
106
|
+
<li><a href="#fuzz">fuzz</a></li>
|
107
|
+
|
108
|
+
<li><a href="#gamma">gamma</a></li>
|
109
|
+
|
110
|
+
<li><a href="#geometry">geometry</a></li>
|
111
|
+
|
112
|
+
<li><a href="#image_type">image_type</a></li>
|
113
|
+
|
114
|
+
<li><a href="#interlace">interlace</a></li>
|
115
|
+
|
116
|
+
<li><a href="#iptc_profile">iptc_profile</a></li>
|
117
|
+
|
118
|
+
<li><a href="#matte">matte</a></li>
|
119
|
+
|
120
|
+
<li><a href=
|
121
|
+
"#mean_error_per_pixel">mean_error_per_pixel</a></li>
|
122
|
+
</ul>
|
123
|
+
</div>
|
124
|
+
|
125
|
+
<div class="toccol">
|
126
|
+
<ul>
|
127
|
+
<li><a href="#mime_type">mime_type</a></li>
|
128
|
+
|
129
|
+
<li><a href="#montage">montage</a></li>
|
130
|
+
|
131
|
+
<li><a href=
|
132
|
+
"#normalized_mean_error">normalized_mean_error</a></li>
|
133
|
+
|
134
|
+
<li><a href=
|
135
|
+
"#normalized_maximum_error">normalized_maximum_error</a></li>
|
136
|
+
|
137
|
+
<li><a href="#number_colors">number_colors</a></li>
|
138
|
+
|
139
|
+
<li><a href="#offset">offset</a></li>
|
140
|
+
|
141
|
+
<li><a href="#opacity_eq">opacity</a></li>
|
142
|
+
|
143
|
+
<li><a href="#page">page</a></li>
|
144
|
+
|
145
|
+
<li><a href="#quantum_depth">quantum_depth</a></li>
|
146
|
+
|
147
|
+
<li><a href="#rendering_intent">rendering_intent</a></li>
|
148
|
+
|
149
|
+
<li><a href="#rows">rows</a></li>
|
150
|
+
|
151
|
+
<li><a href="#scene">scene</a></li>
|
152
|
+
|
153
|
+
<li><a href="#start_loop">start_loop</a></li>
|
154
|
+
|
155
|
+
<li><a href="#tile_info">tile_info</a></li>
|
156
|
+
|
157
|
+
<li><a href="#total_colors">total_colors</a></li>
|
158
|
+
|
159
|
+
<li><a href="#units">units</a></li>
|
160
|
+
|
161
|
+
<li><a href="#x_resolution">x_resolution</a></li>
|
162
|
+
|
163
|
+
<li><a href="#y_resolution">y_resolution</a></li>
|
164
|
+
</ul>
|
165
|
+
</div>
|
166
|
+
</div>
|
167
|
+
</div>
|
168
|
+
|
169
|
+
<h2 class="methods">attribute methods</h2>
|
170
|
+
|
171
|
+
<div class="sig">
|
172
|
+
<h3 id="background_color">background_color</h3>
|
173
|
+
|
174
|
+
<p><span class="arg">image.</span>background_color ->
|
175
|
+
<em>aString</em><br />
|
176
|
+
<span class="arg">image</span>.background_color = <span class=
|
177
|
+
"arg">aString</span> or <span class="arg">aPixel</span></p>
|
178
|
+
</div>
|
179
|
+
|
180
|
+
<div class="desc">
|
181
|
+
<h4>Description</h4>
|
182
|
+
|
183
|
+
<p>The image's background color. By default the background
|
184
|
+
color is "white".</p>
|
185
|
+
|
186
|
+
<h4>Arguments</h4>Either a <a href=
|
187
|
+
"imusage.html#color_names">color name</a> or a <a href=
|
188
|
+
"struct.html#Pixel">Pixel</a> object.
|
189
|
+
|
190
|
+
<h4>Returns</h4>
|
191
|
+
|
192
|
+
<p>A color name.</p>
|
193
|
+
</div>
|
194
|
+
|
195
|
+
<div class="sig">
|
196
|
+
<h3 id="base_columns">base_columns</h3>
|
197
|
+
|
198
|
+
<p><span class="arg">image.</span>base_columns ->
|
199
|
+
<em>anInteger</em></p>
|
200
|
+
</div>
|
201
|
+
|
202
|
+
<div class="desc">
|
203
|
+
<h4>Description</h4>
|
204
|
+
|
205
|
+
<p>The number of columns in the image before any
|
206
|
+
transformations. Get-only.</p>
|
207
|
+
</div>
|
208
|
+
|
209
|
+
<div class="sig">
|
210
|
+
<h3 id="base_filename">base_filename</h3>
|
211
|
+
|
212
|
+
<p><span class="arg">image</span>.base_filename ->
|
213
|
+
<em>aString</em></p>
|
214
|
+
</div>
|
215
|
+
|
216
|
+
<div class="desc">
|
217
|
+
<h4>Description</h4>
|
218
|
+
|
219
|
+
<p>The image's original filename before any transformations.
|
220
|
+
Get-only.</p>
|
221
|
+
</div>
|
222
|
+
|
223
|
+
<div class="sig">
|
224
|
+
<h3 id="base_rows">base_rows</h3>
|
225
|
+
|
226
|
+
<p><span class="arg">image.</span>base_rows ->
|
227
|
+
<em>anInteger</em></p>
|
228
|
+
</div>
|
229
|
+
|
230
|
+
<div class="desc">
|
231
|
+
<h4>Description</h4>
|
232
|
+
|
233
|
+
<p>The number of rows in the image before any transformations.
|
234
|
+
Get-only.</p>
|
235
|
+
</div>
|
236
|
+
|
237
|
+
<div class="sig">
|
238
|
+
<h3 id="blur">blur</h3>
|
239
|
+
|
240
|
+
<p><span class="arg">image.</span>blur ->
|
241
|
+
<em>aFloat</em><br />
|
242
|
+
<span class="arg">image.</span>blur = <span class=
|
243
|
+
"arg">aFloat</span></p>
|
244
|
+
</div>
|
245
|
+
|
246
|
+
<div class="desc">
|
247
|
+
<h4>Description</h4>The blur factor to use when resizing. See
|
248
|
+
<a href="image3.html#resize">resize</a>.
|
249
|
+
</div>
|
250
|
+
|
251
|
+
<div class="sig">
|
252
|
+
<h3 id="border_color">border_color</h3>
|
253
|
+
|
254
|
+
<p><span class="arg">image.</span>border_color ->
|
255
|
+
<em>aString</em><br />
|
256
|
+
<span class="arg">image.</span>border_color = <span class=
|
257
|
+
"arg">aString</span> or <span class="arg">aPixel</span></p>
|
258
|
+
</div>
|
259
|
+
|
260
|
+
<div class="desc">
|
261
|
+
<h4>Description</h4>The image's border color. The default
|
262
|
+
border color is "#dfdfdf" (gray).
|
263
|
+
|
264
|
+
<h4>Arguments</h4>
|
265
|
+
|
266
|
+
<p>Either a <a href="imusage.html#color_names">color name</a>
|
267
|
+
or a <a href="struct.html#Pixel">Pixel</a> object.</p>
|
268
|
+
|
269
|
+
<h4>Returns</h4>
|
270
|
+
|
271
|
+
<p>A color name.</p>
|
272
|
+
</div>
|
273
|
+
|
274
|
+
<div class="sig">
|
275
|
+
<h3 id="bounding_box">bounding_box</h3>
|
276
|
+
|
277
|
+
<p><span class="arg">bounding_box</span> ->
|
278
|
+
<em>aRectangle</em></p>
|
279
|
+
</div>
|
280
|
+
|
281
|
+
<div class="desc">
|
282
|
+
<h4>Description</h4>
|
283
|
+
|
284
|
+
<p>The image's <em>bounding box</em>. The bounding box is the
|
285
|
+
rectangle that encloses all the pixels not in the border color.
|
286
|
+
Uses the current <a href="#fuzz">fuzz</a> value. Get-only.</p>
|
287
|
+
|
288
|
+
<h4>Returns</h4>A <a href="struct.html#Rectangle">Rectangle</a>
|
289
|
+
object.
|
290
|
+
|
291
|
+
<h4>Example</h4>
|
292
|
+
|
293
|
+
<p>In this example, the bounding box is the gray square
|
294
|
+
enclosing the blue circle. (The coordinates and red circles
|
295
|
+
were added after the bounding box was computed.)</p>
|
296
|
+
|
297
|
+
<p><a href="javascript:popup('bounding_box.rb.html')"><img src=
|
298
|
+
"ex/bounding_box.gif" alt="ex/bounding_box.rb" title=
|
299
|
+
"Click to see the example script" /></a></p>
|
300
|
+
</div>
|
301
|
+
|
302
|
+
<div class="sig">
|
303
|
+
<h3 id="chromaticity">chromaticity</h3>
|
304
|
+
|
305
|
+
<p><span class="arg">image.</span>chromaticity ->
|
306
|
+
<em>aChromaticity</em><br />
|
307
|
+
<span class="arg">image.</span>chromaticity = <span class=
|
308
|
+
"arg">aChromaticity</span></p>
|
309
|
+
</div>
|
310
|
+
|
311
|
+
<div class="desc">
|
312
|
+
<h4>Description</h4>
|
313
|
+
|
314
|
+
<p>The <span class="imquote">red, green, blue, and white-point
|
315
|
+
chromaticity values.</span>.</p>
|
316
|
+
|
317
|
+
<h4>Arguments</h4>A <a href=
|
318
|
+
"struct.html#Chromaticity">Chromaticity</a> object.
|
319
|
+
|
320
|
+
<h4>Returns</h4>A <a href=
|
321
|
+
"struct.html#Chromaticity">Chromaticity</a> object.
|
322
|
+
</div>
|
323
|
+
|
324
|
+
<div class="sig">
|
325
|
+
<h3 id="class_type">class_type</h3>
|
326
|
+
|
327
|
+
<p><span class="arg">image.</span>class_type ->
|
328
|
+
<em>aClassType</em><br />
|
329
|
+
<span class="arg">image.</span>class_type = <span class=
|
330
|
+
"arg">aClassType</span></p>
|
331
|
+
</div>
|
332
|
+
|
333
|
+
<div class="desc">
|
334
|
+
<h4>Description</h4>
|
335
|
+
|
336
|
+
<p>The image's <em>storage class</em>. <span class="imquote">If
|
337
|
+
DirectClass then the pixels contain valid RGB or CMYK colors.
|
338
|
+
If PseudoClass then the image has a colormap referenced by the
|
339
|
+
pixel's index member.</span></p>
|
340
|
+
|
341
|
+
<h4>Arguments</h4>
|
342
|
+
|
343
|
+
<p>A <a href="constants.html#ClassType">ClassType</a>
|
344
|
+
constant.</p>
|
345
|
+
|
346
|
+
<h4>Returns</h4>
|
347
|
+
|
348
|
+
<p>A <a href="constants.html#ClassType">ClassType</a>
|
349
|
+
constant.</p>
|
350
|
+
</div>
|
351
|
+
|
352
|
+
<div class="sig">
|
353
|
+
<h3 id="clip_mask">clip_mask</h3>
|
354
|
+
|
355
|
+
<p><span class="arg">image.</span>clip_mask = <span class=
|
356
|
+
"arg">anImage</span> or <span class="arg">anImageList</span> or
|
357
|
+
<span class="arg"><code>nil</code></span></p>
|
358
|
+
</div>
|
359
|
+
|
360
|
+
<div class="desc">
|
361
|
+
<h4>Description</h4>
|
362
|
+
|
363
|
+
<p>Associates a clip mask with the image. The clip mask must
|
364
|
+
have the same dimensions as the image. <span class=
|
365
|
+
"imquote">Set any pixel component of the clip mask to
|
366
|
+
TransparentOpacity to prevent that corresponding image pixel
|
367
|
+
component from being updated.</span> Set-only.</p>
|
368
|
+
|
369
|
+
<h4>Arguments</h4>
|
370
|
+
|
371
|
+
<p>If an imagelist, uses the current image as the clip mask.
|
372
|
+
Assign <code>nil</code> to remove the clip mask.</p>
|
373
|
+
</div>
|
374
|
+
|
375
|
+
<div class="sig">
|
376
|
+
<h3 id="color_profile">color_profile</h3>
|
377
|
+
|
378
|
+
<p><span class="arg">image.</span>color_profile ->
|
379
|
+
<em>aString</em><br />
|
380
|
+
<span class="arg">image.</span>color_profile = <span class=
|
381
|
+
"arg">aString</span></p>
|
382
|
+
</div>
|
383
|
+
|
384
|
+
<div class="desc">
|
385
|
+
<h4>Description</h4>
|
386
|
+
|
387
|
+
<p>The <a href="http://www.color.org/icc_specs2.html">ICC color
|
388
|
+
profile</a>.</p>
|
389
|
+
|
390
|
+
<h4>Arguments</h4>
|
391
|
+
|
392
|
+
<p>A color profile is represented as a string.</p>
|
393
|
+
|
394
|
+
<h4>Returns</h4>
|
395
|
+
|
396
|
+
<p>The current color profile, or <code>nil</code> if there is
|
397
|
+
no profile.</p>
|
398
|
+
</div>
|
399
|
+
|
400
|
+
<div class="sig">
|
401
|
+
<h3 id="colors">colors</h3>
|
402
|
+
|
403
|
+
<p><span class="arg">image.</span>colors ->
|
404
|
+
<em>anInteger</em></p>
|
405
|
+
</div>
|
406
|
+
|
407
|
+
<div class="desc">
|
408
|
+
<h4>Description</h4>
|
409
|
+
|
410
|
+
<p>The number of colors in the colormap. Only meaningful for
|
411
|
+
<a href="constants.html#ClassType">PseudoClass</a> images.
|
412
|
+
Get-only.</p>
|
413
|
+
</div>
|
414
|
+
|
415
|
+
<div class="sig">
|
416
|
+
<h3 id="colorspace">colorspace</h3>
|
417
|
+
|
418
|
+
<p><span class="arg">image.</span>colorspace ->
|
419
|
+
<em>aColorspace</em><br />
|
420
|
+
<span class="arg">image.</span>colorspace = <span class=
|
421
|
+
"arg">aColorspace</span></p>
|
422
|
+
</div>
|
423
|
+
|
424
|
+
<div class="desc">
|
425
|
+
<h4>Description</h4>
|
426
|
+
|
427
|
+
<p class="imquote">Image pixel interpretation. If the <a href=
|
428
|
+
"constants.html#ColorspaceType">colorspace</a> is RGBColorspace
|
429
|
+
the pixels are red, green, blue. If <a href="#matte">matte</a>
|
430
|
+
is true, then red, green, blue, and opacity. If it is
|
431
|
+
CMYKColorspace, the pixels are cyan, yellow, magenta, black.
|
432
|
+
Otherwise the colorspace is ignored.</p>
|
433
|
+
|
434
|
+
<h4>Arguments</h4>
|
435
|
+
|
436
|
+
<p>A <a href="constants.html#Colorspace">Colorspace</a>
|
437
|
+
constant.</p>
|
438
|
+
|
439
|
+
<h4>Returns</h4>
|
440
|
+
|
441
|
+
<p>A <a href="constants.html#Colorspace">Colorspace</a>
|
442
|
+
constant.</p>
|
443
|
+
</div>
|
444
|
+
|
445
|
+
<div class="sig">
|
446
|
+
<h3 id="columns">columns</h3>
|
447
|
+
|
448
|
+
<p><span class="arg">image.</span>columns ->
|
449
|
+
<em>anInteger</em></p>
|
450
|
+
</div>
|
451
|
+
|
452
|
+
<div class="desc">
|
453
|
+
<h4>Description</h4>
|
454
|
+
|
455
|
+
<p>The width of the image in pixels. Get-only.</p>
|
456
|
+
</div>
|
457
|
+
|
458
|
+
<div class="sig">
|
459
|
+
<h3 id="compose">compose</h3>
|
460
|
+
|
461
|
+
<p><span class="arg">image.</span>compose ->
|
462
|
+
<em>aCompositeOperator</em><br />
|
463
|
+
<span class="arg">image.</span>compose = <span class=
|
464
|
+
"arg">aCompositeOperator</span></p>
|
465
|
+
</div>
|
466
|
+
|
467
|
+
<div class="desc">
|
468
|
+
<h4>Description</h4>
|
469
|
+
|
470
|
+
<p>The image composite operator. The default is
|
471
|
+
OverCompositeOp. See <a href=
|
472
|
+
"ilist.html#montage">montage</a>.</p>
|
473
|
+
|
474
|
+
<h4>Arguments</h4>
|
475
|
+
|
476
|
+
<p>A <a href="constants.html#CompositeOperator">composite
|
477
|
+
operator</a> constant.</p>
|
478
|
+
|
479
|
+
<h4>Returns</h4>
|
480
|
+
|
481
|
+
<p>A <a href="constants.html#CompositeOperator">composite
|
482
|
+
operator</a> constant.</p>
|
483
|
+
</div>
|
484
|
+
|
485
|
+
<div class="sig">
|
486
|
+
<h3 id="compression">compression</h3>
|
487
|
+
|
488
|
+
<p><span class="arg">image.</span>compression ->
|
489
|
+
<em>aCompressionType</em><br />
|
490
|
+
<span class="arg">image.</span>compression = <span class=
|
491
|
+
"arg">aCompressionType</span></p>
|
492
|
+
</div>
|
493
|
+
|
494
|
+
<div class="desc">
|
495
|
+
<h4>Description</h4>The image compression type. The default is
|
496
|
+
the compression type of the specified image file.
|
497
|
+
|
498
|
+
<h4>Arguments</h4>
|
499
|
+
|
500
|
+
<p>A <a href=
|
501
|
+
"constants.html#CompressionType">CompressionType</a>
|
502
|
+
constant.</p>
|
503
|
+
|
504
|
+
<h4>Returns</h4>
|
505
|
+
|
506
|
+
<p>A <a href=
|
507
|
+
"constants.html#CompressionType">CompressionType</a>
|
508
|
+
constant.</p>
|
509
|
+
</div>
|
510
|
+
|
511
|
+
<div class="sig">
|
512
|
+
<h3 id="delay">delay</h3>
|
513
|
+
|
514
|
+
<p><span class="arg">image.</span>delay ->
|
515
|
+
<em>anInteger</em><br />
|
516
|
+
<span class="arg">image.</span>delay = <span class=
|
517
|
+
"arg">anInteger</span></p>
|
518
|
+
</div>
|
519
|
+
|
520
|
+
<div class="desc">
|
521
|
+
<h4>Description</h4>
|
522
|
+
|
523
|
+
<p><span class="imquote">Time in 1/100ths of a second which
|
524
|
+
must expire before displaying the next image in an animated
|
525
|
+
sequence.</span> The default is 0.</p>
|
526
|
+
|
527
|
+
<h4>Arguments</h4>An integer value between 0 and 65535,
|
528
|
+
inclusive.
|
529
|
+
|
530
|
+
<h4>Returns</h4>
|
531
|
+
|
532
|
+
<p>The current delay value.</p>
|
533
|
+
</div>
|
534
|
+
|
535
|
+
<div class="sig">
|
536
|
+
<h3 id="density">density</h3>
|
537
|
+
|
538
|
+
<p><span class="arg">image.</span>density ->
|
539
|
+
<em>aString</em><br />
|
540
|
+
<span class="arg">image.</span>density = <span class=
|
541
|
+
"arg">aString</span> or <span class="arg">aGeometry</span></p>
|
542
|
+
</div>
|
543
|
+
|
544
|
+
<div class="desc">
|
545
|
+
<h4>Description</h4>
|
546
|
+
|
547
|
+
<p>The <span class="imquote">vertical and horizontal resolution
|
548
|
+
in pixels of the image.</span> The default is "72x72".</p>
|
549
|
+
|
550
|
+
<h4>Arguments</h4>
|
551
|
+
|
552
|
+
<p>The density may be expressed either as a string or a
|
553
|
+
<a href="struct.html#Geometry">Geometry</a> object. If a
|
554
|
+
string, it is in the form "XxY", or simply "X". If "Y" is
|
555
|
+
omitted it is set to "X". To specify the density with a
|
556
|
+
Geometry object, set the <code>width</code> attribute to the x
|
557
|
+
resolution and the <code>height</code> argument to the y
|
558
|
+
resolution. If <code>height</code> is nil, <code>width</code>
|
559
|
+
will be used as the y resolution as well.</p>
|
560
|
+
|
561
|
+
<h4>Returns</h4>
|
562
|
+
|
563
|
+
<p>The image density represented as a string.</p>
|
564
|
+
|
565
|
+
<h4>See also</h4>
|
566
|
+
|
567
|
+
<p>Also see <a href="#Image.x_resolution">x_resolution</a> and
|
568
|
+
<a href="#Image.y_resolution">y_resolution</a>.</p>
|
569
|
+
</div>
|
570
|
+
|
571
|
+
<div class="sig">
|
572
|
+
<h3 id="depth">depth</h3>
|
573
|
+
|
574
|
+
<p><span class="arg">image.</span>depth ->
|
575
|
+
<em>anInteger</em></p>
|
576
|
+
</div>
|
577
|
+
|
578
|
+
<div class="desc">
|
579
|
+
<h4>Description</h4>
|
580
|
+
|
581
|
+
<p>The image depth (8, 16, or 32). Get-only.</p>
|
582
|
+
</div>
|
583
|
+
|
584
|
+
<div class="sig">
|
585
|
+
<h3 id="directory">directory</h3>
|
586
|
+
|
587
|
+
<p><span class="arg">image.</span>directory ->
|
588
|
+
<em>aString</em></p>
|
589
|
+
</div>
|
590
|
+
|
591
|
+
<div class="desc">
|
592
|
+
<h4>Description</h4>
|
593
|
+
|
594
|
+
<p><span class="imquote">Tile names from within an image
|
595
|
+
montage. Only valid after calling <a href=
|
596
|
+
"ilist.html#montage">montage</a> or reading a MIFF file which
|
597
|
+
contains a directory.</span> Get-only.</p>
|
598
|
+
|
599
|
+
<h4>Returns</h4>
|
600
|
+
|
601
|
+
<p>A newline ("\n")-delimited list of the images in the
|
602
|
+
montage.</p>
|
603
|
+
</div>
|
604
|
+
|
605
|
+
<div class="sig">
|
606
|
+
<h3 id="dispose">dispose</h3>
|
607
|
+
|
608
|
+
<p><span class="arg">image.</span>dispose ->
|
609
|
+
<em>anInteger</em><br />
|
610
|
+
<span class="arg">image.</span>dispose = <span class=
|
611
|
+
"arg">aDisposeType</span></p>
|
612
|
+
</div>
|
613
|
+
|
614
|
+
<div class="desc">
|
615
|
+
<h4>Description</h4>
|
616
|
+
|
617
|
+
<p class="imquote">GIF disposal method. This attribute is used
|
618
|
+
to control how successive images are rendered (how the
|
619
|
+
preceding image is disposed of) when creating a GIF
|
620
|
+
animation.</p>
|
621
|
+
|
622
|
+
<h4>Arguments</h4>
|
623
|
+
|
624
|
+
<p>An integer corresponding to the disposal method.</p>
|
625
|
+
|
626
|
+
<h4>Returns</h4>A <a href=
|
627
|
+
"constants.html#DisposeType">DisposeType</a> constant.
|
628
|
+
</div>
|
629
|
+
|
630
|
+
<div class="sig">
|
631
|
+
<h3 id="endian">endian</h3>
|
632
|
+
|
633
|
+
<p><span class="arg">image.</span>endian ->
|
634
|
+
<em>anEndianType</em><br />
|
635
|
+
<span class="arg">image.</span>endian = <span class=
|
636
|
+
"arg">anEndianType</span></p>
|
637
|
+
</div>
|
638
|
+
|
639
|
+
<div class="desc">
|
640
|
+
<h4>Description</h4>
|
641
|
+
|
642
|
+
<p>Get or set the endian attribute. <em>(As best I can tell,
|
643
|
+
only the TIFF format supports this attribute.)</em></p>
|
644
|
+
|
645
|
+
<h4>Arguments</h4>
|
646
|
+
|
647
|
+
<p>An <a href="constants.html#EndianType">EndianType</a>
|
648
|
+
value.</p>
|
649
|
+
|
650
|
+
<h4>Returns</h4>
|
651
|
+
|
652
|
+
<p>An <a href="constants.html#EndianType">EndianType</a>
|
653
|
+
value.</p>
|
654
|
+
</div>
|
655
|
+
|
656
|
+
<div class="sig">
|
657
|
+
<h3 id="extract_info">extract_info</h3>
|
658
|
+
|
659
|
+
<p><span class="arg">image.</span>extract_info ->
|
660
|
+
<em>aRectangle</em><br />
|
661
|
+
<span class="arg">image.</span>extract_info = <span class=
|
662
|
+
"arg">aRectangle</span></p>
|
663
|
+
</div>
|
664
|
+
|
665
|
+
<div class="desc">
|
666
|
+
<h4>Description</h4>
|
667
|
+
|
668
|
+
<p>Specify a rectangle within an image, or retrieve the
|
669
|
+
rectangle specified when the image was constituted. See
|
670
|
+
<a href="info.html#Info.extract_eq">extract=</a>.</p>
|
671
|
+
|
672
|
+
<h4>Arguments</h4>
|
673
|
+
|
674
|
+
<p>A <a href="struct.html#Rectangle">Rectangle</a> object.</p>
|
675
|
+
|
676
|
+
<h4>Returns</h4>
|
677
|
+
|
678
|
+
<p>A <a href="struct.html#Rectangle">Rectangle</a> object.</p>
|
679
|
+
|
680
|
+
<h4>Note</h4>
|
681
|
+
|
682
|
+
<p>This attribute replaces the <a href=
|
683
|
+
"#Image.tile_info">tile_info</a> attribute in releases of
|
684
|
+
ImageMagick starting with 5.5.6. With releases of ImageMagick
|
685
|
+
prior to 5.5.6, this attribute is a synonym for
|
686
|
+
<code>tile_info</code>.</p>
|
687
|
+
</div>
|
688
|
+
|
689
|
+
<div class="sig">
|
690
|
+
<h3 id="filename">filename</h3>
|
691
|
+
|
692
|
+
<p><span class="arg">image.</span>filename ->
|
693
|
+
<em>aString</em></p>
|
694
|
+
</div>
|
695
|
+
|
696
|
+
<div class="desc">
|
697
|
+
<h4>Description</h4>
|
698
|
+
|
699
|
+
<p>The image filename. Get-only.</p>
|
700
|
+
</div>
|
701
|
+
|
702
|
+
<div class="sig">
|
703
|
+
<h3 id="filesize">filesize</h3>
|
704
|
+
|
705
|
+
<p><span class="arg">image.</span>filesize ->
|
706
|
+
<em>anInteger</em></p>
|
707
|
+
</div>
|
708
|
+
|
709
|
+
<div class="desc">
|
710
|
+
<h4>Description</h4>
|
711
|
+
|
712
|
+
<p>The image filesize in bytes. Get-only.</p>
|
713
|
+
</div>
|
714
|
+
|
715
|
+
<div class="sig">
|
716
|
+
<h3 id="filter">filter</h3>
|
717
|
+
|
718
|
+
<p><span class="arg">image.</span>filter ->
|
719
|
+
<em>aFilterType</em><br />
|
720
|
+
<span class="arg">image.</span>filter = <span class=
|
721
|
+
"arg">aFilterType</span></p>
|
722
|
+
</div>
|
723
|
+
|
724
|
+
<div class="desc">
|
725
|
+
<h4>Description</h4>
|
726
|
+
|
727
|
+
<p class="imquote">Filter to use when resizing image. The
|
728
|
+
reduction filter employed has a significant effect on the time
|
729
|
+
required to resize an image and the resulting quality. The
|
730
|
+
default filter is Lanczos which has been shown to produce high
|
731
|
+
quality results when reducing most images.</p>
|
732
|
+
|
733
|
+
<h4>Arguments</h4>
|
734
|
+
|
735
|
+
<p>A <a href="constants.html#FilterType">FilterType</a>
|
736
|
+
constant.</p>
|
737
|
+
|
738
|
+
<h4>Returns</h4>A <a href=
|
739
|
+
"constants.html#FilterType">FilterType</a> constant.
|
740
|
+
</div>
|
741
|
+
|
742
|
+
<div class="sig">
|
743
|
+
<h3 id="format">format</h3>
|
744
|
+
|
745
|
+
<p><span class="arg">image.</span>format ->
|
746
|
+
<em>aString</em><br />
|
747
|
+
<span class="arg">image.</span>format = <span class=
|
748
|
+
"arg">aString</span></p>
|
749
|
+
</div>
|
750
|
+
|
751
|
+
<div class="desc">
|
752
|
+
<h4>Description</h4>
|
753
|
+
|
754
|
+
<p>The image encoding format. For example, "GIF" or "PNG". See
|
755
|
+
<a href="magick.html#formats">formats</a>.</p>
|
756
|
+
|
757
|
+
<h4>Arguments</h4>
|
758
|
+
|
759
|
+
<p>The format name.</p>
|
760
|
+
|
761
|
+
<h4>Returns</h4>
|
762
|
+
|
763
|
+
<p>The format name.</p>
|
764
|
+
</div>
|
765
|
+
|
766
|
+
<div class="sig">
|
767
|
+
<h3 id="fuzz">fuzz</h3>
|
768
|
+
|
769
|
+
<p><span class="arg">image.</span>fuzz ->
|
770
|
+
<em>aFloat</em><br />
|
771
|
+
<span class="arg">image.</span>fuzz = <span class=
|
772
|
+
"arg">aNumeric</span> or <span class="arg">aString</span></p>
|
773
|
+
</div>
|
774
|
+
|
775
|
+
<div class="desc">
|
776
|
+
<h4>Description</h4>
|
777
|
+
|
778
|
+
<p><span class="imquote">Colors within this distance are
|
779
|
+
considered equal. A number of algorithms search for a target
|
780
|
+
color. By default the color must be exact. Use this</span>
|
781
|
+
[attribute] <span class="imquote">to match colors that are
|
782
|
+
close to the target color in RGB space.</span></p>
|
783
|
+
|
784
|
+
<p>See <a href="image3.html#opaque">opaque</a>, <a href=
|
785
|
+
"image3.html#texture_floodfill">texture_floodfill</a>, and
|
786
|
+
<a href="image3.html#transparent">transparent</a>.</p>
|
787
|
+
|
788
|
+
<h4>Arguments</h4>
|
789
|
+
|
790
|
+
<p>The argument may be a floating-point numeric value or a
|
791
|
+
string in the form "NN%". In the second case, the argument is
|
792
|
+
computed as a percentage of <a href=
|
793
|
+
"constants.html#Miscellaneous_constants">MaxRGB</a>. For
|
794
|
+
example, a value of '5%' sets <code>fuzz</code> to
|
795
|
+
0.05*MaxRGB.</p>
|
796
|
+
|
797
|
+
<h4>Returns</h4>
|
798
|
+
|
799
|
+
<p>A <code>Float</code></p>
|
800
|
+
</div>
|
801
|
+
|
802
|
+
<div class="sig">
|
803
|
+
<h3 id="gamma">gamma</h3>
|
804
|
+
|
805
|
+
<p><span class="arg">image.</span>gamma ->
|
806
|
+
<em>aFloat</em><br />
|
807
|
+
<span>image.</span>gamma = <span class="arg">aFloat</span></p>
|
808
|
+
</div>
|
809
|
+
|
810
|
+
<div class="desc">
|
811
|
+
<h4>Description</h4>
|
812
|
+
|
813
|
+
<p class="imquote">Gamma level of the image. The same color
|
814
|
+
image displayed on two different workstations may look
|
815
|
+
different due to differences in the display monitor. Use gamma
|
816
|
+
correction to adjust for this color difference.</p>
|
817
|
+
</div>
|
818
|
+
|
819
|
+
<div class="sig">
|
820
|
+
<h3 id="geometry">geometry</h3>
|
821
|
+
|
822
|
+
<p><span class="arg">image.</span>geometry ->
|
823
|
+
<em>aString</em><br />
|
824
|
+
<span class="arg">image.</span>geometry = <span class=
|
825
|
+
"arg">aString</span> or <span class="arg">aGeometry</span></p>
|
826
|
+
</div>
|
827
|
+
|
828
|
+
<div class="desc">
|
829
|
+
<h4>Description</h4>
|
830
|
+
|
831
|
+
<p class="imquote">Preferred size of the image when
|
832
|
+
encoding.</p>
|
833
|
+
|
834
|
+
<h4>Arguments</h4>
|
835
|
+
|
836
|
+
<p>A <a href="imusage.html#geometry">geometry string</a> or a
|
837
|
+
<a href="struct.html#Geometry">Geometry</a> object.</p>
|
838
|
+
|
839
|
+
<h4>Returns</h4>
|
840
|
+
|
841
|
+
<p>A <a href="imusage.html#geometry">geometry string</a>.</p>
|
842
|
+
</div>
|
843
|
+
|
844
|
+
<div class="sig">
|
845
|
+
<h3 id="image_type">image_type</h3>
|
846
|
+
|
847
|
+
<p><span class="arg">image.</span>image_type ->
|
848
|
+
<em>anImageType</em><br />
|
849
|
+
<span class="arg">image.</span>image_type = <span class=
|
850
|
+
"arg">anImageType</span></p>
|
851
|
+
</div>
|
852
|
+
|
853
|
+
<div class="desc">
|
854
|
+
<h4>Description</h4>
|
855
|
+
|
856
|
+
<p>The image type classification. For example, GrayscaleType.
|
857
|
+
Don't confuse this attribute with the <a href=
|
858
|
+
"#format">format</a>, that is "GIF" or "JPG".</p>
|
859
|
+
|
860
|
+
<h4>Arguments</h4>
|
861
|
+
|
862
|
+
<p>An <a href="constants.html#ImageType">ImageType</a>
|
863
|
+
constant.</p>
|
864
|
+
|
865
|
+
<h4>Returns</h4>
|
866
|
+
|
867
|
+
<p>An <a href="constants.html#ImageType">ImageType</a>
|
868
|
+
constant.</p>
|
869
|
+
</div>
|
870
|
+
|
871
|
+
<div class="sig">
|
872
|
+
<h3 id="interlace">interlace</h3>
|
873
|
+
|
874
|
+
<p><span class="arg">image.</span>interlace ->
|
875
|
+
<em>anInterlaceType</em><br />
|
876
|
+
<span class="arg">image.</span>interlace = <span class=
|
877
|
+
"arg">anInterlaceType</span></p>
|
878
|
+
</div>
|
879
|
+
|
880
|
+
<div class="desc">
|
881
|
+
<h4>Description</h4>
|
882
|
+
|
883
|
+
<p class="imquote">The type of interlacing scheme (default
|
884
|
+
NoInterlace). This option is used to specify the type of
|
885
|
+
interlacing scheme for raw image formats such as RGB or YUV.
|
886
|
+
NoInterlace means do not interlace, LineInterlace uses scanline
|
887
|
+
interlacing, and PlaneInterlace uses plane interlacing.
|
888
|
+
PartitionInterlace is like PlaneInterlace except the different
|
889
|
+
planes are saved to individual files (e.g. image.R, image.G,
|
890
|
+
and image.B). Use LineInterlace or PlaneInterlace to create an
|
891
|
+
interlaced GIF or progressive JPEG image.</p>
|
892
|
+
|
893
|
+
<h4>Arguments</h4>
|
894
|
+
|
895
|
+
<p>An <a href="constants.html#InterlaceType">InterlaceType</a>
|
896
|
+
constant.</p>
|
897
|
+
|
898
|
+
<h4>Returns</h4>
|
899
|
+
|
900
|
+
<p>An <a href="constants.html#InterlaceType">InterlaceType</a>
|
901
|
+
constant.</p>
|
902
|
+
</div>
|
903
|
+
|
904
|
+
<div class="sig">
|
905
|
+
<h3 id="iptc_profile">iptc_profile</h3>
|
906
|
+
|
907
|
+
<p><span class="arg">image.</span>iptc_profile ->
|
908
|
+
<em>aString</em><br />
|
909
|
+
<span class="arg">image.</span>iptc_profile = <span class=
|
910
|
+
"arg">aString</span> or <span class=
|
911
|
+
"arg"><code>nil</code></span></p>
|
912
|
+
</div>
|
913
|
+
|
914
|
+
<div class="desc">
|
915
|
+
<h4>Description</h4>
|
916
|
+
|
917
|
+
<p class="imquote">IPTC profile. Specifications are available
|
918
|
+
from the <a href="http://www.iptc.org">International Press
|
919
|
+
Telecommunications Council</a> for IPTC profiles.</p>
|
920
|
+
|
921
|
+
<h4>Arguments</h4>
|
922
|
+
|
923
|
+
<p>To remove an existing profile, assign <code>nil</code> to
|
924
|
+
the attribute.</p>
|
925
|
+
|
926
|
+
<h4>Returns</h4>
|
927
|
+
|
928
|
+
<p>The current profile, or <code>nil</code> if the image has no
|
929
|
+
IPTC profile.</p>
|
930
|
+
</div>
|
931
|
+
|
932
|
+
<div class="sig">
|
933
|
+
<h3 id="matte">matte</h3>
|
934
|
+
|
935
|
+
<p><span class="arg">image.</span>matte -> <code>true</code>
|
936
|
+
<em>or</em> <code>false</code><br />
|
937
|
+
<span class="arg">image.</span>matte = <span class=
|
938
|
+
"arg"><code>true</code></span> or <span class=
|
939
|
+
"arg"><code>false</code></span></p>
|
940
|
+
</div>
|
941
|
+
|
942
|
+
<div class="desc">
|
943
|
+
<h4>Description</h4>
|
944
|
+
|
945
|
+
<p>If <code>true</code>, honor the opacity values in the image
|
946
|
+
pixels. See <a href="struct.html#Pixel">Pixel</a>.</p>
|
947
|
+
</div>
|
948
|
+
|
949
|
+
<div class="sig">
|
950
|
+
<h3 id="mean_error_per_pixel">mean_error_per_pixel</h3>
|
951
|
+
|
952
|
+
<p><span class="arg">image.</span>mean_error_per_pixel ->
|
953
|
+
<em>aFloat</em></p>
|
954
|
+
</div>
|
955
|
+
|
956
|
+
<div class="desc">
|
957
|
+
<h4>Description</h4>
|
958
|
+
|
959
|
+
<p><span class="imquote">The mean error per pixel computed when
|
960
|
+
a image is color reduced.</span> This parameter is only valid
|
961
|
+
if the verbose argument to <code>quantize</code><a href=
|
962
|
+
"ilist.html#quantize">[ImageList]</a><a href=
|
963
|
+
"image3.html#quantize">[Image]</a> is set to <code>true</code>.
|
964
|
+
Get-only.</p>
|
965
|
+
</div>
|
966
|
+
|
967
|
+
<div class="sig">
|
968
|
+
<h3 id="mime_type">mime_type</h3>
|
969
|
+
|
970
|
+
<p><span class="arg">image.</span>mime_type ->
|
971
|
+
<em>aString</em></p>
|
972
|
+
</div>
|
973
|
+
|
974
|
+
<div class="desc">
|
975
|
+
<h4>Description</h4>
|
976
|
+
|
977
|
+
<p><span class="imquote">Returns the officially registered (or
|
978
|
+
de facto) MIME media-type.</span> If there is no registered
|
979
|
+
media-type, returns "image/x-magick". Get-only.</p>
|
980
|
+
</div>
|
981
|
+
|
982
|
+
<div class="sig">
|
983
|
+
<h3 id="montage">montage</h3>
|
984
|
+
|
985
|
+
<p><span class="arg">image.</span>montage ->
|
986
|
+
<em>aString</em><br />
|
987
|
+
<span class="arg">image.</span>montage = <code>nil</code></p>
|
988
|
+
</div>
|
989
|
+
|
990
|
+
<div class="desc">
|
991
|
+
<h4>Description</h4>
|
992
|
+
|
993
|
+
<p><span class="imquote">Tile size and offset within an image
|
994
|
+
montage. Only valid for</span> [images produced by <a href=
|
995
|
+
"ilist.html#montage">montage</a>.] <span class="imquote">The
|
996
|
+
string is in the form of a <a href=
|
997
|
+
"imusage.html#geometry">geometry</a> string.</span></p>
|
998
|
+
|
999
|
+
<h4>Arguments</h4>
|
1000
|
+
|
1001
|
+
<p>To release the montage string, set this attribute to
|
1002
|
+
<code>nil</code>.</p>
|
1003
|
+
</div>
|
1004
|
+
|
1005
|
+
<div class="sig">
|
1006
|
+
<h3 id="normalized_mean_error">normalized_mean_error</h3>
|
1007
|
+
|
1008
|
+
<p><span class="arg">image.</span>normalized_mean_error ->
|
1009
|
+
<em>aFloat</em></p>
|
1010
|
+
</div>
|
1011
|
+
|
1012
|
+
<div class="desc">
|
1013
|
+
<h4>Description</h4>
|
1014
|
+
|
1015
|
+
<p><span class="imquote">The normalized mean error computed
|
1016
|
+
when an image is color reduced.</span> This parameter is only
|
1017
|
+
valid if the verbose argument to <code>quantize</code><a href=
|
1018
|
+
"ilist.html#quantize">[ImageList]</a><a href=
|
1019
|
+
"image3.html#quantize">[Image]</a> is set to <code>true</code>.
|
1020
|
+
Get-only.</p>
|
1021
|
+
</div>
|
1022
|
+
|
1023
|
+
<div class="sig">
|
1024
|
+
<h3 id="normalized_maximum_error">normalized_maximum_error</h3>
|
1025
|
+
|
1026
|
+
<p><span class="arg" style=
|
1027
|
+
"padding-left: 20px;">image.</span>normalized_maximum_error
|
1028
|
+
-> <em>aFloat</em></p>
|
1029
|
+
</div>
|
1030
|
+
|
1031
|
+
<div class="desc">
|
1032
|
+
<h4>Description</h4>
|
1033
|
+
|
1034
|
+
<p><span class="imquote">The normalized mean error per pixel
|
1035
|
+
computed when an image is color reduced.</span> This parameter
|
1036
|
+
is only valid if the verbose argument to
|
1037
|
+
<code>quantize</code><a href=
|
1038
|
+
"ilist.html#quantize">[ImageList]</a><a href=
|
1039
|
+
"image3.html#quantize">[Image]</a> is set to <code>true</code>.
|
1040
|
+
Get-only.</p>
|
1041
|
+
</div>
|
1042
|
+
|
1043
|
+
<div class="sig">
|
1044
|
+
<h3 id="number_colors">number_colors</h3>
|
1045
|
+
|
1046
|
+
<p><span class="arg">image.</span>number_colors ->
|
1047
|
+
<em>anInteger</em></p>
|
1048
|
+
</div>
|
1049
|
+
|
1050
|
+
<div class="desc">
|
1051
|
+
<h4>Description</h4>
|
1052
|
+
|
1053
|
+
<p>Number of unique colors in the image. Get-only.</p>
|
1054
|
+
</div>
|
1055
|
+
|
1056
|
+
<div class="sig">
|
1057
|
+
<h3 id="offset">offset</h3>
|
1058
|
+
|
1059
|
+
<p><span class="arg">image.</span>offset ->
|
1060
|
+
<em>anInteger</em><br />
|
1061
|
+
<span class="arg">image.</span>offset = <span class=
|
1062
|
+
"arg">anInteger</span></p>
|
1063
|
+
</div>
|
1064
|
+
|
1065
|
+
<div class="desc">
|
1066
|
+
<h4>Description</h4>
|
1067
|
+
|
1068
|
+
<p class="imquote">Number of initial bytes to skip over when
|
1069
|
+
reading raw image.</p>
|
1070
|
+
</div>
|
1071
|
+
|
1072
|
+
<div class="sig">
|
1073
|
+
<h3 id="opacity">opacity</h3>
|
1074
|
+
|
1075
|
+
<p><span class="arg">image.</span>opacity =
|
1076
|
+
<em>anInteger</em></p>
|
1077
|
+
</div>
|
1078
|
+
|
1079
|
+
<div class="desc">
|
1080
|
+
<h4>Description</h4>
|
1081
|
+
|
1082
|
+
<p><span class="imquote">Attenuates the opacity channel of an
|
1083
|
+
image. If the image pixels are opaque, they are set to the
|
1084
|
+
specified opacity level. Otherwise, the pixel opacity values
|
1085
|
+
are blended with the supplied transparency value.</span>
|
1086
|
+
Set-only.</p>
|
1087
|
+
|
1088
|
+
<h4>Arguments</h4>A number between 0 and MaxRGB. Higher numbers
|
1089
|
+
increase transparency.
|
1090
|
+
</div>
|
1091
|
+
|
1092
|
+
<div class="sig">
|
1093
|
+
<h3 id="page">page</h3>
|
1094
|
+
|
1095
|
+
<p><span class="arg">image.</span>page ->
|
1096
|
+
<em>aRectangle</em><br />
|
1097
|
+
<span class="arg">image.</span>page = <span class=
|
1098
|
+
"arg">aRectangle</span></p>
|
1099
|
+
</div>
|
1100
|
+
|
1101
|
+
<div class="desc">
|
1102
|
+
<h4>Description</h4>
|
1103
|
+
|
1104
|
+
<p>When compositing, this attribute describes the position of
|
1105
|
+
this image with respect to the underlying image. See <a href=
|
1106
|
+
"ilist.html#coalesce">coalesce</a>, <a href=
|
1107
|
+
"ilist.html#flatten_images">flatten_images</a>, and <a href=
|
1108
|
+
"ilist.html#mosaic">mosaic</a>.</p>
|
1109
|
+
|
1110
|
+
<h4>Arguments</h4>
|
1111
|
+
|
1112
|
+
<p>A <a href="struct.html#Rectangle">Rectangle</a> object.</p>
|
1113
|
+
|
1114
|
+
<h4>Returns</h4>
|
1115
|
+
|
1116
|
+
<p>A <a href="struct.html#Rectangle">Rectangle</a> object.</p>
|
1117
|
+
</div>
|
1118
|
+
|
1119
|
+
<div class="sig">
|
1120
|
+
<h3 id="quantum_depth">quantum_depth</h3>
|
1121
|
+
|
1122
|
+
<p><span class="arg">image.</span>quantum_depth ->
|
1123
|
+
<em>anInteger</em></p>
|
1124
|
+
</div>
|
1125
|
+
|
1126
|
+
<div class="desc">
|
1127
|
+
<h4>Description</h4>
|
1128
|
+
|
1129
|
+
<p>The image depth to the nearest Quantum (8, 16, or 32).
|
1130
|
+
Get-only. Available in ImageMagick 6.0.0.</p>
|
1131
|
+
</div>
|
1132
|
+
|
1133
|
+
<div class="sig">
|
1134
|
+
<h3 id="rendering_intent">rendering_intent</h3>
|
1135
|
+
|
1136
|
+
<p><span class="arg">image.</span>rendering_intent ->
|
1137
|
+
<em>aRenderingIntent</em><br />
|
1138
|
+
<span class="arg">image.</span>rendering_intent = <span class=
|
1139
|
+
"arg">aRenderingIntent</span></p>
|
1140
|
+
</div>
|
1141
|
+
|
1142
|
+
<div class="desc">
|
1143
|
+
<h4>Description</h4>
|
1144
|
+
|
1145
|
+
<p class="imquote">The type of rendering intent.</p>
|
1146
|
+
|
1147
|
+
<h4>Arguments</h4>
|
1148
|
+
|
1149
|
+
<p>A <a href=
|
1150
|
+
"constants.html#RenderingIntent">RenderingIntent</a>
|
1151
|
+
constant.</p>
|
1152
|
+
|
1153
|
+
<h4>Returns</h4>A <a href=
|
1154
|
+
"constants.html#RenderingIntent">RenderingIntent</a> constant.
|
1155
|
+
</div>
|
1156
|
+
|
1157
|
+
<div class="sig">
|
1158
|
+
<h3 id="rows">rows</h3>
|
1159
|
+
|
1160
|
+
<p><span class="arg">image.</span>rows ->
|
1161
|
+
<em>anInteger</em></p>
|
1162
|
+
</div>
|
1163
|
+
|
1164
|
+
<div class="desc">
|
1165
|
+
<h4>Description</h4>
|
1166
|
+
|
1167
|
+
<p>The height of the image in pixels. Get-only.</p>
|
1168
|
+
</div>
|
1169
|
+
|
1170
|
+
<div class="sig">
|
1171
|
+
<h3 id="scene">scene</h3>
|
1172
|
+
|
1173
|
+
<p><span class="arg">image.</span>scene ->
|
1174
|
+
<em>anInteger</em></p>
|
1175
|
+
</div>
|
1176
|
+
|
1177
|
+
<div class="desc">
|
1178
|
+
<h4>Description</h4>
|
1179
|
+
|
1180
|
+
<p>The scene number assigned to the image the last time the
|
1181
|
+
image was written to a multi-image image file. Don't confuse
|
1182
|
+
this attribute with <code>ImageList</code>'s <a href=
|
1183
|
+
"ilist.html#scene">scene</a> attribute, which denotes the image
|
1184
|
+
to which Image methods will be sent.</p>
|
1185
|
+
</div>
|
1186
|
+
|
1187
|
+
<div class="sig">
|
1188
|
+
<h3 id="start_loop">start_loop</h3>
|
1189
|
+
|
1190
|
+
<p><span class="arg">image.</span>start_loop ->
|
1191
|
+
<code>true</code> or <code>false</code><br />
|
1192
|
+
<span class="arg">image.</span>start_loop = <span class=
|
1193
|
+
"arg"><code>true</code></span> or <span class=
|
1194
|
+
"arg"><code>false</code></span></p>
|
1195
|
+
</div>
|
1196
|
+
|
1197
|
+
<div class="desc">
|
1198
|
+
<h4>Description</h4>
|
1199
|
+
|
1200
|
+
<p>Indicates the first image in an animation.</p>
|
1201
|
+
</div>
|
1202
|
+
|
1203
|
+
<div class="sig">
|
1204
|
+
<h3 id="tile_info">tile_info</h3>
|
1205
|
+
|
1206
|
+
<p><span class="arg">image.</span>tile_info ->
|
1207
|
+
<em>aRectangle</em><br />
|
1208
|
+
<span class="arg">image.</span>tile_info = <span class=
|
1209
|
+
"arg">aRectangle</span></p>
|
1210
|
+
</div>
|
1211
|
+
|
1212
|
+
<div class="desc">
|
1213
|
+
<h4>Description</h4>
|
1214
|
+
|
1215
|
+
<p class="imquote">Describes a tile within an image. For
|
1216
|
+
example, if your image is 640x480 you may only want 320x256
|
1217
|
+
with an offset of +128+64. It is used for raw formats such as
|
1218
|
+
RGB and CMYK as well as for TIFF.</p>
|
1219
|
+
|
1220
|
+
<p>This attribute is deprecated in ImageMagick 5.5.6 and later.
|
1221
|
+
Use <a href="#extract_info">extract_info</a> instead.</p>
|
1222
|
+
|
1223
|
+
<h4>Arguments</h4>
|
1224
|
+
|
1225
|
+
<p>A <a href="struct.html#Rectangle">Rectangle</a> object.</p>
|
1226
|
+
|
1227
|
+
<h4>Returns</h4>
|
1228
|
+
|
1229
|
+
<p>A <a href="struct.html#Rectangle">Rectangle</a> object.</p>
|
1230
|
+
</div>
|
1231
|
+
|
1232
|
+
<div class="sig">
|
1233
|
+
<h3 id="total_colors">total_colors</h3>
|
1234
|
+
|
1235
|
+
<p><span class="arg">image.</span>total_colors ->
|
1236
|
+
<em>anInteger</em></p>
|
1237
|
+
</div>
|
1238
|
+
|
1239
|
+
<div class="desc">
|
1240
|
+
<h4>Description</h4>
|
1241
|
+
|
1242
|
+
<p>The number of colors in the image after quantization. Set by
|
1243
|
+
<code>quantize</code> <a href=
|
1244
|
+
"ilist.html#quantize">[ImageList]</a><a href=
|
1245
|
+
"image3.html#quantize">[Image]</a> if the <code>verbose</code>
|
1246
|
+
argument is <code>true</code>. Get-only.</p>
|
1247
|
+
</div>
|
1248
|
+
|
1249
|
+
<div class="sig">
|
1250
|
+
<h3 id="units">units</h3>
|
1251
|
+
|
1252
|
+
<p><span class="arg">image.</span>units ->
|
1253
|
+
<em>aResolutionType</em><br />
|
1254
|
+
<span class="arg">image.</span>units = <span class=
|
1255
|
+
"arg">aResolutionType</span></p>
|
1256
|
+
</div>
|
1257
|
+
|
1258
|
+
<div class="desc">
|
1259
|
+
<h4>Description</h4>
|
1260
|
+
|
1261
|
+
<p class="imquote">Units of image resolution.</p>
|
1262
|
+
|
1263
|
+
<h4>Arguments</h4>
|
1264
|
+
|
1265
|
+
<p>A <a href="constants.html#ResolutionType">ResolutionType</a>
|
1266
|
+
constant.</p>
|
1267
|
+
|
1268
|
+
<h4>Returns</h4>
|
1269
|
+
|
1270
|
+
<p>A <a href="constants.html#ResolutionType">ResolutionType</a>
|
1271
|
+
constant.</p>
|
1272
|
+
|
1273
|
+
<h4>See also</h4><p><a href="#x_resolution">x_resolution</a>,
|
1274
|
+
<a href="y_resolution">y_resolution</a></p>
|
1275
|
+
</div>
|
1276
|
+
|
1277
|
+
<div class="sig">
|
1278
|
+
<h3 id="x_resolution">x_resolution</h3>
|
1279
|
+
|
1280
|
+
<p><span class="arg">image.</span>x_resolution ->
|
1281
|
+
<em>aFloat</em><br />
|
1282
|
+
<span class="arg">image.</span>x_resolution = <span class=
|
1283
|
+
"arg">aFloat</span></p>
|
1284
|
+
</div>
|
1285
|
+
|
1286
|
+
<div class="desc">
|
1287
|
+
<h4>Description</h4>
|
1288
|
+
|
1289
|
+
<p class="imquote">Horizontal resolution of the image.</p>
|
1290
|
+
|
1291
|
+
<h4>See also</h4><p><a href="#units">units</a></p>
|
1292
|
+
</div>
|
1293
|
+
|
1294
|
+
<div class="sig">
|
1295
|
+
<h3 id="y_resolution">y_resolution</h3>
|
1296
|
+
|
1297
|
+
<p><span class="arg">image.</span>y_resolution ->
|
1298
|
+
<em>aFloat</em><br />
|
1299
|
+
<span class="arg">image.</span>y_resolution = <span class=
|
1300
|
+
"arg">aFloat</span></p>
|
1301
|
+
</div>
|
1302
|
+
|
1303
|
+
<div class="desc">
|
1304
|
+
<h4>Description</h4>
|
1305
|
+
|
1306
|
+
<p class="imquote">Vertical resolution of the image.</p>
|
1307
|
+
|
1308
|
+
<h4>See also</h4><p><a href="#units">units</a></p>
|
1309
|
+
</div>
|
1310
|
+
|
1311
|
+
<p class="spacer"> </p>
|
1312
|
+
|
1313
|
+
<div class="nav">
|
1314
|
+
« <a href="ilist.html">Prev</a> | <a href=
|
1315
|
+
"index.html">Contents</a> | <a href=
|
1316
|
+
"image1.html">Next</a> »
|
1317
|
+
</div>
|
1318
|
+
</body>
|
1319
|
+
</html>
|