« back to all changes in this revision
Viewing changes to www/Magick++/Image.html
- browse files at revision 29
- compare with another revision
- download diff
- download tarball
- view history from revision 29
- Committer: Bazaar Package Importer
- Author(s): Colin Watson
- Date: 2011-06-15 11:05:28 UTC
- mfrom: (6.2.11 sid)
- Revision ID: james.westby@ubuntu.com-20110615110528-08jgo07a4846xh8d
Tags: 8:6.6.0.4-3ubuntu1
* Resynchronise with Debian (LP: #797595). Remaining changes:
- Make ufraw-batch (universe) a suggestion instead of a recommendation.
- Make debian/rules install target depend on check; they cannot reliably
be run in parallel.
- Don't set MAKEFLAGS in debian/rules; just pass it to the build.
- Make ufraw-batch (universe) a suggestion instead of a recommendation.
- Make debian/rules install target depend on check; they cannot reliably
be run in parallel.
- Don't set MAKEFLAGS in debian/rules; just pass it to the build.
- files added:
- m4/ac_compile_warnings.m4
- files removed:
- coders/debug.c
- files modified:
- .pc/601824.patch/magick/configure.c
- magick.sh.in *
added
removed
www/Magick++/Image.html
8
8
<meta name="Author" content="Bob Friesenhahn">
9
9
<meta name="Description" content="Description of Magick::Image Class">
10
10
<title>Magick::Image Class</title>
11
<link rel=stylesheet type=text/css href="magick.css">
12
11
</head>
13
<body alink="#ff0000" bgcolor="#ffffff" link="#0000ee" text="#000000"
14
vlink="#551a8b">
12
<body text="#000000" bgcolor="#ffffff" link="#0000ee" vlink="#551a8b"
13
alink="#ff0000">
15
14
<center>
16
15
<h1> Magick::Image Class</h1>
17
16
</center>
26
25
Access</a> </li>
27
26
</ul>
28
27
<hr width="100%">Image is the primary object in Magick++ and represents
29
a single image frame (see <a href="ImageDesign.html">design</a> ). The
30
<a href="STL.html">STL interface</a> <b>must</b> be used to operate on
31
image sequences or images (e.g. of format GIF, TIFF, MIFF, Postscript,
32
& MNG) which are comprized of multiple image frames. Individual
28
a single image frame (see <a href="ImageDesign.html">design</a> ). The <a
29
href="STL.html">STL interface</a> <b>must</b> be used to operate on
30
image sequences or images (e.g. of format GIF, TIFF, MIFF, Postscript,
31
& MNG) which are comprized of multiple image frames. Individual
33
32
frames of a multi-frame image may be requested by adding array-style
34
33
notation to the end of the file name (e.g. "animation.gif[3]" retrieves
35
34
the fourth frame of a GIF animation. Various image manipulation
36
35
operations may be applied to the image. Attributes may be set on the
37
36
image to influence the operation of the manipulation operations. The <a
38
href="Pixels.html"> Pixels</a> class provides low-level access to
39
image
37
href="Pixels.html"> Pixels</a> class provides low-level access to image
40
38
pixels. As a convenience, including <tt><font color="#663366"><Magick++.h></font></tt>
41
is sufficient in order to use the complete Magick++ API. The Magick++
39
is sufficient in order to use the complete Magick++ API. The Magick++
42
40
API is enclosed within the <i>Magick</i> namespace so you must either
43
add the prefix "<tt> Magick::</tt> " to each class/enumeration name or
44
add
45
the statement "<tt> using namespace Magick;</tt>" after including the <tt>Magick++.h</tt>
41
add the prefix "<tt> Magick::</tt> " to each class/enumeration name or add
42
the statement "<tt> using namespace Magick;</tt>" after including the <tt>Magick++.h</tt>
46
43
header.
47
44
<p>The preferred way to allocate Image objects is via automatic
48
45
allocation (on the stack). There is no concern that allocating Image
49
objects on the stack will excessively enlarge the stack since Magick++
50
allocates all large data objects (such as the actual image data) from
51
the heap. Use of automatic allocation is preferred over explicit
52
allocation (via <i>new</i>) since it is much less error prone and
53
allows use of C++ scoping rules to avoid memory leaks. Use of automatic
54
allocation allows Magick++ objects to be assigned and copied just like
55
the C++ intrinsic data types (e.g. '<i>int</i> '), leading to clear and
46
objects on the stack will excessively enlarge the stack since Magick++
47
allocates all large data objects (such as the actual image data) from
48
the heap. Use of automatic allocation is preferred over explicit
49
allocation (via <i>new</i>) since it is much less error prone and
50
allows use of C++ scoping rules to avoid memory leaks. Use of automatic
51
allocation allows Magick++ objects to be assigned and copied just like
52
the C++ intrinsic data types (e.g. '<i>int</i> '), leading to clear and
56
53
easy to read code. Use of automatic allocation leads to naturally
57
54
exception-safe code since if an exception is thrown, the object is
58
automagically deallocated once the stack unwinds past the scope of the
55
automatically deallocated once the stack unwinds past the scope of the
59
56
allocation (not the case for objects allocated via <i>new</i> ). </p>
60
57
<p>Image is very easy to use. For example, here is a the source to a
61
program which reads an image, crops it, and writes it to a new file
62
(the
58
program which reads an image, crops it, and writes it to a new file (the
63
59
exception handling is optional but strongly recommended): </p>
64
<blockquote><tt><font color="#000066">#include <Magick++.h></font></tt>
65
<br>
60
<blockquote><tt><font color="#000066">#include <Magick++.h></font></tt> <br>
66
61
<tt><font color="#000066">#include <iostream></font></tt> <br>
67
62
<tt><font color="#000066">using namespace std;</font></tt> <br>
68
63
<tt><font color="#000066">using namespace Magick;</font></tt> <br>
79
74
<p><tt><font color="#000066"> try {</font></tt> <br>
80
75
<tt><font color="#000066"> // Read a file into
81
76
image object</font></tt> <br>
82
<tt><font color="#000066"> image.read( "girl.gif" );</font></tt>
83
</p>
77
<tt><font color="#000066"> image.read( "girl.gif" );</font></tt> </p>
84
78
<p><tt><font color="#000066"> // Crop the image to
85
79
specified size</font></tt> (width, height, xOffset, yOffset)<br>
86
80
<tt><font color="#000066"> image.crop(
87
81
Geometry(100,100, 100, 100) );</font></tt> </p>
88
82
<p><tt><font color="#000066"> // Write the image to
89
83
a file</font></tt> <br>
90
<tt><font color="#000066"> image.write( "x.gif" );</font></tt>
91
<br>
84
<tt><font color="#000066"> image.write( "x.gif" );</font></tt> <br>
92
85
<tt><font color="#000066"> }</font></tt> <br>
93
<tt><font color="#000066"> catch( Exception &error_ )</font></tt>
94
<br>
86
<tt><font color="#000066"> catch( Exception &error_ )</font></tt> <br>
95
87
<tt><font color="#000066"> {</font></tt> <br>
96
88
<tt><font color="#000066"> cout
97
<< "Caught exception: " << error_.what() << endl;</font></tt>
98
<br>
99
<tt><font color="#000066"> return 1;</font></tt>
100
<br>
89
<< "Caught exception: " << error_.what() << endl;</font></tt> <br>
90
<tt><font color="#000066"> return 1;</font></tt> <br>
101
91
<tt><font color="#000066"> }</font></tt> <br>
102
92
<tt><font color="#000066"> return 0;</font></tt> <br>
103
93
<tt><font color="#000066">}</font></tt></p>
104
94
</blockquote>
105
95
The following is the source to a program which illustrates the use of
106
96
Magick++'s efficient reference-counted assignment and copy-constructor
107
operations which minimize use of memory and eliminate unncessary copy
108
operations (allowing Image objects to be efficiently assigned, and
109
copied into containers). The program accomplishes the
97
operations which minimize use of memory and eliminate unncessary copy
98
operations (allowing Image objects to be efficiently assigned, and
99
copied into containers). The program accomplishes the
110
100
following:
111
101
<ol>
112
102
<li> Read master image.</li>
117
107
<li> Write the second image to a file.</li>
118
108
<li> Write the third image to a file.</li>
119
109
</ol>
120
<blockquote><tt><font color="#000066">#include <Magick++.h></font></tt>
121
<br>
110
<blockquote><tt><font color="#000066">#include <Magick++.h></font></tt> <br>
122
111
<tt><font color="#000066">#include <iostream></font></tt> <br>
123
112
<tt><font color="#000066">using namespace std;</font></tt> <br>
124
113
<tt><font color="#000066">using namespace Magick;</font></tt> <br>
126
115
<tt><font color="#000066">{</font></tt> <br>
127
116
<tt><font color="#000066"> Image
128
117
master("horse.jpg");</font></tt> <br>
129
<tt><font color="#000066"> Image second = master;</font></tt>
130
<br>
131
<tt><font color="#000066"> second.zoom("640x480");</font></tt>
132
<br>
133
<tt><font color="#000066"> Image third = master;</font></tt>
134
<br>
135
<tt><font color="#000066"> third.zoom("800x600");</font></tt>
136
<br>
118
<tt><font color="#000066"> Image second = master;</font></tt> <br>
119
<tt><font color="#000066"> second.zoom("640x480");</font></tt> <br>
120
<tt><font color="#000066"> Image third = master;</font></tt> <br>
121
<tt><font color="#000066"> third.zoom("800x600");</font></tt> <br>
137
122
<tt><font color="#000066">
138
123
second.write("horse640x480.jpg");</font></tt> <br>
139
124
<tt><font color="#000066">
143
128
During the entire operation, a maximum of three images exist in memory
144
129
and the image data is never copied.
145
130
<p>The following is the source for another simple program which creates
146
a 100 by 100 pixel white image with a red pixel in the center and
131
a 100 by 100 pixel white image with a red pixel in the center and
147
132
writes it to a file: </p>
148
<blockquote><tt><font color="#000066">#include <Magick++.h></font></tt>
149
<br>
133
<blockquote><tt><font color="#000066">#include <Magick++.h></font></tt> <br>
150
134
<tt><font color="#000066">using namespace std;</font></tt> <br>
151
135
<tt><font color="#000066">using namespace Magick;</font></tt> <br>
152
136
<tt><font color="#000066">int main(int argc,char **argv)</font></tt> <br>
165
149
image.quantizeColorSpace( GRAYColorspace );</font></tt> <br>
166
150
<tt><font color="#000066"> image.quantizeColors( 256
167
151
);</font></tt> <br>
168
<tt><font color="#000066"> image.quantize( );</font></tt>
169
</p>
152
<tt><font color="#000066"> image.quantize( );</font></tt> </p>
170
153
<p>or, more simply: </p>
171
154
<p><tt><font color="#000066"> image.type(
172
155
GrayscaleType );</font></tt> </p>
175
158
<h3> <a name="BLOBs"></a> BLOBs</h3>
176
159
</center>
177
160
While encoded images (e.g. JPEG) are most often written-to and
178
read-from a disk file, encoded images may also reside in memory.
179
Encoded
180
images in memory are known as BLOBs (Binary Large OBjects) and may be
181
represented using the <a href="Blob.html">Blob</a> class. The encoded
182
image may be initially placed in memory by reading it directly from a
183
file, reading the image from a database, memory-mapped from a disk
161
read-from a disk file, encoded images may also reside in memory. Encoded
162
images in memory are known as BLOBs (Binary Large OBjects) and may be
163
represented using the <a href="Blob.html">Blob</a> class. The encoded
164
image may be initially placed in memory by reading it directly from a
165
file, reading the image from a database, memory-mapped from a disk
184
166
file, or could be written to memory by Magick++. Once the encoded image
185
167
has been placed within a Blob, it may be read into a Magick++ Image via
186
168
a <a href="#constructor_blob">constructor</a> or <a href="#read">read()</a>
188
170
href="#write"> write()</a> .
189
171
<p>An example of using Image to write to a Blob follows: <br>
190
172
</p>
191
<blockquote><tt><font color="#000066">#include <Magick++.h></font></tt>
192
<br>
173
<blockquote><tt><font color="#000066">#include <Magick++.h></font></tt> <br>
193
174
<tt><font color="#000066">using namespace std;</font></tt> <br>
194
175
<tt><font color="#000066">using namespace Magick;</font></tt> <br>
195
176
<tt><font color="#000066">int main(int argc,char **argv)</font></tt> <br>
196
177
<tt><font color="#000066">{</font></tt> <br>
197
<tt><font color="#000066"> // Read GIF file from
178
<tt><font color="#000066"> // Read GIF file from
198
179
disk</font></tt> <br>
199
180
<tt><font color="#000066"> Image image(
200
181
"giraffe.gif" );</font></tt>
203
184
<tt><font color="#000066"> Blob blob;</font></tt> <br>
204
185
<tt><font color="#000066"> image.magick( "JPEG" )
205
186
// Set JPEG output format</font></tt> <br>
206
<tt><font color="#000066"> image.write( &blob );</font></tt>
207
</p>
187
<tt><font color="#000066"> image.write( &blob );</font></tt> </p>
208
188
<p><tt><font color="#000066"> [ Use BLOB data (in
209
189
JPEG format) here ]</font></tt> </p>
210
<p><tt><font color="#000066"> return 0;</font></tt>
211
<br>
190
<p><tt><font color="#000066"> return 0;</font></tt> <br>
212
191
<tt><font color="#000066">}</font></tt></p>
213
192
</blockquote>
214
193
<p><br>
217
196
<p>[ <font color="#000000">Entry condition for the following examples
218
197
is that <i>data</i> is pointer to encoded image data and <i>length</i>
219
198
represents the size of the data</font> ] </p>
220
<blockquote><tt><font color="#000066">Blob blob( data, length );</font></tt>
221
<br>
199
<blockquote><tt><font color="#000066">Blob blob( data, length );</font></tt> <br>
222
200
<tt><font color="#000066">Image image( blob );</font></tt></blockquote>
223
201
or
224
<blockquote><tt><font color="#000066">Blob blob( data, length );</font></tt>
225
<br>
202
<blockquote><tt><font color="#000066">Blob blob( data, length );</font></tt> <br>
226
203
<tt><font color="#000066">Image image;</font></tt> <br>
227
204
<tt><font color="#000066">image.read( blob);</font></tt></blockquote>
228
205
some images do not contain their size or format so the size and format
229
206
must be specified in advance:
230
<blockquote><tt><font color="#000066">Blob blob( data, length );</font></tt>
231
<br>
207
<blockquote><tt><font color="#000066">Blob blob( data, length );</font></tt> <br>
232
208
<tt><font color="#000066">Image image;</font></tt> <br>
233
209
<tt><font color="#000066">image.size( "640x480")</font></tt> <br>
234
210
<tt><font color="#000066">image.magick( "RGBA" );</font></tt> <br>
242
218
constructors are shown in the following table: <br>
243
219
<br>
244
220
245
<table bgcolor="#ffffff" border="1" width="100%">
221
<table border="1" width="100%" bgcolor="#ffffff">
246
222
<caption><b>Image Constructors</b></caption> <tbody>
247
223
<tr>
248
224
<td>
256
232
<td><font size="-1">const std::string &imageSpec_</font></td>
257
233
<td><font size="-1">Construct Image by reading from file or URL
258
234
specified by <i>imageSpec_</i>. Use array notation (e.g. filename[9])
259
to select a specific scene from a multi-frame image.</font></td>
235
to select a specific scene from a multi-frame image.</font></td>
260
236
</tr>
261
237
<tr>
262
238
<td><font size="-1">const Geometry &size_, const <a
263
239
href="Color.html"> Color</a> &color_</font></td>
264
240
<td><font size="-1">Construct a blank image canvas of specified
265
size and color</font></td>
241
size and color</font></td>
266
242
</tr>
267
243
<tr>
268
244
<td><a name="constructor_blob"></a> <font size="-1">const <a
270
246
<td rowspan="5"><font size="-1">Construct Image by reading from
271
247
encoded image data contained in an in-memory <a href="Blob.html">BLOB</a>
272
248
. Depending on the constructor arguments, the Blob <a href="#size">size</a>
273
, <a href="#depth">depth</a> , <a href="#magick">magick</a> (format)
274
may
275
also be specified. Some image formats require that size be specified.
249
, <a href="#depth">depth</a> , <a href="#magick">magick</a> (format) may
250
also be specified. Some image formats require that size be specified.
276
251
The default ImageMagick uses for depth depends on the compiled-in
277
252
Quantum size (8 or 16). If ImageMagick's Quantum size does not
278
253
match that of the image, the depth may need to be specified.
279
ImageMagick can usually automagically detect the image's format.
280
When a format can't be automagically detected, the format (<a
254
ImageMagick can usually automatically detect the image's format.
255
When a format can't be automatically detected, the format (<a
281
256
href="#magick">magick</a> ) must be specified.</font></td>
282
257
</tr>
283
258
<tr>
287
262
<tr>
288
263
<td><font size="-1">const <a href="Blob.html">Blob</a>
289
264
&blob_, const <a href="Geometry.html">Geometry</a> &size,
290
size_t depth</font></td>
291
</tr>
292
<tr>
293
<td><font size="-1">const <a href="Blob.html">Blob</a>
294
&blob_, const <a href="Geometry.html">Geometry</a> &size,
295
size_t depth_, const string &magick_</font></td>
296
</tr>
297
<tr>
298
<td><font size="-1">const <a href="Blob.html">Blob</a>
299
&blob_, const <a href="Geometry.html">Geometry</a> &size,
300
const
265
unsigned int depth</font></td>
266
</tr>
267
<tr>
268
<td><font size="-1">const <a href="Blob.html">Blob</a>
269
&blob_, const <a href="Geometry.html">Geometry</a> &size,
270
unsigned int depth_, const string &magick_</font></td>
271
</tr>
272
<tr>
273
<td><font size="-1">const <a href="Blob.html">Blob</a>
274
&blob_, const <a href="Geometry.html">Geometry</a> &size, const
301
275
string &magick_</font></td>
302
276
</tr>
303
277
<tr>
304
<td><font size="-1">const size_t width_, </font> <br>
305
<font size="-1">const size_t height_,</font> <br>
278
<td><font size="-1">const unsigned int width_, </font> <br>
279
<font size="-1">const unsigned int height_,</font> <br>
306
280
<font size="-1">std::string map_,</font> <br>
307
281
<font size="-1">const <a href="Enumerations.html#StorageType">
308
282
StorageType</a> type_,</font> <br>
309
<font size="-1">const void *pixels_</font></td>
283
<font size="-1">const unsigned char* pixels_</font></td>
310
284
<td><font size="-1">Construct a new Image based on an array of
311
image pixels. The pixel data must be in scanline order top-to-bottom.
312
The data can be character, short int, integer, float, or double. Float
285
image pixels. The pixel data must be in scanline order top-to-bottom.
286
The data can be character, short int, integer, float, or double. Float
313
287
and double require the pixels to be normalized [0..1]. The other types
314
are [0..MaxRGB]. For example, to create a 640x480 image from
315
unsigned red-green-blue character data, use</font>
316
<p><font size="-1"> Image image( 640, 480, "RGB",
288
are [0..QuantumRange]. For example, to create a 640x480 image from
289
unsigned red-green-blue character data, use</font>
290
<p><font size="-1"> Image image( 640, 480, "RGB",
317
291
0, pixels );</font> </p>
318
292
<p><font size="-1">The parameters are as follows:</font> <br>
319
293
330
304
<tr>
331
305
<td><font size="-1">map_</font></td>
332
306
<td><font size="-1">This character string can be any
333
combination or order of R = red, G = green, B = blue, A = alpha, C =
334
cyan, Y = yellow M = magenta, and K = black. The ordering reflects the
335
order of the pixels in the supplied pixel array.</font></td>
307
combination or order of R = red, G = green, B = blue, A = alpha, C =
308
cyan, Y = yellow M = magenta, and K = black. The ordering reflects the
309
order of the pixels in the supplied pixel array.</font></td>
336
310
</tr>
337
311
<tr>
338
312
<td><font size="-1">type_</font></td>
339
313
<td><font size="-1"><a href="Enumerations.html#StorageType">Pixel
340
storage type</a> (CharPixel, ShortPixel, IntegerPixel, FloatPixel, or
314
storage type</a> (CharPixel, ShortPixel, IntegerPixel, FloatPixel, or
341
315
DoublePixel)</font></td>
342
316
</tr>
343
317
<tr>
344
318
<td><font size="-1">pixels_</font></td>
345
319
<td><font size="-1">This array of values contain the pixel
346
components as defined by the map_ and type_ parameters. The length of
347
the arrays must equal the area specified by the width_ and height_
320
components as defined by the map_ and type_ parameters. The length of
321
the arrays must equal the area specified by the width_ and height_
348
322
values and type_ parameters.</font></td>
349
323
</tr>
350
324
</tbody>
355
329
</tbody>
356
330
</table>
357
331
<center>
358
<h3> <a name="Image Manipulation Methods"></a> Image Manipulation
359
Methods</h3>
332
<h3> <a name="Image Manipulation Methods"></a> Image Manipulation Methods</h3>
360
333
</center>
361
<i>Image</i> supports access to all the single-image (versus
362
image-list) manipulation operations provided by the ImageMagick
363
library. If you
334
<i>Image</i> supports access to all the single-image (versus image-list)
335
manipulation operations provided by the ImageMagick library. If you
364
336
must process a multi-image file (such as an animation), the <a
365
337
href="STL.html"> STL interface</a> , which provides a multi-image
366
abstraction on top of <i>Image</i>, must be used.
338
abstraction on top of <i>Image</i>, must be used.
367
339
<p>Image manipulation methods are very easy to use. For example: </p>
368
340
<blockquote><font color="#663366">Image image;</font> <br>
369
341
<font color="#663366">image.read("myImage.tiff");</font> <br>
372
344
adds gaussian noise to the image file "myImage.tiff".
373
345
<p>The operations supported by Image are shown in the following table: <br>
374
346
375
<table nosave="" border="1">
376
<caption><b>Image Image Manipulation Methods</b></caption> <tbody>
347
<table border="1" nosave="">
348
<caption><b>Image Manipulation Methods</b></caption> <tbody>
377
349
<tr align="center">
378
350
<td><b>Method</b></td>
379
351
<td><b>Signature(s)</b></td>
380
352
<td><b>Description</b></td>
381
353
</tr>
382
354
<tr>
383
<td style="text-align: center;" valign="middle">
355
<td valign="middle">
384
356
<div align="center"><a name="adaptiveThreshold"></a> <font
385
357
size="-1">adaptiveThreshold<br>
386
358
</font></div>
387
359
</td>
388
<td valign="middle"><font size="-1">size_t width, unsigned
360
<td valign="middle"><font size="-1">unsigned int width, unsigned
389
361
int height, unsigned offset = 0<br>
390
362
</font></td>
391
<td valign="top"><font size="-1">Apply adaptive thresholding to
363
<td valign="top"><font size="-1">Apply adaptive thresholding to
392
364
the image. Adaptive thresholding is useful if the ideal threshold level
393
is not known in advance, or if the illumination gradient is not
394
constant
365
is not known in advance, or if the illumination gradient is not constant
395
366
across the image. Adaptive thresholding works by evaulating the mean
396
367
(average) of a pixel region (size specified by <i>width</i> and <i>height</i>)
397
368
and using the mean as the thresholding value. In order to remove
401
372
</td>
402
373
</tr>
403
374
<tr>
404
<td style="text-align: center;">
375
<td>
405
376
<center><a name="addNoise"></a> <font size="-1">addNoise</font></center>
406
377
</td>
407
378
<td><font size="-1"><a href="Enumerations.html#NoiseType">NoiseType</a>
409
380
<td><font size="-1">Add noise to image with specified noise type.</font></td>
410
381
</tr>
411
382
<tr>
412
<td style="vertical-align: middle; text-align: center;"><small><a
413
name="addNoiseChannel"></a>addNoiseChannel<br>
414
</small></td>
415
<td style="vertical-align: middle;"><small>const ChannelType
416
channel_, const NoiseType noiseType_<br>
417
</small></td>
418
<td style="vertical-align: middle;"><small>Add noise to an image
419
channel with the specified noise type.</small><font size="-1"> The <span
420
style="font-style: italic;">channel_</span> parameter specifies the
421
channel to add noise to. The </font><small>noiseType_ parameter
422
specifies the type of noise.<br>
423
</small></td>
424
</tr>
425
<tr>
426
<td style="vertical-align: middle; text-align: center;"><small><a
383
<td style="vertical-align: middle;"><small><a
427
384
name="affineTransform"></a>affineTransform<br>
428
385
</small></td>
429
386
<td style="vertical-align: middle;"><small>const DrawableAffine
434
391
</small></td>
435
392
</tr>
436
393
<tr>
437
<td style="text-align: center;" rowspan="4">
394
<td rowspan="4">
438
395
<center><a name="annotate"></a> <font size="-1">annotate</font></center>
439
396
</td>
440
397
<td><font size="-1">const std::string &text_, const <a
447
404
&boundingArea_, <a href="Enumerations.html#GravityType">GravityType</a>
448
405
gravity_</font></td>
449
406
<td><font size="-1">Annotate using specified text, bounding area,
450
and placement gravity. If <i>boundingArea_</i> is invalid, then
451
bounding area is entire image.</font></td>
407
and placement gravity. If <i>boundingArea_</i> is invalid, then
408
bounding area is entire image.</font></td>
452
409
</tr>
453
410
<tr>
454
411
<td><font size="-1">const std::string &text_, const <a
456
413
href="Enumerations.html#GravityType">GravityType</a> gravity_, double
457
414
degrees_, </font></td>
458
415
<td><font size="-1">Annotate with text using specified text,
459
bounding area, placement gravity, and rotation. If <i>boundingArea_</i>
460
is invalid, then bounding area is entire image.</font></td>
416
bounding area, placement gravity, and rotation. If <i>boundingArea_</i>
417
is invalid, then bounding area is entire image.</font></td>
461
418
</tr>
462
419
<tr>
463
420
<td><font size="-1">const std::string &text_, <a
466
423
image) and placement gravity.</font></td>
467
424
</tr>
468
425
<tr>
469
<td style="text-align: center;">
426
<td>
470
427
<center><a name="blur"></a> <font size="-1">blur</font></center>
471
428
</td>
472
429
<td><font size="-1">const double radius_ = 1, const double sigma_
473
430
= 0.5</font></td>
474
431
<td><font size="-1">Blur image. The <i>radius_ </i>parameter
475
specifies the radius of the Gaussian, in pixels, not counting the
476
center
477
pixel. The <i>sigma_</i> parameter specifies the standard
478
deviation of the Laplacian, in pixels.</font></td>
479
</tr>
480
<tr>
481
<td style="vertical-align: middle; text-align: center;"><small><a
482
name="blurChannel"></a>blurChannel<br>
483
</small></td>
484
<td style="vertical-align: middle;"><small>const ChannelType
485
channel_, const double radius_ = 0.0, const double sigma_ = 1.0<br>
486
</small></td>
487
<td style="vertical-align: middle;"><font size="-1">Blur an image
488
channel. The <span style="font-style: italic;">channel_</span>
489
parameter specifies the channel to blur. The <i>radius_ </i>parameter
490
specifies the radius of the Gaussian, in pixels, not counting the
491
center
492
pixel. The <i>sigma_</i> parameter specifies the standard
493
deviation of the Laplacian, in pixels.</font></td>
494
</tr>
495
<tr>
496
<td style="text-align: center;">
432
specifies the radius of the Gaussian, in pixels, not counting the center
433
pixel. The <i>sigma_</i> parameter specifies the standard
434
deviation of the Laplacian, in pixels.</font></td>
435
</tr>
436
<tr>
437
<td>
497
438
<center><a name="border"></a> <font size="-1">border</font></center>
498
439
</td>
499
440
<td><font size="-1">const <a href="Geometry.html">Geometry</a>
502
443
color of the border is specified by the <i>borderColor</i> attribute.</font></td>
503
444
</tr>
504
445
<tr>
505
<td style="text-align: center;">
506
<center><a name="cdl"></a> <font size="-1">cdl</font></center>
507
</td>
508
<td><font size="-1">const std::string &cdl_</font></td>
509
<td><font size="-1">color correct with a color decision list. See <a href="http://en.wikipedia.org/wiki/ASC_CDL">http://en.wikipedia.org/wiki/ASC_CDL</a> for details.</font></td>
510
</tr>
511
<tr>
512
<td style="text-align: center;">
446
<td>
513
447
<center><a name="channel"></a> <font size="-1">channel</font></center>
514
448
</td>
515
449
<td><font size="-1"><a href="Enumerations.html#ChannelType">ChannelType</a>
516
450
layer_</font></td>
517
451
<td><font size="-1">Extract channel from image. Use this option
518
to extract a particular channel from the image. <i>MatteChannel</i>
452
to extract a particular channel from the image. <i>MatteChannel</i>
519
453
for example, is useful for extracting the opacity values
520
454
from an image.</font></td>
521
455
</tr>
522
456
<tr>
523
<td style="text-align: center;">
457
<td>
524
458
<center><a name="charcoal"></a> <font size="-1">charcoal</font></center>
525
459
</td>
526
460
<td><font size="-1">const double radius_ = 1, const double sigma_
527
461
= 0.5</font></td>
528
462
<td><font size="-1">Charcoal effect image (looks like charcoal
529
463
sketch). The <i>radius_</i> parameter specifies the radius of the
530
Gaussian, in pixels, not counting the center pixel. The <i>sigma_</i>
531
parameter specifies the standard deviation of the Laplacian, in pixels.</font></td>
464
Gaussian, in pixels, not counting the center pixel. The <i>sigma_</i>
465
parameter specifies the standard deviation of the Laplacian, in pixels.</font></td>
532
466
</tr>
533
467
<tr>
534
<td style="text-align: center;">
468
<td>
535
469
<center><a name="chop"></a> <font size="-1">chop</font></center>
536
470
</td>
537
471
<td><font size="-1">const <a href="Geometry.html">Geometry</a>
540
474
subregion of image)</font></td>
541
475
</tr>
542
476
<tr>
543
<td style="text-align: center;" rowspan="2">
477
<td rowspan="2">
544
478
<center><a name="colorize"></a> <font size="-1">colorize</font></center>
545
479
</td>
546
<td><font size="-1">const size_t opacityRed_, const
547
size_t opacityGreen_, const size_t opacityBlue_, const
480
<td><font size="-1">const unsigned int opacityRed_, const
481
unsigned int opacityGreen_, const unsigned int opacityBlue_, const
548
482
Color &penColor_</font></td>
549
483
<td><font size="-1">Colorize image with pen color, using
550
specified percent opacity for red, green, and blue quantums.</font></td>
551
</tr>
552
<tr>
553
<td style="text-align: center;">
554
<center><a name="colorMatrix"></a> <font size="-1">colorMatrix</font></center>
555
</td>
556
<td><font size="-1">const size_t order_, const double *color_matrix_</font></td>
557
<td><font size="-1">apply color correction to the image.</font></td>
558
</tr>
559
<tr>
560
<td style="text-align: center;">
484
specified percent opacity for red, green, and blue quantums.</font></td>
485
</tr>
486
<tr>
487
<td><font size="-1">const unsigned int opacity_, const Color
488
&penColor_</font></td>
489
<td><font size="-1">Colorize image with pen color, using
490
specified percent opacity.</font></td>
491
</tr>
492
<tr>
493
<td>
561
494
<center><a name="comment"></a> <font size="-1">comment</font></center>
562
495
</td>
563
<td><font size="-1">const std::string &comment_</font></td>
496
<td><font size="-1">const string &comment_</font></td>
564
497
<td><font size="-1">Comment image (add comment string to
565
498
image). By default, each image is commented with its file name.
566
Use this method to assign a specific comment to the
567
image. Optionally you can include the image filename, type,
568
width, height, or other image attributes by embedding <a
499
Use this method to assign a specific comment to the
500
image. Optionally you can include the image filename, type,
501
width, height, or other image attributes by embedding <a
569
502
href="FormatCharacters.html">special format characters.</a> </font></td>
570
503
</tr>
571
504
<tr>
572
<td style="text-align: center;" valign="middle"><font size="-1"><a
505
<td valign="middle" align="center"><font size="-1"><a
573
506
name="compare"></a> compare<br>
574
507
</font></td>
575
508
<td valign="middle"><font size="-1">const Image &reference_<br>
576
509
</font></td>
577
<td valign="top"><font size="-1">Compare current image with
578
another image. Sets <a href="#meanErrorPerPixel">meanErrorPerPixel</a>
579
, <a href="#normalizedMaxError">normalizedMaxError</a> , and <a
510
<td valign="top"><font size="-1">Compare current image with
511
another image. Sets <a href="#meanErrorPerPixel">meanErrorPerPixel</a> , <a
512
href="#normalizedMaxError">normalizedMaxError</a> , and <a
580
513
href="#normalizedMeanError">normalizedMeanError</a> in the current
581
image. False is returned if the images are identical. An ErrorOption
582
exception is thrown if the reference image columns, rows, colorspace,
583
or
514
image. False is returned if the images are identical. An ErrorOption
515
exception is thrown if the reference image columns, rows, colorspace, or
584
516
matte differ from the current image.</font><br>
585
517
</td>
586
518
</tr>
587
519
<tr>
588
<td style="text-align: center;" rowspan="3">
520
<td rowspan="3">
589
521
<center><a name="composite"></a> <font size="-1">composite</font></center>
590
522
</td>
591
523
<td><font size="-1">const <a href="Image.html">Image</a>
592
&compositeImage_, ssize_t xOffset_, ssize_t yOffset_, <a
524
&compositeImage_, int xOffset_, int yOffset_, <a
593
525
href="Enumerations.html#CompositeOperator"> CompositeOperator</a>
594
526
compose_ = <i>InCompositeOp</i></font></td>
595
527
<td><font size="-1">Compose an image onto the current image at
596
offset specified by <i>xOffset_</i>, <i>yOffset_ </i>using the
597
composition algorithm specified by <i>compose_</i>. </font></td>
528
offset specified by <i>xOffset_</i>, <i>yOffset_ </i>using the
529
composition algorithm specified by <i>compose_</i>. </font></td>
598
530
</tr>
599
531
<tr>
600
532
<td><font size="-1">const <a href="Image.html">Image</a>
602
534
&offset_, <a href="Enumerations.html#CompositeOperator">CompositeOperator</a>
603
535
compose_ = <i>InCompositeOp</i></font></td>
604
536
<td><font size="-1">Compose an image onto the current image at
605
offset specified by <i>offset_</i> using the composition algorithm
537
offset specified by <i>offset_</i> using the composition algorithm
606
538
specified by <i>compose_</i> . </font></td>
607
539
</tr>
608
540
<tr>
611
543
gravity_, <a href="Enumerations.html#CompositeOperator">CompositeOperator</a>
612
544
compose_ = <i>InCompositeOp</i></font></td>
613
545
<td><font size="-1">Compose an image onto the current image with
614
placement specified by <i>gravity_ </i>using the composition
615
algorithm
546
placement specified by <i>gravity_ </i>using the composition algorithm
616
547
specified by <i>compose_</i>. </font></td>
617
548
</tr>
618
549
<tr>
619
<td style="text-align: center;">
550
<td>
620
551
<center><a name="contrast"></a> <font size="-1">contrast</font></center>
621
552
</td>
622
<td><font size="-1">size_t sharpen_</font></td>
553
<td><font size="-1">unsigned int sharpen_</font></td>
623
554
<td><font size="-1">Contrast image (enhance intensity differences
624
555
in image)</font></td>
625
556
</tr>
626
557
<tr>
627
<td style="text-align: center;">
558
<td>
628
559
<center><a name="convolve"></a> <font size="-1">convolve</font></center>
629
560
</td>
630
<td><font size="-1">size_t order_, const double *kernel_</font></td>
561
<td><font size="-1">unsigned int order_, const double *kernel_</font></td>
631
562
<td><font size="-1">Convolve image. Applies a user-specfied
632
563
convolution to the image. The <i>order_</i> parameter represents the
633
number of columns and rows in the filter kernel, and <i>kernel_</i>
634
is a two-dimensional array of doubles representing the convolution
564
number of columns and rows in the filter kernel, and <i>kernel_</i>
565
is a two-dimensional array of doubles representing the convolution
635
566
kernel to apply.</font></td>
636
567
</tr>
637
568
<tr>
638
<td style="text-align: center;">
569
<td>
639
570
<center><a name="crop"></a> <font size="-1">crop</font></center>
640
571
</td>
641
572
<td><font size="-1">const <a href="Geometry.html">Geometry</a>
643
574
<td><font size="-1">Crop image (subregion of original image)</font></td>
644
575
</tr>
645
576
<tr>
646
<td style="text-align: center;">
577
<td>
647
578
<center><a name="cycleColormap"></a> <font size="-1">cycleColormap</font></center>
648
579
</td>
649
580
<td><font size="-1">int amount_</font></td>
650
581
<td><font size="-1">Cycle image colormap</font></td>
651
582
</tr>
652
583
<tr>
653
<td style="text-align: center;">
584
<td>
654
585
<center><a name="despeckle"></a> <font size="-1">despeckle</font></center>
655
586
</td>
656
587
<td><font size="-1">void</font></td>
657
588
<td><font size="-1">Despeckle image (reduce speckle noise)</font></td>
658
589
</tr>
659
590
<tr>
660
<td style="text-align: center;">
591
<td>
661
592
<center><a name="display"></a> <font size="-1">display</font></center>
662
593
</td>
663
594
<td><font size="-1">void</font></td>
664
595
<td><font size="-1">Display image on screen.</font> <br>
665
596
<font size="-1"><b><font color="#ff0000">Caution: </font></b> if
666
an image format is is not compatible with the display visual (e.g.
667
JPEG on a colormapped display) then the original image will be
597
an image format is not compatible with the display visual (e.g.
598
JPEG on a colormapped display) then the original image will be
668
599
altered. Use a copy of the original if this is a problem.</font></td>
669
600
</tr>
670
601
<tr>
671
<td>
672
<center><a name="distort"></a> <font size="-1">distort</font></center>
673
</td>
674
<td><font size="-1">const DistortImageMethod method, const unsigned long number_arguments, const double *arguments, const bool bestfit = false </font></td>
675
<td><font size="-1">Distort image. Applies a user-specfied
676
distortion to the image.</font></td>
677
</tr>
678
<tr>
679
<td style="text-align: center;" rowspan="2">
602
<td rowspan="2">
680
603
<center><a name="draw"></a> <font size="-1">draw</font></center>
681
604
</td>
682
605
<td><font size="-1">const <a href="Drawable.html">Drawable</a>
688
611
> &drawable_</font></td>
689
612
<td><font size="-1">Draw shapes or text on image using a set of
690
613
Drawable objects contained in an STL list. Use of this method improves
691
drawing performance and allows batching draw objects together in a
614
drawing performance and allows batching draw objects together in a
692
615
list for repeated use.</font></td>
693
616
</tr>
694
617
<tr>
695
<td style="text-align: center;">
618
<td>
696
619
<center><a name="edge"></a> <font size="-1">edge</font></center>
697
620
</td>
698
<td><font size="-1">size_t radius_ = 0.0</font></td>
621
<td><font size="-1">unsigned int radius_ = 0.0</font></td>
699
622
<td><font size="-1">Edge image (hilight edges in image).
700
The radius is the radius of the pixel neighborhood.. Specify a radius
701
of zero for automatic radius selection.</font></td>
623
The radius is the radius of the pixel neighborhood.. Specify a radius
624
of zero for automatic radius selection.</font></td>
702
625
</tr>
703
626
<tr>
704
<td style="text-align: center;">
627
<td>
705
628
<center><a name="emboss"></a> <font size="-1">emboss</font></center>
706
629
</td>
707
630
<td><font size="-1">const double radius_ = 1, const double sigma_
708
631
= 0.5</font></td>
709
632
<td><font size="-1">Emboss image (hilight edges with 3D effect).
710
633
The <i> radius_</i> parameter specifies the radius of the Gaussian, in
711
pixels, not counting the center pixel. The <i>sigma_</i>
712
parameter specifies the standard deviation of the Laplacian, in pixels.</font></td>
634
pixels, not counting the center pixel. The <i>sigma_</i>
635
parameter specifies the standard deviation of the Laplacian, in pixels.</font></td>
713
636
</tr>
714
637
<tr>
715
<td style="text-align: center;">
638
<td>
716
639
<center><a name="enhance"></a> <font size="-1">enhance</font></center>
717
640
</td>
718
641
<td><font size="-1">void</font></td>
719
642
<td><font size="-1">Enhance image (minimize noise)</font></td>
720
643
</tr>
721
644
<tr>
722
<td style="text-align: center;">
645
<td>
723
646
<center><a name="equalize"></a> <font size="-1">equalize</font></center>
724
647
</td>
725
648
<td><font size="-1">void</font></td>
726
649
<td><font size="-1">Equalize image (histogram equalization)</font></td>
727
650
</tr>
728
651
<tr>
729
<td style="text-align: center;">
652
<td>
730
653
<center><a name="erase"></a> <font size="-1">erase</font></center>
731
654
</td>
732
655
<td><font size="-1">void</font></td>
734
657
background color.</font></td>
735
658
</tr>
736
659
<tr>
737
<td style="text-align: center;" rowspan="4">
738
<center><a name="extent"></a> <font size="-1">extent</font></td>
739
<td><font size="-1">const <a href="Geometry.html"> Geometry</a> &geometry_</font></td>
740
<td rowspan="2"><font size="-1">extends the image as defined by the geometry, gravity, and image background color.</font></td>
741
</tr>
742
<tr>
743
<td><font size="-1">const <a href="Geometry.html">Geometry</a>
744
&geometry_, const <a href="Color.html">Color</a> &backgroundColor_</font></td>
745
</tr>
746
<tr>
747
<td><font size="-1">const <a href="Geometry.html"> Geometry</a> &geometry_, const <a href="Enumerations.html#GravityType">GravityType</a>
748
&gravity_</font></td>
749
<td rowspan="2"><font size="-1">extends the image as defined by the geometry, gravity, and image background color.</font></td>
750
</tr>
751
<tr>
752
<td><font size="-1">const <a href="Geometry.html">Geometry</a>
753
&geometry_, const <a href="Color.html">Color</a> &backgroundColor_,
754
const <a href="Enumerations.html#GravityType">GravityType</a> &gravity_</font></td>
755
</tr>
756
<tr>
757
<td style="text-align: center;">
660
<td>
758
661
<center><a name="flip"></a> <font size="-1">flip</font></center>
759
662
</td>
760
663
<td><font size="-1">void</font></td>
762
665
vertical direction)</font></td>
763
666
</tr>
764
667
<tr>
765
<td style="text-align: center;" rowspan="4">
766
<center><a name="floodFillColor"></a> <font size="-1">floodFill-</font>
767
<br>
668
<td rowspan="4">
669
<center><a name="floodFillColor"></a> <font size="-1">floodFill-</font> <br>
768
670
<font size="-1">Color</font></center>
769
671
</td>
770
<td><font size="-1">size_t x_, size_t y_, const <a
672
<td><font size="-1">unsigned int x_, unsigned int y_, const <a
771
673
href="Color.html"> Color</a> &fillColor_</font></td>
772
674
<td rowspan="2"><font size="-1">Flood-fill color across pixels
773
that match the color of the target pixel and are neighbors of the
774
target pixel. Uses current fuzz setting when determining color match.</font></td>
675
that match the color of the target pixel and are neighbors of the
676
target pixel. Uses current fuzz setting when determining color match.</font></td>
775
677
</tr>
776
678
<tr>
777
679
<td><font size="-1">const <a href="Geometry.html">Geometry</a>
778
680
&point_, const <a href="Color.html">Color</a> &fillColor_</font></td>
779
681
</tr>
780
682
<tr>
781
<td><font size="-1">size_t x_, size_t y_, const <a
782
href="Color.html"> Color</a> &fillColor_, const <a
783
href="Color.html">Color</a>
683
<td><font size="-1">unsigned int x_, unsigned int y_, const <a
684
href="Color.html"> Color</a> &fillColor_, const <a href="Color.html">Color</a>
784
685
&borderColor_</font></td>
785
686
<td rowspan="2"><font size="-1">Flood-fill color across pixels
786
687
starting at target-pixel and stopping at pixels matching specified
787
border color. Uses current fuzz setting when determining color match.</font></td>
688
border color. Uses current fuzz setting when determining color match.</font></td>
788
689
</tr>
789
690
<tr>
790
691
<td><font size="-1">const <a href="Geometry.html">Geometry</a>
791
&point_, const <a href="Color.html">Color</a> &fillColor_,
792
const <a href="Color.html">Color</a> &borderColor_</font></td>
692
&point_, const <a href="Color.html">Color</a> &fillColor_, const <a
693
href="Color.html">Color</a> &borderColor_</font></td>
793
694
</tr>
794
695
<tr>
795
<td style="text-align: center;"><a name="floodFillOpacity"></a> <font
796
size="-1">floodFillOpacity</font></td>
696
<td><a name="floodFillOpacity"></a> <font size="-1">floodFillOpacity</font></td>
797
697
<td><font size="-1">const long x_, const long y_, const unsigned
798
int opacity_, const PaintMethod method_</font></td>
698
int opacity_, const PaintMethod method_</font></td>
799
699
<td><font size="-1">Floodfill pixels matching color (within fuzz
800
factor) of target pixel(x,y) with replacement opacity value using
801
method.</font></td>
700
factor) of target pixel(x,y) with replacement opacity value using method.</font></td>
802
701
</tr>
803
702
<tr>
804
<td style="text-align: center;" rowspan="4">
805
<center><a name="floodFillTexture"></a> <font size="-1">floodFill-</font>
806
<br>
703
<td rowspan="4">
704
<center><a name="floodFillTexture"></a> <font size="-1">floodFill-</font> <br>
807
705
<font size="-1">Texture</font></center>
808
706
</td>
809
<td><font size="-1">size_t x_, size_t y_, const
707
<td><font size="-1">unsigned int x_, unsigned int y_, const
810
708
Image &texture_</font></td>
811
709
<td rowspan="2"><font size="-1">Flood-fill texture across pixels
812
that match the color of the target pixel and are neighbors of the
813
target pixel. Uses current fuzz setting when determining color match.</font></td>
710
that match the color of the target pixel and are neighbors of the
711
target pixel. Uses current fuzz setting when determining color match.</font></td>
814
712
</tr>
815
713
<tr>
816
714
<td><font size="-1">const <a href="Geometry.html">Geometry</a>
817
715
&point_, const Image &texture_</font></td>
818
716
</tr>
819
717
<tr>
820
<td><font size="-1">size_t x_, size_t y_, const Image
718
<td><font size="-1">unsigned int x_, unsigned int y_, const Image
821
719
&texture_, const <a href="Color.html">Color</a> &borderColor_</font></td>
822
720
<td rowspan="2"><font size="-1">Flood-fill texture across pixels
823
721
starting at target-pixel and stopping at pixels matching specified
824
border color. Uses current fuzz setting when determining color match.</font></td>
722
border color. Uses current fuzz setting when determining color match.</font></td>
825
723
</tr>
826
724
<tr>
827
725
<td><font size="-1">const <a href="Geometry.html">Geometry</a>
828
&point_, const Image &texture_, const <a href="Color.html">
829
Color</a>
726
&point_, const Image &texture_, const <a href="Color.html"> Color</a>
830
727
&borderColor_</font></td>
831
728
</tr>
832
729
<tr>
833
<td style="text-align: center;">
730
<td>
834
731
<center><a name="flop"></a> <font size="-1">flop</font></center>
835
732
</td>
836
733
<td><font size="-1">void </font></td>
838
735
horizontal direction)</font></td>
839
736
</tr>
840
737
<tr>
841
<td>
842
<center><a name="forwardFourierTransform"></a> <font size="-1">forwardFourierTransform</font></center>
843
</td>
844
<td><font size="-1">const bool magnitude</font></td>
845
<td><font size="-1">Implements the discrete Fourier transform (DFT) of the image either as a magnitude / phase or real / imaginary image pair.</font></td>
846
</tr>
847
<tr>
848
<td style="text-align: center;" rowspan="2">
738
<td rowspan="2">
849
739
<center><a name="frame"></a> <font size="-1">frame</font></center>
850
740
</td>
851
741
<td><font size="-1">const <a href="Geometry.html">Geometry</a>
853
743
<td rowspan="2"><font size="-1">Add decorative frame around image</font></td>
854
744
</tr>
855
745
<tr>
856
<td><font size="-1">size_t width_, size_t height_,
857
int x_, ssize_t y_, ssize_t innerBevel_ = 0, ssize_t outerBevel_ = 0</font></td>
858
</tr>
859
<tr>
860
<td>
861
<center><a name="fx"></a> <font size="-1">fx</font></center>
862
</td>
863
<td><font size="-1">const std::string expression, const Magick::ChannelType channel</font></td>
864
<td><font size="-1">Fx image. Applies a mathematical
865
expression to the image.</font></td>
866
</tr>
867
<tr>
868
<td style="text-align: center;" rowspan="2">
746
<td><font size="-1">unsigned int width_, unsigned int height_,
747
int x_, int y_, int innerBevel_ = 0, int outerBevel_ = 0</font></td>
748
</tr>
749
<tr>
750
<td rowspan="2">
869
751
<center><a name="gamma"></a> <font size="-1">gamma</font></center>
870
752
</td>
871
753
<td><font size="-1">double gamma_</font></td>
879
761
of image.</font></td>
880
762
</tr>
881
763
<tr>
882
<td style="text-align: center;">
764
<td>
883
765
<center><a name="gaussianBlur"></a> <font size="-1">gaussianBlur</font></center>
884
766
</td>
885
767
<td><font size="-1">const double width_, const double sigma_</font></td>
886
768
<td><font size="-1">Gaussian blur image. The number of neighbor
887
769
pixels to be included in the convolution mask is specified by
888
'width_'. For example, a width of one gives a (standard) 3x3
889
convolution mask. The standard deviation of the gaussian bell curve is
890
specified by 'sigma_'.</font></td>
891
</tr>
892
<tr>
893
<td style="vertical-align: middle; text-align: center;"><small><a
894
name="gaussianBlurChannel"></a>gaussianBlurChannel<br>
895
</small></td>
896
<td style="vertical-align: middle;"><small>const ChannelType
897
channel_, const double radius_ = 0.0, const double sigma_ = 1.0<br>
898
</small></td>
899
<td style="vertical-align: middle;"><font size="-1">Gaussian blur
900
an image channel. </font><font size="-1">The <span
901
style="font-style: italic;">channel_</span> parameter specifies the
902
channel to blur. </font><font size="-1">The number of neighbor
903
pixels to be included in the convolution mask is specified by
904
'width_'. For example, a width of one gives a (standard) 3x3
905
convolution mask. The standard deviation of the gaussian bell curve is
906
specified by 'sigma_'.</font></td>
907
</tr>
908
<tr>
909
<td style="text-align: center;" valign="middle"><font size="-1"><a
910
name="haldClut"></a> haldClut<br>
911
</font></td>
912
<td valign="middle"><font size="-1">const Image &reference_<br>
913
</font></td>
914
<td valign="top"><font size="-1">apply a Hald color lookup table to the image.</font><br>
915
</td>
916
</tr>
917
<tr>
918
<td style="text-align: center;">
770
'width_'. For example, a width of one gives a (standard) 3x3
771
convolution mask. The standard deviation of the gaussian bell curve is
772
specified by 'sigma_'.</font></td>
773
</tr>
774
<tr>
775
<td>
919
776
<center><a name="implode"></a> <font size="-1">implode</font></center>
920
777
</td>
921
778
<td><font size="-1">const double factor_</font></td>
922
779
<td><font size="-1">Implode image (special effect)</font></td>
923
780
</tr>
924
781
<tr>
925
<td style="text-align: center;">
926
<center><a name="inverseFourierTransform"></a> <font size="-1">inverseFourierTransform</font></center>
927
</td>
928
<td><font size="-1">const Image &phaseImage_, const bool magnitude_</font></td>
929
<td><font size="-1">implements the inverse discrete Fourier transform (DFT) of the image either as a magnitude / phase or real / imaginary image pair.</font></td>
930
</tr>
931
<tr>
932
<td style="text-align: center;">
782
<td>
933
783
<center><a name="label"></a> <font size="-1">label</font></center>
934
784
</td>
935
785
<td><font size="-1">const string &label_</font></td>
936
786
<td><font size="-1">Assign a label to an image. Use this option
937
787
to assign a specific label to the image. Optionally
938
you can include the image filename, type, width, height, or scene
939
number in the label by embedding <a href="FormatCharacters.html">
940
special format characters.</a> If the first character of string is @,
941
the
942
image label is read from a file titled by the remaining characters in
788
you can include the image filename, type, width, height, or scene
789
number in the label by embedding <a href="FormatCharacters.html">
790
special format characters.</a> If the first character of string is @, the
791
image label is read from a file titled by the remaining characters in
943
792
the string. When converting to Postscript, use this option to
944
793
specify a header string to print above the image.</font></td>
945
794
</tr>
959
808
specifies a gamma correction to apply to the image. White point
960
809
specifies the lightest color in the image. Colors brighter than
961
810
the white point are set to the maximum quantum value. The black and
962
white point have the valid range 0 to MaxRGB while mid (gamma) has a
811
white point have the valid range 0 to QuantumRange while mid (gamma) has a
963
812
useful range of 0 to ten.<br>
964
813
</small></td>
965
814
</tr>
966
815
<tr>
967
<td style="vertical-align: middle; text-align: center;"><small><a
816
<td style="vertical-align: top; text-align: center;"><small><a
968
817
name="levelChannel"></a>levelChannel<br>
969
818
</small></td>
970
<td style="vertical-align: middle;"><small>const ChannelType
819
<td style="vertical-align: top;"><small>const ChannelType
971
820
channel, const double black_point, const double white_point, const
972
821
double mid_point=1.0<br>
973
822
</small></td>
974
<td style="vertical-align: middle;"><small>Level image channel.
823
<td style="vertical-align: top;"><small>Level image channel.
975
824
Adjust the levels of the image channel by scaling the values falling
976
825
between specified white and black points to the full available quantum
977
826
range. The parameters provided represent the black, mid (gamma), and
980
829
specifies a gamma correction to apply to the image. White point
981
830
specifies the lightest color in the image. Colors brighter than the
982
831
white point are set to the maximum quantum value. The black and white
983
point have the valid range 0 to MaxRGB while mid (gamma) has a useful
832
point have the valid range 0 to QuantumRange while mid (gamma) has a useful
984
833
range of 0 to ten.<br>
985
834
</small></td>
986
835
</tr>
987
836
<tr>
988
<td style="text-align: center;">
837
<td>
989
838
<center><a name="magnify"></a> <font size="-1">magnify</font></center>
990
839
</td>
991
840
<td><font size="-1">void</font></td>
992
841
<td><font size="-1">Magnify image by integral size</font></td>
993
842
</tr>
994
843
<tr>
995
<td style="text-align: center;">
844
<td>
996
845
<center><a name="map"></a> <font size="-1">map</font></center>
997
846
</td>
998
847
<td><font size="-1">const Image &mapImage_ , bool dither_ =
999
848
false</font></td>
1000
849
<td><font size="-1">Remap image colors with closest color from
1001
reference image. Set dither_ to <i>true</i> in to apply
1002
Floyd/Steinberg
1003
error diffusion to the image. By default, color reduction chooses an
1004
optimal set of colors that best represent the original
850
reference image. Set dither_ to <i>true</i> in to apply Floyd/Steinberg
851
error diffusion to the image. By default, color reduction chooses an
852
optimal set of colors that best represent the original
1005
853
image. Alternatively, you can choose a
1006
particular set of colors from an image file
854
particular set of colors from an image file
1007
855
with this option.</font></td>
1008
856
</tr>
1009
857
<tr>
1010
<td style="text-align: center;">
858
<td>
1011
859
<center><a name="matteFloodfill"></a> <font size="-1">matteFloodfill</font></center>
1012
860
</td>
1013
861
<td><font size="-1">const <a href="Color.html">Color</a>
1014
&target_, const size_t opacity_, const ssize_t x_, const
1015
int
862
&target_, const unsigned int opacity_, const int x_, const int
1016
863
y_, <a href="Enumerations.html#PaintMethod">PaintMethod</a> method_</font></td>
1017
864
<td><font size="-1">Floodfill designated area with a replacement
1018
865
opacity value.</font></td>
1019
866
</tr>
1020
867
<tr>
1021
<td style="text-align: center;"><a name="medianFilter"></a> <font
1022
size="-1">medianFilter</font></td>
868
<td><a name="medianFilter"></a> <font size="-1">medianFilter</font></td>
1023
869
<td><font size="-1">const double radius_ = 0.0</font></td>
1024
870
<td><font size="-1">Filter image by replacing each pixel
1025
component with the median color in a circular neighborhood</font></td>
871
component with the median color in a circular neighborhood</font></td>
1026
872
</tr>
1027
873
<tr>
1028
<td style="text-align: center;">
874
<td>
1029
875
<center><a name="minify"></a> <font size="-1">minify</font></center>
1030
876
</td>
1031
877
<td><font size="-1">void</font></td>
1032
878
<td><font size="-1">Reduce image by integral size</font></td>
1033
879
</tr>
1034
880
<tr>
1035
<td style="text-align: center;"><a name="modifyImage"></a> <font
1036
size="-1">modifyImage</font></td>
881
<td><a name="modifyImage"></a> <font size="-1">modifyImage</font></td>
1037
882
<td><font size="-1">void</font></td>
1038
883
<td><font size="-1">Prepare to update image. Ensures that there
1039
is only one reference to the underlying image so that the underlying
1040
image may be safely modified without effecting previous generations of
1041
the image. Copies the underlying image to a new image if necessary.</font></td>
884
is only one reference to the underlying image so that the underlying
885
image may be safely modified without effecting previous generations of
886
the image. Copies the underlying image to a new image if necessary.</font></td>
1042
887
</tr>
1043
888
<tr>
1044
<td style="text-align: center;">
889
<td>
1045
890
<center><a name="modulate"></a> <font size="-1">modulate</font></center>
1046
891
</td>
1047
892
<td><font size="-1">double brightness_, double saturation_,
1048
893
double hue_</font></td>
1049
894
<td><font size="-1">Modulate percent hue, saturation, and
1050
brightness of an image. Modulation of saturation and brightness is as a
895
brightness of an image. Modulation of saturation and brightness is as a
1051
896
ratio of the current value (1.0 for no change). Modulation of hue is an
1052
897
absolute rotation of -180 degrees to +180 degrees from the current
1053
898
position corresponding to an argument range of 0 to 2.0 (1.0 for no
1054
899
change).</font></td>
1055
900
</tr>
1056
901
<tr>
1057
<td style="vertical-align: middle; text-align: center;"><small><a
1058
name="motionBlur"></a>motionBlur<br>
1059
</small></td>
1060
<td style="vertical-align: middle;"><small>const double radius_,
1061
const double sigma_, const double angle_<br>
1062
</small></td>
1063
<td style="vertical-align: middle;"><small>Motion blur image with
1064
specified blur factor. The radius_ parameter specifies the radius of
1065
the Gaussian, in pixels, not counting the center pixel. The
1066
sigma_ parameter specifies the standard deviation of the Laplacian, in
1067
pixels. The angle_ parameter specifies the angle the object appears to
1068
be comming from (zero degrees is from the right).<br>
1069
</small></td>
1070
</tr>
1071
<tr>
1072
<td style="text-align: center;">
902
<td>
1073
903
<center><a name="negate"></a> <font size="-1">negate</font></center>
1074
904
</td>
1075
905
<td><font size="-1">bool grayscale_ = false</font></td>
1076
906
<td><font size="-1">Negate colors in image. Replace every
1077
pixel with its complementary color (white becomes black, yellow becomes
1078
blue, etc.). Set grayscale to only negate grayscale values in
907
pixel with its complementary color (white becomes black, yellow becomes
908
blue, etc.). Set grayscale to only negate grayscale values in
1079
909
image.</font></td>
1080
910
</tr>
1081
911
<tr>
1082
<td style="text-align: center;">
912
<td>
1083
913
<center><a name="normalize"></a> <font size="-1">normalize</font></center>
1084
914
</td>
1085
915
<td><font size="-1">void</font></td>
1086
916
<td><font size="-1">Normalize image (increase contrast by
1087
normalizing the pixel values to span the full range of color values).</font></td>
917
normalizing the pixel values to span the full range of color values).</font></td>
1088
918
</tr>
1089
919
<tr>
1090
<td style="text-align: center;">
920
<td>
1091
921
<center><a name="oilPaint"></a> <font size="-1">oilPaint</font></center>
1092
922
</td>
1093
<td><font size="-1">size_t radius_ = 3</font></td>
923
<td><font size="-1">unsigned int radius_ = 3</font></td>
1094
924
<td><font size="-1">Oilpaint image (image looks like oil painting)</font></td>
1095
925
</tr>
1096
926
<tr>
1097
<td style="text-align: center;">
927
<td>
1098
928
<center><a name="opacity"></a> <font size="-1">opacity</font></center>
1099
929
</td>
1100
<td><font size="-1">size_t opacity_</font></td>
930
<td><font size="-1">unsigned int opacity_</font></td>
1101
931
<td><font size="-1">Set or attenuate the opacity channel in the
1102
image. If the image pixels are opaque then they are set to the
1103
specified
932
image. If the image pixels are opaque then they are set to the specified
1104
933
opacity value, otherwise they are blended with the supplied opacity
1105
value. The value of opacity_ ranges from 0 (completely opaque) to
1106
<i>MaxRGB</i>
934
value. The value of opacity_ ranges from 0 (completely opaque) to <i>QuantumRange</i>
1107
935
. The defines <i>OpaqueOpacity</i> and <i>TransparentOpacity</i> are
1108
936
available to specify completely opaque or completely transparent,
1109
937
respectively.</font></td>
1110
938
</tr>
1111
939
<tr>
1112
<td style="text-align: center;">
940
<td>
1113
941
<center><a name="opaque"></a> <font size="-1">opaque</font></center>
1114
942
</td>
1115
943
<td><font size="-1">const <a href="Color.html">Color</a>
1116
944
&opaqueColor_, const <a href="Color.html">Color</a> &penColor_</font></td>
1117
945
<td><font size="-1">Change color of pixels matching opaqueColor_
1118
to specified penColor_.</font></td>
946
to specified penColor_.</font></td>
1119
947
</tr>
1120
948
<tr nosave="">
1121
<td style="text-align: center;" rowspan="2" nosave="">
949
<td rowspan="2" nosave="">
1122
950
<center><a name="ping"></a> <font size="-1">ping</font></center>
1123
951
</td>
1124
952
<td><font size="-1">const std::string &imageSpec_</font></td>
1125
953
<td rowspan="2" nosave=""><font size="-1">Ping is similar to read
1126
954
except only enough of the image is read to determine the image columns,
1127
rows, and filesize. The <a href="#columns">columns</a> </font>,
1128
<font size="-1"><a href="#rows">rows</a> , and <a
1129
href="#fileSize">fileSize</a>
955
rows, and filesize. The <a href="#columns">columns</a> </font>, <font
956
size="-1"><a href="#rows">rows</a> , and <a href="#fileSize">fileSize</a>
1130
957
attributes are valid after invoking ping. The image data is not
1131
958
valid after calling ping.</font></td>
1132
959
</tr>
1134
961
<td><font size="-1">const Blob &blob_</font></td>
1135
962
</tr>
1136
963
<tr>
1137
<td style="vertical-align: middle; text-align: center;"><small><a
964
<td style="text-align: center; vertical-align: middle;"><small><a
1138
965
name="process"></a>process<br>
1139
966
</small></td>
1140
967
<td style="vertical-align: middle;"><small>std::string name_,
1141
const ssize_t argc_, char **argv_<br>
968
const int argc_, char **argv_<br>
1142
969
</small></td>
1143
970
<td style="vertical-align: middle;"><small>Execute the named
1144
process module, passing any arguments via an argument vector, with
1145
argc_
971
process module, passing any arguments via an argument vector, with argc_
1146
972
specifying the number of arguments in the vector, and argv_ passing the
1147
973
address of an array of null-terminated C strings which constitute the
1148
974
argument vector. An exception is thrown if the requested process module
1150
976
</td>
1151
977
</tr>
1152
978
<tr>
1153
<td style="text-align: center;">
979
<td>
1154
980
<center><a name="quantize"></a> <font size="-1">quantize</font></center>
1155
981
</td>
1156
982
<td><font size="-1">bool measureError_ = false</font></td>
1158
984
measureError_ to true in order to calculate error attributes.</font></td>
1159
985
</tr>
1160
986
<tr>
1161
<td style="text-align: center;">
987
<td>
1162
988
<center><a name="raise"></a> <font size="-1">raise</font></center>
1163
989
</td>
1164
990
<td><font size="-1">const <a href="Geometry.html">Geometry</a>
1165
991
&geometry_ = "6x6+0+0", bool raisedFlag_ = false</font></td>
1166
992
<td><font size="-1">Raise image (lighten or darken the edges of
1167
an image to give a 3-D raised or lowered effect)</font></td>
993
an image to give a 3-D raised or lowered effect)</font></td>
1168
994
</tr>
1169
995
<tr>
1170
<td style="text-align: center;" rowspan="8">
996
<td rowspan="8">
1171
997
<center><a name="read"></a> <font size="-1">read</font></center>
1172
998
</td>
1173
999
<td><font size="-1">const string &imageSpec_</font></td>
1177
1003
<td><font size="-1">const <a href="Geometry.html">Geometry</a>
1178
1004
&size_, const std::string &imageSpec_</font></td>
1179
1005
<td><font size="-1">Read image of specified size into current
1180
object. This form is useful for images that do not specifiy their size
1181
or to specify a size hint for decoding an image. For example, when
1182
reading a Photo CD, JBIG, or JPEG image, a size request causes the
1183
library to return an image which is the next resolution greater or
1184
equal to the specified size. This may result in memory and time savings.</font></td>
1006
object. This form is useful for images that do not specifiy their size
1007
or to specify a size hint for decoding an image. For example, when
1008
reading a Photo CD, JBIG, or JPEG image, a size request causes the
1009
library to return an image which is the next resolution greater or
1010
equal to the specified size. This may result in memory and time savings.</font></td>
1185
1011
</tr>
1186
1012
<tr>
1187
1013
<td><font size="-1">const <a href="Blob.html">Blob</a> &blob_</font></td>
1188
1014
<td rowspan="5"><font size="-1">Read encoded image of specified
1189
size from an in-memory <a href="Blob.html">BLOB</a> into current
1190
object. Depending on the method arguments, the Blob size, depth, and
1191
format may also be specified. Some image formats require that size be
1015
size from an in-memory <a href="Blob.html">BLOB</a> into current
1016
object. Depending on the method arguments, the Blob size, depth, and
1017
format may also be specified. Some image formats require that size be
1192
1018
specified. The default ImageMagick uses for depth depends on its
1193
1019
Quantum size (8 or 16). If ImageMagick's Quantum size does not
1194
1020
match that of the image, the depth may need to be specified.
1195
ImageMagick can usually automagically detect the image's format.
1196
When
1197
a format can't be automagically detected, the format must be specified.</font></td>
1021
ImageMagick can usually automatically detect the image's format. When
1022
a format can't be automatically detected, the format must be specified.</font></td>
1198
1023
</tr>
1199
1024
<tr>
1200
1025
<td><font size="-1">const <a href="Blob.html">Blob</a>
1203
1028
<tr>
1204
1029
<td><font size="-1">const <a href="Blob.html">Blob</a>
1205
1030
&blob_, const <a href="Geometry.html">Geometry</a> &size_,
1206
size_t depth_</font></td>
1031
unsigned int depth_</font></td>
1207
1032
</tr>
1208
1033
<tr>
1209
1034
<td><font size="-1">const <a href="Blob.html">Blob</a>
1212
1037
</tr>
1213
1038
<tr>
1214
1039
<td><font size="-1">const <a href="Blob.html">Blob</a>
1215
&blob_, const <a href="Geometry.html">Geometry</a> &size_,
1216
const
1040
&blob_, const <a href="Geometry.html">Geometry</a> &size_, const
1217
1041
string &magick_</font></td>
1218
1042
</tr>
1219
1043
<tr>
1220
<td><font size="-1">const size_t width_, const size_t
1221
height_, std::string map_, const StorageType type_, const void *pixels_</font></td>
1044
<td><font size="-1">const unsigned int width_, const unsigned int
1045
height_, std::string map_, const StorageType type_, const unsigned char* pixels_</font></td>
1222
1046
<td><font size="-1">Read image based on an array of image pixels.
1223
The pixel data must be in scanline order top-to-bottom. The data can be
1047
The pixel data must be in scanline order top-to-bottom. The data can be
1224
1048
character, short int, integer, float, or double. Float and double
1225
require the pixels to be normalized [0..1]. The other types are
1226
[0..MaxRGB]. For example, to create a 640x480 image from
1049
require the pixels to be normalized [0..1]. The other types are
1050
[0..QuantumRange]. For example, to create a 640x480 image from
1227
1051
unsigned red-green-blue character data, use</font>
1228
<p><font size="-1"> image.read( 640, 480, "RGB", CharPixel,
1052
<p><font size="-1"> image.read( 640, 480, "RGB", 0,
1229
1053
pixels );</font> </p>
1230
1054
<p><font size="-1">The parameters are as follows:</font> <br>
1231
1055
1242
1066
<tr>
1243
1067
<td><font size="-1">map_</font></td>
1244
1068
<td><font size="-1">This character string can be any
1245
combination or order of R = red, G = green, B = blue, A = alpha, C =
1246
cyan, Y = yellow M = magenta, and K = black. The ordering reflects the
1247
order of the pixels in the supplied pixel array.</font></td>
1069
combination or order of R = red, G = green, B = blue, A = alpha, C =
1070
cyan, Y = yellow M = magenta, and K = black. The ordering reflects the
1071
order of the pixels in the supplied pixel array.</font></td>
1248
1072
</tr>
1249
1073
<tr>
1250
1074
<td><font size="-1">type_</font></td>
1251
1075
<td><font size="-1">Pixel storage type (CharPixel,
1252
ShortPixel, IntegerPixel, FloatPixel, or DoublePixel)</font></td>
1076
ShortPixel, IntegerPixel, FloatPixel, or DoublePixel)</font></td>
1253
1077
</tr>
1254
1078
<tr>
1255
1079
<td><font size="-1">pixels_</font></td>
1256
1080
<td><font size="-1">This array of values contain the pixel
1257
components as defined by the map_ and type_ parameters. The length of
1258
the arrays must equal the area specified by the width_ and height_
1081
components as defined by the map_ and type_ parameters. The length of
1082
the arrays must equal the area specified by the width_ and height_
1259
1083
values and type_ parameters.</font></td>
1260
1084
</tr>
1261
1085
</tbody>
1264
1088
</td>
1265
1089
</tr>
1266
1090
<tr>
1267
<td style="text-align: center;">
1091
<td rowspan="2">
1268
1092
<center><a name="reduceNoise"></a> <font size="-1">reduceNoise</font></center>
1269
1093
</td>
1270
<td><font size="-1">const double order_</font></td>
1271
<td><font size="-1">reduce noise in image using a noise peak elimination filter.</font></td>
1272
</tr>
1273
<tr>
1274
<td style="vertical-align: middle; text-align: center;"><small><a
1275
name="randomThreshold"></a>randomThreshold<br>
1276
</small></td>
1277
<td style="vertical-align: middle;"><small>const Geometry
1278
&thresholds_<br>
1279
</small></td>
1280
<td style="vertical-align: middle;"><small>Random threshold the
1281
image. Changes the value of individual pixels based on the intensity of
1282
each pixel compared to a random threshold. The result is a
1283
low-contrast, two color image. The thresholds_ argument is a
1284
geometry containing LOWxHIGH thresholds. If the string contains
1285
2x2, 3x3, or 4x4, then an ordered dither of order 2, 3, or 4 will be
1286
performed instead. This is a very fast alternative to 'quantize' based
1287
dithering.<br>
1288
</small></td>
1289
</tr>
1290
<tr>
1291
<td style="vertical-align: middle; text-align: center;"><small><a
1292
name="randomThresholdChannel"></a>randomThresholdChannel<br>
1293
</small></td>
1294
<td style="vertical-align: middle;"><small>const Geometry
1295
&thresholds_, const ChannelType channel_<br>
1296
</small></td>
1297
<td style="vertical-align: middle;"><small>Random threshold an
1298
image channel. Similar to <a href="#randomThreshold">randomThreshold</a>()
1299
but restricted to the specified channel.<br>
1300
</small></td>
1301
</tr>
1302
<tr>
1303
<td style="text-align: center;">
1094
<td><font size="-1">void</font></td>
1095
<td rowspan="2"><font size="-1">Reduce noise in image using a
1096
noise peak elimination filter.</font></td>
1097
</tr>
1098
<tr>
1099
<td><font size="-1">unsigned int order_</font></td>
1100
</tr>
1101
<tr>
1102
<td>
1304
1103
<center><a name="roll"></a> <font size="-1">roll</font></center>
1305
1104
</td>
1306
<td><font size="-1">int columns_, ssize_t rows_</font></td>
1105
<td><font size="-1">int columns_, int rows_</font></td>
1307
1106
<td><font size="-1">Roll image (rolls image vertically and
1308
1107
horizontally) by specified number of columnms and rows)</font></td>
1309
1108
</tr>
1310
1109
<tr>
1311
<td style="text-align: center;">
1110
<td>
1312
1111
<center><a name="rotate"></a> <font size="-1">rotate</font></center>
1313
1112
</td>
1314
1113
<td><font size="-1">double degrees_</font></td>
1316
1115
number of degrees.</font></td>
1317
1116
</tr>
1318
1117
<tr>
1319
<td style="text-align: center;">
1118
<td>
1320
1119
<center><a name="sample"></a> <font size="-1">sample</font></center>
1321
1120
</td>
1322
1121
<td><font size="-1">const <a href="Geometry.html">Geometry</a>
1324
1123
<td><font size="-1">Resize image by using pixel sampling algorithm</font></td>
1325
1124
</tr>
1326
1125
<tr>
1327
<td style="text-align: center;">
1126
<td>
1328
1127
<center><a name="scale"></a> <font size="-1">scale</font></center>
1329
1128
</td>
1330
1129
<td><font size="-1">const <a href="Geometry.html">Geometry</a>
1332
1131
<td><font size="-1">Resize image by using simple ratio algorithm</font></td>
1333
1132
</tr>
1334
1133
<tr>
1335
<td style="text-align: center;">
1134
<td>
1336
1135
<center><a name="segment"></a> <font size="-1">segment</font></center>
1337
1136
</td>
1338
1137
<td><font size="-1">double clusterThreshold_ = 1.0,</font> <br>
1339
1138
<font size="-1">double smoothingThreshold_ = 1.5</font></td>
1340
1139
<td><font size="-1">Segment (coalesce similar image components)
1341
by analyzing the histograms of the color components and identifying
1342
units that are homogeneous with the fuzzy c-means technique. Also uses <i>quantizeColorSpace</i>
1343
and <i>verbose</i> image attributes. Specify <i> clusterThreshold_</i>
1344
,
1345
as the number of pixels each cluster must
1346
exceed
1140
by analyzing the histograms of the color components and identifying
1141
units that are homogeneous with the fuzzy c-means technique. Also uses <i>quantizeColorSpace</i>
1142
and <i>verbose</i> image attributes. Specify <i> clusterThreshold_</i> ,
1143
as the number of pixels each cluster must exceed
1347
1144
the cluster threshold to be considered valid. <i>SmoothingThreshold_</i>
1348
eliminates noise in the second derivative of the histogram. As
1349
the
1145
eliminates noise in the second derivative of the histogram. As the
1350
1146
value is increased, you can expect a smoother
1351
1147
second derivative. The default is 1.5.</font></td>
1352
1148
</tr>
1353
1149
<tr>
1354
<td style="text-align: center;">
1150
<td>
1355
1151
<center><a name="shade"></a> <font size="-1">shade</font></center>
1356
1152
</td>
1357
<td><font size="-1">double azimuth_ = 30, double elevation_ = 30,</font>
1358
<br>
1153
<td><font size="-1">double azimuth_ = 30, double elevation_ = 30,</font> <br>
1359
1154
<font size="-1">bool colorShading_ = false</font></td>
1360
1155
<td><font size="-1">Shade image using distant light source.
1361
1156
Specify <i> azimuth_</i> and <i>elevation_</i> as the
1362
position of the light source. By default, the shading
1363
results as a grayscale image.. Set c<i>olorShading_</i> to <i>true</i>
1364
to
1365
shade the red, green, and blue components of the image.</font></td>
1157
position of the light source. By default, the shading
1158
results as a grayscale image.. Set c<i>olorShading_</i> to <i>true</i> to
1159
shade the red, green, and blue components of the image.</font></td>
1366
1160
</tr>
1367
1161
<tr>
1368
<td style="text-align: center;">
1162
<td>
1369
1163
<center><a name="sharpen"></a> <font size="-1">sharpen</font></center>
1370
1164
</td>
1371
1165
<td><font size="-1">const double radius_ = 1, const double sigma_
1376
1170
standard deviation of the Laplacian, in pixels.</font></td>
1377
1171
</tr>
1378
1172
<tr>
1379
<td style="vertical-align: middle; text-align: center;"><small><a
1380
name="sharpenChannel"></a>sharpenChannel<br>
1381
</small></td>
1382
<td style="vertical-align: middle;"><small>const ChannelType
1383
channel_, const double radius_ = 0.0, const double sigma_ = 1.0<br>
1384
</small></td>
1385
<td style="vertical-align: middle;"><font size="-1">Sharpen pixel
1386
quantums in an image channel The <span
1387
style="font-style: italic;">channel_</span> parameter specifies the
1388
channel to sharpen.. The <i>radius_</i>
1389
parameter specifies the radius of the Gaussian, in pixels, not counting
1390
the center pixel. The <i>sigma_</i> parameter specifies the
1391
standard deviation of the Laplacian, in pixels.</font></td>
1392
</tr>
1393
<tr>
1394
<td style="text-align: center;">
1173
<td>
1395
1174
<center><a name="shave"></a> <font size="-1">shave</font></center>
1396
1175
</td>
1397
1176
<td><font size="-1">const Geometry &geometry_</font></td>
1398
1177
<td><font size="-1">Shave pixels from image edges.</font></td>
1399
1178
</tr>
1400
1179
<tr>
1401
<td style="text-align: center;">
1180
<td>
1402
1181
<center><a name="shear"></a> <font size="-1">shear</font></center>
1403
1182
</td>
1404
1183
<td><font size="-1">double xShearAngle_, double yShearAngle_</font></td>
1405
1184
<td><font size="-1">Shear image (create parallelogram by sliding
1406
1185
image by X or Y axis). Shearing slides one edge of an image along
1407
the X or Y axis, creating a
1408
parallelogram. An X direction shear slides an edge along the X
1409
axis, while a Y direction shear slides
1410
an edge along the Y axis. The amount of the shear is controlled
1411
by a shear angle. For X direction shears, x
1186
the X or Y axis, creating a
1187
parallelogram. An X direction shear slides an edge along the X
1188
axis, while a Y direction shear slides
1189
an edge along the Y axis. The amount of the shear is controlled
1190
by a shear angle. For X direction shears, x
1412
1191
degrees is measured relative to the Y axis, and similarly, for Y
1413
1192
direction shears y degrees is measured relative to the X
1414
1193
axis. Empty triangles left over from shearing the image are
1415
1194
filled with the color defined as <i>borderColor</i>. </font></td>
1416
1195
</tr>
1417
1196
<tr>
1418
<td style="text-align: center;">
1197
<td>
1419
1198
<center><a name="solarize"></a> <font size="-1">solarize</font></center>
1420
1199
</td>
1421
1200
<td><font size="-1">double factor_ = 50.0</font></td>
1423
1202
exposing a photographic film to light during the development process)</font></td>
1424
1203
</tr>
1425
1204
<tr>
1426
<td style="text-align: center;">
1427
<center><a name="splice"></a> <font size="-1">splice</font></center>
1428
</td>
1429
<td><font size="-1">const <a href="Geometry.html">Geometry</a>
1430
&geometry_</font></td>
1431
<td><font size="-1">splice the background color into the image</font></td>
1432
</tr>
1433
<tr>
1434
<td style="text-align: center;">
1205
<td>
1435
1206
<center><a name="spread"></a> <font size="-1">spread</font></center>
1436
1207
</td>
1437
<td><font size="-1">size_t amount_ = 3</font></td>
1208
<td><font size="-1">unsigned int amount_ = 3</font></td>
1438
1209
<td><font size="-1">Spread pixels randomly within image by
1439
1210
specified amount</font></td>
1440
1211
</tr>
1441
1212
<tr>
1442
<td style="text-align: center;">
1213
<td>
1443
1214
<center><a name="stegano"></a> <font size="-1">stegano</font></center>
1444
1215
</td>
1445
1216
<td><font size="-1">const Image &watermark_</font></td>
1446
1217
<td><font size="-1">Add a digital watermark to the image (based
1447
on second image)</font></td>
1218
on second image)</font></td>
1448
1219
</tr>
1449
1220
<tr>
1450
1221
<td>
1451
<center><a name="sparseColor"></a> <font size="-1">sparseColor</font></center>
1452
</td>
1453
<td><font size="-1">const ChannelType channel, const SparseColorMethod method, const unsigned long number_arguments, const double *arguments </font></td>
1454
<td><font size="-1">Sparse color image, given a set of coordinates, interpolates the colors found at those coordinates, across the whole image, using various methods.</font></td>
1455
</tr>
1456
<tr>
1457
<td style="text-align: center;">
1458
<center><a name="statistics"></a> <font size="-1">statistics</font></center>
1459
</td>
1460
<td><font size="-1">ImageStatistics *statistics</font></td>
1461
<td><font size="-1">Obtain image statistics. Statistics are normalized to the range of 0.0 to 1.0 and are output to the specified ImageStatistics structure. The structure includes members maximum, minimum, mean, standard_deviation, and variance for each of these channels: red, green, blue, and opacity (e.g. statistics->red.maximum).</font></td>
1462
</tr>
1463
<tr>
1464
<td style="text-align: center;">
1465
1222
<center><a name="stereo"></a> <font size="-1">stereo</font></center>
1466
1223
</td>
1467
1224
<td><font size="-1">const Image &rightImage_</font></td>
1469
1226
viewed with red-blue glasses (Red image on left, blue on right)</font></td>
1470
1227
</tr>
1471
1228
<tr>
1472
<td style="text-align: center;">
1229
<td>
1473
1230
<center><a name="swirl"></a> <font size="-1">swirl</font></center>
1474
1231
</td>
1475
1232
<td><font size="-1">double degrees_</font></td>
1477
1234
degrees)</font></td>
1478
1235
</tr>
1479
1236
<tr>
1480
<td style="text-align: center;">
1237
<td>
1481
1238
<center><a name="texture"></a> <font size="-1">texture</font></center>
1482
1239
</td>
1483
1240
<td><font size="-1">const Image &texture_</font></td>
1485
1242
background color.</font></td>
1486
1243
</tr>
1487
1244
<tr>
1488
<td style="text-align: center;">
1245
<td>
1489
1246
<center><a name="threshold"></a> <font size="-1">threshold</font></center>
1490
1247
</td>
1491
1248
<td><font size="-1">double threshold_</font></td>
1492
1249
<td><font size="-1">Threshold image</font></td>
1493
1250
</tr>
1494
1251
<tr>
1495
<td style="text-align: center;" rowspan="2">
1252
<td rowspan="2">
1496
1253
<center><a name="transform"></a> <font size="-1">transform</font></center>
1497
1254
</td>
1498
1255
<td><font size="-1">const <a href="Geometry.html">Geometry</a>
1499
1256
&imageGeometry_</font></td>
1500
1257
<td rowspan="2"><font size="-1">Transform image based on image
1501
and crop geometries. Crop geometry is optional.</font></td>
1258
and crop geometries. Crop geometry is optional.</font></td>
1502
1259
</tr>
1503
1260
<tr>
1504
1261
<td><font size="-1">const <a href="Geometry.html">Geometry</a>
1506
1263
&cropGeometry_ </font></td>
1507
1264
</tr>
1508
1265
<tr>
1509
<td style="text-align: center;">
1266
<td>
1510
1267
<center><a name="transparent"></a> <font size="-1">transparent</font></center>
1511
1268
</td>
1512
1269
<td><font size="-1">const <a href="Color.html">Color</a>
1513
1270
&color_</font></td>
1514
1271
<td><font size="-1">Add matte image to image, setting pixels
1515
matching color to transparent.</font></td>
1272
matching color to transparent.</font></td>
1516
1273
</tr>
1517
1274
<tr>
1518
<td style="text-align: center;">
1275
<td>
1519
1276
<center><a name="trim"></a> <font size="-1">trim</font></center>
1520
1277
</td>
1521
1278
<td><font size="-1">void</font></td>
1523
1280
the image.</font></td>
1524
1281
</tr>
1525
1282
<tr>
1526
<td style="text-align: center;">
1283
<td>
1527
1284
<center><a name="unsharpmask"></a> <font size="-1">unsharpmask</font></center>
1528
1285
</td>
1529
1286
<td><font size="-1">double radius_, double sigma_, double
1530
amount_, double threshold_</font></td>
1531
<td><font size="-1">Sharpen the image using the unsharp mask
1532
algorithm. The <i>radius</i>_
1533
parameter specifies the radius of the Gaussian, in pixels, not
1534
counting the center pixel. The <i>sigma</i>_ parameter specifies the
1535
standard deviation of the Gaussian, in pixels. The <i>amount</i>_
1536
parameter specifies the percentage of the difference between the
1537
original and the blur image that is added back into the original. The <i>threshold</i>_
1538
parameter specifies the threshold in pixels needed to apply the
1539
diffence amount.</font></td>
1540
</tr>
1541
<tr>
1542
<td style="vertical-align: middle; text-align: center;"><small><a
1543
name="unsharpmaskChannel"></a>unsharpmaskChannel<br>
1544
</small></td>
1545
<td style="vertical-align: middle;"><small>const ChannelType
1546
channel_, const double radius_, const double sigma_, const double
1547
amount_, const double threshold_<br>
1548
</small></td>
1549
<td style="vertical-align: middle;"><small>Sharpen an image
1550
channel using the unsharp mask algorithm. The <span
1551
style="font-style: italic;">channel_</span> parameter specifies the
1552
channel to sharpen. </small><font size="-1">The <i>radius</i>_
1553
parameter specifies the radius of the Gaussian, in pixels, not
1554
counting the center pixel. The <i>sigma</i>_ parameter specifies the
1555
standard deviation of the Gaussian, in pixels. The <i>amount</i>_
1556
parameter specifies the percentage of the difference between the
1557
original and the blur image that is added back into the original. The <i>threshold</i>_
1558
parameter specifies the threshold in pixels needed to apply the
1559
diffence amount.</font></td>
1560
</tr>
1561
<tr>
1562
<td style="text-align: center;">
1287
amount_, double threshold_</font></td>
1288
<td><font size="-1">Replace image with a sharpened version of the
1289
original image using the unsharp mask algorithm. The <i>radius</i>_
1290
parameter specifies the radius of the Gaussian, in pixels, not
1291
counting the center pixel. The <i>sigma</i>_ parameter specifies the
1292
standard deviation of the Gaussian, in pixels. The <i>amount</i>_
1293
parameter specifies the percentage of the difference between the
1294
original and the blur image that is added back into the original. The <i>threshold</i>_
1295
parameter specifies the threshold in pixels needed to apply the
1296
diffence amount.</font></td>
1297
</tr>
1298
<tr>
1299
<td>
1563
1300
<center><a name="wave"></a> <font size="-1">wave</font></center>
1564
1301
</td>
1565
1302
<td><font size="-1">double amplitude_ = 25.0, double wavelength_
1567
1304
<td><font size="-1">Alter an image along a sine wave.</font></td>
1568
1305
</tr>
1569
1306
<tr>
1570
<td style="text-align: center;" rowspan="5">
1307
<td rowspan="5">
1571
1308
<center><a name="write"></a> <font size="-1">write</font></center>
1572
1309
</td>
1573
1310
<td><font size="-1">const string &imageSpec_</font></td>
1574
1311
<td><font size="-1">Write image to a file using filename i<i>mageSpec_</i>
1575
1312
.</font> <br>
1576
1313
<font size="-1"><b><font color="#ff0000">Caution: </font></b> if
1577
an image format is selected which is capable of supporting fewer
1578
colors than the original image or quantization has been requested, the
1579
original image will be quantized to fewer colors. Use a copy of the
1314
an image format is selected which is capable of supporting fewer
1315
colors than the original image or quantization has been requested, the
1316
original image will be quantized to fewer colors. Use a copy of the
1580
1317
original if this is a problem.</font></td>
1581
1318
</tr>
1582
1319
<tr>
1583
1320
<td><font size="-1"><a href="Blob.html">Blob</a> *blob_</font></td>
1584
1321
<td rowspan="3"><font size="-1">Write image to a in-memory <a
1585
1322
href="Blob.html"> BLOB</a> stored in <i>blob_</i>. The <i>magick</i>_
1586
parameter specifies the image format to write (defaults to <a
1323
parameter specifies the image format to write (defaults to <a
1587
1324
href="#magick">magick</a> ). The depth_ parameter species the image
1588
1325
depth (defaults to <a href="#depth"> depth</a> ).</font> <br>
1589
1326
<font size="-1"><b><font color="#ff0000">Caution: </font></b> if
1590
an image format is selected which is capable of supporting fewer
1591
colors than the original image or quantization has been requested, the
1592
original image will be quantized to fewer colors. Use a copy of the
1327
an image format is selected which is capable of supporting fewer
1328
colors than the original image or quantization has been requested, the
1329
original image will be quantized to fewer colors. Use a copy of the
1593
1330
original if this is a problem.</font></td>
1594
1331
</tr>
1595
1332
<tr>
1598
1335
</tr>
1599
1336
<tr>
1600
1337
<td><font size="-1"><a href="Blob.html">Blob</a> *blob_,
1601
std::string &magick_, size_t depth_</font></td>
1338
std::string &magick_, unsigned int depth_</font></td>
1602
1339
</tr>
1603
1340
<tr>
1604
<td><font size="-1">const ssize_t x_, const ssize_t y_, const unsigned
1605
int columns_, const size_t rows_, const std::string &map_,
1606
const StorageType type_, void *pixels_</font></td>
1341
<td><font size="-1">const int x_, const int y_, const unsigned
1342
int columns_, const unsigned int rows_, const std::string &map_,
1343
const StorageType type_, unsigned char* pixels_</font></td>
1607
1344
<td><font size="-1">Write pixel data into a buffer you supply.
1608
The data is saved either as char, short int, integer, float or double
1609
format in the order specified by the type_ parameter. For example, we
1345
The data is saved either as char, short int, integer, float or double
1346
format in the order specified by the type_ parameter. For example, we
1610
1347
want to extract scanline 1 of a 640x480 image as character data in
1611
1348
red-green-blue order:</font>
1612
<p><font size="-1"> image.write(0,0,640,1,"RGB",0,pixels);</font>
1613
</p>
1349
<p><font size="-1"> image.write(0,0,640,1,"RGB",0,pixels);</font> </p>
1614
1350
<p><font size="-1">The parameters are as follows:</font> <br>
1615
1351
1616
1352
<table border="0" width="100%">
1618
1354
<tr>
1619
1355
<td><font size="-1">x_</font></td>
1620
1356
<td><font size="-1">Horizontal ordinate of left-most
1621
coordinate of region to extract.</font></td>
1357
coordinate of region to extract.</font></td>
1622
1358
</tr>
1623
1359
<tr>
1624
1360
<td><font size="-1">y_</font></td>
1625
1361
<td><font size="-1">Vertical ordinate of top-most
1626
coordinate of region to extract.</font></td>
1362
coordinate of region to extract.</font></td>
1627
1363
</tr>
1628
1364
<tr>
1629
1365
<td><font size="-1">columns_</font></td>
1638
1374
<tr>
1639
1375
<td><font size="-1">map_</font></td>
1640
1376
<td><font size="-1">This character string can be any
1641
combination or order of R = red, G = green, B = blue, A = alpha, C =
1642
cyan, Y = yellow, M = magenta, and K = black. The ordering reflects
1643
the order of the pixels in the supplied pixel array.</font></td>
1377
combination or order of R = red, G = green, B = blue, A = alpha, C =
1378
cyan, Y = yellow, M = magenta, and K = black. The ordering reflects
1379
the order of the pixels in the supplied pixel array.</font></td>
1644
1380
</tr>
1645
1381
<tr>
1646
1382
<td><font size="-1">type_</font></td>
1647
1383
<td><font size="-1">Pixel storage type (CharPixel,
1648
ShortPixel, IntegerPixel, FloatPixel, or DoublePixel)</font></td>
1384
ShortPixel, IntegerPixel, FloatPixel, or DoublePixel)</font></td>
1649
1385
</tr>
1650
1386
<tr>
1651
1387
<td><font size="-1">pixels_</font></td>
1652
1388
<td><font size="-1">This array of values contain the pixel
1653
components as defined by the map_ and type_ parameters. The length of
1654
the arrays must equal the area specified by the width_ and height_
1389
components as defined by the map_ and type_ parameters. The length of
1390
the arrays must equal the area specified by the width_ and height_
1655
1391
values and type_ parameters.</font></td>
1656
1392
</tr>
1657
1393
</tbody>
1660
1396
</td>
1661
1397
</tr>
1662
1398
<tr>
1663
<td style="text-align: center;">
1399
<td>
1664
1400
<center><a name="zoom"></a> <font size="-1">zoom</font></center>
1665
1401
</td>
1666
1402
<td><font size="-1">const <a href="Geometry.html">Geometry</a>
1683
1419
<blockquote><font color="#663366">string filename("file.tiff");</font> <br>
1684
1420
<font color="#663366">Image image;</font> <br>
1685
1421
<font color="#663366">image.read(filename);</font> <br>
1686
<font color="#663366">image.resolutionUnits(PixelsPerInchResolution);</font>
1687
<br>
1422
<font color="#663366">image.resolutionUnits(PixelsPerInchResolution);</font> <br>
1688
1423
<font color="#663366">image.density(Geometry(150,150));
1689
1424
// could also use image.density("150x150")</font> <br>
1690
1425
<font color="#663366">image.write(filename)</font></blockquote>
1727
1462
<td><font size="-1">void</font></td>
1728
1463
<td><font size="-1">bool flag_</font></td>
1729
1464
<td><font size="-1">Control antialiasing of rendered Postscript
1730
and Postscript or TrueType fonts. Enabled by default.</font></td>
1465
and Postscript or TrueType fonts. Enabled by default.</font></td>
1731
1466
</tr>
1732
1467
<tr>
1733
1468
<td>
1734
<center><a name="animationDelay"></a> <font size="-1">animation-</font>
1735
<br>
1469
<center><a name="animationDelay"></a> <font size="-1">animation-</font> <br>
1736
1470
<font size="-1">Delay</font></center>
1737
1471
</td>
1738
<td><font size="-1">size_t (0 to 65535)</font></td>
1472
<td><font size="-1">unsigned int (0 to 65535)</font></td>
1739
1473
<td><font size="-1">void</font></td>
1740
<td><font size="-1">size_t delay_</font></td>
1474
<td><font size="-1">unsigned int delay_</font></td>
1741
1475
<td><font size="-1">Time in 1/100ths of a second (0 to 65535)
1742
which must expire before displaying the next image in an animated
1743
sequence. This option is useful for regulating the animation of a
1744
sequence of GIF images within Netscape.</font></td>
1476
which must expire before displaying the next image in an animated
1477
sequence. This option is useful for regulating the animation of a
1478
sequence of GIF images within Netscape.</font></td>
1745
1479
</tr>
1746
1480
<tr>
1747
1481
<td>
1748
<center><a name="animationIterations"></a> <font size="-1">animation-</font>
1749
<br>
1482
<center><a name="animationIterations"></a> <font size="-1">animation-</font> <br>
1750
1483
<font size="-1">Iterations</font></center>
1751
1484
</td>
1752
<td><font size="-1">size_t</font></td>
1485
<td><font size="-1">unsigned int</font></td>
1753
1486
<td><font size="-1">void</font></td>
1754
<td><font size="-1">size_t iterations_</font></td>
1487
<td><font size="-1">unsigned int iterations_</font></td>
1755
1488
<td><font size="-1">Number of iterations to loop an animation
1756
(e.g. Netscape loop extension) for.</font></td>
1489
(e.g. Netscape loop extension) for.</font></td>
1757
1490
</tr>
1758
1491
<tr>
1759
1492
<td style="vertical-align: middle; text-align: center;"><small><a
1770
1503
image attribute. Any number of named attributes may be attached to the
1771
1504
image. For example, the image comment is a named image attribute with
1772
1505
the name "comment". EXIF tags are attached to the image as named
1773
attributes. Use the syntax "EXIF:<tag>" to request an EXIF tag
1774
similar to "EXIF:DateTime".</small><br>
1506
attributes. Use the syntax "[EXIF:<tag>]" to request an EXIF tag
1507
similar to "[EXIF:DateTime]".</small><br>
1775
1508
</td>
1776
1509
</tr>
1777
1510
<tr>
1778
1511
<td>
1779
<center><a name="backgroundColor"></a> <font size="-1">background-</font>
1780
<br>
1512
<center><a name="backgroundColor"></a> <font size="-1">background-</font> <br>
1781
1513
<font size="-1">Color</font></center>
1782
1514
</td>
1783
1515
<td><font size="-1"><a href="Color.html">Color</a> </font></td>
1788
1520
</tr>
1789
1521
<tr>
1790
1522
<td>
1791
<center><a name="backgroundTexture"></a> <font size="-1">background-</font>
1792
<br>
1523
<center><a name="backgroundTexture"></a> <font size="-1">background-</font> <br>
1793
1524
<font size="-1">Texture</font></center>
1794
1525
</td>
1795
1526
<td><font size="-1">string</font></td>
1796
1527
<td><font size="-1">void</font></td>
1797
1528
<td><font size="-1">const string &texture_</font></td>
1798
1529
<td><font size="-1">Image file name to use as the background
1799
texture. Does not modify image pixels.</font></td>
1530
texture. Does not modify image pixels.</font></td>
1800
1531
</tr>
1801
1532
<tr>
1802
1533
<td>
1803
1534
<center><a name="baseColumns"></a> <font size="-1">baseColumns</font></center>
1804
1535
</td>
1805
<td><font size="-1">size_t</font></td>
1536
<td><font size="-1">unsigned int</font></td>
1806
1537
<td><font size="-1">void</font></td>
1807
1538
<td bgcolor="#666666"><font size="-1"> </font></td>
1808
1539
<td><font size="-1">Base image width (before transformations)</font></td>
1820
1551
<td>
1821
1552
<center><a name="baseRows"></a> <font size="-1">baseRows</font></center>
1822
1553
</td>
1823
<td><font size="-1">size_t</font></td>
1554
<td><font size="-1">unsigned int</font></td>
1824
1555
<td><font size="-1">void</font></td>
1825
1556
<td bgcolor="#666666"><font size="-1"> </font></td>
1826
1557
<td><font size="-1">Base image height (before transformations)</font></td>
1841
1572
<td><font size="-1">void</font></td>
1842
1573
<td bgcolor="#666666"><font size="-1"> </font></td>
1843
1574
<td><font size="-1">Return smallest bounding box enclosing
1844
non-border pixels. The current fuzz value is used when discriminating
1845
between pixels. This is the crop bounding box used by
1575
non-border pixels. The current fuzz value is used when discriminating
1576
between pixels. This is the crop bounding box used by
1846
1577
crop(Geometry(0,0)).</font></td>
1847
1578
</tr>
1848
1579
<tr>
1858
1589
</tr>
1859
1590
<tr>
1860
1591
<td><a name="cacheThreshold"></a> <font size="-1">cacheThreshold</font></td>
1861
<td><font size="-1">size_t</font></td>
1592
<td><font size="-1">unsigned int</font></td>
1862
1593
<td bgcolor="#666666"><font size="-1"> </font></td>
1863
1594
<td><font size="-1">const int</font></td>
1864
1595
<td><font size="-1">Pixel cache threshold in megabytes. Once this
1865
1596
threshold is exceeded, all subsequent pixels cache operations are
1866
to/from disk. This is a static method and the attribute it sets is
1597
to/from disk. This is a static method and the attribute it sets is
1867
1598
shared by all Image objects.</font></td>
1868
1599
</tr>
1869
1600
<tr>
1877
1608
ChannelType channel_<br>
1878
1609
</small></td>
1879
1610
<td style="vertical-align: middle;"><small>const ChannelType
1880
channel_, const size_t depth_<br>
1611
channel_, const unsigned int depth_<br>
1881
1612
</small></td>
1882
1613
<td style="vertical-align: middle;"><small>Channel modulus depth.
1883
The channel modulus depth represents the minimum number of bits
1884
required
1885
to support the channel without loss. Setting the channel's modulus
1886
depth
1887
modifies the channel (i.e. discards resolution) if the requested
1888
modulus
1614
The channel modulus depth represents the minimum number of bits required
1615
to support the channel without loss. Setting the channel's modulus depth
1616
modifies the channel (i.e. discards resolution) if the requested modulus
1889
1617
depth is less than the current modulus depth, otherwise the channel is
1890
1618
not altered. There is no attribute associated with the modulus depth so
1891
1619
the current modulus depth is obtained by inspecting the pixels. As a
1896
1624
</tr>
1897
1625
<tr>
1898
1626
<td>
1899
<center><a name="chromaBluePrimary"></a> <font size="-1">chroma-</font>
1900
<br>
1627
<center><a name="chromaBluePrimary"></a> <font size="-1">chroma-</font> <br>
1901
1628
<font size="-1">BluePrimary</font></center>
1902
1629
</td>
1903
1630
<td><font size="-1">double x & y</font></td>
1908
1635
</tr>
1909
1636
<tr>
1910
1637
<td>
1911
<center><a name="chromaGreenPrimary"></a> <font size="-1">chroma-</font>
1912
<br>
1638
<center><a name="chromaGreenPrimary"></a> <font size="-1">chroma-</font> <br>
1913
1639
<font size="-1">GreenPrimary</font></center>
1914
1640
</td>
1915
1641
<td><font size="-1">double x & y</font></td>
1920
1646
</tr>
1921
1647
<tr>
1922
1648
<td>
1923
<center><a name="chromaRedPrimary"></a> <font size="-1">chroma-</font>
1924
<br>
1649
<center><a name="chromaRedPrimary"></a> <font size="-1">chroma-</font> <br>
1925
1650
<font size="-1">RedPrimary</font></center>
1926
1651
</td>
1927
1652
<td><font size="-1">double x & y</font></td>
1932
1657
</tr>
1933
1658
<tr>
1934
1659
<td>
1935
<center><a name="chromaWhitePoint"></a> <font size="-1">chroma-</font>
1936
<br>
1660
<center><a name="chromaWhitePoint"></a> <font size="-1">chroma-</font> <br>
1937
1661
<font size="-1">WhitePoint</font></center>
1938
1662
</td>
1939
1663
<td><font size="-1">double x & y</font></td>
1946
1670
<td>
1947
1671
<center><a name="classType"></a> <font size="-1">classType</font></center>
1948
1672
</td>
1949
<td><font size="-1"><a href="Enumerations.html#ClassType">ClassType</a>
1950
</font></td>
1673
<td><font size="-1"><a href="Enumerations.html#ClassType">ClassType</a> </font></td>
1951
1674
<td><font size="-1">void</font></td>
1952
1675
<td><font size="-1"> <a href="Enumerations.html#ClassType">ClassType</a>
1953
1676
class_</font></td>
1954
1677
<td><font size="-1">Image storage class. Note that
1955
conversion from a DirectClass image to a PseudoClass image may result
1956
in a loss of color due to the limited size of the palette (256 or
1678
conversion from a DirectClass image to a PseudoClass image may result
1679
in a loss of color due to the limited size of the palette (256 or
1957
1680
65535 colors).</font></td>
1958
1681
</tr>
1959
1682
<tr>
1965
1688
<td><font size="-1">const Image &clipMask_</font></td>
1966
1689
<td><font size="-1">Associate a clip mask image with the current
1967
1690
image. The clip mask image must have the same dimensions as the current
1968
image or an exception is thrown. Clipping occurs wherever pixels are
1969
transparent in the clip mask image. Clipping Pass an invalid image to
1970
unset an existing clip mask.</font></td>
1691
image or an exception is thrown. Clipping occurs wherever pixels are
1692
transparent in the clip mask image. Clipping Pass an invalid image to
1693
unset an existing clip mask.</font></td>
1971
1694
</tr>
1972
1695
<tr>
1973
1696
<td>
1978
1701
<td><font size="-1">double fuzz_</font></td>
1979
1702
<td><font size="-1">Colors within this distance are considered
1980
1703
equal. A number of algorithms search for a target color. By
1981
default the color must be exact. Use this option to match colors that
1982
are close to the target color in RGB space.</font></td>
1704
default the color must be exact. Use this option to match colors that
1705
are close to the target color in RGB space.</font></td>
1983
1706
</tr>
1984
1707
<tr>
1985
1708
<td>
1986
1709
<center><a name="colorMap"></a> <font size="-1">colorMap</font></center>
1987
1710
</td>
1988
1711
<td><font size="-1"><a href="Color.html">Color</a> </font></td>
1989
<td><font size="-1">size_t index_</font></td>
1990
<td><font size="-1">size_t index_, const <a
1712
<td><font size="-1">unsigned int index_</font></td>
1713
<td><font size="-1">unsigned int index_, const <a
1991
1714
href="Color.html"> Color</a> &color_</font></td>
1992
1715
<td><font size="-1">Color at colormap index.</font></td>
1993
1716
</tr>
1996
1719
<div align="center"><a name="colorMapSize"></a> <font size="-1">colorMapSize<br>
1997
1720
</font></div>
1998
1721
</td>
1999
<td valign="middle"><font size="-1">size_t<br>
1722
<td valign="middle"><font size="-1">unsigned int<br>
2000
1723
</font></td>
2001
1724
<td valign="middle"><font size="-1">void<br>
2002
1725
</font></td>
2003
<td valign="middle"><font size="-1">size_t entries_<br>
1726
<td valign="middle"><font size="-1">unsigned int entries_<br>
2004
1727
</font></td>
2005
1728
<td valign="middle"><font size="-1">Number of entries in the
2006
colormap. Setting the colormap size may extend or truncate the
2007
colormap.
1729
colormap. Setting the colormap size may extend or truncate the colormap.
2008
1730
The maximum number of supported entries is specified by the <i>MaxColormapSize</i>constant,
2009
1731
and is dependent on the value of QuantumDepth when ImageMagick is
2010
1732
compiled. An exception is thrown if more entries are requested than may
2022
1744
<td><font size="-1"><a href="Enumerations.html#ColorspaceType">ColorspaceType</a>
2023
1745
colorSpace_</font></td>
2024
1746
<td><font size="-1">The colorspace (e.g. CMYK) used to represent
2025
the image pixel colors. Image pixels are always stored as RGB(A) except
2026
for the case of CMY(K).</font></td>
1747
the image pixel colors. Image pixels are always stored as RGB(A) except
1748
for the case of CMY(K).</font></td>
2027
1749
</tr>
2028
1750
<tr>
2029
1751
<td>
2030
1752
<center><a name="columns"></a> <font size="-1">columns</font></center>
2031
1753
</td>
2032
<td><font size="-1">size_t</font></td>
1754
<td><font size="-1">unsigned int</font></td>
2033
1755
<td><font size="-1">void</font></td>
2034
1756
<td bgcolor="#666666"><font size="-1"> </font></td>
2035
1757
<td><font size="-1">Image width</font></td>
2047
1769
<td>
2048
1770
<center><a name="compose"></a> <font size="-1">compose</font></center>
2049
1771
</td>
2050
<td><font size="-1"><a href="Enumerations.html#CompositeOperator">CompositeOperator</a>
2051
</font></td>
1772
<td><font size="-1"><a href="Enumerations.html#CompositeOperator">CompositeOperator</a> </font></td>
2052
1773
<td><small><font size="-1"><small>void</small></font></small></td>
2053
1774
<td><small><font size="-1"><small><a
2054
1775
href="Enumerations.html#CompositeOperator">CompositeOperator</a>
2058
1779
</tr>
2059
1780
<tr>
2060
1781
<td>
2061
<center><a name="compressType"></a> <font size="-1">compress-</font>
2062
<br>
1782
<center><a name="compressType"></a> <font size="-1">compress-</font> <br>
2063
1783
<font size="-1">Type</font></center>
2064
1784
</td>
2065
<td><font size="-1"><a href="Enumerations.html#CompressionType">CompressionType</a>
2066
</font></td>
1785
<td><font size="-1"><a href="Enumerations.html#CompressionType">CompressionType</a> </font></td>
2067
1786
<td><small><font size="-1"><small>void</small></font></small></td>
2068
1787
<td><small><font size="-1"><small><a
2069
1788
href="Enumerations.html#CompressionType">CompressionType</a>
2079
1798
<td><small><font size="-1"><small>void</small></font></small></td>
2080
1799
<td><small><font size="-1"><small>bool flag_</small></font></small></td>
2081
1800
<td><font size="-1">Enable printing of internal debug messages
2082
from ImageMagick as it executes.</font></td>
1801
from ImageMagick as it executes.</font></td>
2083
1802
</tr>
2084
1803
<tr>
2085
1804
<td style="text-align: center; vertical-align: middle;"><small><a
2119
1838
<td style="vertical-align: middle;"><small>Set or obtain a
2120
1839
definition flag to applied when encoding or decoding the specified
2121
1840
format.</small><small>. Similar to the defineValue() method except that
2122
passing the <span style="font-style: italic;">flag_</span> value
2123
'true'
1841
passing the <span style="font-style: italic;">flag_</span> value 'true'
2124
1842
creates a value-less define with that format and key. Passing the <span
2125
1843
style="font-style: italic;">f</span><span style="font-style: italic;">lag_</span>
2126
1844
value 'false' removes any existing matching definition. The method
2138
1856
<td><font size="-1">const <a href="Geometry.html">Geometry</a>
2139
1857
&density_</font></td>
2140
1858
<td><font size="-1">Vertical and horizontal resolution in pixels
2141
of the image. This option specifies an image density when decoding a
1859
of the image. This option specifies an image density when decoding a
2142
1860
Postscript or Portable Document page. Often used with <i>psPageSize</i>.</font></td>
2143
1861
</tr>
2144
1862
<tr>
2145
1863
<td>
2146
1864
<center><a name="depth"></a> <font size="-1">depth</font></center>
2147
1865
</td>
2148
<td><font size="-1"> size_t (8-32)</font></td>
1866
<td><font size="-1"> unsigned int (8, 16, or 32)</font></td>
2149
1867
<td><font size="-1">void</font></td>
2150
<td><font size="-1">size_t depth_</font></td>
1868
<td><font size="-1">unsigned int depth_</font></td>
2151
1869
<td><font size="-1">Image depth. Used to specify the bit depth
2152
when reading or writing raw images or when the output format
1870
when reading or writing raw images or when the output format
2153
1871
supports multiple depths. Defaults to the quantum depth that
2154
1872
ImageMagick is compiled with.</font></td>
2155
1873
</tr>
2157
1875
<td>
2158
1876
<center><a name="endian"></a> <font size="-1">endian</font></center>
2159
1877
</td>
2160
<td><font size="-1"><a href="Enumerations.html#EndianType">EndianType</a>
2161
</font></td>
1878
<td><font size="-1"><a href="Enumerations.html#EndianType">EndianType</a> </font></td>
2162
1879
<td><font size="-1">void</font></td>
2163
1880
<td><font size="-1"><a href="Enumerations.html#EndianType">EndianType</a>
2164
1881
endian_</font></td>
2176
1893
</tr>
2177
1894
<tr>
2178
1895
<td>
2179
<center><a name="file"></a> <font size="-1">file</font></center>
2180
</td>
2181
<td><font size="-1">FILE *</font></td>
2182
<td><font size="-1">FILE *</font></td>
2183
<td><font size="-1">FILE *file_</font></td>
2184
<td><font size="-1">Image file descriptor.</font></td>
2185
</tr>
2186
<tr>
2187
<td>
2188
1896
<center><a name="fileName"></a> <font size="-1">fileName</font></center>
2189
1897
</td>
2190
1898
<td><font size="-1">string</font></td>
2224
1932
<td>
2225
1933
<center><a name="fillRule"></a> <font size="-1">fillRule</font></center>
2226
1934
</td>
2227
<td><font size="-1"><a href="Enumerations.html#FillRule">FillRule</a>
2228
</font></td>
1935
<td><font size="-1"><a href="Enumerations.html#FillRule">FillRule</a> </font></td>
2229
1936
<td><font size="-1">void</font></td>
2230
1937
<td><font size="-1">const Magick::FillRule &fillRule_</font></td>
2231
1938
<td><font size="-1">Rule to use when filling drawn objects.</font></td>
2234
1941
<td>
2235
1942
<center><a name="filterType"></a> <font size="-1">filterType</font></center>
2236
1943
</td>
2237
<td><font size="-1"><a href="Enumerations.html#FilterTypes">FilterTypes</a>
2238
</font></td>
1944
<td><font size="-1"><a href="Enumerations.html#FilterTypes">FilterTypes</a> </font></td>
2239
1945
<td><font size="-1">void</font></td>
2240
1946
<td><font size="-1"><a href="Enumerations.html#FilterTypes">FilterTypes</a>
2241
1947
filterType_</font></td>
2242
1948
<td><font size="-1">Filter to use when resizing image. The
2243
reduction filter employed has a sigificant effect on the time required
2244
to resize an image and the resulting quality. The default filter is <i>Lanczos</i>
1949
reduction filter employed has a sigificant effect on the time required
1950
to resize an image and the resulting quality. The default filter is <i>Lanczos</i>
2245
1951
which has been shown to produce high quality results when reducing most
2246
1952
images.</font></td>
2247
1953
</tr>
2254
1960
<td><font size="-1">const string &font_</font></td>
2255
1961
<td><font size="-1">Text rendering font. If the font is a fully
2256
1962
qualified X server font name, the font is obtained from an X
2257
server. To use a TrueType font, precede the TrueType filename with an
2258
@. Otherwise, specify a Postscript font name (e.g.
1963
server. To use a TrueType font, precede the TrueType filename with an
1964
@. Otherwise, specify a Postscript font name (e.g.
2259
1965
"helvetica").</font></td>
2260
1966
</tr>
2261
1967
<tr>
2262
1968
<td>
2263
1969
<center><a name="fontPointsize"></a> <font size="-1">fontPointsize</font></center>
2264
1970
</td>
2265
<td><font size="-1">size_t</font></td>
1971
<td><font size="-1">unsigned int</font></td>
2266
1972
<td><font size="-1">void</font></td>
2267
<td><font size="-1">size_t pointSize_</font></td>
1973
<td><font size="-1">unsigned int pointSize_</font></td>
2268
1974
<td><font size="-1">Text rendering font point size</font></td>
2269
1975
</tr>
2270
1976
<tr>
2296
2002
<td><font size="-1">void</font></td>
2297
2003
<td bgcolor="#666666"><font size="-1"> </font></td>
2298
2004
<td><font size="-1">Gamma level of the image. The same color
2299
image displayed on two different workstations may
2300
look different due to differences in the display monitor.
2301
Use gamma correction to adjust for this
2005
image displayed on two different workstations may
2006
look different due to differences in the display monitor.
2007
Use gamma correction to adjust for this
2302
2008
color difference.</font></td>
2303
2009
</tr>
2304
2010
<tr>
2312
2018
</tr>
2313
2019
<tr>
2314
2020
<td>
2315
<center><a name="gifDisposeMethod"></a> <font size="-1">gifDispose-</font>
2316
<br>
2021
<center><a name="gifDisposeMethod"></a> <font size="-1">gifDispose-</font> <br>
2317
2022
<font size="-1">Method</font></center>
2318
2023
</td>
2319
<td><font size="-1">size_t</font> <br>
2024
<td><font size="-1">unsigned int</font> <br>
2320
2025
<font size="-1">{ 0 = Disposal not specified,</font> <br>
2321
2026
<font size="-1">1 = Do not dispose of graphic,</font> <br>
2322
<font size="-1">3 = Overwrite graphic with background color,</font>
2323
<br>
2324
<font size="-1">4 = Overwrite graphic with previous graphic. }</font></td>
2027
<font size="-1">3 = Overwrite graphic with background color,</font> <br>
2028
<font size="-1">4 = Overwrite graphic with previous graphic. }</font></td>
2325
2029
<td><font size="-1">void</font></td>
2326
<td><font size="-1">size_t disposeMethod_</font></td>
2030
<td><font size="-1">unsigned int disposeMethod_</font></td>
2327
2031
<td><font size="-1">GIF disposal method. This option is used to
2328
2032
control how successive frames are rendered (how the preceding frame is
2329
disposed of) when creating a GIF animation.</font></td>
2033
disposed of) when creating a GIF animation.</font></td>
2330
2034
</tr>
2331
2035
<tr>
2332
2036
<td>
2338
2042
&colorProfile_</font></td>
2339
2043
<td><font size="-1">ICC color profile. Supplied via a <a
2340
2044
href="Blob.html"> Blob</a> since Magick++/ and ImageMagick do not
2341
currently support formating this data structure directly.
2045
currently support formating this data structure directly.
2342
2046
Specifications are available from the <a href="http://www.color.org/">
2343
2047
International Color Consortium</a> for the format of ICC color profiles.</font></td>
2344
2048
</tr>
2345
2049
<tr>
2346
2050
<td>
2347
<center><a name="interlaceType"></a> <font size="-1">interlace-</font>
2348
<br>
2051
<center><a name="interlaceType"></a> <font size="-1">interlace-</font> <br>
2349
2052
<font size="-1">Type</font></center>
2350
2053
</td>
2351
<td><font size="-1"><a href="Enumerations.html#InterlaceType">InterlaceType</a>
2352
</font></td>
2054
<td><font size="-1"><a href="Enumerations.html#InterlaceType">InterlaceType</a> </font></td>
2353
2055
<td><font size="-1">void</font></td>
2354
2056
<td><font size="-1"><a href="Enumerations.html#InterlaceType">InterlaceType</a>
2355
2057
interlace_</font></td>
2359
2061
means do not interlace, <i>LineInterlace</i> uses scanline
2360
2062
interlacing, and <i>PlaneInterlace</i> uses plane interlacing. <i>
2361
2063
PartitionInterlace</i> is like <i>PlaneInterlace</i> except the
2362
different planes are saved to individual files (e.g.
2064
different planes are saved to individual files (e.g.
2363
2065
image.R, image.G, and image.B). Use <i>LineInterlace</i> or <i>
2364
PlaneInterlace</i> to create an interlaced GIF or progressive JPEG
2365
image.</font></td>
2066
PlaneInterlace</i> to create an interlaced GIF or progressive JPEG image.</font></td>
2366
2067
</tr>
2367
2068
<tr>
2368
2069
<td>
2374
2075
iptcProfile_</font></td>
2375
2076
<td><font size="-1">IPTC profile. Supplied via a <a
2376
2077
href="Blob.html"> Blob</a> since Magick++ and ImageMagick do not
2377
currently support formating this data structure directly.
2078
currently support formating this data structure directly.
2378
2079
Specifications are available from the <a href="http://www.iptc.org/">
2379
2080
International Press Telecommunications Council</a> for IPTC profiles.</font></td>
2380
2081
</tr>
2404
2105
<td><font size="-1">void</font></td>
2405
2106
<td><font size="-1">bool matteFlag_</font></td>
2406
2107
<td><font size="-1">True if the image has transparency. If set
2407
True, store matte channel if the image has one otherwise create
2408
an opaque one.</font></td>
2108
True, store matte channel if the image has one otherwise create
2109
an opaque one.</font></td>
2409
2110
</tr>
2410
2111
<tr>
2411
2112
<td>
2419
2120
</tr>
2420
2121
<tr>
2421
2122
<td>
2422
<center><a name="meanErrorPerPixel"></a> <font size="-1">meanError-</font>
2423
<br>
2123
<center><a name="meanErrorPerPixel"></a> <font size="-1">meanError-</font> <br>
2424
2124
<font size="-1">PerPixel</font></center>
2425
2125
</td>
2426
2126
<td><font size="-1">double</font></td>
2427
2127
<td><font size="-1">void</font></td>
2428
2128
<td bgcolor="#666666"><font size="-1"> </font></td>
2429
2129
<td><font size="-1">The mean error per pixel computed when an
2430
image is color reduced. This parameter is only valid if verbose is set
2431
to true and the image has just been quantized.</font></td>
2130
image is color reduced. This parameter is only valid if verbose is set
2131
to true and the image has just been quantized.</font></td>
2432
2132
</tr>
2433
2133
<tr>
2434
2134
<td style="text-align: center; vertical-align: middle;"><font
2447
2147
modulus depth (minimum number of bits required to support
2448
2148
red/green/blue components without loss of accuracy). The pixel modulus
2449
2149
depth may be decreased by supplying a value which is less than the
2450
current value, updating the pixels (reducing accuracy) to the new
2451
depth.
2150
current value, updating the pixels (reducing accuracy) to the new depth.
2452
2151
The pixel modulus depth can not be increased over the current value
2453
2152
using this method.<br>
2454
2153
</small></td>
2464
2163
</tr>
2465
2164
<tr>
2466
2165
<td>
2467
<center><a name="montageGeometry"></a> <font size="-1">montage-</font>
2468
<br>
2166
<center><a name="montageGeometry"></a> <font size="-1">montage-</font> <br>
2469
2167
<font size="-1">Geometry</font></center>
2470
2168
</td>
2471
2169
<td><font size="-1"><a href="Geometry.html">Geometry</a> </font></td>
2476
2174
</tr>
2477
2175
<tr>
2478
2176
<td>
2479
<center><a name="normalizedMaxError"></a> <font size="-1">normalized-</font>
2480
<br>
2177
<center><a name="normalizedMaxError"></a> <font size="-1">normalized-</font> <br>
2481
2178
<font size="-1">MaxError</font></center>
2482
2179
</td>
2483
2180
<td><font size="-1">double</font></td>
2484
2181
<td><font size="-1">void</font></td>
2485
2182
<td bgcolor="#666666"><font size="-1"> </font></td>
2486
2183
<td><font size="-1">The normalized max error per pixel computed
2487
when an image is color reduced. This parameter is only valid if verbose
2488
is set to true and the image has just been quantized.</font></td>
2184
when an image is color reduced. This parameter is only valid if verbose
2185
is set to true and the image has just been quantized.</font></td>
2489
2186
</tr>
2490
2187
<tr>
2491
2188
<td>
2492
<center><a name="normalizedMeanError"></a> <font size="-1">normalized-</font>
2493
<br>
2189
<center><a name="normalizedMeanError"></a> <font size="-1">normalized-</font> <br>
2494
2190
<font size="-1">MeanError</font></center>
2495
2191
</td>
2496
2192
<td><font size="-1">double</font></td>
2497
2193
<td><font size="-1">void</font></td>
2498
2194
<td bgcolor="#666666"><font size="-1"> </font></td>
2499
2195
<td><font size="-1">The normalized mean error per pixel computed
2500
when an image is color reduced. This parameter is only valid if verbose
2501
is set to true and the image has just been quantized.</font></td>
2196
when an image is color reduced. This parameter is only valid if verbose
2197
is set to true and the image has just been quantized.</font></td>
2502
2198
</tr>
2503
2199
<tr>
2504
2200
<td style="text-align: center; vertical-align: middle;"><small><a
2509
2205
<td style="vertical-align: top;"><small>void</small><br>
2510
2206
</td>
2511
2207
<td style="vertical-align: middle;"><small><a
2512
href="Enumerations.html#OrientationType">OrientationType</a>
2208
href="www/Magick++/Enumerations.html#OrientationType">OrientationType</a>
2513
2209
orientation_</small></td>
2514
2210
<td style="vertical-align: top;"><small>Image orientation.
2515
2211
Supported by some file formats such as DPX and TIFF. Useful for
2520
2216
<td>
2521
2217
<center><a name="packets"></a> <font size="-1">packets</font></center>
2522
2218
</td>
2523
<td><font size="-1">size_t</font></td>
2219
<td><font size="-1">unsigned int</font></td>
2524
2220
<td><font size="-1">void</font></td>
2525
2221
<td bgcolor="#666666"><font size="-1"> </font></td>
2526
<td><font size="-1">The number of runlength-encoded packets in</font>
2527
<br>
2222
<td><font size="-1">The number of runlength-encoded packets in</font> <br>
2528
2223
<font size="-1">the image</font></td>
2529
2224
</tr>
2530
2225
<tr>
2531
2226
<td>
2532
2227
<center><a name="packetSize"></a> <font size="-1">packetSize</font></center>
2533
2228
</td>
2534
<td><font size="-1">size_t</font></td>
2229
<td><font size="-1">unsigned int</font></td>
2535
2230
<td><font size="-1">void</font></td>
2536
2231
<td bgcolor="#666666"><font size="-1"> </font></td>
2537
2232
<td><font size="-1">The number of bytes in each pixel packet</font></td>
2540
2235
<td>
2541
2236
<center><a name="page"></a> <font size="-1">page</font></center>
2542
2237
</td>
2543
<td><font size="-1"><a href="Geometry.html#PostscriptPageSize">Geometry</a>
2544
</font></td>
2238
<td><font size="-1"><a href="Geometry.html#PostscriptPageSize">Geometry</a> </font></td>
2545
2239
<td><font size="-1">void</font></td>
2546
2240
<td><font size="-1">const <a
2547
2241
href="Geometry.html#PostscriptPageSize"> Geometry</a> &pageSize_</font></td>
2548
2242
<td><font size="-1">Preferred size and location of an image
2549
2243
canvas.</font>
2550
<p><font size="-1">Use this option to specify the dimensions
2551
and position of the Postscript page in dots per inch or a TEXT page in
2244
<p><font size="-1">Use this option to specify the dimensions
2245
and position of the Postscript page in dots per inch or a TEXT page in
2552
2246
pixels. This option is typically used in concert with <i><a
2553
2247
href="#density"> density</a> </i>.</font> </p>
2554
<p><font size="-1">Page may also be used to position a GIF
2248
<p><font size="-1">Page may also be used to position a GIF
2555
2249
image (such as for a scene in an animation)</font></p>
2556
2250
</td>
2557
2251
</tr>
2560
2254
<center><a name="pixelColor"></a> <font size="-1">pixelColor</font></center>
2561
2255
</td>
2562
2256
<td><font size="-1"><a href="Color.html">Color</a> </font></td>
2563
<td><font size="-1">size_t x_, size_t y_</font></td>
2564
<td><font size="-1">size_t x_, size_t y_, const <a
2257
<td><font size="-1">unsigned int x_, unsigned int y_</font></td>
2258
<td><font size="-1">unsigned int x_, unsigned int y_, const <a
2565
2259
href="Color.html"> Color</a> &color_</font></td>
2566
2260
<td><font size="-1">Get/set pixel color at location x & y.</font></td>
2567
2261
</tr>
2574
2268
</small></a> </td>
2575
2269
<td valign="top"><small>const std::string name_</small><small><br>
2576
2270
</small></td>
2577
<td valign="top"><small>const std::string name_, const Blob
2271
<td valign="top"><small>const std::string name_, const Blob
2578
2272
&colorProfile_</small><small><br>
2579
2273
</small></td>
2580
2274
<td valign="top"><small>Get/set/remove </small><small> a named
2581
2275
profile</small><small>. Valid names include </small><small>"*",
2582
"8BIM", "ICM", "IPTC", or a user/format-defined profile name. </small><br>
2276
"8bim", "icm", "iptc", or a user/format-defined profile name. </small><br>
2583
2277
</td>
2584
2278
</tr>
2585
2279
<tr>
2586
2280
<td>
2587
2281
<center><a name="quality"></a> <font size="-1">quality</font></center>
2588
2282
</td>
2589
<td><font size="-1">size_t (0 to 100)</font></td>
2283
<td><font size="-1">unsigned int (0 to 100)</font></td>
2590
2284
<td><font size="-1">void</font></td>
2591
<td><font size="-1">size_t quality_</font></td>
2285
<td><font size="-1">unsigned int quality_</font></td>
2592
2286
<td><font size="-1">JPEG/MIFF/PNG compression level (default 75).</font></td>
2593
2287
</tr>
2594
2288
<tr>
2595
2289
<td>
2596
<center><a name="quantizeColors"></a> <font size="-1">quantize-</font>
2597
<br>
2290
<center><a name="quantizeColors"></a> <font size="-1">quantize-</font> <br>
2598
2291
<font size="-1">Colors</font></center>
2599
2292
</td>
2600
<td><font size="-1">size_t</font></td>
2293
<td><font size="-1">unsigned int</font></td>
2601
2294
<td><font size="-1">void</font></td>
2602
<td><font size="-1">size_t colors_</font></td>
2295
<td><font size="-1">unsigned int colors_</font></td>
2603
2296
<td><font size="-1">Preferred number of colors in the image. The
2604
2297
actual number of colors in the image may be less than your request, but
2605
never more. Images with less unique colors than specified with this
2606
option will have any duplicate or unused colors removed.</font></td>
2298
never more. Images with less unique colors than specified with this
2299
option will have any duplicate or unused colors removed.</font></td>
2607
2300
</tr>
2608
2301
<tr>
2609
2302
<td>
2610
<center><a name="quantizeColorSpace"></a> <font size="-1">quantize-</font>
2611
<br>
2303
<center><a name="quantizeColorSpace"></a> <font size="-1">quantize-</font> <br>
2612
2304
<font size="-1">ColorSpace</font></center>
2613
2305
</td>
2614
<td><font size="-1"><a href="Enumerations.html#ColorspaceType">ColorspaceType</a>
2615
</font></td>
2306
<td><font size="-1"><a href="Enumerations.html#ColorspaceType">ColorspaceType</a> </font></td>
2616
2307
<td><font size="-1">void</font></td>
2617
2308
<td><font size="-1"><a href="Enumerations.html#ColorspaceType">ColorspaceType</a>
2618
2309
colorSpace_</font></td>
2619
2310
<td><font size="-1">Colorspace to quantize colors in (default
2620
RGB). Empirical evidence suggests that distances in color spaces such
2621
as YUV or YIQ correspond to perceptual color differences more closely
2622
than do distances in RGB space. These color spaces may give better
2311
RGB). Empirical evidence suggests that distances in color spaces such
2312
as YUV or YIQ correspond to perceptual color differences more closely
2313
than do distances in RGB space. These color spaces may give better
2623
2314
results when color reducing an image.</font></td>
2624
2315
</tr>
2625
2316
<tr>
2626
2317
<td>
2627
<center><a name="quantizeDither"></a> <font size="-1">quantize-</font>
2628
<br>
2318
<center><a name="quantizeDither"></a> <font size="-1">quantize-</font> <br>
2629
2319
<font size="-1">Dither</font></center>
2630
2320
</td>
2631
2321
<td><font size="-1">bool</font></td>
2632
2322
<td><font size="-1">void</font></td>
2633
2323
<td><font size="-1">bool flag_</font></td>
2634
2324
<td><font size="-1">Apply Floyd/Steinberg error diffusion to the
2635
image. The basic strategy of dithering is to trade
2636
intensity
2325
image. The basic strategy of dithering is to trade intensity
2637
2326
resolution for spatial resolution by
2638
averaging the intensities of several
2639
neighboring pixels. Images which suffer from
2640
severe contouring when reducing colors can be
2327
averaging the intensities of several
2328
neighboring pixels. Images which suffer from
2329
severe contouring when reducing colors can be
2641
2330
improved with this option. The quantizeColors or monochrome option must
2642
2331
be set for this option to take effect.</font></td>
2643
2332
</tr>
2644
2333
<tr>
2645
2334
<td>
2646
<center><a name="quantizeTreeDepth"></a> <font size="-1">quantize-</font>
2647
<br>
2335
<center><a name="quantizeTreeDepth"></a> <font size="-1">quantize-</font> <br>
2648
2336
<font size="-1">TreeDepth</font></center>
2649
2337
</td>
2650
<td><font size="-1">size_t </font></td>
2338
<td><font size="-1">unsigned int </font></td>
2651
2339
<td><font size="-1">void</font></td>
2652
<td><font size="-1">size_t treeDepth_</font></td>
2340
<td><font size="-1">unsigned int treeDepth_</font></td>
2653
2341
<td><font size="-1">Depth of the quantization color
2654
classification tree. Values of 0 or 1 allow selection of the optimal
2655
tree depth for the color reduction algorithm. Values between 2 and 8
2656
may be used to manually adjust the tree depth.</font></td>
2342
classification tree. Values of 0 or 1 allow selection of the optimal
2343
tree depth for the color reduction algorithm. Values between 2 and 8
2344
may be used to manually adjust the tree depth.</font></td>
2657
2345
</tr>
2658
2346
<tr>
2659
2347
<td>
2660
<center><a name="renderingIntent"></a> <font size="-1">rendering-</font>
2661
<br>
2348
<center><a name="renderingIntent"></a> <font size="-1">rendering-</font> <br>
2662
2349
<font size="-1">Intent</font></center>
2663
2350
</td>
2664
<td><font size="-1"><a href="Enumerations.html#RenderingIntent">RenderingIntent</a>
2665
</font></td>
2351
<td><font size="-1"><a href="Enumerations.html#RenderingIntent">RenderingIntent</a> </font></td>
2666
2352
<td><font size="-1">void</font></td>
2667
2353
<td><font size="-1"><a href="Enumerations.html#RenderingIntent">RenderingIntent</a>
2668
2354
render_</font></td>
2670
2356
</tr>
2671
2357
<tr>
2672
2358
<td>
2673
<center><a name="resolutionUnits"></a> <font size="-1">resolution-</font>
2674
<br>
2359
<center><a name="resolutionUnits"></a> <font size="-1">resolution-</font> <br>
2675
2360
<font size="-1">Units</font></center>
2676
2361
</td>
2677
<td><font size="-1"><a href="Enumerations.html#ResolutionType">ResolutionType</a>
2678
</font></td>
2362
<td><font size="-1"><a href="Enumerations.html#ResolutionType">ResolutionType</a> </font></td>
2679
2363
<td><font size="-1">void</font></td>
2680
2364
<td><font size="-1"><a href="Enumerations.html#ResolutionType">ResolutionType</a>
2681
2365
units_</font></td>
2685
2369
<td>
2686
2370
<center><a name="rows"></a> <font size="-1">rows</font></center>
2687
2371
</td>
2688
<td><font size="-1">size_t</font></td>
2372
<td><font size="-1">unsigned int</font></td>
2689
2373
<td><font size="-1">void</font></td>
2690
2374
<td bgcolor="#666666"><font size="-1"> </font></td>
2691
2375
<td><font size="-1">The number of pixel rows in the image</font></td>
2692
2376
</tr>
2693
2377
<tr>
2694
2378
<td>
2379
<center><a name="samplingFactor"></a> <font size="-1">samplingFactor</font></center>
2380
</td>
2381
<td><font size="-1">string (e.g. "2x1,1x1,1x1")</font></td>
2382
<td><font size="-1">void</font></td>
2383
<td><font size="-1">const string &samplingFactor_</font></td>
2384
<td><font size="-1">JPEG sampling factors</font></td>
2385
</tr>
2386
<tr>
2387
<td>
2695
2388
<center><a name="scene"></a> <font size="-1">scene</font></center>
2696
2389
</td>
2697
<td><font size="-1">size_t</font></td>
2390
<td><font size="-1">unsigned int</font></td>
2698
2391
<td><font size="-1">void</font></td>
2699
<td><font size="-1">size_t scene_</font></td>
2392
<td><font size="-1">unsigned int scene_</font></td>
2700
2393
<td><font size="-1">Image scene number</font></td>
2701
2394
</tr>
2702
2395
<tr>
2718
2411
<td><font size="-1">const <a href="Geometry.html">Geometry</a>
2719
2412
&geometry_</font></td>
2720
2413
<td><font size="-1">Width and height of a raw image (an image
2721
which does not support width and height information). Size may
2722
also be used to affect the image size read from a multi-resolution
2723
format (e.g. Photo CD, JBIG, or JPEG.</font></td>
2414
which does not support width and height information). Size may
2415
also be used to affect the image size read from a multi-resolution
2416
format (e.g. Photo CD, JBIG, or JPEG.</font></td>
2724
2417
</tr>
2725
2418
<tr>
2726
2419
<td>
2745
2438
<td>
2746
2439
<center><a name="strokeDashOffset"></a> <font size="-1">strokeDashOffset</font></center>
2747
2440
</td>
2748
<td><font size="-1">size_t</font></td>
2441
<td><font size="-1">unsigned int</font></td>
2749
2442
<td><font size="-1">void</font></td>
2750
2443
<td><font size="-1">double strokeDashOffset_</font></td>
2751
2444
<td><font size="-1">While drawing using a dash pattern, specify
2759
2452
<td><font size="-1">void</font></td>
2760
2453
<td><font size="-1">const double* strokeDashArray_</font></td>
2761
2454
<td><font size="-1">Specify the pattern of dashes and gaps used
2762
to stroke paths. The strokeDashArray represents a zero-terminated
2763
array of numbers that specify the lengths (in pixels) of alternating
2764
dashes and gaps in user units. If an odd number of values is provided,
2765
then the list of values is repeated to yield an even number of
2766
values. A typical strokeDashArray_ array might contain the
2767
members 5 3 2 0, where the zero value indicates the end of the pattern
2455
to stroke paths. The strokeDashArray represents a zero-terminated
2456
array of numbers that specify the lengths (in pixels) of alternating
2457
dashes and gaps in user units. If an odd number of values is provided,
2458
then the list of values is repeated to yield an even number of
2459
values. A typical strokeDashArray_ array might contain the
2460
members 5 3 2 0, where the zero value indicates the end of the pattern
2768
2461
array.</font></td>
2769
2462
</tr>
2770
2463
<tr>
2775
2468
<td><font size="-1">void</font></td>
2776
2469
<td><font size="-1">LineCap lineCap_</font></td>
2777
2470
<td><font size="-1">Specify the shape to be used at the corners
2778
of paths (or other vector shapes) when they are stroked. Values of
2779
LineJoin are UndefinedJoin, MiterJoin, RoundJoin, and BevelJoin.</font></td>
2471
of paths (or other vector shapes) when they are stroked. Values of
2472
LineJoin are UndefinedJoin, MiterJoin, RoundJoin, and BevelJoin.</font></td>
2780
2473
</tr>
2781
2474
<tr>
2782
2475
<td>
2786
2479
<td><font size="-1">void</font></td>
2787
2480
<td><font size="-1">LineJoin lineJoin_</font></td>
2788
2481
<td><font size="-1">Specify the shape to be used at the corners
2789
of paths (or other vector shapes) when they are stroked. Values of
2790
LineJoin are UndefinedJoin, MiterJoin, RoundJoin, and BevelJoin.</font></td>
2482
of paths (or other vector shapes) when they are stroked. Values of
2483
LineJoin are UndefinedJoin, MiterJoin, RoundJoin, and BevelJoin.</font></td>
2791
2484
</tr>
2792
2485
<tr>
2793
2486
<td>
2794
2487
<center><a name="strokeMiterLimit"></a> <font size="-1">strokeMiterLimit</font></center>
2795
2488
</td>
2796
<td><font size="-1">size_t</font></td>
2489
<td><font size="-1">unsigned int</font></td>
2797
2490
<td><font size="-1">void</font></td>
2798
<td><font size="-1">size_t miterLimit_</font></td>
2491
<td><font size="-1">unsigned int miterLimit_</font></td>
2799
2492
<td><font size="-1">Specify miter limit. When two line segments
2800
meet at a sharp angle and miter joins have been specified for
2801
'lineJoin', it is possible for the miter to extend far beyond the
2802
thickness of the line stroking the path. The miterLimit' imposes a
2803
limit on the ratio of the miter length to the 'lineWidth'. The default
2493
meet at a sharp angle and miter joins have been specified for
2494
'lineJoin', it is possible for the miter to extend far beyond the
2495
thickness of the line stroking the path. The miterLimit' imposes a
2496
limit on the ratio of the miter length to the 'lineWidth'. The default
2804
2497
value of this parameter is 4.</font></td>
2805
2498
</tr>
2806
2499
<tr>
2811
2504
<td><font size="-1">void</font></td>
2812
2505
<td><font size="-1">double strokeWidth_</font></td>
2813
2506
<td><font size="-1">Stroke width for use when drawing vector
2814
objects (default one)</font></td>
2507
objects (default one)</font></td>
2815
2508
</tr>
2816
2509
<tr>
2817
2510
<td>
2827
2520
<td>
2828
2521
<center><a name="subImage"></a> <font size="-1">subImage</font></center>
2829
2522
</td>
2830
<td><font size="-1">size_t</font></td>
2523
<td><font size="-1">unsigned int</font></td>
2831
2524
<td><font size="-1">void</font></td>
2832
<td><font size="-1">size_t subImage_</font></td>
2525
<td><font size="-1">unsigned int subImage_</font></td>
2833
2526
<td><font size="-1">Subimage of an image sequence</font></td>
2834
2527
</tr>
2835
2528
<tr>
2836
2529
<td>
2837
2530
<center><a name="subRange"></a> <font size="-1">subRange</font></center>
2838
2531
</td>
2839
<td><font size="-1">size_t</font></td>
2532
<td><font size="-1">unsigned int</font></td>
2840
2533
<td><font size="-1">void</font></td>
2841
<td><font size="-1">size_t subRange_</font></td>
2534
<td><font size="-1">unsigned int subRange_</font></td>
2842
2535
<td><font size="-1">Number of images relative to the base image</font></td>
2843
2536
</tr>
2844
2537
<tr>
2852
2545
</small></td>
2853
2546
<td valign="middle"><small>const std::string &encoding_</small><small><br>
2854
2547
</small></td>
2855
<td valign="top"><small>Specify the code set to use for text
2856
annotations. The only character encoding which may be specified at
2548
<td valign="top"><small>Specify the code set to use for text
2549
annotations. The only character encoding which may be specified at
2857
2550
this time is "UTF-8" for representing </small><small><a
2858
2551
href="http://www.unicode.org/"> Unicode </a> </small><small>as a
2859
sequence of bytes. Specify an empty string to use the default ASCII
2860
encoding. Successful text annotation using Unicode may require fonts
2552
sequence of bytes. Specify an empty string to use the default ASCII
2553
encoding. Successful text annotation using Unicode may require fonts
2861
2554
designed to support Unicode.</small><br>
2862
2555
</td>
2863
2556
</tr>
2883
2576
<td>
2884
2577
<center><a name="type"></a> <font size="-1">type</font></center>
2885
2578
</td>
2886
<td><font size="-1"><a href="Enumerations.html#ImageType">ImageType</a>
2887
</font></td>
2579
<td><font size="-1"><a href="Enumerations.html#ImageType">ImageType</a> </font></td>
2888
2580
<td><font size="-1">void</font></td>
2889
2581
<td bgcolor="#ffffff"><font size="-1"><a
2890
2582
href="Enumerations.html#ImageType"> ImageType</a> </font></td>
2910
2602
</tr>
2911
2603
<tr>
2912
2604
<td>
2913
<center><a name="virtualPixelMethod"></a> <font size="-1">virtualPixelMethod</font></center>
2914
</td>
2915
<td><font size="-1"><a href="Enumerations.html#VirtualPixelMethod">VirtualPixelMethod</a>
2916
</font></td>
2917
<td><small><font size="-1"><small>void</small></font></small></td>
2918
<td><small><font size="-1"><small><a
2919
href="Enumerations.html#VirtualPixelMethod">VirtualPixelMethod</a>
2920
virtualPixelMethod_</small></font></small></td>
2921
<td><font size="-1">Image virtual pixel method.</font></td>
2922
</tr>
2923
<tr>
2924
<td>
2925
2605
<center><a name="x11Display"></a> <font size="-1">x11Display</font></center>
2926
2606
</td>
2927
2607
<td><font size="-1">string (e.g. "hostname:0.0")</font></td>
2928
2608
<td><font size="-1">void</font></td>
2929
2609
<td><font size="-1">const string &display_</font></td>
2930
2610
<td><font size="-1">X11 display to display to, obtain fonts from,
2931
or to capture image from</font></td>
2611
or to capture image from</font></td>
2932
2612
</tr>
2933
2613
<tr>
2934
2614
<td>
2954
2634
<h3> <a name="Raw Image Pixel Access"></a> Low-Level Image Pixel Access</h3>
2955
2635
</center>
2956
2636
Image pixels (of type <i><a href="PixelPacket.html">PixelPacket</a> </i>)
2957
may be accessed directly via the <i>Image Pixel Cache</i> . The
2958
image pixel cache is a rectangular window into the actual image pixels
2959
(which may be in memory, memory-mapped from a disk file, or entirely on
2960
disk). Two interfaces exist to access the <i>Image Pixel Cache.</i>
2961
The
2962
interface described here (part of the <i>Image</i> class) supports
2963
only
2637
may be accessed directly via the <i>Image Pixel Cache</i> . The
2638
image pixel cache is a rectangular window into the actual image pixels
2639
(which may be in memory, memory-mapped from a disk file, or entirely on
2640
disk). Two interfaces exist to access the <i>Image Pixel Cache.</i> The
2641
interface described here (part of the <i>Image</i> class) supports only
2964
2642
one view at a time. See the <i><a href="Pixels.html">Pixels</a> </i>
2965
class for a more abstract interface which supports simultaneous pixel
2966
views (up to the number of rows). As an analogy, the interface
2967
described
2643
class for a more abstract interface which supports simultaneous pixel
2644
views (up to the number of rows). As an analogy, the interface described
2968
2645
here relates to the <i><a href="Pixels.html">Pixels</a> </i> class as
2969
stdio's gets() relates to fgets(). The <i><a href="Pixels.html"> Pixels</a>
2970
</i>class provides the more general form of the interface.
2971
<p>Obtain existing image pixels via <i>getPixels()</i>. Create a new
2646
stdio's gets() relates to fgets(). The <i><a href="Pixels.html"> Pixels</a> </i>
2647
class provides the more general form of the interface.
2648
<p>Obtain existing image pixels via <i>getPixels()</i>. Create a new
2972
2649
pixel region using <i>setPixels().</i></p>
2973
2650
<p>In order to ensure that only the current generation of the image is
2974
2651
modified, the Image's <a href="#modifyImage">modifyImage()</a> method
2977
2654
generation of the image to be modified due to the use of reference
2978
2655
counting when copying or constructing an Image.<br>
2979
2656
</p>
2980
<p>Depending on the capabilities of the operating system, and the
2657
<p>Depending on the capabilities of the operating system, and the
2981
2658
relationship of the window to the image, the pixel cache may be a copy
2982
2659
of the pixels in the selected window, or it may be the actual image
2983
2660
pixels. In any case calling <i>syncPixels()</i> insures that the base
2984
2661
image is updated with the contents of the modified pixel cache. The
2985
method <i> readPixels()</i> supports copying foreign pixel data
2986
formats
2987
into the pixel cache according to the <i>QuantumTypes</i>. The method <i>writePixels()</i>
2988
supports copying the pixels in the cache to a foreign pixel
2989
representation according to the format specified by <i>QuantumTypes</i>.</p>
2990
<p>The pixel region is effectively a small image in which the pixels
2662
method <i> readPixels()</i> supports copying foreign pixel data formats
2663
into the pixel cache according to the <i>QuantumTypes</i>. The method <i>writePixels()</i>
2664
supports copying the pixels in the cache to a foreign pixel
2665
representation according to the format specified by <i>QuantumTypes</i>.</p>
2666
<p>The pixel region is effectively a small image in which the pixels
2991
2667
may be accessed, addressed, and updated, as shown in the following
2992
2668
example:
2993
2669
<table border="0" width="100%">
3010
2686
size="-1"> // Request pixel region with size 60x40, and top origin at
3011
2687
20x30</font></font></font> <br>
3012
2688
<font face="Courier New,Courier"><font color="#000099"><font
3013
size="-1"> ssize_t columns = 60;</font></font></font> <br>
2689
size="-1"> int columns = 60;</font></font></font> <br>
3014
2690
<font face="Courier New,Courier"><font color="#000099"><font
3015
size="-1"> PixelPacket *pixel_cache =
3016
image.getPixels(20,30,columns,40);</font></font></font> <br>
2691
size="-1"> PixelPacket *pixel_cache = image.getPixels(20,30,columns,40);</font></font></font> <br>
3017
2692
<font face="Courier New,Courier"><font color="#ff0000"><font
3018
2693
size="-1"> // Set pixel at column 5, and row 10 in the pixel cache to
3019
2694
red.</font></font></font> <br>
3020
2695
<font face="Courier New,Courier"><font color="#000099"><font
3021
size="-1"> ssize_t column = 5;</font></font></font> <br>
3022
<font face="Courier New,Courier"><font color="#000099"><font
3023
size="-1"> ssize_t row = 10;</font></font></font> <br>
3024
<font face="Courier New,Courier"><font color="#000099"><font
3025
size="-1"> PixelPacket *pixel =
3026
pixel_cache+row*columns*sizeof(PixelPacket)+column;</font></font></font>
3027
<br>
2696
size="-1"> int column = 5;</font></font></font> <br>
2697
<font face="Courier New,Courier"><font color="#000099"><font
2698
size="-1"> int row = 10;</font></font></font> <br>
2699
<font face="Courier New,Courier"><font color="#000099"><font
2700
size="-1"> PixelPacket *pixel = pixel_cache+row*columns+column;</font></font></font> <br>
3028
2701
<font face="Courier New,Courier"><font color="#000099"><font
3029
2702
size="-1"> *pixel = Color("red");</font></font></font> <br>
3030
2703
<font face="Courier New,Courier"><font color="#ff0000"><font
3064
2737
</td>
3065
2738
<td><font size="-1">const <a href="PixelPacket.html">PixelPacket</a>
3066
2739
*</font></td>
3067
<td><font size="-1">const ssize_t x_, const ssize_t y_, const unsigned
3068
int columns_, const size_t rows_</font></td>
2740
<td><font size="-1">const int x_, const int y_, const unsigned
2741
int columns_, const unsigned int rows_</font></td>
3069
2742
<td><font size="-1">Transfers pixels from the image to the pixel
3070
2743
cache as defined by the specified rectangular region. </font><font
3071
2744
size="-1">The returned pointer remains valid until the next getPixel,
3072
getConstPixels, or setPixels call and should never be deallocated by
3073
the
2745
getConstPixels, or setPixels call and should never be deallocated by the
3074
2746
user.</font></td>
3075
2747
</tr>
3076
2748
<tr>
3084
2756
getConstPixels, or setPixels call. </font><font size="-1">The
3085
2757
returned pointer remains valid until the next getPixel, getConstPixels,
3086
2758
or setPixels call and should never be deallocated by the user.</font><font
3087
size="-1"> Only valid for PseudoClass images or CMYKA images. The
3088
pixel indexes represent an array of type IndexPacket, with each entry
3089
corresponding to an x,y pixel position. For PseudoClass images, the
3090
entry's value is the offset into the colormap (see <a href="#colorMap">colorMap</a>
2759
size="-1"> Only valid for PseudoClass images or CMYKA images. The
2760
pixel indexes represent an array of type IndexPacket, with each entry
2761
corresponding to an x,y pixel position. For PseudoClass images, the
2762
entry's value is the offset into the colormap (see <a href="#colorMap">colorMap</a>
3091
2763
) for that pixel. For CMYKA images, the indexes are used to contain the
3092
2764
alpha channel.</font></td>
3093
2765
</tr>
3100
2772
<td><font size="-1">Returns a pointer to the Image pixel indexes
3101
2773
corresponding to the pixel region requested by the last <a
3102
2774
href="#getConstPixels">getConstPixels</a> , <a href="#getPixels">getPixels</a>
3103
, or <a href="#setPixels">setPixels</a> call. </font><font
3104
size="-1">The
2775
, or <a href="#setPixels">setPixels</a> call. </font><font size="-1">The
3105
2776
returned pointer remains valid until the next getPixel, getConstPixels,
3106
2777
or setPixels call and should never be deallocated by the user.</font><font
3107
size="-1"> </font><font size="-1">Only valid for PseudoClass images
3108
or
3109
CMYKA images. The pixel indexes represent an array of type
3110
IndexPacket, with each entry corresponding to a pixel x,y position. For
3111
PseudoClass images, the entry's value is the offset into the colormap
3112
(see <a href="#colorMap">colorMap</a> ) for that pixel. For
3113
CMYKA
3114
images, the indexes are used to contain the alpha channel.</font></td>
2778
size="-1"> </font><font size="-1">Only valid for PseudoClass images or
2779
CMYKA images. The pixel indexes represent an array of type
2780
IndexPacket, with each entry corresponding to a pixel x,y position. For
2781
PseudoClass images, the entry's value is the offset into the colormap
2782
(see <a href="#colorMap">colorMap</a> ) for that pixel. For CMYKA
2783
images, the indexes are used to contain the alpha channel.</font></td>
3115
2784
</tr>
3116
2785
<tr>
3117
2786
<td>
3118
2787
<center><a name="getPixels"></a> <font size="-1">getPixels</font></center>
3119
2788
</td>
3120
2789
<td><font size="-1"><a href="PixelPacket.html">PixelPacket</a> *</font></td>
3121
<td><font size="-1">const ssize_t x_, const ssize_t y_, const unsigned
3122
int columns_, const size_t rows_</font></td>
2790
<td><font size="-1">const int x_, const int y_, const unsigned
2791
int columns_, const unsigned int rows_</font></td>
3123
2792
<td><font size="-1">Transfers pixels from the image to the pixel
3124
2793
cache as defined by the specified rectangular region. Modified pixels
3125
may be subsequently transferred back to the image via syncPixels. </font><font
2794
may be subsequently transferred back to the image via syncPixels. </font><font
3126
2795
size="-1">The returned pointer remains valid until the next getPixel,
3127
getConstPixels, or setPixels call and should never be deallocated by
3128
the
2796
getConstPixels, or setPixels call and should never be deallocated by the
3129
2797
user.</font><font size="-1"></font></td>
3130
2798
</tr>
3131
2799
<tr>
3133
2801
<center><a name="setPixels"></a> <font size="-1">setPixels</font></center>
3134
2802
</td>
3135
2803
<td><font size="-1"><a href="PixelPacket.html">PixelPacket</a> *</font></td>
3136
<td><font size="-1">const ssize_t x_, const ssize_t y_, const unsigned
3137
int columns_, const size_t rows_</font></td>
2804
<td><font size="-1">const int x_, const int y_, const unsigned
2805
int columns_, const unsigned int rows_</font></td>
3138
2806
<td><font size="-1">Allocates a pixel cache region to store image
3139
2807
pixels as defined by the region rectangle. This area is
3140
subsequently transferred from the pixel cache to the image via
2808
subsequently transferred from the pixel cache to the image via
3141
2809
syncPixels. </font><font size="-1">The returned pointer remains
3142
2810
valid until the next getPixel, getConstPixels, or setPixels call and
3143
2811
should never be deallocated by the user.</font></td>
3170
2838
<td><font size="-1"><a href="Enumerations.html#QuantumTypes">QuantumTypes</a>
3171
2839
quantum_, unsigned char *destination_</font></td>
3172
2840
<td><font size="-1">Transfers one or more pixel components from
3173
the image pixel cache to a buffer or file. WritePixels is typically
3174
used to support image encoders. The region transferred corresponds to
2841
the image pixel cache to a buffer or file. WritePixels is typically
2842
used to support image encoders. The region transferred corresponds to
3175
2843
the region set by a preceding getPixels or getConstPixels call.</font></td>
3176
2844
</tr>
3177
2845
</tbody>
Loggerhead is a web-based interface for Breezy
Version: 2.0.1