forked from ImageMagick/Website
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathSTL.html
More file actions
1909 lines (1903 loc) · 82.6 KB
/
Copy pathSTL.html
File metadata and controls
1909 lines (1903 loc) · 82.6 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Magick++ API: STL Templates</title>
<link rel="stylesheet" href="magick.css" type="text/css" />
</head>
<body>
<div class="doc-section">
<h1> Magick++ STL Support</h1>
Magick++ provides a set of <a href="http://www.sgi.com/tech/stl/">Standard
Template Library</a> (<a href="http://www.sgi.com/tech/stl/">STL</a> )
algorithms for operating across ranges of image frames in a container.
It also provides a set of STL unary function objects to apply an
operation on image frames in a container via an algorithm which uses
unary function objects. A good example of a standard algorithm which is
useful for processing containers of image frames is the STL <i><a
href="http://www.sgi.com/tech/stl/for_each.html"> for_each</a> </i>
algorithm which invokes a unary function object on a range of container
elements.
<p>Magick++ uses a limited set of template argument types. The current
template argument types are: </p>
<a href="http://www.sgi.com/tech/stl/Container.html">Container</a>
<blockquote>A container having the properties of a <a
href="http://www.sgi.com/tech/stl/BackInsertionSequence.html"> Back
Insertion Sequence</a> . Sequences support forward iterators and Back
Insertion Sequences support the additional ability to append an element
via push_back(). Common compatible container types are the STL <<a
href="http://www.sgi.com/tech/stl/Vector.html"> vector</a> > and <<a
href="http://www.sgi.com/tech/stl/List.html">list</a> > template
containers. This template argument is usually used to represent an
output container in which one or more image frames may be appended.
Containers like STL <<a href="http://www.sgi.com/tech/stl/Vector.html">vector</a>
> which have a given default <i>capacity</i> may need to have their <i>
capacity</i> adjusted via r<i>eserve() </i>to a larger <i>capacity</i>
in order to support the expected final <i>size</i> . Since Magick++
images are very small, it is likely that the default capacity of STL <<a
href="http://www.sgi.com/tech/stl/Vector.html"> vector</a> > is
sufficient for most situations.</blockquote>
<a href="http://www.sgi.com/tech/stl/InputIterator.html">InputIterator</a>
<blockquote>An input iterator used to express a position in a
container. These template arguments are typically used to represent a
range of elements with f<i>irst_</i> representing the first element to
be processed and <i> last_</i> representing the element to stop at. When
processing the entire contents of a container, it is handy to know that
STL containers usually provide the begin() and end() methods to return
input iterators which correspond with the first and last elements,
respectively.</blockquote>
<p>The following is an example of how frames from a GIF animation <font
color="#000000"> "test_image_anim.gif" may be appended horizontally
with the resulting image written to the file <kbd>appended_image.miff</kbd>:</font></p>
<pre class="code">
#include <list>
#include <Magick++.h>
using namespace std;
using namespace Magick;
int main(int argc,char **argv)
{
InitializeMagick(*argv);
list<Image> imageList;
readImages( &imageList, "test_image_anim.gif" );
Image appended;
appendImages( &appended, imageList.begin(), imageList.end() );
appended.write( "appended_image.miff" );
return 0;
}
</pre>
<p>The available Magick++ specific STL algorithms for operating on
sequences of image frames are shown in the following table: <br />
 
