Debian Codegraph @

www/Magick++/Image++.html

raw
1 <?xml version="1.0" encoding="utf-8" ?>
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4 <head>
5 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
6 <title>Magick++ API: Working with Images</title>
7 <link rel="stylesheet" href="magick.css" type="text/css" />
8 </head>
9 <body>
10 <div class="doc-section">
11 <center>
12 <h1> Magick::Image Class</h1>
13 </center>
14 <h4> Quick Contents</h4>
15 <ul>
16 <li> <a href="Image++.html#BLOBs">BLOBs</a> </li>
17 <li> <a href="Image++.html#Constructors">Constructors</a> </li>
18 <li>
19 <a href="Image++.html#Image%20Manipulation%20Methods">
20 Image Manipulation
21 Methods
22 </a>
23 </li>
24 <li> <a href="Image++.html#Image%20Attributes">Image Attributes</a> </li>
25 <li>
26 <a href="Image++.html#Raw%20Image%20Pixel%20Access">
27 Low-Level Image Pixel
28 Access
29 </a>
30 </li>
31 </ul>
32 <p>
33 Image is the primary object in Magick++ and represents
34 a single image frame (see <a href="https://imagemagick.org/Magick++/ImageDesign.html">design</a> ). The
35 <a href="STL.html">STL interface</a> <b>must</b> be used to operate on
36 image sequences or images (e.g. of format GIF, TIFF, MIFF, Postscript,
37 &amp; MNG) which are comprized of multiple image frames. Individual
38 frames of a multi-frame image may be requested by adding array-style
39 notation to the end of the file name (e.g. "animation.gif[3]" retrieves
40 the fourth frame of a GIF animation.&#160; Various image manipulation
41 operations may be applied to the image. Attributes may be set on the
42 image to influence the operation of the manipulation operations. The <a href="Pixels.html">Pixels</a> class provides low-level access to
43 image
44 pixels. As a convenience, including <tt><font color="#663366">&lt;Magick++.h&gt;</font></tt>
45 is sufficient in order to use the complete Magick++ API. The Magick++
46 API is enclosed within the <i>Magick</i> namespace so you must either
47 add the prefix "<tt> Magick::</tt> " to each class/enumeration name or
48 add
49 the statement "<tt> using namespace Magick;</tt>" after including the <tt>Magick++.h</tt>
50 header.
51 </p>
52 <p>
53 The preferred way to allocate Image objects is via automatic
54 allocation (on the stack). There is no concern that allocating Image
55 objects on the stack will excessively enlarge the stack since Magick++
56 allocates all large data objects (such as the actual image data) from
57 the heap. Use of automatic allocation is preferred over explicit
58 allocation (via <i>new</i>) since it is much less error prone and
59 allows use of C++ scoping rules to avoid memory leaks. Use of automatic
60 allocation allows Magick++ objects to be assigned and copied just like
61 the C++ intrinsic data types (e.g. '<i>int</i> '), leading to clear and
62 easy to read code. Use of automatic allocation leads to naturally
63 exception-safe code since if an exception is thrown, the object is
64 automagically deallocated once the stack unwinds past the scope of the
65 allocation (not the case for objects allocated via <i>new</i> ).
66 </p>
67 <p>
68 Image is very easy to use. For example, here is a the source to a
69 program which reads an image, crops it, and writes it to a new file
70 (the
71 exception handling is optional but strongly recommended):
72 </p>
73 <pre class="code">
74 #include &lt;Magick++.h>
75 #include &lt;iostream>
76 using namespace std;
77 using namespace Magick;
78 int main(int argc,char **argv)
79 {
80 InitializeMagick(*argv);
81
82 // Construct the image object. Seperating image construction from the
83 // the read operation ensures that a failure to read the image file
84 // doesn't render the image object useless.
85 Image image;
86 try {
87 // Read a file into image object
88 image.read( "girl.gif" );
89
90 // Crop the image to specified size (width, height, xOffset, yOffset)
91 image.crop( Geometry(100,100, 100, 100) );
92
93 // Write the image to a file
94 image.write( "x.gif" );
95 }
96 catch( Exception &amp;error_ )
97 {
98 cout &lt;&lt; "Caught exception: " &lt;&lt; error_.what() &lt;&lt; endl;
99 return 1;
100 }
101 return 0;
102 }
103 </pre>
104 The following is the source to a program which illustrates the use of
105 Magick++'s efficient reference-counted assignment and copy-constructor
106 operations which minimize use of memory and eliminate unncessary copy
107 operations (allowing Image objects to be efficiently assigned, and
108 copied into containers).&#160; The program accomplishes the
109 following:
110 <ol>
111 <li> Read master image.</li>
112 <li> Assign master image to second image.</li>
113 <li> Resize second image to the size 640x480.</li>
114 <li> Assign master image to a third image.</li>
115 <li> Resize third image to the size 800x600.</li>
116 <li> Write the second image to a file.</li>
117 <li> Write the third image to a file.</li>
118 </ol>
119 <pre class="code">
120 #include &lt;Magick++.h>
121 #include &lt;iostream>
122 using namespace std;
123 using namespace Magick;
124 int main(int argc,char **argv)
125 {
126 InitializeMagick(*argv);
127
128 Image master("horse.jpg");
129 Image second = master;
130 second.resize("640x480");
131 Image third = master;
132 third.resize("800x600");
133 second.write("horse640x480.jpg");
134 third.write("horse800x600.jpg");
135 return 0;
136 }
137 </pre>
138 During the entire operation, a maximum of three images exist in memory
139 and the image data is never copied.
140 <p>
141 The following is the source for another simple program which creates
142 a 100 by 100 pixel white image with a red pixel in the center and
143 writes it to a file:
144 </p>
145 <pre class="code">
146 #include &lt;Magick++.h>
147 using namespace std;
148 using namespace Magick;
149 int main(int argc,char **argv)
150 {
151 InitializeMagick(*argv);
152 Image image( "100x100", "white" );
153 image.pixelColor( 49, 49, "red" );
154 image.write( "red_pixel.png" );
155 return 0;
156 }
157 </pre>
158 If you wanted to change the color image to grayscale, you could add the
159 lines:
160 <pre class="code">
161 image.quantizeColorSpace( GRAYColorspace );
162 image.quantizeColors( 256 );
163 image.quantize( );
164 </pre>
165 <p>or, more simply: </p>
166 <pre class="code">
167 image.type( GrayscaleType );
168 </pre>
169 <p>prior to writing the image. </p>
170 <center>
171 <h3> <a name="BLOBs"></a> BLOBs</h3>
172 </center>
173 While encoded images (e.g. JPEG) are most often written-to and
174 read-from a disk file, encoded images may also reside in memory.
175 Encoded
176 images in memory are known as BLOBs (Binary Large OBjects) and may be
177 represented using the <a href="Blob.html">Blob</a> class. The encoded
178 image may be initially placed in memory by reading it directly from a
179 file, reading the image from a database, memory-mapped from a disk
180 file, or could be written to memory by Magick++. Once the encoded image
181 has been placed within a Blob, it may be read into a Magick++ Image via
182 a <a href="Image++.html#constructor_blob">constructor</a> or <a href="Image++.html#read">read()</a>
183 . Likewise, a Magick++ image may be written to a Blob via <a href="Image++.html#write">write()</a> .
184 <p>
185 An example of using Image to write to a Blob follows: <br />
186 &#160;
187 </p>
188 <pre class="code">
189 #include &gt;Magick++.h>
190 using namespace std;
191 using namespace Magick;
192 int main(int argc,char **argv)
193 {
194 InitializeMagick(*argv);
195
196 // Read GIF file from disk
197 Image image( "giraffe.gif" );
198 // Write to BLOB in JPEG format
199 Blob blob;
200 image.magick( "JPEG" ) // Set JPEG output format
201 image.write( &amp;blob );
202
203 [ Use BLOB data (in JPEG format) here ]
204
205 return 0;
206 }
207 </pre>
208 <p>
209 <br />
210 likewise, to read an image from a Blob, you could use one of the
211 following examples:
212 </p>
213 <p>
214 [ <font color="#000000">
215 Entry condition for the following examples
216 is that <i>data</i> is pointer to encoded image data and <i>length</i>
217 represents the size of the data
218 </font> ]
219 </p>
220 <pre class="code">
221 Blob blob( data, length );
222 Image image( blob );
223 </pre>
224 or
225 <pre class="code">
226 Blob blob( data, length );
227 Image image;
228 image.read( blob);
229 </pre>
230 some images do not contain their size or format so the size and format must be specified in advance:
231 <pre class="code">
232 Blob blob( data, length );
233 Image image;
234 image.size( "640x480")
235 image.magick( "RGBA" );
236 image.read( blob);
237 </pre>
238 <center>
239 <h3> <a name="Constructors"></a> Constructors</h3>
240 </center>
241 Image may be constructed in a number of ways. It may be constructed
242 from a file, a URL, or an encoded image (e.g. JPEG) contained in an
243 in-memory <a href="Blob.html"> BLOB</a> . The available Image
244 constructors are shown in the following table: <br />
245 &#160; <br />
246 &#160;
247 <table bgcolor="#ffffff" border="1" width="100%">
248 <caption><b>Image Constructors</b></caption>
249 <tbody>
250 <tr>
251 <td>
252 <center><b>Signature</b></center>
253 </td>
254 <td>
255 <center><b>Description</b></center>
256 </td>
257 </tr>
258 <tr>
259 <td><font size="-1">const std::string &amp;imageSpec_</font></td>
260 <td>
261 <font size="-1">
262 Construct Image by reading from file or URL
263 specified by <i>imageSpec_</i>. Use array notation (e.g. filename[9])
264 to select a specific scene from a multi-frame image.
265 </font>
266 </td>
267 </tr>
268 <tr>
269 <td>
270 <font size="-1">
271 const Geometry &amp;size_, const <a href="Color.html">Color</a> &amp;color_
272 </font>
273 </td>
274 <td>
275 <font size="-1">
276 Construct a blank image canvas of specified
277 size and color
278 </font>
279 </td>
280 </tr>
281 <tr>
282 <td>
283 <a name="constructor_blob"></a> <font size="-1">
284 const <a href="Blob.html">Blob</a> &amp;blob_
285 </font>
286 </td>
287 <td rowspan="5">
288 <font size="-1">
289 Construct Image by reading from
290 encoded image data contained in an in-memory <a href="Blob.html">BLOB</a>
291 . Depending on the constructor arguments, the Blob <a href="Image++.html#size">size</a>
292 , <a href="Image++.html#depth">depth</a> , <a href="Image++.html#magick">magick</a> (format)
293 may
294 also be specified. Some image formats require that size be specified.
295 The default ImageMagick uses for depth depends on the compiled-in
296 Quantum size (8 or 16).&#160; If ImageMagick's Quantum size does not
297 match that of the image, the depth may need to be specified.
298 ImageMagick can usually automagically detect the image's format.
299 When a format can't be automagically detected, the format (<a href="Image++.html#magick">magick</a> ) must be specified.
300 </font>
301 </td>
302 </tr>
303 <tr>
304 <td>
305 <font size="-1">
306 const <a href="Blob.html">Blob</a>
307 &amp;blob_, const <a href="Geometry.html">Geometry</a> &amp;size_
308 </font>
309 </td>
310 </tr>
311 <tr>
312 <td>
313 <font size="-1">
314 const <a href="Blob.html">Blob</a>
315 &amp;blob_, const <a href="Geometry.html">Geometry</a> &amp;size,
316 size_t depth
317 </font>
318 </td>
319 </tr>
320 <tr>
321 <td>
322 <font size="-1">
323 const <a href="Blob.html">Blob</a>
324 &amp;blob_, const <a href="Geometry.html">Geometry</a> &amp;size,
325 size_t depth_, const string &amp;magick_
326 </font>
327 </td>
328 </tr>
329 <tr>
330 <td>
331 <font size="-1">
332 const <a href="Blob.html">Blob</a>
333 &amp;blob_, const <a href="Geometry.html">Geometry</a> &amp;size,
334 const
335 string &amp;magick_
336 </font>
337 </td>
338 </tr>
339 <tr>
340 <td>
341 <font size="-1">const size_t width_,&#160;</font> <br />
342 <font size="-1">const size_t height_,</font> <br />
343 <font size="-1">std::string map_,</font> <br />
344 <font size="-1">
345 const <a href="https://imagemagick.org/Magick++/Enumerations.html#StorageType">
346 StorageType
347 </a> type_,
348 </font> <br />
349 <font size="-1">const void *pixels_</font>
350 </td>
351 <td>
352 <font size="-1">
353 Construct a new Image based on an array of
354 image pixels. The pixel data must be in scanline order top-to-bottom.
355 The data can be character, short int, integer, float, or double. Float
356 and double require the pixels to be normalized [0..1]. The other types
357 are [0..MaxRGB].&#160; For example, to create a 640x480 image from
358 unsigned red-green-blue character data, use
359 </font>
360 <p>
361 <font size="-1">
362 &#160;&#160; Image image( 640, 480, "RGB",
363 0, pixels );
364 </font>
365 </p>
366 <p>
367 <font size="-1">The parameters are as follows:</font> <br />
368 &#160;
369 </p>
370 <table border="0" width="100%">
371 <tbody>
372 <tr>
373 <td><font size="-1">width_</font></td>
374 <td><font size="-1">Width in pixels of the image.</font></td>
375 </tr>
376 <tr>
377 <td><font size="-1">height_</font></td>
378 <td><font size="-1">Height in pixels of the image.</font></td>
379 </tr>
380 <tr>
381 <td><font size="-1">map_</font></td>
382 <td>
383 <font size="-1">
384 This character string can be any
385 combination or order of R = red, G = green, B = blue, A = alpha, C =
386 cyan, Y = yellow M = magenta, and K = black. The ordering reflects the
387 order of the pixels in the supplied pixel array.
388 </font>
389 </td>
390 </tr>
391 <tr>
392 <td><font size="-1">type_</font></td>
393 <td>
394 <font size="-1">
395 <a href="https://imagemagick.org/Magick++/Enumerations.html#StorageType">
396 Pixel
397 storage type
398 </a> (CharPixel, ShortPixel, IntegerPixel, FloatPixel, or
399 DoublePixel)
400 </font>
401 </td>
402 </tr>
403 <tr>
404 <td><font size="-1">pixels_</font></td>
405 <td>
406 <font size="-1">
407 This array of values contain the pixel
408 components as defined by the map_ and type_ parameters. The length of
409 the arrays must equal the area specified by the width_ and height_
410 values and type_ parameters.
411 </font>
412 </td>
413 </tr>
414 </tbody>
415 </table>
416 </td>
417 </tr>
418 </tbody>
419 </table>
420 <center>
421 <h3>
422 <a name="Image Manipulation Methods"></a> Image Manipulation
423 Methods
424 </h3>
425 </center>
426 <i>Image</i> supports access to all the single-image (versus
427 image-list) manipulation operations provided by the ImageMagick
428 library. If you
429 must process a multi-image file (such as an animation), the <a href="STL.html">STL interface</a> , which provides a multi-image
430 abstraction on top of <i>Image</i>, must be used.
431 <p>Image manipulation methods are very easy to use.&#160; For example: </p>
432 <pre class="code">
433 Image image;
434 image.read("myImage.tiff");
435 image.addNoise(GaussianNoise);
436 image.write("myImage.tiff");
437 </pre>
438 adds gaussian noise to the image file "myImage.tiff".
439 <p>
440 The operations supported by Image are shown in the following table: <br />
441 &#160;
442 </p>
443 <table border="1">
444 <caption><b>Image Image Manipulation Methods</b></caption>
445 <tbody>
446 <tr align="center">
447 <td><b>Method</b></td>
448 <td><b>Signature(s)</b></td>
449 <td><b>Description</b></td>
450 </tr>
451 <tr>
452 <td style="text-align: center;" valign="middle">
453 <div style="text-align:center">
454 <a name="adaptiveThreshold"></a> <font size="-1">
455 adaptiveThreshold<br />
456 </font>
457 </div>
458 </td>
459 <td valign="middle">
460 <font size="-1">
461 size_t width, size_t
462 height, size_t offset = 0<br />
463 </font>
464 </td>
465 <td valign="top">
466 <font size="-1">
467 Apply adaptive thresholding to
468 the image. Adaptive thresholding is useful if the ideal threshold level
469 is not known in advance, or if the illumination gradient is not
470 constant
471 across the image. Adaptive thresholding works by evaulating the mean
472 (average) of a pixel region (size specified by <i>width</i> and <i>height</i>)
473 and using the mean as the thresholding value. In order to remove
474 residual noise from the background, the threshold may be adjusted by
475 subtracting a constant <i>offset</i> (default zero) from the mean to
476 compute the threshold.
477 </font><br />
478 </td>
479 </tr>
480 <tr>
481 <td style="text-align: center;">
482 <center><a name="addNoise"></a> <font size="-1">addNoise</font></center>
483 </td>
484 <td>
485 <font size="-1">
486 <a href="https://imagemagick.org/Magick++/Enumerations.html#NoiseType">NoiseType</a>
487 noiseType_
488 </font>
489 </td>
490 <td><font size="-1">Add noise to image with specified noise type.</font></td>
491 </tr>
492 <tr>
493 <td style="vertical-align: middle; text-align: center;">
494 <small>
495 <a name="addNoiseChannel"></a>addNoiseChannel<br />
496 </small>
497 </td>
498 <td style="vertical-align: middle;">
499 <small>
500 const ChannelType
501 channel_, const NoiseType noiseType_<br />
502 </small>
503 </td>
504 <td style="vertical-align: middle;">
505 <small>
506 Add noise to an image
507 channel with the specified noise type.
508 </small><font size="-1">
509 The <span style="font-style: italic;">channel_</span> parameter specifies the
510 channel to add noise to.&#160; The
511 </font><small>
512 noiseType_ parameter
513 specifies the type of noise.<br />
514 </small>
515 </td>
516 </tr>
517 <tr>
518 <td style="vertical-align: middle; text-align: center;">
519 <small>
520 <a name="affineTransform"></a>affineTransform<br />
521 </small>
522 </td>
523 <td style="vertical-align: middle;">
524 <small>
525 const DrawableAffine
526 &amp;affine<br />
527 </small>
528 </td>
529 <td style="vertical-align: middle;">
530 <small>
531 Transform image by
532 specified affine (or free transform) matrix.<br />
533 </small>
534 </td>
535 </tr>
536 <tr>
537 <td style="text-align: center;" rowspan="4">
538 <center><a name="annotate"></a> <font size="-1">annotate</font></center>
539 </td>
540 <td>
541 <font size="-1">
542 const std::string &amp;text_, const <a href="Geometry.html">Geometry</a> &amp;location_
543 </font>
544 </td>
545 <td>
546 <font size="-1">
547 Annotate using specified text, and placement
548 location
549 </font>
550 </td>
551 </tr>
552 <tr>
553 <td>
554 <font size="-1">
555 string text_, const <a href="Geometry.html">Geometry</a>
556 &amp;boundingArea_, <a href="https://imagemagick.org/Magick++/Enumerations.html#GravityType">GravityType</a>
557 gravity_
558 </font>
559 </td>
560 <td>
561 <font size="-1">
562 Annotate using specified text, bounding area,
563 and placement gravity. If <i>boundingArea_</i> is invalid, then
564 bounding area is entire image.
565 </font>
566 </td>
567 </tr>
568 <tr>
569 <td>
570 <font size="-1">
571 const std::string &amp;text_, const <a href="Geometry.html">Geometry</a> &amp;boundingArea_, <a href="https://imagemagick.org/Magick++/Enumerations.html#GravityType">GravityType</a> gravity_, double
572 degrees_,&#160;
573 </font>
574 </td>
575 <td>
576 <font size="-1">
577 Annotate with text using specified text,
578 bounding area, placement gravity, and rotation. If <i>boundingArea_</i>
579 is invalid, then bounding area is entire image.
580 </font>
581 </td>
582 </tr>
583 <tr>
584 <td>
585 <font size="-1">
586 const std::string &amp;text_, <a href="https://imagemagick.org/Magick++/Enumerations.html#GravityType">GravityType</a> gravity_
587 </font>
588 </td>
589 <td>
590 <font size="-1">
591 Annotate with text (bounding area is entire
592 image) and placement gravity.
593 </font>
594 </td>
595 </tr>
596 <tr>
597 <td style="text-align: center;">
598 <center><a name="blur"></a> <font size="-1">blur</font></center>
599 </td>
600 <td>
601 <font size="-1">
602 const double radius_ = 1, const double sigma_
603 = 0.5
604 </font>
605 </td>
606 <td>
607 <font size="-1">
608 Blur image. The <i>radius_ </i>parameter
609 specifies the radius of the Gaussian, in pixels, not counting the
610 center
611 pixel.&#160; The <i>sigma_</i> parameter specifies the standard
612 deviation of the Laplacian, in pixels.
613 </font>
614 </td>
615 </tr>
616 <tr>
617 <td style="vertical-align: middle; text-align: center;">
618 <small>
619 <a name="blurChannel"></a>blurChannel<br />
620 </small>
621 </td>
622 <td style="vertical-align: middle;">
623 <small>
624 const ChannelType
625 channel_, const double radius_ = 0.0, const double sigma_ = 1.0<br />
626 </small>
627 </td>
628 <td style="vertical-align: middle;">
629 <font size="-1">
630 Blur an image
631 channel. The <span style="font-style: italic;">channel_</span>
632 parameter specifies the channel to blur. The <i>radius_ </i>parameter
633 specifies the radius of the Gaussian, in pixels, not counting the
634 center
635 pixel.&#160; The <i>sigma_</i> parameter specifies the standard
636 deviation of the Laplacian, in pixels.
637 </font>
638 </td>
639 </tr>
640 <tr>
641 <td style="text-align: center;">
642 <center><a name="border"></a> <font size="-1">border</font></center>
643 </td>
644 <td>
645 <font size="-1">
646 const <a href="Geometry.html">Geometry</a>
647 &amp;geometry_ = "6x6+0+0"
648 </font>
649 </td>
650 <td>
651 <font size="-1">
652 Border image (add border to image).&#160; The
653 color of the border is specified by the <i>borderColor</i> attribute.
654 </font>
655 </td>
656 </tr>
657 <tr>
658 <td style="text-align: center;">
659 <center><a name="cdl"></a> <font size="-1">cdl</font></center>
660 </td>
661 <td><font size="-1">const std::string &amp;cdl_</font></td>
662 <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>
663 </tr>
664 <tr>
665 <td style="text-align: center;">
666 <center><a name="channel"></a> <font size="-1">channel</font></center>
667 </td>
668 <td>
669 <font size="-1">
670 <a href="https://imagemagick.org/Magick++/Enumerations.html#ChannelType">ChannelType</a>
671 channel_
672 </font>
673 </td>
674 <td>
675 <font size="-1">
676 Extract channel from image. Use this option
677 to extract a particular channel from&#160; the image.&#160; <i>alphaChannel</i>
678 &#160; for&#160; example, is useful for extracting the alpha values
679 from an image.
680 </font>
681 </td>
682 </tr>
683 <tr>
684 <td style="text-align: center;">
685 <center><a name="charcoal"></a> <font size="-1">charcoal</font></center>
686 </td>
687 <td>
688 <font size="-1">
689 const double radius_ = 1, const double sigma_
690 = 0.5
691 </font>
692 </td>
693 <td>
694 <font size="-1">
695 Charcoal effect image (looks like charcoal
696 sketch). The <i>radius_</i> parameter specifies the radius of the
697 Gaussian, in pixels, not counting the center pixel.&#160; The <i>sigma_</i>
698 parameter specifies the standard deviation of the Laplacian, in pixels.
699 </font>
700 </td>
701 </tr>
702 <tr>
703 <td style="text-align: center;">
704 <center><a name="chop"></a> <font size="-1">chop</font></center>
705 </td>
706 <td>
707 <font size="-1">
708 const <a href="Geometry.html">Geometry</a>
709 &amp;geometry_
710 </font>
711 </td>
712 <td>
713 <font size="-1">
714 Chop image (remove vertical or horizontal
715 subregion of image)
716 </font>
717 </td>
718 </tr>
719 <tr>
720 <td style="text-align: center;">
721 <center><a name="colorize"></a> <font size="-1">colorize</font></center>
722 </td>
723 <td>
724 <font size="-1">
725 const unsigned int opacityRed_, const
726 unsigned int opacityGreen_, const unsigned int opacityBlue_, const
727 Color &amp;penColor_
728 </font>
729 </td>
730 <td>
731 <font size="-1">
732 Colorize image with pen color, using
733 specified percent opacity for red, green, and blue quantums.
734 </font>
735 </td>
736 </tr>
737 <tr>
738 <td style="text-align: center;">
739 <center><a name="colorMatrix"></a> <font size="-1">colorMatrix</font></center>
740 </td>
741 <td><font size="-1">const size_t order_, const double *color_matrix_</font></td>
742 <td><font size="-1">apply color correction to the image.</font></td>
743 </tr>
744 <tr>
745 <td style="text-align: center;">
746 <center><a name="comment"></a> <font size="-1">comment</font></center>
747 </td>
748 <td><font size="-1">const std::string &amp;comment_</font></td>
749 <td>
750 <font size="-1">
751 Comment image (add comment string to
752 image).&#160; By default, each image is commented with its file name.
753 Use&#160; this&#160; method to&#160; assign a specific comment to the
754 image.&#160; Optionally you can include the image filename, type,
755 width, height, or other&#160; image&#160; attributes by embedding <a href="https://imagemagick.org/Magick++/FormatCharacters.html">special format characters.</a>
756 </font>
757 </td>
758 </tr>
759 <tr>
760 <td style="text-align: center;" valign="middle">
761 <font size="-1">
762 <a name="compare"></a> compare<br />
763 </font>
764 </td>
765 <td valign="middle">
766 <font size="-1">
767 const Image &amp;reference_<br />
768 </font>
769 </td>
770 <td valign="top">
771 <font size="-1">
772 Compare current image with
773 another image. Sets <a href="Image++.html#meanErrorPerPixel">meanErrorPerPixel</a>
774 , <a href="Image++.html#normalizedMaxError">normalizedMaxError</a> , and <a href="Image++.html#normalizedMeanError">normalizedMeanError</a> in the current
775 image. False is returned if the images are identical. An ErrorOption
776 exception is thrown if the reference image columns, rows, colorspace,
777 or
778 matte differ from the current image.
779 </font><br />
780 </td>
781 </tr>
782 <tr>
783 <td style="text-align: center;" rowspan="3">
784 <center><a name="composite"></a> <font size="-1">composite</font></center>
785 </td>
786 <td>
787 <font size="-1">
788 const <a href="Image++.html">Image</a>
789 &amp;compositeImage_, ssize_t xOffset_, ssize_t yOffset_, <a href="https://imagemagick.org/Magick++/Enumerations.html#CompositeOperator">CompositeOperator</a>
790 compose_ = <i>InCompositeOp</i>
791 </font>
792 </td>
793 <td>
794 <font size="-1">
795 Compose an image onto the current image at
796 offset specified by <i>xOffset_</i>, <i>yOffset_ </i>using the
797 composition algorithm specified by <i>compose_</i>.&#160;
798 </font>
799 </td>
800 </tr>
801 <tr>
802 <td>
803 <font size="-1">
804 const <a href="Image++.html">Image</a>
805 &amp;compositeImage_, const <a href="Geometry.html">Geometry</a>
806 &amp;offset_, <a href="https://imagemagick.org/Magick++/Enumerations.html#CompositeOperator">CompositeOperator</a>
807 compose_ = <i>InCompositeOp</i>
808 </font>
809 </td>
810 <td>
811 <font size="-1">
812 Compose an image onto the current image at
813 offset specified by <i>offset_</i> using the composition algorithm
814 specified by <i>compose_</i> .&#160;
815 </font>
816 </td>
817 </tr>
818 <tr>
819 <td>
820 <font size="-1">
821 const <a href="Image++.html">Image</a>
822 &amp;compositeImage_, <a href="https://imagemagick.org/Magick++/Enumerations.html#GravityType">GravityType</a>
823 gravity_, <a href="https://imagemagick.org/Magick++/Enumerations.html#CompositeOperator">CompositeOperator</a>
824 compose_ = <i>InCompositeOp</i>
825 </font>
826 </td>
827 <td>
828 <font size="-1">
829 Compose an image onto the current image with
830 placement specified by <i>gravity_ </i>using the composition
831 algorithm
832 specified by <i>compose_</i>.&#160;
833 </font>
834 </td>
835 </tr>
836 <tr>
837 <td style="text-align: center;">
838 <center><a name="contrast"></a> <font size="-1">contrast</font></center>
839 </td>
840 <td><font size="-1">size_t sharpen_</font></td>
841 <td>
842 <font size="-1">
843 Contrast image (enhance intensity differences
844 in image)
845 </font>
846 </td>
847 </tr>
848 <tr>
849 <td style="text-align: center;">
850 <center><a name="convolve"></a> <font size="-1">convolve</font></center>
851 </td>
852 <td><font size="-1">size_t order_, const double *kernel_</font></td>
853 <td>
854 <font size="-1">
855 Convolve image.&#160; Applies a user-specfied
856 convolution to the image. The <i>order_</i> parameter represents the
857 number of columns and rows in the filter kernel, and <i>kernel_</i>
858 is a two-dimensional array of doubles representing the convolution
859 kernel to apply.
860 </font>
861 </td>
862 </tr>
863 <tr>
864 <td style="text-align: center;">
865 <center><a name="crop"></a> <font size="-1">crop</font></center>
866 </td>
867 <td>
868 <font size="-1">
869 const <a href="Geometry.html">Geometry</a>
870 &amp;geometry_
871 </font>
872 </td>
873 <td><font size="-1">Crop image (subregion of original image)</font></td>
874 </tr>
875 <tr>
876 <td style="text-align: center;">
877 <center><a name="cycleColormap"></a> <font size="-1">cycleColormap</font></center>
878 </td>
879 <td><font size="-1">int amount_</font></td>
880 <td><font size="-1">Cycle image colormap</font></td>
881 </tr>
882 <tr>
883 <td style="text-align: center;">
884 <center><a name="despeckle"></a> <font size="-1">despeckle</font></center>
885 </td>
886 <td><font size="-1">void</font></td>
887 <td><font size="-1">Despeckle image (reduce speckle noise)</font></td>
888 </tr>
889 <tr>
890 <td style="text-align: center;">
891 <center><a name="display"></a> <font size="-1">display</font></center>
892 </td>
893 <td><font size="-1">void</font></td>
894 <td>
895 <font size="-1">Display image on screen.</font> <br />
896 <font size="-1">
897 <b><font color="#ff0000">Caution: </font></b> if
898 an image format is not compatible with the display visual (e.g.
899 JPEG on a colormapped display) then the original image will be
900 altered. Use a copy of the original if this is a problem.
901 </font>
902 </td>
903 </tr>
904 <tr>
905 <td>
906 <center><a name="distort"></a> <font size="-1">distort</font></center>
907 </td>
908 <td><font size="-1">const DistortImageMethod method, const size_t number_arguments, const double *arguments, const bool bestfit = false </font></td>
909 <td>
910 <font size="-1">
911 Distort image.&#160; Applies a user-specfied
912 distortion to the image.
913 </font>
914 </td>
915 </tr>
916 <tr>
917 <td style="text-align: center;" rowspan="2">
918 <center><a name="draw"></a> <font size="-1">draw</font></center>
919 </td>
920 <td>
921 <font size="-1">
922 const <a href="Drawable.html">Drawable</a>
923 &amp;drawable_
924 </font>
925 </td>
926 <td><font size="-1">Draw shape or text on image.</font></td>
927 </tr>
928 <tr>
929 <td>
930 <font size="-1">
931 const std::list&lt;<a href="Drawable.html">Drawable</a>
932 &gt; &amp;drawable_
933 </font>
934 </td>
935 <td>
936 <font size="-1">
937 Draw shapes or text on image using a set of
938 Drawable objects contained in an STL list. Use of this method improves
939 drawing performance and allows batching draw objects together in a
940 list for repeated use.
941 </font>
942 </td>
943 </tr>
944 <tr>
945 <td style="text-align: center;">
946 <center><a name="edge"></a> <font size="-1">edge</font></center>
947 </td>
948 <td><font size="-1">size_t radius_ = 0.0</font></td>
949 <td>
950 <font size="-1">
951 Edge image (hilight edges in image).&#160;
952 The radius is the radius of the pixel neighborhood.. Specify a radius
953 of zero for automatic radius selection.
954 </font>
955 </td>
956 </tr>
957 <tr>
958 <td style="text-align: center;">
959 <center><a name="emboss"></a> <font size="-1">emboss</font></center>
960 </td>
961 <td>
962 <font size="-1">
963 const double radius_ = 1, const double sigma_
964 = 0.5
965 </font>
966 </td>
967 <td>
968 <font size="-1">
969 Emboss image (hilight edges with 3D effect).
970 The <i> radius_</i> parameter specifies the radius of the Gaussian, in
971 pixels, not counting the center pixel.&#160; The <i>sigma_</i>
972 parameter specifies the standard deviation of the Laplacian, in pixels.
973 </font>
974 </td>
975 </tr>
976 <tr>
977 <td style="text-align: center;">
978 <center><a name="enhance"></a> <font size="-1">enhance</font></center>
979 </td>
980 <td><font size="-1">void</font></td>
981 <td><font size="-1">Enhance image (minimize noise)</font></td>
982 </tr>
983 <tr>
984 <td style="text-align: center;">
985 <center><a name="equalize"></a> <font size="-1">equalize</font></center>
986 </td>
987 <td><font size="-1">void</font></td>
988 <td><font size="-1">Equalize image (histogram equalization)</font></td>
989 </tr>
990 <tr>
991 <td style="text-align: center;">
992 <center><a name="erase"></a> <font size="-1">erase</font></center>
993 </td>
994 <td><font size="-1">void</font></td>
995 <td>
996 <font size="-1">
997 Set all image pixels to the current
998 background color.
999 </font>
1000 </td>
1001 </tr>
1002 <tr>
1003 <td style="text-align: center;" rowspan="4">
1004 <center><a name="extent"></a> <font size="-1">extent</font></center>
1005 </td>
1006 <td><font size="-1">const <a href="Geometry.html"> Geometry</a> &amp;geometry_</font></td>
1007 <td rowspan="2"><font size="-1">extends the image as defined by the geometry, gravity, and image background color.</font></td>
1008 </tr>
1009 <tr>
1010 <td>
1011 <font size="-1">
1012 const <a href="Geometry.html">Geometry</a>
1013 &amp;geometry_, const <a href="Color.html">Color</a> &amp;backgroundColor_
1014 </font>
1015 </td>
1016 </tr>
1017 <tr>
1018 <td>
1019 <font size="-1">
1020 const <a href="Geometry.html"> Geometry</a> &amp;geometry_, const <a href="https://imagemagick.org/Magick++/Enumerations.html#GravityType">GravityType</a>
1021 &amp;gravity_
1022 </font>
1023 </td>
1024 <td rowspan="2"><font size="-1">extends the image as defined by the geometry, gravity, and image background color.</font></td>
1025 </tr>
1026 <tr>
1027 <td>
1028 <font size="-1">
1029 const <a href="Geometry.html">Geometry</a>
1030 &amp;geometry_, const <a href="Color.html">Color</a> &amp;backgroundColor_,
1031 const <a href="https://imagemagick.org/Magick++/Enumerations.html#GravityType">GravityType</a> &amp;gravity_
1032 </font>
1033 </td>
1034 </tr>
1035 <tr>
1036 <td style="text-align: center;">
1037 <center><a name="flip"></a> <font size="-1">flip</font></center>
1038 </td>
1039 <td><font size="-1">void</font></td>
1040 <td>
1041 <font size="-1">
1042 Flip image (reflect each scanline in the
1043 vertical direction)
1044 </font>
1045 </td>
1046 </tr>
1047 <tr>
1048 <td style="text-align: center;" rowspan="4">
1049 <center>
1050 <a name="floodFillColor"></a> <font size="-1">floodFill-</font>
1051 <br />
1052 <font size="-1">Color</font>
1053 </center>
1054 </td>
1055 <td>
1056 <font size="-1">
1057 ssize_t x_, ssize_t y_, const <a href="Color.html">Color</a> &amp;fillColor_
1058 </font>
1059 </td>
1060 <td rowspan="2">
1061 <font size="-1">
1062 Flood-fill color across pixels
1063 that match the color of the target pixel and are neighbors of the
1064 target pixel. Uses current fuzz setting when determining color match.
1065 </font>
1066 </td>
1067 </tr>
1068 <tr>
1069 <td>
1070 <font size="-1">
1071 const <a href="Geometry.html">Geometry</a>
1072 &amp;point_, const <a href="Color.html">Color</a> &amp;fillColor_
1073 </font>
1074 </td>
1075 </tr>
1076 <tr>
1077 <td>
1078 <font size="-1">
1079 ssize_t x_, ssize_t y_, const <a href="Color.html">Color</a> &amp;fillColor_, const <a href="Color.html">Color</a>
1080 &amp;borderColor_
1081 </font>
1082 </td>
1083 <td rowspan="2">
1084 <font size="-1">
1085 Flood-fill color across pixels
1086 starting at target-pixel and stopping at pixels matching specified
1087 border color. Uses current fuzz setting when determining color match.
1088 </font>
1089 </td>
1090 </tr>
1091 <tr>
1092 <td>
1093 <font size="-1">
1094 const <a href="Geometry.html">Geometry</a>
1095 &amp;point_, const <a href="Color.html">Color</a> &amp;fillColor_,
1096 const <a href="Color.html">Color</a> &amp;borderColor_
1097 </font>
1098 </td>
1099 </tr>
1100 <tr>
1101 <td style="text-align: center;">
1102 <a name="floodFillOpacity"></a> <font size="-1">floodFillOpacity</font>
1103 </td>
1104 <td>
1105 <font size="-1">
1106 const long x_, const long y_, const unsigned int
1107 opacity_, const PaintMethod method_
1108 </font>
1109 </td>
1110 <td>
1111 <font size="-1">
1112 Floodfill pixels matching color (within fuzz
1113 factor) of target pixel(x,y) with replacement opacity value using
1114 method.
1115 </font>
1116 </td>
1117 </tr>
1118 <tr>
1119 <td style="text-align: center;" rowspan="4">
1120 <center>
1121 <a name="floodFillTexture"></a> <font size="-1">floodFill-</font>
1122 <br />
1123 <font size="-1">Texture</font>
1124 </center>
1125 </td>
1126 <td>
1127 <font size="-1">
1128 ssize_t x_, ssize_t y_,&#160; const
1129 Image &amp;texture_
1130 </font>
1131 </td>
1132 <td rowspan="2">
1133 <font size="-1">
1134 Flood-fill texture across pixels
1135 that match the color of the target pixel and are neighbors of the
1136 target pixel. Uses current fuzz setting when determining color match.
1137 </font>
1138 </td>
1139 </tr>
1140 <tr>
1141 <td>
1142 <font size="-1">
1143 const <a href="Geometry.html">Geometry</a>
1144 &amp;point_, const Image &amp;texture_
1145 </font>
1146 </td>
1147 </tr>
1148 <tr>
1149 <td>
1150 <font size="-1">
1151 ssize_t x_, ssize_t y_, const Image
1152 &amp;texture_, const <a href="Color.html">Color</a> &amp;borderColor_
1153 </font>
1154 </td>
1155 <td rowspan="2">
1156 <font size="-1">
1157 Flood-fill texture across pixels
1158 starting at target-pixel and stopping at pixels matching specified
1159 border color. Uses current fuzz setting when determining color match.
1160 </font>
1161 </td>
1162 </tr>
1163 <tr>
1164 <td>
1165 <font size="-1">
1166 const <a href="Geometry.html">Geometry</a>
1167 &amp;point_, const Image &amp;texture_, const <a href="Color.html">
1168 Color
1169 </a>
1170 &amp;borderColor_
1171 </font>
1172 </td>
1173 </tr>
1174 <tr>
1175 <td style="text-align: center;">
1176 <center><a name="flop"></a> <font size="-1">flop</font></center>
1177 </td>
1178 <td><font size="-1">void&#160;</font></td>
1179 <td>
1180 <font size="-1">
1181 Flop image (reflect each scanline in the
1182 horizontal direction)
1183 </font>
1184 </td>
1185 </tr>
1186 <tr>
1187 <td style="text-align: center;" rowspan="2">
1188 <center><a name="frame"></a> <font size="-1">frame</font></center>
1189 </td>
1190 <td>
1191 <font size="-1">
1192 const <a href="Geometry.html">Geometry</a>
1193 &amp;geometry_ = "25x25+6+6"
1194 </font>
1195 </td>
1196 <td rowspan="2"><font size="-1">Add decorative frame around image</font></td>
1197 </tr>
1198 <tr>
1199 <td>
1200 <font size="-1">
1201 size_t width_, size_t height_,
1202 ssize_t x_, ssize_t y_, ssize_t innerBevel_ = 0, ssize_t outerBevel_ = 0
1203 </font>
1204 </td>
1205 </tr>
1206 <tr>
1207 <td>
1208 <center><a name="fx"></a> <font size="-1">fx</font></center>
1209 </td>
1210 <td><font size="-1">const std::string expression, const Magick::ChannelType channel</font></td>
1211 <td>
1212 <font size="-1">
1213 Fx image.&#160; Applies a mathematical
1214 expression to the image.
1215 </font>
1216 </td>
1217 </tr>
1218 <tr>
1219 <td style="text-align: center;" rowspan="2">
1220 <center><a name="gamma"></a> <font size="-1">gamma</font></center>
1221 </td>
1222 <td><font size="-1">double gamma_</font></td>
1223 <td>
1224 <font size="-1">
1225 Gamma correct image (uniform red, green, and
1226 blue correction).
1227 </font>
1228 </td>
1229 </tr>
1230 <tr>
1231 <td>
1232 <font size="-1">
1233 double gammaRed_, double gammaGreen_, double
1234 gammaBlue_
1235 </font>
1236 </td>
1237 <td>
1238 <font size="-1">
1239 Gamma correct red, green, and blue channels
1240 of image.
1241 </font>
1242 </td>
1243 </tr>
1244 <tr>
1245 <td style="text-align: center;">
1246 <center><a name="gaussianBlur"></a> <font size="-1">gaussianBlur</font></center>
1247 </td>
1248 <td><font size="-1">const double width_, const double sigma_</font></td>
1249 <td>
1250 <font size="-1">
1251 Gaussian blur image. The number of neighbor
1252 pixels to be included in the convolution mask is specified by
1253 'width_'.&#160; For example, a width of one gives a (standard) 3x3
1254 convolution mask. The standard deviation of the gaussian bell curve is
1255 specified by 'sigma_'.
1256 </font>
1257 </td>
1258 </tr>
1259 <tr>
1260 <td style="vertical-align: middle; text-align: center;">
1261 <small>
1262 <a name="gaussianBlurChannel"></a>gaussianBlurChannel<br />
1263 </small>
1264 </td>
1265 <td style="vertical-align: middle;">
1266 <small>
1267 const ChannelType
1268 channel_, const double radius_ = 0.0, const double sigma_ = 1.0<br />
1269 </small>
1270 </td>
1271 <td style="vertical-align: middle;">
1272 <font size="-1">
1273 Gaussian blur
1274 an image channel.
1275 </font><font size="-1">
1276 The <span style="font-style: italic;">channel_</span> parameter specifies the
1277 channel to blur.
1278 </font><font size="-1">
1279 The number of neighbor
1280 pixels to be included in the convolution mask is specified by
1281 'width_'.&#160; For example, a width of one gives a (standard) 3x3
1282 convolution mask. The standard deviation of the gaussian bell curve is
1283 specified by 'sigma_'.
1284 </font>
1285 </td>
1286 </tr>
1287 <tr>
1288 <td style="text-align: center;" valign="middle">
1289 <font size="-1">
1290 <a name="haldClut"></a> haldClut<br />
1291 </font>
1292 </td>
1293 <td valign="middle">
1294 <font size="-1">
1295 const Image &amp;reference_<br />
1296 </font>
1297 </td>
1298 <td valign="top">
1299 <font size="-1">apply a Hald color lookup table to the image.</font><br />
1300 </td>
1301 </tr>
1302 <tr>
1303 <td style="text-align: center;">
1304 <center><a name="implode"></a> <font size="-1">implode</font></center>
1305 </td>
1306 <td><font size="-1">const double factor_</font></td>
1307 <td><font size="-1">Implode image (special effect)</font></td>
1308 </tr>
1309 <tr>
1310 <td style="text-align: center;">
1311 <center><a name="inverseFourierTransform"></a> <font size="-1">inverseFourierTransform</font></center>
1312 </td>
1313 <td><font size="-1">const Image &amp;phaseImage_, const bool magnitude_</font></td>
1314 <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>
1315 </tr>
1316 <tr>
1317 <td style="text-align: center;">
1318 <center><a name="label"></a> <font size="-1">label</font></center>
1319 </td>
1320 <td><font size="-1">const string &amp;label_</font></td>
1321 <td>
1322 <font size="-1">
1323 Assign a label to an image. Use this option
1324 to&#160; assign&#160; a&#160; specific label to the image. Optionally
1325 you can include the image filename, type, width, height, or scene
1326 number in the label by embedding&#160; <a href="https://imagemagick.org/Magick++/FormatCharacters.html">
1327 special format characters.
1328 </a> If the first character of string is @,
1329 the
1330 image label is read from a file titled by the remaining characters in
1331 the string. When converting to Postscript, use this&#160; option to
1332 specify a header string to print above the image.
1333 </font>
1334 </td>
1335 </tr>
1336 <tr>
1337 <td style="vertical-align: top; text-align: center;">
1338 <small>
1339 <a name="level"></a>level<br />
1340 </small>
1341 </td>
1342 <td style="vertical-align: top;">
1343 <small>
1344 const double black_point,
1345 const double white_point, const double mid_point=1.0<br />
1346 </small>
1347 </td>
1348 <td style="vertical-align: top;">
1349 <small>
1350 Level image. Adjust the
1351 levels of the image by scaling the colors falling between specified
1352 white and black points to the full available quantum range. The
1353 parameters provided represent the black, mid (gamma), and white
1354 points.&#160; The black point specifies the darkest color in the image.
1355 Colors darker than the black point are set to zero. Mid point (gamma)
1356 specifies a gamma correction to apply to the image. White point
1357 specifies the lightest color in the image.&#160; Colors brighter than
1358 the white point are set to the maximum quantum value. The black and
1359 white point have the valid range 0 to MaxRGB while mid (gamma) has a
1360 useful range of 0 to ten.<br />
1361 </small>
1362 </td>
1363 </tr>
1364 <tr>
1365 <td style="vertical-align: middle; text-align: center;">
1366 <small>
1367 <a name="levelChannel"></a>levelChannel<br />
1368 </small>
1369 </td>
1370 <td style="vertical-align: middle;">
1371 <small>
1372 const ChannelType
1373 channel, const double black_point, const double white_point, const
1374 double mid_point=1.0<br />
1375 </small>
1376 </td>
1377 <td style="vertical-align: middle;">
1378 <small>
1379 Level image channel.
1380 Adjust the levels of the image channel by scaling the values falling
1381 between specified white and black points to the full available quantum
1382 range. The parameters provided represent the black, mid (gamma), and
1383 white points. The black point specifies the darkest color in the image.
1384 Colors darker than the black point are set to zero. Mid point (gamma)
1385 specifies a gamma correction to apply to the image. White point
1386 specifies the lightest color in the image. Colors brighter than the
1387 white point are set to the maximum quantum value. The black and white
1388 point have the valid range 0 to MaxRGB while mid (gamma) has a useful
1389 range of 0 to ten.<br />
1390 </small>
1391 </td>
1392 </tr>
1393 <tr>
1394 <td style="text-align: center;">
1395 <center><a name="magnify"></a> <font size="-1">magnify</font></center>
1396 </td>
1397 <td><font size="-1">void</font></td>
1398 <td><font size="-1">Magnify image by integral size</font></td>
1399 </tr>
1400 <tr>
1401 <td style="text-align: center;">
1402 <center><a name="map"></a> <font size="-1">map</font></center>
1403 </td>
1404 <td>
1405 <font size="-1">
1406 const Image &amp;mapImage_ , bool dither_ =
1407 false
1408 </font>
1409 </td>
1410 <td>
1411 <font size="-1">
1412 Remap image colors with closest color from
1413 reference image. Set dither_ to <i>true</i> in to apply
1414 Floyd/Steinberg
1415 error diffusion to the image. By default, color reduction chooses an
1416 optimal&#160; set&#160; of colors that best represent the original
1417 image. Alternatively, you can&#160; choose&#160; a&#160;
1418 particular&#160; set&#160; of colors&#160; from&#160; an image file
1419 with this option.
1420 </font>
1421 </td>
1422 </tr>
1423 <tr>
1424 <td style="text-align: center;">
1425 <center><a name="floodFillAlpha"></a> <font size="-1">floodFillAlpha</font></center>
1426 </td>
1427 <td>
1428 <font size="-1">
1429 const ssize_t x_, const ssize_t, const unsigned int&#160; alpha_, const <a href="Color.html">Color</a> &amp;target_, const bool invert_
1430 </font>
1431 </td>
1432 <td>
1433 <font size="-1">
1434 Floodfill designated area with a replacement alpha value.
1435 </font>
1436 </td>
1437 </tr>
1438 <tr>
1439 <td style="text-align: center;">
1440 <a name="medianFilter"></a> <font size="-1">medianFilter</font>
1441 </td>
1442 <td><font size="-1">const double radius_ = 0.0</font></td>
1443 <td>
1444 <font size="-1">
1445 Filter image by replacing each pixel
1446 component with the median color in a circular neighborhood
1447 </font>
1448 </td>
1449 </tr>
1450 <tr>
1451 <td style="text-align: center;">
1452 <center><a name="mergeLayers"></a> <font size="-1">mergeLayers</font></center>
1453 </td>
1454 <td>
1455 <font size="-1">
1456 <a href="https://imagemagick.org/Magick++/Enumerations.html#LayerMethod">LayerMethod</a>
1457 noiseType_
1458 </font>
1459 </td>
1460 <td><font size="-1">handle multiple images forming a set of image layers or animation frames.</font></td>
1461 </tr>
1462 <tr>
1463 <td style="text-align: center;">
1464 <center><a name="minify"></a> <font size="-1">minify</font></center>
1465 </td>
1466 <td><font size="-1">void</font></td>
1467 <td><font size="-1">Reduce image by integral size</font></td>
1468 </tr>
1469 <tr>
1470 <td style="text-align: center;">
1471 <a name="modifyImage"></a> <font size="-1">modifyImage</font>
1472 </td>
1473 <td><font size="-1">void</font></td>
1474 <td>
1475 <font size="-1">
1476 Prepare to update image. Ensures that there
1477 is only one reference to the underlying image so that the underlying
1478 image may be safely modified without effecting previous generations of
1479 the image. Copies the underlying image to a new image if necessary.
1480 </font>
1481 </td>
1482 </tr>
1483 <tr>
1484 <td style="text-align: center;">
1485 <center><a name="modulate"></a> <font size="-1">modulate</font></center>
1486 </td>
1487 <td>
1488 <font size="-1">
1489 double brightness_, double saturation_,
1490 double hue_
1491 </font>
1492 </td>
1493 <td>
1494 <font size="-1">
1495 Modulate percent hue, saturation, and
1496 brightness of an image. Modulation of saturation and brightness is as a
1497 ratio of the current value (1.0 for no change). Modulation of hue is an
1498 absolute rotation of -180 degrees to +180 degrees from the current
1499 position corresponding to an argument range of 0 to 2.0 (1.0 for no
1500 change).
1501 </font>
1502 </td>
1503 </tr>
1504 <tr>
1505 <td style="vertical-align: middle; text-align: center;">
1506 <small>
1507 <a name="motionBlur"></a>motionBlur<br />
1508 </small>
1509 </td>
1510 <td style="vertical-align: middle;">
1511 <small>
1512 const double radius_,
1513 const double sigma_, const double angle_<br />
1514 </small>
1515 </td>
1516 <td style="vertical-align: middle;">
1517 <small>
1518 Motion blur image with
1519 specified blur factor. The radius_ parameter specifies the radius of
1520 the Gaussian, in pixels, not counting the center pixel.&#160; The
1521 sigma_ parameter specifies the standard deviation of the Laplacian, in
1522 pixels. The angle_ parameter specifies the angle the object appears to
1523 be comming from (zero degrees is from the right).<br />
1524 </small>
1525 </td>
1526 </tr>
1527 <tr>
1528 <td style="text-align: center;">
1529 <center><a name="negate"></a> <font size="-1">negate</font></center>
1530 </td>
1531 <td><font size="-1">bool grayscale_ = false</font></td>
1532 <td>
1533 <font size="-1">
1534 Negate colors in image.&#160; Replace every
1535 pixel with its complementary color (white becomes black, yellow becomes
1536 blue, etc.).&#160; Set grayscale to only negate grayscale values in
1537 image.
1538 </font>
1539 </td>
1540 </tr>
1541 <tr>
1542 <td style="text-align: center;">
1543 <center><a name="normalize"></a> <font size="-1">normalize</font></center>
1544 </td>
1545 <td><font size="-1">void</font></td>
1546 <td>
1547 <font size="-1">
1548 Normalize image (increase contrast by
1549 normalizing the pixel values to span the full range of color values).
1550 </font>
1551 </td>
1552 </tr>
1553 <tr>
1554 <td style="text-align: center;">
1555 <center><a name="oilPaint"></a> <font size="-1">oilPaint</font></center>
1556 </td>
1557 <td><font size="-1">size_t radius_ = 3</font></td>
1558 <td><font size="-1">Oilpaint image (image looks like oil painting)</font></td>
1559 </tr>
1560 <tr>
1561 <td style="text-align: center;">
1562 <center><a name="opacity"></a> <font size="-1">opacity</font></center>
1563 </td>
1564 <td><font size="-1">unsigned int opacity_</font></td>
1565 <td>
1566 <font size="-1">
1567 Set or attenuate the opacity channel in the
1568 image. If the image pixels are opaque then they are set to the
1569 specified
1570 opacity value, otherwise they are blended with the supplied opacity
1571 value.&#160; The value of opacity_ ranges from 0 (completely opaque) to
1572 <i>MaxRGB</i>
1573 . The defines <i>OpaqueOpacity</i> and <i>TransparentOpacity</i> are
1574 available to specify completely opaque or completely transparent,
1575 respectively.
1576 </font>
1577 </td>
1578 </tr>
1579 <tr>
1580 <td style="text-align: center;">
1581 <center><a name="opaque"></a> <font size="-1">opaque</font></center>
1582 </td>
1583 <td>
1584 <font size="-1">
1585 const <a href="Color.html">Color</a>
1586 &amp;opaqueColor_, const <a href="Color.html">Color</a> &amp;penColor_
1587 </font>
1588 </td>
1589 <td>
1590 <font size="-1">
1591 Change color of pixels matching opaqueColor_
1592 to specified penColor_.
1593 </font>
1594 </td>
1595 </tr>
1596 <tr>
1597 <td style="text-align: center;" rowspan="2">
1598 <center><a name="ping"></a> <font size="-1">ping</font></center>
1599 </td>
1600 <td><font size="-1">const std::string &amp;imageSpec_</font></td>
1601 <td rowspan="2">
1602 <font size="-1">
1603 Ping is similar to read
1604 except only enough of the image is read to determine the image columns,
1605 rows, and filesize.&#160; The <a href="Image++.html#columns">columns</a>
1606 </font>,
1607 <font size="-1">
1608 <a href="Image++.html#rows">rows</a> , and <a href="Image++.html#fileSize">fileSize</a>
1609 attributes are valid after invoking ping.&#160; The image data is not
1610 valid after calling ping.
1611 </font>
1612 </td>
1613 </tr>
1614 <tr>
1615 <td><font size="-1">const Blob &amp;blob_</font></td>
1616 </tr>
1617 <tr>
1618 <td style="vertical-align: middle; text-align: center;">
1619 <small>
1620 <a name="process"></a>process<br />
1621 </small>
1622 </td>
1623 <td style="vertical-align: middle;">
1624 <small>
1625 std::string name_,
1626 const ssize_t argc_, char **argv_<br />
1627 </small>
1628 </td>
1629 <td style="vertical-align: middle;">
1630 <small>
1631 Execute the named
1632 process module, passing any arguments via an argument vector, with
1633 argc_
1634 specifying the number of arguments in the vector, and argv_ passing the
1635 address of an array of null-terminated C strings which constitute the
1636 argument vector. An exception is thrown if the requested process module
1637 does not exist, fails to load, or fails during execution.
1638 </small><br />
1639 </td>
1640 </tr>
1641 <tr>
1642 <td style="text-align: center;">
1643 <center><a name="quantize"></a> <font size="-1">quantize</font></center>
1644 </td>
1645 <td><font size="-1">bool measureError_ = false</font></td>
1646 <td>
1647 <font size="-1">
1648 Quantize image (reduce number of colors). Set
1649 measureError_ to true in order to calculate error attributes.
1650 </font>
1651 </td>
1652 </tr>
1653 <tr>
1654 <td style="text-align: center;">
1655 <center><a name="raise"></a> <font size="-1">raise</font></center>
1656 </td>
1657 <td>
1658 <font size="-1">
1659 const <a href="Geometry.html">Geometry</a>
1660 &amp;geometry_ = "6x6+0+0",&#160; bool raisedFlag_ =&#160; false
1661 </font>
1662 </td>
1663 <td>
1664 <font size="-1">
1665 Raise image (lighten or darken the edges of
1666 an image to give a 3-D raised or lowered effect)
1667 </font>
1668 </td>
1669 </tr>
1670 <tr>
1671 <td style="text-align: center;" rowspan="8">
1672 <center><a name="read"></a> <font size="-1">read</font></center>
1673 </td>
1674 <td><font size="-1">const string &amp;imageSpec_</font></td>
1675 <td><font size="-1">Read image into current object</font></td>
1676 </tr>
1677 <tr>
1678 <td>
1679 <font size="-1">
1680 const <a href="Geometry.html">Geometry</a>
1681 &amp;size_, const std::string &amp;imageSpec_
1682 </font>
1683 </td>
1684 <td>
1685 <font size="-1">
1686 Read image of specified size into current
1687 object. This form is useful for images that do not specifiy their size
1688 or to specify a size hint for decoding an image. For example, when
1689 reading a Photo CD, JBIG, or JPEG image, a size request causes the
1690 library to return an image which is the next resolution greater or
1691 equal to the specified size. This may result in memory and time savings.
1692 </font>
1693 </td>
1694 </tr>
1695 <tr>
1696 <td><font size="-1">const <a href="Blob.html">Blob</a> &amp;blob_</font></td>
1697 <td rowspan="5">
1698 <font size="-1">
1699 Read encoded image of specified
1700 size from an in-memory <a href="Blob.html">BLOB</a> into current
1701 object. Depending on the method arguments, the Blob size, depth, and
1702 format may also be specified. Some image formats require that size be
1703 specified. The default ImageMagick uses for depth depends on its
1704 Quantum size (8 or 16).&#160; If ImageMagick's Quantum size does not
1705 match that of the image, the depth may need to be specified.
1706 ImageMagick can usually automagically detect the image's format.
1707 When
1708 a format can't be automagically detected, the format must be specified.
1709 </font>
1710 </td>
1711 </tr>
1712 <tr>
1713 <td>
1714 <font size="-1">
1715 const <a href="Blob.html">Blob</a>
1716 &amp;blob_, const <a href="Geometry.html">Geometry</a> &amp;size_
1717 </font>
1718 </td>
1719 </tr>
1720 <tr>
1721 <td>
1722 <font size="-1">
1723 const <a href="Blob.html">Blob</a>
1724 &amp;blob_, const <a href="Geometry.html">Geometry</a> &amp;size_,
1725 size_t depth_
1726 </font>
1727 </td>
1728 </tr>
1729 <tr>
1730 <td>
1731 <font size="-1">
1732 const <a href="Blob.html">Blob</a>
1733 &amp;blob_, const <a href="Geometry.html">Geometry</a> &amp;size_,
1734 size_t depth_, const string &amp;magick_&#160;
1735 </font>
1736 </td>
1737 </tr>
1738 <tr>
1739 <td>
1740 <font size="-1">
1741 const <a href="Blob.html">Blob</a>
1742 &amp;blob_, const <a href="Geometry.html">Geometry</a> &amp;size_,
1743 const
1744 string &amp;magick_
1745 </font>
1746 </td>
1747 </tr>
1748 <tr>
1749 <td>
1750 <font size="-1">
1751 const size_t width_, const size_t
1752 height_, std::string map_, const StorageType type_, const void *pixels_
1753 </font>
1754 </td>
1755 <td>
1756 <font size="-1">
1757 Read image based on an array of image pixels.
1758 The pixel data must be in scanline order top-to-bottom. The data can be
1759 character, short int, integer, float, or double. Float and double
1760 require the pixels to be normalized [0..1]. The other types are
1761 [0..MaxRGB].&#160; For example, to create a 640x480 image from
1762 unsigned red-green-blue character data, use
1763 </font>
1764 <p>
1765 <font size="-1">
1766 &#160; image.read( 640, 480, "RGB", CharPixel,
1767 pixels );
1768 </font>
1769 </p>
1770 <p>
1771 <font size="-1">The parameters are as follows:</font> <br />
1772 &#160;
1773 </p>
1774 <table border="0" width="100%">
1775 <tbody>
1776 <tr>
1777 <td><font size="-1">width_</font></td>
1778 <td><font size="-1">Width in pixels of the image.</font></td>
1779 </tr>
1780 <tr>
1781 <td><font size="-1">height_</font></td>
1782 <td><font size="-1">Height in pixels of the image.</font></td>
1783 </tr>
1784 <tr>
1785 <td><font size="-1">map_</font></td>
1786 <td>
1787 <font size="-1">
1788 This character string can be any
1789 combination or order of R = red, G = green, B = blue, A = alpha, C =
1790 cyan, Y = yellow M = magenta, and K = black. The ordering reflects the
1791 order of the pixels in the supplied pixel array.
1792 </font>
1793 </td>
1794 </tr>
1795 <tr>
1796 <td><font size="-1">type_</font></td>
1797 <td>
1798 <font size="-1">
1799 Pixel storage type (CharPixel,
1800 ShortPixel, IntegerPixel, FloatPixel, or DoublePixel)
1801 </font>
1802 </td>
1803 </tr>
1804 <tr>
1805 <td><font size="-1">pixels_</font></td>
1806 <td>
1807 <font size="-1">
1808 This array of values contain the pixel
1809 components as defined by the map_ and type_ parameters. The length of
1810 the arrays must equal the area specified by the width_ and height_
1811 values and type_ parameters.
1812 </font>
1813 </td>
1814 </tr>
1815 </tbody>
1816 </table>
1817 </td>
1818 </tr>
1819 <tr>
1820 <td style="text-align: center;">
1821 <center><a name="reduceNoise"></a> <font size="-1">reduceNoise</font></center>
1822 </td>
1823 <td><font size="-1">const double order_</font></td>
1824 <td><font size="-1">reduce noise in image using a noise peak elimination filter.</font></td>
1825 </tr>
1826 <tr>
1827 <td style="vertical-align: middle; text-align: center;">
1828 <small>
1829 <a name="randomThreshold"></a>randomThreshold<br />
1830 </small>
1831 </td>
1832 <td style="vertical-align: middle;">
1833 <small>
1834 const Geometry
1835 &amp;thresholds_<br />
1836 </small>
1837 </td>
1838 <td style="vertical-align: middle;">
1839 <small>
1840 Random threshold the
1841 image. Changes the value of individual pixels based on the intensity of
1842 each pixel compared to a random threshold. The result is a
1843 low-contrast, two color image. The thresholds_ argument is a
1844 geometry containing LOWxHIGH thresholds. If the string contains
1845 2x2, 3x3, or 4x4, then an ordered dither of order 2, 3, or 4 will be
1846 performed instead. This is a very fast alternative to 'quantize' based
1847 dithering.<br />
1848 </small>
1849 </td>
1850 </tr>
1851 <tr>
1852 <td style="vertical-align: middle; text-align: center;">
1853 <small>
1854 <a name="randomThresholdChannel"></a>randomThresholdChannel<br />
1855 </small>
1856 </td>
1857 <td style="vertical-align: middle;">
1858 <small>
1859 const Geometry
1860 &amp;thresholds_, const ChannelType channel_<br />
1861 </small>
1862 </td>
1863 <td style="vertical-align: middle;">
1864 <small>
1865 Random threshold an
1866 image channel. Similar to <a href="Image++.html#randomThreshold">randomThreshold</a>()
1867 but restricted to the specified channel.<br />
1868 </small>
1869 </td>
1870 </tr>
1871 <tr>
1872 <td style="text-align: center;">
1873 <center><a name="roll"></a> <font size="-1">roll</font></center>
1874 </td>
1875 <td><font size="-1">int columns_, ssize_t rows_</font></td>
1876 <td>
1877 <font size="-1">
1878 Roll image (rolls image vertically and
1879 horizontally) by specified number of columnms and rows)
1880 </font>
1881 </td>
1882 </tr>
1883 <tr>
1884 <td style="text-align: center;">
1885 <center><a name="rotate"></a> <font size="-1">rotate</font></center>
1886 </td>
1887 <td><font size="-1">double degrees_</font></td>
1888 <td>
1889 <font size="-1">
1890 Rotate image counter-clockwise by specified
1891 number of degrees.
1892 </font>
1893 </td>
1894 </tr>
1895 <tr>
1896 <td style="text-align: center;">
1897 <center><a name="sample"></a> <font size="-1">sample</font></center>
1898 </td>
1899 <td>
1900 <font size="-1">
1901 const <a href="Geometry.html">Geometry</a>
1902 &amp;geometry_&#160;
1903 </font>
1904 </td>
1905 <td><font size="-1">Resize image by using pixel sampling algorithm</font></td>
1906 </tr>
1907 <tr>
1908 <td style="text-align: center;">
1909 <center><a name="scale"></a> <font size="-1">scale</font></center>
1910 </td>
1911 <td>
1912 <font size="-1">
1913 const <a href="Geometry.html">Geometry</a>
1914 &amp;geometry_
1915 </font>
1916 </td>
1917 <td><font size="-1">Resize image by using simple ratio algorithm</font></td>
1918 </tr>
1919 <tr>
1920 <td style="text-align: center;">
1921 <center><a name="segment"></a> <font size="-1">segment</font></center>
1922 </td>
1923 <td>
1924 <font size="-1">double clusterThreshold_ = 1.0,</font> <br />
1925 <font size="-1">double smoothingThreshold_ = 1.5</font>
1926 </td>
1927 <td>
1928 <font size="-1">
1929 Segment (coalesce similar image components)
1930 by analyzing the histograms of the color components and identifying
1931 units that are homogeneous with the fuzzy c-means technique. Also uses <i>quantizeColorSpace</i>
1932 and <i>verbose</i> image attributes. Specify <i> clusterThreshold_</i>
1933 ,
1934 as the number&#160; of&#160; pixels&#160; each cluster&#160; must
1935 exceed
1936 the cluster threshold to be considered valid. <i>SmoothingThreshold_</i>
1937 eliminates noise in the&#160; second derivative of the histogram. As
1938 the
1939 value is&#160; increased, you can&#160; expect&#160; a&#160; smoother
1940 second derivative.&#160; The default is 1.5.
1941 </font>
1942 </td>
1943 </tr>
1944 <tr>
1945 <td style="text-align: center;">
1946 <center><a name="shade"></a> <font size="-1">shade</font></center>
1947 </td>
1948 <td>
1949 <font size="-1">double azimuth_ = 30, double elevation_ = 30,</font>
1950 <br />
1951 <font size="-1">bool colorShading_ = false</font>
1952 </td>
1953 <td>
1954 <font size="-1">
1955 Shade image using distant light source.
1956 Specify <i> azimuth_</i> and <i>elevation_</i> as the&#160;
1957 position&#160; of&#160; the light source. By default, the shading
1958 results as a grayscale image.. Set c<i>olorShading_</i> to <i>true</i>
1959 to
1960 shade the red, green, and blue components of the image.
1961 </font>
1962 </td>
1963 </tr>
1964 <tr>
1965 <td style="text-align: center;">
1966 <center><a name="shadow"></a> <font size="-1">shadow</font></center>
1967 </td>
1968 <td>
1969 <font size="-1">
1970 const double percent_opacity = 80, const double sigma_
1971 = 0.5, const ssize_t x_ = 0, const ssize_t y_ = 0
1972 </font>
1973 </td>
1974 <td><font size="-1">simulate an image shadow</font></td>
1975 </tr>
1976 <tr>
1977 <td style="text-align: center;">
1978 <center><a name="sharpen"></a> <font size="-1">sharpen</font></center>
1979 </td>
1980 <td>
1981 <font size="-1">
1982 const double radius_ = 1, const double sigma_
1983 = 0.5
1984 </font>
1985 </td>
1986 <td>
1987 <font size="-1">
1988 Sharpen pixels in image.&#160; The <i>radius_</i>
1989 parameter specifies the radius of the Gaussian, in pixels, not counting
1990 the center pixel.&#160; The <i>sigma_</i> parameter specifies the
1991 standard deviation of the Laplacian, in pixels.
1992 </font>
1993 </td>
1994 </tr>
1995 <tr>
1996 <td style="vertical-align: middle; text-align: center;">
1997 <small>
1998 <a name="sharpenChannel"></a>sharpenChannel<br />
1999 </small>
2000 </td>
2001 <td style="vertical-align: middle;">
2002 <small>
2003 const ChannelType
2004 channel_, const double radius_ = 0.0, const double sigma_ = 1.0<br />
2005 </small>
2006 </td>
2007 <td style="vertical-align: middle;">
2008 <font size="-1">
2009 Sharpen pixel
2010 quantums in an image channel&#160; The <span style="font-style: italic;">channel_</span> parameter specifies the
2011 channel to sharpen..&#160; The <i>radius_</i>
2012 parameter specifies the radius of the Gaussian, in pixels, not counting
2013 the center pixel.&#160; The <i>sigma_</i> parameter specifies the
2014 standard deviation of the Laplacian, in pixels.
2015 </font>
2016 </td>
2017 </tr>
2018 <tr>
2019 <td style="text-align: center;">
2020 <center><a name="shave"></a> <font size="-1">shave</font></center>
2021 </td>
2022 <td><font size="-1">const Geometry &amp;geometry_</font></td>
2023 <td><font size="-1">Shave pixels from image edges.</font></td>
2024 </tr>
2025 <tr>
2026 <td style="text-align: center;">
2027 <center><a name="shear"></a> <font size="-1">shear</font></center>
2028 </td>
2029 <td><font size="-1">double xShearAngle_, double yShearAngle_</font></td>
2030 <td>
2031 <font size="-1">
2032 Shear image (create parallelogram by sliding
2033 image by X or Y axis).&#160; Shearing slides one edge of an image along
2034 the X&#160; or&#160; Y axis,&#160; creating&#160; a
2035 parallelogram.&#160; An X direction shear slides an edge along the X
2036 axis, while&#160; a&#160; Y&#160; direction shear&#160; slides&#160;
2037 an edge along the Y axis.&#160; The amount of the shear is controlled
2038 by a shear angle.&#160; For X direction&#160; shears,&#160; x&#160;
2039 degrees is measured relative to the Y axis, and similarly, for Y
2040 direction shears&#160; y&#160; degrees is measured relative to the X
2041 axis. Empty triangles left over from shearing the&#160; image&#160; are
2042 filled&#160; with&#160; the&#160; color&#160; defined as <i>borderColor</i>.&#160;
2043 </font>
2044 </td>
2045 </tr>
2046 <tr>
2047 <td style="text-align: center;">
2048 <center><a name="solarize"></a> <font size="-1">solarize</font></center>
2049 </td>
2050 <td><font size="-1">double factor_ = 50.0</font></td>
2051 <td>
2052 <font size="-1">
2053 Solarize image (similar to effect seen when
2054 exposing a photographic film to light during the development process)
2055 </font>
2056 </td>
2057 </tr>
2058 <tr>
2059 <td style="text-align: center;">
2060 <center><a name="splice"></a> <font size="-1">splice</font></center>
2061 </td>
2062 <td>
2063 <font size="-1">
2064 const <a href="Geometry.html">Geometry</a>
2065 &amp;geometry_
2066 </font>
2067 </td>
2068 <td><font size="-1">splice the background color into the image</font></td>
2069 </tr>
2070 <tr>
2071 <td style="text-align: center;">
2072 <center><a name="spread"></a> <font size="-1">spread</font></center>
2073 </td>
2074 <td><font size="-1">size_t amount_ = 3</font></td>
2075 <td>
2076 <font size="-1">
2077 Spread pixels randomly within image by
2078 specified amount
2079 </font>
2080 </td>
2081 </tr>
2082 <tr>
2083 <td style="text-align: center;">
2084 <center><a name="stegano"></a> <font size="-1">stegano</font></center>
2085 </td>
2086 <td><font size="-1">const Image &amp;watermark_</font></td>
2087 <td>
2088 <font size="-1">
2089 Add a digital watermark to the image (based
2090 on second image)
2091 </font>
2092 </td>
2093 </tr>
2094 <tr>
2095 <td>
2096 <center><a name="sparseColor"></a> <font size="-1">sparseColor</font></center>
2097 </td>
2098 <td><font size="-1">const ChannelType channel, const SparseColorMethod method, const size_t number_arguments, const double *arguments </font></td>
2099 <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>
2100 </tr>
2101 <tr>
2102 <td style="text-align: center;">
2103 <center><a name="statistics"></a> <font size="-1">statistics</font></center>
2104 </td>
2105 <td><font size="-1">ImageStatistics *statistics</font></td>
2106 <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>
2107 </tr>
2108 <tr>
2109 <td style="text-align: center;">
2110 <center><a name="stereo"></a> <font size="-1">stereo</font></center>
2111 </td>
2112 <td><font size="-1">const Image &amp;rightImage_</font></td>
2113 <td>
2114 <font size="-1">
2115 Create an image which appears in stereo when
2116 viewed with red-blue glasses (Red image on left, blue on right)
2117 </font>
2118 </td>
2119 </tr>
2120 <tr>
2121 <td style="text-align: center;">
2122 <center><a name="swirl"></a> <font size="-1">swirl</font></center>
2123 </td>
2124 <td><font size="-1">double degrees_</font></td>
2125 <td>
2126 <font size="-1">
2127 Swirl image (image pixels are rotated by
2128 degrees)
2129 </font>
2130 </td>
2131 </tr>
2132 <tr>
2133 <td style="text-align: center;">
2134 <center><a name="texture"></a> <font size="-1">texture</font></center>
2135 </td>
2136 <td><font size="-1">const Image &amp;texture_</font></td>
2137 <td>
2138 <font size="-1">
2139 Layer a texture on pixels matching image
2140 background color.
2141 </font>
2142 </td>
2143 </tr>
2144 <tr>
2145 <td style="text-align: center;">
2146 <center><a name="threshold"></a> <font size="-1">threshold</font></center>
2147 </td>
2148 <td><font size="-1">double threshold_</font></td>
2149 <td><font size="-1">Threshold image</font></td>
2150 </tr>
2151 <tr>
2152 <td style="text-align: center;" rowspan="2">
2153 <center><a name="transform"></a> <font size="-1">transform</font></center>
2154 </td>
2155 <td>
2156 <font size="-1">
2157 const <a href="Geometry.html">Geometry</a>
2158 &amp;imageGeometry_
2159 </font>
2160 </td>
2161 <td rowspan="2">
2162 <font size="-1">
2163 Transform image based on image
2164 and crop geometries. Crop geometry is optional.
2165 </font>
2166 </td>
2167 </tr>
2168 <tr>
2169 <td>
2170 <font size="-1">
2171 const <a href="Geometry.html">Geometry</a>
2172 &amp;imageGeometry_, const <a href="Geometry.html">Geometry</a>
2173 &amp;cropGeometry_&#160;
2174 </font>
2175 </td>
2176 </tr>
2177 <tr>
2178 <td style="text-align: center;">
2179 <center><a name="transparent"></a> <font size="-1">transparent</font></center>
2180 </td>
2181 <td>
2182 <font size="-1">
2183 const <a href="Color.html">Color</a>
2184 &amp;color_
2185 </font>
2186 </td>
2187 <td>
2188 <font size="-1">
2189 Add alpha image to image, setting pixels
2190 matching color to transparent.
2191 </font>
2192 </td>
2193 </tr>
2194 <tr>
2195 <td style="text-align: center;">
2196 <center><a name="trim"></a> <font size="-1">trim</font></center>
2197 </td>
2198 <td><font size="-1">void</font></td>
2199 <td>
2200 <font size="-1">
2201 Trim edges that are the background color from
2202 the image.
2203 </font>
2204 </td>
2205 </tr>
2206 <tr>
2207 <td style="text-align: center;">
2208 <center><a name="unsharpmask"></a> <font size="-1">unsharpmask</font></center>
2209 </td>
2210 <td>
2211 <font size="-1">
2212 double radius_, double sigma_, double
2213 amount_, double threshold_
2214 </font>
2215 </td>
2216 <td>
2217 <font size="-1">
2218 Sharpen the image using the unsharp mask
2219 algorithm. The <i>radius</i>_
2220 parameter specifies the radius of the Gaussian, in pixels, not
2221 counting the center pixel. The <i>sigma</i>_ parameter specifies the
2222 standard deviation of the Gaussian, in pixels. The <i>amount</i>_
2223 parameter specifies the percentage of the difference between the
2224 original and the blur image that is added back into the original. The <i>threshold</i>_
2225 parameter specifies the threshold in pixels needed to apply the
2226 diffence amount.
2227 </font>
2228 </td>
2229 </tr>
2230 <tr>
2231 <td style="vertical-align: middle; text-align: center;">
2232 <small>
2233 <a name="unsharpmaskChannel"></a>unsharpmaskChannel<br />
2234 </small>
2235 </td>
2236 <td style="vertical-align: middle;">
2237 <small>
2238 const ChannelType
2239 channel_, const double radius_, const double sigma_, const double
2240 amount_, const double threshold_<br />
2241 </small>
2242 </td>
2243 <td style="vertical-align: middle;">
2244 <small>
2245 Sharpen an image
2246 channel using the unsharp mask algorithm. The <span style="font-style: italic;">channel_</span> parameter specifies the
2247 channel to sharpen.
2248 </small><font size="-1">
2249 The <i>radius</i>_
2250 parameter specifies the radius of the Gaussian, in pixels, not
2251 counting the center pixel. The <i>sigma</i>_ parameter specifies the
2252 standard deviation of the Gaussian, in pixels. The <i>amount</i>_
2253 parameter specifies the percentage of the difference between the
2254 original and the blur image that is added back into the original. The <i>threshold</i>_
2255 parameter specifies the threshold in pixels needed to apply the
2256 diffence amount.
2257 </font>
2258 </td>
2259 </tr>
2260 <tr>
2261 <td style="text-align: center;">
2262 <center><a name="wave"></a> <font size="-1">wave</font></center>
2263 </td>
2264 <td>
2265 <font size="-1">
2266 double amplitude_ = 25.0, double wavelength_
2267 = 150.0
2268 </font>
2269 </td>
2270 <td><font size="-1">Alter an image along a sine wave.</font></td>
2271 </tr>
2272 <tr>
2273 <td style="text-align: center;" rowspan="5">
2274 <center><a name="write"></a> <font size="-1">write</font></center>
2275 </td>
2276 <td><font size="-1">const string &amp;imageSpec_</font></td>
2277 <td>
2278 <font size="-1">
2279 Write image to a file using filename i<i>mageSpec_</i>
2280 .
2281 </font> <br />
2282 <font size="-1">
2283 <b><font color="#ff0000">Caution: </font></b> if
2284 an image format is selected which is capable of supporting fewer
2285 colors than the original image or quantization has been requested, the
2286 original image will be quantized to fewer colors. Use a copy of the
2287 original if this is a problem.
2288 </font>
2289 </td>
2290 </tr>
2291 <tr>
2292 <td><font size="-1"><a href="Blob.html">Blob</a> *blob_</font></td>
2293 <td rowspan="3">
2294 <font size="-1">
2295 Write image to a in-memory <a href="Blob.html">BLOB</a> stored in <i>blob_</i>. The <i>magick</i>_
2296 parameter specifies the image format to write (defaults to <a href="Image++.html#magick">magick</a> ). The depth_ parameter species the image
2297 depth (defaults to <a href="Image++.html#depth"> depth</a> ).
2298 </font> <br />
2299 <font size="-1">
2300 <b><font color="#ff0000">Caution: </font></b> if
2301 an image format is selected which is capable of supporting fewer
2302 colors than the original image or quantization has been requested, the
2303 original image will be quantized to fewer colors. Use a copy of the
2304 original if this is a problem.
2305 </font>
2306 </td>
2307 </tr>
2308 <tr>
2309 <td>
2310 <font size="-1">
2311 <a href="Blob.html">Blob</a> *blob_,
2312 std::string &amp;magick_
2313 </font>
2314 </td>
2315 </tr>
2316 <tr>
2317 <td>
2318 <font size="-1">
2319 <a href="Blob.html">Blob</a> *blob_,
2320 std::string &amp;magick_, size_t depth_
2321 </font>
2322 </td>
2323 </tr>
2324 <tr>
2325 <td>
2326 <font size="-1">
2327 const ssize_t x_, const ssize_t y_, const size_t
2328 columns_, const size_t rows_, const std::string &amp;map_,
2329 const StorageType type_, void *pixels_
2330 </font>
2331 </td>
2332 <td>
2333 <font size="-1">
2334 Write pixel data into a buffer you supply.
2335 The data is saved either as char, short int, integer, float or double
2336 format in the order specified by the type_ parameter. For example, we
2337 want to extract scanline 1 of a 640x480 image as character data in
2338 red-green-blue order:
2339 </font>
2340 <p>
2341 <font size="-1">&#160; image.write(0,0,640,1,"RGB",0,pixels);</font>
2342 </p>
2343 <p>
2344 <font size="-1">The parameters are as follows:</font> <br />
2345 &#160;
2346 </p>
2347 <table border="0" width="100%">
2348 <tbody>
2349 <tr>
2350 <td><font size="-1">x_</font></td>
2351 <td>
2352 <font size="-1">
2353 Horizontal ordinate of left-most
2354 coordinate of region to extract.
2355 </font>
2356 </td>
2357 </tr>
2358 <tr>
2359 <td><font size="-1">y_</font></td>
2360 <td>
2361 <font size="-1">
2362 Vertical ordinate of top-most
2363 coordinate of region to extract.
2364 </font>
2365 </td>
2366 </tr>
2367 <tr>
2368 <td><font size="-1">columns_</font></td>
2369 <td>
2370 <font size="-1">
2371 Width in pixels of the region to
2372 extract.
2373 </font>
2374 </td>
2375 </tr>
2376 <tr>
2377 <td><font size="-1">rows_</font></td>
2378 <td>
2379 <font size="-1">
2380 Height in pixels of the region to
2381 extract.
2382 </font>
2383 </td>
2384 </tr>
2385 <tr>
2386 <td><font size="-1">map_</font></td>
2387 <td>
2388 <font size="-1">
2389 This character string can be any
2390 combination or order of R = red, G = green, B = blue, A = alpha, C =
2391 cyan, Y = yellow, M = magenta, and K = black. The ordering reflects
2392 the order of the pixels in the supplied pixel array.
2393 </font>
2394 </td>
2395 </tr>
2396 <tr>
2397 <td><font size="-1">type_</font></td>
2398 <td>
2399 <font size="-1">
2400 Pixel storage type (CharPixel,
2401 ShortPixel, IntegerPixel, FloatPixel, or DoublePixel)
2402 </font>
2403 </td>
2404 </tr>
2405 <tr>
2406 <td><font size="-1">pixels_</font></td>
2407 <td>
2408 <font size="-1">
2409 This array of values contain the pixel
2410 components as defined by the map_ and type_ parameters. The length of
2411 the arrays must equal the area specified by the width_ and height_
2412 values and type_ parameters.
2413 </font>
2414 </td>
2415 </tr>
2416 </tbody>
2417 </table>
2418 </td>
2419 </tr>
2420 <tr>
2421 <td style="text-align: center;">
2422 <center><a name="resize"></a> <font size="-1">resize</font></center>
2423 </td>
2424 <td>
2425 <font size="-1">
2426 const <a href="Geometry.html">Geometry</a>
2427 &amp;geometry_
2428 </font>
2429 </td>
2430 <td><font size="-1">Resize image to specified size.</font></td>
2431 </tr>
2432 </tbody>
2433 </table>
2434 <center>
2435 <h3> <a name="Image Attributes"></a> Image Attributes</h3>
2436 </center>
2437 Image attributes are set and obtained via methods in Image. Except for
2438 methods which accept pointer arguments (e.g. c<tt>hromaBluePrimary)</tt>
2439 all methods return attributes by value.
2440 <p>
2441 Image attributes are easily used. For example, to set the resolution
2442 of the TIFF file "file.tiff" to 150 dots-per-inch (DPI) in both the
2443 horizontal and vertical directions, you can use the following example
2444 code:
2445 </p>
2446 <pre class="code">
2447 string filename("file.tiff");
2448 Image image;
2449 image.read(filename);
2450 image.resolutionUnits(PixelsPerInchResolution);
2451 image.density(Geometry(150,150)); // could also use image.density("150x150")
2452 image.write(filename)
2453 </pre>
2454 The supported image attributes and the method arguments required to
2455 obtain them are shown in the following table: <br />
2456 &#160;
2457 <table border="1">
2458 <caption>Image Attributes</caption>
2459 <tbody>
2460 <tr>
2461 <td>
2462 <center><b>Function</b></center>
2463 </td>
2464 <td>
2465 <center><b>Type</b></center>
2466 </td>
2467 <td>
2468 <center><b>Get Signature</b></center>
2469 </td>
2470 <td>
2471 <center><b>Set Signature</b></center>
2472 </td>
2473 <td>
2474 <center><b>Description</b></center>
2475 </td>
2476 </tr>
2477 <tr>
2478 <td>
2479 <center><a name="adjoin"></a> <font size="-1">adjoin</font></center>
2480 </td>
2481 <td><font size="-1">bool</font></td>
2482 <td><font size="-1">void</font></td>
2483 <td><font size="-1">bool flag_</font></td>
2484 <td><font size="-1">Join images into a single multi-image file.</font></td>
2485 </tr>
2486 <tr>
2487 <td>
2488 <center><a name="antiAlias"></a> <font size="-1">antiAlias</font></center>
2489 </td>
2490 <td><font size="-1">bool</font></td>
2491 <td><font size="-1">void</font></td>
2492 <td><font size="-1">bool flag_</font></td>
2493 <td>
2494 <font size="-1">
2495 Control antialiasing of rendered Postscript
2496 and Postscript or TrueType fonts. Enabled by default.
2497 </font>
2498 </td>
2499 </tr>
2500 <tr>
2501 <td>
2502 <center>
2503 <a name="animationDelay"></a> <font size="-1">animation-</font>
2504 <br />
2505 <font size="-1">Delay</font>
2506 </center>
2507 </td>
2508 <td><font size="-1">size_t (0 to 65535)</font></td>
2509 <td><font size="-1">void</font></td>
2510 <td><font size="-1">size_t delay_</font></td>
2511 <td>
2512 <font size="-1">
2513 Time in 1/100ths of a second (0 to 65535)
2514 which must expire before displaying the next image in an animated
2515 sequence. This option is useful for regulating the animation of a
2516 sequence&#160; of GIF images within Netscape.
2517 </font>
2518 </td>
2519 </tr>
2520 <tr>
2521 <td>
2522 <center>
2523 <a name="animationIterations"></a> <font size="-1">animation-</font>
2524 <br />
2525 <font size="-1">Iterations</font>
2526 </center>
2527 </td>
2528 <td><font size="-1">size_t</font></td>
2529 <td><font size="-1">void</font></td>
2530 <td><font size="-1">size_t iterations_</font></td>
2531 <td>
2532 <font size="-1">
2533 Number of iterations to loop an animation
2534 (e.g. Netscape loop extension) for.
2535 </font>
2536 </td>
2537 </tr>
2538 <tr>
2539 <td style="vertical-align: middle; text-align: center;">
2540 <small>
2541 <a name="attribute"></a>attribute<br />
2542 </small>
2543 </td>
2544 <td style="vertical-align: middle;">
2545 <small>
2546 string<br />
2547 </small>
2548 </td>
2549 <td style="vertical-align: top;" valign="top">
2550 <small>
2551 const
2552 std::string name_<br />
2553 </small>
2554 </td>
2555 <td style="vertical-align: top;" valign="top">
2556 <small>
2557 const
2558 std::string name_, const std::string value_
2559 </small>
2560 </td>
2561 <td style="vertical-align: middle;">
2562 <small>
2563 An arbitrary named
2564 image attribute. Any number of named attributes may be attached to the
2565 image. For example, the image comment is a named image attribute with
2566 the name "comment". EXIF tags are attached to the image as named
2567 attributes. Use the syntax "EXIF:&lt;tag&gt;" to request an EXIF tag
2568 similar to "EXIF:DateTime".
2569 </small><br />
2570 </td>
2571 </tr>
2572 <tr>
2573 <td>
2574 <center>
2575 <a name="backgroundColor"></a> <font size="-1">background-</font>
2576 <br />
2577 <font size="-1">Color</font>
2578 </center>
2579 </td>
2580 <td><font size="-1"><a href="Color.html">Color</a> </font></td>
2581 <td><font size="-1">void</font></td>
2582 <td>
2583 <font size="-1">
2584 const <a href="Color.html">Color</a>
2585 &amp;color_
2586 </font>
2587 </td>
2588 <td><font size="-1">Image background color</font></td>
2589 </tr>
2590 <tr>
2591 <td>
2592 <center>
2593 <a name="backgroundTexture"></a> <font size="-1">background-</font>
2594 <br />
2595 <font size="-1">Texture</font>
2596 </center>
2597 </td>
2598 <td><font size="-1">string</font></td>
2599 <td><font size="-1">void</font></td>
2600 <td><font size="-1">const string &amp;texture_</font></td>
2601 <td>
2602 <font size="-1">
2603 Image file name to use as the background
2604 texture. Does not modify image pixels.
2605 </font>
2606 </td>
2607 </tr>
2608 <tr>
2609 <td>
2610 <center><a name="baseColumns"></a> <font size="-1">baseColumns</font></center>
2611 </td>
2612 <td><font size="-1">size_t</font></td>
2613 <td><font size="-1">void</font></td>
2614 <td bgcolor="#666666"><font size="-1">&#160;</font></td>
2615 <td><font size="-1">Base image width (before transformations)</font></td>
2616 </tr>
2617 <tr>
2618 <td>
2619 <center><a name="baseFilename"></a> <font size="-1">baseFilename</font></center>
2620 </td>
2621 <td><font size="-1">string</font></td>
2622 <td><font size="-1">void</font></td>
2623 <td bgcolor="#666666"><font size="-1">&#160;</font></td>
2624 <td><font size="-1">Base image filename (before transformations)</font></td>
2625 </tr>
2626 <tr>
2627 <td>
2628 <center><a name="baseRows"></a> <font size="-1">baseRows</font></center>
2629 </td>
2630 <td><font size="-1">size_t</font></td>
2631 <td><font size="-1">void</font></td>
2632 <td bgcolor="#666666"><font size="-1">&#160;</font></td>
2633 <td><font size="-1">Base image height (before transformations)</font></td>
2634 </tr>
2635 <tr>
2636 <td>
2637 <center><a name="borderColor"></a> <font size="-1">borderColor</font></center>
2638 </td>
2639 <td><font size="-1"><a href="Color.html">Color</a> </font></td>
2640 <td><font size="-1">void</font></td>
2641 <td>
2642 <font size="-1">
2643 &#160;const <a href="Color.html">Color</a>
2644 &amp;color_
2645 </font>
2646 </td>
2647 <td><font size="-1">Image border color</font></td>
2648 </tr>
2649 <tr>
2650 <td style="vertical-align: middle;" valign="middle"><small><a name="boundingBox"></a>boundingBox<br /> </small></td>
2651 <td><font size="-1">Geometry</font></td>
2652 <td><font size="-1">void</font></td>
2653 <td bgcolor="#666666"><font size="-1">&#160;</font></td>
2654 <td>
2655 <font size="-1">
2656 Return smallest bounding box enclosing
2657 non-border pixels. The current fuzz value is used when discriminating
2658 between pixels. This is the crop bounding box used by
2659 crop(Geometry(0,0)).
2660 </font>
2661 </td>
2662 </tr>
2663 <tr>
2664 <td>
2665 <center><a name="boxColor"></a> <font size="-1">boxColor</font></center>
2666 </td>
2667 <td><font size="-1"><a href="Color.html">Color</a> </font></td>
2668 <td><font size="-1">void</font></td>
2669 <td>
2670 <font size="-1">
2671 const <a href="Color.html">Color</a>
2672 &amp;boxColor_
2673 </font>
2674 </td>
2675 <td>
2676 <font size="-1">
2677 Base color that annotation text is rendered
2678 on.
2679 </font>
2680 </td>
2681 </tr>
2682 <tr>
2683 <td><a name="cacheThreshold"></a> <font size="-1">cacheThreshold</font></td>
2684 <td><font size="-1">size_t</font></td>
2685 <td bgcolor="#666666"><font size="-1">&#160;</font></td>
2686 <td><font size="-1">const size_t</font></td>
2687 <td>
2688 <font size="-1">
2689 Pixel cache threshold in bytes. Once this
2690 threshold is exceeded, all subsequent pixels cache operations are
2691 to/from disk. This is a static method and the attribute it sets is
2692 shared by all Image objects.
2693 </font>
2694 </td>
2695 </tr>
2696 <tr>
2697 <td style="vertical-align: middle;" valign="middle">
2698 <small>
2699 <a name="channelDepth"></a>channelDepth<br />
2700 </small>
2701 </td>
2702 <td style="vertical-align: middle;" valign="middle">
2703 <small>
2704 size_t
2705 <br />
2706 </small>
2707 </td>
2708 <td style="vertical-align: middle;" valign="middle">
2709 <small>
2710 const
2711 ChannelType channel_<br />
2712 </small>
2713 </td>
2714 <td style="vertical-align: middle;">
2715 <small>
2716 const ChannelType
2717 channel_, const size_t depth_<br />
2718 </small>
2719 </td>
2720 <td style="vertical-align: middle;">
2721 <small>
2722 Channel modulus depth.
2723 The channel modulus depth represents the minimum number of bits
2724 required
2725 to support the channel without loss. Setting the channel's modulus
2726 depth
2727 modifies the channel (i.e. discards resolution) if the requested
2728 modulus
2729 depth is less than the current modulus depth, otherwise the channel is
2730 not altered. There is no attribute associated with the modulus depth so
2731 the current modulus depth is obtained by inspecting the pixels. As a
2732 result, the depth returned may be less than the most recently set
2733 channel depth. Subsequent image processing may result in increasing the
2734 channel depth.<br />
2735 </small>
2736 </td>
2737 </tr>
2738 <tr>
2739 <td style="vertical-align: middle;" valign="middle"><small><a name="channels"></a>channels<br /> </small></td>
2740 <td><font size="-1">size_t</font></td>
2741 <td bgcolor="#666666"><font size="-1">&#160;</font></td>
2742 <td><font size="-1">const size_t</font></td>
2743 <td><font size="-1">NUmber of pixel channels.</font></td>
2744 </tr>
2745 <tr>
2746 <td>
2747 <center>
2748 <a name="chromaBluePrimary"></a> <font size="-1">chroma-</font>
2749 <br />
2750 <font size="-1">BluePrimary</font>
2751 </center>
2752 </td>
2753 <td><font size="-1">double x &amp; y</font></td>
2754 <td><font size="-1">double *x_, double *y_</font></td>
2755 <td><font size="-1">double x_, double y_</font></td>
2756 <td>
2757 <font size="-1">
2758 Chromaticity blue primary point (e.g. x=0.15,
2759 y=0.06)
2760 </font>
2761 </td>
2762 </tr>
2763 <tr>
2764 <td>
2765 <center>
2766 <a name="chromaGreenPrimary"></a> <font size="-1">chroma-</font>
2767 <br />
2768 <font size="-1">GreenPrimary</font>
2769 </center>
2770 </td>
2771 <td><font size="-1">double x &amp; y</font></td>
2772 <td><font size="-1">double *x_, double *y_</font></td>
2773 <td><font size="-1">double x_, double y_</font></td>
2774 <td>
2775 <font size="-1">
2776 Chromaticity green primary point (e.g. x=0.3,
2777 y=0.6)
2778 </font>
2779 </td>
2780 </tr>
2781 <tr>
2782 <td>
2783 <center>
2784 <a name="chromaRedPrimary"></a> <font size="-1">chroma-</font>
2785 <br />
2786 <font size="-1">RedPrimary</font>
2787 </center>
2788 </td>
2789 <td><font size="-1">double x &amp; y</font></td>
2790 <td><font size="-1">double *x_, double *y_</font></td>
2791 <td><font size="-1">double x_, double y_</font></td>
2792 <td>
2793 <font size="-1">
2794 Chromaticity red primary point (e.g. x=0.64,
2795 y=0.33)
2796 </font>
2797 </td>
2798 </tr>
2799 <tr>
2800 <td>
2801 <center>
2802 <a name="chromaWhitePoint"></a> <font size="-1">chroma-</font>
2803 <br />
2804 <font size="-1">WhitePoint</font>
2805 </center>
2806 </td>
2807 <td><font size="-1">double x &amp; y</font></td>
2808 <td><font size="-1">double*x_, double *y_</font></td>
2809 <td><font size="-1">double x_, double y_</font></td>
2810 <td>
2811 <font size="-1">
2812 Chromaticity white point (e.g. x=0.3127,
2813 y=0.329)
2814 </font>
2815 </td>
2816 </tr>
2817 <tr>
2818 <td>
2819 <center><a name="classType"></a> <font size="-1">classType</font></center>
2820 </td>
2821 <td>
2822 <font size="-1">
2823 <a href="https://imagemagick.org/Magick++/Enumerations.html#ClassType">ClassType</a>
2824 </font>
2825 </td>
2826 <td><font size="-1">void</font></td>
2827 <td>
2828 <font size="-1">
2829 &#160;<a href="https://imagemagick.org/Magick++/Enumerations.html#ClassType">ClassType</a>
2830 class_
2831 </font>
2832 </td>
2833 <td>
2834 <font size="-1">
2835 Image storage class.&#160; Note that
2836 conversion from a DirectClass image to a PseudoClass image may result
2837 in a loss of color due to the limited size of the palette (256 or
2838 65535 colors).
2839 </font>
2840 </td>
2841 </tr>
2842 <tr>
2843 <td>
2844 <center><a name="clipMask"></a> <font size="-1">clipMask</font></center>
2845 </td>
2846 <td><font size="-1">Image</font></td>
2847 <td><font size="-1">void</font></td>
2848 <td><font size="-1">const Image &amp;clipMask_</font></td>
2849 <td>
2850 <font size="-1">
2851 Associate a clip mask image with the current
2852 image. The clip mask image must have the same dimensions as the current
2853 image or an exception is thrown. Clipping occurs wherever pixels are
2854 transparent in the clip mask image. Clipping Pass an invalid image to
2855 unset an existing clip mask.
2856 </font>
2857 </td>
2858 </tr>
2859 <tr>
2860 <td>
2861 <center><a name="colorFuzz"></a> <font size="-1">colorFuzz</font></center>
2862 </td>
2863 <td><font size="-1">double</font></td>
2864 <td><font size="-1">void</font></td>
2865 <td><font size="-1">double fuzz_</font></td>
2866 <td>
2867 <font size="-1">
2868 Colors within this distance are considered
2869 equal. A number of algorithms search for a target&#160; color. By
2870 default the color must be exact. Use this option to match colors that
2871 are close to the target color in RGB space.
2872 </font>
2873 </td>
2874 </tr>
2875 <tr>
2876 <td>
2877 <center><a name="colorMap"></a> <font size="-1">colorMap</font></center>
2878 </td>
2879 <td><font size="-1"><a href="Color.html">Color</a> </font></td>
2880 <td><font size="-1">size_t index_</font></td>
2881 <td>
2882 <font size="-1">
2883 size_t index_, const <a href="Color.html">Color</a> &amp;color_
2884 </font>
2885 </td>
2886 <td><font size="-1">Color at colormap index.</font></td>
2887 </tr>
2888 <tr>
2889 <td valign="middle">
2890 <div style="text-align:center">
2891 <a name="colorMapSize"></a> <font size="-1">
2892 colorMapSize<br />
2893 </font>
2894 </div>
2895 </td>
2896 <td valign="middle">
2897 <font size="-1">
2898 size_t<br />
2899 </font>
2900 </td>
2901 <td valign="middle">
2902 <font size="-1">
2903 void<br />
2904 </font>
2905 </td>
2906 <td valign="middle">
2907 <font size="-1">
2908 size_t entries_<br />
2909 </font>
2910 </td>
2911 <td valign="middle">
2912 <font size="-1">
2913 Number of entries in the
2914 colormap. Setting the colormap size may extend or truncate the
2915 colormap.
2916 The maximum number of supported entries is specified by the <i>MaxColormapSize</i>constant,
2917 and is dependent on the value of QuantumDepth when ImageMagick is
2918 compiled. An exception is thrown if more entries are requested than may
2919 be supported. Care should be taken when truncating the colormap to
2920 ensure that the image colormap indexes reference valid colormap entries.
2921 </font><br />
2922 </td>
2923 </tr>
2924 <tr>
2925 <td>
2926 <center><a name="colorSpace"></a> <font size="-1">colorSpace</font></center>
2927 </td>
2928 <td>
2929 <font size="-1">
2930 <a href="https://imagemagick.org/Magick++/Enumerations.html#ColorspaceType">ColorspaceType</a>
2931 colorSpace_
2932 </font>
2933 </td>
2934 <td><font size="-1">void</font></td>
2935 <td>
2936 <font size="-1">
2937 <a href="https://imagemagick.org/Magick++/Enumerations.html#ColorspaceType">ColorspaceType</a>
2938 colorSpace_
2939 </font>
2940 </td>
2941 <td>
2942 <font size="-1">
2943 The colorspace (e.g. CMYK) used to represent
2944 the image pixel colors. Image pixels are always stored as RGB(A) except
2945 for the case of CMY(K).
2946 </font>
2947 </td>
2948 </tr>
2949 <tr>
2950 <td>
2951 <center><a name="columns"></a> <font size="-1">columns</font></center>
2952 </td>
2953 <td><font size="-1">size_t</font></td>
2954 <td><font size="-1">void</font></td>
2955 <td bgcolor="#666666"><font size="-1">&#160;</font></td>
2956 <td><font size="-1">Image width</font></td>
2957 </tr>
2958 <tr>
2959 <td>
2960 <center><a name="comment"></a> <font size="-1">comment</font></center>
2961 </td>
2962 <td><font size="-1">string</font></td>
2963 <td><font size="-1">void</font></td>
2964 <td bgcolor="#666666"><font size="-1">&#160;</font></td>
2965 <td><font size="-1">Image comment</font></td>
2966 </tr>
2967 <tr>
2968 <td>
2969 <center><a name="compose"></a> <font size="-1">compose</font></center>
2970 </td>
2971 <td>
2972 <font size="-1">
2973 <a href="https://imagemagick.org/Magick++/Enumerations.html#CompositeOperator">CompositeOperator</a>
2974 </font>
2975 </td>
2976 <td><small><font size="-1"><small>void</small></font></small></td>
2977 <td>
2978 <small>
2979 <font size="-1">
2980 <small>
2981 <a href="https://imagemagick.org/Magick++/Enumerations.html#CompositeOperator">CompositeOperator</a>
2982 compose_
2983 </small>
2984 </font>
2985 </small>
2986 </td>
2987 <td>
2988 <font size="-1">
2989 Composition operator to be used when
2990 composition is implicitly used (such as for image flattening).
2991 </font>
2992 </td>
2993 </tr>
2994 <tr>
2995 <td>
2996 <center>
2997 <a name="compressType"></a> <font size="-1">compress-</font>
2998 <br />
2999 <font size="-1">Type</font>
3000 </center>
3001 </td>
3002 <td>
3003 <font size="-1">
3004 <a href="https://imagemagick.org/Magick++/Enumerations.html#CompressionType">CompressionType</a>
3005 </font>
3006 </td>
3007 <td><small><font size="-1"><small>void</small></font></small></td>
3008 <td>
3009 <small>
3010 <font size="-1">
3011 <small>
3012 <a href="https://imagemagick.org/Magick++/Enumerations.html#CompressionType">CompressionType</a>
3013 compressType_
3014 </small>
3015 </font>
3016 </small>
3017 </td>
3018 <td>
3019 <font size="-1">
3020 Image compresion type. The default is the
3021 compression type of the specified image file.
3022 </font>
3023 </td>
3024 </tr>
3025 <tr>
3026 <td>
3027 <center><a name="debug"></a> <font size="-1">debug</font></center>
3028 </td>
3029 <td><font size="-1">bool</font></td>
3030 <td><small><font size="-1"><small>void</small></font></small></td>
3031 <td><small><font size="-1"><small>bool flag_</small></font></small></td>
3032 <td>
3033 <font size="-1">
3034 Enable printing of internal debug messages
3035 from ImageMagick as it executes.
3036 </font>
3037 </td>
3038 </tr>
3039 <tr>
3040 <td style="text-align: center; vertical-align: middle;">
3041 <small>
3042 <a name="defineValue"></a>defineValue<br />
3043 </small>
3044 </td>
3045 <td style="vertical-align: middle; text-align: left;">
3046 <small>
3047 string<br />
3048 </small>
3049 </td>
3050 <td style="vertical-align: middle;">
3051 <small>
3052 const std::string
3053 &amp;magick_, const std::string &amp;key_<br />
3054 </small>
3055 </td>
3056 <td style="vertical-align: middle;">
3057 <small>
3058 const std::string
3059 &amp;magick_, const std::string &amp;key_, &#160;const std::string
3060 &amp;value_<br />
3061 </small>
3062 </td>
3063 <td style="vertical-align: top;">
3064 <small>
3065 Set or obtain a
3066 definition string to applied when encoding or decoding the specified
3067 format. The meanings of the definitions are format specific. The format
3068 is designated by the <span style="font-style: italic;">magick_</span>
3069 argument, the format-specific key is designated by <span style="font-style: italic;">key_</span>, and the associated value is
3070 specified by <span style="font-style: italic;">value_</span>. See the
3071 defineSet() method if the key must be removed entirely.
3072 </small><br />
3073 </td>
3074 </tr>
3075 <tr>
3076 <td style="text-align: center; vertical-align: middle;">
3077 <small>
3078 <a name="defineSet"></a>defineSet<br />
3079 </small>
3080 </td>
3081 <td style="vertical-align: middle; text-align: left;">
3082 <small>
3083 bool<br />
3084 </small>
3085 </td>
3086 <td style="vertical-align: middle;">
3087 <small>
3088 const std::string
3089 &amp;magick_, const std::string &amp;key_<br />
3090 </small>
3091 </td>
3092 <td style="vertical-align: middle;">
3093 <small>
3094 const std::string
3095 &amp;magick_, const std::string &amp;key_, bool flag_<br />
3096 </small>
3097 </td>
3098 <td style="vertical-align: middle;">
3099 <small>
3100 Set or obtain a
3101 definition flag to applied when encoding or decoding the specified
3102 format.
3103 </small><small>
3104 . Similar to the defineValue() method except that
3105 passing the <span style="font-style: italic;">flag_</span> value
3106 'true'
3107 creates a value-less define with that format and key. Passing the <span style="font-style: italic;">f</span><span style="font-style: italic;">lag_</span>
3108 value 'false' removes any existing matching definition. The method
3109 returns 'true' if a matching key exists, and 'false' if no matching key
3110 exists.<br />
3111 </small>
3112 </td>
3113 </tr>
3114 <tr>
3115 <td>
3116 <center><a name="density"></a> <font size="-1">density</font></center>
3117 </td>
3118 <td>
3119 <font size="-1">
3120 <a href="Geometry.html">Geometry</a> &#160;
3121 (default 72x72)
3122 </font>
3123 </td>
3124 <td><font size="-1">void</font></td>
3125 <td>
3126 <font size="-1">
3127 const <a href="Geometry.html">Geometry</a>
3128 &amp;density_
3129 </font>
3130 </td>
3131 <td>
3132 <font size="-1">
3133 Vertical and horizontal resolution in pixels
3134 of the image. This option specifies an image density when decoding a
3135 Postscript or Portable Document page. Often used with <i>psPageSize</i>.
3136 </font>
3137 </td>
3138 </tr>
3139 <tr>
3140 <td>
3141 <center><a name="depth"></a> <font size="-1">depth</font></center>
3142 </td>
3143 <td><font size="-1">&#160;size_t (8-32)</font></td>
3144 <td><font size="-1">void</font></td>
3145 <td><font size="-1">size_t depth_</font></td>
3146 <td>
3147 <font size="-1">
3148 Image depth. Used to specify the bit depth
3149 when reading or writing&#160; raw images or when the output format
3150 supports multiple depths. Defaults to the quantum depth that
3151 ImageMagick is compiled with.
3152 </font>
3153 </td>
3154 </tr>
3155 <tr>
3156 <td>
3157 <center><a name="endian"></a> <font size="-1">endian</font></center>
3158 </td>
3159 <td>
3160 <font size="-1">
3161 <a href="https://imagemagick.org/Magick++/Enumerations.html#EndianType">EndianType</a>
3162 </font>
3163 </td>
3164 <td><font size="-1">void</font></td>
3165 <td>
3166 <font size="-1">
3167 <a href="https://imagemagick.org/Magick++/Enumerations.html#EndianType">EndianType</a>
3168 endian_
3169 </font>
3170 </td>
3171 <td>
3172 <font size="-1">
3173 Specify (or obtain) endian option for formats
3174 which support it.
3175 </font>
3176 </td>
3177 </tr>
3178 <tr>
3179 <td>
3180 <center><a name="directory"></a> <font size="-1">directory</font></center>
3181 </td>
3182 <td><font size="-1">string</font></td>
3183 <td><font size="-1">void</font></td>
3184 <td><font size="-1">&#160;</font></td>
3185 <td><font size="-1">Tile names from within an image montage</font></td>
3186 </tr>
3187 <tr>
3188 <td>
3189 <center><a name="file"></a> <font size="-1">file</font></center>
3190 </td>
3191 <td><font size="-1">FILE *</font></td>
3192 <td><font size="-1">FILE *</font></td>
3193 <td><font size="-1">FILE *file_</font></td>
3194 <td><font size="-1">Image file descriptor.</font></td>
3195 </tr>
3196 <tr>
3197 <td>
3198 <center><a name="fileName"></a> <font size="-1">fileName</font></center>
3199 </td>
3200 <td><font size="-1">string</font></td>
3201 <td><font size="-1">void</font></td>
3202 <td><font size="-1">const string &amp;fileName_</font></td>
3203 <td><font size="-1">Image file name.</font></td>
3204 </tr>
3205 <tr>
3206 <td>
3207 <center><a name="fileSize"></a> <font size="-1">fileSize</font></center>
3208 </td>
3209 <td><font size="-1">off_t</font></td>
3210 <td><font size="-1">void</font></td>
3211 <td bgcolor="#666666"><font size="-1">&#160;</font></td>
3212 <td><font size="-1">Number of bytes of the image on disk</font></td>
3213 </tr>
3214 <tr>
3215 <td>
3216 <center><a name="fillColor"></a> <font size="-1">fillColor</font></center>
3217 </td>
3218 <td><font size="-1">Color</font></td>
3219 <td><font size="-1">void</font></td>
3220 <td><font size="-1">const Color &amp;fillColor_</font></td>
3221 <td><font size="-1">Color to use when filling drawn objects</font></td>
3222 </tr>
3223 <tr>
3224 <td>
3225 <center><a name="fillPattern"></a> <font size="-1">fillPattern</font></center>
3226 </td>
3227 <td><font size="-1">Image</font></td>
3228 <td><font size="-1">void</font></td>
3229 <td><font size="-1">const Image &amp;fillPattern_</font></td>
3230 <td>
3231 <font size="-1">
3232 Pattern image to use when filling drawn
3233 objects.
3234 </font>
3235 </td>
3236 </tr>
3237 <tr>
3238 <td>
3239 <center><a name="fillRule"></a> <font size="-1">fillRule</font></center>
3240 </td>
3241 <td>
3242 <font size="-1">
3243 <a href="https://imagemagick.org/Magick++/Enumerations.html#FillRule">FillRule</a>
3244 </font>
3245 </td>
3246 <td><font size="-1">void</font></td>
3247 <td><font size="-1">const Magick::FillRule &amp;fillRule_</font></td>
3248 <td><font size="-1">Rule to use when filling drawn objects.</font></td>
3249 </tr>
3250 <tr>
3251 <td>
3252 <center><a name="filterType"></a> <font size="-1">filterType</font></center>
3253 </td>
3254 <td>
3255 <font size="-1">
3256 <a href="https://imagemagick.org/Magick++/Enumerations.html#FilterTypes">FilterTypes</a>
3257 </font>
3258 </td>
3259 <td><font size="-1">void</font></td>
3260 <td>
3261 <font size="-1">
3262 <a href="https://imagemagick.org/Magick++/Enumerations.html#FilterTypes">FilterTypes</a>
3263 filterType_
3264 </font>
3265 </td>
3266 <td>
3267 <font size="-1">
3268 Filter to use when resizing image. The
3269 reduction filter employed has a sigificant effect on the time required
3270 to resize an image and the resulting quality. The default filter is <i>Lanczos</i>
3271 which has been shown to produce high quality results when reducing most
3272 images.
3273 </font>
3274 </td>
3275 </tr>
3276 <tr>
3277 <td>
3278 <center><a name="font"></a> <font size="-1">font</font></center>
3279 </td>
3280 <td><font size="-1">string</font></td>
3281 <td><font size="-1">void</font></td>
3282 <td><font size="-1">const string &amp;font_</font></td>
3283 <td>
3284 <font size="-1">
3285 Text rendering font. If the font is a fully
3286 qualified X server font name, the font is obtained from an X&#160;
3287 server. To use a TrueType font, precede the TrueType filename with an
3288 @. Otherwise, specify&#160; a&#160; Postscript font name (e.g.
3289 "helvetica").
3290 </font>
3291 </td>
3292 </tr>
3293 <tr>
3294 <td>
3295 <center><a name="fontPointsize"></a> <font size="-1">fontPointsize</font></center>
3296 </td>
3297 <td><font size="-1">size_t</font></td>
3298 <td><font size="-1">void</font></td>
3299 <td><font size="-1">size_t pointSize_</font></td>
3300 <td><font size="-1">Text rendering font point size</font></td>
3301 </tr>
3302 <tr>
3303 <td>
3304 <center><a name="fontTypeMetrics"></a> <font size="-1">fontTypeMetrics</font></center>
3305 </td>
3306 <td><font size="-1"><a href="TypeMetric.html">TypeMetric</a> </font></td>
3307 <td>
3308 <font size="-1">
3309 const std::string &amp;text_, <a href="TypeMetric.html">TypeMetric</a> *metrics
3310 </font>
3311 </td>
3312 <td bgcolor="#666666"><font size="-1">&#160;</font></td>
3313 <td>
3314 <font size="-1">
3315 Update metrics with font type metrics using
3316 specified <i>text</i>, and current <a href="Image++.html#font">font</a> and <a href="Image++.html#fontPointsize">fontPointSize</a> settings.
3317 </font>
3318 </td>
3319 </tr>
3320 <tr>
3321 <td>
3322 <center><a name="format"></a> <font size="-1">format</font></center>
3323 </td>
3324 <td><font size="-1">string</font></td>
3325 <td><font size="-1">void</font></td>
3326 <td bgcolor="#666666"><font size="-1">&#160;</font></td>
3327 <td><font size="-1">Long form image format description.</font></td>
3328 </tr>
3329 <tr>
3330 <td>
3331 <center><a name="gamma"></a> <font size="-1">gamma</font></center>
3332 </td>
3333 <td><font size="-1">double (typical range 0.8 to 2.3)</font></td>
3334 <td><font size="-1">void</font></td>
3335 <td bgcolor="#666666"><font size="-1">&#160;</font></td>
3336 <td>
3337 <font size="-1">
3338 Gamma level of the image. The same color
3339 image displayed on two different&#160; workstations&#160; may&#160;
3340 look&#160; different due to differences in the display monitor.&#160;
3341 Use gamma correction&#160; to&#160; adjust&#160; for this&#160;
3342 color&#160; difference.
3343 </font>
3344 </td>
3345 </tr>
3346 <tr>
3347 <td>
3348 <center><a name="geometry"></a> <font size="-1">geometry</font></center>
3349 </td>
3350 <td><font size="-1"><a href="Geometry.html">Geometry</a> </font></td>
3351 <td><font size="-1">void</font></td>
3352 <td bgcolor="#666666"><font size="-1">&#160;</font></td>
3353 <td><font size="-1">Preferred size of the image when encoding.</font></td>
3354 </tr>
3355 <tr>
3356 <td>
3357 <center>
3358 <a name="gifDisposeMethod"></a> <font size="-1">gifDispose-</font>
3359 <br />
3360 <font size="-1">Method</font>
3361 </center>
3362 </td>
3363 <td>
3364 <font size="-1">size_t</font> <br />
3365 <font size="-1">{ 0 = Disposal not specified,</font> <br />
3366 <font size="-1">1 = Do not dispose of graphic,</font> <br />
3367 <font size="-1">3 = Overwrite graphic with background color,</font>
3368 <br />
3369 <font size="-1">4 = Overwrite graphic with previous graphic. }</font>
3370 </td>
3371 <td><font size="-1">void</font></td>
3372 <td><font size="-1">size_t disposeMethod_</font></td>
3373 <td>
3374 <font size="-1">
3375 GIF disposal method. This option is used to
3376 control how successive frames are rendered (how the preceding frame is
3377 disposed of) when creating a GIF animation.
3378 </font>
3379 </td>
3380 </tr>
3381 <tr>
3382 <td>
3383 <center><a name="iccColorProfile"></a> <font size="-1">iccColorProfile</font></center>
3384 </td>
3385 <td><font size="-1"><a href="Blob.html">Blob</a> </font></td>
3386 <td><font size="-1">void</font></td>
3387 <td>
3388 <font size="-1">
3389 const <a href="Blob.html">Blob</a>
3390 &amp;colorProfile_
3391 </font>
3392 </td>
3393 <td>
3394 <font size="-1">
3395 ICC color profile. Supplied via a <a href="Blob.html">Blob</a> since Magick++/ and ImageMagick do not
3396 currently support formating this data structure directly.&#160;
3397 Specifications are available from the <a href="http://www.color.org/">
3398 International Color Consortium
3399 </a> for the format of ICC color profiles.
3400 </font>
3401 </td>
3402 </tr>
3403 <tr>
3404 <td>
3405 <center>
3406 <a name="interlaceType"></a> <font size="-1">interlace-</font>
3407 <br />
3408 <font size="-1">Type</font>
3409 </center>
3410 </td>
3411 <td>
3412 <font size="-1">
3413 <a href="https://imagemagick.org/Magick++/Enumerations.html#InterlaceType">InterlaceType</a>
3414 </font>
3415 </td>
3416 <td><font size="-1">void</font></td>
3417 <td>
3418 <font size="-1">
3419 <a href="https://imagemagick.org/Magick++/Enumerations.html#InterlaceType">InterlaceType</a>
3420 interlace_
3421 </font>
3422 </td>
3423 <td>
3424 <font size="-1">
3425 The type of interlacing scheme (default <i>NoInterlace</i>
3426 ). This option is used to specify the type of&#160; interlacing
3427 scheme&#160; for&#160; raw&#160; image formats such as RGB or YUV. <i>NoInterlace</i>
3428 means do not&#160; interlace, <i>LineInterlace</i> uses scanline
3429 interlacing, and <i>PlaneInterlace</i> uses plane interlacing. <i>
3430 PartitionInterlace
3431 </i> is like <i>PlaneInterlace</i> except the&#160;
3432 different planes&#160; are saved&#160; to individual files (e.g.&#160;
3433 image.R, image.G, and image.B). Use <i>LineInterlace</i> or <i>
3434 PlaneInterlace
3435 </i> to create an interlaced GIF or progressive JPEG
3436 image.
3437 </font>
3438 </td>
3439 </tr>
3440 <tr>
3441 <td>
3442 <center><a name="iptcProfile"></a> <font size="-1">iptcProfile</font></center>
3443 </td>
3444 <td><font size="-1"><a href="Blob.html">Blob</a> </font></td>
3445 <td><font size="-1">void</font></td>
3446 <td>
3447 <font size="-1">
3448 const <a href="Blob.html">Blob</a> &amp;
3449 iptcProfile_
3450 </font>
3451 </td>
3452 <td>
3453 <font size="-1">
3454 IPTC profile. Supplied via a <a href="Blob.html">Blob</a> since Magick++ and ImageMagick do not
3455 currently&#160; support formating this data structure directly.
3456 Specifications are available from the <a href="http://www.iptc.org/">
3457 International Press Telecommunications Council
3458 </a> for IPTC profiles.
3459 </font>
3460 </td>
3461 </tr>
3462 <tr>
3463 <td>
3464 <center><a name="label"></a> <font size="-1">label</font></center>
3465 </td>
3466 <td><font size="-1">string</font></td>
3467 <td><font size="-1">void</font></td>
3468 <td><font size="-1">const string &amp;label_</font></td>
3469 <td><font size="-1">Image label</font></td>
3470 </tr>
3471 <tr>
3472 <td>
3473 <center><a name="magick"></a> <font size="-1">magick</font></center>
3474 </td>
3475 <td><font size="-1">string</font></td>
3476 <td><font size="-1">void</font></td>
3477 <td><font size="-1">&#160;const string &amp;magick_</font></td>
3478 <td><font size="-1">Get image format (e.g. "GIF")</font></td>
3479 </tr>
3480 <tr>
3481 <td>
3482 <center><a name="alpha"></a> <font size="-1">alpha</font></center>
3483 </td>
3484 <td><font size="-1">const bool</font></td>
3485 <td><font size="-1">void</font></td>
3486 <td><font size="-1">const bool alphaFlag_</font></td>
3487 <td>
3488 <font size="-1">
3489 Image supports transparency (alpha channel)
3490 </font>
3491 </td>
3492 </tr>
3493 <tr>
3494 <td>
3495 <center><a name="matteColor"></a> <font size="-1">matteColor</font></center>
3496 </td>
3497 <td><font size="-1"><a href="Color.html">Color</a> </font></td>
3498 <td><font size="-1">void</font></td>
3499 <td>
3500 <font size="-1">
3501 const <a href="Color.html">Color</a>
3502 &amp;matteColor_
3503 </font>
3504 </td>
3505 <td><font size="-1">Image matte (frame) color</font></td>
3506 </tr>
3507 <tr>
3508 <td>
3509 <center>
3510 <a name="meanErrorPerPixel"></a> <font size="-1">meanError-</font>
3511 <br />
3512 <font size="-1">PerPixel</font>
3513 </center>
3514 </td>
3515 <td><font size="-1">double</font></td>
3516 <td><font size="-1">void</font></td>
3517 <td bgcolor="#666666"><font size="-1">&#160;</font></td>
3518 <td>
3519 <font size="-1">
3520 The mean error per pixel computed when an
3521 image is color reduced. This parameter is only valid if verbose is set
3522 to true and the image has just been quantized.
3523 </font>
3524 </td>
3525 </tr>
3526 <tr>
3527 <td style="text-align: center; vertical-align: middle;">
3528 <font size="-1">
3529 <a name="modulusDepth"></a>modulusDepth<br />
3530 </font>
3531 </td>
3532 <td style="text-align: left; vertical-align: middle;">
3533 <small>
3534 size_t
3535 <br />
3536 </small>
3537 </td>
3538 <td style="text-align: left; vertical-align: middle;">
3539 <small>
3540 <font size="-1">
3541 <small>
3542 void<br />
3543 </small>
3544 </font>
3545 </small>
3546 </td>
3547 <td style="text-align: left; vertical-align: middle;">
3548 <small>
3549 size_t
3550 depth_<br />
3551 </small>
3552 </td>
3553 <td style="text-align: left; vertical-align: middle;">
3554 <small>
3555 Image
3556 modulus depth (minimum number of bits required to support
3557 red/green/blue components without loss of accuracy). The pixel modulus
3558 depth may be decreased by supplying a value which is less than the
3559 current value, updating the pixels (reducing accuracy) to the new
3560 depth.
3561 The pixel modulus depth can not be increased over the current value
3562 using this method.<br />
3563 </small>
3564 </td>
3565 </tr>
3566 <tr>
3567 <td>
3568 <center><a name="monochrome"></a> <font size="-1">monochrome</font></center>
3569 </td>
3570 <td><font size="-1">bool</font></td>
3571 <td><font size="-1">void</font></td>
3572 <td><font size="-1">bool flag_</font></td>
3573 <td><font size="-1">Transform the image to black and white</font></td>
3574 </tr>
3575 <tr>
3576 <td>
3577 <center>
3578 <a name="montageGeometry"></a> <font size="-1">montage-</font>
3579 <br />
3580 <font size="-1">Geometry</font>
3581 </center>
3582 </td>
3583 <td><font size="-1"><a href="Geometry.html">Geometry</a> </font></td>
3584 <td><font size="-1">void</font></td>
3585 <td bgcolor="#666666"><font size="-1">&#160;</font></td>
3586 <td>
3587 <font size="-1">
3588 Tile size and offset within an image montage.
3589 Only valid for montage images.
3590 </font>
3591 </td>
3592 </tr>
3593 <tr>
3594 <td>
3595 <center>
3596 <a name="normalizedMaxError"></a> <font size="-1">normalized-</font>
3597 <br />
3598 <font size="-1">MaxError</font>
3599 </center>
3600 </td>
3601 <td><font size="-1">double</font></td>
3602 <td><font size="-1">void</font></td>
3603 <td bgcolor="#666666"><font size="-1">&#160;</font></td>
3604 <td>
3605 <font size="-1">
3606 The normalized max error per pixel computed
3607 when an image is color reduced. This parameter is only valid if verbose
3608 is set to true and the image has just been quantized.
3609 </font>
3610 </td>
3611 </tr>
3612 <tr>
3613 <td>
3614 <center>
3615 <a name="normalizedMeanError"></a> <font size="-1">normalized-</font>
3616 <br />
3617 <font size="-1">MeanError</font>
3618 </center>
3619 </td>
3620 <td><font size="-1">double</font></td>
3621 <td><font size="-1">void</font></td>
3622 <td bgcolor="#666666"><font size="-1">&#160;</font></td>
3623 <td>
3624 <font size="-1">
3625 The normalized mean error per pixel computed
3626 when an image is color reduced. This parameter is only valid if verbose
3627 is set to true and the image has just been quantized.
3628 </font>
3629 </td>
3630 </tr>
3631 <tr>
3632 <td style="text-align: center; vertical-align: middle;">
3633 <small>
3634 <a name="orientation"></a>orientation<br />
3635 </small>
3636 </td>
3637 <td style="vertical-align: middle;">
3638 <small>
3639 <a href="https://imagemagick.org/Magick++/Enumerations.html#OrientationType">OrientationType</a>
3640 </small>
3641 </td>
3642 <td style="vertical-align: top;">
3643 <small>void</small><br />
3644 </td>
3645 <td style="vertical-align: middle;">
3646 <small>
3647 <a href="https://imagemagick.org/Magick++/Enumerations.html#OrientationType">OrientationType</a>
3648 orientation_
3649 </small>
3650 </td>
3651 <td style="vertical-align: top;">
3652 <small>
3653 Image orientation.
3654 &#160;Supported by some file formats such as DPX and TIFF. Useful for
3655 turning the right way up.<br />
3656 </small>
3657 </td>
3658 </tr>
3659 <tr>
3660 <td>
3661 <center><a name="packets"></a> <font size="-1">packets</font></center>
3662 </td>
3663 <td><font size="-1">size_t</font></td>
3664 <td><font size="-1">void</font></td>
3665 <td bgcolor="#666666"><font size="-1">&#160;</font></td>
3666 <td>
3667 <font size="-1">The number of runlength-encoded packets in</font>
3668 <br />
3669 <font size="-1">the image</font>
3670 </td>
3671 </tr>
3672 <tr>
3673 <td>
3674 <center><a name="packetSize"></a> <font size="-1">packetSize</font></center>
3675 </td>
3676 <td><font size="-1">size_t</font></td>
3677 <td><font size="-1">void</font></td>
3678 <td bgcolor="#666666"><font size="-1">&#160;</font></td>
3679 <td><font size="-1">The number of bytes in each pixel packet</font></td>
3680 </tr>
3681 <tr>
3682 <td>
3683 <center><a name="page"></a> <font size="-1">page</font></center>
3684 </td>
3685 <td>
3686 <font size="-1">
3687 <a href="Geometry.html#PostscriptPageSize">Geometry</a>
3688 </font>
3689 </td>
3690 <td><font size="-1">void</font></td>
3691 <td>
3692 <font size="-1">
3693 const <a href="Geometry.html#PostscriptPageSize">Geometry</a> &amp;pageSize_
3694 </font>
3695 </td>
3696 <td>
3697 <font size="-1">
3698 Preferred size and location of an image
3699 canvas.
3700 </font>
3701 <p>
3702 <font size="-1">
3703 Use this option to specify the dimensions
3704 and position of the Postscript page in dots per inch or a TEXT page in
3705 pixels. This option is typically used in concert with <i>
3706 <a href="Image++.html#density">density</a>
3707 </i>.
3708 </font>
3709 </p>
3710 <p>
3711 <font size="-1">
3712 Page may also be used to position a GIF
3713 image (such as for a scene in an animation)
3714 </font>
3715 </p>
3716 </td>
3717 </tr>
3718 <tr>
3719 <td>
3720 <center><a name="pixelColor"></a> <font size="-1">pixelColor</font></center>
3721 </td>
3722 <td><font size="-1"><a href="Color.html">Color</a> </font></td>
3723 <td><font size="-1">ssize_t x_, ssize_t y_</font></td>
3724 <td>
3725 <font size="-1">
3726 ssize_t x_, ssize_t y_, const <a href="Color.html">Color</a> &amp;color_
3727 </font>
3728 </td>
3729 <td><font size="-1">Get/set pixel color at location x &amp; y.</font></td>
3730 </tr>
3731 <tr>
3732 <td valign="top">
3733 <div style="text-align:center">
3734 <a name="profile"></a> <small>profile</small><br />
3735 </div>
3736 </td>
3737 <td valign="top">
3738 <a href="Blob.html">
3739 <small> Blob</small><small>
3740 <br />
3741 </small>
3742 </a>
3743 </td>
3744 <td valign="top">
3745 <small>const std::string name_</small><small>
3746 <br />
3747 </small>
3748 </td>
3749 <td valign="top">
3750 <small>
3751 const std::string name_, const Blob
3752 &amp;colorProfile_
3753 </small><small>
3754 <br />
3755 </small>
3756 </td>
3757 <td valign="top">
3758 <small>Get/set/remove </small><small>
3759 a named
3760 profile
3761 </small><small>. Valid names include </small><small>
3762 "*",
3763 "8BIM", "ICM", "IPTC", or a user/format-defined profile name.
3764 </small><br />
3765 </td>
3766 </tr>
3767 <tr>
3768 <td>
3769 <center><a name="quality"></a> <font size="-1">quality</font></center>
3770 </td>
3771 <td><font size="-1">size_t (0 to 100)</font></td>
3772 <td><font size="-1">void</font></td>
3773 <td><font size="-1">size_t quality_</font></td>
3774 <td><font size="-1">JPEG/MIFF/PNG compression level (default 75).</font></td>
3775 </tr>
3776 <tr>
3777 <td>
3778 <center>
3779 <a name="quantizeColors"></a> <font size="-1">quantize-</font>
3780 <br />
3781 <font size="-1">Colors</font>
3782 </center>
3783 </td>
3784 <td><font size="-1">size_t</font></td>
3785 <td><font size="-1">void</font></td>
3786 <td><font size="-1">size_t colors_</font></td>
3787 <td>
3788 <font size="-1">
3789 Preferred number of colors in the image. The
3790 actual number of colors in the image may be less than your request, but
3791 never more. Images with less unique colors than specified with this
3792 option will have any duplicate or unused colors removed.
3793 </font>
3794 </td>
3795 </tr>
3796 <tr>
3797 <td>
3798 <center>
3799 <a name="quantizeColorSpace"></a> <font size="-1">quantize-</font>
3800 <br />
3801 <font size="-1">ColorSpace</font>
3802 </center>
3803 </td>
3804 <td>
3805 <font size="-1">
3806 <a href="https://imagemagick.org/Magick++/Enumerations.html#ColorspaceType">ColorspaceType</a>
3807 </font>
3808 </td>
3809 <td><font size="-1">void</font></td>
3810 <td>
3811 <font size="-1">
3812 <a href="https://imagemagick.org/Magick++/Enumerations.html#ColorspaceType">ColorspaceType</a>
3813 colorSpace_
3814 </font>
3815 </td>
3816 <td>
3817 <font size="-1">
3818 Colorspace to quantize colors in (default
3819 RGB). Empirical evidence suggests that distances in color spaces such
3820 as YUV or YIQ correspond to perceptual color differences more closely
3821 than do distances in RGB space. These color spaces may give better
3822 results when color reducing an image.
3823 </font>
3824 </td>
3825 </tr>
3826 <tr>
3827 <td>
3828 <center>
3829 <a name="quantizeDither"></a> <font size="-1">quantize-</font>
3830 <br />
3831 <font size="-1">Dither</font>
3832 </center>
3833 </td>
3834 <td><font size="-1">bool</font></td>
3835 <td><font size="-1">void</font></td>
3836 <td><font size="-1">bool flag_</font></td>
3837 <td>
3838 <font size="-1">
3839 Apply Floyd/Steinberg error diffusion to the
3840 image. The basic strategy of dithering is to&#160; trade&#160;
3841 intensity
3842 resolution&#160; for&#160; spatial&#160; resolution&#160; by&#160;
3843 averaging the intensities&#160; of&#160; several&#160;
3844 neighboring&#160; pixels. Images which&#160; suffer&#160; from&#160;
3845 severe&#160; contouring&#160; when&#160; reducing colors can be
3846 improved with this option. The quantizeColors or monochrome option must
3847 be set for this option to take effect.
3848 </font>
3849 </td>
3850 </tr>
3851 <tr>
3852 <td>
3853 <center>
3854 <a name="quantizeTreeDepth"></a> <font size="-1">quantize-</font>
3855 <br />
3856 <font size="-1">TreeDepth</font>
3857 </center>
3858 </td>
3859 <td><font size="-1">size_t&#160;</font></td>
3860 <td><font size="-1">void</font></td>
3861 <td><font size="-1">size_t treeDepth_</font></td>
3862 <td>
3863 <font size="-1">
3864 Depth of the quantization color
3865 classification tree. Values of 0 or 1 allow selection of the optimal
3866 tree depth for the color reduction algorithm. Values between 2 and 8
3867 may be used to manually adjust the tree depth.
3868 </font>
3869 </td>
3870 </tr>
3871 <tr>
3872 <td>
3873 <center>
3874 <a name="renderingIntent"></a> <font size="-1">rendering-</font>
3875 <br />
3876 <font size="-1">Intent</font>
3877 </center>
3878 </td>
3879 <td>
3880 <font size="-1">
3881 <a href="https://imagemagick.org/Magick++/Enumerations.html#RenderingIntent">RenderingIntent</a>
3882 </font>
3883 </td>
3884 <td><font size="-1">void</font></td>
3885 <td>
3886 <font size="-1">
3887 <a href="https://imagemagick.org/Magick++/Enumerations.html#RenderingIntent">RenderingIntent</a>
3888 render_
3889 </font>
3890 </td>
3891 <td><font size="-1">The type of rendering intent</font></td>
3892 </tr>
3893 <tr>
3894 <td>
3895 <center>
3896 <a name="resolutionUnits"></a> <font size="-1">resolution-</font>
3897 <br />
3898 <font size="-1">Units</font>
3899 </center>
3900 </td>
3901 <td>
3902 <font size="-1">
3903 <a href="https://imagemagick.org/Magick++/Enumerations.html#ResolutionType">ResolutionType</a>
3904 </font>
3905 </td>
3906 <td><font size="-1">void</font></td>
3907 <td>
3908 <font size="-1">
3909 <a href="https://imagemagick.org/Magick++/Enumerations.html#ResolutionType">ResolutionType</a>
3910 units_
3911 </font>
3912 </td>
3913 <td><font size="-1">Units of image resolution</font></td>
3914 </tr>
3915 <tr>
3916 <td>
3917 <center><a name="rows"></a> <font size="-1">rows</font></center>
3918 </td>
3919 <td><font size="-1">size_t</font></td>
3920 <td><font size="-1">void</font></td>
3921 <td bgcolor="#666666"><font size="-1">&#160;</font></td>
3922 <td><font size="-1">The number of pixel rows in the image</font></td>
3923 </tr>
3924 <tr>
3925 <td>
3926 <center><a name="scene"></a> <font size="-1">scene</font></center>
3927 </td>
3928 <td><font size="-1">size_t</font></td>
3929 <td><font size="-1">void</font></td>
3930 <td><font size="-1">size_t scene_</font></td>
3931 <td><font size="-1">Image scene number</font></td>
3932 </tr>
3933 <tr>
3934 <td>
3935 <center><a name="signature"></a> <font size="-1">signature</font></center>
3936 </td>
3937 <td><font size="-1">string</font></td>
3938 <td><font size="-1">bool force_ = false</font></td>
3939 <td bgcolor="#666666"><font size="-1">&#160;</font></td>
3940 <td>
3941 <font size="-1">
3942 Image MD5 signature. Set force_ to 'true' to
3943 force re-computation of signature.
3944 </font>
3945 </td>
3946 </tr>
3947 <tr>
3948 <td>
3949 <center><a name="size"></a> <font size="-1">size</font></center>
3950 </td>
3951 <td><font size="-1"><a href="Geometry.html">Geometry</a> </font></td>
3952 <td><font size="-1">void</font></td>
3953 <td>
3954 <font size="-1">
3955 const <a href="Geometry.html">Geometry</a>
3956 &amp;geometry_
3957 </font>
3958 </td>
3959 <td>
3960 <font size="-1">
3961 Width and height of a raw image (an image
3962 which does not support width and height information).&#160; Size may
3963 also be used to affect the image size read from a multi-resolution
3964 format (e.g. Photo CD, JBIG, or JPEG.
3965 </font>
3966 </td>
3967 </tr>
3968 <tr>
3969 <td style="text-align: center;">
3970 <center><a name="strip"></a> <font size="-1">strip</font></center>
3971 </td>
3972 <td><font size="-1">void</font></td>
3973 <td><font size="-1">strips an image of all profiles and comments.</font></td>
3974 </tr>
3975 <tr>
3976 <td>
3977 <center><a name="strokeAntiAlias"></a> <font size="-1">strokeAntiAlias</font></center>
3978 </td>
3979 <td><font size="-1">bool</font></td>
3980 <td><font size="-1">void</font></td>
3981 <td><font size="-1">bool flag_</font></td>
3982 <td>
3983 <font size="-1">
3984 Enable or disable anti-aliasing when drawing
3985 object outlines.
3986 </font>
3987 </td>
3988 </tr>
3989 <tr>
3990 <td>
3991 <center><a name="strokeColor"></a> <font size="-1">strokeColor</font></center>
3992 </td>
3993 <td><font size="-1">Color</font></td>
3994 <td><font size="-1">void</font></td>
3995 <td><font size="-1">const Color &amp;strokeColor_</font></td>
3996 <td><font size="-1">Color to use when drawing object outlines</font></td>
3997 </tr>
3998 <tr>
3999 <td>
4000 <center><a name="strokeDashOffset"></a> <font size="-1">strokeDashOffset</font></center>
4001 </td>
4002 <td><font size="-1">size_t</font></td>
4003 <td><font size="-1">void</font></td>
4004 <td><font size="-1">double strokeDashOffset_</font></td>
4005 <td>
4006 <font size="-1">
4007 While drawing using a dash pattern, specify
4008 distance into the dash pattern to start the dash (default 0).
4009 </font>
4010 </td>
4011 </tr>
4012 <tr>
4013 <td>
4014 <center><a name="strokeDashArray"></a> <font size="-1">strokeDashArray</font></center>
4015 </td>
4016 <td><font size="-1">const double*</font></td>
4017 <td><font size="-1">void</font></td>
4018 <td><font size="-1">const double* strokeDashArray_</font></td>
4019 <td>
4020 <font size="-1">
4021 Specify the pattern of dashes and gaps used
4022 to stroke paths. The strokeDashArray represents a zero-terminated
4023 array of numbers that specify the lengths (in pixels) of alternating
4024 dashes and gaps in user units. If an odd number of values is provided,
4025 then the list of values is repeated to yield an even number of
4026 values.&#160; A typical strokeDashArray_ array might contain the
4027 members 5 3 2 0, where the zero value indicates the end of the pattern
4028 array.
4029 </font>
4030 </td>
4031 </tr>
4032 <tr>
4033 <td>
4034 <center><a name="strokeLineCap"></a> <font size="-1">strokeLineCap</font></center>
4035 </td>
4036 <td><font size="-1">LineCap</font></td>
4037 <td><font size="-1">void</font></td>
4038 <td><font size="-1">LineCap lineCap_</font></td>
4039 <td>
4040 <font size="-1">
4041 Specify the shape to be used at the corners
4042 of paths (or other vector shapes) when they are stroked. Values of
4043 LineJoin are UndefinedJoin, MiterJoin, RoundJoin, and BevelJoin.
4044 </font>
4045 </td>
4046 </tr>
4047 <tr>
4048 <td>
4049 <center><a name="strokeLineJoin"></a> <font size="-1">strokeLineJoin</font></center>
4050 </td>
4051 <td><font size="-1">LineJoin</font></td>
4052 <td><font size="-1">void</font></td>
4053 <td><font size="-1">LineJoin lineJoin_</font></td>
4054 <td>
4055 <font size="-1">
4056 Specify the shape to be used at the corners
4057 of paths (or other vector shapes) when they are stroked. Values of
4058 LineJoin are UndefinedJoin, MiterJoin, RoundJoin, and BevelJoin.
4059 </font>
4060 </td>
4061 </tr>
4062 <tr>
4063 <td>
4064 <center><a name="strokeMiterLimit"></a> <font size="-1">strokeMiterLimit</font></center>
4065 </td>
4066 <td><font size="-1">size_t</font></td>
4067 <td><font size="-1">void</font></td>
4068 <td><font size="-1">size_t miterLimit_</font></td>
4069 <td>
4070 <font size="-1">
4071 Specify miter limit. When two line segments
4072 meet at a sharp angle and miter joins have been specified for
4073 'lineJoin', it is possible for the miter to extend far beyond the
4074 thickness of the line stroking the path. The miterLimit' imposes a
4075 limit on the ratio of the miter length to the 'lineWidth'. The default
4076 value of this parameter is 4.
4077 </font>
4078 </td>
4079 </tr>
4080 <tr>
4081 <td>
4082 <center><a name="strokeWidth"></a> <font size="-1">strokeWidth</font></center>
4083 </td>
4084 <td><font size="-1">double</font></td>
4085 <td><font size="-1">void</font></td>
4086 <td><font size="-1">double strokeWidth_</font></td>
4087 <td>
4088 <font size="-1">
4089 Stroke width for use when drawing vector
4090 objects (default one)
4091 </font>
4092 </td>
4093 </tr>
4094 <tr>
4095 <td>
4096 <center><a name="strokePattern"></a> <font size="-1">strokePattern</font></center>
4097 </td>
4098 <td><font size="-1">Image</font></td>
4099 <td><font size="-1">void</font></td>
4100 <td><font size="-1">const Image &amp;strokePattern_</font></td>
4101 <td>
4102 <font size="-1">
4103 Pattern image to use while drawing object
4104 stroke (outlines).
4105 </font>
4106 </td>
4107 </tr>
4108 <tr>
4109 <td>
4110 <center><a name="subImage"></a> <font size="-1">subImage</font></center>
4111 </td>
4112 <td><font size="-1">size_t</font></td>
4113 <td><font size="-1">void</font></td>
4114 <td><font size="-1">size_t subImage_</font></td>
4115 <td><font size="-1">Subimage of an image sequence</font></td>
4116 </tr>
4117 <tr>
4118 <td>
4119 <center><a name="subRange"></a> <font size="-1">subRange</font></center>
4120 </td>
4121 <td><font size="-1">size_t</font></td>
4122 <td><font size="-1">void</font></td>
4123 <td><font size="-1">size_t subRange_</font></td>
4124 <td><font size="-1">Number of images relative to the base image</font></td>
4125 </tr>
4126 <tr>
4127 <td valign="middle">
4128 <div style="text-align:center">
4129 <a name="textEncoding"></a> <small>textEncoding</small><br />
4130 </div>
4131 </td>
4132 <td valign="middle">
4133 <small>string</small><small>
4134 <br />
4135 </small>
4136 </td>
4137 <td valign="middle">
4138 <small>void</small><small>
4139 <br />
4140 </small>
4141 </td>
4142 <td valign="middle">
4143 <small>const std::string &amp;encoding_</small><small>
4144 <br />
4145 </small>
4146 </td>
4147 <td valign="top">
4148 <small>
4149 Specify the code set to use for text
4150 annotations. The only character encoding which may be specified at
4151 this time is "UTF-8" for representing
4152 </small><small>
4153 <a href="http://www.unicode.org/">Unicode</a>
4154 </small><small>
4155 as a
4156 sequence of bytes. Specify an empty string to use the default ASCII
4157 encoding. Successful text annotation using Unicode may require fonts
4158 designed to support Unicode.
4159 </small><br />
4160 </td>
4161 </tr>
4162 <tr>
4163 <td>
4164 <center><a name="tileName"></a> <font size="-1">tileName</font></center>
4165 </td>
4166 <td><font size="-1">string</font></td>
4167 <td><font size="-1">void</font></td>
4168 <td><font size="-1">const string &amp;tileName_</font></td>
4169 <td><font size="-1">Tile name</font></td>
4170 </tr>
4171 <tr>
4172 <td>
4173 <center><a name="totalColors"></a> <font size="-1">totalColors</font></center>
4174 </td>
4175 <td><font size="-1">size_t</font></td>
4176 <td><font size="-1">void</font></td>
4177 <td bgcolor="#666666"><font size="-1">&#160;</font></td>
4178 <td><font size="-1">Number of colors in the image</font></td>
4179 </tr>
4180 <tr>
4181 <td>
4182 <center><a name="type"></a> <font size="-1">type</font></center>
4183 </td>
4184 <td>
4185 <font size="-1">
4186 <a href="https://imagemagick.org/Magick++/Enumerations.html#ImageType">ImageType</a>
4187 </font>
4188 </td>
4189 <td><font size="-1">void</font></td>
4190 <td bgcolor="#ffffff">
4191 <font size="-1">
4192 <a href="https://imagemagick.org/Magick++/Enumerations.html#ImageType">ImageType</a>
4193 </font>
4194 </td>
4195 <td><font size="-1">Image type.</font></td>
4196 </tr>
4197 <tr>
4198 <td>
4199 <center><a name="verbose"></a> <font size="-1">verbose</font></center>
4200 </td>
4201 <td><font size="-1">bool</font></td>
4202 <td><font size="-1">void</font></td>
4203 <td><font size="-1">bool verboseFlag_</font></td>
4204 <td><font size="-1">Print detailed information about the image</font></td>
4205 </tr>
4206 <tr>
4207 <td>
4208 <center><a name="view"></a> <font size="-1">view</font></center>
4209 </td>
4210 <td><font size="-1">string</font></td>
4211 <td><font size="-1">void</font></td>
4212 <td><font size="-1">const string &amp;view_</font></td>
4213 <td><font size="-1">FlashPix viewing parameters.</font></td>
4214 </tr>
4215 <tr>
4216 <td>
4217 <center><a name="virtualPixelMethod"></a> <font size="-1">virtualPixelMethod</font></center>
4218 </td>
4219 <td>
4220 <font size="-1">
4221 <a href="https://imagemagick.org/Magick++/Enumerations.html#VirtualPixelMethod">VirtualPixelMethod</a>
4222 </font>
4223 </td>
4224 <td><small><font size="-1"><small>void</small></font></small></td>
4225 <td>
4226 <small>
4227 <font size="-1">
4228 <small>
4229 <a href="https://imagemagick.org/Magick++/Enumerations.html#VirtualPixelMethod">VirtualPixelMethod</a>
4230 virtualPixelMethod_
4231 </small>
4232 </font>
4233 </small>
4234 </td>
4235 <td><font size="-1">Image virtual pixel method.</font></td>
4236 </tr>
4237 <tr>
4238 <td>
4239 <center><a name="x11Display"></a> <font size="-1">x11Display</font></center>
4240 </td>
4241 <td><font size="-1">string (e.g. "hostname:0.0")</font></td>
4242 <td><font size="-1">void</font></td>
4243 <td><font size="-1">const string &amp;display_</font></td>
4244 <td>
4245 <font size="-1">
4246 X11 display to display to, obtain fonts from,
4247 or to capture image from
4248 </font>
4249 </td>
4250 </tr>
4251 <tr>
4252 <td>
4253 <center><a name="xResolution"></a> <font size="-1">xResolution</font></center>
4254 </td>
4255 <td><font size="-1">double</font></td>
4256 <td><font size="-1">void</font></td>
4257 <td bgcolor="#666666"><font size="-1">&#160;</font></td>
4258 <td><font size="-1">x resolution of the image</font></td>
4259 </tr>
4260 <tr>
4261 <td>
4262 <center><a name="yResolution"></a> <font size="-1">yResolution</font></center>
4263 </td>
4264 <td><font size="-1">double</font></td>
4265 <td><font size="-1">void</font></td>
4266 <td bgcolor="#666666"><font size="-1">&#160;</font></td>
4267 <td><font size="-1">y resolution of the image</font></td>
4268 </tr>
4269 </tbody>
4270 </table>
4271 <center>
4272 <h3> <a name="Raw Image Pixel Access"></a> Low-Level Image Pixel Access</h3>
4273 </center>
4274 Image pixels (of type <i><a href="https://imagemagick.org/Magick++/Quantum.html">Quantum</a> </i>)
4275 may be accessed directly via the <i>Image Pixel Cache</i> .&#160; The
4276 image pixel cache is a rectangular window into the actual image pixels
4277 (which may be in memory, memory-mapped from a disk file, or entirely on
4278 disk). Two interfaces exist to access the <i>Image Pixel Cache.</i>
4279 The
4280 interface described here (part of the <i>Image</i> class) supports
4281 only
4282 one view at a time. See the <i><a href="Pixels.html">Pixels</a> </i>
4283 class for a more abstract interface which supports simultaneous pixel
4284 views (up to the number of rows). As an analogy, the interface
4285 described
4286 here relates to the <i><a href="Pixels.html">Pixels</a> </i> class as
4287 stdio's gets() relates to fgets(). The <i>
4288 <a href="Pixels.html"> Pixels</a>
4289 </i>class provides the more general form of the interface.
4290 <p>
4291 Obtain existing image pixels via <i>getPixels()</i>. Create a new
4292 pixel region using <i>setPixels().</i>
4293 </p>
4294 <p>
4295 In order to ensure that only the current generation of the image is
4296 modified, the Image's <a href="Image++.html#modifyImage">modifyImage()</a> method
4297 should be invoked to reduce the reference count on the underlying image
4298 to one. If this is not done, then it is possible for a previous
4299 generation of the image to be modified due to the use of reference
4300 counting when copying or constructing an Image.<br />
4301 </p>
4302 <p>
4303 Depending on the capabilities of the operating system, and the
4304 relationship of the window to the image, the pixel cache may be a copy
4305 of the pixels in the selected window, or it may be the actual image
4306 pixels. In any case calling <i>syncPixels()</i> insures that the base
4307 image is updated with the contents of the modified pixel cache. The
4308 method <i> readPixels()</i> supports copying foreign pixel data
4309 formats
4310 into the pixel cache according to the <i>QuantumTypes</i>. The method <i>writePixels()</i>
4311 supports copying the pixels in the cache to a foreign pixel
4312 representation according to the format specified by <i>QuantumTypes</i>.
4313 </p>
4314 <p>
4315 The pixel region is effectively a small image in which the pixels
4316 may be accessed, addressed, and updated, as shown in the following
4317 example:
4318 </p>
4319 <pre class="code">
4320 <img class="icon" src="Cache.png" name="Graphic1" width="254" border="0" alt="cache" />
4321
4322 Image image("cow.png");
4323 // Ensure that there are no other references to this image.
4324 image.modifyImage();
4325 // Set the image type to TrueColor DirectClass representation.
4326 image.type(TrueColorType);
4327 // Request pixel region with size 60x40, and top origin at 20x30
4328 ssize_t columns = 60;
4329 Quantum *pixel_cache = image.getPixels(20,30,columns,40);
4330 // Set pixel at column 5, and row 10 in the pixel cache to red.
4331 ssize_t column = 5;
4332 ssize_t row = 10;
4333 Quantum *pixel = pixel_cache+row*columns+column;
4334 *pixel = Color("red");
4335 // Save changes to underlying image .
4336 image.syncPixels();
4337 // Save updated image to file.
4338 image.write("horse.png");
4339 </pre>
4340 <p>
4341 The image cache supports the following methods: <br />
4342 &#160;
4343 </p>
4344 <table border="1" width="100%">
4345 <caption>Image Cache Methods</caption>
4346 <tbody>
4347 <tr>
4348 <td>
4349 <center><b>Method</b></center>
4350 </td>
4351 <td>
4352 <center><b>Returns</b></center>
4353 </td>
4354 <td>
4355 <center><b>Signature</b></center>
4356 </td>
4357 <td>
4358 <center><b>Description</b></center>
4359 </td>
4360 </tr>
4361 <tr>
4362 <td>
4363 <center><a name="getConstPixels"></a> <font size="-1">getConstPixels</font></center>
4364 </td>
4365 <td>
4366 <font size="-1">
4367 const <a href="https://imagemagick.org/Magick++/Quantum.html">Quantum</a>
4368 *
4369 </font>
4370 </td>
4371 <td>
4372 <font size="-1">
4373 const ssize_t x_, const ssize_t y_, const size_t
4374 columns_, const size_t rows_
4375 </font>
4376 </td>
4377 <td>
4378 <font size="-1">
4379 Transfers pixels from the image to the pixel
4380 cache as defined by the specified rectangular region.&#160;
4381 </font><font size="-1">
4382 The returned pointer remains valid until the next getPixel,
4383 getConstPixels, or setPixels call and should never be deallocated by
4384 the
4385 user.
4386 </font>
4387 </td>
4388 </tr>
4389 <tr>
4390 <td>
4391 <center><a name="getConstMetacontent"></a> <font size="-1">getConstMetacontent</font></center>
4392 </td>
4393 <td><font size="-1">const void*</font></td>
4394 <td><font size="-1">void</font></td>
4395 <td>
4396 <font size="-1">
4397 Returns a pointer to the Image pixel meta-content
4398 corresponding to a previous
4399 </font><font size="-1">
4400 getPixel(), getConstPixels(), or setPixels() call. &#160;
4401 </font><font size="-1">
4402 The returned pointer remains valid until the next getPixel, getConstPixels,
4403 or setPixels call and should never be deallocated by the user.
4404 </font><font size="-1">
4405 The pixel meta-content represent an array of type void, with each entry
4406 corresponding to an x,y pixel position.
4407 </font>
4408 </td>
4409 </tr>
4410 <tr>
4411 <td>
4412 <center><a name="getMetacontent"></a> <font size="-1">getMetacontent</font></center>
4413 </td>
4414 <td><font size="-1">void*</font></td>
4415 <td><font size="-1">void</font></td>
4416 <td>
4417 <font size="-1">
4418 Returns a pointer to the Image pixel meta-content
4419 corresponding to the pixel region requested by the last <a href="Image++.html#getConstPixels">getConstPixels</a> , <a href="Image++.html#getPixels">getPixels</a>
4420 , or <a href="Image++.html#setPixels">setPixels</a> call.
4421 </font><font size="-1">
4422 The returned pointer remains valid until the next getPixel, getConstPixels,
4423 or setPixels call and should never be deallocated by the user.
4424 </font>
4425 </td>
4426 </tr>
4427 <tr>
4428 <td>
4429 <center><a name="getPixels"></a> <font size="-1">getPixels</font></center>
4430 </td>
4431 <td><font size="-1"><a href="https://imagemagick.org/Magick++/Quantum.html">Quantum</a> *</font></td>
4432 <td>
4433 <font size="-1">
4434 const ssize_t x_, const ssize_t y_, const size_t
4435 columns_, const size_t rows_
4436 </font>
4437 </td>
4438 <td>
4439 <font size="-1">
4440 Transfers pixels from the image to the pixel
4441 cache as defined by the specified rectangular region. Modified pixels
4442 may be subsequently transferred back to the image via syncPixels.
4443 </font><font size="-1">
4444 The returned pointer remains valid until the next getPixel,
4445 getConstPixels(), or setPixels() call and should never be deallocated by
4446 the
4447 user.
4448 </font><font size="-1"></font>
4449 </td>
4450 </tr>
4451 <tr>
4452 <td>
4453 <center><a name="setPixels"></a> <font size="-1">setPixels</font></center>
4454 </td>
4455 <td><font size="-1"><a href="https://imagemagick.org/Magick++/Quantum.html">Quantum</a> *</font></td>
4456 <td>
4457 <font size="-1">
4458 const ssize_t x_, const ssize_t y_, const size_t
4459 columns_, const size_t rows_
4460 </font>
4461 </td>
4462 <td>
4463 <font size="-1">
4464 Allocates a pixel cache region to store image
4465 pixels as defined by the region rectangle.&#160; This area is
4466 subsequently transferred from the pixel cache to the image via
4467 syncPixels.&#160;
4468 </font><font size="-1">
4469 The returned pointer remains
4470 valid until the next getPixel, getConstPixels, or setPixels call and
4471 should never be deallocated by the user.
4472 </font>
4473 </td>
4474 </tr>
4475 <tr>
4476 <td>
4477 <center><a name="syncPixels"></a> <font size="-1">syncPixels</font></center>
4478 </td>
4479 <td><font size="-1">void</font></td>
4480 <td><font size="-1">void</font></td>
4481 <td><font size="-1">Transfers the image cache pixels to the image.</font></td>
4482 </tr>
4483 <tr>
4484 <td>
4485 <center><a name="readPixels"></a> <font size="-1">readPixels</font></center>
4486 </td>
4487 <td><font size="-1">void</font></td>
4488 <td>
4489 <font size="-1">
4490 const <a href="https://imagemagick.org/Magick++/Enumerations.html#QuantumTypes">QuantumType</a>
4491 quantum_, const unsigned char *source_
4492 </font>
4493 </td>
4494 <td>
4495 <font size="-1">
4496 Transfers one or more pixel components from a
4497 buffer or file into the image pixel cache of an image. ReadPixels is
4498 typically used to support image decoders. The region transferred
4499 corresponds to the region set by a preceding setPixels call.
4500 </font>
4501 </td>
4502 </tr>
4503 <tr>
4504 <td>
4505 <center><a name="writePixels"></a> <font size="-1">writePixels</font></center>
4506 </td>
4507 <td><font size="-1">void</font></td>
4508 <td>
4509 <font size="-1">
4510 const <a href="https://imagemagick.org/Magick++/Enumerations.html#QuantumTypes">QuantumType</a>
4511 quantum_, unsigned char *destination_
4512 </font>
4513 </td>
4514 <td>
4515 <font size="-1">
4516 Transfers one or more pixel components from
4517 the image pixel cache to a buffer or file. WritePixels is typically
4518 used to support image encoders. The region transferred corresponds to
4519 the region set by a preceding getPixels or getConstPixels call.
4520 </font>
4521 </td>
4522 </tr>
4523 </tbody>
4524 </table>
4525 </div>
4526 </body>
4527 </html>