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