<ul><table border="1" width="100%">
<caption><b>Magick++ STL Algorithms For Image Sequences</b></caption> <tbody>
<tr>
<td>
<center><b>Algorithm</b></center>
</td>
<td>
<center><b>Signature</b></center>
</td>
<td>
<center><b>Description</b></center>
</td>
</tr>
<tr>
<td>
<center><a name="animateImages"></a> <font size="-1">animateImages</font></center>
</td>
<td><font size="-1"><a
href="http://www.sgi.com/tech/stl/InputIterator.html"> InputIterator</a>
first_, <a href="http://www.sgi.com/tech/stl/InputIterator.html">InputIterator</a>
last_</font></td>
<td><font size="-1">Animate a sequence of image frames. Image
frames are displayed in succession, creating an animated effect. The
animation options are taken from the first image frame. This feature is
only supported under X11 at the moment.</font></td>
</tr>
<tr>
<td>
<center><a name="appendImages"></a> <font size="-1">appendImages</font></center>
</td>
<td><font size="-1"><a href="Image++.html">Image</a>
*appendedImage_, <a
href="http://www.sgi.com/tech/stl/InputIterator.html"> InputIterator</a>
first_, <a href="http://www.sgi.com/tech/stl/InputIterator.html">InputIterator</a>
last_, bool stack_ = false</font></td>
<td><font size="-1">Append a sequence of image frames, writing
the result to <i>appendedImage_.</i> All the input image frames must
have the same width or height. Image frames of the same width are
stacked top-to-bottom. Image frames of the same height are stacked
left-to-right. If the <i>stack_</i> parameter is false, rectangular
image frames are stacked left-to-right otherwise top-to-bottom.</font></td>
</tr>
<tr>
<td>
<center><a name="averageImages"></a> <font size="-1">averageImages</font></center>
</td>
<td><font size="-1"><a href="Image++.html">Image</a>
*averagedImage_, <a
href="http://www.sgi.com/tech/stl/InputIterator.html"> InputIterator</a>
first_, <a href="http://www.sgi.com/tech/stl/InputIterator.html">InputIterator</a>
last_</font></td>
<td><font size="-1">Average a sequence of image frames, writing
the result to <i>averagedImage_</i>. All the input image frames must
be the same size in pixels.</font></td>
</tr>
<tr>
<td>
<center><a name="coalesceImages"></a> <font size="-1">coalesceImages</font></center>
</td>
<td><font size="-1"><a
href="http://www.sgi.com/tech/stl/Container.html"> Container</a>
*coalescedImages_, <a
href="http://www.sgi.com/tech/stl/InputIterator.html"> InputIterator</a>
first_, <a href="http://www.sgi.com/tech/stl/InputIterator.html">InputIterator</a>
last_</font><br />
</td>
<td><font size="-1">Create a coalesced image sequence obtained by
"playing" the image sequence (observing page offsets and disposal
methods) to create a new image sequence in which all frames are full
size and completely rendered. Note that if the original image sequence
relied on page offsets and disposal methods that the resulting sequence
will be larger (perhaps much larger) then the original. This is useful
for GIF animation sequences that have page offsets and disposal methods.
The resulting image sequence is returned via <i>coalescedImages_.</i></font></td>
</tr>
<tr>
<td>
<center><a name="deconstructImages"></a> <font size="-1">deconstructImages</font></center>
</td>
<td><font size="-1"><a
href="http://www.sgi.com/tech/stl/Container.html"> Container</a>
*deconstructedImages_, <a
href="http://www.sgi.com/tech/stl/InputIterator.html"> InputIterator</a>
first_, <a href="http://www.sgi.com/tech/stl/InputIterator.html">InputIterator</a>
last_</font></td>
<td><font size="-1">Break down an image sequence into constituent
parts.  This is useful for creating GIF or MNG animation sequences.
The input sequence is specified by <i>first_</i> and <i>last_</i>, and
the deconstructed images are returned via <i>deconstructedImages_</i>.</font></td>
</tr>
<tr>
<td>
<center><a name="displayImages"></a> <font size="-1">displayImages</font></center>
</td>
<td><font size="-1"><a
href="http://www.sgi.com/tech/stl/InputIterator.html"> InputIterator</a>
first_, <a href="http://www.sgi.com/tech/stl/InputIterator.html">InputIterator</a>
last_</font></td>
<td><font size="-1">Display a sequence of image frames. Through
use of a pop-up menu, image frames may be selected in succession. This
feature is fully supported under X11 but may have only limited support
in other environments.</font> <br />
<font size="-1"><b><font color="#ff0000">Caution: </font></b> if
an image format is not compatible with the display visual (e.g. JPEG
on a colormapped display) then the original image will be altered. Use a
copy of the original if this is a problem.</font></td>
</tr>
<tr>
<td>
<center><a name="flattenImages"></a> <font size="-1">flattenImages</font></center>
</td>
<td><font size="-1"><a href="Image++.html">Image</a>
*flattendImage_, <a
href="http://www.sgi.com/tech/stl/InputIterator.html"> InputIterator</a>
first_, <a href="http://www.sgi.com/tech/stl/InputIterator.html">InputIterator</a>
last_</font></td>
<td><font size="-1">Merge a sequence of image frames which
represent image layers into a single composited representation. The <i>flattendImage_</i>
parameter points to an existing Image to update with the flattened
image. This function is useful for combining Photoshop layers into a
single image.</font></td>
</tr>
<tr>
<td>
<center><a name="forwardFourierTransformImage"></a> <font size="-1">forwardFourierTransformImage</font></center>
</td>
<td><font size="-1"><a
href="http://www.sgi.com/tech/stl/Container.html"> Container</a>
*fourierImages_, const Image &image_ </font></td>
<td><font size="-1"> Implements the discrete Fourier transform (DFT) of the image as a magnitude / phase image pair via <i>fourierImages_</i>.</font></td>
</tr>
<tr>
<td>
<center><a name="forwardFourierTransformImage"></a> <font size="-1">forwardFourierTransformImage</font></center>
</td>
<td><font size="-1"><a
href="http://www.sgi.com/tech/stl/Container.html"> Container</a>
*fourierImages_, const Image &image_, const bool magnitude_ </font></td>
<td><font size="-1"> Implements the discrete Fourier transform (DFT) of the image either as a magnitude / phase or real / imaginary image pair via <i>fourierImages_</i>.</font></td>
</tr>
<tr>
<td>
<center><a name="mapImages"></a> <font size="-1">mapImages</font></center>
</td>
<td><font size="-1"><a
href="http://www.sgi.com/tech/stl/InputIterator.html"> InputIterator</a>
first_, <a href="http://www.sgi.com/tech/stl/InputIterator.html">InputIterator</a>
last_, const <a href="Image++.html">Image</a> & mapImage_, bool
dither_,  bool measureError_ = false</font></td>
<td><font size="-1">Replace the colors of a sequence of images
with the closest color from a reference image. Set <i>dither_</i> to <i>true</i>
to enable dithering.  Set <i>measureError_</i> to <i>true</i> in
order to evaluate quantization error.</font></td>
</tr>
<tr>
<td>
<center><a name="montageImages"></a> <font size="-1">montageImages</font></center>
</td>
<td><font size="-1"><a
href="http://www.sgi.com/tech/stl/Container.html"> Container</a>
*montageImages_, <a
href="http://www.sgi.com/tech/stl/InputIterator.html"> InputIterator</a>
first_, <a href="http://www.sgi.com/tech/stl/InputIterator.html">InputIterator</a>
last_, const <a href="Montage.html">Montage</a> &montageOpts_</font></td>
<td><font size="-1">Create a composite image by combining several
separate image frames. Multiple frames may be generated in the output
container <i> montageImages_ </i>depending on the tile setting and the
number of image frames montaged. Montage options are provided via the
parameter <i>montageOpts_</i> . Options set in the first image frame (<a
href="Image++.html#backgroundColor"> backgroundColor,</a> <a
href="Image++.html#borderColor">borderColor</a> , <a
href="Image++.html#matteColor">matteColor</a> , <a
href="Image++.html#penColor">penColor,</a> <a href="Image++.html#font">font,</a>
and <a href="Image++.html#fontPointsize">fontPointsize</a> ) are also used
as options by <i>montageImages().</i></font></td>
</tr>
<tr>
<td>
<center><a name="morphImages"></a> <font size="-1">morphImages</font></center>
</td>
<td><font size="-1"><a
href="http://www.sgi.com/tech/stl/Container.html"> Container</a>
*morphedImages_, <a
href="http://www.sgi.com/tech/stl/InputIterator.html"> InputIterator</a>
first_, <a href="http://www.sgi.com/tech/stl/InputIterator.html">InputIterator</a>
last_, size_t frames_</font></td>
<td><font size="-1">Morph a sequence of image frames. This
algorithm  expands the number of image frames (output to the
container <i>morphedImages_)</i> by adding the number of intervening
frames specified by <i>frames_</i> such that the original frames morph
(blend) into each other when played as an animation.</font></td>
</tr>
<tr>
<td>
<center><a name="mosaicImages"></a> <font size="-1">mosaicImages</font></center>
</td>
<td><font size="-1"><a href="Image++.html">Image</a> *mosaicImage_, <a
href="http://www.sgi.com/tech/stl/InputIterator.html"> InputIterator</a>
first_, <a href="http://www.sgi.com/tech/stl/InputIterator.html">InputIterator</a>
last_</font></td>
<td><font size="-1">Inlay a number of images to form a single
coherent picture. The <i>mosicImage_</i> argument is updated with a
mosaic constructed from the image sequence represented by <i>first_</i>
through <i>last_</i> .</font></td>
</tr>
<tr>
<td><center><a name="quantizeImages"></a> <font size="-1">quantizeImages</font></center></td>
<td><font size="-1"><a
href="http://www.sgi.com/tech/stl/InputIterator.html"> InputIterator</a>
first_, <a href="http://www.sgi.com/tech/stl/InputIterator.html">InputIterator</a>
last_, bool measureError_ = false</font></td>
<td><font size="-1">Quantize colors in images using current
quantization settings. Set <i>measureError_</i> to <i>true</i> in order
to measure quantization error.</font></td>
</tr>
<tr>
<td rowspan="2">
<center><a name="readImages"></a> <font size="-1">readImages</font></center>
</td>
<td><font size="-1"><a
href="http://www.sgi.com/tech/stl/Container.html"> Container</a>
*sequence_, const std::string &imageSpec_</font></td>
<td><font size="-1">Read a sequence of image frames into existing
container (appending to container <i>sequence_</i>) with image names
specified in the UTF-8 string <i>imageSpec_</i>.</font></td>
</tr>
<tr>
<td><font size="-1"><a
href="http://www.sgi.com/tech/stl/Container.html"> Container</a>
*sequence_, const <a href="Blob.html">Blob</a> &blob_</font></td>
<td><font size="-1">Read a sequence of image frames into existing
container (appending to container sequence_) from <a href="Blob.html">Blob</a>
blob_.</font></td>
</tr>
<tr>
<td rowspan="2">
<center><a name="writeImages"></a> <font size="-1">writeImages</font></center>
</td>
<td><font size="-1"><a
href="http://www.sgi.com/tech/stl/InputIterator.html"> InputIterator</a>
first_, <a href="http://www.sgi.com/tech/stl/InputIterator.html">InputIterator</a>
last_, const std::string &imageSpec_, bool adjoin_ = true</font></td>
<td><font size="-1">Write images in container to file specified
by string <i>imageSpec_</i>. Set <i>adjoin_ </i>to false to write a
set of image frames via a wildcard <i>imageSpec_ </i>(e.g.
image%02d.miff).</font> <br />
The wildcard must be one of <tt>%0Nd, %0No, or %0Nx</tt>. <br />
<font size="-1"><b><font color="#ff0000">Caution: </font></b> if
an image format is selected which is capable of supporting fewer colors
than the original image or quantization has been requested, the original
image will be quantized to fewer colors. Use a copy of the original if
this is a problem.</font></td>
</tr>
<tr>
<td><font size="-1"><a
href="http://www.sgi.com/tech/stl/InputIterator.html"> InputIterator</a>
first_, <a href="http://www.sgi.com/tech/stl/InputIterator.html">InputIterator</a>
last_, <a href="Blob.html">Blob</a> *blob_, bool adjoin_ = true</font></td>
<td><font size="-1">Write images in container to in-memory BLOB
specified by <a href="Blob.html">Blob</a> blob_. Set adjoin_ to false to
write a set of image frames via a wildcard imageSpec_ (e.g.
image%02d.miff).</font> <br />
<font size="-1"><b><font color="#ff0000">Caution:</font></b> if an
image format is selected which is capable of supporting fewer colors
than the original image or quantization has been requested, the original
image will be quantized to fewer colors. Use a copy of the original if
this is a problem.</font></td>
</tr>
</tbody>
</table></ul>
<p>In addition, we support these yet to be documented methods: <code>combineImages()</code>, <code>evaluateImages()</code>, <code>mergeImageLayers()</code>, <code>optimizeImageLayers()</code>, <code>optimizePlusImageLayers()</code>, and <code>separateImages()</code>.</p>
<br />
  </p>
