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