granicus.if.org Git - imagemagick/blob - www/escape.html

   1
   2
   3
   4
   5 <!DOCTYPE html>
   6 <html lang="en">
   7 <head>
   8   <meta charset="utf-8"  />
   9   <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"  />
  10   <title>Format and Print Image Properties @ ImageMagick</title>
  11   <meta name="application-name" content="ImageMagick" />
  12   <meta name="description" content="ImageMagick® is a software suite to create, edit, compose, or convert bitmap images. It can read and write images in a variety of formats (over 200) including PNG, JPEG, JPEG-2000, GIF, WebP, Postscript, PDF, and SVG. Use ImageMagick to resize, flip, mirror, rotate, distort, shear and transform images, adjust image colors, apply various special effects, or draw text, lines, polygons, ellipses and Bézier curves." />
  13   <meta name="application-url" content="https://www.imagemagick.org" />
  14   <meta name="generator" content="PHP" />
  15   <meta name="keywords" content="format, print, image, properties, 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-2017 ImageMagick Studio LLC" />
  23   <meta name="distribution" content="Global" />
  24   <meta name="magick-serial" content="P131-S030410-R485315270133-P82224-A6668-G1245-1" />
  25   <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
  26   <meta name="google-site-verification" content="_bMOCDpkx9ZAzBwb2kF3PRHbfUUdFj2uO8Jd1AXArz4" />
  27   <link href="escape.html" rel="canonical" />
  28   <link href="../images/wand.png" rel="icon" />
  29   <link href="../images/wand.ico" rel="shortcut icon" />
  30   <link href="assets/magick.css" rel="stylesheet" />
  31 </head>
  32 <body>
  33   <header>
  34   <nav class="navbar navbar-expand-md navbar-dark bg-dark fixed-top">
  35     <a class="navbar-brand" href="../index.html">ImageMagick</a>
  36     <button class="navbar-toggler collapsed" type="button" data-toggle="collapse" data-target="#navbarsExampleDefault" aria-controls="navbarsExampleDefault" aria-expanded="false" aria-label="Toggle navigation">
  37     <span class="navbar-toggler-icon"></span>
  38     </button>
  39
  40     <div class="navbar-collapse collapse" id="navbarsExampleDefault" style="">
  41     <ul class="navbar-nav mr-auto">
  42       <li class="nav-item ">
  43         <a class="nav-link" href="../index.html">Home <span class="sr-only">(current)</span></a>
  44       </li>
  45       <li class="nav-item ">
  46         <a class="nav-link" href="../www/download.html">Download</a>
  47       </li>
  48       <li class="nav-item ">
  49         <a class="nav-link" href="../www/command-line-tools.html">Tools</a>
  50       </li>
  51       <li class="nav-item ">
  52         <a class="nav-link" href="../www/command-line-processing.html">Command-line</a>
  53       </li>
  54       <li class="nav-item ">
  55         <a class="nav-link" href="../www/resources.html">Resources</a>
  56       </li>
  57       <li class="nav-item ">
  58         <a class="nav-link" href="../www/develop.html">Develop</a>
  59       </li>
  60       <li class="nav-item">
  61         <a class="nav-link" href="https://www.imagemagick.org/discourse-server/">Community</a>
  62       </li>
  63     </ul>
  64     <form class="form-inline my-2 my-lg-0" action="https://www.imagemagick.org/script/search.php">
  65       <!-- <input class="form-control mr-sm-2" type="text" placeholder="Search" aria-label="Search"> -->
  66       <button class="btn btn-outline-success my-2 my-sm-0" type="submit">Search</button>
  67     </form>
  68     </div>
  69   </nav>
  70   <div class="container">
  71    <script async="async" src="http://localhost/pagead/js/adsbygoogle.js"></script>    <ins class="adsbygoogle"
  72          style="display:block"
  73          data-ad-client="ca-pub-3129977114552745"
  74          data-ad-slot="6345125851"
  75          data-ad-format="auto"></ins>
  76     <script>
  77       (adsbygoogle = window.adsbygoogle || []).push({});
  78     </script>
  79   </div>
  80   </header>
  81     <main role="main" class="container">
  82     <div class="magick-template">
  83 <div class="magick-header">
  84 <p class="lead magick-description">There are copious amounts of extra data associated with images (metadata), beyond the actual image pixels. This metadata can be useful, either for display, or for various calculations, or in modifying the behavior of later image processing operations.  You can utilize percent escapes in a number of options, for example in <a href="command-line-options.html#format_identify_">-format</a> or in montage <a href="command-line-options.html#label" >-label</a>, to print various properties and other settings associated with an image.</p>
  85
  86 <div class="table-responsive">
  87 <table class="table table-striped">
  88 <tr>
  89     <td><b>Profile Data</b></td>
  90     <td>Such as EXIF: data, containing focal lengths, exposures, dates, and in
  91         come cases GPS locations.
  92     </td></tr>
  93 <tr>
  94     <td><b>Attributes</b></td>
  95     <td>These are directly involved with image data, and more commonly
  96         modified as part of normal image processing.  These include
  97         width, height, depth, image type (colorspace), timing delays, and
  98         background color. Most specific percent escapes is to access this
  99         information.
 100     </td></tr>
 101 <tr>
 102     <td><b>Properties</b></td>
 103     <td>These are stored as a table of free form strings, and are (if possible)
 104         saved with the image (especially in MIFF and PNG image file formats).
 105         These include: Labels, Captions, Comments.
 106     </td></tr>
 107 <tr>
 108     <td><b>Artifacts</b></td>
 109     <td>These are various operational (expert) settings that are saved for
 110         use by various operators, or by the user for future use.  It is just
 111         a table of free-form strings.  They are not saved with the image when
 112         written.  See Artifacts and Options below for details.
 113     </td></tr>
 114 <tr>
 115     <td><b>Options</b></td>
 116     <td>Also operational (expert) settings that are saved for
 117         use by various operators, but are set globally for use by a whole
 118         image list (also not saved).  See Artifacts and Options below.
 119     </td></tr>
 120 </table></div>
 121
 122 <h3>Percent Escape Handling</h3>
 123
 124 <p>If you request a percent escape such as <code>%[key]</code> the setting
 125 is looked for in the following order until the first match has been
 126 found...</p>
 127
 128 <ol>
 129 <li>Handle special prefixes such as 'artifact:' 'option:' 'exif:', or
 130     'fx:'.  This includes and calculations and or globs of those prefixes such
 131     as 'exif:*' or 'artifact:*' (see below).</li>
 132
 133 <li>If <code>key</code> contains a glob pattern (but no known prefix)
 134     search free-form properties table.</li>
 135
 136 <li>If <code>key</code> is a special image 'attribute' name (see list
 137     above) return the associated or calculated image attribute.</li>
 138
 139 <li>Search for setting as a free-form 'property'</li>
 140 <li>Search for setting as a free-form 'artifact'</li>
 141 <li>Search for setting as a free-form 'option'</li>
 142
 143 <li>Replace escape with empty string, and perhaps produce a warning.</li>
 144 </ol>
 145
 146 <p>Remember, all long name forms of percent escapes are handled in a is case
 147 insensitive manner. </p>
 148
 149 <p><b>As of IM v6.8.0-5</b> you can now access the Artifact and Option
 150 free-form string tables directly, allowing you to override the above sequence,
 151 and avoid accessing an attribute or property of the same name.</p>
 152
 153 <pre class="highlight"><code>%[artifact:<var>setting</var>]
 154 %[option:<var>setting</var>]
 155 </code></pre>
 156
 157
 158 <h3>Single Letter Attribute Percent Escapes</h3>
 159
 160 <p>Here are common single letter escapes (short form) is used to report the most
 161 common attributes and properties of an image, such as: the image filename
 162 filename, type, width, height. </p>
 163
 164 <div class="table-responsive">
 165 <table class="table table-sm table-striped">
 166   <tr>
 167     <td>\n</td>
 168     <td>newline</td>
 169   </tr>
 170   <tr>
 171     <td>\r</td>
 172     <td>carriage return</td>
 173   </tr>
 174   <tr>
 175     <td>&lt;</td>
 176     <td>less-than character.</td>
 177   </tr>
 178   <tr>
 179     <td>&gt;</td>
 180     <td>greater-than character.</td>
 181   </tr>
 182   <tr>
 183     <td>&amp;</td>
 184     <td>ampersand character.</td>
 185   </tr>
 186   <tr>
 187     <td>%%</td>
 188     <td>a percent sign</td>
 189   </tr>
 190   <tr>
 191     <td>%b</td>
 192     <td>file size of image read in</td>
 193   </tr>
 194   <tr>
 195     <td>%c</td>
 196     <td>comment meta-data property</td>
 197   </tr>
 198   <tr>
 199     <td>%d</td>
 200     <td>directory component of path</td>
 201   </tr>
 202   <tr>
 203     <td>%e</td>
 204     <td>filename extension or suffix</td>
 205   </tr>
 206   <tr>
 207     <td>%f</td>
 208     <td>filename (including suffix)</td>
 209   </tr>
 210   <tr>
 211     <td>%g</td>
 212     <td>layer canvas page geometry   (equivalent to "%Wx%H%X%Y")</td>
 213   </tr>
 214   <tr>
 215     <td>%h</td>
 216     <td>current image height in pixels</td>
 217   </tr>
 218   <tr>
 219     <td>%i</td>
 220     <td>image filename (note: becomes output filename for "info:")</td>
 221   </tr>
 222   <tr>
 223     <td>%k</td>
 224     <td>CALCULATED: number of unique colors</td>
 225   </tr>
 226   <tr>
 227     <td>%l</td>
 228     <td>label meta-data property</td>
 229   </tr>
 230   <tr>
 231     <td>%m</td>
 232     <td>image file format (file magic)</td>
 233   </tr>
 234   <tr>
 235     <td>%n</td>
 236     <td>number of images in current image sequence</td>
 237   </tr>
 238   <tr>
 239     <td>%o</td>
 240     <td>output filename  (used for delegates)</td>
 241   </tr>
 242   <tr>
 243     <td>%p</td>
 244     <td>index of image in current image list</td>
 245   </tr>
 246   <tr>
 247     <td>%q</td>
 248     <td>quantum depth (compile-time constant)</td>
 249   </tr>
 250   <tr>
 251     <td>%r</td>
 252     <td>image class and colorspace</td>
 253   </tr>
 254   <tr>
 255     <td>%s</td>
 256     <td>scene number (from input unless re-assigned)</td>
 257   </tr>
 258   <tr>
 259     <td>%t</td>
 260     <td>filename without directory or extension (suffix)</td>
 261   </tr>
 262   <tr>
 263     <td>%u</td>
 264     <td>unique temporary filename (used for delegates)</td>
 265   </tr>
 266   <tr>
 267     <td>%w</td>
 268     <td>current width in pixels</td>
 269   </tr>
 270   <tr>
 271     <td>%x</td>
 272     <td>x resolution (density)</td>
 273   </tr>
 274   <tr>
 275     <td>%y</td>
 276     <td>y resolution (density)</td>
 277   </tr>
 278   <tr>
 279     <td>%z</td>
 280     <td>image depth (as read in unless modified, image save depth)</td>
 281   </tr>
 282   <tr>
 283     <td>%A</td>
 284     <td>image transparency channel enabled (true/false)</td>
 285   </tr>
 286   <tr>
 287     <td>%C</td>
 288     <td>image compression type</td>
 289   </tr>
 290   <tr>
 291     <td>%D</td>
 292     <td>image GIF dispose method</td>
 293   </tr>
 294   <tr>
 295     <td>%G</td>
 296     <td>original image size (%wx%h; before any resizes)</td>
 297   </tr>
 298   <tr>
 299     <td>%H</td>
 300     <td>page (canvas) height</td>
 301   </tr>
 302   <tr>
 303     <td>%M</td>
 304     <td>Magick filename (original file exactly as given,  including read mods)</td>
 305   </tr>
 306   <tr>
 307     <td>%O</td>
 308     <td>page (canvas) offset ( = %X%Y )</td>
 309   </tr>
 310   <tr>
 311     <td>%P</td>
 312     <td>page (canvas) size ( = %Wx%H )</td>
 313   </tr>
 314   <tr>
 315     <td>%Q</td>
 316     <td>image compression quality ( 0 = default )</td>
 317   </tr>
 318   <tr>
 319     <td>%S</td>
 320     <td>?? scenes ??</td>
 321   </tr>
 322   <tr>
 323     <td>%T</td>
 324     <td>image time delay (in centi-seconds)</td>
 325   </tr>
 326   <tr>
 327     <td>%U</td>
 328     <td>image resolution units</td>
 329   </tr>
 330   <tr>
 331     <td>%W</td>
 332     <td>page (canvas) width</td>
 333   </tr>
 334   <tr>
 335     <td>%X</td>
 336     <td>page (canvas) x offset (including sign)</td>
 337   </tr>
 338   <tr>
 339     <td>%Y</td>
 340     <td>page (canvas) y offset (including sign)</td>
 341   </tr>
 342   <tr>
 343     <td>%Z</td>
 344     <td>unique filename (used for delegates)</td>
 345   </tr>
 346   <tr>
 347     <td>%@</td>
 348     <td>CALCULATED: trim bounding box (without actually trimming)</td>
 349   </tr>
 350   <tr>
 351     <td>%#</td>
 352     <td>CALCULATED: 'signature' hash of image values</td>
 353   </tr>
 354 </table></div>
 355
 356 <p>Here is a sample command and its output for an image with filename
 357 <code>bird.miff</code> and whose width is 512 and height is 480.</p>
 358
 359 <pre class="highlight"><code>-> identify -format "%m:%f %wx%h" bird.miff
 360 MIFF:bird.miff 512x480
 361 </code></pre>
 362
 363 <p>Note that all single letter percent escapes can also be used using long
 364 form (from IM version 6.7.6-9, see next). For example <code>%[f]</code> is
 365 equivalent to the <code>%f</code> short form. </p>
 366
 367 <p><b>WARNING</b>: short form percent escapes are NOT performed when the percent
 368 is after a number.  For example,  <code>10%x10</code> does not expand the
 369 <code>%x</code> as a percent escape.  If you specifically want to expand the
 370 'x', use the long form which overrides this special case. EG:
 371 <code>10%[x]10</code>. </p>
 372
 373 <p>Also be warned that calculated attributes can take some time to generate,
 374 especially for large images.</p>
 375
 376 <h3>Long Form Attribute Percent Escapes</h3>
 377
 378 <p>In addition to the above specific and calculated attributes are recognized
 379 when enclosed in braces (long form):</p>
 380
 381 <div class="table-responsive">
 382 <table class="table table-sm table-striped">
 383   <tr>
 384     <td>%[base]</td>
 385     <td>base filename, no suffixes (as %t)</td>
 386   </tr>
 387   <tr>
 388     <td>%[caption]</td>
 389     <td>caption meta-data property</td>
 390   </tr>
 391    <tr>
 392     <td>%[caption:pointsize]</td>
 393     <td>returns the pointsize computed during caption: processing (as of IM 6.9.1-0)</td>
 394   </tr>
 395   <tr>
 396     <td>%[channels]</td>
 397     <td>??? channels in use - colorspace ???</td>
 398   </tr>
 399   <tr>
 400     <td>%[colors]</td>
 401     <td>Number of unique colors in the image (as of IM 7.0.3.8)</td>
 402   </tr>
 403   <tr>
 404     <td>%[colorspace]</td>
 405     <td>Colorspace of Image Data (excluding transparency)</td>
 406   </tr>
 407   <tr>
 408     <td>%[compression]</td>
 409     <td>Image compression type (as of IM 7.0.3.8)</td>
 410   </tr>
 411   <tr>
 412     <td>%[copyright]</td>
 413     <td>ImageMagick Copyright String</td>
 414   </tr>
 415   <tr>
 416     <td>%[depth]</td>
 417     <td>depth of image for write (as input unless changed)</td>
 418   </tr>
 419   <tr>
 420     <td>%[deskew:angle]</td>
 421     <td>The deskew angle in degrees of rotation</td>
 422   </tr>
 423   <tr>
 424     <td>%[directory]</td>
 425     <td>directory part of filename (as %d)</td>
 426   </tr>
 427   <tr>
 428     <td>%[distortion]</td>
 429     <td>how well an image resembles a reference image (<a href="command-line-options.html#compare" >-compare</a>)</td>
 430   </tr>
 431   <tr>
 432     <td>%[entropy]</td>
 433     <td>CALCULATED: entropy of the image</td>
 434   </tr>
 435   <tr>
 436     <td>%[extension]</td>
 437     <td>extension part of filename (as %e)</td>
 438   </tr>
 439   <tr>
 440     <td>%[gamma]</td>
 441     <td>value of image gamma</td>
 442   </tr>
 443   <tr>
 444     <td>%[group]</td>
 445     <td>??? window group ???</td>
 446   </tr>
 447   <tr>
 448     <td>%[height]</td>
 449     <td>original height of image (when it was read in)</td>
 450   </tr>
 451   <tr>
 452     <td>%[interlace]</td>
 453     <td>Image interlace mode (as of IM 7.0.3.8)</td>
 454   </tr>
 455   <tr>
 456     <td>%[kurtosis]</td>
 457     <td>CALCULATED: kurtosis statistic of image</td>
 458   </tr>
 459   <tr>
 460     <td>%[label]</td>
 461     <td>label meta-data property</td>
 462   </tr>
 463    <tr>
 464     <td>%[label:pointsize]</td>
 465     <td>returns the pointsize computed during label: processing (as of IM 6.9.1-0)</td>
 466   </tr>
 467   <tr>
 468     <td>%[magick]</td>
 469     <td>coder used to read image (not the file suffix)</td>
 470   </tr>
 471   <tr>
 472     <td>%[max]</td>
 473     <td>CALCULATED: maximum value statistic of image</td>
 474   </tr>
 475   <tr>
 476     <td>%[mean]</td>
 477     <td>CALCULATED: average value statistic of image</td>
 478   </tr>
 479   <tr>
 480     <td>%[min]</td>
 481     <td>CALCULATED: minimum value statistic of image</td>
 482   </tr>
 483   <tr>
 484     <td>%[name]</td>
 485     <td>The original name of the image</td>
 486   </tr>
 487   <tr>
 488     <td>%[opaque]</td>
 489     <td>CALCULATED: is image fully-opaque?</td>
 490   </tr>
 491   <tr>
 492     <td>%[orientation]</td>
 493     <td>image orientation</td>
 494   </tr>
 495   <tr>
 496     <td>%[page]</td>
 497     <td>Virtual canvas (page) geometry</td>
 498   </tr>
 499   <tr>
 500     <td>%[profile:icc]</td>
 501     <td>ICC profile info</td>
 502   </tr>
 503   <tr>
 504     <td>%[profile:icm]</td>
 505     <td>ICM profile info</td>
 506   </tr>
 507   <tr>
 508     <td>%[profiles]</td>
 509     <td>list of any embedded profiles</td>
 510   </tr>
 511   <tr>
 512     <td>%[quality]</td>
 513     <td>Image quality value (as of IM 7.0.3.8)</td>
 514   </tr>
 515   <tr>
 516     <td>%[rendering-intent]</td>
 517     <td>Image rendering intent (as of IM 7.0.3.8)</td>
 518   </tr>
 519   <tr>
 520     <td>%[resolution.x]</td>
 521     <td>X density (resolution) without units</td>
 522   </tr>
 523   <tr>
 524     <td>%[resolution.y]</td>
 525     <td>Y density (resolution) without units</td>
 526   </tr>
 527   <tr>
 528     <td>%[scene]</td>
 529     <td>original scene number of image in input file</td>
 530   </tr>
 531   <tr>
 532     <td>%[size]</td>
 533     <td>original size of image (when it was read in)</td>
 534   </tr>
 535   <tr>
 536     <td>%[skewness]</td>
 537     <td>CALCULATED: skewness statistic of image</td>
 538   </tr>
 539   <tr>
 540     <td>%[standard-deviation]</td>
 541     <td>CALCULATED: standard deviation statistic of image</td>
 542   </tr>
 543   <tr>
 544     <td>%[type]</td>
 545     <td>CALCULATED: image type</td>
 546   </tr>
 547   <tr>
 548     <td>%[unique]</td>
 549     <td>unique temporary filename ???</td>
 550   </tr>
 551   <tr>
 552     <td>%[units]</td>
 553     <td>image resolution units</td>
 554   </tr>
 555   <tr>
 556     <td>%[version]</td>
 557     <td>Version Information of this running ImageMagick</td>
 558   </tr>
 559   <tr>
 560     <td>%[width]</td>
 561     <td>original width of image (when it was read in)</td>
 562   </tr>
 563   <tr>
 564     <td>%[zero]</td>
 565     <td>zero (unique filename for delegate use)</td>
 566   </tr>
 567 </table></div>
 568
 569 <h3>Properties</h3>
 570
 571 <p>All other long forms of percent escapes (not single letter long form) are
 572 handled in a case insensitive manner. Such escapes will will attempt to look
 573 up that name specific data sources. </p>
 574
 575 <p>The primary search space (if not a specific attribute listed above) is
 576 a free-form property string.  Such strings are associated and saved with
 577 images, and are typically set using either the <a href="command-line-options.html#set" >-set</a>
 578 CLI option (or API equivalent), or from special convenience options
 579 (such as <a href="command-line-options.html#label"
 580 >-label</a>, <a href="command-line-options.html#comment"
 581 >-comment</a>, <a href="command-line-options.html#caption"
 582 >-caption</a>). </p>
 583
 584 <p>These convenience options are globally saved (as 'global options' so thay can
 585 be set before images are read), and later are transfered to the property of
 586 individual images, only when they are read in. At that time any internal
 587 percent escape present is then handled. </p>
 588
 589 <p>To change a property of an image already in memory, you need to use <a
 590 href="command-line-options.html#set" >-set</a>.
 591 </p>
 592
 593 <p>Note that properties, like attributes (and profiles), are saved with
 594 images when write, if the image file format allows. </p>
 595
 596
 597 <h3>Artifacts and Options</h3>
 598
 599 <p>The previous percent escapes are associated with the primary Attributes and
 600 Properties. Which is the original and primary focus of such percent escapes.
 601 </p>
 602
 603 <p>However there are many operational settings that are used by various
 604 ImageMagick operators that can be useful to set and later access.  These
 605 consist of per-image Artifacts, and Global options (associated with a list of
 606 images, typically the current image list).</p>
 607
 608 <p>Note that the major difference between an artifact and a property is that
 609 artifacts, being an internal operational setting, is not saved with images (if
 610 such is possible). </p>
 611
 612 <p>For example when you use <code>-define 'distort:viewport=100x100'</code> you
 613 are in fact generating a global option, which the <a href="command-line-options.html#distort"
 614 >-distort</a> operator will use to modify its behavior (distorted output
 615 image 'view'). </p>
 616
 617 <p>An Option is essentually a Artifact that has been stored globally as part
 618 of a list of images (specifically a 'Wand' of images). As such they are
 619 identical, in that a Option, is simply a global Artifact for all the
 620 associated images. </p>
 621
 622 <p>As such you can use <code>-set 'option:distort:viewport' '100x100'</code> to
 623 achieve the same result of setting a Artifact for the disort operation to use.
 624 </p>
 625
 626 <p><b>Internal Handling of a Global Option...</b></p>
 627
 628 <p>The Core library ('MagickCore') does not generally directly understand
 629 Global Options. As such, continuing the previous example, the
 630 <code>DistortImages()</code> function only looks up an artifact to discover if
 631 a 'viewport' has been provided to it. </p>
 632
 633 <p>How Global Options are used when a library function requests an Artifact is
 634 one of the key differences between IMv6 and IMv7.</p>
 635
 636 <p>In <b>ImageMagick version 6</b>... before each operator, any global Options
 637 are copied to per-image Artifacts, for every image in the current image list.
 638 This allows various operators to find its operational 'defines' or Artifacts.
 639 </p>
 640
 641 <p>In <b>ImageMagick version 7</b>... sets a link back to the global options
 642 data, so that if a specific per-image Artifact is not found , then it will
 643 look for a equivalent global Option for that image list.  directly.  This
 644 saves coping these free-form options into artifacts repeatally, and means you
 645 can now separately define a global option for a list, and a individual
 646 overriding artifact for a specific image in that list. </p>
 647
 648 <p>Note that many API's that do not use Wands (PerlMagick for example using
 649 arrays of images rather than a Wand). In these API's you will not have Global
 650 Options, only per-image Artifacts. </p>
 651
 652 <p>In summery a Global Option, if available, is equivalent to a per-image
 653 Artifact. </p>
 654
 655
 656 <h3>Glob-Pattern Listing of Properties, Artifacts and Options</h3>
 657
 658 <p>The <var>setting</var> can contain a glob pattern. As such you can
 659 now list all free-form string properties, artifacts, and options, (but not
 660 specific image attributes) using...</p>
 661
 662 <pre class="highlight"><code>convert ... \
 663    -print "__Properties__\n%[*]" \
 664    -print "__Artifacts__\n%[artifact:*]" \
 665    -print "__Options__\n%[option:*]" \
 666    ...
 667 </code></pre>
 668
 669 <p> The format of glob patterns are very specific and as such is generally
 670 only used to list specific settings, such as when debugging, rather than being
 671 used for image processing use. </p>
 672
 673
 674 <h3>Calculated Percent Escape Prefixes</h3>
 675
 676 <p>There are some special prefixes (before the first ':') which performs
 677 calculations based on the user provided string that follows that prefix.  For
 678 example you can do a numerical calculation use <code>%[fx:...]</code> to
 679 evaluate the given <a href="../www/fx.html">FX</a> expressions:</p>
 680
 681 <pre class="highlight"><code>%[fx:<var>expression</var>]
 682 </code></pre>
 683
 684 <p>Use <code>pixel:</code> or <code>hex:</code> to evaluate a pixel color as defined by the <a
 685 href="../www/fx.html">FX</a>
 686 expression:</p>
 687
 688 <pre class="highlight"><code>%[pixel:<var>expression</var>]
 689 </code></pre>
 690
 691 <h3>Specific Profile Percent Escape Prefixes</h3>
 692
 693 <p>You can also use the following special formatting syntax to print EXIF
 694 mage meta-data that was included in the image read in:</p>
 695
 696 <pre class="highlight"><code>%[EXIF:<var>tag</var>]
 697 </code></pre>
 698
 699 <p>Choose <var>tag</var> from the following:</p>
 700
 701 <pre class="pre-scrollable"><code>
 702 *  (print all EXIF tags, in keyword=data format)
 703 !  (print all EXIF tags, in tag_number data format)
 704 #hhhh (print data for EXIF tag #hhhh)
 705 ImageWidth
 706 ImageLength
 707 BitsPerSample
 708 Compression
 709 PhotometricInterpretation
 710 FillOrder
 711 DocumentName
 712 ImageDescription
 713 Make
 714 Model
 715 StripOffsets
 716 Orientation
 717 SamplesPerPixel
 718 RowsPerStrip
 719 StripByteCounts
 720 XResolution
 721 YResolution
 722 PlanarConfiguration
 723 ResolutionUnit
 724 TransferFunction
 725 Software
 726 DateTime
 727 Artist
 728 WhitePoint
 729 PrimaryChromaticities
 730 TransferRange
 731 JPEGProc
 732 JPEGInterchangeFormat
 733 JPEGInterchangeFormatLength
 734 YCbCrCoefficients
 735 YCbCrSubSampling
 736 YCbCrPositioning
 737 ReferenceBlackWhite
 738 CFARepeatPatternDim
 739 CFAPattern
 740 BatteryLevel
 741 Copyright
 742 ExposureTime
 743 FNumber
 744 IPTC/NAA
 745 EXIFOffset
 746 InterColorProfile
 747 ExposureProgram
 748 SpectralSensitivity
 749 GPSInfo
 750 ISOSpeedRatings
 751 OECF
 752 EXIFVersion
 753 DateTimeOriginal
 754 DateTimeDigitized
 755 ComponentsConfiguration
 756 CompressedBitsPerPixel
 757 ShutterSpeedValue
 758 ApertureValue
 759 BrightnessValue
 760 ExposureBiasValue
 761 MaxApertureValue
 762 SubjectDistance
 763 MeteringMode
 764 LightSource
 765 Flash
 766 FocalLength
 767 MakerNote
 768 UserComment
 769 SubSecTime
 770 SubSecTimeOriginal
 771 SubSecTimeDigitized
 772 FlashPixVersion
 773 ColorSpace
 774 EXIFImageWidth
 775 EXIFImageLength
 776 InteroperabilityOffset
 777 FlashEnergy
 778 SpatialFrequencyResponse
 779 FocalPlaneXResolution
 780 FocalPlaneYResolution
 781 FocalPlaneResolutionUnit
 782 SubjectLocation
 783 ExposureIndex
 784 SensingMethod
 785 FileSource
 786 SceneType
 787 </code></pre>
 788 <br/>
 789 <p>Surround the format specification with quotation marks to prevent your
 790 shell from misinterpreting any spaces and square brackets.</p>
 791
 792 <p>The following special formatting syntax can be used to print IPTC
 793 information contained in the file:</p>
 794
 795 <pre class="highlight"><code>%[IPTC:<var>dataset</var>:<var>record</var>]
 796 </code></pre>
 797
 798 <p>Select <var>dataset</var> and <var>record</var> from the following:</p>
 799
 800 <pre class="pre-scrollable:">
 801   Envelope Record
 802   1:00  Model Version
 803   1:05  Destination
 804   1:20  File Format
 805   1:22  File Format Version
 806   1:30  Service Identifier
 807   1:40  Envelope Number
 808   1:50  Product ID
 809   1:60  Envelope Priority
 810   1:70  Date Sent
 811   1:80  Time Sent
 812   1:90  Coded Character Set
 813   1:100  UNO (Unique Name of Object)
 814   1:120  ARM Identifier
 815   1:122  ARM Version
 816
 817 Application Record
 818   2:00  Record Version
 819   2:03  Object Type Reference
 820   2:05  Object Name (Title)
 821   2:07  Edit Status
 822   2:08  Editorial Update
 823   2:10  Urgency
 824   2:12  Subject Reference
 825   2:15  Category
 826   2:20  Supplemental Category
 827   2:22  Fixture Identifier
 828   2:25  Keywords
 829   2:26  Content Location Code
 830   2:27  Content Location Name
 831   2:30  Release Date
 832   2:35  Release Time
 833   2:37  Expiration Date
 834   2:38  Expiration Time
 835   2:40  Special Instructions
 836   2:42  Action Advised
 837   2:45  Reference Service
 838   2:47  Reference Date
 839   2:50  Reference Number
 840   2:55  Date Created
 841   2:60  Time Created
 842   2:62  Digital Creation Date
 843   2:63  Digital Creation Time
 844   2:65  Originating Program
 845   2:70  Program Version
 846   2:75  Object Cycle
 847   2:80  By-Line (Author)
 848   2:85  By-Line Title (Author Position) [Not used in Photoshop 7]
 849   2:90  City
 850   2:92  Sub-Location
 851   2:95  Province/State
 852   2:100  Country/Primary Location Code
 853   2:101  Country/Primary Location Name
 854   2:103  Original Transmission Reference
 855   2:105  Headline
 856   2:110  Credit
 857   2:115  Source
 858   2:116  Copyright Notice
 859   2:118  Contact
 860   2:120  Caption/Abstract
 861   2:122  Caption Writer/Editor
 862   2:125  Rasterized Caption
 863   2:130  Image Type
 864   2:131  Image Orientation
 865   2:135  Language Identifier
 866   2:150  Audio Type
 867   2:151  Audio Sampling Rate
 868   2:152  Audio Sampling Resolution
 869   2:153  Audio Duration
 870   2:154  Audio Outcue
 871   2:200  ObjectData Preview File Format
 872   2:201  ObjectData Preview File Format Version
 873   2:202  ObjectData Preview Data
 874
 875 Pre-ObjectData Descriptor Record
 876   7:10   Size Mode
 877   7:20   Max Subfile Size
 878   7:90   ObjectData Size Announced
 879   7:95   Maximum ObjectData Size
 880
 881 ObjectData Record
 882   8:10   Subfile
 883
 884 Post ObjectData Descriptor Record
 885   9:10   Confirmed ObjectData Size
 886 </code></pre>
 887 </div>
 888     </div>
 889   </main><!-- /.container -->
 890   <footer class="magick-footer">
 891     <p><a href="../www/security-policy.html">Security</a> •
 892     <a href="../www/architecture.html">Architecture</a> •
 893     <a href="../www/links.html">Related</a> •
 894      <a href="../www/sitemap.html">Sitemap</a> •
 895     <a href="http://pgp.mit.edu/pks/lookup?op=get&amp;search=0x89AB63D48277377A">Public Key</a>
 896 </p>
 897     <p><a href="../www/support.html">Donate</a> •
 898     <a href="escape.html#">Back to top</a> •
 899     <a href="https://www.imagemagick.org/script/contact.php">Contact Us</a></p>
 900         <p><small>© 1999-2018 ImageMagick Studio LLC</small></p>
 901   </footer>
 902
 903   <!-- Javascript assets -->
 904   <script src="assets/magick.js" crossorigin="anonymous"></script>
 905   <script>window.jQuery || document.write('<script src="assets/jquery.min.js"><\/script>')</script>
 906 </body>
 907 </html>
 908 <!-- Magick Cache 9th December 2017 14:51 -->