<center>
<h3> Magick++ Unary Function Objects</h3>
</center>
Magick++ unary function objects inherit from the STL unary_function
template class . The STL unary_function template class is of the form
<pre class="text"><tt><font color="#000099">unary_function<Arg, Result></font></tt></pre>
and expects that derived classes implement a method of the form:
<pre class="text"><tt><font color="#000099">Result operator()( Arg argument_);</font></tt></pre>
which is invoked by algorithms using the function object. In the case
of unary function objects defined by Magick++, the invoked function
looks like:
<pre class="text"><tt><font color="#000099">void operator()( Image &image_);</font></tt></pre>
with a typical implementation looking similar to:
<pre class="text"><tt><font color="#000099">void operator()( Image &image_ )</font></tt> <br />
<tt><font color="#000099">  {</font></tt> <br />
<tt><font color="#000099">    image_.contrast(
_sharpen );</font></tt> <br />
<tt><font color="#000099">  }</font></tt></pre>
where <i>contrast</i> is an Image method and <i>_sharpen </i>is an
argument stored within the function object by its constructor. Since
constructors may be polymorphic, a given function object may have
several constructors and selects the appropriate Image method based on
the arguments supplied.
<p>In essence, unary function objects (as provided by Magick++) simply
provide the means to construct an object which caches arguments for
later use by an algorithm designed for use with unary function objects.
There is a unary function object corresponding each algorithm provided
by the <a href="Image++.html"> Image</a> class and there is a constructor
available compatible with each synonymous method in the Image class. </p>
<p>The unary function objects that Magick++ provides to support
manipulating images are shown in the following table: <br />
 
