1 2 3 4 5<!DOCTYPE html> 6<html lang="en"> 7<head> 8 <meta charset="utf-8" /> 9 <meta name="viewport" content="width=device-width,minimum-scale=1,initial-scale=1,shrink-to-fit=no" /> 10 <title>ImageMagick - PerlMagick, Perl API</title> 11 <meta name="application-name" content="ImageMagick" /> 12 <meta name="description" content="Use ImageMagick® to create, edit, compose, and convert bitmap images. Resize an image, crop it, change its shades and colors, add captions, and more." /> 13 <meta name="application-url" content="https://imagemagick.org" /> 14 <meta name="generator" content="PHP" /> 15 <meta name="keywords" content="perlmagick, perl, api, ImageMagick, PerlMagick, image processing, image, photo, software, Magick++, OpenMP, convert" /> 16 <meta name="rating" content="GENERAL" /> 17 <meta name="robots" content="INDEX, FOLLOW" /> 18 <meta name="generator" content="ImageMagick Studio LLC" /> 19 <meta name="author" content="ImageMagick Studio LLC" /> 20 <meta name="revisit-after" content="2 DAYS" /> 21 <meta name="resource-type" content="document" /> 22 <meta name="copyright" content="Copyright (c) 1999-2020 ImageMagick Studio LLC" /> 23 <meta name="distribution" content="Global" /> 24 <meta name="magick-serial" content="P131-S030410-R485315270133-P82224-A6668-G1245-1" /> 25 <meta property='og:url' content='../' /> 26 <meta property='og:title' content='ImageMagick' /> 27 <meta property='og:image' content='../images/logo.png' /> 28 <meta property='og:type' content='website' /> 29 <meta property='og:site_name' content='ImageMagick' /> 30 <meta property='og:description' content="Convert, Edit, or Compose Bitmap Images" /> 31 <meta name="google-site-verification" content="_bMOCDpkx9ZAzBwb2kF3PRHbfUUdFj2uO8Jd1AXArz4" /> 32 <link href="../www/perl-magick.html" rel="canonical" /> 33 <link href="../images/wand.png" rel="icon" /> 34 <link href="../images/wand.ico" rel="shortcut icon" /> 35 <link href="assets/magick.css" rel="stylesheet" /> 36</head> 37<body> 38 <nav class="navbar navbar-expand-md navbar-dark fixed-top bg-dark"> 39 <a class="navbar-brand" href="../index.html"><img class="d-block" id="icon" alt="ImageMagick" width="32" height="32" src="../images/wand.ico"/></a> 40 <button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarsMagick" aria-controls="navbarsMagick" aria-expanded="false" aria-label="Toggle navigation"> 41 <span class="navbar-toggler-icon"></span> 42 </button> 43 44 <div class="navbar-collapse collapse" id="navbarsMagick" style=""> 45 <ul class="navbar-nav mr-auto"> 46 <li class="nav-item "> 47 <a class="nav-link" href="../index.html">Home <span class="sr-only">(current)</span></a> 48 </li> 49 <li class="nav-item "> 50 <a class="nav-link" href="download.html">Download</a> 51 </li> 52 <li class="nav-item "> 53 <a class="nav-link" href="command-line-tools.html">Tools</a> 54 </li> 55 <li class="nav-item "> 56 <a class="nav-link" href="command-line-processing.html">Command-line</a> 57 </li> 58 <li class="nav-item "> 59 <a class="nav-link" href="resources.html">Resources</a> 60 </li> 61 <li class="nav-item "> 62 <a class="nav-link" href="develop.html">Develop</a> 63 </li> 64 <li class="nav-item"> 65 <a class="nav-link" target="_blank" href="https://imagemagick.org/discourse-server/">Community</a> 66 </li> 67 </ul> 68 <form class="form-inline my-2 my-lg-0" action="https://imagemagick.org/script/search.php"> 69 <input class="form-control mr-sm-2" type="text" name="q" placeholder="Search" aria-label="Search"> 70 <button class="btn btn-outline-success my-2 my-sm-0" type="submit" name="sa">Search</button> 71 </form> 72 </div> 73 </nav> 74 <div class="container"> 75 <script async="async" src="http://localhost/pagead/js/adsbygoogle.js"></script> <ins class="adsbygoogle" 76 style="display:block" 77 data-ad-client="ca-pub-3129977114552745" 78 data-ad-slot="6345125851" 79 data-full-width-responsive="true" 80 data-ad-format="horizontal"></ins> 81 <script> 82 (adsbygoogle = window.adsbygoogle || []).push({}); 83 </script> 84 85 </div> 86 87 <main class="container"> 88 <div class="magick-template"> 89<div class="magick-header"> 90<p class="text-center"><a href="perl-magick.html#installation">Installation</a> • <a href="perl-magick.html#overview">Overview</a> • <a href="perl-magick.html#example">Example Script</a> • <a href="perl-magick.html#read">Read or Write an Image</a> • <a href="perl-magick.html#manipulate">Manipulate an Image</a> • <a href="perl-magick.html#set-attribute">Set an Image Attribute</a> • <a href="perl-magick.html#get-attribute">Get an Image Attribute</a> • <a href="perl-magick.html#compare">Compare an Image to its Reconstruction</a> • <a href="perl-magick.html#montage">Create an Image Montage</a> • <a href="perl-magick.html#blobs">Working with Blobs</a> • <a href="perl-magick.html#direct-access">Direct-access to Image Pixels</a> • <a href="perl-magick.html#miscellaneous">Miscellaneous Methods</a> • <a href="perl-magick.html#exceptions">Handling Exceptions</a>• <a href="perl-magick.html#constants">Constant</a> </p> 91 92<a class="anchor" id="introduction"></a> 93<p class="lead magick-description"><a href="download.html">PerlMagick</a> is an objected-oriented <a href="http://www.perl.com/perl/">Perl</a> interface to ImageMagick. Use the module to read, manipulate, or write an image or image sequence from within a Perl script. This makes it very suitable for Web CGI scripts. You must have ImageMagick 6.5.5 or above and Perl version 5.005_02 or greater installed on your system for PerlMagick to build properly.</p> 94 95<p>There are a number of useful scripts available to show you the value of PerlMagick. You can do Web based image manipulation and conversion with <a href="https://imagemagick.org/download/perl">MagickStudio</a>, or use <a href="https://github.com/ImageMagick/ImageMagick/tree/master/PerlMagick/demo/tree.pl">L-systems</a> to create images of plants using mathematical constructs, and finally navigate through collections of thumbnail images and select the image to view with the <a href="http://webmagick.sourceforge.net/">WebMagick Image Navigator</a>.</p> 96 97<p>You can try PerlMagick from your Web browser at the <a href="../MagickStudio/scripts/MagickStudio.cgi">ImageMagick Studio</a>. Or, you can see <a href="examples.html">examples</a> of select PerlMagick functions.</p> 98 99<h2><a class="anchor" id="installation"></a>Installation</h2> 100 101<p><b>UNIX</b></p> 102 103<p>Is PerlMagick available from your system RPM repository? For example, on our CentOS system, we install PerlMagick thusly:</p> 104 105<pre class="highlight"><code>yum install ImageMagick-perl 106</code></pre> 107 108<p>If not, you must install PerlMagick from the ImageMagick source distribution. Download the latest <a href="https://imagemagick.org/download/ImageMagick.tar.gz">source</a> release.</p> 109 110<p>Unpack the distribution with this command:</p> 111 112<pre class="highlight"><code>tar xvzf ImageMagick.tar.gz 113</code></pre> 114 115<p>Next configure and compile ImageMagick:</p> 116 117<pre class="highlight"><span class="crtprompt">$ </span><span class='crtin'>cd ImageMagick-7.0.9<br/>$ ./configure -with-perl<br/>$ make</span></pre> 118<p>If ImageMagick / PerlMagick configured and compiled without complaint, you are ready to install it on your system. Administrator privileges are required to install. To install, type</p> 119 120<pre class="highlight"><code>sudo make install 121</code></pre> 122 123<p>You may need to configure the dynamic linker run-time bindings:</p> 124 125<pre class="highlight"><code>sudo ldconfig /usr/local/lib 126</code></pre> 127 128 129<p>Finally, verify the PerlMagick install worked properly, type</p> 130 131<pre class="highlight"><code>perl -MImage::Magick -le 'print Image::Magick->QuantumDepth' 132</code></pre> 133 134<p>Congratulations, you have a working ImageMagick distribution and you are ready to use PerlMagick to <a href="../Usage/">convert, compose, or edit</a> your images.</p> 135 136<p><b>Windows XP / Windows 2000</b></p> 137 138<p>ImageMagick must already be installed on your system. Also, the ImageMagick source distribution for <a href="download.html">Windows 2000</a> is required. You must also have the <code>nmake</code> from the Visual C++ or J++ development environment. Copy <code>\bin\IMagick.dll</code> and <code>\bin\X11.dll</code> to a directory in your dynamic load path such as <code>c:\perl\site\5.00502</code>.</p> 139 140<p>Next, type</p> 141 142<pre class="highlight"><code>cd PerlMagick 143perl Makefile.nt 144nmake 145nmake install 146</code></pre> 147 148<p>See the <a href="http://www.dylanbeattie.net/magick/">PerlMagick Windows HowTo</a> page for further installation instructions.</p> 149 150<p><b>Running the Regression Tests</b></p> 151 152<p>To verify a correct installation, type</p> 153 154<pre class="highlight"><code>make test 155</code></pre> 156 157<p>Use <code>nmake test</code> under Windows. There are a few demonstration scripts available to exercise many of the functions PerlMagick can perform. Type</p> 158 159<pre class="highlight"><code>cd demo 160make 161</code></pre> 162 163<p>You are now ready to utilize the PerlMagick methods from within your Perl scripts.</p> 164 165<h2><a class="anchor" id="overview"></a>Overview</h2> 166 167<p>Any script that wants to use PerlMagick methods must first define the methods within its namespace and instantiate an image object. Do this with:</p> 168 169<pre class="highlight"><code>use Image::Magick; 170 171$image = Image::Magick->new; 172</code></pre> 173 174<p>PerlMagick is <var>quantum</var> aware. You can request a specific quantum depth when you instantiate an image object:</p> 175 176<pre class="highlight"><code>use Image::Magick::Q16; 177 178$image = Image::Magick::Q16->new; 179</code></pre> 180 181<p>The new() method takes the same parameters as <a href="perl-magick.html#set-attribute">SetAttribute</a> . For example,</p> 182 183<pre class="highlight"><code>$image = Image::Magick->new(size=>'384x256'); 184</code></pre> 185 186<p>Next you will want to read an image or image sequence, manipulate it, and then display or write it. The input and output methods for PerlMagick are defined in <a href="perl-magick.html#read">Read or Write an Image</a>. See <a href="perl-magick.html#set-attribute">Set an Image Attribute</a> for methods that affect the way an image is read or written. Refer to <a href="perl-magick.html#manipulate">Manipulate an Image</a> for a list of methods to transform an image. <a href="perl-magick.html#get-attribute">Get an Image Attribute</a> describes how to retrieve an attribute for an image. Refer to <a href="perl-magick.html#montage">Create an Image Montage</a> for details about tiling your images as thumbnails on a background. Finally, some methods do not neatly fit into any of the categories just mentioned. Review <a href="perl-magick.html#misc">Miscellaneous Methods</a> for a list of these methods.</p> 187 188<p>Once you are finished with a PerlMagick object you should consider destroying it. Each image in an image sequence is stored in virtual memory. This can potentially add up to mebibytes of memory. Upon destroying a PerlMagick object, the memory is returned for use by other Perl methods. The recommended way to destroy an object is with <code>undef</code>:</p> 189 190<pre class="highlight"><code>undef $image; 191</code></pre> 192 193<p>To delete all the images but retain the <code>Image::Magick</code> object use</p> 194 195<pre class="highlight"><code>@$image = (); 196</code></pre> 197 198<p>and finally, to delete a single image from a multi-image sequence, use</p> 199 200<pre class="highlight"><code>undef $image->[$x]; 201</code></pre> 202 203<p>The next section illustrates how to use various PerlMagick methods to manipulate an image sequence.</p> 204 205<p>Some of the PerlMagick methods require external programs such as <a href="http://www.cs.wisc.edu/~ghost/">Ghostscript</a>. This may require an explicit path in your PATH environment variable to work properly. For example (in Unix),</p> 206 207<pre class="highlight"><code>$ENV{PATH}' . "='/../bin:/usr/bin:/usr/local/bin'; 208</code></pre> 209 210<h2><a class="anchor" id="example"></a>Example Script</h2> 211 212<p>Here is an example script to get you started:</p> 213 214<pre class="highlight"><code>#!/usr/local/bin/perl 215use Image::Magick;<br /> 216my($image, $x);<br /> 217$image = Image::Magick->new; 218$x = $image->Read('girl.png', 'logo.png', 'rose.png'); 219warn "$x" if "$x";<br /> 220$x = $image->Crop(geometry=>'100x100+100+100'); 221warn "$x" if "$x";<br /> 222$x = $image->Write('x.png'); 223warn "$x" if "$x"; 224</code></pre> 225 226<p>The script reads three images, crops them, and writes a single image as a GIF animation sequence. In many cases you may want to access individual images of a sequence. The next example illustrates how this done:</p> 227 228<pre class="pre-scrollable"><code>#!/usr/local/bin/perl 229use Image::Magick;<br /> 230my($image, $p, $q);<br /> 231$image = new Image::Magick; 232$image->Read('x1.png'); 233$image->Read('j*.jpg'); 234$image->Read('k.miff[1, 5, 3]'); 235$image->Contrast(); 236for ($x = 0; $image->[$x]; $x++) 237{ 238 $image->[$x]->Frame('100x200') if $image->[$x]->Get('magick') eq 'GIF'; 239 undef $image->[$x] if $image->[$x]->Get('columns') < 100; 240} 241$p = $image->[1]; 242$p->Draw(stroke=>'red', primitive=>'rectangle', points=>20,20 100,100'); 243$q = $p->Montage(); 244undef $image; 245$q->Write('x.miff'); 246</code></pre> 247 248<p>Suppose you want to start out with a 100 by 100 pixel white canvas with a red pixel in the center. Try</p> 249 250<pre class="highlight"><code>$image = Image::Magick->new; 251$image->Set(size=>'100x100'); 252$image->ReadImage('canvas:white'); 253$image->Set('pixel[49,49]'=>'red'); 254</code></pre> 255 256<p>Here we reduce the intensity of the red component at (1,1) by half:</p> 257 258<pre class="highlight"><code>@pixels = $image->GetPixel(x=>1,y=>1); 259$pixels[0]*=0.5; 260$image->SetPixel(x=>1,y=>1,color=>\@pixels); 261</code></pre> 262 263<p>Or suppose you want to convert your color image to grayscale:</p> 264 265<pre class="highlight"><code>$image->Quantize(colorspace=>'gray'); 266</code></pre> 267 268<p>Let's annotate an image with a Taipai TrueType font:</p> 269 270<pre class="highlight"><code>$text = 'Works like magick!'; 271$image->Annotate(font=>'kai.ttf', pointsize=>40, fill=>'green', text=>$text); 272</code></pre> 273 274<p>Perhaps you want to extract all the pixel intensities from an image and write them to STDOUT:</p> 275 276<pre class="highlight"><code>@pixels = $image->GetPixels(map=>'I', height=>$height, width=>$width, normalize=>true); 277binmode STDOUT; 278print pack('B*',join('',@pixels)); 279</code></pre> 280 281<p>Other clever things you can do with a PerlMagick objects include</p> 282 283<pre class="highlight"><code>$i = $#$p"+1"; # return the number of images associated with object p 284push(@$q, @$p); # push the images from object p onto object q 285@$p = (); # delete the images but not the object p 286$p->Convolve([1, 2, 1, 2, 4, 2, 1, 2, 1]); # 3x3 Gaussian kernel 287</code></pre> 288 289 <h2><a class="anchor" id="read"></a>Read or Write an Image</h2> 290 291<p>Use the methods listed below to either read, write, or display an image or image sequence:</p> 292 293<table class="table table-sm table-striped"> 294<caption>Read or Write Methods</caption> 295<colgroup> 296 <col width="20%" /> 297 <col width="20%" /> 298 <col width="20%" /> 299 <col width="40%" /> 300</colgroup> 301<tbody> 302 303 <tr> 304 <th>Method</th> 305 <th>Parameters</th> 306 <th>Return Value</th> 307 <th>Description</th> 308 </tr> 309 310 <tr> 311 <td>Read</td> 312 <td>one or more filenames</td> 313 <td>the number of images read</td> 314 <td>read an image or image sequence</td> 315 </tr> 316 317 <tr> 318 <td>Write</td> 319 <td>filename</td> 320 <td>the number of images written</td> 321 <td>write an image or image sequence</td> 322 </tr> 323 324 <tr> 325 <td>Display</td> 326 <td>server name</td> 327 <td>the number of images displayed</td> 328 <td>display the image or image sequence to an X server</td> 329 </tr> 330 331 <tr> 332 <td>Animate</td> 333 <td>server name</td> 334 <td>the number of images animated</td> 335 <td>animate image sequence to an X server</td> 336 </tr> 337</tbody> 338</table> 339 340<p>For convenience, methods Write(), Display(), and Animate() can take any parameter that <a href="perl-magick.html#set-attribute">SetAttribute</a> knows about. For example,</p> 341 342<pre class="highlight"><code>$image->Write(filename=>'image.png', compression=>'None'); 343</code></pre> 344 345<p>Use <code>-</code> as the filename to method Read() to read from standard in or to method Write() to write to standard out:</p> 346 347<pre class="highlight"><code>binmode STDOUT; 348$image->Write('png:-'); 349</code></pre> 350 351<p>To read an image in the GIF format from a PERL filehandle, use:</p> 352 353<pre class="highlight"><code>$image = Image::Magick->new; 354open(IMAGE, 'image.gif'); 355$image->Read(file=>\*IMAGE); 356close(IMAGE); 357</code></pre> 358 359<p>To write an image in the PNG format to a PERL filehandle, use:</p> 360 361<pre class="highlight"><code>$filename = "image.png"; 362open(IMAGE, ">$filename"); 363$image->Write(file=>\*IMAGE, filename=>$filename); 364close(IMAGE); 365</code></pre> 366 367<p>Note, reading from or writing to a Perl filehandle may fail under Windows due to different versions of the C-runtime libraries between ImageMagick and the ActiveState Perl distributions or if one of the DLL's is linked with the /MT option. See <a href="http://msdn.microsoft.com/en-us/library/ms235460.aspx">Potential Errors Passing CRT Objects Across DLL Boundaries</a> for an explanation.</p> 368 369<p>If <code>%0Nd, %0No, or %0Nx</code> appears in the filename, it is interpreted as a printf format specification and the specification is replaced with the specified decimal, octal, or hexadecimal encoding of the scene number. For example,</p> 370 371<pre class="highlight"><code>image%03d.miff 372</code></pre> 373 374<p>converts files image000.miff, image001.miff, etc.</p> 375 376<p>You can optionally add <i>Image</i> to any method name. For example, ReadImage() is an alias for method Read().</p> 377 378<h2><a class="anchor" id="manipulate"></a>Manipulate an Image</h2> 379 380<p>Once you create an image with, for example, method ReadImage() you may want to operate on it. Below is a list of all the image manipulations methods available to you with PerlMagick. There are <a href="examples.html">examples</a> of select PerlMagick methods. Here is an example call to an image manipulation method:</p> 381 382<pre class="highlight"><code>$image->Crop(geometry=>'100x100+10+20'); 383$image->[$x]->Frame("100x200"); 384</code></pre> 385 386<p>And here is a list of other image manipulation methods you can call:</p> 387 388<table class="table table-sm table-striped"> 389<caption>Image Manipulation Methods</caption> 390<tbody> 391 <tr> 392 <th>Method</th> 393 <th style="width: 40%">Parameters</th> 394 <th style="width: 40%">Description</th> 395 </tr> 396 397 <tr> 398 <td>AdaptiveBlur</td> 399 <td>geometry=><i>geometry</i>, radius=><i>double</i>, sigma=><i>double</i>, bias=><i>double</i>, channel=>{All, Default, Alpha, Black, Blue, CMYK, Cyan, Gray, Green, Index, Magenta, Alpha, Red, RGB, Yellow}</td> 400 <td>adaptively blur the image with a Gaussian operator of the given radius and standard deviation (sigma). Decrease the effect near edges.</td> 401 </tr> 402 403 <tr> 404 <td>AdaptiveResize</td> 405 <td>geometry=><i>geometry</i>, width=><i>integer</i>, height=><i>integer</i>, filter=>{Point, Box, Triangle, Hermite, Hanning, Hamming, Blackman, Gaussian, Quadratic, Cubic, Catrom, Mitchell, Lanczos, Bessel, Sinc}, support=><i>double</i>, blur=><i>double</i></td> 406 <td>adaptively resize image using data dependant triangulation. Specify <code>blur</code> > 1 for blurry or < 1 for sharp</td> 407 </tr> 408 409 <tr> 410 <td>AdaptiveSharpen</td> 411 <td>geometry=><i>geometry</i>, radius=><i>double</i>, sigma=><i>double</i>, bias=><i>double</i>, channel=>{All, Default, Alpha, Black, Blue, CMYK, Cyan, Gray, Green, Index, Magenta, Alpha, Red, RGB, Yellow}</td> 412 <td>adaptively sharpen the image with a Gaussian operator of the given radius and standard deviation (sigma). Increase the effect near edges.</td> 413 </tr> 414 415 <tr> 416 <td>AdaptiveThreshold</td> 417 <td>geometry=><i>geometry</i>, width=><i>integer</i>, height=><i>integer</i>, bias=><i>double</i></td> 418 <td>local adaptive thresholding.</td> 419 </tr> 420 421 <tr> 422 <td>AddNoise</td> 423 <td>noise=>{Uniform, Gaussian, Multiplicative, Impulse, Laplacian, Poisson}, attenuate=><i>double</i>, channel=>{All, Default, Alpha, Black, Blue, CMYK, Cyan, Gray, Green, Index, Magenta, Alpha, Red, RGB, Yellow}</td> 424 <td>add noise to an image</td> 425 </tr> 426 427 <tr> 428 <td>AffineTransform</td> 429 <td>affine=><i>array of float values</i>, translate=><i>float, float</i>, scale=> <i>float, float</i>, rotate=><i>float</i>, skewX=><i>float</i>, skewY=><i>float</i>, interpolate={Average, Bicubic, Bilinear, Filter, Integer, Mesh, NearestNeighbor}, background=><i><a href="color.html">color name</a></i></td> 430 <td>affine transform image</td> 431 </tr> 432 433 <tr> 434 <td>Affinity</td> 435 <td>image=><i>image-handle</i>, method=>{None, FloydSteinberg, Riemersma}</td> 436 <td>choose a particular set of colors from this image</td> 437 </tr> 438 439 <tr> 440 <td>Annotate</td> 441 <td>text=><i>string</i>, font=><i>string</i>, family=><i>string</i>, style=>{Normal, Italic, Oblique, Any}, stretch=>{Normal, UltraCondensed, ExtraCondensed, Condensed, SemiCondensed, SemiExpanded, Expanded, ExtraExpanded, UltraExpanded}, weight=><i>integer</i>, pointsize=><i>integer</i>, density=><i>geometry</i>, stroke=><i><a href="color.html">color name</a></i>, strokewidth=><i>integer</i>, fill=><i><a href="color.html">color name</a></i>, undercolor=><i><a href="color.html">color name</a></i>, kerning=><i>float</i>, geometry=><i>geometry</i>, gravity=>{NorthWest, North, NorthEast, West, Center, East, SouthWest, South, SouthEast}, antialias=>{true, false}, x=><i>integer</i>, y=><i>integer</i>, affine=><i>array of float values</i>, translate=><i>float, float</i>, scale=><i>float, float</i>, rotate=><i>float</i>. skewX=><i>float</i>, skewY=> <i>float</i>, align=>{Left, Center, Right}, encoding=>{UTF-8}, interline-spacing=><i>double</i>, interword-spacing=><i>double</i>, direction=>{right-to-left, left-to-right}, decorate=>{none, underline, overline, line-through}</td> 442 <td>annotate an image with text. See <a href="perl-magick.html#misc">QueryFontMetrics</a> to get font metrics without rendering any text.</td> 443 </tr> 444 445 <tr> 446 <td>AutoGamma</td> 447 <td>channel=>{All, Default, Alpha, Black, Blue, CMYK, Cyan, Gray, Green, Index, Magenta, Alpha, Red, RGB, Yellow}</td> 448 <td>automagically adjust gamma level of image</td> 449 </tr> 450 451 <tr> 452 <td>AutoLevel</td> 453 <td>channel=>{All, Default, Alpha, Black, Blue, CMYK, Cyan, Gray, Green, Index, Magenta, Alpha, Red, RGB, Yellow}</td> 454 <td>automagically adjust color levels of image</td> 455 </tr> 456 457 <tr> 458 <td>AutoOrient</td> 459 <td><br /></td> 460 <td>adjusts an image so that its orientation is suitable for viewing (i.e. top-left orientation)</td> 461 </tr> 462 463 <tr> 464 <td>AutoThreshold</td> 465 <td>method=>{Kapur, OTSU, Triangle}</td> 466 <td>automatically perform image thresholding</td> 467 </tr> 468 469 <tr> 470 <td>BlackThreshold</td> 471 <td>threshold=><i>string</i>, channel=>{All, Default, Alpha, Black, Blue, CMYK, Cyan, Gray, Green, Index, Magenta, Alpha, Red, RGB, Yellow}</td> 472 <td>force all pixels below the threshold intensity into black</td> 473 </tr> 474 475 <tr> 476 <td>BlueShift</td> 477 <td>factor=><i>double</i>,</td> 478 <td>simulate a scene at nighttime in the moonlight. Start with a factor of 1.5.</td> 479 </tr> 480 481 <tr> 482 <td>Blur</td> 483 <td>geometry=><i>geometry</i>, radius=><i>double</i>, sigma=><i>double</i>, bias=><i>double</i>, channel=>{All, Default, Alpha, Black, Blue, CMYK, Cyan, Gray, Green, Index, Magenta, Alpha, Red, RGB, Yellow}</td> 484 <td>reduce image noise and reduce detail levels with a Gaussian operator of the given radius and standard deviation (sigma).</td> 485 </tr> 486 487 <tr> 488 <td>Border</td> 489 <td>geometry=><i>geometry</i>, width=><i>integer</i>, height=><i>integer</i>, bordercolor=><i><a href="color.html">color name</a></i>, compose=>{Undefined, Add, Atop, Blend, Bumpmap, Clear, ColorBurn, ColorDodge, Colorize, CopyBlack, CopyBlue, CopyCMYK, Cyan, CopyGreen, Copy, CopyMagenta, CopyAlpha, CopyRed, RGB, CopyYellow, Darken, Dst, Difference, Displace, Dissolve, DstAtop, DstIn, DstOut, DstOver, Dst, Exclusion, HardLight, Hue, In, Lighten, Luminize, Minus, Modulate, Multiply, None, Out, Overlay, Over, Plus, ReplaceCompositeOp, Saturate, Screen, SoftLight, Src, SrcAtop, SrcIn, SrcOut, SrcOver, Src, Subtract, Threshold, Xor },</td> 490 <td>surround the image with a border of color</td> 491 </tr> 492 493 <tr> 494 <td>CannyEdge</td> 495 <td>geometry=><i>geometry</i>, radius=><i>double</i>, sigma=><i>double</i>, 'lower-percent'=><i>double</i>, 'upper-percent'=><i>double</i></td> 496 <td>use a multi-stage algorithm to detect a wide range of edges in the image (e.g. CannyEdge('0x1+10%+40%')).</td> 497 </tr> 498 499 <tr> 500 <td>Charcoal</td> 501 <td>geometry=><i>geometry</i>, radius=><i>double</i>, sigma=><i>double</i></td> 502 <td>simulate a charcoal drawing</td> 503 </tr> 504 505 <tr> 506 <td>Chop</td> 507 <td>geometry=><i>geometry</i>, width=><i>integer</i>, height=><i>integer</i>, x=><i>integer</i>, y=><i>integer</i>, gravity=>{NorthWest, North, NorthEast, West, Center, East, SouthWest, South, SouthEast}</td> 508 <td>chop an image</td> 509 </tr> 510 511 <tr> 512 <td>CLAHE</td> 513 <td>geometry=><i>geometry</i>, width=><i>integer</i>, height=><i>integer</i>, number-bins=><i>integer</i>, clip-limit=><i>double</i></td> 514 <td>contrast limited adaptive histogram equalization. <var>width</var>, <var>height</var> divides the image into tiles. <var>number-bins</var> is the number of histogram bins per tile (min 2, max 256). <var>clip-limit</var> is the contrast limit for localised changes in contrast. A clip-limit of 2 to 3 is a good starting place.</td> 515 </tr> 516 517 <tr> 518 <td>Clamp</td> 519 <td>channel=>{Red, RGB, All, etc.}</td> 520 <td>set each pixel whose value is below zero to zero and any the pixel whose value is above the quantum range to the quantum range (e.g. 65535) otherwise the pixel value remains unchanged.</td> 521 </tr> 522 523 <tr> 524 <td>Clip</td> 525 <td>id=><i>name</i>, inside=><i>{true, false}</i>,</td> 526 <td>apply along a named path from the 8BIM profile.</td> 527 </tr> 528 529 <tr> 530 <td>ClipMask</td> 531 <td>mask=><i>image-handle</i></td> 532 <td>clip image as defined by the image mask</td> 533 </tr> 534 535 <tr> 536 <td>Clut</td> 537 <td>image=><i>image-handle</i>, interpolate={Average, Bicubic, Bilinear, Filter, Integer, Mesh, NearestNeighbor}, channel=>{Red, RGB, All, etc.}</td> 538 <td>apply a color lookup table to an image sequence</td> 539 </tr> 540 541 <tr> 542 <td>Color</td> 543 <td>color=><i><a href="color.html">color name</a></i></td> 544 <td>set the entire image to this color.</td> 545 </tr> 546 547 <tr> 548 <td>ColorDecisionList</td> 549 <td>filename=><i>string</i>,</td> 550 <td>color correct with a color decision list.</td> 551 </tr> 552 553 <tr> 554 <td>Colorize</td> 555 <td>fill=><i><a href="color.html">color name</a></i>, blend=><i>string</i></td> 556 <td>colorize the image with the fill color</td> 557 </tr> 558 559 <tr> 560 <td>ColorMatrix</td> 561 <td>matrix=><i>array of float values</i></td> 562 <td>apply color correction to the image. Although you can use variable sized matrices, typically you use a 5 x 5 for an RGBA image and a 6x6 for CMYKA. A 6x6 matrix is required for offsets (populate the last column with normalized values).</td> 563 </tr> 564 565 <tr> 566 <td>Colorspace</td> 567 <td>colorspace=>{RGB, Gray, Transparent, OHTA, XYZ, YCbCr, YCC, YIQ, YPbPr, YUV, CMYK}</td> 568 <td> set the image colorspace</td> 569 </tr> 570 571 <tr> 572 <td>Comment</td> 573 <td>string</td> 574 <td>add a comment to your image</td> 575 </tr> 576 577 <tr> 578 <td>CompareLayers</td> 579 <td>method=>{any, clear, overlay}</td> 580 <td>compares each image with the next in a sequence and returns the minimum bounding region of any pixel differences it discovers. Images do not have to be the same size, though it is best that all the images are coalesced (images are all the same size, on a flattened canvas, so as to represent exactly how a specific frame should look).</td> 581 </tr> 582 583 <tr> 584 <td>Composite</td> 585 <td>image=><i>image-handle</i>, compose=>{Undefined, Add, Atop, Blend, Bumpmap, Clear, ColorBurn, ColorDodge, Colorize, CopyBlack, CopyBlue, CopyCMYK, Cyan, CopyGreen, Copy, CopyMagenta, CopyAlpha, CopyRed, RGB, CopyYellow, Darken, Dst, Difference, Displace, Dissolve, DstAtop, DstIn, DstOut, DstOver, Dst, Exclusion, HardLight, Hue, In, Lighten, Luminize, Minus, Modulate, Multiply, None, Out, Overlay, Over, Plus, ReplaceCompositeOp, Saturate, Screen, SoftLight, Src, SrcAtop, SrcIn, SrcOut, SrcOver, Src, Subtract, Threshold, Xor }, mask=><i>image-handle</i>, geometry=><i>geometry</i>, x=><i>integer</i>, y=><i>integer</i>, gravity=>{NorthWest, North, NorthEast, West, Center, East, SouthWest, South, SouthEast}, opacity=><i>integer</i>, tile=>{True, False}, rotate=><i>double</i>, color=><i><a href="color.html">color name</a></i>, blend=><i>geometry</i>, interpolate=>{undefined, average, bicubic, bilinear, filter, integer, mesh, nearest-neighbor, spline}, clip-to-self=>{True, False}</td> 586 <td>composite one image onto another. Use the rotate parameter in concert with the tile parameter.</td> 587 </tr> 588 589 <tr> 590 <td>ConnectedComponents</td> 591 <td>connectivity=><i>integer</i>,</td> 592 <td>connected-components uniquely labeled, choose from 4 or 8 way connectivity.</td> 593 </tr> 594 595 <tr> 596 <td>Contrast</td> 597 <td>sharpen=>{True, False}</td> 598 <td>enhance or reduce the image contrast</td> 599 </tr> 600 601 <tr> 602 <td>ContrastStretch</td> 603 <td>levels=><i>string</i>, 'black-point'=><i>double</i>, 'white-point'=><i>double</i>, channel=>{Red, RGB, All, etc.}</td> 604 <td>improve the contrast in an image by `stretching' the range of intensity values</td> 605 </tr> 606 607 <tr> 608 <td>Convolve</td> 609 <td>coefficients=><i>array of float values</i>, channel=>{All, Default, Alpha, Black, Blue, CMYK, Cyan, Gray, Green, Index, Magenta, Alpha, Red, RGB, Yellow}, bias=><i>double</i></td> 610 <td>apply a convolution kernel to the image. Given a kernel <i>order</i> , you would supply <i>order*order</i> float values (e.g. 3x3 implies 9 values).</td> 611 </tr> 612 613 <tr> 614 <td>CopyPixels</td> 615 <td>image=><i>image-handle</i>, geometry=><i>geometry</i>, width=><i>integer</i>, height=><i>integer</i>, x=><i>integer</i>, y=><i>integer</i>, offset=><i>geometry</i>, gravity=>{NorthWest, North, NorthEast, West, Center, East, SouthWest, South, SouthEast}, dx=><i>integer</i>, dy=><i>integer</i></td> 616 <td>copy pixels from the image as defined by the <code>width</code>x<code>height</code>+<code>x</code>+<code>y</code> to image at offset +<code>dx</code>,+<code>dy</code>.</td> 617 </tr> 618 619 <tr> 620 <td>Crop</td> 621 <td>geometry=><i>geometry</i>, width=><i>integer</i>, height=><i>integer</i>, x=><i>integer</i>, y=><i>integer</i>, fuzz=><i>double</i>, gravity=>{NorthWest, North, NorthEast, West, Center, East, SouthWest, South, SouthEast}</td> 622 <td>crop an image</td> 623 </tr> 624 625 <tr> 626 <td>CycleColormap</td> 627 <td>amount=><i>integer</i></td> 628 <td>displace image colormap by amount</td> 629 </tr> 630 631 <tr> 632 <td>Decipher</td> 633 <td>passphrase=><i>string</i></td> 634 <td>convert cipher pixels to plain pixels</td> 635 </tr> 636 637 <tr> 638 <td>Deconstruct</td> 639 <td><br /></td> 640 <td>break down an image sequence into constituent parts</td> 641 </tr> 642 643 <tr> 644 <td>Deskew</td> 645 <td>geometry=><i>string</i>,threshold=><i>double</i></td> 646 <td>straighten the image</td> 647 </tr> 648 649 <tr> 650 <td>Despeckle</td> 651 <td> </td> 652 <td>reduce the speckles within an image</td> 653 </tr> 654 655 <tr> 656 <td>Difference</td> 657 <td>image=><i>image-handle</i></td> 658 <td>compute the difference metrics between two images </td> 659 </tr> 660 661 <tr> 662 <td>Distort</td> 663 <td>points=><i>array of float values</i>, method=>{Affine, AffineProjection, ScaleRotateTranslate, SRT, Perspective, PerspectiveProjection, BilinearForward, BilinearReverse, Polynomial, Arc, Polar, DePolar, Barrel, BarrelInverse, Shepards, Resize}, 'virtual-pixel'=>{Background Black Constant Dither Edge Gray Mirror Random Tile Transparent White}, 'best-fit'=>{True, False}</td> 664 <td>distort image</td> 665 </tr> 666 667 <tr> 668 <td>Draw</td> 669 <td>primitive=>{point, line, rectangle, arc, ellipse, circle, path, polyline, polygon, bezier, color, matte, text, @<i>filename</i>}, points=><i>string</i> , method=><i>{Point, Replace, Floodfill, FillToBorder, Reset}</i>, stroke=><i><a href="color.html">color name</a></i>, fill=><i><a href="color.html">color name</a></i>, font=><i>string</i>, pointsize=><i>integer</i>, strokewidth=><i>float</i>, antialias=>{true, false}, bordercolor=><i><a href="color.html">color name</a></i>, x=><i>float</i>, y=><i>float</i>, dash-offset=><i>float</i>, dash-pattern=><i>array of float values</i>, affine=><i>array of float values</i>, translate=><i>float, float</i>, scale=><i>float, float</i>, rotate=><i>float</i>, skewX=><i>float</i>, skewY=><i>float</i>, interpolate=>{undefined, average, bicubic, bilinear, mesh, nearest-neighbor, spline}, kerning=><i>float</i>, text=><i>string</i>, vector-graphics=><i>string</i>, interline-spacing=><i>double</i>, interword-spacing=><i>double</i>, direction=>{right-to-left, left-to-right}</td> 670 <td>annotate an image with one or more graphic primitives.</td> 671 </tr> 672 673 <tr> 674 <td>Encipher</td> 675 <td>passphrase=><i>string</i></td> 676 <td>convert plain pixels to cipher pixels</td> 677 </tr> 678 679 <tr> 680 <td>Edge</td> 681 <td>radius=><i>double</i></td> 682 <td>enhance edges within the image with a convolution filter of the given radius.</td> 683 </tr> 684 685 <tr> 686 <td>Emboss</td> 687 <td>geometry=><i>geometry</i>, radius=><i>double</i>, sigma=><i>double</i></td> 688 <td>emboss the image with a convolution filter of the given radius and standard deviation (sigma).</td> 689 </tr> 690 691 <tr> 692 <td>Enhance</td> 693 <td><br /></td> 694 <td>apply a digital filter to enhance a noisy image</td> 695 </tr> 696 697 <tr> 698 <td>Equalize</td> 699 <td>channel=>{All, Default, Alpha, Black, Blue, CMYK, Cyan, Gray, Green, Index, Magenta, Alpha, Red, RGB, Yellow}<br /></td> 700 <td>perform histogram equalization to the image</td> 701 </tr> 702 703 <tr> 704 <td>Extent</td> 705 <td>geometry=><i>geometry</i>, width=><i>integer</i>, height=><i>integer</i>, x=><i>integer</i>, y=><i>integer</i>, fuzz=><i>double</i>, background=><i><a href="color.html">color name</a></i>, gravity=>{NorthWest, North, NorthEast, West, Center, East, SouthWest, South, SouthEast}</td> 706 <td>set the image size</td> 707 </tr> 708 709 <tr> 710 <td>Evaluate</td> 711 <td>value=><i>double</i>, operator=><i>{Add, And, Divide, LeftShift, Max, Min, Multiply, Or, Rightshift, RMS, Subtract, Xor}</i>, channel=>{All, Default, Alpha, Black, Blue, CMYK, Cyan, Gray, Green, Index, Magenta, Alpha, Red, RGB, Yellow} </td> 712 <td>apply an arithmetic, relational, or logical expression to the image</td> 713 </tr> 714 715 <tr> 716 <td>Filter</td> 717 <td>kernel=><i>string</i>, channel=>{All, Default, Alpha, Black, Blue, CMYK, Cyan, Gray, Green, Index, Magenta, Alpha, Red, RGB, Yellow}, bias=><i>double</i></td> 718 <td>apply a convolution kernel to the image.</td> 719 </tr> 720 721 <tr> 722 <td>Flip</td> 723 <td><br /></td> 724 <td>reflect the image scanlines in the vertical direction</td> 725 </tr> 726 727 <tr> 728 <td>Flop</td> 729 <td><br /></td> 730 <td>reflect the image scanlines in the horizontal direction</td> 731 </tr> 732 733 <tr> 734 <td>FloodfillPaint</td> 735 <td>geometry=><i>geometry</i>, channel=>{All, Default, Alpha, Black, Blue, CMYK, Cyan, Gray, Green, Index, Magenta, Alpha, Red, RGB, Yellow}, x=><i>integer</i>, y=><i>integer</i> , fill=><i><a href="color.html">color name</a></i>, bordercolor=><i><a href="color.html">color name</a></i>, fuzz=><i>double</i>, invert=>{True, False}</td> 736 <td>changes the color value of any pixel that matches the color of the target pixel and is a neighbor. If you specify a border color, the color value is changed for any neighbor pixel that is not that color.</td> 737 </tr> 738 739 <tr> 740 <td>ForwardFourierTransform</td> 741 <td>magnitude=>{True, False}</td> 742 <td>implements the forward discrete Fourier transform (DFT)</td> 743 </tr> 744 745 <tr> 746 <td>Frame</td> 747 <td>geometry=><i>geometry</i>, width=><i>integer</i>, height=><i>integer</i>, inner=><i>integer</i>, outer=><i>integer</i>, fill=><i><a href="color.html">color name</a></i>, compose=>{Undefined, Add, Atop, Blend, Bumpmap, Clear, ColorBurn, ColorDodge, Colorize, CopyBlack, CopyBlue, CopyCMYK, Cyan, CopyGreen, Copy, CopyMagenta, CopyAlpha, CopyRed, RGB, CopyYellow, Darken, Dst, Difference, Displace, Dissolve, DstAtop, DstIn, DstOut, DstOver, Dst, Exclusion, HardLight, Hue, In, Lighten, Luminize, Minus, Modulate, Multiply, None, Out, Overlay, Over, Plus, ReplaceCompositeOp, Saturate, Screen, SoftLight, Src, SrcAtop, SrcIn, SrcOut, SrcOver, Src, Subtract, Threshold, Xor },</td> 748 <td>surround the image with an ornamental border</td> 749 </tr> 750 751 <tr> 752 <td>Function</td> 753 <td>parameters=><i>array of float values</i>, function=>{Sin}, 'virtual-pixel'=>{Background Black Constant Dither Edge Gray Mirror Random Tile Transparent White}</td> 754 <td>apply a function to the image</td> 755 </tr> 756 757 <tr> 758 <td>Gamma</td> 759 <td>gamma=><i>string</i>, channel=>{All, Default, Alpha, Black, Blue, CMYK, Cyan, Gray, Green, Index, Magenta, Alpha, Red, RGB, Yellow}</td> 760 <td>gamma correct the image</td> 761 </tr> 762 763 <tr> 764 <td>GaussianBlur</td> 765 <td>geometry=><i>geometry</i>, radius=><i>double</i>, sigma=><i>double</i>, bias=><i>double</i>, channel=>{All, Default, Alpha, Black, Blue, CMYK, Cyan, Gray, Green, Index, Magenta, Alpha, Red, RGB, Yellow}</td> 766 <td>reduce image noise and reduce detail levels with a Gaussian operator of the given radius and standard deviation (sigma).</td> 767 </tr> 768 769 <tr> 770 <td>GetPixel</td> 771 <td>geometry=><i>geometry</i>, channel=>{All, Default, Alpha, Black, Blue, CMYK, Cyan, Gray, Green, Index, Magenta, Alpha, Red, RGB, Yellow}, normalize=>{true, false}, x=><i>integer</i>, y=><i>integer</i></td> 772 <td>get a single pixel. By default normalized pixel values are returned.</td> 773 </tr> 774 775 <tr> 776 <td>GetPixels</td> 777 <td>geometry=><i>geometry</i>, width=><i>integer</i>, height=><i>integer</i>, x=><i>integer</i>, y=><i>integer</i>, map=><i>string</i>, normalize=>{true, false}</td> 778 <td>get image pixels as defined by the map (e.g. "RGB", "RGBA", etc.). By default non-normalized pixel values are returned.</td> 779 </tr> 780 781 <tr> 782 <td>Grayscale</td> 783 <td>channel=>{Average, Brightness, Lightness, Rec601Luma, Rec601Luminance, Rec709Luma, Rec709Luminance, RMS}</td> 784 <td>convert image to grayscale</td> 785 </tr> 786 787 <tr> 788 <td>HaldClut</td> 789 <td>image=><i>image-handle</i>, channel=>{Red, RGB, All, etc.}</td> 790 <td>apply a Hald color lookup table to an image sequence</td> 791 </tr> 792 793 <tr> 794 <td>HoughLine</td> 795 <td>geometry=><i>geometry</i>, width=><i>double</i>, height=><i>double</i>, threshold=><i>double</i></td> 796 <td>identify lines in the image (e.g. HoughLine('9x9+195')).</td> 797 </tr> 798 799 <tr> 800 <td>Identify</td> 801 <td>file=><i>file</i>, features=><i>distance</i>, unique=>{True, False}</td> 802 <td>identify the attributes of an image</td> 803 </tr> 804 805 <tr> 806 <td>Implode</td> 807 <td>amount=><i>double</i>, interpolate=>{undefined, average, bicubic, bilinear, mesh, nearest-neighbor, spline}</td> 808 <td>implode image pixels about the center</td> 809 </tr> 810 811 <tr> 812 <td>InverseDiscreteFourierTransform</td> 813 <td>magnitude=>{True, False}</td> 814 <td>implements the inverse discrete Fourier transform (DFT)</td> 815 </tr> 816 817 <tr> 818 <td>Kmeans</td> 819 <td>geometry=><i>geometry</i>, 'colors'=><i>double</i>, 'iterations'=><i>double</i>, 'tolerance'=><i>double</i></td> 820 <td>K means color reduction.</td> 821 </tr> 822 823 <tr> 824 <td>Kuwahara</td> 825 <td>geometry=><i>geometry</i>, radius=><i>double</i>, sigma=><i>double</i>, bias=><i>double</i>, channel=>{All, Default, Alpha, Black, Blue, CMYK, Cyan, Gray, Green, Index, Magenta, Alpha, Red, RGB, Yellow}</td> 826 <td>edge preserving noise reduction filter</td> 827 </tr> 828 829 <tr> 830 <td>Label</td> 831 <td>string</td> 832 <td>assign a label to an image</td> 833 </tr> 834 835 <tr> 836 <td>Layers</td> 837 <td>method=>{coalesce, compare-any, compare-clear, compare-over, composite, dispose, flatten, merge, mosaic, optimize, optimize-image, optimize-plus, optimize-trans, remove-dups, remove-zero}, compose=>{Undefined, Add, Atop, Blend, Bumpmap, Clear, ColorBurn, ColorDodge, Colorize, CopyBlack, CopyBlue, CopyCMYK, Cyan, CopyGreen, Copy, CopyMagenta, CopyAlpha, CopyRed, RGB, CopyYellow, Darken, Dst, Difference, Displace, Dissolve, DstAtop, DstIn, DstOut, DstOver, Dst, Exclusion, HardLight, Hue, In, Lighten, LinearLight, Luminize, Minus, Modulate, Multiply, None, Out, Overlay, Over, Plus, ReplaceCompositeOp, Saturate, Screen, SoftLight, Src, SrcAtop, SrcIn, SrcOut, SrcOver, Src, Subtract, Threshold, Xor }, dither=>{true, false}</td> 838 <td>compare each image the GIF disposed forms of the previous image in the sequence. From this, attempt to select the smallest cropped image to replace each frame, while preserving the results of the animation.</td> 839 </tr> 840 841 <tr> 842 <td>Level</td> 843 <td>levels=><i>string</i>, 'black-point'=><i>double</i>, 'gamma'=><i>double</i>, 'white-point'=><i>double</i>, channel=>{Red, RGB, All, etc.}</td> 844 <td>adjust the level of image contrast</td> 845 </tr> 846 847 <tr> 848 <td>LevelColors</td> 849 <td>invert=>>{True, False}, 'black-point'=><i>string</i>, 'white-point'=><i>string</i>, channel=>{Red, RGB, All, etc.}</td> 850 <td>level image with the given colors</td> 851 </tr> 852 853 <tr> 854 <td>LinearStretch</td> 855 <td>levels=><i>string</i>, 'black-point'=><i>double</i>, 'white-point'=><i>double</i></td> 856 <td>linear with saturation stretch</td> 857 </tr> 858 859 <tr> 860 <td>LiquidResize</td> 861 <td>geometry=><i>geometry</i>, width=><i>integer</i>, height=><i>integer</i>, delta-x=><i>double</i>, rigidity=><i>double</i></td> 862 <td>rescale image with seam-carving.</td> 863 </tr> 864 865 <tr> 866 <td>Magnify</td> 867 <td><br /></td> 868 <td>double the size of the image with pixel art scaling</td> 869 </tr> 870 871 <tr> 872 <td>Mask</td> 873 <td>mask=><i>image-handle</i></td> 874 <td>composite image pixels as defined by the mask</td> 875 </tr> 876 877 <tr> 878 <td>MatteFloodfill</td> 879 <td>geometry=><i>geometry</i>, x=><i>integer</i>, y=><i>integer</i> , matte=><i>integer</i>, bordercolor=><i><a href="color.html">color name</a></i>, fuzz=><i>double</i>, invert=>{True, False}</td> 880 <td>changes the matte value of any pixel that matches the color of the target pixel and is a neighbor. If you specify a border color, the matte value is changed for any neighbor pixel that is not that color.</td> 881 </tr> 882 883 <tr> 884 <td>MeanShift</td> 885 <td>geometry=><i>geometry</i>, width=><i>double</i>, height=><i>double</i>, distance=><i>double</i></td> 886 <td>delineate arbitrarily shaped clusters in the image (e.g. MeanShift('7x7+10%')).</td> 887 </tr> 888 889 <tr> 890 <td>MedianFilter</td> 891 <td>geometry=><i>geometry</i>, width=><i>integer</i>, height=><i>integer</i>, channel=>{All, Default, Alpha, Black, Blue, CMYK, Cyan, Gray, Green, Index, Magenta, Alpha, Red, RGB, Yellow}</td> 892 <td>replace each pixel with the median intensity pixel of a neighborhood.</td> 893 </tr> 894 895 <tr> 896 <td>Minify</td> 897 <td><br /></td> 898 <td>half the size of an image</td> 899 </tr> 900 901 <tr> 902 <td>Mode</td> 903 <td>geometry=><i>geometry</i>, width=><i>integer</i>, height=><i>integer</i>, channel=>{All, Default, Alpha, Black, Blue, CMYK, Cyan, Gray, Green, Index, Magenta, Alpha, Red, RGB, Yellow}</td> 904 <td>make each pixel the <var>predominant color</var> of the neighborhood.</td> 905 </tr> 906 907 <tr> 908 <td>Modulate</td> 909 <td>factor=><i>geometry</i>, brightness=><i>double</i>, saturation=><i>double</i>, hue=><i>double</i>, lightness=><i>double</i>, whiteness=><i>double</i>, blackness=><i>double</i> </td> 910 <td>vary the brightness, saturation, and hue of an image by the specified percentage</td> 911 </tr> 912 913 <tr> 914 <td>Morphology</td> 915 <td>kernel=><i>string</i>, channel=>{All, Default, Alpha, Black, Blue, CMYK, Cyan, Gray, Green, Index, Magenta, Alpha, Red, RGB, Yellow}, iterations=><i>integer</i></td> 916 <td>apply a morphology method to the image.</td> 917 </tr> 918 919 <tr> 920 <td>MotionBlur</td> 921 <td>geometry=><i>geometry</i>, radius=><i>double</i>, sigma=><i>double</i>, angle=><i>double</i>, bias=><i>double</i>, channel=>{All, Default, Alpha, Black, Blue, CMYK, Cyan, Gray, Green, Index, Magenta, Alpha, Red, RGB, Yellow}</td> 922 <td>reduce image noise and reduce detail levels with a Gaussian operator of the given radius and standard deviation (sigma) at the given angle to simulate the effect of motion</td> 923 </tr> 924 925 <tr> 926 <td>Negate</td> 927 <td>gray=>{True, False}, channel=>{All, Default, Alpha, Black, Blue, CMYK, Cyan, Gray, Green, Index, Magenta, Alpha, Red, RGB, Yellow}</td> 928 <td>replace each pixel with its complementary color (white becomes black, yellow becomes blue, etc.)</td> 929 </tr> 930 931 <tr> 932 <td>Normalize</td> 933 <td>channel=>{All, Default, Alpha, Black, Blue, CMYK, Cyan, Gray, Green, Index, Magenta, Alpha, Red, RGB, Yellow}<br /></td> 934 <td>transform image to span the full range of color values</td> 935 </tr> 936 937 <tr> 938 <td>OilPaint</td> 939 <td>radius=><i>integer</i></td> 940 <td>simulate an oil painting</td> 941 </tr> 942 943 <tr> 944 <td>Opaque</td> 945 <td>color=><i><a href="color.html">color name</a></i>, 946fill=><i><a href="color.html">color name</a></i>, channel=>{All, Default, Alpha, Black, Blue, CMYK, Cyan, Gray, Green, Index, Magenta, Alpha, Red, RGB, Yellow}, invert=>{True, False}</td> 947 <td>change this color to the fill color within the image</td> 948 </tr> 949 950 <tr> 951 <td>OrderedDither</td> 952 <td>threshold=>{threshold, checks, o2x2, o3x3, o4x4, o8x8, h4x4a, h6x6a, h8x8a, h4x4o, h6x6o, h8x8o, h16x16o, hlines6x4}, channel=>{All, Default, Alpha, Black, Blue, CMYK, Cyan, Gray, Green, Index, Magenta, Alpha, Red, RGB, Yellow}</td> 953 <td>order dither image</td> 954 </tr> 955 956 <tr> 957 <td>Perceptible</td> 958 <td>epsilon=><i>double</i>, channel=>{Red, RGB, All, etc.}</td> 959 <td>set each pixel whose value is less than |<var>epsilon</var>| to <var>-epsilon</var> or <var>epsilon</var> (whichever is closer) otherwise the pixel value remains unchanged..</td> 960 </tr> 961 962 <tr> 963 <td>Polaroid</td> 964 <td>caption=><i>string</i>, angle=><i>double</i>, pointsize=><i>double</i>, font=><i>string</i>, stroke=> <i><a href="color.html">color name</a></i>, strokewidth=><i>integer</i>, fill=><i><a href="color.html">color name</a></i>, gravity=>{NorthWest, North, NorthEast, West, Center, East, SouthWest, South, SouthEast}, background=><i><a href="color.html">color name</a></i></td> 965 <td>simulate a Polaroid picture.</td> 966 </tr> 967 968 <tr> 969 <td>Posterize</td> 970 <td>levels=><i>integer</i>, dither=>{True, False}</td> 971 <td>reduce the image to a limited number of color level</td> 972 </tr> 973 974 <tr> 975 <td>Profile</td> 976 <td>name=><i>string</i>, profile=><i>blob</i>, rendering-intent=>{Undefined, Saturation, Perceptual, Absolute, Relative}, black-point-compensation=>{True, False}</td> 977 <td>add or remove ICC or IPTC image profile; name is formal name (e.g. ICC or filename; set profile to <code>''</code> to remove profile</td> 978 </tr> 979 980 <tr> 981 <td>Quantize</td> 982 <td>colors=><i>integer</i>, colorspace=>{RGB, Gray, Transparent, OHTA, XYZ, YCbCr, YIQ, YPbPr, YUV, CMYK, sRGB, HSL, HSB}, treedepth=> <i>integer</i>, dither=>{True, False}, dither-method=>{Riemersma, Floyd-Steinberg}, measure_error=>{True, False}, global_colormap=>{True, False}, transparent-color=><i>color</i></td> 983 <td>preferred number of colors in the image</td> 984 </tr> 985 986 <tr> 987 <td>Raise</td> 988 <td>geometry=><i>geometry</i>, width=><i>integer</i>, height=><i>integer</i>, x=><i>integer</i>, y=><i>integer</i>, raise=>{True, False}</td> 989 <td>lighten or darken image edges to create a 3-D effect</td> 990 </tr> 991 992 <tr> 993 <td>RangeThreshold</td> 994 <td>geometry=><i>geometry</i>, 'low-black'=><i>double</i>, 'low-white'=><i>double</i>, 'high-white'=><i>double</i>, 'high-black'=><i>double</i></td> 995 <td>combine soft and hard image thresholding.</td> 996 </tr> 997 998 <tr> 999 <td>ReduceNoise</td> 1000 <td>geometry=><i>geometry</i>, width=><i>integer</i>, height=><i>integer</i>, channel=>{All, Default, Alpha, Black, Blue, CMYK, Cyan, Gray, Green, Index, Magenta, Alpha, Red, RGB, Yellow}</td> 1001 <td>reduce noise in the image with a noise peak elimination filter</td> 1002 </tr> 1003 1004 <tr> 1005 <td>Remap</td> 1006 <td>image=><i>image-handle</i>, dither=>{true, false}, dither-method=>{Riemersma, Floyd-Steinberg}</td> 1007 <td>replace the colors of an image with the closest color from a reference image.</td> 1008 </tr> 1009 1010 <tr> 1011 <td>Resample</td> 1012 <td>density=><i>geometry</i>, x=><i>double</i>, y=><i>double</i>, filter=>{Point, Box, Triangle, Hermite, Hanning, Hamming, Blackman, Gaussian, Quadratic, Cubic, Catrom, Mitchell, Lanczos, Bessel, Sinc}, support=><i>double</i></td> 1013 <td>resample image to desired resolution. Specify <code>blur</code> > 1 for blurry or < 1 for sharp</td> 1014 </tr> 1015 1016 <tr> 1017 <td>Resize</td> 1018 <td>geometry=><i>geometry</i>, width=><i>integer</i>, height=><i>integer</i>, filter=>{Point, Box, Triangle, Hermite, Hanning, Hamming, Blackman, Gaussian, Quadratic, Cubic, Catrom, Mitchell, Lanczos, Bessel, Sinc}, support=><i>double</i>, blur=><i>double</i></td> 1019 <td>scale image to desired size. Specify <code>blur</code> > 1 for blurry or < 1 for sharp</td> 1020 </tr> 1021 1022 <tr> 1023 <td>Roll</td> 1024 <td>geometry=><i>geometry</i>, x=><i>integer</i>, y=><i>integer</i></td> 1025 <td>roll an image vertically or horizontally</td> 1026 </tr> 1027 1028 <tr> 1029 <td>Rotate</td> 1030 <td>degrees=><i>double</i>, background=><i><a href="color.html">color name</a></i></td> 1031 <td>rotate an image</td> 1032 </tr> 1033 1034 <tr> 1035 <td>RotationalBlur</td> 1036 <td>geometry=><i>geometry</i>, angle=><i>double</i>, bias=><i>double</i>, channel=>{All, Default, Alpha, Black, Blue, CMYK, Cyan, Gray, Green, Index, Magenta, Alpha, Red, RGB, Yellow}</td> 1037 <td>radial blur the image.</td> 1038 </tr> 1039 1040 <tr> 1041 <td>Sample</td> 1042 <td>geometry=><i>geometry</i>, width=><i>integer</i>, height=><i>integer</i></td> 1043 <td>scale image with pixel sampling.</td> 1044 </tr> 1045 1046 <tr> 1047 <td>Scale</td> 1048 <td>geometry=><i>geometry</i>, width=><i>integer</i>, height=><i>integer</i></td> 1049 <td>scale image to desired size</td> 1050 </tr> 1051 1052 <tr> 1053 <td>Segment</td> 1054 <td>colorspace=>{RGB, Gray, Transparent, OHTA, XYZ, YCbCr, YCC, YIQ, YPbPr, YUV, CMYK}, verbose={True, False}, cluster-threshold=><i>double</i>, smoothing-threshold=<i>double</i></td> 1055 <td>segment an image by analyzing the histograms of the color components and identifying units that are homogeneous</td> 1056 </tr> 1057 1058 <tr> 1059 <td>SelectiveBlur</td> 1060 <td>geometry=><i>geometry</i>, radius=><i>double</i>, sigma=><i>double</i>, threshold=><i>double</i>, bias=><i>double</i>, channel=>{All, Default, Alpha, Black, Blue, CMYK, Cyan, Gray, Green, Index, Magenta, Alpha, Red, RGB, Yellow}</td> 1061 <td>selectively blur pixels within a contrast threshold.</td> 1062 </tr> 1063 <tr> 1064 <td>Separate</td> 1065 <td>channel=>{Red, RGB, All, etc.}</td> 1066 <td>separate a channel from the image into a grayscale image</td> 1067 </tr> 1068 1069 <tr> 1070 <td>Shade</td> 1071 <td>geometry=><i>geometry</i>, azimuth=><i>double</i>, elevation=><i>double</i>, gray=>{true, false}</td> 1072 <td>shade the image using a distant light source</td> 1073 </tr> 1074 1075 <tr> 1076 <td>SetPixel</td> 1077 <td>geometry=><i>geometry</i>, channel=>{All, Default, Alpha, Black, Blue, CMYK, Cyan, Gray, Green, Index, Magenta, Alpha, Red, RGB, Yellow}, color=><i>array of float values</i>, x=><i>integer</i>, y=><i>integer</i>, color=><i>array of float values</i></td> 1078 <td>set the value a single pixel. Normalized pixel values are expected.</td> 1079 </tr> 1080 1081 <tr> 1082 <td>SetPixels</td> 1083 <td>geometry=><i>geometry</i>, channel=>{All, Default, Alpha, Black, Blue, CMYK, Cyan, Gray, Green, Index, Magenta, Alpha, Red, RGB, Yellow}, color=><i>array of float values</i>, width=><i>integer</i>, height=><i>integer</i>, x=><i>integer</i>, y=><i>integer</i>, color=><i>array of float values</i></td> 1084 <td>set the value of one or more pixels. Normalized pixel values are expected.</td> 1085 </tr> 1086 1087 <tr> 1088 <td>Shadow</td> 1089 <td>geometry=><i>geometry</i>, opacity=><i>double</i>, sigma=><i>double</i>, x=><i>integer</i>, y=><i>integer</i></td> 1090 <td>simulate an image shadow</td> 1091 </tr> 1092 1093 <tr> 1094 <td>Sharpen</td> 1095 <td>geometry=><i>geometry</i>, radius=><i>double</i>, sigma=><i>double</i>, bias=><i>double</i>, channel=>{All, Default, Alpha, Black, Blue, CMYK, Cyan, Gray, Green, Index, Magenta, Alpha, Red, RGB, Yellow}</td> 1096 <td>sharpen the image with a Gaussian operator of the given radius and standard deviation (sigma).</td> 1097 </tr> 1098 1099 <tr> 1100 <td>Shave</td> 1101 <td>geometry=><i>geometry</i>, width=><i>integer</i>, height=><i>integer</i></td> 1102 <td>shave pixels from the image edges</td> 1103 </tr> 1104 1105 <tr> 1106 <td>Shear</td> 1107 <td>geometry=><i>geometry</i>, x=><i>double</i>, y=><i>double</i> fill=><i><a href="color.html">color name</a></i></td> 1108 <td>shear the image along the X or Y axis by a positive or negative shear angle</td> 1109 </tr> 1110 1111 <tr> 1112 <td>SigmoidalContrast</td> 1113 <td>geometry=><i>string</i>, 'contrast'=><i>double</i>, 'mid-point'=><i>double</i> channel=>{Red, RGB, All, etc.}, sharpen=>{True, False}</td> 1114 <td>sigmoidal non-lineraity contrast control. Increase the contrast of the image using a sigmoidal transfer function without saturating highlights or shadows. <var>Contrast</var> indicates how much to increase the contrast (0 is none; 3 is typical; 20 is a lot); <var>mid-point</var> indicates where midtones fall in the resultant image (0 is white; 50% is middle-gray; 100% is black). To decrease contrast, set sharpen to False.</td> 1115 </tr> 1116 1117 <tr> 1118 <td>Signature</td> 1119 <td><br /></td> 1120 <td>generate an SHA-256 message digest for the image pixel stream</td> 1121 </tr> 1122 1123 <tr> 1124 <td>Sketch</td> 1125 <td>geometry=><i>geometry</i>, radius=><i>double</i>, sigma=><i>double</i>, angle=><i>double</i></td> 1126 <td>sketch the image with a Gaussian operator of the given radius and standard deviation (sigma) at the given angle</td> 1127 </tr> 1128 1129 <tr> 1130 <td>Solarize</td> 1131 <td>geometry=><i>string</i>, threshold=><i>double</i>, channel=>{All, Default, Alpha, Black, Blue, CMYK, Cyan, Gray, Green, Index, Magenta, Alpha, Red, RGB, Yellow}</td> 1132 <td>negate all pixels above the threshold level</td> 1133 </tr> 1134 1135 <tr> 1136 <td>SparseColor</td> 1137 <td>points=><i>array of float values</i>, method=>{Barycentric, Bilinear, Shepards, Voronoi}, 'virtual-pixel'=>{Background Black Constant Dither Edge Gray Mirror Random Tile Transparent White}</td> 1138 <td>interpolate the image colors around the supplied points</td> 1139 </tr> 1140 1141 <tr> 1142 <td>Splice</td> 1143 <td>geometry=><i>geometry</i>, width=><i>integer</i>, height=><i>integer</i>, x=><i>integer</i>, y=><i>integer</i>, fuzz=><i>double</i>, background=><i><a href="color.html">color name</a></i>, gravity=>{NorthWest, North, NorthEast, West, Center, East, SouthWest, South, SouthEast}</td> 1144 <td>splice an image</td> 1145 </tr> 1146 1147 <tr> 1148 <td>Spread</td> 1149 <td>radius=><i>double</i>, interpolate=>{undefined, average, bicubic, bilinear, mesh, nearest-neighbor, spline}</td> 1150 <td>displace image pixels by a random amount</td> 1151 </tr> 1152 1153 <tr> 1154 <td>Statistic</td> 1155 <td>geometry=><i>geometry</i>, width=><i>integer</i>, height=><i>integer</i>, channel=>{All, Default, Alpha, Black, Blue, CMYK, Cyan, Gray, Green, Index, Magenta, Alpha, Red, RGB, Yellow}, type=>{Median, Mode, Mean, Maximum, Minimum, ReduceNoise, RMS}</td> 1156 <td>replace each pixel with corresponding statistic from the neighborhood.</td> 1157 </tr> 1158 <tr> 1159 <td>Stegano</td> 1160 <td>image=><i>image-handle</i>, offset=><i>integer</i></td> 1161 <td>hide a digital watermark within the image</td> 1162 </tr> 1163 1164 <tr> 1165 <td>Stereo</td> 1166 <td>image=><i>image-handle</i>, x=><i>integer</i>, y=><i>integer</i></td> 1167 <td>composites two images and produces a single image that is the composite of a left and right image of a stereo pair</td> 1168 </tr> 1169 1170 <tr> 1171 <td>Strip</td> 1172 <td><br /></td> 1173 <td>strip an image of all profiles and comments.</td> 1174 </tr> 1175 1176 <tr> 1177 <td>Swirl</td> 1178 <td>degrees=><i>double</i>, interpolate=>{undefined, average, bicubic, bilinear, mesh, nearest-neighbor, spline}</td> 1179 <td>swirl image pixels about the center</td> 1180 </tr> 1181 1182 <tr> 1183 <td>Texture</td> 1184 <td>texture=><i>image-handle</i></td> 1185 <td>name of texture to tile onto the image background</td> 1186 </tr> 1187 1188 <tr> 1189 <td>Thumbnail</td> 1190 <td>geometry=><i>geometry</i>, width=><i>integer</i>, height=><i>integer</i></td> 1191 <td>changes the size of an image to the given dimensions and removes any associated profiles.</td> 1192 </tr> 1193 1194 <tr> 1195 <td>Threshold</td> 1196 <td>threshold=><i>string</i>, channel=>{All, Default, Alpha, Black, Blue, CMYK, Cyan, Gray, Green, Index, Magenta, Alpha, Red, RGB, Yellow}</td> 1197 <td>threshold the image</td> 1198 </tr> 1199 1200 <tr> 1201 <td>Tint</td> 1202 <td>fill=><i><a href="color.html">color name</a></i>, blend=><i>string</i></td> 1203 <td>tint the image with the fill color.</td> 1204 </tr> 1205 1206 <tr> 1207 <td>Transparent</td> 1208 <td>color=><i><a href="color.html">color name</a></i>, invert=>{True, False}</td> 1209 <td>make this color transparent within the image</td> 1210 </tr> 1211 1212 <tr> 1213 <td>Transpose</td> 1214 <td><br /></td> 1215 <td>flip image in the vertical direction and rotate 90 degrees</td> 1216 </tr> 1217 1218 <tr> 1219 <td>Transverse</td> 1220 <td><br /></td> 1221 <td>flop image in the horizontal direction and rotate 270 degrees</td> 1222 </tr> 1223 1224 <tr> 1225 <td>Trim</td> 1226 <td><br /></td> 1227 <td>remove edges that are the background color from the image</td> 1228 </tr> 1229 1230 <tr> 1231 <td>UnsharpMask</td> 1232 <td>geometry=><i>geometry</i>, radius=><i>double</i>, sigma=><i>double</i>, gain=><i>double</i>, threshold=><i>double</i></td> 1233 <td>sharpen the image with the unsharp mask algorithm.</td> 1234 </tr> 1235 1236 <tr> 1237 <td>Vignette</td> 1238 <td>geometry=><i>geometry</i>, radius=><i>double</i>, sigma=><i>double</i>, x=><i>integer</i>, y=><i>integer</i>, background=><i><a href="color.html">color name</a></i></td> 1239 <td>offset the edges of the image in vignette style</td> 1240 </tr> 1241 1242 <tr> 1243 <td>Wave</td> 1244 <td>geometry=><i>geometry</i>, amplitude=><i>double</i>, wavelength=><i>double</i>, interpolate=>{undefined, average, bicubic, bilinear, mesh, nearest-neighbor, spline}</td> 1245 <td>alter an image along a sine wave</td> 1246 </tr> 1247 1248 <tr> 1249 <td>WaveDenoise</td> 1250 <td>geometry=><i>geometry</i>, threshold=><i>double</i>, threshold=><i>double</i></td> 1251 <td>removes noise from the image using a wavelet transform</td> 1252 </tr> 1253 1254 <tr> 1255 <td>WhiteThreshold</td> 1256 <td>threshold=><i>string</i>, , channel=>{All, Default, Alpha, Black, Blue, CMYK, Cyan, Gray, Green, Index, Magenta, Alpha, Red, RGB, Yellow}</td> 1257 <td>force all pixels above the threshold intensity into white</td> 1258 </tr> 1259</tbody> 1260</table> 1261 1262<p>Note, that the <code>geometry</code> parameter is a short cut for the <code>width</code> and <code>height</code> parameters (e.g. <code>geometry=>'106x80'</code> is equivalent to <code>width=>106, height=>80</code> ).</p> 1263 1264<p>You can specify <code>@filename</code> in both Annotate() and Draw(). This reads the text or graphic primitive instructions from a file on disk. For example,</p> 1265 1266<pre class="highlight"><code>image->Draw(fill=>'red', primitive=>'rectangle', 1267 points=>'20,20 100,100 40,40 200,200 60,60 300,300'); 1268</code></pre> 1269 1270<p>Is equivalent to</p> 1271 1272<pre class="highlight"><code>$image->Draw(fill=>'red', primitive=>'@draw.txt'); 1273</code></pre> 1274 1275<p>Where <code>draw.txt</code> is a file on disk that contains this:</p> 1276 1277<pre class="highlight"><code>rectangle 20, 20 100, 100 1278rectangle 40, 40 200, 200 1279rectangle 60, 60 300, 300 1280</code></pre> 1281 1282<p>The <i>text</i> parameter for methods, Annotate(), Comment(), Draw(), and Label() can include the image filename, type, width, height, or other image attribute by embedding these special format characters:</p> 1283 1284<pre class="pre-scrollable"><code>%b file size 1285%c comment 1286%d directory 1287%e filename extension 1288%f filename 1289%g page geometry 1290%h height 1291%i input filename 1292%k number of unique colors 1293%l label 1294%m magick 1295%n number of scenes 1296%o output filename 1297%p page number 1298%q quantum depth 1299%r image class and colorspace 1300%s scene number 1301%t top of filename 1302%u unique temporary filename 1303%w width 1304%x x resolution 1305%y y resolution 1306%z image depth 1307%C image compression type 1308%D image dispose method 1309%H page height 1310%Q image compression quality 1311%T image delay 1312%W page width 1313%X page x offset 1314%Y page y offset 1315%@ bounding box 1316%# signature 1317%% a percent sign 1318\n newline 1319\r carriage return 1320</code></pre> 1321 1322<p>For example,</p> 1323 1324<pre class="highlight"><code>text=>"%m:%f %wx%h" 1325</code></pre> 1326 1327<p>produces an annotation of <b>MIFF:bird.miff 512x480</b> for an image titled <b>bird.miff</b> and whose width is 512 and height is 480.</p> 1328 1329<p>You can optionally add <i>Image</i> to any method name. For example, TrimImage() is an alias for method Trim().</p> 1330 1331<p>Most of the attributes listed above have an analog in <a href="convert.html">convert</a>. See the documentation for a more detailed description of these attributes.</p> 1332 1333<h2><a class="anchor" id="set-attribute"></a>Set an Image Attribute</h2> 1334 1335<p>Use method Set() to set an image attribute. For example,</p> 1336 1337<pre class="highlight"><code>$image->Set(dither=>'True'); 1338$image->[$x]->Set(delay=>3); 1339</code></pre> 1340 1341<p>Where this example uses 'True' and this document says '{True, False}', 1342you can use the case-insensitive strings 'True' and 'False', or you 1343can use the integers 1 and 0.</p> 1344 1345<p>When you call Get() on a Boolean attribute, Image::Magick returns 1 or 0, not a string.</p> 1346 1347<p>And here is a list of all the image attributes you can set:</p> 1348 1349<table class="table table-sm table-striped"> 1350 <caption>Image Attributes</caption> 1351 <tbody> 1352 <tr> 1353 <th>Attribute</th> 1354 <th style="width: 40%">Values</th> 1355 <th style="width: 40%">Description</th> 1356 </tr> 1357 1358 <tr> 1359 <td>adjoin</td> 1360 <td>{True, False}</td> 1361 <td>join images into a single multi-image file</td> 1362 </tr> 1363 1364 <tr> 1365 <td>alpha</td> 1366 <td>{On, Off, Opaque, Transparent, Copy, Extract, Set}</td> 1367 <td>control of and special operations involving the alpha/matte channel</td> 1368 </tr> 1369 1370 <tr> 1371 <td>antialias</td> 1372 <td>{True, False}</td> 1373 <td>remove pixel aliasing</td> 1374 </tr> 1375 1376 <tr> 1377 <td>area-limit</td> 1378 <td><i>integer</i></td> 1379 <td>set pixel area resource limit.</td> 1380 </tr> 1381 1382 <tr> 1383 <td>attenuate</td> 1384 <td><i>double</i></td> 1385 <td>lessen (or intensify) when adding noise to an image.</td> 1386 </tr> 1387 1388 <tr> 1389 <td>authenticate</td> 1390 <td><i>string</i></td> 1391 <td>decrypt image with this password.</td> 1392 </tr> 1393 1394 <tr> 1395 <td>background</td> 1396 <td><i><a href="color.html">color name</a></i></td> 1397 <td>image background color</td> 1398 </tr> 1399 1400 <tr> 1401 <td>blue-primary</td> 1402 <td><i>x-value</i>, <i>y-value</i></td> 1403 <td>chromaticity blue primary point (e.g. 0.15, 0.06)</td> 1404 </tr> 1405 1406 <tr> 1407 <td>bordercolor</td> 1408 <td><i><a href="color.html">color name</a></i></td> 1409 <td>set the image border color</td> 1410 </tr> 1411 1412 <tr> 1413 <td>clip-mask</td> 1414 <td><i>image</i></td> 1415 <td>associate a clip mask with the image.</td> 1416 </tr> 1417 1418 <tr> 1419 <td>colormap[<i>i</i>]</td> 1420 <td><i><a href="color.html">color name</a></i></td> 1421 <td>color name (e.g. red) or hex value (e.g. #ccc) at position 1422<i>i</i></td> 1423 </tr> 1424 1425 <tr> 1426 <td>comment</td> 1427 <td><i>string</i></td> 1428 <td>set the image comment</td> 1429 </tr> 1430 1431 <tr> 1432 <td>compression</td> 1433 <td>{None, BZip, Fax, Group4, JPEG, JPEG2000, LosslessJPEG, LZW, RLE, Zip}</td> 1434 <td>type of image compression</td> 1435 </tr> 1436 1437 <tr> 1438 <td>debug</td> 1439 <td>{All, Annotate, Blob, Cache, Coder, Configure, Deprecate, Draw, Exception, Locale, None, Resource, Transform, X11}</td> 1440 <td>display copious debugging information</td> 1441 </tr> 1442 1443 <tr> 1444 <td>delay</td> 1445 <td><i>integer</i></td> 1446 <td>this many 1/100ths of a second must expire before displaying the next image in a sequence</td> 1447 </tr> 1448 1449 <tr> 1450 <td>density</td> 1451 <td><i>geometry</i></td> 1452 <td>vertical and horizontal resolution in pixels of the image</td> 1453 </tr> 1454 1455 <tr> 1456 <td>depth</td> 1457 <td><i>integer</i></td> 1458 <td>image depth</td> 1459 </tr> 1460 1461 <tr> 1462 <td>direction</td> 1463 <td><i>{Undefined, right-to-left, left-to-right</i></td> 1464 <td>render text right-to-left or left-to-right</td> 1465 </tr> 1466 1467 <tr> 1468 <td>disk-limit</td> 1469 <td><i>integer</i></td> 1470 <td>set disk resource limit</td> 1471 </tr> 1472 1473 <tr> 1474 <td>dispose</td> 1475 <td><i>{Undefined, None, Background, Previous}</i></td> 1476 <td>layer disposal method</td> 1477 </tr> 1478 1479 <tr> 1480 <td>dither</td> 1481 <td>{True, False}</td> 1482 <td>apply error diffusion to the image</td> 1483 </tr> 1484 1485 <tr> 1486 <td>display</td> 1487 <td><i>string</i></td> 1488 <td>specifies the X server to contact</td> 1489 </tr> 1490 1491 <tr> 1492 <td>extract</td> 1493 <td><i>geometry</i></td> 1494 <td>extract area from image</td> 1495 </tr> 1496 1497 <tr> 1498 <td>file</td> 1499 <td><i>filehandle</i></td> 1500 <td>set the image filehandle</td> 1501 </tr> 1502 1503 <tr> 1504 <td>filename</td> 1505 <td><i>string</i></td> 1506 <td>set the image filename</td> 1507 </tr> 1508 1509 <tr> 1510 <td>fill</td> 1511 <td><i>color</i></td> 1512 <td>The fill color paints any areas inside the outline of drawn shape.</td> 1513 </tr> 1514 1515 <tr> 1516 <td>font</td> 1517 <td><i>string</i></td> 1518 <td>use this font when annotating the image with text</td> 1519 </tr> 1520 1521 <tr> 1522 <td>fuzz</td> 1523 <td><i>integer</i></td> 1524 <td>colors within this distance are considered equal</td> 1525 </tr> 1526 1527 <tr> 1528 <td>gamma</td> 1529 <td><i>double</i></td> 1530 <td>gamma level of the image</td> 1531 </tr> 1532 1533 <tr> 1534 <td>Gravity</td> 1535 <td>{Forget, NorthWest, North, NorthEast, West, Center, East, SouthWest, South, SouthEast}</td> 1536 <td>type of image gravity</td> 1537 </tr> 1538 1539 <tr> 1540 <td>green-primary</td> 1541 <td><i>x-value</i>, <i>y-value</i></td> 1542 <td>chromaticity green primary point (e.g. 0.3, 0.6)</td> 1543 </tr> 1544 1545 <tr> 1546 <td>index[<i>x</i>, <i>y</i>]</td> 1547 <td><i>string</i></td> 1548 <td>colormap index at position (<i>x</i>, <i>y</i>)</td> 1549 </tr> 1550 1551 <tr> 1552 <td>interlace</td> 1553 <td>{None, Line, Plane, Partition, JPEG, GIF, PNG}</td> 1554 <td>the type of interlacing scheme</td> 1555 </tr> 1556 1557 <tr> 1558 <td>iterations</td> 1559 <td><i>integer</i></td> 1560 <td>add Netscape loop extension to your GIF animation</td> 1561 </tr> 1562 1563 <tr> 1564 <td>label</td> 1565 <td><i>string</i></td> 1566 <td>set the image label</td> 1567 </tr> 1568 1569 <tr> 1570 <td>loop</td> 1571 <td><i>integer</i></td> 1572 <td>add Netscape loop extension to your GIF animation</td> 1573 </tr> 1574 1575 <tr> 1576 <td>magick</td> 1577 <td><i>string</i></td> 1578 <td>set the image format</td> 1579 </tr> 1580 1581 <tr> 1582 <td>map-limit</td> 1583 <td><i>integer</i></td> 1584 <td>set map resource limit</td> 1585 </tr> 1586 1587 <tr> 1588 <td>mask</td> 1589 <td><i>image</i></td> 1590 <td>associate a mask with the image.</td> 1591 </tr> 1592 1593 <tr> 1594 <td>matte</td> 1595 <td>{True, False}</td> 1596 <td>enable the image matte channel</td> 1597 </tr> 1598 1599 <tr> 1600 <td>mattecolor</td> 1601 <td><i><a href="color.html">color name</a></i></td> 1602 <td>set the image matte color</td> 1603 </tr> 1604 1605 <tr> 1606 <td>memory-limit</td> 1607 <td><i>integer</i></td> 1608 <td>set memory resource limit</td> 1609 </tr> 1610 1611 <tr> 1612 <td>monochrome</td> 1613 <td>{True, False}</td> 1614 <td>transform the image to black and white</td> 1615 </tr> 1616 1617 <tr> 1618 <td>option</td> 1619 <td><i>string</i></td> 1620 <td>associate an option with an image format (e.g. option=>'ps:imagemask'</td> 1621 </tr> 1622 1623 <tr> 1624 <td>orientation</td> 1625 <td>{top-left, top-right, bottom-right, bottom-left, left-top, right-top, right-bottom, left-bottom}</td> 1626 <td>image orientation</td> 1627 </tr> 1628 1629 <tr> 1630 <td>page</td> 1631 <td>{ Letter, Tabloid, Ledger, Legal, Statement, Executive, A3, A4, A5, B4, B5, Folio, Quarto, 10x14} or <i>geometry</i></td> 1632 <td>preferred size and location of an image canvas</td> 1633 </tr> 1634 1635 <tr> 1636 <td>pixel[<i>x</i>, <i>y</i>]</td> 1637 <td><i>string</i></td> 1638 <td>hex value (e.g. #ccc) at position (<i>x</i>, <i>y</i>)</td> 1639 </tr> 1640 1641 <tr> 1642 <td>pointsize</td> 1643 <td><i>integer</i></td> 1644 <td>pointsize of the Postscript or TrueType font</td> 1645 </tr> 1646 1647 <tr> 1648 <td>quality</td> 1649 <td><i>integer</i></td> 1650 <td>JPEG/MIFF/PNG compression level</td> 1651 </tr> 1652 1653 <tr> 1654 <td>red-primary</td> 1655 <td><i>x-value</i>, <i>y-value</i></td> 1656 <td>chromaticity red primary point (e.g. 0.64, 0.33)</td> 1657 </tr> 1658 1659 <tr> 1660 <td>sampling-factor</td> 1661 <td><i>geometry</i></td> 1662 <td>horizontal and vertical sampling factor</td> 1663 </tr> 1664 1665 <tr> 1666 <td>scene</td> 1667 <td><i>integer</i></td> 1668 <td>image scene number</td> 1669 </tr> 1670 1671 <tr> 1672 <td>server</td> 1673 <td><i>string</i></td> 1674 <td>specifies the X server to contact</td> 1675 </tr> 1676 1677 <tr> 1678 <td>size</td> 1679 <td><i>string</i></td> 1680 <td>width and height of a raw image</td> 1681 </tr> 1682 1683 <tr> 1684 <td>stroke</td> 1685 <td><i>color</i></td> 1686 <td>The stroke color paints along the outline of a shape.</td> 1687 </tr> 1688 1689 <tr> 1690 <td>texture</td> 1691 <td><i>string</i></td> 1692 <td>name of texture to tile onto the image background</td> 1693 </tr> 1694 1695 <tr> 1696 <td>tile-offset</td> 1697 <td><i>geometry</i></td> 1698 <td>image tile offset</td> 1699 </tr> 1700 1701 <tr> 1702 <td>time-limit</td> 1703 <td><i>integer</i></td> 1704 <td>set time resource limit in seconds</td> 1705 </tr> 1706 1707 <tr> 1708 <td>type</td> 1709 <td>{Bilevel, Grayscale, GrayscaleMatte, Palette, PaletteMatte, TrueColor, TrueColorMatte, ColorSeparation, ColorSeparationMatte}</td> 1710 <td>image type</td> 1711 </tr> 1712 1713 <tr> 1714 <td>units</td> 1715 <td>{ Undefined, PixelsPerInch, PixelsPerCentimeter}</td> 1716 <td>units of image resolution</td> 1717 </tr> 1718 1719 <tr> 1720 <td>verbose</td> 1721 <td>{True, False}</td> 1722 <td>print detailed information about the image</td> 1723 </tr> 1724 1725 <tr> 1726 <td>virtual-pixel</td> 1727 <td>{Background Black Constant Dither Edge Gray Mirror Random Tile Transparent White}</td> 1728 <td>the virtual pixel method</td> 1729 </tr> 1730 1731 <tr> 1732 <td>white-point</td> 1733 <td><i>x-value</i>, <i>y-value</i></td> 1734 <td>chromaticity white point (e.g. 0.3127, 0.329)</td> 1735 </tr> 1736 </tbody> 1737</table> 1738 1739<p>Note, that the <code>geometry</code> parameter is a short cut for the <code>width</code> and <code>height</code> parameters (e.g. <code>geometry=>'106x80'</code> is equivalent to <code>width=>106, height=>80</code>).</p> 1740 1741<p>SetAttribute() is an alias for method Set().</p> 1742 1743<p>Most of the attributes listed above have an analog in 1744<a href="convert.html">convert</a>. See the documentation for a more detailed description of these attributes.</p> 1745 1746<h2><a class="anchor" id="get-attribute"></a>Get an Image Attribute</h2> 1747 1748<p>Use method Get() to get an image attribute. For example,</p> 1749 1750<pre class="highlight"><code>($a, $b, $c) = $image->Get('colorspace', 'magick', 'adjoin'); 1751$width = $image->[3]->Get('columns'); 1752</code></pre> 1753 1754<p>In addition to all the attributes listed in <a href="perl-magick.html#set-attribute">Set an Image Attribute</a> , you can get these additional attributes:</p> 1755 1756<table class="table table-sm table-striped"> 1757 <caption>Image Attributes</caption> 1758 <tbody> 1759 <tr> 1760 <th>Attribute</th> 1761 <th>Values</th> 1762 <th style="width: 60%">Description</th> 1763 </tr> 1764 1765 <tr> 1766 <td>area</td> 1767 <td><i>integer</i></td> 1768 <td>current area resource consumed</td> 1769 </tr> 1770 1771 <tr> 1772 <td>base-columns</td> 1773 <td><i>integer</i></td> 1774 <td>base image width (before transformations)</td> 1775 </tr> 1776 1777 <tr> 1778 <td>base-filename</td> 1779 <td><i>string</i></td> 1780 <td>base image filename (before transformations)</td> 1781 </tr> 1782 1783 <tr> 1784 <td>base-rows</td> 1785 <td><i>integer</i></td> 1786 <td>base image height (before transformations)</td> 1787 </tr> 1788 1789 <tr> 1790 <td>class</td> 1791 <td>{Direct, Pseudo}</td> 1792 <td>image class</td> 1793 </tr> 1794 1795 <tr> 1796 <td>colors</td> 1797 <td><i>integer</i></td> 1798 <td>number of unique colors in the image</td> 1799 </tr> 1800 1801 <tr> 1802 <td>columns</td> 1803 <td><i>integer</i></td> 1804 <td>image width</td> 1805 </tr> 1806 1807 <tr> 1808 <td>copyright</td> 1809 <td><i>string</i></td> 1810 <td>get PerlMagick's copyright</td> 1811 </tr> 1812 1813 <tr> 1814 <td>directory</td> 1815 <td><i>string</i></td> 1816 <td>tile names from within an image montage</td> 1817 </tr> 1818 1819 <tr> 1820 <td>elapsed-time</td> 1821 <td><i>double</i></td> 1822 <td>elapsed time in seconds since the image was created</td> 1823 </tr> 1824 1825 <tr> 1826 <td>error</td> 1827 <td><i>double</i></td> 1828 <td>the mean error per pixel computed with methods Compare() or Quantize()</td> 1829 </tr> 1830 1831 <tr> 1832 <td>bounding-box</td> 1833 <td><i>string</i></td> 1834 <td>image bounding box</td> 1835 </tr> 1836 1837 <tr> 1838 <td>disk</td> 1839 <td><i>integer</i></td> 1840 <td>current disk resource consumed</td> 1841 </tr> 1842 1843 <tr> 1844 <td>filesize</td> 1845 <td><i>integer</i></td> 1846 <td>number of bytes of the image on disk</td> 1847 </tr> 1848 1849 <tr> 1850 <td>format</td> 1851 <td><i>string</i></td> 1852 <td>get the descriptive image format</td> 1853 </tr> 1854 1855 <tr> 1856 <td>geometry</td> 1857 <td><i>string</i></td> 1858 <td>image geometry</td> 1859 </tr> 1860 1861 <tr> 1862 <td>height</td> 1863 <td><i>integer</i></td> 1864 <td>the number of rows or height of an image</td> 1865 </tr> 1866 1867 <tr> 1868 <td>icc</td> 1869 <td><i>string</i></td> 1870 <td>ICC profile</td> 1871 </tr> 1872 1873 <tr> 1874 <td>icc</td> 1875 <td><i>string</i></td> 1876 <td>ICM profile</td> 1877 </tr> 1878 1879 <tr> 1880 <td>id</td> 1881 <td><i>integer</i></td> 1882 <td>ImageMagick registry id</td> 1883 </tr> 1884 1885 <tr> 1886 <td>IPTC</td> 1887 <td><i>string</i></td> 1888 <td>IPTC profile</td> 1889 </tr> 1890 1891 <tr> 1892 <td>mean-error</td> 1893 <td><i>double</i></td> 1894 <td>the normalized mean error per pixel computed with methods Compare() or Quantize()</td> 1895 </tr> 1896 1897 <tr> 1898 <td>map</td> 1899 <td><i>integer</i></td> 1900 <td>current memory-mapped resource consumed</td> 1901 </tr> 1902 1903 <tr> 1904 <td>matte</td> 1905 <td>{True, False}</td> 1906 <td>whether or not the image has a matte channel</td> 1907 </tr> 1908 1909 <tr> 1910 <td>maximum-error</td> 1911 <td><i>double</i></td> 1912 <td>the normalized max error per pixel computed with methods Compare() or Quantize()</td> 1913 </tr> 1914 1915 <tr> 1916 <td>memory</td> 1917 <td><i>integer</i></td> 1918 <td>current memory resource consumed</td> 1919 </tr> 1920 1921 <tr> 1922 <td>mime</td> 1923 <td><i>string</i></td> 1924 <td>MIME of the image format</td> 1925 </tr> 1926 1927 <tr> 1928 <td>montage</td> 1929 <td><i>geometry</i></td> 1930 <td>tile size and offset within an image montage</td> 1931 </tr> 1932 1933 <tr> 1934 <td>page.x</td> 1935 <td><i>integer</i></td> 1936 <td>x offset of image virtual canvas</td> 1937 </tr> 1938 1939 <tr> 1940 <td>page.y</td> 1941 <td><i>integer</i></td> 1942 <td>y offset of image virtual canvas</td> 1943 </tr> 1944 1945 <tr> 1946 <td>rows</td> 1947 <td><i>integer</i></td> 1948 <td>the number of rows or height of an image</td> 1949 </tr> 1950 1951 <tr> 1952 <td>signature</td> 1953 <td><i>string</i></td> 1954 <td>SHA-256 message digest associated with the image pixel stream</td> 1955 </tr> 1956 1957 <tr> 1958 <td>taint</td> 1959 <td>{True, False}</td> 1960 <td>True if the image has been modified</td> 1961 </tr> 1962 1963 <tr> 1964 <td>total-ink-density</td> 1965 <td><i>double</i></td> 1966 <td>returns the total ink density for a CMYK image</td> 1967 </tr> 1968 1969 <tr> 1970 <td>transparent-color</td> 1971 <td><i><a href="color.html">color name</a></i></td> 1972 <td>set the image transparent color</td> 1973 </tr> 1974 1975 <tr> 1976 <td>user-time</td> 1977 <td><i>double</i></td> 1978 <td>user time in seconds since the image was created</td> 1979 </tr> 1980 1981 <tr> 1982 <td>version</td> 1983 <td><i>string</i></td> 1984 <td>get PerlMagick's version</td> 1985 </tr> 1986 1987 <tr> 1988 <td>width</td> 1989 <td><i>integer</i></td> 1990 <td>the number of columns or width of an image</td> 1991 </tr> 1992 1993 <tr> 1994 <td>XMP</td> 1995 <td><i>string</i></td> 1996 <td>XMP profile</td> 1997 </tr> 1998 1999 <tr> 2000 <td>x-resolution</td> 2001 <td><i>integer</i></td> 2002 <td>x resolution of the image</td> 2003 </tr> 2004 2005 <tr> 2006 <td>y-resolution</td> 2007 <td><i>integer</i></td> 2008 <td>y resolution of the image</td> 2009 </tr> 2010 </tbody> 2011</table> 2012 2013<p>GetAttribute() is an alias for method Get().</p> 2014 2015<p>Most of the attributes listed above have an analog in 2016<a href="convert.html">convert</a>. See the documentation for a more detailed description of these attributes.</p> 2017 2018<h2><a class="anchor" id="compare"></a>Compare an Image to its Reconstruction</h2> 2019 2020<p>Mathematically and visually annotate the difference between an image and its reconstruction with the Compare() method. The method supports these parameters:</p> 2021 2022<table class="table table-sm table-striped"> 2023 <caption>Compare Parameters</caption> 2024 <tbody> 2025 <tr> 2026 <th>Parameter</th> 2027 <th style="width: 40%">Values</th> 2028 <th style="width: 40%">Description</th> 2029 </tr> 2030 2031 <tr> 2032 <td>channel</td> 2033 <td><i>double</i></td> 2034 <td>select image channels, the default is all channels except alpha.</td> 2035 </tr> 2036 2037 <tr> 2038 <td>fuzz</td> 2039 <td><i>double</i></td> 2040 <td>colors within this distance are considered equal</td> 2041 </tr> 2042 2043 <tr> 2044 <td>image</td> 2045 <td><i>image-reference</i></td> 2046 <td>the image reconstruction</td> 2047 </tr> 2048 2049 <tr> 2050 <td>metric</td> 2051 <td>AE, MAE, MEPP, MSE, PAE, PSNR, RMSE</td> 2052 <td>measure differences between images with this metric</td> 2053 </tr> 2054 </tbody> 2055</table> 2056 2057<p>In this example, we compare the ImageMagick logo to a sharpened reconstruction:</p> 2058 2059<pre class="highlight"><code>use Image::Magick; 2060 2061$logo=Image::Magick->New(); 2062$logo->Read('logo:'); 2063$sharp=Image::Magick->New(); 2064$sharp->Read('logo:'); 2065$sharp->Sharpen('0x1'); 2066$difference=$logo->Compare(image=>$sharp, metric=>'rmse'); 2067print $difference->Get('error'), "\n"; 2068$difference->Display(); 2069</code></pre> 2070 2071<p>In addition to the reported root mean squared error of around 0.024, a difference image is displayed so you can visually identify the difference between the images.</p> 2072 2073<h2><a class="anchor" id="montage"></a>Create an Image Montage</h2> 2074 2075<p>Use method Montage() to create a composite image by combining several separate images. The images are tiled on the composite image with the name of the image optionally appearing just below the individual tile. For example,</p> 2076 2077<pre class="highlight"><code>$image->Montage(geometry=>'160x160', tile=>'2x2', texture=>'granite:'); 2078</code></pre> 2079 2080<p>And here is a list of Montage() parameters you can set:</p> 2081 2082<table class="table table-sm table-striped"> 2083 <caption>Montage Parameters</caption> 2084 <tbody> 2085 <tr> 2086 <th>Parameter</th> 2087 <th style="width: 40%">Values</th> 2088 <th style="width: 40%">Description</th> 2089 </tr> 2090 2091 <tr> 2092 <td>background</td> 2093 <td><i><a href="color.html">color name</a></i></td> 2094 <td>background color name</td> 2095 </tr> 2096 2097 <tr> 2098 <td>border</td> 2099 <td><i>integer</i></td> 2100 <td>image border width</td> 2101 </tr> 2102 2103 <tr> 2104 <td>filename</td> 2105 <td><i>string</i></td> 2106 <td>name of montage image</td> 2107 </tr> 2108 2109 <tr> 2110 <td>fill</td> 2111 <td><a href="color.html">color name</a></td> 2112 <td>fill color for annotations</td> 2113 </tr> 2114 2115 <tr> 2116 <td>font</td> 2117 <td><i>string</i></td> 2118 <td>X11 font name</td> 2119 </tr> 2120 2121 <tr> 2122 <td>frame</td> 2123 <td><i>geometry</i></td> 2124 <td>surround the image with an ornamental border</td> 2125 </tr> 2126 2127 <tr> 2128 <td>geometry</td> 2129 <td><i>geometry</i></td> 2130 <td>preferred tile and border size of each tile of the composite 2131image (e.g. 120x120+4+3>)</td> 2132 </tr> 2133 2134 <tr> 2135 <td>gravity</td> 2136 <td>NorthWest, North, NorthEast, West, Center, East, SouthWest, 2137South, SouthEast</td> 2138 <td>direction image gravitates to within a tile</td> 2139 </tr> 2140 2141 <tr> 2142 <td>label</td> 2143 <td><i>string</i></td> 2144 <td>assign a label to an image</td> 2145 </tr> 2146 2147 <tr> 2148 <td>mode</td> 2149 <td>Frame, Unframe, Concatenate</td> 2150 <td>thumbnail framing options</td> 2151 </tr> 2152 2153 <tr> 2154 <td>pointsize</td> 2155 <td><i>integer</i></td> 2156 <td>pointsize of the Postscript or TrueType font</td> 2157 </tr> 2158 2159 <tr> 2160 <td>shadow</td> 2161 <td>{True, False}</td> 2162 <td>add a shadow beneath a tile to simulate depth</td> 2163 </tr> 2164 2165 <tr> 2166 <td>stroke</td> 2167 <td><a href="color.html">color name</a></td> 2168 <td>stroke color for annotations</td> 2169 </tr> 2170 2171 <tr> 2172 <td>texture</td> 2173 <td><i>string</i></td> 2174 <td>name of texture to tile onto the image background</td> 2175 </tr> 2176 2177 <tr> 2178 <td>tile</td> 2179 <td><i>geometry</i></td> 2180 <td>the number of tiles per row and page (e.g. 6x4)</td> 2181 </tr> 2182 2183 <tr> 2184 <td>title</td> 2185 <td>string</td> 2186 <td>assign a title to the image montage</td> 2187 </tr> 2188 2189 <tr> 2190 <td>transparent</td> 2191 <td><i>string</i></td> 2192 <td>make this color transparent within the image</td> 2193 </tr> 2194 </tbody> 2195</table> 2196 2197<p>Note, that the <code>geometry</code> parameter is a short cut for the <code>width</code> and <code>height</code> parameters (e.g. <code>geometry=>'106x80'</code> is equivalent to <code>width=>106, height=>80</code>).</p> 2198 2199<p>MontageImage() is an alias for method Montage().</p> 2200 2201<p>Most of the attributes listed above have an analog in <a href="montage.html">montage</a>. See the documentation for a more detailed description of these attributes.</p> 2202 2203<h2><a class="anchor" id="blobs"></a>Working with Blobs</h2> 2204 2205<p>A blob contains data that directly represent a particular image 2206format in memory instead of on disk. PerlMagick supports 2207blobs in any of these image <a href="formats.html">formats</a> and provides methods to convert a blob to or from a particular image format.</p> 2208 2209<table class="table table-sm table-striped"> 2210 <caption>Blob Methods</caption> 2211 <tbody> 2212 <tr> 2213 <th>Method</th> 2214 <th>Parameters</th> 2215 <th>Return Value</th> 2216 <th>Description</th> 2217 </tr> 2218 2219 <tr> 2220 <td>ImageToBlob</td> 2221 <td>any image <a href="perl-magick.html#set-attribute">attribute</a></td> 2222 <td>an array of image data in the respective image format</td> 2223 <td>convert an image or image sequence to an array of blobs</td> 2224 </tr> 2225 2226 <tr> 2227 <td>BlobToImage</td> 2228 <td>one or more blobs</td> 2229 <td>the number of blobs converted to an image</td> 2230 <td>convert one or more blobs to an image</td> 2231 </tr> 2232 </tbody> 2233</table> 2234 2235<p>ImageToBlob() returns the image data in their respective formats. You can then print it, save it to an ODBC database, write it to a file, or pipe it to a display program:</p> 2236 2237<pre class="highlight"><code>@blobs = $image->ImageToBlob(); 2238open(DISPLAY,"| display -") || die; 2239binmode DISPLAY; 2240print DISPLAY $blobs[0]; 2241close DISPLAY; 2242</code></pre> 2243 2244<p>Method BlobToImage() returns an image or image sequence converted from the supplied blob:</p> 2245 2246<pre class="highlight"><code>@blob=$db->GetImage(); 2247$image=Image::Magick->new(magick=>'jpg'); 2248$image->BlobToImage(@blob); 2249</code></pre> 2250 2251<h2><a class="anchor" id="direct-access"></a>Direct-access to Image Pixels</h2> 2252 2253<p>Use these methods to obtain direct access to the image pixels:</p> 2254 2255<table class="table table-sm table-striped"> 2256<caption>Direct-access to Image Pixels</caption> 2257<tbody> 2258 <tr> 2259 <th>Method</th> 2260 <th>Parameters</th> 2261 <th style="width: 50%">Description</th> 2262 </tr> 2263 2264 <tr> 2265 <td>GetAuthenticPixels</td> 2266 <td>geometry=><i>geometry</i>, width=><i>integer</i>, height=><i>integer</i>, x=><i>integer</i>, y=><i>integer</i></td> 2267 <td>return authentic pixels as a C pointer</td> 2268 </tr> 2269 2270 <tr> 2271 <td>GetVirtualPixels</td> 2272 <td>geometry=><i>geometry</i>, width=><i>integer</i>, height=><i>integer</i>, x=><i>integer</i>, y=><i>integer</i></td> 2273 <td>return virtual pixels as a const C pointer</td> 2274 </tr> 2275 2276 <tr> 2277 <td>GetAuthenticIndexQueue</td> 2278 <td></td> 2279 <td>return colormap indexes or black pixels as a C pointer</td> 2280 </tr> 2281 2282 <tr> 2283 <td>GetVirtualIndexQueue</td> 2284 <td></td> 2285 <td>return colormap indexes or black pixels as a const C pointer</td> 2286 </tr> 2287 2288 <tr> 2289 <td>SyncAuthenticPixels</td> 2290 <td></td> 2291 <td>sync authentic pixels to pixel cache</td> 2292 </tr> 2293 2294</tbody> 2295</table> 2296 2297<h2><a class="anchor" id="miscellaneous"></a>Miscellaneous Methods</h2> 2298 2299<p>The Append() method append a set of images. For example,</p> 2300 2301<pre class="highlight"><code>$p = $image->Append(stack=>{true,false}); 2302</code></pre> 2303 2304<p>appends all the images associated with object <code>$image</code>. By default, images are stacked left-to-right. Set <code>stack</code> to True to stack them top-to-bottom.</p> 2305 2306<p>The Clone() method copies a set of images. For example,</p> 2307 2308<pre class="highlight"><code>$q = $p->Clone(); 2309</code></pre> 2310 2311<p>copies all the images from object <code>$p</code> to <code>$q</code>. You can use this method for single or multi-image sequences.</p> 2312 2313<p>Coalesce() composites a set of images while respecting any page 2314offsets and disposal methods. GIF, MIFF, and MNG animation sequences 2315typically start with an image background and each subsequent image 2316varies in size and offset. A new image sequence is returned with all 2317images the same size as the first images virtual canvas and composited 2318with the next image in the sequence.. For example,</p> 2319 2320<pre class="highlight"><code>$q = $p->Coalesce(); 2321</code></pre> 2322 2323<p>The ComplexImages() method performs complex mathematics on an image sequence. For example,</p> 2324 2325<pre class="highlight"><code>$p = $image->ComplexImages('conjugate'); 2326</code></pre> 2327 2328<p>The EvaluateImages() method applies an arithmetic, logical or relational expression to a set of images. For example,</p> 2329 2330 2331<pre class="highlight"><code>$p = $image->EvaluateImages('mean'); 2332</code></pre> 2333 2334<p>averages all the images associated with object <code>$image</code>.</p> 2335 2336<p>The Features() method returns features for each channel in the image in each of four directions (horizontal, vertical, left and right diagonals) for the specified distance. The features include the angular second momentum, contrast, correlation, sum of squares: variance, inverse difference moment, sum average, sum varience, sum entropy, entropy, difference variance, difference entropy, information measures of correlation 1, information measures of correlation 2, and maximum correlation coefficient. Values in RGB, CMYK, RGBA, or CMYKA order (depending on the image type).</p> 2337 2338<pre class="highlight"><code>@features = $image->Features(1); 2339</code></pre> 2340 2341<p>The Flatten() method flattens a set of images and returns it. For example,</p> 2342 2343<pre class="highlight"><code>$p = $images->Flatten(background=>'none'); 2344$p->Write('flatten.png'); 2345</code></pre> 2346 2347<p>The sequence of images is replaced by a single image created by composing each image after the first over the first image.</p> 2348 2349<p>The Fx() method applies a mathematical expression to a set of images and returns the results. For example,</p> 2350 2351<pre class="highlight"><code>$p = $image->Fx(expression=>'(g+b)/2.0',channel=>'red'); 2352$p->Write('fx.miff'); 2353</code></pre> 2354 2355<p>replaces the red channel with the average of the green and blue channels.</p> 2356 2357<p>See <a href="fx.html">FX, The Special Effects Image Operator</a> for a detailed discussion of this method.</p> 2358 2359<p>Histogram() returns the unique colors in the image and a count for each one. The returned values are an array of red, green, blue, opacity, and count values.</p> 2360 2361<p>The Morph() method morphs a set of images. Both the image pixels and size are linearly interpolated to give the appearance of a meta-morphosis from one image to the next:</p> 2362 2363<pre class="highlight"><code>$p = $image->Morph(frames=><i>integer</i>); 2364</code></pre> 2365 2366<p>where <i>frames</i> is the number of in-between images to generate. The default is 1.</p> 2367 2368<p>Mosaic() creates an mosaic from an image sequence.</p> 2369 2370<p>Method Mogrify() is a single entry point for the image manipulation methods (<a href="perl-magick.html#manipulate">Manipulate an Image</a>). The parameters are the name of a method followed by any parameters the method may require. For example, these calls are equivalent:</p> 2371 2372<pre class="highlight"><code>$image->Crop('340x256+0+0'); 2373$image->Mogrify('crop', '340x256+0+0'); 2374</code></pre> 2375 2376<p>Method MogrifyRegion() applies a transform to a region of the image. It is similar to Mogrify() but begins with the region geometry. For example, suppose you want to brighten a 100x100 region of your image at location (40, 50):</p> 2377 2378<pre class="highlight"><code>$image->MogrifyRegion('100x100+40+50', 'modulate', brightness=>50); 2379</code></pre> 2380 2381<p>PerceptualHash() maps visually identical images to the same or similar hash-- useful in image retrieval, authentication, indexing, or copy detection as well as digital watermarking. For each channel and for the sRGB and the HCLp colorspaces, 7 hash values are returned For an sRGB images, for example, expect 42 perceptual hashes.</p> 2382 2383<pre class="highlight"><code>@phash = $image->PerceptualHash();</code></pre> 2384 2385<p>Ping() is a convenience method that returns information about an image without having to read the image into memory. It returns the width, height, file size in bytes, and the file format of the image. You can specify more than one filename but only one filehandle:</p> 2386 2387<pre class="highlight"><code>($width, $height, $size, $format) = $image->Ping('logo.png'); 2388($width, $height, $size, $format) = $image->Ping(file=>\*IMAGE); 2389($width, $height, $size, $format) = $image->Ping(blob=>$blob); 2390</code></pre> 2391 2392<p>This a more efficient and less memory intensive way to query if an image exists and what its characteristics are.</p> 2393 2394<p>Poly() builds a polynomial from the image sequence and the corresponding terms (coefficients and degree pairs):</p> 2395 2396<pre class="highlight"><code>$p = $image->Poly([0.5,1.0,0.25,2.0,1.0,1.0]); 2397</code></pre> 2398 2399<p>PreviewImage() tiles 9 thumbnails of the specified image with an image processing operation applied at varying strengths. This may be helpful pin-pointing an appropriate parameter for a particular image processing operation. Choose from these operations: <code>Rotate, Shear, Roll, Hue, Saturation, Brightness, Gamma, Spiff, Dull, Grayscale, Quantize, Despeckle, ReduceNoise, AddNoise, Sharpen, Blur, Threshold, EdgeDetect, Spread, Solarize, Shade, Raise, Segment, Swirl, Implode, Wave, OilPaint, CharcoalDrawing, JPEG</code>. Here is an example:</p> 2400 2401<pre class="highlight"><code>$preview = $image->Preview('Gamma'); 2402$preview->Display(); 2403</code></pre> 2404 2405<p>To have full control over text positioning you need font metric information. Use</p> 2406 2407<pre class="highlight"><code>($x_ppem, $y_ppem, $ascender, $descender, $width, $height, $max_advance) = 2408 $image->QueryFontMetrics(<i>parameters</i>); 2409</code></pre> 2410 2411<p>Where <i>parameters</i> is any parameter of the <a href="perl-magick.html#manipulate">Annotate</a> method. The return values are:</p> 2412 2413<ol> 2414 <li>character width</li> 2415 <li>character height</li> 2416 <li>ascender</li> 2417 <li>descender</li> 2418 <li>text width</li> 2419 <li>text height</li> 2420 <li>maximum horizontal advance</li> 2421 <li>bounds: x1</li> 2422 <li>bounds: y1</li> 2423 <li>bounds: x2</li> 2424 <li>bounds: y2</li> 2425 <li>origin: x</li> 2426 <li>origin: y</li> 2427</ol> 2428 2429<p>Use QueryMultilineFontMetrics() to get the maximum text width and height for multiple lines of text.</p> 2430 2431<p>Call QueryColor() with no parameters to return a list of known colors names or specify one or more color names to get these attributes: red, green, blue, and opacity value.</p> 2432 2433<pre class="highlight"><code>@colors = $image->QueryColor(); 2434($red, $green, $blue) = $image->QueryColor('cyan'); 2435($red, $green, $blue, $alpha) = $image->QueryColor('#716baeff'); 2436</code></pre> 2437 2438<p>QueryColorname() accepts a color value and returns its respective name or hex value;</p> 2439 2440<pre class="highlight"><code>$name = $image->QueryColorname('rgba(80,60,0,0)'); 2441</code></pre> 2442 2443<p>Call QueryFont() with no parameters to return a list of known fonts or specify one or more font names to get these attributes: font name, description, family, style, stretch, weight, encoding, foundry, format, metrics, and glyphs values.</p> 2444 2445<pre class="highlight"><code>@fonts = $image->QueryFont(); 2446$weight = ($image->QueryFont('Helvetica'))[5]; 2447</code></pre> 2448 2449<p>Call QueryFormat() with no parameters to return a list of known image formats or specify one or more format names to get these attributes: adjoin, blob support, raw, decoder, encoder, description, and module.</p> 2450 2451<pre class="highlight"><code>@formats = $image->QueryFormat(); 2452($adjoin, $blob_support, $raw, $decoder, $encoder, $description, $module) = 2453 $image->QueryFormat('gif'); 2454</code></pre> 2455 2456<p>Call MagickToMime() with the image format name to get its MIME type such as <code>images/tiff</code> from <code>tif</code>.</p> 2457 2458<pre class="highlight"><code>$mime = $image->MagickToMime('tif'); 2459</code></pre> 2460 2461<p>Use RemoteCommand() to send a command to an already running <a href="display.html">display</a> or <a href="animate.html">animate</a> application. The only parameter is the name of the image file to display or animate.</p> 2462 2463<pre class="highlight"><code>$image->RemoteCommand('image.jpg'); 2464</code></pre> 2465 2466<p>The Smush() method smushes a set of images together. For example,</p> 2467 2468<pre class="highlight"><code>$p = $image->Smush(stack=>{true,false},offset=><var>integer</var>); 2469</code></pre> 2470 2471<p>smushes together all the images associated with object <code>$image</code>. By default, images are smushed left-to-right. Set <code>stack</code> to True to smushed them top-to-bottom.</p> 2472 2473<p>Statistics() returns the image statistics for each channel in the image. The returned values are an array of depth, minima, maxima, mean, standard deviation, kurtosis, skewness, and entropy values in RGB, CMYK, RGBA, or CMYKA order (depending on the image type).</p> 2474 2475<pre class="highlight"><code>@statistics = $image->Statistics(); 2476</code></pre> 2477 2478<p>Finally, the Transform() method accepts a fully-qualified geometry specification for cropping or resizing one or more images. For example,</p> 2479 2480<pre class="highlight"><code>$p = $image->Transform(crop=>'100x100+0+0'); 2481</code></pre> 2482 2483<p>You can optionally add <i>Image</i> to any method name above. For example, PingImage() is an alias for method Ping().</p> 2484 2485<h2><a class="anchor" id="exceptions"></a>Handling Exceptions</h2> 2486 2487<p>All PerlMagick methods return an undefined string context upon success. If any problems occur, the error is returned as a string with an embedded numeric status code. A status code less than 400 is a warning. This means that the operation did not complete but was recoverable to some degree. A numeric code greater or equal to 400 is an error and indicates the operation failed completely. Here is how exceptions are returned for the different methods:</p> 2488 2489<p>Methods which return a number (e.g. Read(), Write()):</p> 2490 2491<pre class="highlight"><code>$x = $image->Read(...); 2492warn "$x" if "$x"; # print the error message 2493$x =~ /(\d+)/; 2494print $1; # print the error number 2495print 0+$x; # print the number of images read 2496</code></pre> 2497 2498<p>Methods which operate on an image (e.g. Resize(), Crop()):</p> 2499 2500<pre class="highlight"><code>$x = $image->Crop(...); 2501warn "$x" if "$x"; # print the error message 2502$x =~ /(\d+)/; 2503print $1; # print the error number 2504</code></pre> 2505 2506<p>Methods which return images (EvaluateSequence(), Montage(), Clone()) should be checked for errors this way:</p> 2507 2508<pre class="highlight"><code>$x = $image->Montage(...); 2509warn "$x" if !ref($x); # print the error message 2510$x =~ /(\d+)/; 2511print $1; # print the error number 2512</code></pre> 2513 2514<p>Here is an example error message:</p> 2515 2516<pre class="highlight"><code>Error 400: Memory allocation failed 2517</code></pre> 2518 2519<p>Review the complete list of <a href="../www/exception.html">error and warning codes</a>.</p> 2520 2521<p>The following illustrates how you can use a numeric status code:</p> 2522 2523<pre class="highlight"><code>$x = $image->Read('rose.png'); 2524$x =~ /(\d+)/; 2525die "unable to continue" if ($1 == ResourceLimitError); 2526</code></pre> 2527 2528<h2><a class="anchor" id="constants"></a>Constants</h2> 2529 2530<p>PerlMagick includes these constants:</p> 2531 2532<pre class="pre-scrollable"><code>BlobError 2533BlobWarning 2534CacheError 2535CacheWarning 2536CoderError 2537CoderWarning 2538ConfigureError 2539ConfigureWarning 2540CorruptImageError 2541CorruptImageWarning 2542DelegateError 2543DelegateWarning 2544DrawError 2545DrawWarning 2546ErrorException 2547FatalErrorException 2548FileOpenError 2549FileOpenWarning 2550ImageError 2551ImageWarning 2552MissingDelegateError 2553MissingDelegateWarning 2554ModuleError 2555ModuleWarning 2556Opaque 2557OptionError 2558OptionWarning 2559QuantumDepth 2560QuantumRange 2561RegistryError 2562RegistryWarning 2563ResourceLimitError 2564ResourceLimitWarning 2565StreamError 2566StreamWarning 2567Success 2568Transparent 2569TypeError 2570TypeWarning 2571WarningException 2572XServerError 2573XServerWarning 2574</code></pre> 2575 2576<p>You can access them like this:</p> 2577 2578<pre class="highlight"><code>Image::Magick->QuantumDepth 2579</code></pre> 2580 2581</div> 2582 </div> 2583 </main><!-- /.container --> 2584 <footer class="magick-footer"> 2585 <p><a href="security-policy.html">Security</a> • 2586 <a href="architecture.html">Architecture</a> 2587 2588 <a href="perl-magick.html#"><img class="d-inline" id="wand" alt="And Now a Touch of Magick" width="16" height="16" src="../images/wand.ico"/></a> 2589 2590 <a href="links.html">Related</a> • 2591 <a href="sitemap.html">Sitemap</a> 2592 <br/> 2593 <a href="support.html">Donate</a> • 2594 <a href="http://pgp.mit.edu/pks/lookup?op=get&search=0x89AB63D48277377A">Public Key</a> • 2595 <a href="https://imagemagick.org/script/contact.php">Contact Us</a> 2596 <br/> 2597 <small>© 1999-2020 ImageMagick Studio LLC</small></p> 2598 </footer> 2599 2600 <!-- Javascript assets --> 2601 <script src="assets/magick.js" crossorigin="anonymous"></script> 2602 <script>window.jQuery || document.write('<script src="https://localhost/ajax/libs/jquery/3.4.1/jquery.min.js"><\/script>')</script> 2603</body> 2604</html> 2605<!-- Magick Cache 5th January 2020 11:48 -->
