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