<ul><table border="1">
<caption><b>Magick++ Unary Function Objects For Image Manipulation</b></caption> <tbody>
<tr align="center">
<td><b>Function Object</b></td>
<td><b>Constructor Signatures(s)</b></td>
<td><b>Description</b></td>
</tr>
<tr>
<td valign="middle">
<div align="center"><a name="adaptiveThresholdImage"></a> <font
size="-1">adaptiveThresholdImage</font><br />
</div>
</td>
<td valign="middle"><font size="-1">size_t width, size_t
height, unsigned offset = 0</font><br />
</td>
<td valign="top"><font size="-1">Apply adaptive thresholding to
the image. Adaptive thresholding is useful if the ideal threshold level
is not known in advance, or if the illumination gradient is not constant
across the image. Adaptive thresholding works by evaluating the mean
(average) of a pixel region (size specified by <i>width</i> and <i>height</i>)
and using the mean as the thresholding value. In order to remove
residual noise from the background, the threshold may be adjusted by
subtracting a constant <i>offset</i> (default zero) from the mean to
compute the threshold.</font><br />
</td>
</tr>
<tr>
<td>
<center><a name="addNoiseImage"></a> <font size="-1">addNoiseImage</font></center>
</td>
<td><font size="-1"><a href="Enumerations.html#NoiseType">NoiseType</a>
noiseType_</font></td>
<td><font size="-1">Add noise to image with specified noise type.</font></td>
</tr>
<tr>
<td style="vertical-align: middle;"><small><a
name="affineTransformImage"></a>affineTransformImage<br />
</small></td>
<td style="vertical-align: middle;"><small>const DrawableAffine
&affine_<br />
</small></td>
<td style="vertical-align: middle;"><small>Transform image by
specified affine (or free transform) matrix.<br />
</small></td>
</tr>
<tr>
<td rowspan="4">
<center><a name="annotateImage"></a> <font size="-1">annotateImage</font></center>
</td>
<td><font size="-1">const std::string &text_, const <a
href="Geometry.html"> Geometry</a> &location_</font></td>
<td><font size="-1">Annotate with text using specified text,
bounding area, placement gravity, and rotation. If <i>boundingArea_</i>
is invalid, then bounding area is entire image.</font></td>
</tr>
<tr>
<td><font size="-1">std::string text_, const <a
href="Geometry.html">Geometry</a> &boundingArea_, <a
href="Enumerations.html#GravityType">GravityType</a> gravity_</font></td>
<td><font size="-1">Annotate using specified text, bounding area,
and placement gravity. If <i>boundingArea_</i> is invalid, then
bounding area is entire image.</font></td>
</tr>
<tr>
<td><font size="-1">const std::string &text_, const <a
href="Geometry.html"> Geometry</a> &boundingArea_, <a
href="Enumerations.html#GravityType">GravityType</a> gravity_, double
degrees_, </font></td>
<td><font size="-1">Annotate with text using specified text,
bounding area, placement gravity, and rotation. If <i>boundingArea_</i>
is invalid, then bounding area is entire image.</font></td>
</tr>
<tr>
<td><font size="-1">const std::string &text_, <a
href="Enumerations.html#GravityType"> GravityType</a> gravity_</font></td>
<td><font size="-1">Annotate with text (bounding area is entire
image) and placement gravity.</font></td>
</tr>
<tr>
<td>
<center><a name="blurImage"></a> <font size="-1">blurImage</font></center>
</td>
<td><font size="-1">const double radius_ = 1, const double sigma_
= 0.5</font></td>
<td><font size="-1">Blur image. The radius_ parameter specifies
the radius of the Gaussian, in pixels, not counting the center
pixel.  The sigma_ parameter specifies the standard deviation of
the Laplacian, in pixels.</font></td>
</tr>
<tr>
<td>
<center><a name="borderImage"></a> <font size="-1">borderImage</font></center>
</td>
<td><font size="-1">const <a href="Geometry.html">Geometry</a>
&geometry_ = "6x6+0+0"</font></td>
<td><font size="-1">Border image (add border to image).  The
color of the border is specified by the <i>borderColor</i> attribute.</font></td>
</tr>
<tr>
<td>
<center><a name="charcoalImage"></a> <font size="-1">charcoalImage</font></center>
</td>
<td><font size="-1">const double radius_ = 1, const double sigma_
= 0.5</font></td>
<td><font size="-1">Charcoal effect image (looks like charcoal
sketch). The radius_ parameter specifies the radius of the Gaussian, in
pixels, not counting the center pixel.  The sigma_ parameter
specifies the standard deviation of the Laplacian, in pixels.</font></td>
</tr>
<tr>
<td>
<center><a name="chopImage"></a> <font size="-1">chopImage</font></center>
</td>
<td><font size="-1">const <a href="Geometry.html">Geometry</a>
&geometry_</font></td>
<td><font size="-1">Chop image (remove vertical or horizontal
subregion of image)</font></td>
</tr>
<tr>
<td rowspan="2">
<center><a name="colorizeImage"></a> <font size="-1">colorizeImage</font></center>
</td>
<td><font size="-1">const size_t opacityRed_, const
size_t opacityGreen_, const size_t opacityBlue_, const Color
&penColor_</font></td>
<td><font size="-1">Colorize image with pen color, using
specified percent opacity for red, green, and blue quantums.</font></td>
</tr>
<tr>
<td><font size="-1">const size_t opacity_, const <a
href="Color.html"> Color</a> &penColor_</font></td>
<td><font size="-1">Colorize image with pen color, using
specified percent opacity.</font></td>
</tr>
<tr>
<td>
<center><a name="commentImage"></a> <font size="-1">commentImage</font></center>
</td>
<td><font size="-1">const std::string &comment_</font></td>
<td><font size="-1">Comment image (add comment string to
image).  By default, each image is commented with its file name.
Use  this  method to  assign a specific comment to the
image.  Optionally you can include the image filename, type, width,
height, or other  image  attributes by embedding <a
href="FormatCharacters.html">special format characters.</a> </font></td>
</tr>
<tr>
<td rowspan="2">
<center><a name="compositeImage"></a> <font size="-1">compositeImage</font></center>
</td>
<td><font size="-1">const <a href="Image++.html">Image</a>
&compositeImage_, ssize_t xOffset_, ssize_t yOffset_, <a
href="Enumerations.html#CompositeOperator"> CompositeOperator</a>
compose_ = <i>InCompositeOp</i></font></td>
<td rowspan="2"><font size="-1">Compose an image onto another at
specified offset and using specified algorithm</font></td>
</tr>
<tr>
<td><font size="-1">const <a href="Image++.html">Image</a>
&compositeImage_, const Geometry &offset_, <a
href="Enumerations.html#CompositeOperator"> CompositeOperator</a>
compose_ = <i>InCompositeOp</i></font></td>
</tr>
<tr>
<td>
<center><a name="condenseImage"></a> <font size="-1">condenseImage</font></center>
</td>
<td><font size="-1">void</font></td>
<td><font size="-1">Condense image (Re-run-length encode image in
memory).</font></td>
</tr>
<tr>
<td>
<center><a name="contrastImage"></a> <font size="-1">contrastImage</font></center>
</td>
<td><font size="-1">size_t sharpen_</font></td>
<td><font size="-1">Contrast image (enhance intensity differences
in image)</font></td>
</tr>
<tr>
<td>
<center><a name="cropImage"></a> <font size="-1">cropImage</font></center>
</td>
<td><font size="-1">const <a href="Geometry.html">Geometry</a>
&geometry_</font></td>
<td><font size="-1">Crop image (subregion of original image)</font></td>
</tr>
<tr>
<td>
<center><a name="cycleColormapImage"></a> <font size="-1">cycleColormap-</font> <br />
<font size="-1">Image</font></center>
</td>
<td><font size="-1">int amount_</font></td>
<td><font size="-1">Cycle image colormap</font></td>
</tr>
<tr>
<td>
<center><a name="despeckleImage"></a> <font size="-1">despeckleImage</font></center>
</td>
<td><font size="-1">void</font></td>
<td><font size="-1">Despeckle image (reduce speckle noise)</font></td>
</tr>
<tr>
<td rowspan="2">
<center><a name="drawImage"></a> <font size="-1">drawImage</font></center>
</td>
<td><font size="-1">const <a href="Drawable.html">Drawable</a>
&drawable_</font></td>
<td><font size="-1">Draw shape or text on image.</font></td>
</tr>
<tr>
<td><font size="-1">const std::list<<a href="Drawable.html">Drawable</a>
> &drawable_</font></td>
<td><font size="-1">Draw shapes or text on image using a set of
Drawable objects contained in an STL list. Use of this method improves
drawing performance and allows batching draw objects together in a list
for repeated use.</font></td>
</tr>
<tr>
<td>
<center><a name="edgeImage"></a> <font size="-1">edgeImage</font></center>
</td>
<td><font size="-1">size_t radius_ = 0.0</font></td>
<td><font size="-1">Edge image (hilight edges in image). 
The radius is the radius of the pixel neighborhood.. Specify a radius
of zero for automatic radius selection.</font></td>
</tr>
<tr>
<td>
<center><a name="embossImage"></a> <font size="-1">embossImage</font></center>
</td>
<td><font size="-1">const double radius_ = 1, const double sigma_
= 0.5</font></td>
<td><font size="-1">Emboss image (hilight edges with 3D effect).
The radius_ parameter specifies the radius of the Gaussian, in pixels,
not counting the center pixel.  The sigma_ parameter specifies the
standard deviation of the Laplacian, in pixels.</font></td>
</tr>
<tr>
<td>
<center><a name="enhanceImage"></a> <font size="-1">enhanceImage</font></center>
</td>
<td><font size="-1">void</font></td>
<td><font size="-1">Enhance image (minimize noise)</font></td>
</tr>
<tr>
<td>
<center><a name="equalizeImage"></a> <font size="-1">equalizeImage</font></center>
</td>
<td><font size="-1">void</font></td>
<td><font size="-1">Equalize image (histogram equalization)</font></td>
</tr>
<tr>
<td>
<center><a name="flipImage"></a> <font size="-1">flipImage</font></center>
</td>
<td><font size="-1">void</font></td>
<td><font size="-1">Flip image (reflect each scanline in the
vertical direction)</font></td>
</tr>
<tr>
<td rowspan="4">
<center><a name="floodFillColorImage"></a> <font size="-1">floodFill-</font> <br />
<font size="-1">ColorImage</font></center>
</td>
<td><font size="-1">ssize_t x_, ssize_t y_, const <a
href="Color.html"> Color</a> &fillColor_</font></td>
<td rowspan="2"><font size="-1">Flood-fill color across pixels
that match the color of the target pixel and are neighbors of the
target pixel. Uses current fuzz setting when determining color match.</font></td>
</tr>
<tr>
<td><font size="-1">const <a href="Geometry.html">Geometry</a>
&point_, const <a href="Color.html">Color</a> &fillColor_</font></td>
</tr>
<tr>
<td><font size="-1">ssize_t x_, ssize_t y_, const <a
href="Color.html"> Color</a> &fillColor_, const <a href="Color.html">Color</a>
&borderColor_</font></td>
<td rowspan="2"><font size="-1">Flood-fill color across pixels
starting at target-pixel and stopping at pixels matching specified
border color. Uses current fuzz setting when determining color match.</font></td>
</tr>
<tr>
<td><font size="-1">const <a href="Geometry.html">Geometry</a>
&point_, const <a href="Color.html">Color</a> &fillColor_, const <a
href="Color.html">Color</a> &borderColor_</font></td>
</tr>
<tr>
<td rowspan="4">
<center><a name="floodFillTextureImage"></a> <font size="-1">floodFill-</font> <br />
<font size="-1">TextureImage</font></center>
</td>
<td><font size="-1">ssize_t x_, ssize_t y_,  const <a
href="Image++.html"> Image</a> &texture_</font></td>
<td rowspan="2"><font size="-1">Flood-fill texture across pixels
that match the color of the target pixel and are neighbors of the
target pixel. Uses current fuzz setting when determining color match.</font></td>
</tr>
<tr>
<td><font size="-1">const <a href="Geometry.html">Geometry</a>
&point_, const Image &texture_</font></td>
</tr>
<tr>
<td><font size="-1">ssize_t x_, ssize_t y_, const Image
&texture_, const <a href="Color.html">Color</a> &borderColor_</font></td>
<td rowspan="2"><font size="-1">Flood-fill texture across pixels
starting at target-pixel and stopping at pixels matching specified
border color. Uses current fuzz setting when determining color match.</font></td>
</tr>
<tr>
<td><font size="-1">const <a href="Geometry.html">Geometry</a>
&point_, const Image &texture_, const <a href="Color.html">Color</a>
&borderColor_</font></td>
</tr>
<tr>
<td>
<center><a name="flopImage"></a> <font size="-1">flopImage</font></center>
</td>
<td><font size="-1">void </font></td>
<td><font size="-1">Flop image (reflect each scanline in the
horizontal direction)</font></td>
</tr>
<tr>
<td rowspan="2">
<center><a name="frameImage"></a> <font size="-1">frameImage</font></center>
</td>
<td><font size="-1">const <a href="Geometry.html">Geometry</a>
&geometry_ = "25x25+6+6"</font></td>
<td rowspan="2"><font size="-1">Add decorative frame around image</font></td>
</tr>
<tr>
<td><font size="-1">size_t width_, size_t height_,
ssize_t x_, ssize_t y_, ssize_t innerBevel_ = 0, ssize_t outerBevel_ = 0</font></td>
</tr>
<tr>
<td rowspan="2">
<center><a name="gammaImage"></a> <font size="-1">gammaImage</font></center>
</td>
<td><font size="-1">double gamma_</font></td>
<td><font size="-1">Gamma correct image (uniform red, green, and
blue correction).</font></td>
</tr>
<tr>
<td><font size="-1">double gammaRed_, double gammaGreen_, double
gammaBlue_</font></td>
<td><font size="-1">Gamma correct red, green, and blue channels
of image.</font></td>
</tr>
<tr>
<td>
<center><a name="gaussianBlur"></a> <font size="-1">gaussianBlurImage</font></center>
</td>
<td><font size="-1">double width_, double sigma_</font></td>
<td><font size="-1">Gaussian blur image. The number of neighbor
pixels to be included in the convolution mask is specified by
'width_'.  For example, a width of one gives a (standard) 3x3
convolution mask. The standard deviation of the gaussian bell curve is
specified by 'sigma_'.</font></td>
</tr>
<tr>
<td>
<center><a name="implodeImage"></a> <font size="-1">implodeImage</font></center>
</td>
<td><font size="-1">double factor_</font></td>
<td><font size="-1">Implode image (special effect)</font></td>
</tr>
<tr>
<td>
<center><a name="inverseFourierTransformImage"></a> <font size="-1">inverseFourierTransformImage</font></center>
</td>
<td><font size="-1">const <a href="Image++.html">Image</a>
&phaseImage_, const bool magnitude_</font></td>
<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>
</tr>
<tr>
<td>
<center><a name="labelImage"></a> <font size="-1">labelImage</font></center>
</td>
<td><font size="-1">const string &label_</font></td>
<td><font size="-1">Assign a label to an image. Use this option
to  assign  a  specific label to the image. Optionally
you can include the image filename, type, width, height, or scene
number in the label by embedding  <a href="FormatCharacters.html">special
format characters.</a> If the first character of string is @, the image
label is read from a file titled by the remaining characters in the
string. When converting to Postscript, use this  option to specify
a header string to print above the image.</font></td>
</tr>
<tr>
<td style="text-align: center; vertical-align: middle;"><small><a
name="levelImage"></a>levelImage<br />
</small></td>
<td style="vertical-align: top;"><small>const double black_point,
const double white_point, const double mid_point=1.0<br />
</small></td>
<td style="vertical-align: top;"><small>Level image. Adjust the
levels of the image by scaling the colors falling between specified
white and black points to the full available quantum range. The
parameters provided represent the black, mid (gamma), and white
points.  The black point specifies the darkest color in the image.
Colors darker than the black point are set to zero. Mid point (gamma)
specifies a gamma correction to apply to the image. White point
specifies the lightest color in the image.  Colors brighter than
the white point are set to the maximum quantum value. The black and
white point have the valid range 0 to QuantumRange while mid (gamma) has a
useful range of 0 to ten.</small></td>
</tr>
<tr>
<td style="text-align: center; vertical-align: middle;"><small><a
name="levelChannelImage"></a>levelChannelImage<br />
</small></td>
<td style="vertical-align: top;"><small>const Magick::ChannelType
channel, const double black_point, const double white_point, const
double mid_point=1.0<br />
</small></td>
<td style="vertical-align: top;"><small>Level image channel.
Adjust the levels of the image channel by scaling the values falling
between specified white and black points to the full available quantum
range. The parameters provided represent the black, mid (gamma), and
white points. The black point specifies the darkest color in the image.
Colors darker than the black point are set to zero. Mid point (gamma)
specifies a gamma correction to apply to the image. White point
specifies the lightest color in the image. Colors brighter than the
white point are set to the maximum quantum value. The black and white
point have the valid range 0 to QuantumRange while mid (gamma) has a useful
range of 0 to ten.</small></td>
</tr>
<tr>
<td>
<center><a name="layerImage"></a> <font size="-1">layerImage</font></center>
</td>
<td><font size="-1"><a href="Enumerations.html#ChannelType">ChannelType</a>
layer_</font></td>
<td><font size="-1">Extract layer from image. Use this option to
extract a particular layer from  the image.  <i>MatteLayer</i>, 
for  example, is useful for extracting the opacity values from an
image.</font></td>
</tr>
<tr>
<td>
<center><a name="magnifyImage"></a> <font size="-1">magnifyImage</font></center>
</td>
<td><font size="-1">void</font></td>
<td><font size="-1">Magnify image by integral size</font></td>
</tr>
<tr>
<td>
<center><a name="mapImage"></a> <font size="-1">mapImage</font></center>
</td>
<td><font size="-1">const <a href="Image++.html">Image</a>
&mapImage_ , bool dither_ = false</font></td>
<td><font size="-1">Remap image colors with closest color from
reference image. Set dither_ to <i>true</i> in to apply Floyd/Steinberg
error diffusion to the image. By default, color reduction chooses an
optimal  set  of colors that best represent the original
image. Alternatively, you can  choose  a 
particular  set  of colors  from  an image file
with this option.</font></td>
</tr>
<tr>
<td>
<center><a name="matteFloodfillImage"></a> <font size="-1">matteFloodfill-</font> <br />
<font size="-1">Image</font></center>
</td>
<td><font size="-1">const <a href="Color.html">Color</a>
&target_, unsigned int matte_, ssize_t x_, ssize_t y_, <a
href="Enumerations.html#PaintMethod"> PaintMethod</a> method_</font></td>
<td><font size="-1">Floodfill designated area with a matte value</font></td>
</tr>
<tr>
<td><a name="medianFilterImage"></a> <font size="-1">medianFilterImage</font></td>
<td><font size="-1">const double radius_ = 0.0</font></td>
<td><font size="-1">Filter image by replacing each pixel
component with the median color in a circular neighborhood</font></td>
</tr>
<tr>
<td>
<center><a name="minifyImage"></a> <font size="-1">minifyImage</font></center>
</td>
<td><font size="-1">void</font></td>
<td><font size="-1">Reduce image by integral size</font></td>
</tr>
<tr>
<td>
<center><a name="modulateImage"></a> <font size="-1">modulateImage</font></center>
</td>
<td><font size="-1">double brightness_, double saturation_,
double hue_</font></td>
<td><font size="-1">Modulate percent hue, saturation, and
brightness of an image. </font><font size="-1">Modulation of
saturation and brightness is as a ratio of the current value (1.0 for no
change). Modulation of hue is an absolute rotation of -180 degrees to
+180 degrees from the current position corresponding to an argument
range of 0 to 2.0 (1.0 for no change).</font></td>
</tr>
<tr>
<td>
<center><a name="negateImage"></a> <font size="-1">negateImage</font></center>
</td>
<td><font size="-1">bool grayscale_ = false</font></td>
<td><font size="-1">Negate colors in image.  Replace every
pixel with its complementary color (white becomes black, yellow becomes
blue, etc.).  Set grayscale to only negate grayscale values in
image.</font></td>
</tr>
<tr>
<td>
<center><a name="normalizeImage"></a> <font size="-1">normalizeImage</font></center>
</td>
<td><font size="-1">void</font></td>
<td><font size="-1">Normalize image (increase contrast by
normalizing the pixel values to span the full range of color values).</font></td>
</tr>
<tr>
<td>
<center><a name="oilPaintImage"></a> <font size="-1">oilPaintImage</font></center>
</td>
<td><font size="-1">size_t radius_ = 3</font></td>
<td><font size="-1">Oilpaint image (image looks like oil painting)</font></td>
</tr>
<tr>
<td>
<center><a name="opacityImage"></a> <font size="-1">opacityImage</font></center>
</td>
<td><font size="-1">size_t opacity_</font></td>
<td><font size="-1">Set or attenuate the opacity channel in the
image. If the image pixels are opaque then they are set to the specified
opacity value, otherwise they are blended with the supplied opacity
value.  The value of opacity_ ranges from 0 (completely opaque) to <i>QuantumRange</i>.
The defines <i>OpaqueOpacity</i> and <i>TransparentOpacity</i> are
available to specify completely opaque or completely transparent,
respectively.</font></td>
</tr>
<tr>
<td>
<center><a name="opaqueImage"></a> <font size="-1">opaqueImage</font></center>
</td>
<td><font size="-1">const <a href="Color.html">Color</a>
&opaqueColor_, const <a href="Color.html">Color</a> &penColor_</font></td>
<td><font size="-1">Change color of pixels matching opaqueColor_
to specified penColor_.</font></td>
</tr>
<tr>
<td>
<center><a name="quantizeImage"></a> <font size="-1">quantizeImage</font></center>
</td>
<td><font size="-1">bool measureError_ = false</font></td>
<td><font size="-1">Quantize image (reduce number of colors). Set
measureError_ to true in order to calculate error attributes.</font></td>
</tr>
<tr>
<td>
<center><a name="raiseImage"></a> <font size="-1">raiseImage</font></center>
</td>
<td><font size="-1">const <a href="Geometry.html">Geometry</a>
&geometry_ = "6x6+0+0",  bool raisedFlag_ =  false</font></td>
<td><font size="-1">Raise image (lighten or darken the edges of
an image to give a 3-D raised or lowered effect)</font></td>
</tr>
<tr>
<td rowspan="2">
<center><a name="reduceNoiseImage"></a> <font size="-1">reduceNoise-</font> <br />
<font size="-1">Image</font></center>
</td>
<td><font size="-1">void</font></td>
<td rowspan="2"><font size="-1">Reduce noise in image using a
noise peak elimination filter.</font></td>
</tr>
<tr>
<td><font size="-1">size_t order_</font></td>
</tr>
<tr>
<td>
<center><a name="rollImage"></a> <font size="-1">rollImage</font></center>
</td>
<td><font size="-1">int columns_, ssize_t rows_</font></td>
<td><font size="-1">Roll image (rolls image vertically and
horizontally) by specified number of columns and rows)</font></td>
</tr>
<tr>
<td>
<center><a name="rotateImage"></a> <font size="-1">rotateImage</font></center>
</td>
<td><font size="-1">double degrees_</font></td>
<td><font size="-1">Rotate image counter-clockwise by specified
number of degrees</font></td>
</tr>
<tr>
<td>
<center><a name="sampleImage"></a> <font size="-1">sampleImage</font></center>
</td>
<td><font size="-1">const <a href="Geometry.html">Geometry</a>
&geometry_ </font></td>
<td><font size="-1">Resize image by using pixel sampling algorithm</font></td>
</tr>
<tr>
<td>
<center><a name="scaleImage"></a> <font size="-1">scaleImage</font></center>
</td>
<td><font size="-1">const <a href="Geometry.html">Geometry</a>
&geometry_</font></td>
<td><font size="-1">Resize image by using simple ratio algorithm</font></td>
</tr>
<tr>
<td>
<center><a name="segmentImage"></a> <font size="-1">segmentImage</font></center>
</td>
<td><font size="-1">double clusterThreshold_ = 1.0,</font> <br />
<font size="-1">double smoothingThreshold_ = 1.5</font></td>
<td><font size="-1">Segment (coalesce similar image components)
by analyzing the histograms of the color components and identifying
units that are homogeneous with the fuzzy c-means technique. Also uses <i>quantizeColorSpace</i>
and <i>verbose</i> image attributes. Specify <i>clusterThreshold_</i> ,
as the number  of  pixels  each cluster  must exceed
the cluster threshold to be considered valid. <i>SmoothingThreshold_</i>
eliminates noise in the  second derivative of the histogram. As the
value is  increased, you can  expect  a  smoother
second derivative.  The default is 1.5.</font></td>
</tr>
<tr>