blob: d68a0d8f73ea509b5dcf99c2ef60d12713a9bc7b [file] [log] [blame]
Cristy594d2772015-11-15 10:47:42 -05001
2
3
4
cristy29dc8652015-05-12 16:26:21 +00005<!DOCTYPE html>
cristyd2432012015-05-04 23:15:15 +00006<html lang="en">
cristyad41c0c2012-10-31 00:49:28 +00007<head>
Cristy912a9222016-06-17 15:37:28 -04008 <meta charset="utf-8" />
Cristy3b0b58d2016-11-06 07:40:23 -05009 <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no" />
10 <meta http-equiv="x-ua-compatible" content="ie=edge" />
Cristy6549abb2016-11-10 08:25:55 -050011 <title>Command-line Options @ ImageMagick</title>
Cristy594d2772015-11-15 10:47:42 -050012 <meta http-equiv="content-type" content="text/html; charset=utf-8"/>
13 <meta name="application-name" content="ImageMagick"/>
14 <meta name="description" content="ImageMagick® is a software suite to create, edit, compose, or convert bitmap images. It can read and write images in a variety of formats (over 200) including PNG, JPEG, JPEG-2000, GIF, WebP, Postscript, PDF, and SVG. Use ImageMagick to resize, flip, mirror, rotate, distort, shear and transform images, adjust image colors, apply various special effects, or draw text, lines, polygons, ellipses and Bézier curves."/>
Cristy364a72f2016-11-04 22:38:41 -040015 <meta name="application-url" content="https://www.imagemagick.org"/>
Cristy594d2772015-11-15 10:47:42 -050016 <meta name="generator" content="PHP"/>
17 <meta name="keywords" content="command-line, options, ImageMagick, PerlMagick, image processing, image, photo, software, Magick++, OpenMP, convert"/>
18 <meta name="rating" content="GENERAL"/>
19 <meta name="robots" content="INDEX, FOLLOW"/>
20 <meta name="generator" content="ImageMagick Studio LLC"/>
21 <meta name="author" content="ImageMagick Studio LLC"/>
22 <meta name="revisit-after" content="2 DAYS"/>
23 <meta name="resource-type" content="document"/>
Cristyfe36f992016-12-29 20:24:13 -050024 <meta name="copyright" content="Copyright (c) 1999-2017 ImageMagick Studio LLC"/>
Cristy594d2772015-11-15 10:47:42 -050025 <meta name="distribution" content="Global"/>
26 <meta name="magick-serial" content="P131-S030410-R485315270133-P82224-A6668-G1245-1"/>
Cristy912a9222016-06-17 15:37:28 -040027 <meta name="google-site-verification" content="_bMOCDpkx9ZAzBwb2kF3PRHbfUUdFj2uO8Jd1AXArz4" />
Cristyfe36f992016-12-29 20:24:13 -050028 <link rel="canonical" href="https://www.imagemagick.org/script/command-line-options.html"/>
Cristy594d2772015-11-15 10:47:42 -050029 <link rel="icon" href="../images/wand.png"/>
30 <link rel="shortcut icon" href="../images/wand.ico"/>
Cristybc232422016-11-22 07:46:18 -050031 <link rel="stylesheet" type="text/css" href="http://fonts.googleapis.com/css?family=Roboto:900,400,400italic,700,700italic,300,300italic|Open+Sans:300italic,400italic,700italic,300,400,600,700" />
Cristyce4a3552015-12-14 13:53:35 -050032 <link rel="stylesheet" href="css/magick.css"/>
cristyad41c0c2012-10-31 00:49:28 +000033</head>
cristyd2432012015-05-04 23:15:15 +000034<body>
cristyad41c0c2012-10-31 00:49:28 +000035<div class="main">
cristyd2432012015-05-04 23:15:15 +000036<div class="magick-masthead">
37 <div class="container">
Cristy6549abb2016-11-10 08:25:55 -050038 <script async="async" src="http://localhost/pagead/js/adsbygoogle.js"></script> <ins class="adsbygoogle"
Cristy594d2772015-11-15 10:47:42 -050039 style="display:block"
40 data-ad-client="ca-pub-3129977114552745"
41 data-ad-slot="6345125851"
42 data-ad-format="auto"></ins>
cristy29f2c972015-07-28 13:37:46 +000043 <script>
Cristy542697a2015-10-12 20:10:32 -040044 (adsbygoogle = window.adsbygoogle || []).push({});
cristyd2432012015-05-04 23:15:15 +000045 </script>
cristyd2432012015-05-04 23:15:15 +000046 <nav class="magick-nav">
cristy44443b92015-05-05 00:06:07 +000047 <a class="magick-nav-item " href="../index.html">Home</a>
Cristy9017f3a2017-01-21 10:51:11 -050048 <a class="magick-nav-item " href="download.html">Download</a>
cristyd2432012015-05-04 23:15:15 +000049 <a class="magick-nav-item " href="command-line-tools.html">Tools</a>
Cristye93be682015-11-26 09:07:51 -050050 <a class="magick-nav-item " href="command-line-processing.html">Command-line</a>
cristyea2793e2015-05-31 16:52:26 +000051 <a class="magick-nav-item " href="resources.html">Resources</a>
Cristy9017f3a2017-01-21 10:51:11 -050052 <a class="magick-nav-item " href="develop.html">Develop</a>
Cristy6549abb2016-11-10 08:25:55 -050053 <a class="magick-nav-item " href="https://www.imagemagick.org/script/search.php">Search</a>
54 <a class="magick-nav-item pull-right" href="https://www.imagemagick.org/discourse-server/">Community</a>
cristyd2432012015-05-04 23:15:15 +000055 </nav>
56 </div>
57</div>
58<div class="container">
Cristy882d9f42015-10-29 16:48:39 -040059<div class="magick-header">
Cristyb7f455a2017-03-03 19:30:34 -050060<p class="text-center"><a href="command-line-options.html#adaptive-blur">&#x2011;adaptive&#x2011;blur</a><a href="command-line-options.html#adaptive-resize">&#x2011;adaptive&#x2011;resize</a><a href="command-line-options.html#adaptive-sharpen">&#x2011;adaptive&#x2011;sharpen</a><a href="command-line-options.html#adjoin">&#x2011;adjoin</a><a href="command-line-options.html#affine">&#x2011;affine</a><a href="command-line-options.html#alpha">&#x2011;alpha</a><a href="command-line-options.html#annotate">&#x2011;annotate</a><a href="command-line-options.html#antialias">&#x2011;antialias</a><a href="command-line-options.html#append">&#x2011;append</a><a href="command-line-options.html#attenuate">&#x2011;attenuate</a><a href="command-line-options.html#authenticate">&#x2011;authenticate</a><a href="command-line-options.html#auto-gamma">&#x2011;auto&#x2011;gamma</a><a href="command-line-options.html#auto-level">&#x2011;auto&#x2011;level</a><a href="command-line-options.html#auto-orient">&#x2011;auto&#x2011;orient</a><a href="command-line-options.html#backdrop">&#x2011;backdrop</a><a href="command-line-options.html#background">&#x2011;background</a><a href="command-line-options.html#bench">&#x2011;bench</a><a href="command-line-options.html#bias">&#x2011;bias</a><a href="command-line-options.html#black-point-compensation">&#x2011;black&#x2011;point&#x2011;compensation</a><a href="command-line-options.html#black-threshold">&#x2011;black&#x2011;threshold</a><a href="command-line-options.html#blend">&#x2011;blend</a><a href="command-line-options.html#blue-primary">&#x2011;blue&#x2011;primary</a><a href="command-line-options.html#blue-shift">&#x2011;blue&#x2011;shift</a><a href="command-line-options.html#blur">&#x2011;blur</a><a href="command-line-options.html#border">&#x2011;border</a><a href="command-line-options.html#bordercolor">&#x2011;bordercolor</a><a href="command-line-options.html#borderwidth">&#x2011;borderwidth</a><a href="command-line-options.html#brightness-contrast">&#x2011;brightness&#x2011;contrast</a><a href="command-line-options.html#cache">&#x2011;cache</a><a href="command-line-options.html#canny">&#x2011;canny</a><a href="command-line-options.html#caption">&#x2011;caption</a><a href="command-line-options.html#cdl">&#x2011;cdl</a><a href="command-line-options.html#channel">&#x2011;channel</a><a href="command-line-options.html#charcoal">&#x2011;charcoal</a><a href="command-line-options.html#channel-fx">&#x2011;channel&#x2011;fx</a><a href="command-line-options.html#chop">&#x2011;chop</a><a href="command-line-options.html#clamp">&#x2011;clamp</a><a href="command-line-options.html#clip">&#x2011;clip</a><a href="command-line-options.html#clip-mask">&#x2011;clip&#x2011;mask</a><a href="command-line-options.html#clip-path">&#x2011;clip&#x2011;path</a><a href="command-line-options.html#clone">&#x2011;clone</a><a href="command-line-options.html#clut">&#x2011;clut</a><a href="command-line-options.html#coalesce">&#x2011;coalesce</a><a href="command-line-options.html#colorize">&#x2011;colorize</a><a href="command-line-options.html#colormap">&#x2011;colormap</a><a href="command-line-options.html#color-matrix">&#x2011;color&#x2011;matrix</a><a href="command-line-options.html#colors">&#x2011;colors</a><a href="command-line-options.html#colorspace">&#x2011;colorspace</a><a href="command-line-options.html#combine">&#x2011;combine</a><a href="command-line-options.html#comment">&#x2011;comment</a><a href="command-line-options.html#compare">&#x2011;compare</a><a href="command-line-options.html#complex">&#x2011;complex</a><a href="command-line-options.html#compose">&#x2011;compose</a><a href="command-line-options.html#composite">&#x2011;composite</a><a href="command-line-options.html#compress">&#x2011;compress</a><a href="command-line-options.html#connected-components">&#x2011;connected&#x2011;components</a><a href="command-line-options.html#contrast">&#x2011;contrast</a><a href="command-line-options.html#contrast-stretch">&#x2011;contrast&#x2011;stretch</a><a href="command-line-options.html#convolve">&#x2011;convolve</a><a href="command-line-options.html#copy">&#x2011;copy</a><a href="command-line-options.html#crop">&#x2011;crop</a><a href="command-line-options.html#cycle">&#x2011;cycle</a><a href="command-line-options.html#debug">&#x2011;debug</a><a href="command-line-options.html#decipher">&#x2011;decipher</a><a href="command-line-options.html#deconstruct">&#x2011;deconstruct</a><a href="command-line-options.html#define">&#x2011;define</a><a href="command-line-options.html#delay">&#x2011;delay</a><a href="command-line-options.html#delete">&#x2011;delete</a><a href="command-line-options.html#density">&#x2011;density</a><a href="command-line-options.html#depth">&#x2011;depth</a><a href="command-line-options.html#descend">&#x2011;descend</a><a href="command-line-options.html#deskew">&#x2011;deskew</a><a href="command-line-options.html#despeckle">&#x2011;despeckle</a><a href="command-line-options.html#direction">&#x2011;direction</a><a href="command-line-options.html#displace">&#x2011;displace</a><a href="command-line-options.html#display">&#x2011;display</a><a href="command-line-options.html#dispose">&#x2011;dispose</a><a href="command-line-options.html#dissimilarity-threshold">&#x2011;dissimilarity&#x2011;threshold</a><a href="command-line-options.html#dissolve">&#x2011;dissolve</a><a href="command-line-options.html#distort">&#x2011;distort</a><a href="command-line-options.html#distribute-cache">&#x2011;distribute&#x2011;cache</a><a href="command-line-options.html#dither">&#x2011;dither</a><a href="command-line-options.html#draw">&#x2011;draw</a><a href="command-line-options.html#duplicate">&#x2011;duplicate</a><a href="command-line-options.html#edge">&#x2011;edge</a><a href="command-line-options.html#emboss">&#x2011;emboss</a><a href="command-line-options.html#encipher">&#x2011;encipher</a><a href="command-line-options.html#encoding">&#x2011;encoding</a><a href="command-line-options.html#endian">&#x2011;endian</a><a href="command-line-options.html#enhance">&#x2011;enhance</a><a href="command-line-options.html#equalize">&#x2011;equalize</a><a href="command-line-options.html#evaluate">&#x2011;evaluate</a><a href="command-line-options.html#evaluate-sequence">&#x2011;evaluate&#x2011;sequence</a><a href="command-line-options.html#extent">&#x2011;extent</a><a href="command-line-options.html#extract">&#x2011;extract</a><a href="command-line-options.html#family">&#x2011;family</a><a href="command-line-options.html#features">&#x2011;features</a><a href="command-line-options.html#fft">&#x2011;fft</a><a href="command-line-options.html#fill">&#x2011;fill</a><a href="command-line-options.html#filter">&#x2011;filter</a><a href="command-line-options.html#flatten">&#x2011;flatten</a><a href="command-line-options.html#flip">&#x2011;flip</a><a href="command-line-options.html#floodfill">&#x2011;floodfill</a><a href="command-line-options.html#flop">&#x2011;flop</a><a href="command-line-options.html#font">&#x2011;font</a><a href="command-line-options.html#foreground">&#x2011;foreground</a><a href="command-line-options.html#format">&#x2011;format</a><a href="command-line-options.html#format_identify_">&#x2011;format[identify]</a><a href="command-line-options.html#frame">&#x2011;frame</a><a href="command-line-options.html#frame_import_">&#x2011;frame[import]</a><a href="command-line-options.html#function">&#x2011;function</a><a href="command-line-options.html#fuzz">&#x2011;fuzz</a><a href="command-line-options.html#fx">&#x2011;fx</a><a href="command-line-options.html#gamma">&#x2011;gamma</a><a href="command-line-options.html#gaussian-blur">&#x2011;gaussian&#x2011;blur</a><a href="command-line-options.html#geometry">&#x2011;geometry</a><a href="command-line-options.html#gravity">&#x2011;gravity</a><a href="command-line-options.html#grayscale">&#x2011;grayscale</a><a href="command-line-options.html#green-primary">&#x2011;green&#x2011;primary</a><a href="command-line-options.html#hald-clut">&#x2011;hald&#x2011;clut</a><a href="command-line-options.html#help">&#x2011;help</a><a href="command-line-options.html#highlight-color">&#x2011;highlight&#x2011;color</a><a href="command-line-options.html#hough-lines">&#x2011;hough&#x2011;lines</a><a href="command-line-options.html#iconGeometry">&#x2011;iconGeometry</a><a href="command-line-options.html#iconic">&#x2011;iconic</a><a href="command-line-options.html#identify">&#x2011;identify</a><a href="command-line-options.html#ift">&#x2011;ift</a><a href="command-line-options.html#immutable">&#x2011;immutable</a><a href="command-line-options.html#implode">&#x2011;implode</a><a href="command-line-options.html#insert">&#x2011;insert</a><a href="command-line-options.html#intensity">&#x2011;intensity</a><a href="command-line-options.html#intent">&#x2011;intent</a><a href="command-line-options.html#interlace">&#x2011;interlace</a><a href="command-line-options.html#interpolate">&#x2011;interpolate</a><a href="command-line-options.html#interline-spacing">&#x2011;interline&#x2011;spacing</a><a href="command-line-options.html#interword-spacing">&#x2011;interword&#x2011;spacing</a><a href="command-line-options.html#kerning">&#x2011;kerning</a><a href="command-line-options.html#kuwahara">&#x2011;kuwahara</a><a href="command-line-options.html#label">&#x2011;label</a><a href="command-line-options.html#lat">&#x2011;lat</a><a href="command-line-options.html#layers">&#x2011;layers</a><a href="command-line-options.html#level">&#x2011;level</a><a href="command-line-options.html#level-colors">&#x2011;level&#x2011;colors</a><a href="command-line-options.html#limit">&#x2011;limit</a><a href="command-line-options.html#linear-stretch">&#x2011;linear&#x2011;stretch</a><a href="command-line-options.html#linewidth">&#x2011;linewidth</a><a href="command-line-options.html#liquid-rescale">&#x2011;liquid&#x2011;rescale</a><a href="command-line-options.html#list">&#x2011;list</a><a href="command-line-options.html#log">&#x2011;log</a><a href="command-line-options.html#loop">&#x2011;loop</a><a href="command-line-options.html#lowlight-color">&#x2011;lowlight&#x2011;color</a><a href="command-line-options.html#magnify">&#x2011;magnify</a><a href="command-line-options.html#map">&#x2011;map</a><a href="command-line-options.html#map_stream_">&#x2011;map[stream]</a><a href="command-line-options.html#mattecolor">&#x2011;mattecolor</a><a href="command-line-options.html#median">&#x2011;median</a><a href="command-line-options.html#mean-shift">&#x2011;mean&#x2011;shift</a><a href="command-line-options.html#metric">&#x2011;metric</a><a href="command-line-options.html#mode">&#x2011;mode</a><a href="command-line-options.html#modulate">&#x2011;modulate</a><a href="command-line-options.html#moments">&#x2011;moments</a><a href="command-line-options.html#monitor">&#x2011;monitor</a><a href="command-line-options.html#monochrome">&#x2011;monochrome</a><a href="command-line-options.html#morph">&#x2011;morph</a><a href="command-line-options.html#morphology">&#x2011;morphology</a><a href="command-line-options.html#mosaic">&#x2011;mosaic</a><a href="command-line-options.html#motion-blur">&#x2011;motion&#x2011;blur</a><a href="command-line-options.html#name">&#x2011;name</a><a href="command-line-options.html#negate">&#x2011;negate</a><a href="command-line-options.html#noise">&#x2011;noise</a><a href="command-line-options.html#normalize">&#x2011;normalize</a><a href="command-line-options.html#opaque">&#x2011;opaque</a><a href="command-line-options.html#ordered-dither">&#x2011;ordered&#x2011;dither</a><a href="command-line-options.html#orient">&#x2011;orient</a><a href="command-line-options.html#page">&#x2011;page</a><a href="command-line-options.html#paint">&#x2011;paint</a><a href="command-line-options.html#path">&#x2011;path</a><a href="command-line-options.html#pause_animate_">&#x2011;pause[animate]</a><a href="command-line-options.html#pause_import_">&#x2011;pause[import]</a><a href="command-line-options.html#perceptible">&#x2011;perceptible</a><a href="command-line-options.html#ping">&#x2011;ping</a><a href="command-line-options.html#pointsize">&#x2011;pointsize</a><a href="command-line-options.html#polaroid">&#x2011;polaroid</a><a href="command-line-options.html#poly">&#x2011;poly</a><a href="command-line-options.html#posterize">&#x2011;posterize</a><a href="command-line-options.html#precision">&#x2011;precision</a><a href="command-line-options.html#preview">&#x2011;preview</a><a href="command-line-options.html#print">&#x2011;print</a><a href="command-line-options.html#process">&#x2011;process</a><a href="command-line-options.html#profile">&#x2011;profile</a><a href="command-line-options.html#quality">&#x2011;quality</a><a href="command-line-options.html#quantize">&#x2011;quantize</a><a href="command-line-options.html#quiet">&#x2011;quiet</a><a href="command-line-options.html#radial-blur">&#x2011;radial&#x2011;blur</a><a href="command-line-options.html#raise">&#x2011;raise</a><a href="command-line-options.html#random-threshold">&#x2011;random&#x2011;threshold</a><a href="command-line-options.html#read-mask">&#x2011;read&#x2011;mask</a><a href="command-line-options.html#red-primary">&#x2011;red&#x2011;primary</a><a href="command-line-options.html#regard-warnings">&#x2011;regard&#x2011;warnings</a><a href="command-line-options.html#region">&#x2011;region</a><a href="command-line-options.html#remap">&#x2011;remap</a><a href="command-line-options.html#remote">&#x2011;remote</a><a href="command-line-options.html#render">&#x2011;render</a><a href="command-line-options.html#repage">&#x2011;repage</a><a href="command-line-options.html#resample">&#x2011;resample</a><a href="command-line-options.html#resize">&#x2011;resize</a><a href="command-line-options.html#respect-parentheses">&#x2011;respect&#x2011;parentheses</a><a href="command-line-options.html#reverse">&#x2011;reverse</a><a href="command-line-options.html#roll">&#x2011;roll</a><a href="command-line-options.html#rotate">&#x2011;rotate</a><a href="command-line-options.html#sample">&#x2011;sample</a><a href="command-line-options.html#sampling-factor">&#x2011;sampling&#x2011;factor</a><a href="command-line-options.html#scale">&#x2011;scale</a><a href="command-line-options.html#scene">&#x2011;scene</a><a href="command-line-options.html#screen">&#x2011;screen</a><a href="command-line-options.html#seed">&#x2011;seed</a><a href="command-line-options.html#segment">&#x2011;segment</a><a href="command-line-options.html#selective-blur">&#x2011;selective&#x2011;blur</a><a href="command-line-options.html#separate">&#x2011;separate</a><a href="command-line-options.html#sepia-tone">&#x2011;sepia&#x2011;tone</a><a href="command-line-options.html#set">&#x2011;set</a><a href="command-line-options.html#shade">&#x2011;shade</a><a href="command-line-options.html#shadow">&#x2011;shadow</a><a href="command-line-options.html#shared-memory">&#x2011;shared&#x2011;memory</a><a href="command-line-options.html#sharpen">&#x2011;sharpen</a><a href="command-line-options.html#shave">&#x2011;shave</a><a href="command-line-options.html#shear">&#x2011;shear</a><a href="command-line-options.html#sigmoidal-contrast">&#x2011;sigmoidal&#x2011;contrast</a><a href="command-line-options.html#silent">&#x2011;silent</a><a href="command-line-options.html#similarity-threshold">&#x2011;similarity&#x2011;threshold</a><a href="command-line-options.html#size">&#x2011;size</a><a href="command-line-options.html#sketch">&#x2011;sketch</a><a href="command-line-options.html#smush">&#x2011;smush</a><a href="command-line-options.html#snaps">&#x2011;snaps</a><a href="command-line-options.html#solarize">&#x2011;solarize</a><a href="command-line-options.html#sparse-color">&#x2011;sparse&#x2011;color</a><a href="command-line-options.html#splice">&#x2011;splice</a><a href="command-line-options.html#spread">&#x2011;spread</a><a href="command-line-options.html#statistic">&#x2011;statistic</a><a href="command-line-options.html#stegano">&#x2011;stegano</a><a href="command-line-options.html#stereo">&#x2011;stereo</a><a href="command-line-options.html#storage-type">&#x2011;storage&#x2011;type</a><a href="command-line-options.html#stretch">&#x2011;stretch</a><a href="command-line-options.html#strip">&#x2011;strip</a><a href="command-line-options.html#stroke">&#x2011;stroke</a><a href="command-line-options.html#strokewidth">&#x2011;strokewidth</a><a href="command-line-options.html#style">&#x2011;style</a><a href="command-line-options.html#subimage-search">&#x2011;subimage&#x2011;search</a><a href="command-line-options.html#swap">&#x2011;swap</a><a href="command-line-options.html#swirl">&#x2011;swirl</a><a href="command-line-options.html#synchronize">&#x2011;synchronize</a><a href="command-line-options.html#taint">&#x2011;taint</a><a href="command-line-options.html#text-font">&#x2011;text&#x2011;font</a><a href="command-line-options.html#texture">&#x2011;texture</a><a href="command-line-options.html#threshold">&#x2011;threshold</a><a href="command-line-options.html#thumbnail">&#x2011;thumbnail</a><a href="command-line-options.html#tile">&#x2011;tile</a><a href="command-line-options.html#tile-offset">&#x2011;tile&#x2011;offset</a><a href="command-line-options.html#tint">&#x2011;tint</a><a href="command-line-options.html#title">&#x2011;title</a><a href="command-line-options.html#transform">&#x2011;transform</a><a href="command-line-options.html#transparent">&#x2011;transparent</a><a href="command-line-options.html#transparent-color">&#x2011;transparent&#x2011;color</a><a href="command-line-options.html#transpose">&#x2011;transpose</a><a href="command-line-options.html#transverse">&#x2011;transverse</a><a href="command-line-options.html#treedepth">&#x2011;treedepth</a><a href="command-line-options.html#trim">&#x2011;trim</a><a href="command-line-options.html#type">&#x2011;type</a><a href="command-line-options.html#undercolor">&#x2011;undercolor</a><a href="command-line-options.html#unique-colors">&#x2011;unique&#x2011;colors</a><a href="command-line-options.html#units">&#x2011;units</a><a href="command-line-options.html#unsharp">&#x2011;unsharp</a><a href="command-line-options.html#update">&#x2011;update</a><a href="command-line-options.html#verbose">&#x2011;verbose</a><a href="command-line-options.html#version">&#x2011;version</a><a href="command-line-options.html#view">&#x2011;view</a><a href="command-line-options.html#vignette">&#x2011;vignette</a><a href="command-line-options.html#virtual-pixel">&#x2011;virtual&#x2011;pixel</a><a href="command-line-options.html#visual">&#x2011;visual</a><a href="command-line-options.html#watermark">&#x2011;watermark</a><a href="command-line-options.html#wave">&#x2011;wave</a><a href="command-line-options.html#wavelet-denoise">&#x2011;wavelet&#x2011;denoise</a><a href="command-line-options.html#weight">&#x2011;weight</a><a href="command-line-options.html#white-point">&#x2011;white&#x2011;point</a><a href="command-line-options.html#white-threshold">&#x2011;white&#x2011;threshold</a><a href="command-line-options.html#window">&#x2011;window</a><a href="command-line-options.html#window-group">&#x2011;window&#x2011;group</a><a href="command-line-options.html#write">&#x2011;write</a><a href="command-line-options.html#write-mask">&#x2011;write&#x2011;mask</a> </p>
Cristy882d9f42015-10-29 16:48:39 -040061<p class="lead magick-description">Below is list of command-line options recognized by the ImageMagick <a href="command-line-tools.html">command-line tools</a>. If you want a description of a particular option, click on the option name in the navigation bar above and you will go right to it. Unless otherwise noted, each option is recognized by the commands: <a href="convert.html">convert</a> and <a href="mogrify.html">mogrify</a>.</p>
62
63<div style="margin: auto;">
64 <h3 class="magick-header"><a id="adaptive-blur"></a>-adaptive-blur <var>radius</var>[x<var>sigma</var>]</h3>
65</div>
66
67<p class="magick-description">Adaptively blur pixels, with decreasing effect near edges.</p>
68
69<p>A Gaussian operator of the given radius and standard deviation (<var>sigma</var>) is used. If <var>sigma</var> is not given it
70defaults to 1.</p>
71
72<div style="margin: auto;">
73 <h3 class="magick-header"><a id="adaptive-resize"></a>-adaptive-resize <var>geometry</var></h3>
74</div>
75
76<p class="magick-description">Resize the image using data-dependent triangulation.</p>
77
78<p>See <a href="command-line-processing.html#geometry">Image Geometry</a> for complete details about the <em class="arg">geometry</em> argument. The <a href="command-line-options.html#adaptive-resize">-adaptive-resize</a>
Cristy594d2772015-11-15 10:47:42 -050079option defaults to data-dependent triangulation. Use the <a
80href="command-line-options.html#filter">-filter</a> to choose a different resampling algorithm.
81Offsets, if present in the geometry string, are ignored, and the <a
82href="command-line-options.html#gravity">-gravity</a> option has no effect.</p>
Cristy882d9f42015-10-29 16:48:39 -040083
84<div style="margin: auto;">
85 <h3 class="magick-header"><a id="adaptive-sharpen"></a>-adaptive-sharpen <var>radius</var>[x<var>sigma</var>]</h3>
86</div>
87
88<p class="magick-description">Adaptively sharpen pixels, with increasing effect near edges.</p>
89
90<p>A Gaussian operator of the given radius and standard deviation
91(<var>sigma</var>) is used. If <var>sigma</var> is not given it
92defaults to 1.</p>
93
94<div style="margin: auto;">
95 <h3 class="magick-header"><a id="adjoin"></a>-adjoin</h3>
96</div>
97
98<p class="magick-description">Join images into a single multi-image file.</p>
99
100<p>This option is enabled by default. An attempt is made to save all images of
101an image sequence into the given output file. However, some formats, such as
102JPEG and PNG, do not support more than one image per file, and in that case
103ImageMagick is forced to write each image as a separate file. As such, if
104more than one image needs to be written, the filename given is modified by
105adding a <a href="command-line-options.html#scene">-scene</a> number before the suffix, in order to
106make distinct names for each image. </p>
107
108<p>Use <a href="command-line-options.html#adjoin">+adjoin</a> to force each image to be written to
109separate files, whether or not the file format allows multiple images per file
110(for example, GIF, MIFF, and TIFF). </p>
111
112<p>Including a C-style integer format string in the output filename will
113automagically enable <a href="command-line-options.html#adjoin">+adjoin</a> and are used to specify
114where the <a href="command-line-options.html#scene">-scene</a> number is placed in the filenames. These
115strings, such as '<code>%d</code>' or '<code>%03d</code>', are familiar to those
116who have used the standard <code>printf()</code>' C-library function. As an
117example, the command</p>
118
119<pre>
120convert logo: rose: -morph 15 my%02dmorph.jpg
121</pre>
122
123<p>will create a sequence of 17 images (the two given plus 15 more created by
124<a href="command-line-options.html#morph">-morph</a>), named: my00morph.jpg, my01morph.jpg,
125my02morph.jpg, ..., my16morph.jpg. </p>
126
127<p>In summary, ImageMagick tries to write all images to one file, but will
128save to multiple files, if any of the following conditions exist...</p>
129<ol>
130<li>the output image's file format does not allow multi-image files,</li>
131<li>the <a href="command-line-options.html#adjoin">+adjoin</a> option is given, or</li>
132<li>a printf() integer format string (eg: "%d") is present in the output
133 filename.</li>
134</ol>
135
136
137<div style="margin: auto;">
138 <h3 class="magick-header"><a id="affine"></a>-affine
139 <var>s<sub>x</sub></var>,<var>r<sub>x</sub></var>,<var>r<sub>y</sub></var>,<var>s<sub>y</sub></var>[,<var>t<sub>x</sub></var>,<var>t<sub>y</sub></var>]</h3>
140</div>
141
142<p class="magick-description">Set the drawing transformation matrix for combined rotating and scaling.</p>
143
Cristy594d2772015-11-15 10:47:42 -0500144<p>This option sets a transformation matrix, for use by subsequent <a
145href="command-line-options.html#draw">-draw</a> or <a href="command-line-options.html#transform">-transform</a> options. </p>
Cristy882d9f42015-10-29 16:48:39 -0400146
147<p>The matrix entries are entered as comma-separated numeric values either in
148quotes or without spaces. </p>
149
150<p>Internally, the transformation matrix has 3x3 elements, but three of them
151are omitted from the input because they are constant. The new (transformed)
152coordinates (<var>x'</var>, <var>y'</var>) of a pixel at
153position (<var>x</var>, <var>y</var>) in the original
154image are calculated using the following matrix equation.</p>
155
Cristy594d2772015-11-15 10:47:42 -0500156<p class="text-center"><img class="img-thumbnail" alt="affine transformation" src="../images/affine.png"/> </p>
Cristy882d9f42015-10-29 16:48:39 -0400157
158<p> The size of the resulting image is that of the smallest rectangle that
159contains the transformed source image. The parameters
160<var>t<sub>x</sub></var> and <var>t<sub>y</sub></var>
161subsequently shift the image pixels so that those that are moved out of the
162image area are cut off.</p>
163
164<p>The transformation matrix complies with the left-handed pixel coordinate
165system: positive <var>x</var> and <var>y</var> directions
166are rightward and downward, resp.; positive rotation is clockwise.</p>
167
168<p> If the translation coefficients <var>t<sub>x</sub></var> and
169<var>t<sub>y</sub></var> are omitted they default to 0,0. Therefore,
170four parameters suffice for rotation and scaling without translation.</p>
171
172<p>Scaling by the factors <var>s<sub>x</sub></var> and
173<var>s<sub>y</sub></var> in the <var>x</var> and <var>y</var> directions,
174respectively, is accomplished with the following.</p>
175
Cristy594d2772015-11-15 10:47:42 -0500176<p>See <a href="command-line-options.html#transform">-transform</a>, and the <a
177href="command-line-options.html#distort">-distort</a> method '<code>Affineprojection</code> for more
Cristy882d9f42015-10-29 16:48:39 -0400178information </p>
179
180
181<pre>
182-affine <var>s<sub>x</sub></var>,0,0,<var>s<sub>y</sub></var>
183</pre>
184
185<p>Translation by a displacement (<var>t<sub>x</sub></var>, <var>t<sub>y</sub></var>) is accomplished like so:</p>
186
187<pre>
188-affine 1,0,0,1,<var>t<sub>x</sub></var>,<var>t<sub>y</sub></var>
189</pre>
190
191<p>Rotate clockwise about the origin (the upper left-hand corner) by an angle
192<var>a</var> by letting <var>c</var> = cos(<var>a</var>), <var>s</var>
193= sin(<var>a</var>), and using the following.</p>
194
195<pre>
196-affine <var>c</var>,<var>s</var>,-<var>s</var>,<var>c</var>
197</pre>
198
Cristy594d2772015-11-15 10:47:42 -0500199<p>The cumulative effect of a sequence of <a href="command-line-options.html#affine" >-affine</a>
200transformations can be accomplished by instead by a single <a href="command-line-options.html#affine"
201>-affine</a> operation using the matrix equal to the product of the matrices
Cristy882d9f42015-10-29 16:48:39 -0400202of the individual transformations.</p>
203
204<p>An attempt is made to detect near-singular transformation matrices. If the
205matrix determinant has a sufficiently small absolute value it is rejected.</p>
206
207<div style="margin: auto;">
208 <h3 class="magick-header"><a id="alpha"></a>-alpha <var>type</var></h3>
209</div>
210
211<p class="magick-description">Gives control of the alpha/matte channel of an image.</p>
212
213<p>Used to set a flag on an image indicating whether or not to use existing alpha
214channel data, to create an alpha channel, or to perform other operations on the alpha channel. Choose the argument <var>type</var> from the list below.</p>
215
216<dl class="dl-horizontal">
217 <dt>Activate</dt>
218 <dd>
219 Enable the image's transparency channel. Note normally Set
220 should be used instead of this, unless you specifically need to
221 preserve existing (but specifically turned Off) transparency
222 channel. </dd>
223
224 <dt>Associate</dt>
225 <dd>
226 associate the alpha channel with the image.</dd>
227
228 <dt>Deactivate</dt>
229 <dd>
230 Disables the image's transparency channel. Does not delete or change the
231 existing data, just turns off the use of that data.</dd>
232
233 <dt>Disassociate</dt>
234 <dd>
235 disassociate the alpha channel from the image.</dd>
236
237 <dt>Set</dt>
238 <dd>
239 Activates the alpha/matte channel. If it was previously turned off
240 then it also resets the channel to opaque. If the image already had
241 the alpha channel turned on, it will have no effect.</dd>
242
243 <dt>Opaque</dt>
244 <dd>
245 Enables the alpha/matte channel and forces it to be fully opaque.
246 </dd>
247
248 <dt>Transparent</dt>
249 <dd>
250 Activates the alpha/matte channel and forces it to be fully
251 transparent. This effectively creates a fully transparent image the
252 same size as the original and with all its original RGB data still
253 intact, but fully transparent. </dd>
254
255 <dt>Extract</dt>
256 <dd>
257 Copies the alpha channel values into all the color channels and turns
258 'Off' the the image's transparency, so as to generate
Cristy769d8892016-01-19 18:11:14 -0500259 a grayscale mask of the image's shape. The alpha channel data is left
Cristy882d9f42015-10-29 16:48:39 -0400260 intact just deactivated. This is the inverse of 'Copy'.
261 </dd>
262
263 <dt>Copy</dt>
264 <dd>
265 Turns 'On' the alpha/matte channel, then copies the
Cristy769d8892016-01-19 18:11:14 -0500266 grayscale intensity of the image, into the alpha channel, converting
267 a grayscale mask into a transparent shaped mask ready to be colored
Cristy882d9f42015-10-29 16:48:39 -0400268 appropriately. The color channels are not modified. </dd>
269
270 <dt>Shape</dt>
271 <dd>
272 As per 'Copy' but also colors the resulting shape mask with
273 the current background color. That is the RGB color channels is
274 replaced, with appropriate alpha shape.
275 </dd>
276
277 <dt>Remove</dt>
278 <dd>
279 Composite the image over the background color.
280 </dd>
281
282 <dt>Background</dt>
283 <dd>
284 Set any fully-transparent pixel to the background color, while leaving
285 it fully-transparent. This can make some image file formats, such as
286 PNG, smaller as the RGB values of transparent pixels are more uniform,
287 and thus can compress better.
288 </dd>
289</dl>
290
291<p>Note that while the obsolete <code>+matte</code> operation was the
Cristy594d2772015-11-15 10:47:42 -0500292same as "<code><a href="command-line-options.html#alpha" >-alpha</a> Off</code>", the <code>
293>-matte</code> operation was the same as "<code><a href="command-line-options.html#alpha" >-alpha</a>
294Set</code>" and not "<code><a href="command-line-options.html#alpha" >-alpha</a> On</code>". </p>
Cristy882d9f42015-10-29 16:48:39 -0400295
Cristyf650f4f2016-04-01 10:53:07 -0400296<div style="margin: auto;">
Cristy882d9f42015-10-29 16:48:39 -0400297 <h3 class="magick-header"><a id="annotate"></a>
Cristy594d2772015-11-15 10:47:42 -0500298 -annotate <var>degrees</var> <var>text</var><br />
299 -annotate <var>Xdegrees</var>x<var>Ydegrees</var> <var>text</var><br /> -annotate <var>Xdegrees</var>x<var>Ydegrees</var> {+-}<var>t<sub>x</sub></var>{+-}<var>t<sub>y</sub></var> <var>text</var><br /> -annotate {+-}<var>t<sub>x</sub></var>{+-}<var>t<sub>y</sub></var> <var>text</var></h3>
Cristy882d9f42015-10-29 16:48:39 -0400300</div>
301
302<p class="magick-description">Annotate an image with text</p>
303
304<p>This is a convenience for annotating an image with text. For more precise
305control over text annotations, use <a href="command-line-options.html#draw">-draw</a>.</p>
306
307
308<p>The values <var>Xdegrees</var> and <var>Ydegrees</var>
Cristy594d2772015-11-15 10:47:42 -0500309control the shears applied to the text, while <var>t<sub>x</sub></var> and <var>t<sub>y</sub></var> are offsets that give the location of the text relative any <a href="command-line-options.html#gravity" >-gravity</a> setting and defaults to the upper left corner of the image.</p>
Cristy882d9f42015-10-29 16:48:39 -0400310
311<p>Using <a href="command-line-options.html#annotate">-annotate</a> <var>degrees</var>
312or <a href="command-line-options.html#annotate">-annotate</a> <var>degrees</var>x<var>degrees</var> produces an unsheared rotation of the text. The
313direction of the rotation is positive, which means a clockwise rotation if <var>degrees</var> is positive. (This conforms to the usual mathematical
314convention once it is realized that the positive <var>y</var>–direction is
315conventionally considered to be <var>downward</var> for images.)</p>
316
317<p>The new (transformed) coordinates (<var>x'</var>, <var>y'</var>) of a pixel at position (<var>x</var>, <var>y</var>) in the image are calculated using the following matrix
318equation.</p>
319
Cristy594d2772015-11-15 10:47:42 -0500320<p class="text-center"><img class="img-thumbnail" alt="annotate transformation" src="../images/annotate.png"/></p>
Cristy882d9f42015-10-29 16:48:39 -0400321
322<p>If <var>t<sub>x</sub></var> and <var>t<sub>y</sub></var> are omitted, they default to 0. This makes the
323bottom-left of the text becomes the upper-left corner of the image, which is
Cristy594d2772015-11-15 10:47:42 -0500324probably undesirable. Adding a <a href="command-line-options.html#gravity" >-gravity</a> option in this
Cristy882d9f42015-10-29 16:48:39 -0400325case leads to nice results.</p>
326
327<p>Text is any UTF-8 encoded character sequence. If <var>text</var>
328is of the form '@mytext.txt', the text is read from the file
329<code>mytext.txt</code>. Text in a file is taken literally; no embedded
330formatting characters are recognized.</p>
331
332<div style="margin: auto;">
333 <h3 class="magick-header"><a id="antialias"></a>-antialias</h3>
334</div>
335
336<p class="magick-description">Enable/Disable of the rendering of anti-aliasing pixels when drawing fonts and lines.</p>
337
338<p>By default, objects (e.g. text, lines, polygons, etc.) are antialiased when
339drawn. Use <a href="command-line-options.html#antialias">+antialias</a> to disable the addition of
340antialiasing edge pixels. This will then reduce the number of colors added to
341an image to just the colors being directly drawn. That is, no mixed colors
342are added when drawing such objects. </p>
343
344<div style="margin: auto;">
345 <h3 class="magick-header"><a id="append"></a>-append</h3>
346</div>
347
348<p class="magick-description">Join current images vertically or horizontally.</p>
349
350<p>This option creates a single longer image, by joining all the current
351images in sequence top-to-bottom. Use <a href="command-line-options.html#append">+append</a> to
352stack images left-to-right. </p>
353
354<p>If they are not of the same width, narrower images are padded with the
355current <a href="command-line-options.html#background">-background</a> color setting, and their
Cristy594d2772015-11-15 10:47:42 -0500356position relative to each other can be controlled by the current <a
357href="command-line-options.html#gravity">-gravity</a> setting. </p>
Cristy882d9f42015-10-29 16:48:39 -0400358
359
360<div style="margin: auto;">
361 <h3 class="magick-header"><a id="attenuate"></a>-attenuate <var>value</var></h3>
362</div>
363
364<p class="magick-description">Lessen (or intensify) when adding noise to an image.</p>
365
366<p>If unset the value is equivalent to 1.0, or a maximum noise addition</p>
367
368<div style="margin: auto;">
369 <h3 class="magick-header"><a id="authenticate"></a>-authenticate <var>password</var></h3>
370</div>
371
372<p class="magick-description">Decrypt a PDF with a password.</p>
373
374<p>Use this option to supply a <var>password</var> for decrypting
375a PDF that has been encrypted using Microsoft Crypto API (MSC API). The
376encrypting using the MSC API is not supported.</p>
377
378<p>For a different encryption method, see <a href="command-line-options.html#encipher">-encipher</a>
379and <a href="command-line-options.html#decipher">-decipher</a>. </p>
380
381
382<div style="margin: auto;">
383 <h3 class="magick-header"><a id="auto-gamma"></a>-auto-gamma</h3>
384</div>
385
386<p class="magick-description">Automagically adjust gamma level of image.</p>
387
Cristy594d2772015-11-15 10:47:42 -0500388<p>This calculates the mean values of an image, then applies a calculated <a
389href="command-line-options.html#gamma" >-gamma</a> adjustment so that is the mean color exists in the
Cristy882d9f42015-10-29 16:48:39 -0400390image it will get a have a value of 50%. </p>
391
392<p>This means that any solid 'gray' image becomes 50% gray. </p>
393
394<p>This works well for real-life images with little or no extreme dark and
395light areas, but tend to fail for images with large amounts of bright sky or
396dark shadows. It also does not work well for diagrams or cartoon like images.
397</p>
398
Cristy594d2772015-11-15 10:47:42 -0500399<p>It uses the <a href="command-line-options.html#channel" >-channel</a> setting, (including the
Cristy882d9f42015-10-29 16:48:39 -0400400'<var>sync</var>' flag for channel synchronization), to determine which color
Cristy594d2772015-11-15 10:47:42 -0500401values is used and modified. As the default <a href="command-line-options.html#channel"
402>-channel</a> setting is '<var>RGB,sync</var>', channels are modified
Cristy882d9f42015-10-29 16:48:39 -0400403together by the same gamma value, preserving colors. </p>
404
405
406
407<div style="margin: auto;">
408 <h3 class="magick-header"><a id="auto-level"></a>-auto-level</h3>
409</div>
410
411<p class="magick-description">Automagically adjust color levels of image.</p>
412
413<p>This is a 'perfect' image normalization operator. It finds the exact
Cristy594d2772015-11-15 10:47:42 -0500414minimum and maximum color values in the image and then applies a <a
415href="command-line-options.html#level" >-level</a> operator to stretch the values to the full range of
Cristy882d9f42015-10-29 16:48:39 -0400416values. </p>
417
418<p>The operator is not typically used for real-life images, image scans, or
419JPEG format images, as a single 'out-rider' pixel can set a bad min/max values
Cristy594d2772015-11-15 10:47:42 -0500420for the <a href="command-line-options.html#level" >-level</a> operation. On the other hand it is the
Cristy882d9f42015-10-29 16:48:39 -0400421right operator to use for color stretching gradient images being used to
422generate Color lookup tables, distortion maps, or other 'mathematically'
423defined images. </p>
424
Cristy594d2772015-11-15 10:47:42 -0500425<p>The operator is very similar to the <a href="command-line-options.html#normalize">-normalize</a>, <a
426href="command-line-options.html#contrast-stretch" >-contrast-stretch</a>, and <a href="command-line-options.html#linear-stretch"
427>-linear-stretch</a> operators, but without 'histogram binning' or 'clipping'
428problems that these operators may have. That is <a href="command-line-options.html#auto-level"
429>-auto-level</a> is the perfect or ideal version these operators. </p>
Cristy882d9f42015-10-29 16:48:39 -0400430
Cristy594d2772015-11-15 10:47:42 -0500431<p>It uses the <a href="command-line-options.html#channel" >-channel</a> setting, (including the
Cristy882d9f42015-10-29 16:48:39 -0400432special '<var>sync</var>' flag for channel synchronization), to determine
Cristy594d2772015-11-15 10:47:42 -0500433which color values are used and modified. As the default <a
434href="command-line-options.html#channel" >+channel</a> setting is '<var>RGB,sync</var>', the
Cristy882d9f42015-10-29 16:48:39 -0400435'<var>sync</var>' ensures that the color channels will are modified
436together by the same gamma value, preserving colors, and ignoring
437transparency. </p>
438
439
440<div style="margin: auto;">
441 <h3 class="magick-header"><a id="auto-orient"></a>-auto-orient</h3>
442</div>
443
444<p class="magick-description">adjusts an image so that its orientation is suitable for viewing (i.e. top-left orientation).</p>
445
446<p>This operator reads and resets the EXIF image profile setting 'Orientation'
447and then performs the appropriate 90 degree rotation on the image to orient
448the image, for correct viewing. </p>
449
450<p>This EXIF profile setting is usually set using a gravity sensor in digital
451camera, however photos taken directly downward or upward may not have an
452appropriate value. Also images that have been orientation 'corrected' without
453reseting this setting, may be 'corrected' again resulting in a incorrect
Cristy594d2772015-11-15 10:47:42 -0500454result. If the EXIF profile was previously stripped, the <a
455href="command-line-options.html#auto-orient" >-auto-orient</a> operator will do nothing. </p>
Cristy882d9f42015-10-29 16:48:39 -0400456
457
458<div style="margin: auto;">
459 <h3 class="magick-header"><a id="average"></a>-average</h3>
460</div>
461
462<p class="magick-description">Average a set of images.</p>
463
464<p>An error results if the images are not identically sized.</p>
465
466
467<div style="margin: auto;">
468 <h3 class="magick-header"><a id="backdrop"></a>-backdrop</h3>
469</div>
470
471<p class="magick-description">Display the image centered on a backdrop.</p>
472
473<p>This backdrop covers the entire workstation screen and is useful for hiding
474other X window activity while viewing the image. The color of the backdrop is
475specified as the background color. The color is specified using the format
476described under the <a href="command-line-options.html#fill">-fill</a> option.</p>
477
478<div style="margin: auto;">
479 <h3 class="magick-header"><a id="background"></a>-background <var>color</var></h3>
480</div>
481
482<p class="magick-description">Set the background color.</p>
483
Cristy594d2772015-11-15 10:47:42 -0500484<p>The color is specified using the format described under the <a
485href="command-line-options.html#fill">-fill</a> option. The default background color (if none is
Cristy882d9f42015-10-29 16:48:39 -0400486specified or found in the image) is white.</p>
487
488<div style="margin: auto;">
489 <h3 class="magick-header"><a id="bench"></a>-bench <var>iterations</var></h3>
490</div>
491
492<p class="magick-description">Measure performance.</p>
493
494<p>Repeat the entire command for the given number of <var>iterations</var> and report the user-time and elapsed time. For instance,
495consider the following command and its output. Modify the benchmark with the
496-duration to run the benchmark for a fixed number of seconds and -concurrent
497to run the benchmark in parallel (requires the OpenMP feature).</p>
498
499<pre>
Cristye09ed312016-03-06 08:07:39 -0500500-> convert logo: -resize 200% -bench 5 logo.png
501Performance[1]: 5i 1.344ips 1.000e 3.710u 0:03.720
502Performance[2]: 5i 1.634ips 0.549e 3.890u 0:03.060
503Performance[3]: 5i 2.174ips 0.618e 3.190u 0:02.300
504Performance[4]: 5i 1.678ips 0.555e 3.810u 0:02.980
Cristy882d9f42015-10-29 16:48:39 -0400505Performance[4]: 5i 0.875657ips 6.880u 0:05.710
506</pre>
507
Cristye09ed312016-03-06 08:07:39 -0500508<p>In this example, 5 iterations were completed at 2.174 iterations per
509second, using 3 threads and 3.190 seconds of the user allotted time, for
510a total elapsed time of 2.300 seconds.</p>
Cristy882d9f42015-10-29 16:48:39 -0400511
512<div style="margin: auto;">
513 <h3 class="magick-header"><a id="bias"></a>-bias <var>value</var>{<var>%</var>}</h3>
514</div>
515
516<p class="magick-description">Add bias when convolving an image.</p>
517
Cristy594d2772015-11-15 10:47:42 -0500518<p>This option shifts the output of <a href="command-line-options.html#convolve">&#x2011;convolve</a> so that
Cristy882d9f42015-10-29 16:48:39 -0400519positive and negative results are relative to the specified bias value. </p>
520
521<p>This is important for non-HDRI compilations of ImageMagick when dealing
522with convolutions that contain negative as well as positive values. This is
523especially the case with convolutions involving high pass filters or edge
524detection. Without an output bias, the negative values are clipped at
525zero.</p>
526
Cristy594d2772015-11-15 10:47:42 -0500527<p>When using an ImageMagick with the HDRI compile-time setting, <a href="command-line-options.html#bias">&#x2011;bias</a> is not needed, as ImageMagick is able to store/handle any
Cristy882d9f42015-10-29 16:48:39 -0400528negative results without clipping to the color value range
529(0..QuantumRange).</p>
530
Cristy594d2772015-11-15 10:47:42 -0500531<p>See the discussion on HDRI implementations of ImageMagick on the page <a
532href="high-dynamic-range.html" >High Dynamic-Range Images</a>. For more
533about HDRI go the ImageMagick <a
Cristy364a72f2016-11-04 22:38:41 -0400534href="https://www.imagemagick.org/Usage/basics/#hdri" >Usage</a> pages or this
Cristy594d2772015-11-15 10:47:42 -0500535<a
536href="http://en.wikipedia.org/wiki/High_dynamic_range_imaging">Wikipedia</a>
Cristy882d9f42015-10-29 16:48:39 -0400537entry. </p>
538
539<div style="margin: auto;">
540 <h3 class="magick-header"><a id="black-point-compensation"></a>-black-point-compensation</h3>
541</div>
542
543<p class="magick-description">Use black point compensation.</p>
544
545<div style="margin: auto;">
546 <h3 class="magick-header"><a id="black-threshold"></a>-black-threshold <var>value</var>{<var>%</var>}</h3>
547</div>
548
549<p class="magick-description">Force to black all pixels below the threshold while leaving all pixels at or above the threshold unchanged.</p>
550
551<p> The threshold value can be given as a percentage or as an absolute integer
552value within [0, <var>QuantumRange</var>] corresponding to the
Cristy594d2772015-11-15 10:47:42 -0500553desired <a href="command-line-options.html#channel">&#x2011;channel</a> value. See <a href="command-line-options.html#threshold">&#x2011;threshold</a>for more details on thresholds and resulting values. </p>
Cristy882d9f42015-10-29 16:48:39 -0400554
555
556<div style="margin: auto;">
557 <h3 class="magick-header"><a id="blend"></a>-blend <var>geometry</var></h3>
558</div>
559
560<p class="magick-description">blend an image into another by the given absolute value or percent.</p>
561
562<p>Blend will average the images together ('plus') according to the
563percentages given and each pixels transparency. If only a single percentage
564value is given it sets the weight of the composite or 'source' image, while
565the background image is weighted by the exact opposite amount. That is a
566<code>-blend 30%</code> merges 30% of the 'source' image with 70% of the
567'destination' image. Thus it is equivalent to <code>-blend 30x70%</code>.</p>
568
569
570<div style="margin: auto;">
571 <h3 class="magick-header"><a id="blue-primary"></a>-blue-primary <var>x</var>,<var>y</var></h3>
572</div>
573
574<p class="magick-description">Set the blue chromaticity primary point.</p>
575
576<div style="margin: auto;">
577 <h3 class="magick-header"><a id="blue-shift"></a>-blue-shift <var>factor</var></h3>
578</div>
579
580<p class="magick-description">simulate a scene at nighttime in the moonlight. Start with a factor of 1.5</p>
581
582<div style="margin: auto;">
583
584<div style="margin: auto;">
Cristy594d2772015-11-15 10:47:42 -0500585 <h3 class="magick-header"><a id="blur"></a>-blur <var>radius</var><br />-blur <var>radius</var>x<var>sigma</var></h3>
Cristy882d9f42015-10-29 16:48:39 -0400586</div>
587
588<p class="magick-description">Reduce image noise and reduce detail levels.</p>
589
590<p>Convolve the image with a Gaussian or normal distribution using the given
Cristy594d2772015-11-15 10:47:42 -0500591<var >Sigma</var> value. The formula is:</p>
Cristy882d9f42015-10-29 16:48:39 -0400592
Cristy594d2772015-11-15 10:47:42 -0500593<p class="text-center"><img class="img-thumbnail" alt="gaussian distribution" width="243px" height="42px" src="../images/gaussian-blur.png"/></p>
Cristy882d9f42015-10-29 16:48:39 -0400594
Cristy594d2772015-11-15 10:47:42 -0500595<p>The <var >Sigma</var> value is the important argument, and
Cristy882d9f42015-10-29 16:48:39 -0400596determines the actual amount of blurring that will take place. </p>
597
Cristy594d2772015-11-15 10:47:42 -0500598<p>The <var >Radius</var> is only used to determine the size of the
Cristy882d9f42015-10-29 16:48:39 -0400599array which will hold the calculated Gaussian distribution. It should be an
600integer. If not given, or set to zero, IM will calculate the largest possible
601radius that will provide meaningful results for the Gaussian distribution.
602</p>
603
Cristy594d2772015-11-15 10:47:42 -0500604<p>The larger the <var >Radius</var> the slower the
605operation is. However too small a <var >Radius</var>, and sever
606aliasing effects may result. As a guideline, <var >Radius</var>
607should be at least twice the <var >Sigma</var> value, though three
Cristy882d9f42015-10-29 16:48:39 -0400608times will produce a more accurate result. </p>
609
610<p>This option differs from <a href="command-line-options.html#gaussian-blur">-gaussian-blur</a> simply
611by taking advantage of the separability properties of the distribution. Here
612we apply a single-dimensional Gaussian matrix in the horizontal direction,
613then repeat the process in the vertical direction.</p>
614
615<p>The <a href="command-line-options.html#virtual-pixel">-virtual-pixel</a> setting will determine how
616pixels which are outside the image proper are blurred into the final result.
617</p>
618
619
620<div style="margin: auto;">
Cristy882d9f42015-10-29 16:48:39 -0400621 <h3 class="magick-header"><a id="border"></a>-border <var>geometry</var></h3>
622</div>
623
624<p class="magick-description">Surround the image with a border of color. </p>
625
626<p>Set the width and height using the <var>size</var> portion of the
627<var>geometry</var> argument. See <a href="command-line-processing.html#geometry">Image Geometry</a> for complete details about the <em class="arg">geometry</em> argument. Offsets are
628ignored. </p>
629
630<p>As of IM 6.7.8-8, the <var>geometry</var> arguments behave as follows:</p>
631
632<dl class="dl-horizontal">
633<dt><var>value</var></dt>
634<dd>value is added to both left/right and top/bottom</dd>
635<dt><var>value-x</var><kbd>x</kbd></dt>
636<dd>value-x is added only to left/right and top/bottom are unchanged</dd>
637<dt><kbd>x</kbd><var>value-y</var></dt>
638<dd>value-y is added only to top/bottom and left/right are unchanged</dd>
639<dt><var>value-x</var><kbd>x</kbd><var>value-y</var></dt>
640<dd>value-x is added to left/right and value-y added to top/bottom</dd>
641<dt><var>value-x</var><kbd>x</kbd>0</dt>
642<dd>value-x is added only to left/right and top/bottom are unchanged</dd>
643<dt>0<kbd>x</kbd><var>value-y</var></dt>
644<dd>value-y is added only to top/bottom and left/right are unchanged</dd>
645<dt><var>value</var>%</dt>
646<dd>value % of width is added to left/right and value % of height is added to top/bottom</dd>
647<dt><var>value-x</var><kbd>x</kbd>%</dt>
648<dd>value-x % of width is added to left/right and to top/bottom</dd>
649<dt>x<var>value-y</var>%</dt>
650<dd>value-y % of height is added to top/bottom and to left/right</dd>
651<dt><var>value-x</var>%<kbd>x</kbd><var>value-y</var>%</dt>
652<dd>value-x % of width is added to left/right and value-y % of height is added to top/bottom</dd>
653<dt><var>value-x</var>%<kbd>x</kbd>0%</dt>
654<dd>value-x % of width is added to left/right and top/bottom are unchanged</dd>
655<dt>0%<kbd>x</kbd><var>value-y</var>%</dt>
656<dd>value-y % of height is added to top/bottom and left/right are unchanged</dd>
657</dl>
658
Cristy594d2772015-11-15 10:47:42 -0500659<p>Set the border color by preceding with the <a
660href="command-line-options.html#bordercolor">-bordercolor</a> setting.</p>
Cristy882d9f42015-10-29 16:48:39 -0400661
Cristy594d2772015-11-15 10:47:42 -0500662<p>The <a href="command-line-options.html#border">-border</a> operation is affected by the current <a
663href="command-line-options.html#compose">-compose</a> setting and assumes that this is using the default
Cristy882d9f42015-10-29 16:48:39 -0400664'<code>Over</code>' composition method. It generates an image of the appropriate
665size colors by the current <a href="command-line-options.html#bordercolor">-bordercolor</a> before
666overlaying the original image in the center of this net image. This means that
667with the default compose method of '<code>Over</code>' any transparent parts may
668be replaced by the current <a href="command-line-options.html#bordercolor">-bordercolor</a> setting.</p>
669<p>See also the <a href="command-line-options.html#frame">-frame</a> option, which has more
670functionality.</p>
671
672<div style="margin: auto;">
673 <h3 class="magick-header"><a id="bordercolor"></a>-bordercolor <var>color</var></h3>
674</div>
675
676<p class="magick-description">Set the border color.</p>
677
678<p>The color is specified using the format described under the <a href="command-line-options.html#fill">-fill</a> option.</p>
679
680<p>The default border color is <code>#DFDFDF</code>, <span style="background-color: #dfdfdf;">this shade of gray</span>.</p>
681
682<div style="margin: auto;">
683 <h3 class="magick-header"><a id="borderwidth"></a>-borderwidth <var>geometry</var> </h3>
684</div>
685
686<p class="magick-description">Set the border width.</p>
687
688<div style="margin: auto;">
Cristy769d8892016-01-19 18:11:14 -0500689 <h3 class="magick-header"><a id="brightness-contrast"></a>-brightness-contrast <var>brightness</var><br />-brightness-contrast <var>brightness</var>{x<var>contrast</var>}{<var>%</var>}</h3>
Cristy882d9f42015-10-29 16:48:39 -0400690</div>
691
692<p class="magick-description">Adjust the brightness and/or contrast of the image.</p>
693
694<p>Brightness and Contrast values apply changes to the input image. They are
695not absolute settings. A brightness or contrast value of zero means no change.
696The range of values is -100 to +100 on each. Positive values increase the
697brightness or contrast and negative values decrease the brightness or contrast.
698To control only contrast, set the brightness=0. To control only brightness,
699set contrast=0 or just leave it off.</p>
700
701<p>You may also use <a href="command-line-options.html#fill">-channel</a> to control which channels to
702apply the brightness and/or contrast change. The default is to apply the same
703transformation to all channels.</p>
704
705<p>Brightness and Contrast arguments are converted to offset and slope of a
706linear transform and applied
707using <a href="command-line-options.html#fill">-function polynomial "slope,offset"</a>.</p>
708
709<p>The slope varies from 0 at contrast=-100 to almost vertical at
710contrast=+100. For brightness=0 and contrast=-100, the result are totally
711midgray. For brightness=0 and contrast=+100, the result will approach but
712not quite reach a threshold at midgray; that is the linear transformation
713is a very steep vertical line at mid gray.</p>
714
715<p>Negative slopes, i.e. negating the image, are not possible with this
716function. All achievable slopes are zero or positive.</p>
717
718<p>The offset varies from -0.5 at brightness=-100 to 0 at brightness=0 to +0.5
719at brightness=+100. Thus, when contrast=0 and brightness=100, the result is
720totally white. Similarly, when contrast=0 and brightness=-100, the result is
721totally black.</p>
722
723<p>As the range of values for the arguments are -100 to +100, adding the '%'
724symbol is no different than leaving it off.</p>
725
726<div style="margin: auto;">
727 <h3 class="magick-header"><a id="cache"></a>-cache <var>threshold</var></h3>
728</div>
729
Cristy594d2772015-11-15 10:47:42 -0500730<p class="magick-description">(This option has been replaced by the <a href='command-line-options.html#limit'>-limit</a> option).</p>
Cristy882d9f42015-10-29 16:48:39 -0400731
732<div style="margin: auto;">
Cristy594d2772015-11-15 10:47:42 -0500733 <h3 class="magick-header"><a id="canny"></a>-canny <var>radius</var><br/>-canny <var>radius</var>x<var>sigma</var>{<var>+lower-percent</var>}{<var>+upper-percent</var>}</h3>
Cristy882d9f42015-10-29 16:48:39 -0400734</div>
735
736<p class="magick-description">Canny edge detector uses a multi-stage algorithm to detect a wide range of edges in the image.</p>
737
738<p>The thresholds range from 0 to 100% (e.g. -canny 0x1+10%+30%) with {<var>+lower-percent</var>} &lt; {<var>+upper-percent</var>}. If {<var>+upper-percent</var>} is increased but {<var>+lower-percent</var>} remains the same, lesser edge components will be detected, but their lengths will be the same. If {<var>+lower-percent</var>} is increased but {<var>+upper-percent</var>} is the same, the same number of edge components will be detected but their lengths will be shorter. The default thresholds are shown. The <var>radius</var>x<var>sigma</var> controls a gaussian blur applied to the input image to reduce noise and smooth the edges.</p>
739
740<div style="margin: auto;">
741 <h3 class="magick-header"><a id="caption"></a>-caption <var>string</var></h3>
742</div>
743
744<p class="magick-description">Assign a caption to an image.</p>
745
746<p>This option sets the caption meta-data of an image read in after this
747option has been given. To modify a caption of images already in memory use
748"<code><a href="command-line-options.html#set">-set</a> caption</code>". </p>
749
Cristy594d2772015-11-15 10:47:42 -0500750<p>The caption can contain special format characters listed in the <a
751href="escape.html">Format and
Cristy882d9f42015-10-29 16:48:39 -0400752Print Image Properties</a>. These attributes are expanded when the caption
753is finally assigned to the individual images. </p>
754
755<p>If the first character of <var>string</var> is <var>@</var>, the image caption is read from a file titled by the
756remaining characters in the string. Comments read in from a file are literal;
757no embedded formatting characters are recognized.</p>
758
759<p>Caption meta-data is not visible on the image itself. To do that use the
760<a href="command-line-options.html#annotate">-annotate</a> or <a href="command-line-options.html#draw">-draw</a> options
761instead.</p>
762
763<p>For example,</p>
764
765<pre>
766-caption "%m:%f %wx%h" bird.miff
767</pre>
768
769<p>produces an image caption of <code>MIFF:bird.miff 512x480</code> (assuming
770that the image <code>bird.miff</code> has a width of 512 and a height of
771480.</p>
772
773
774<div style="margin: auto;">
775 <h3 class="magick-header"><a id="cdl"></a>-cdl <var>filename</var></h3>
776</div>
777
778<p class="magick-description">color correct with a color decision list.</p>
779
780<p>Here is an example color correction collection:</p>
781
782<pre>
783&lt;?xml version="1.0" encoding="UTF-8"?&gt;
784&lt;ColorCorrectionCollection xmlns="urn:ASC:CDL:v1.2"&gt;
785 &lt;ColorCorrection id="cc06668"&gt;
786 &lt;SOPNode&gt;
787 &lt;Slope&gt; 0.9 1.2 0.5 &lt;/Slope&gt;
788 &lt;Offset&gt; 0.4 -0.5 0.6 &lt;/Offset&gt;
789 &lt;Power&gt; 1.0 0.8 1.5 &lt;/Power&gt;
790 &lt;/SOPNode&gt;
791 &lt;SATNode&gt;
792 &lt;Saturation&gt; 0.85 &lt;/Saturation&gt;
793 &lt;/SATNode&gt;
794 &lt;/ColorCorrection&gt;
795&lt;/ColorCorrectionCollection&gt;
796</pre>
797
798<div style="margin: auto;">
799 <h3 class="magick-header"><a id="channel"></a>-channel <var>type</var></h3>
800</div>
801
802<p class="magick-description">Specify those image color channels to which subsequent operators are limited.</p>
803
804<p>Choose from: <code>Red</code>, <code>Green</code>, <code>Blue</code>,
805<code>Alpha</code>, <code>Gray</code>, <code>Cyan</code>, <code>Magenta</code>,
806<code>Yellow</code>, <code>Black</code>, <code>Opacity</code>,
807<code>Index</code>, <code>RGB</code>, <code>RGBA</code>, <code>CMYK</code>, or
808<code>CMYKA</code>.</p>
809
810<p>The channels above can also be specified as a comma-separated list or can be
811abbreviated as a concatenation of the letters '<code>R</code>', '<code>G</code>',
812'<code>B</code>', '<code>A</code>', '<code>O</code>', '<code>C</code>',
813'<code>M</code>', '<code>Y</code>', '<code>K</code>'.
814
815For example, to only select the <code>Red</code> and <code>Blue</code> channels
816you can either use </p>
817<pre>
818-channel Red,Blue
819</pre>
820<p>or you can use the short hand form</p>
821<pre>
822-channel RB
823</pre>
824
825<p>All the channels that are present in an image can be specified using the
826special channel type <code>All</code>. Not all operators are 'channel capable',
827but generally any operators that are generally 'grey-scale' image operators,
828will understand this setting. See individual operator documentation. </p>
829
Cristy594d2772015-11-15 10:47:42 -0500830<br/>
Cristy882d9f42015-10-29 16:48:39 -0400831
832<p>On top of the normal channel selection an extra flag can be specified,
833'<code>Sync</code>'. This is turned on by default and if set means that
834operators that understand this flag should perform: cross-channel
835synchronization of the channels. If not specified, then most grey-scale
836operators will apply their image processing operations to each individual
837channel (as specified by the rest of the <a href="command-line-options.html#channel">-channel</a>
838setting) completely independently from each other. </p>
839
840<p>For example for operators such as <a href="command-line-options.html#auto-level">-auto-level</a> and
841<a href="command-line-options.html#auto-gamma">-auto-gamma</a> the color channels are modified
842together in exactly the same way so that colors will remain in-sync. Without
843it being set, then each channel is modified separately and
844independently, which may produce color distortion. </p>
845
846<p>The <a href="command-line-options.html#morphology">-morphology</a> '<code>Convolve</code>' method
847and the <a href="command-line-options.html#compose">-compose</a> mathematical methods, also understands
848the '<code>Sync</code>' flag to modify the behavior of pixel colors according
849to the alpha channel (if present). That is to say it will modify the image
850processing with the understanding that fully-transparent colors should not
851contribute to the final result. </p>
852
853<p>Basically, by default, operators work with color channels in synchronous, and
854treats transparency as special, unless the <a href="command-line-options.html#channel">-channel</a>
855setting is modified so as to remove the effect of the '<code>Sync</code>' flag.
856How each operator does this depends on that operators current implementation.
857Not all operators understands this flag at this time, but that is changing.
858</p>
859
860<p>To print a complete list of channel types, use <a href="command-line-options.html#list">-list
861channel</a>.</p>
862
863<p>By default, ImageMagick sets <a href="command-line-options.html#channel">-channel</a> to the value
864'<code>RGBK,sync</code>', which specifies that operators act on all color
865channels except the transparency channel, and that all the color channels are
866to be modified in exactly the same way, with an understanding of transparency
Cristy594d2772015-11-15 10:47:42 -0500867(depending on the operation being applied). The 'plus' form <a
868href="command-line-options.html#channel" >+channel</a> will reset the value back to this default. </p>
Cristy882d9f42015-10-29 16:48:39 -0400869
Cristy594d2772015-11-15 10:47:42 -0500870<p>Options that are affected by the <a href="command-line-options.html#channel" >-channel</a> setting
Cristy882d9f42015-10-29 16:48:39 -0400871include the following.
872
873<a href="command-line-options.html#auto-gamma">-auto-gamma</a>,
874<a href="command-line-options.html#auto-level">-auto-level</a>,
875<a href="command-line-options.html#black-threshold">-black-threshold</a>,
876<a href="command-line-options.html#blur">-blur</a>,
877<a href="command-line-options.html#clamp">-clamp</a>,
878<a href="command-line-options.html#clut">-clut</a>,
879<a href="command-line-options.html#combine">-combine</a>,
880<a href="command-line-options.html#composite">-composite</a> (Mathematical compose methods only),
881<a href="command-line-options.html#convolve">-convolve</a>,
882<a href="command-line-options.html#contrast-stretch">-contrast-stretch</a>,
883<a href="command-line-options.html#evaluate">-evaluate</a>,
884<a href="command-line-options.html#function">-function</a>,
885<a href="command-line-options.html#fx">-fx</a>,
886<a href="command-line-options.html#gaussian-blur">-gaussian-blur</a>,
887<a href="command-line-options.html#hald-clut">-hald-clut</a>,
888<a href="command-line-options.html#motion-blur">-motion-blur</a>,
889<a href="command-line-options.html#morphology">-morphology</a>,
890<a href="command-line-options.html#negate">-negate</a>,
891<a href="command-line-options.html#normalize">-normalize</a>,
892<a href="command-line-options.html#ordered-dither">-ordered-dither</a>,
893<a href="command-line-options.html#radial-blur">-radial-blur</a>,
894<a href="command-line-options.html#random-threshold">-random-threshold</a>,
895<a href="command-line-options.html#separate">-separate</a>,
896<a href="command-line-options.html#threshold">-threshold</a>, and
897<a href="command-line-options.html#white-threshold">-white-threshold</a>.
898</p>
899
Cristy594d2772015-11-15 10:47:42 -0500900<p>Warning, some operators behave differently when the <a href="command-line-options.html#channel"
901>+channel</a> default setting is in effect, verses ANY user defined <a
902href="command-line-options.html#channel" >-channel</a> setting (including the equivalent of the
Cristy882d9f42015-10-29 16:48:39 -0400903default). These operators have yet to be made to understand the newer 'Sync'
904flag. </p>
905
Cristy769d8892016-01-19 18:11:14 -0500906<p>For example <a href="command-line-options.html#threshold">-threshold</a> will by default grayscale
Cristy594d2772015-11-15 10:47:42 -0500907the image before thresholding, if no <a href="command-line-options.html#channel" >-channel</a> setting
Cristy882d9f42015-10-29 16:48:39 -0400908has been defined. This is not 'Sync flag controlled, yet. </p>
909
Cristy594d2772015-11-15 10:47:42 -0500910<p>Also some operators such as <a href="command-line-options.html#blur">-blur</a>, <a
911href="command-line-options.html#gaussian-blur">-gaussian-blur</a>, will modify their handling of the
912color channels if the '<code>alpha</code>' channel is also enabled by <a
913href="command-line-options.html#channel" >-channel</a>. Generally this done to ensure that
Cristy882d9f42015-10-29 16:48:39 -0400914fully-transparent colors are treated as being fully-transparent, and thus any
915underlying 'hidden' color has no effect on the final results. Typically
916resulting in 'halo' effects. The newer <a href="command-line-options.html#morphology">-morphology</a>
917convolution equivalents however does have a understanding of the 'Sync' flag
918and will thus handle transparency correctly by default. </p>
919
920<p>As a alpha channel is optional within images, some operators will read the
921color channels of an image as a greyscale alpha mask, when the image has no
Cristy594d2772015-11-15 10:47:42 -0500922alpha channel present, and the <a href="command-line-options.html#channel" >-channel</a> setting tells
923the operator to apply the operation using alpha channels. The <a
924href="command-line-options.html#clut">-clut</a> operator is a good example of this. </p>
Cristy882d9f42015-10-29 16:48:39 -0400925
Cristyd474b372017-02-14 12:19:13 -0500926<div style="margin: auto;">
927 <h3 class="magick-header"><a id="channel-fx"></a>-channel-fx <var>expression</var></h3>
928</div>
Cristy882d9f42015-10-29 16:48:39 -0400929
Cristyd474b372017-02-14 12:19:13 -0500930<p class="magick-description">exchange, extract, or copy one or more image channels.</p>
931
932<p>The expression consists of one or more channels, either mnemonic or numeric (e.g. red or 0, green or 1, etc.), separated by certain operation symbols as follows:</p>
933
934<pre>
935&lt;=&gt; exchange two channels (e.g. red&lt;=&gt;blue)
936=&gt; copy one channel to another channel (e.g. red=&gt;green)
937= assign a constant value to a channel (e.g. red=50%)
938, write new image with channels in the specified order (e.g. red, green)
939; add a new output image for the next set of channel operations (e.g. red; green; blue)
940| move to the next input image for the source of channel data (e.g. | gray=>alpha)
941</pre>
942
943<p>For example, to create 3 grayscale images from the red, green, and blue channels of an image, use:</p>
944
945<pre>
946-channel-fx "red; green; blue"
947</pre>
948
949<p>A channel without an operation symbol implies separate (i.e, semicolon).</p>
950
951<p>Here we take an sRGB image and a grayscale image and inject the grayscale image into the alpha channel:</p>
952<pre>
953convert wizard.png mask.pgm -channel-fx '| gray=>alpha' wizard-alpha.png
954</pre>
955<p>Use a similar command to define a read mask:</p>
956<pre>
957convert wizard.png mask.pgm -channel-fx '| gray=>read-mask' wizard-mask.png
958</pre>
959
960<p>Add <code>-debug pixel</code> prior to the <code>-channel-fx</code> option to track the channel morphology.</p>
Cristy882d9f42015-10-29 16:48:39 -0400961
962<div style="margin: auto;">
963 <h3 class="magick-header"><a id="charcoal"></a>-charcoal <var>factor</var></h3>
964</div>
965
966<p class="magick-description">Simulate a charcoal drawing.</p>
967
Cristyd474b372017-02-14 12:19:13 -0500968
Cristy882d9f42015-10-29 16:48:39 -0400969<div style="margin: auto;">
970 <h3 class="magick-header"><a id="chop"></a>-chop <var>geometry</var></h3>
971</div>
972
973<p class="magick-description">Remove pixels from the interior of an image.</p>
974
975<p>See <a href="command-line-processing.html#geometry">Image Geometry</a> for complete details about the <em class="arg">geometry</em> argument. The <var>width</var>
976and <var>height</var> given in the of the <var>size</var>
977portion of the <var>geometry</var> argument give the number of
978columns and rows to remove. The <var>offset</var> portion of
979the <var>geometry</var> argument is influenced by
980a <a href="command-line-options.html#gravity">-gravity</a> setting, if present.</p>
981
982<p>The <a href="command-line-options.html#chop">-chop</a> option removes entire rows and columns,
983and moves the remaining corner blocks leftward and upward to close the gaps.</p>
984
985<p>While it can remove internal rows and columns of pixels, it is more
986typically used with as <a href="command-line-options.html#gravity">-gravity</a> setting and zero
Cristy594d2772015-11-15 10:47:42 -0500987offsets so as to remove a single edge from an image. Compare this to <a
988href="command-line-options.html#shave" >-shave</a> which removes equal numbers of pixels from opposite
Cristy882d9f42015-10-29 16:48:39 -0400989sides of the image. </p>
990
Cristy594d2772015-11-15 10:47:42 -0500991<p>Using <a href="command-line-options.html#chop">-chop</a> effectively undoes the results of a <a
992href="command-line-options.html#splice">-splice</a> that was given the same <var>geometry</var> and <a href="command-line-options.html#gravity">-gravity</a> settings. </p>
Cristy882d9f42015-10-29 16:48:39 -0400993
994<div style="margin: auto;">
995 <h3 class="magick-header"><a id="clamp"></a>-clamp</h3>
996</div>
997
998<p class="magick-description">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.</p>
999
1000<div style="margin: auto;">
1001 <h3 class="magick-header"><a id="clip"></a>-clip</h3>
1002</div>
1003
1004<p class="magick-description">Apply the clipping path if one is present.</p>
1005
1006<p>If a clipping path is present, it is applied to subsequent operations.</p>
1007
1008<p>For example, in the command</p>
1009
1010<pre>
1011convert cockatoo.tif -clip -negate negated.tif
1012</pre>
1013
1014<p>only the pixels within the clipping path are negated.</p>
1015
1016<p>The <a href="command-line-options.html#clip">-clip</a> feature requires SVG support. If the SVG
1017delegate library is not present, the option is ignored.</p>
1018
1019<p>Use <a href="command-line-options.html#clip">+clip</a> to disable clipping for subsequent operations.</p>
1020
1021<div style="margin: auto;">
1022 <h3 class="magick-header"><a id="clip-mask"></a>-clip-mask</h3>
1023</div>
1024
1025<p class="magick-description">Clip the image as defined by this mask.</p>
1026
1027<p>Use the alpha channel of the current image as a mask. Any areas that is
1028white is not modified by any of the 'image processing operators' that follow,
1029until the mask is removed. Pixels in the black areas of the clip mask are
1030modified per the requirements of the operator. </p>
1031
1032<p>In some ways this is similar to (though not the same) as defining
Cristy594d2772015-11-15 10:47:42 -05001033a rectangular <a href="command-line-options.html#region" >-region</a>, or using the negative of the
1034mask (third) image in a three image <a href="command-line-options.html#composite" >-composite</a>,
Cristy882d9f42015-10-29 16:48:39 -04001035operation. </p>
1036
1037<p>Use <a href="command-line-options.html#clip-mask">+clip-mask</a> to disable clipping for subsequent operations.</p>
1038
1039<div style="margin: auto;">
1040 <h3 class="magick-header"><a id="clip-path"></a>-clip-path <var>id</var></h3>
1041</div>
1042
1043<p class="magick-description">Clip along a named path from the 8BIM profile.</p>
1044
1045<p>This is identical to <a href="command-line-options.html#clip">-clip</a> except choose a specific clip path in the event the image has more than one path available. </p>
1046
1047<p>Use <a href="command-line-options.html#clip-path">+clip-path</a> to disable clipping for subsequent operations.</p>
1048
1049<div style="margin: auto;">
1050 <h3 class="magick-header"><a id="clone"></a>-clone <var>index(s)</var></h3>
1051</div>
1052
1053<p class="magick-description">make a clone of an image (or images).</p>
1054
1055<p>Inside parenthesis (where the operator is normally used) it will make a
1056clone of the images from the last 'pushed' image sequence, and adds them to
1057the end of the current image sequence. Outside parenthesis
1058(not recommended) it clones the images from the current image sequence. </p>
1059
1060<p>Specify the image by its index in the sequence. The first image is index
10610. Negative indexes are relative to the end of the sequence; for
1062example, <code>−1</code>
1063represents the last image of the sequence. Specify a range of images with a
1064dash (e.g. <code>0−4</code>). Separate multiple indexes with commas but no
1065spaces (e.g. <code>0,2,5</code>). A value of '<code>0−−1</code> will
1066effectively clone all the images. </p>
1067
1068<p>The <a href="command-line-options.html#clone">+clone</a> will simply make a copy of the last image
1069in the image sequence, and is thus equivalent to using a argument of
1070'<code>−1</code>'. </p>
1071
1072<div style="margin: auto;">
1073 <h3 class="magick-header"><a id="clut"></a>-clut</h3>
1074</div>
1075
1076<p class="magick-description">Replace the channel values in the first image using each corresponding channel in the second image as a <b>c</b>olor <b>l</b>ook<b>u</b>p <b>t</b>able.</p>
1077
1078<p>The second (LUT) image is ordinarily a gradient image containing the
1079histogram mapping of how each channel should be modified. Typically it is a
1080either a single row or column image of replacement color values. If larger
1081than a single row or column, values are taken from a diagonal line from
1082top-left to bottom-right corners.</p>
1083
Cristy594d2772015-11-15 10:47:42 -05001084<p>The lookup is further controlled by the <a
1085href="command-line-options.html#interpolate">-interpolate</a> setting, which is especially handy for an
Cristy882d9f42015-10-29 16:48:39 -04001086LUT which is not the full length needed by the ImageMagick installed Quality
1087(Q) level. Good settings for this are the '<code>bilinear</code>' and
1088'<code>bicubic</code>' interpolation settings, which give smooth color
1089gradients, and the '<code>integer</code>' setting for a direct, unsmoothed
1090lookup of color values. </p>
1091
1092<p>This operator is especially suited to replacing a grayscale image with a
1093specific color gradient from the CLUT image. </p>
1094
1095<p>Only the channel values defined by the <a href="command-line-options.html#channel">-channel</a>
Cristy594d2772015-11-15 10:47:42 -05001096setting will have their values replaced. In particular, since the default <a
1097href="command-line-options.html#channel">-channel</a> setting is <code>RGB</code>, this means that
1098transparency (alpha/matte channel) is not affected, unless the <a
1099href="command-line-options.html#channel">-channel</a> setting is modified. When the alpha channel is
1100set, it is treated by the <a href="command-line-options.html#clut" >-clut</a> operator in the same way
Cristy882d9f42015-10-29 16:48:39 -04001101as the other channels, implying that alpha/matte values are replaced using the
1102alpha/matte values of the original image. </p>
1103
1104<p>If either the image being modified, or the lookup image, contains no
Cristy594d2772015-11-15 10:47:42 -05001105transparency (i.e. <a href="command-line-options.html#alpha" >-alpha</a> is turned 'off') but the <a
1106href="command-line-options.html#channel">-channel</a> setting includes alpha replacement, then it is
Cristy769d8892016-01-19 18:11:14 -05001107assumed that image represents a grayscale gradient which is used for the
1108replacement alpha values. That is you can use a grayscale CLUT image to
1109adjust a existing images alpha channel, or you can color a grayscale image
Cristy882d9f42015-10-29 16:48:39 -04001110using colors form CLUT containing the desired colors, including transparency.
1111</p>
1112
Cristy594d2772015-11-15 10:47:42 -05001113<p>See also <a href="command-line-options.html#hald-clut" >-hald-clut</a> which replaces colors
Cristy882d9f42015-10-29 16:48:39 -04001114according to the lookup of the full color RGB value from a 2D representation
1115of a 3D color cube. </p>
1116
1117
1118<div style="margin: auto;">
1119 <h3 class="magick-header"><a id="coalesce"></a>-coalesce</h3>
1120</div>
1121
1122<p class="magick-description">Fully define the look of each frame of an GIF animation sequence, to form a 'film strip' animation.</p>
1123
1124<p>Overlay each image in an image sequence according to
1125its <a href="command-line-options.html#dispose">-dispose</a> meta-data, to reproduce the look of
1126an animation at each point in the animation sequence. All images should be
1127the same size, and are assigned appropriate GIF disposal settings for the
1128animation to continue working as expected as a GIF animation. Such frames
1129are more easily viewed and processed than the highly optimized GIF overlay
1130images. </p>
1131
1132<p>The animation can be re-optimized after processing using
1133the <a href="command-line-options.html#layers">-layers</a> method '<code>optimize</code>', although
1134there is no guarantee that the restored GIF animation optimization is
1135better than the original. </p>
1136
1137
1138<div style="margin: auto;">
1139 <h3 class="magick-header"><a id="colorize"></a>-colorize <var>value</var></h3>
1140</div>
1141
Cristy594d2772015-11-15 10:47:42 -05001142<p class="magick-description">Colorize the image by an amount specified by <var>value</var> using the color specified by the most recent <a href="command-line-options.html#fill" >-fill</a> setting.</p>
Cristy882d9f42015-10-29 16:48:39 -04001143
1144<p>Specify the amount of colorization as a percentage. Separate colorization
1145values can be applied to the red, green, and blue channels of the image with
1146a comma-delimited list of colorization
1147values (e.g., <code>-colorize 0,0,50</code>).</p>
1148
1149<div style="margin: auto;">
1150 <h3 class="magick-header"><a id="colormap"></a>-colormap <var>type</var></h3>
1151</div>
1152
1153<p class="magick-description">Define the colormap type.</p>
1154
1155<p>The <var>type</var> can be <code>shared</code> or <code>private</code>.</p>
1156
1157<p>This option only applies when the default X server visual
1158is <code>PseudoColor</code> or <code>GrayScale</code>. Refer
1159to <a href="command-line-options.html#visual">-visual</a> for more details. By default,
1160a shared colormap is allocated. The image shares colors with
1161other X clients. Some image colors could be approximated,
1162therefore your image may look very different than intended.
1163If <code>private</code> is chosen, the image colors appear exactly
1164as they are defined. However, other clients may go <var>technicolor</var>
1165when the image colormap is installed.</p>
1166
1167<div style="margin: auto;">
1168 <h3 class="magick-header"><a id="colors"></a>-colors <var>value</var></h3>
1169</div>
1170
1171<p class="magick-description">Set the preferred number of colors in the image.</p>
1172
1173<p>The actual number of colors in the image may be less than your request,
1174but never more. Note that this a color reduction option. Images with fewer
1175unique colors than specified by <var>value</var> will have any
1176duplicate or unused colors removed. The ordering of an existing color
1177palette may be altered. When converting an image from color to grayscale,
1178it is more efficient to convert the image to the gray colorspace before
1179reducing the number of colors. Refer to
Cristy6549abb2016-11-10 08:25:55 -05001180the <a href="http://www.imagemagick.org/www/quantize.html">
Cristy882d9f42015-10-29 16:48:39 -04001181color reduction algorithm</a> for more details.</p>
1182
1183<div style="margin: auto;">
1184 <h3 class="magick-header"><a id="color-matrix"></a>-color-matrix <var>matrix</var></h3>
1185</div>
1186
1187<p class="magick-description">apply color correction to the image.</p>
1188
1189<p>This option permits saturation changes, hue rotation, luminance to alpha,
1190and various other effects. Although variable-sized transformation matrices
1191can be used, typically one uses a 5x5 matrix for an RGBA image and a 6x6
1192for CMYKA (or RGBA with offsets). The matrix is similar to those used by
1193Adobe Flash except offsets are in column 6 rather than 5 (in support of
1194CMYKA images) and offsets are normalized (divide Flash offset by 255).</p>
1195
1196<p>As an example, to add contrast to an image with offsets, try this command:</p>
1197
1198<pre>
1199convert kittens.jpg -color-matrix \
1200 " 1.5 0.0 0.0 0.0, 0.0, -0.157 \
1201 0.0 1.5 0.0 0.0, 0.0, -0.157 \
1202 0.0 0.0 1.5 0.0, 0.0, -0.157 \
1203 0.0 0.0 0.0 1.0, 0.0, 0.0 \
1204 0.0 0.0 0.0 0.0, 1.0, 0.0 \
1205 0.0 0.0 0.0 0.0, 0.0, 1.0" kittens.png
1206</pre>
1207<div style="margin: auto;">
1208 <h3 class="magick-header"><a id="colorspace"></a>-colorspace <var>value</var></h3>
1209</div>
1210
1211<p class="magick-description">Set the image colorspace.</p>
1212
1213<p>Choices are:</p>
1214
1215<pre>
1216CMY CMYK Gray HCL
1217HCLp HSB HSI HSL
1218HSV HWB Lab LCHab
1219LCHuv LMS Log Luv
1220OHTA Rec601YCbCr Rec709YCbCr RGB
1221scRGB sRGB Transparent xyY
1222XYZ YCbCr YCC YDbDr
Cristyd474b372017-02-14 12:19:13 -05001223YIQ YPbPr YUV Undefined
Cristy882d9f42015-10-29 16:48:39 -04001224</pre>
1225
1226<p>To print a complete list of colorspaces, use <a href="command-line-options.html#list">-list colorspace</a>.</p>
1227
1228<p>For a more accurate color conversion to or from the linear RGB, CMYK, or grayscale colorspaces, use the <a href="command-line-options.html#profile">-profile</a> option. Note, ImageMagick assumes the sRGB colorspace if the image format does not indicate otherwise. For colorspace conversion, the gamma function is first removed to produce linear RGB.</p>
1229
1230<table class="table table-condensed table-striped">
1231 <caption>Conversion of RGB to Other Color Spaces</caption>
1232 <tr><th valign="middle">CMY</th></tr>
1233 <tr><td valign="middle">C=<var>QuantumRange</var>−R</td></tr>
1234 <tr><td valign="middle">M=<var>QuantumRange</var>−G</td></tr>
1235 <tr><td valign="middle">Y=<var>QuantumRange</var>−B</td></tr>
1236 <tr><th valign="middle">CMYK — starts with CMY from above</th></tr>
1237 <tr><td valign="middle">K=min(C,Y,M)</td></tr>
1238 <tr><td valign="middle">C=<var>QuantumRange</var>*(C−K)/(<var>QuantumRange</var>−K)</td></tr>
1239 <tr><td valign="middle">M=<var>QuantumRange</var>*(M−K)/(<var>QuantumRange</var>−K)</td></tr>
1240 <tr><td valign="middle">Y=<var>QuantumRange</var>*(Y−K)/(<var>QuantumRange</var>−K)</td></tr>
1241
1242 <tr><th valign="middle">Gray</th></tr>
1243 <tr><td valign="middle">Gray = 0.298839*R+0.586811*G+0.114350*B</td></tr>
1244
1245 <tr><th valign="middle">HSB — Hue, Saturation, Brightness; like a cone peak downward</th></tr>
1246 <tr><td valign="middle">H=angle around perimeter (0 to 360 deg); H=0 is red; increasing angles toward green</td></tr>
1247 <tr><td valign="middle">S=distance from axis outward</td></tr>
1248 <tr><td valign="middle">B=distance along axis from bottom upward; B=max(R,G,B); <var>intensity-like</var></td></tr>
1249
1250 <tr><th valign="middle">HSL — Hue, Saturation, Lightness; like a double cone end-to-end with peaks at very top and bottom</th></tr>
1251 <tr><td valign="middle">H=angle around perimeter (0 to 360 deg); H=0 is red; increasing angles toward green</td></tr>
1252 <tr><td valign="middle">S=distance from axis outward</td></tr>
1253 <tr><td valign="middle">L=distance along axis from bottom upward; L=0.5*max(R,G,B) + 0.5*min(R,G,B); <var>intensity-like</var></td></tr>
1254
1255 <tr><th valign="middle">HWB — Hue, Whiteness, Blackness</th></tr>
1256 <tr><td valign="middle">Hue (complicated equation)</td></tr>
1257 <tr><td valign="middle">Whiteness (complicated equation)</td></tr>
1258 <tr><td valign="middle">Blackness (complicated equation)</td></tr>
1259
1260 <tr><th valign="middle">LAB</th></tr>
1261 <tr><td valign="middle">L (complicated equation relating X,Y,Z)</td></tr>
1262 <tr><td valign="middle">A (complicated equation relating X,Y,Z)</td></tr>
1263 <tr><td valign="middle">B (complicated equation relating X,Y,Z)</td></tr>
1264
1265 <tr><th valign="middle">LOG</th></tr>
1266 <tr><td valign="middle">I1 (complicated equation involving logarithm of R)</td></tr>
1267 <tr><td valign="middle">I2 (complicated equation involving logarithm of G)</td></tr>
1268 <tr><td valign="middle">I3 (complicated equation involving logarithm of B)</td></tr>
1269
1270 <tr><th valign="middle">OHTA — approximates principal components transformation</th></tr>
1271 <tr><td valign="middle">I1=0.33333*R+0.33334*G+0.33333*B; <var>intensity-like</var></td></tr>
1272 <tr><td valign="middle">I2=(0.50000*R+0.00000*G−0.50000*B)*(<var>QuantumRange</var>+1)/2</td></tr>
1273 <tr><td valign="middle">I3=(−0.25000*R+0.50000*G−0.25000*B)*(<var>QuantumRange</var>+1)/2</td></tr>
1274
1275 <tr><th valign="middle">Rec601Luma</th></tr>
1276 <tr><td valign="middle">Gray = 0.298839*R+0.586811*G+0.114350*B</td></tr>
1277
1278 <tr><th valign="middle">Rec601YCbCr</th></tr>
1279 <tr><td valign="middle">Y=0.2988390*R+0.5868110*G+0.1143500*B; <var>intensity-like</var></td></tr>
1280 <tr><td valign="middle">Cb=(−0.168736*R-0.331264*G+0.500000*B)*(<var>QuantumRange</var>+1)/2</td></tr>
1281 <tr><td valign="middle">Cr=(0.500000*R−0.418688*G−0.081312*B)*(<var>QuantumRange</var>+1)/2</td></tr>
1282
1283 <tr><th valign="middle">Rec709Luma</th></tr>
1284 <tr><td valign="middle">Gray=0.212656*R+0.715158*G+0.072186*B</td></tr>
1285
1286 <tr><th valign="middle">Rec709YCbCr</th></tr>
1287 <tr><td valign="middle">Y=0.212656*R+0.715158*G+0.072186*B; <var>intensity-like</var></td></tr>
1288 <tr><td valign="middle">Cb=(−0.114572*R−0.385428*G+0.500000*B)+(<var>QuantumRange</var>+1)/2</td></tr>
1289 <tr><td valign="middle">Cr=(0.500000*R−0.454153*G−0.045847*B)+(<var>QuantumRange</var>+1)/2</td></tr>
1290
1291 <tr><th valign="middle">sRGB</th></tr>
1292 <tr><td valign="middle">if R ≤ .0.0031308 then Rs=R/12.92 else Rs=1.055 R ^ (1.0 / 2.4) ? 0.055</td></tr>
1293 <tr><td valign="middle">if G ≤ .0.0031308 then Gs=B/12.92 else Gs=1.055 R ^ (1.0 / 2.4) ? 0.055</td></tr>
1294 <tr><td valign="middle">if B ≤ .0.0031308 then Bs=B/12.92 else Bs=1.055 R ^ (1.0 / 2.4) ? 0.055</td></tr>
1295
1296 <tr><th valign="middle">XYZ</th></tr>
1297 <tr><td valign="middle">X=0.4124564*R+0.3575761*G+0.1804375*B</td></tr>
1298 <tr><td valign="middle">Y=0.2126729*R+0.7151522*G+0.0721750*B</td></tr>
1299 <tr><td valign="middle">Z=0.0193339*R+0.1191920*G+0.9503041*B</td></tr>
1300
1301 <tr><th valign="middle">YCC</th></tr>
1302 <tr><td valign="middle">Y=(0.298839*R+0.586811*G+0.114350*B) (with complicated scaling); <var>intensity-like</var></td></tr>
1303 <tr><td valign="middle">C1=(−0.298839*R−0.586811*G+0.88600*B) (with complicated scaling)</td></tr>
1304 <tr><td valign="middle">C2=(0.70100*R−0.586811*G−0.114350*B) (with complicated scaling)</td></tr>
1305
1306 <tr><th valign="middle">YCbCr</th></tr>
1307 <tr><td valign="middle">Y=0.2988390*R+0.5868110*G+0.1143500*B; <var>intensity-like</var></td></tr>
1308 <tr><td valign="middle">Cb=(−0.168736*R−0.331264*G+0.500000*B)*(<var>QuantumRange</var>+1)/2</td></tr>
1309 <tr><td valign="middle">Cr=(0.500000*R−0.418688*G−0.081312*B)*(<var>QuantumRange</var>+1)/2</td></tr>
1310
1311 <tr><th valign="middle">YIQ</th></tr>
1312 <tr><td valign="middle">Y=0.298839*R+0.586811*G+0.114350*B; <var>intensity-like</var></td></tr>
1313 <tr><td valign="middle">I=(0.59600*R−0.27400*G−0.32200*B)*(<var>QuantumRange</var>+1)/2</td></tr>
1314 <tr><td valign="middle">Q=(0.21100*R−0.52300*G+0.31200*B)*(<var>QuantumRange</var>+1)/2</td></tr>
1315
1316 <tr><th valign="middle">YPbPr</th></tr>
1317 <tr><td valign="middle">Y=0.2988390*R+0.5868110*G+0.1143500*B; <var>intensity-like</var></td></tr>
1318 <tr><td valign="middle">Pb=(−0.168736*R−0.331264*G+0.500000*B)*(<var>QuantumRange</var>+1)/2</td></tr>
1319 <tr><td valign="middle">Pr=(0.500000*R−0.418688*G−0.081312*B)*(<var>QuantumRange</var>+1)/2</td></tr>
1320
1321 <tr><th valign="middle">YUV</th></tr>
1322 <tr><td valign="middle">Y=0.298839*R+0.586811*G+0.114350*B; <var>intensity-like</var></td></tr>
1323 <tr><td valign="middle">U=(−0.14740*R−0.28950*G+0.43690*B)*(<var>QuantumRange</var>+1)/2</td></tr>
1324 <tr><td valign="middle">V=(0.61500*R−0.51500*G−0.10000*B)*(<var>QuantumRange</var>+1)/2</td></tr>
1325</table>
1326
1327<p>Note the scRGB colorspace requires HDRI support otherwise it behaves just like linear RGB.</p>
1328
Cristyd474b372017-02-14 12:19:13 -05001329<p>Use the <code>Undefined</code> colorspace to identify multi-spectral images.</p>
1330
Cristy882d9f42015-10-29 16:48:39 -04001331<div style="margin: auto;">
1332 <h3 class="magick-header"><a id="combine"></a>-combine</h3>
1333</div>
1334
1335<p class="magick-description">Combine one or more images into a single image.</p>
1336
1337<p>The channels (previously set by <a href="command-line-options.html#channel">-channel</a>) of the
1338combined image are taken from the grayscale values of each image in the
1339sequence, in order. For the default -channel setting of <code>RGB</code>, this
1340means the first image is assigned to the <code>Red</code> channel, the second
1341to the <code>Green</code> channel, the third to the <code>Blue</code>.</p>
1342
Cristy594d2772015-11-15 10:47:42 -05001343<p>This option can be thought of as the inverse to <a
1344href="command-line-options.html#separate">-separate</a>, so long as the channel settings are the same.
Cristy882d9f42015-10-29 16:48:39 -04001345Thus, in the following example, the final image should be a copy of the
1346original. </p>
1347
1348<pre>
1349convert original.png -channel RGB -separate sepimage.png
1350convert sepimage-0.png sepimage-1.png sepimage-2.png -channel RGB \
1351 -combine imagecopy.png
1352</pre>
1353
1354<div style="margin: auto;">
1355 <h3 class="magick-header"><a id="comment"></a>-comment <var>string</var></h3>
1356</div>
1357
1358<p class="magick-description">Embed a comment in an image.</p>
1359
1360<p>This option sets the comment meta-data of an image read in after this
1361option has been given. To modify a comment of images already in memory use
1362"<code><a href="command-line-options.html#set">-set</a> comment</code>". </p>
1363
Cristy594d2772015-11-15 10:47:42 -05001364<p>The comment can contain special format characters listed in the <a
1365href="escape.html">Format and
Cristy882d9f42015-10-29 16:48:39 -04001366Print Image Properties</a>. These attributes are expanded when the comment
1367is finally assigned to the individual images. </p>
1368
1369<p>If the first character of <var>string</var> is <var>@</var>, the image comment is read from a file titled by the
1370remaining characters in the string. Comments read in from a file are literal;
1371no embedded formatting characters are recognized.</p>
1372
1373<p>Comment meta-data are not visible on the image itself. To do that use the
1374<a href="command-line-options.html#annotate">-annotate</a> or <a href="command-line-options.html#draw">-draw</a> options
1375instead.</p>
1376
1377<p>For example,</p>
1378
1379<pre>
1380-comment "%m:%f %wx%h" bird.miff
1381</pre>
1382
1383<p>produces an image comment of <code>MIFF:bird.miff 512x480</code> (assuming
1384that the image <code>bird.miff</code> has a width of 512 and a height of
1385480.</p>
1386
1387<div style="margin: auto;">
1388 <h3 class="magick-header"><a id="compare"></a>-compare</h3>
1389</div>
1390
1391<p class="magick-description">mathematically and visually annotate the difference between an image and its reconstruction</p>
1392
1393<p>This is a convert version of "<code>compare</code>" for two same sized images. The syntax is as follows, but other metrics are allowed.</p>
1394
1395<pre>
Cristy594d2772015-11-15 10:47:42 -05001396convert image.png reference.png -metric RMSE -compare \ <br/> difference.png
Cristy882d9f42015-10-29 16:48:39 -04001397</pre>
1398
1399<p>To get the metric value use the string format "%[distortion]".</p>
1400
1401<pre>
1402convert image.png reference.png -metric RMSE -compare -format \
1403 "%[distortion]" info:
1404</pre>
1405
1406<div style="margin: auto;">
1407 <h3 class="magick-header"><a id="complex"></a>-complex <var>operator</var></h3>
1408</div>
1409
1410<p class="magick-description">perform complex mathematics on an image sequence</p>
1411
1412Choose from these operators:
1413
1414<pre>
1415add
1416conjugate
1417divide
1418magnitude-phase
1419multiply
1420real-imaginary
1421subtract
1422</pre>
1423
1424<p>Optionally specify the <code>divide</code> operator SNR with <code><a href="command-line-options.html#define">-define</a> complex:snr=float</code>.</p>
1425
1426<div style="margin: auto;">
1427 <h3 class="magick-header"><a id="compose"></a>-compose <var>operator</var></h3>
1428</div>
1429
1430<p class="magick-description">Set the type of image composition.</p>
1431
Cristy6549abb2016-11-10 08:25:55 -05001432<p>See <a href="http://www.imagemagick.org/www/compose.html">Alpha Compositing</a> for
Cristy882d9f42015-10-29 16:48:39 -04001433a detailed discussion of alpha compositing.</p>
1434
1435<p>This setting effects image processing operators that merge two (or more)
1436images together in some way. This includes the operators,
1437<a href="command-line-options.html#composite">-compare</a>,
1438<a href="command-line-options.html#composite">-composite</a>,
1439<a href="command-line-options.html#layers">-layers</a> composite,
1440<a href="command-line-options.html#flatten">-flatten</a>,
1441<a href="command-line-options.html#mosaic">-mosaic</a>,
1442<a href="command-line-options.html#layers">-layers</a> merge,
1443<a href="command-line-options.html#border">-border</a>,
1444<a href="command-line-options.html#frame">-frame</a>,
1445and <a href="command-line-options.html#extent">-extent</a>. </p>
1446
1447<p>It is also one of the primary options for the "<code>composite</code>"
1448command. </p>
1449
1450
1451<div style="margin: auto;">
1452 <h3 class="magick-header"><a id="composite"></a>-composite</h3>
1453</div>
1454
1455<p class="magick-description">Perform alpha composition on two images and an optional mask</p>
1456
1457<p>Take the first image 'destination' and overlay the second 'source' image
1458according to the current <a href="command-line-options.html#compose">-compose</a> setting. The location
Cristy594d2772015-11-15 10:47:42 -05001459of the 'source' or 'overlay' image is controlled according to <a
Cristye93be682015-11-26 09:07:51 -05001460href="command-line-options.html#gravity" >-gravity</a>, and <a href="command-line-options.html#geometry" >-geometry</a>
Cristy882d9f42015-10-29 16:48:39 -04001461settings. </p>
1462
Cristy769d8892016-01-19 18:11:14 -05001463<p>If a third image is given this is treated as a grayscale blending 'mask' image
Cristy882d9f42015-10-29 16:48:39 -04001464relative to the first 'destination' image. This mask is blended with the
1465source image. However for the '<code>displace</code>' compose method, the
1466mask is used to provide a separate Y-displacement image instead. </p>
1467
1468<p>If a <a href="command-line-options.html#compose">-compose</a> method requires extra numerical
Cristy594d2772015-11-15 10:47:42 -05001469arguments or flags these can be provided by setting the <a
1470href="command-line-options.html#set">-set</a> '<code>option:compose:args</code>'
Cristy882d9f42015-10-29 16:48:39 -04001471appropriately for the compose method. </p>
1472
1473<p>Some <a href="command-line-options.html#compose">-compose</a> methods can modify the 'destination'
Cristy594d2772015-11-15 10:47:42 -05001474image outside the overlay area. You can disable this by setting the special <a
1475href="command-line-options.html#set">-set</a> '<code>option:compose:outside-overlay</code>'
Cristy882d9f42015-10-29 16:48:39 -04001476to '<code>false</code>'. </p>
1477
1478<p>The SVG compositing specification requires that color and opacity values range between zero and QuantumRange inclusive. You can permit values outside this range with this option: <a href="command-line-options.html#set">-set</a> '<code>option:compose:clamp=false</code></p>
1479
1480
1481<div style="margin: auto;">
1482 <h3 class="magick-header"><a id="compress"></a>-compress <var>type</var></h3>
1483</div>
1484
1485<p class="magick-description">Use pixel compression specified by <var>type</var> when writing the image.</p>
1486
Cristy594d2772015-11-15 10:47:42 -05001487<p>Choices are: <code>None</code>, <code>BZip</code>, <code
1488>Fax</code>, <code>Group4</code>, <code
1489>JPEG</code>, <code>JPEG2000</code>, <code
1490>Lossless</code>, <code>LZW</code>, <code
1491>RLE</code> or <code>Zip</code>.</p>
Cristy882d9f42015-10-29 16:48:39 -04001492
1493<p>To print a complete list of compression types, use <a href="command-line-options.html#list">-list
1494compress</a>.</p>
1495
1496<p>Specify <a href="command-line-options.html#compress">+compress</a> to store the binary image in an
1497uncompressed format. The default is the compression type of the specified
1498image file.</p>
1499
1500<p>If <code>LZW</code> compression is specified but LZW compression has not been
1501enabled, the image data is written in an uncompressed LZW format that can be
1502read by LZW decoders. This may result in larger-than-expected GIF files.</p>
1503
1504<p><code>Lossless</code> refers to lossless JPEG, which is only available if the
1505JPEG library has been patched to support it. Use of lossless JPEG is generally
1506not recommended.</p>
1507
1508<p>
1509When writing an ICO file, you may request that the images be encoded in
1510PNG format, by specifying <code>Zip</code> compression.</p>
1511
1512<p>
1513When writing a JNG file, specify <code>Zip</code> compression to request that
1514the alpha channel be encoded in PNG "IDAT" format, or <code>JPEG</code>
1515to request that it be encoded in JPG "JDAA" format.</p>
1516
1517<p>Use the <a href="command-line-options.html#quality">-quality</a> option to set the compression level
1518to be used by JPEG, PNG, MIFF, and MPEG encoders.
1519Use the <a href="command-line-options.html#sampling-factor">-sampling-factor</a> option to set the
1520sampling factor to be used by JPEG, MPEG, and YUV encoders for down-sampling
1521the chroma channels.</p>
1522
1523<div style="margin: auto;">
1524 <h3 class="magick-header"><a id="connected-components"></a>-connected-components <var>connectivity</var></h3>
1525</div>
1526
Cristyce4a3552015-12-14 13:53:35 -05001527<p class="magick-description"><a href="connected-components.html">connected-components</a> labeling detects connected regions in an image, choose from 4 or 8 way connectivity.</p>
Cristy882d9f42015-10-29 16:48:39 -04001528
Cristy594d2772015-11-15 10:47:42 -05001529<p>Use <code><a href="command-line-options.html#define" >-define</a> connected-components:verbose=true</code> to output statistics associated with each unique label.</p>
Cristy882d9f42015-10-29 16:48:39 -04001530
1531<div style="margin: auto;">
1532 <h3 class="magick-header"><a id="contrast"></a>-contrast</h3>
1533</div>
1534
1535<p class="magick-description">Enhance or reduce the image contrast.</p>
1536
1537<p>This option enhances the intensity differences between the lighter and
1538darker elements of the image. Use <a href="command-line-options.html#contrast">-contrast</a> to enhance
1539the image or <a href="command-line-options.html#contrast">+contrast</a> to reduce the image
1540contrast.</p>
1541
1542<p>For a more pronounced effect you can repeat the option:</p>
1543
1544<pre>
1545convert rose: -contrast -contrast rose_c2.png
1546</pre>
1547
1548<div style="margin: auto;">
Cristy769d8892016-01-19 18:11:14 -05001549 <h3 class="magick-header"><a id="contrast-stretch"></a>-contrast-stretch <var>black-point</var><br />-contrast-stretch <var>black-point</var>{x<var>white-point</var>}{<var>%</var>}</h3>
Cristy882d9f42015-10-29 16:48:39 -04001550</div>
1551
1552<p class="magick-description">Increase the contrast in an image by <var>stretching</var> the range of intensity values.</p>
1553
1554<p>While performing the stretch, black-out at most <var>black-point</var> pixels and white-out at most <var>white-point</var> pixels. Or, if percent is used, black-out at most
Cristy594d2772015-11-15 10:47:42 -05001555<var >black-point %</var> pixels and white-out at most <var>white-point %</var> pixels.</p>
Cristy882d9f42015-10-29 16:48:39 -04001556
Cristy594d2772015-11-15 10:47:42 -05001557<p>Prior to ImageMagick 6.4.7-0, <a href="command-line-options.html#contrast-stretch"
1558>-contrast-stretch</a> will black-out at most <var>black-point</var> pixels and white-out at most <var >total pixels
Cristy882d9f42015-10-29 16:48:39 -04001559minus white-point</var> pixels. Or, if percent is used, black-out at most <var>black-point %</var> pixels and white-out at most <var>100% minus white-point %</var> pixels.</p>
1560
1561<p>Note that <code>-contrast-stretch 0</code> will modify the image such that
1562the image's min and max values are stretched to 0 and <var>QuantumRange</var>, respectively, without any loss of data due to burn-out or
Cristy594d2772015-11-15 10:47:42 -05001563clipping at either end. This is not the same as <a href="command-line-options.html#normalize"
1564>-normalize</a>, which is equivalent to <code>-contrast-stretch 0.15x0.05%</code> (or
Cristy882d9f42015-10-29 16:48:39 -04001565prior to ImageMagick 6.4.7-0, <code>-contrast-stretch 2%x99%</code>).</p>
1566
1567<p>Internally operator works by creating a histogram bin, and then uses that
1568bin to modify the image. As such some colors may be merged together when they
1569originally fell into the same 'bin'. </p>
1570
Cristy769d8892016-01-19 18:11:14 -05001571<p>All the channels are normalized in concert by the same amount so as to
Cristy594d2772015-11-15 10:47:42 -05001572preserve color integrity, when the default <a href="command-line-options.html#channel" >+channel</a>
1573setting is in use. Specifying any other <a href="command-line-options.html#channel" >-channel</a>
Cristy882d9f42015-10-29 16:48:39 -04001574setting will normalize the RGB channels independently.</p>
1575
Cristy594d2772015-11-15 10:47:42 -05001576<p>See also <a href="command-line-options.html#auto-level" >-auto-level</a> for a 'perfect'
Cristy882d9f42015-10-29 16:48:39 -04001577normalization of mathematical images. </p>
1578
1579<p>This operator is under review for re-development. </p>
1580
1581
1582<div style="margin: auto;">
1583 <h3 class="magick-header"><a id="convolve"></a>-convolve <var>kernel</var></h3>
1584</div>
1585
1586<p class="magick-description">Convolve an image with a user-supplied convolution kernel.</p>
1587
1588<p>The <var>kernel</var> is a matrix specified as
1589a comma-separated list of integers (with no spaces), ordered left-to right,
1590starting with the top row. Presently, only odd-dimensioned kernels are
1591supported, and therefore the number of entries in the specified <var>kernel</var> must be 3<sup>2</sup>=9, 5<sup>2</sup>=25,
15927<sup>2</sup>=49, etc. </p>
1593
Cristy594d2772015-11-15 10:47:42 -05001594<p>Note that the <a href="command-line-options.html#convolve">&#x2011;convolve</a> operator supports the <a href="command-line-options.html#bias">&#x2011;bias</a> setting. This option shifts the convolution so that
Cristy882d9f42015-10-29 16:48:39 -04001595positive and negative results are relative to a user-specified bias value.
1596This is important for non-HDRI compilations of ImageMagick when dealing with
1597convolutions that contain negative as well as positive values. This is
1598especially the case with convolutions involving high pass filters or edge
1599detection. Without an output bias, the negative values is clipped at zero.
1600</p>
1601
Cristy594d2772015-11-15 10:47:42 -05001602<p>When using an ImageMagick with the HDRI compile-time setting, <a href="command-line-options.html#bias">&#x2011;bias</a> is not needed, as ImageMagick is able to store/handle any
Cristy882d9f42015-10-29 16:48:39 -04001603negative results without clipping to the color value range (0..QuantumRange).
Cristy594d2772015-11-15 10:47:42 -05001604See the discussion on HDRI implementations of ImageMagick on the page <a
1605href="high-dynamic-range.html">High
1606Dynamic-Range Images</a>. For more about HDRI go the ImageMagick <a
Cristy364a72f2016-11-04 22:38:41 -04001607href="https://www.imagemagick.org/Usage/basics/#hdri">Usage</a> pages or this
Cristy882d9f42015-10-29 16:48:39 -04001608<a href="http://en.wikipedia.org/wiki/High_dynamic_range_imaging">Wikipedia</a>
1609entry. </p>
1610
1611
1612<div style="margin: auto;">
1613 <h3 class="magick-header"><a id="copy"></a>-copy <var>geometry</var> <var>offset</var></h3>
1614</div>
1615
1616<p class="magick-description">copy pixels from one area of an image to another.</p>
1617
1618<div style="margin: auto;">
1619 <h3 class="magick-header"><a id="crop"></a>-crop <var>geometry</var>{<var>@</var>}{<var>!</var>}</h3>
1620</div>
1621
1622<p class="magick-description">Cut out one or more rectangular regions of the image.</p>
1623
1624<p>See <a href="command-line-processing.html#geometry">Image Geometry</a> for complete details about the <em class="arg">geometry</em> argument.</p>
1625
1626<p>The <var>width</var> and <var>height</var> of the <var>geometry</var> argument give the size of the image that remains
1627after cropping, and <var>x</var> and <var>y</var> in the
1628<var>offset</var> (if present) gives the location of the top left
1629corner of the cropped image with respect to the original image. To specify the
1630amount to be removed, use <a href="command-line-options.html#shave">-shave</a> instead.</p>
1631
1632<p>If the <var>x</var> and <var>y</var> offsets are
1633present, a single image is generated, consisting of the pixels from the
1634cropping region. The offsets specify the location of the upper left corner of
1635the cropping region measured downward and rightward with respect to the upper
1636left corner of the image. If the <a href="command-line-options.html#gravity">-gravity</a> option is
1637present with <code>NorthEast</code>, <code>East</code>, or <code>SouthEast</code>
1638gravity, it gives the distance leftward from the right edge of the image to
Cristy594d2772015-11-15 10:47:42 -05001639the right edge of the cropping region. Similarly, if the <a
1640href="command-line-options.html#gravity">-gravity</a> option is present with <code>SouthWest</code>,
Cristy882d9f42015-10-29 16:48:39 -04001641<code>South</code>, or <code>SouthEast</code> gravity, the distance is measured
1642upward between the bottom edges.</p>
1643
1644<p>If the <var>x</var> and <var>y</var> offsets are
1645omitted, a set of tiles of the specified geometry, covering the entire input
1646image, is generated. The rightmost tiles and the bottom tiles are smaller if
1647the specified geometry extends beyond the dimensions of the input image.</p>
1648
1649<p>You can add the <var>@</var> to the geometry argument to equally divide the image into the number of tiles generated.</p>
1650
1651<p>By adding a exclamation character flag to the geometry argument, the
1652cropped images virtual canvas page size and offset is set as if the
1653geometry argument was a viewport or window. This means the canvas page size
1654is set to exactly the same size you specified, the image offset set
1655relative top left corner of the region cropped. </p>
1656
1657<p>If the cropped image 'missed' the actual image on its virtual canvas, a
1658special single pixel transparent 'missed' image is returned, and a 'crop
1659missed' warning given. </p>
1660
Cristy594d2772015-11-15 10:47:42 -05001661<p>It might be necessary to <a href="command-line-options.html#repage" >+repage</a> the image prior to
Cristy882d9f42015-10-29 16:48:39 -04001662cropping the image to ensure the crop coordinate frame is relocated to the
1663upper-left corner of the visible image.
1664
Cristy594d2772015-11-15 10:47:42 -05001665Similarly you may want to use <a href="command-line-options.html#repage" >+repage</a> after cropping to
Cristy882d9f42015-10-29 16:48:39 -04001666remove the page offset that will be left behind. This is especially true when
1667you are going to write to an image format such as PNG that supports an image
1668offset.</p>
1669
1670<div style="margin: auto;">
1671 <h3 class="magick-header"><a id="cycle"></a>-cycle <var>amount</var></h3>
1672</div>
1673
1674<p class="magick-description">displace image colormap by amount.</p>
1675
1676<p><var>Amount</var> defines the number of positions each
1677colormap entry is shifted.</p>
1678
1679
1680<div style="margin: auto;">
1681 <h3 class="magick-header"><a id="debug"></a>-debug <var>events</var></h3>
1682</div>
1683
1684<p class="magick-description">enable debug printout.</p>
1685
1686<p>The <code>events</code> parameter specifies which events are to be logged. It
1687can be either <code>None</code>, <code>All</code>, <code>Trace</code>, or
1688a comma-separated list consisting of one or more of the following domains:
1689<code>Accelerate</code>, <code>Annotate</code>, <code>Blob</code>, <code>Cache</code>,
1690<code>Coder</code>, <code>Configure</code>, <code>Deprecate</code>,
1691<code>Exception</code>, <code>Locale</code>, <code>Render</code>,
1692<code>Resource</code>, <code>Security</code>, <code>TemporaryFile</code>,
1693<code>Transform</code>, <code>X11</code>, or <code>User</code>. </p>
1694
1695
1696<p>For example, to log cache and blob events, use.</p>
1697
1698<pre>
1699convert -debug "Cache,Blob" rose: rose.png
1700</pre>
1701
1702<p>The <code>User</code> domain is normally empty, but developers can log user
1703events in their private copy of ImageMagick.</p>
1704
1705<p>To print the complete list of debug methods, use <a href="command-line-options.html#list">-list
1706debug</a>.</p>
1707
1708<p>Use the <a href="command-line-options.html#log">-log</a> option to specify the format for debugging
1709output.</p>
1710
1711<p>Use <a href="command-line-options.html#debug">+debug</a> to turn off all logging.</p>
1712
Cristy594d2772015-11-15 10:47:42 -05001713<p>Debugging may also be set using the <code>MAGICK_DEBUG</code> <a href="resources.html#environment"
1714>environment variable</a>. The allowed values for the <code>MAGICK_DEBUG</code>
Cristy882d9f42015-10-29 16:48:39 -04001715environment variable are the same as for the <a href="command-line-options.html#debug">-debug</a>
1716option.</p>
1717
1718
1719<div style="margin: auto;">
1720 <h3 class="magick-header"><a id="decipher"></a>-decipher <var>filename</var></h3>
1721</div>
1722
1723<p class="magick-description">Decipher and restore pixels that were previously transformed by <a href="command-line-options.html#encipher">-encipher</a>.</p>
1724
1725<p>Get the passphrase from the file specified by <var>filename</var>.</p>
1726
Cristy594d2772015-11-15 10:47:42 -05001727<p>For more information, see the webpage, <a
Cristy6549abb2016-11-10 08:25:55 -05001728href="https://www.imagemagick.org/script/cipher.html">ImageMagick: Encipher or
Cristy882d9f42015-10-29 16:48:39 -04001729Decipher an Image</a>.</p>
1730
1731
1732<div style="margin: auto;">
1733 <h3 class="magick-header"><a id="deconstruct"></a>-deconstruct</h3>
1734</div>
1735
1736<p class="magick-description">find areas that has changed between images </p>
1737
Cristy594d2772015-11-15 10:47:42 -05001738<p>Given a sequence of images all the same size, such as produced by <a
1739href="command-line-options.html#coalesce">-coalesce</a>, replace the second and later images, with
Cristy882d9f42015-10-29 16:48:39 -04001740a smaller image of just the area that changed relative to the previous image.
1741</p>
1742
1743<p>The resulting sequence of images can be used to optimize an animation
1744sequence, though will not work correctly for GIF animations when parts of the
1745animation can go from opaque to transparent. </p>
1746
1747<p>This option is actually equivalent to the <a href="command-line-options.html#layers">-layers</a>
1748method '<code>compare-any</code>'. </p>
1749
1750
1751<div style="margin: auto;">
1752 <h3 class="magick-header"><a id="define"></a>-define <var>key</var>{<var>=value</var>}<var>...</var></h3>
1753</div>
1754
1755<p class="magick-description">add specific global settings generally used to control coders and image processing operations.</p>
1756
1757<p>This option creates one or more definitions for coders and decoders to use
1758while reading and writing image data. Definitions are generally used to
1759control image file format coder modules, and image processing operations,
Cristy594d2772015-11-15 10:47:42 -05001760beyond what is provided by normal means. Defined settings are listed in <a
1761href="command-line-options.html#verbose" >-verbose</a> information ("<code>info:</code>" output format)
Cristy882d9f42015-10-29 16:48:39 -04001762as "Artifacts". </p>
1763
1764<p>If <var>value</var> is missing for a definition, an empty-valued
1765definition of a flag is created with that name. This used to control on/off
1766options. Use <a href="command-line-options.html#define">+define key</a> to remove definitions
1767previously created. Use <a href="command-line-options.html#define">+define "*"</a> to remove all
1768existing definitions.</p>
1769
Cristy594d2772015-11-15 10:47:42 -05001770<p>The same 'artifact' settings can also be defined using the <a
1771href="command-line-options.html#set" >-set "option:<var>key</var>" "<var>value</var>"</a> option, which also allows the use of <a href="escape.html" >Format and Print Image
Cristy882d9f42015-10-29 16:48:39 -04001772Properties</a> in the defined value. </p>
1773
1774<p>The <var>option</var> and <var>key</var> are case-independent (they are
1775converted to lowercase for use within the decoders) while the <var>value</var>
1776is case-dependent.</p>
1777
1778<p>Such settings are global in scope, and affect all images and operations. </p>
1779
1780<p>The following definitions are just some of the artifacts that are
1781available:</p>
1782
1783<table class="table table-condensed table-striped">
1784 <tr>
Cristye0779712016-07-30 17:25:22 -04001785 <td>bmp:alpha=<var>true|false</var></td>
1786 <td>include any alpha channel when writing in the BMP image format.</td>
1787 </tr>
1788
1789 <tr>
Cristy882d9f42015-10-29 16:48:39 -04001790 <td>bmp:format=<var>value</var></td>
1791 <td> valid values are <var>bmp2</var>, <var>bmp3</var>,
1792 and <var>bmp4</var>. This option can be useful when the
1793 method of prepending "BMP2:" to the output filename is inconvenient or
1794 is not available, such as when using the <a href="mogrify.html">mogrify</a> utility.</td>
1795 </tr>
1796
1797 <tr>
1798 <td>colorspace:auto-grayscale=<var>on|off</var></td>
Cristyd474b372017-02-14 12:19:13 -05001799 <td>prevent automatic conversion to grayscale inside coders that support
1800 grayscale. This should be accompanied by -type truecolor. PNG and TIF do
1801 not need this define. With PNG, just use PNG24:image. With TIF, just use
1802 -type truecolor. JPG and PSD will need this define.</td>
Cristy882d9f42015-10-29 16:48:39 -04001803 </tr>
1804
1805 <tr>
1806 <td>complex:snr=<var>value</var></td>
1807 <td>Set the divide SNR constant<a href="command-line-options.html#complex">-complex</a></td>
1808 </tr>
1809
1810 <tr>
1811 <td>compose:args=<var>arguments</var></td>
1812 <td>Sets certain compose argument values when using convert ... -compose ...
Cristy1f1f3a02016-06-01 07:25:42 -04001813 -composite. See <a href="compose.html"
Cristy594d2772015-11-15 10:47:42 -05001814 >Image Composition</a></td>
Cristy882d9f42015-10-29 16:48:39 -04001815 </tr>
1816
1817 <tr>
1818 <td>compose:clamp=<var>on|off</var></td>
Cristyd474b372017-02-14 12:19:13 -05001819 <td>set each pixel whose value is below zero to zero and any the pixel
1820 whose value is above the quantum range to the quantum range (e.g. 65535)
1821 otherwise the pixel value remains unchanged. Define supported in
Cristybc232422016-11-22 07:46:18 -05001822 ImageMagick 6.9.1-3 and above.</td>
Cristy882d9f42015-10-29 16:48:39 -04001823 </tr>
1824
1825 <tr>
Cristyde27d762016-01-02 12:56:44 -05001826 <td>connected-components:area-threshold=<var>value</var></td>
1827 <td>Merges any region with area smaller than <var>value</var> into its surrounding region or largest neighbor.</td>
1828 </tr>
1829
1830 <tr>
1831 <td>connected-components:keep=<var>list-of-ids</var></td>
Cristybc232422016-11-22 07:46:18 -05001832 <td>Comma and/or hyphenated list of id values to keep in the output.
1833 Supported in Imagemagick 6.9.3-0.</td>
Cristyde27d762016-01-02 12:56:44 -05001834 </tr>
1835
1836 <tr>
1837 <td>connected-components:mean-color=<var>true</var></td>
Cristybc232422016-11-22 07:46:18 -05001838 <td>Changes the output image from id values to mean color values. Supported
1839 in Imagemagick 6.9.2-8.</td>
Cristyde27d762016-01-02 12:56:44 -05001840 </tr>
1841
1842 <tr>
1843 <td>connected-components:remove=<var>list-of-ids</var></td>
Cristybc232422016-11-22 07:46:18 -05001844 <td>Comma and/or hyphenated list of id values to remove from the output.
1845 Supported in Imagemagick 6.9.2-9.</td>
Cristyde27d762016-01-02 12:56:44 -05001846 </tr>
1847
1848 <tr>
1849 <td>connected-components:verbose=<var>true</var></td>
1850 <td>Lists id, bounding box, centroid, area, mean color for each region.</td>
1851 </tr>
1852
1853 <tr>
Cristy882d9f42015-10-29 16:48:39 -04001854 <td>convolve:scale=<var>{kernel_scale}[!^] [,{origin_addition}] [%]</var></td>
1855 <td>Defines the kernel scaling. The special flag ! automatically scales to
1856 full dynamic range. The ! flag can be used in combination with a factor or
1857 percent. The factor or percent is then applied after the automatic scaling.
1858 An example is 50%!. This produces a result 50% darker than full dynamic
1859 range scaling. The ^ flag assures the kernel is 'zero-summing', for
1860 example when some values are positive and some are negative as in edge
1861 detection kernels. The origin addition adds that value to the center
1862 pixel of the kernel. This produces and effect that is like adding the image
1863 that many times to the result of the filtered image. The typical value
1864 is 1 so that the original image is added to the result of the convolution.
1865 The default is 0.</td>
1866 </tr>
1867
1868 <tr>
1869 <td>convolve:showkernel=<var>1</var></td>
Cristy594d2772015-11-15 10:47:42 -05001870 <td>Outputs (to 'standard error') all the information about a specified <a
1871 href="command-line-options.html#morphology" >-morphology convolve</a> kernel.</td>
Cristy882d9f42015-10-29 16:48:39 -04001872 </tr>
1873
1874 <tr>
1875 <td>dcm:display-range=<var>reset</var></td>
1876 <td>Sets the display range to the minimum and maximum pixel values for the
1877 DCM image format.</td>
1878 </tr>
1879
1880 <tr>
1881 <td>dds:cluster-fit=<var>true|false</var></td>
1882 <td>Enables the dds cluster-fit.</td>
1883 </tr>
1884
1885 <tr>
1886 <td>dds:compression=<var>dxt1|dxt5|none</var></td>
1887 <td>Sets the dds compression.</td>
1888 </tr>
1889
1890 <tr>
1891 <td>dds:mipmaps=<var>value</var></td>
1892 <td>Sets the dds number of mipmaps.</td>
1893 </tr>
1894
1895 <tr>
Cristy3b0b58d2016-11-06 07:40:23 -05001896 <td>dds:weight-by-alpha=<var>true|false</var></td>
Cristy882d9f42015-10-29 16:48:39 -04001897 <td>Enables the dds alpha weighting.</td>
1898 </tr>
1899
1900 <tr>
Cristy3b0b58d2016-11-06 07:40:23 -05001901 <td>deskew:auto-crop=<var>true</var></td>
1902 <td>auto crop the image after deskewing.</td>
1903 </tr>
1904
1905 <tr>
Cristy882d9f42015-10-29 16:48:39 -04001906 <td>delegate:bimodal=<var>true</var></td>
1907 <td>Specifies direct conversion from Postscript to PDF.</td>
1908 </tr>
1909
1910 <tr>
1911 <td>distort:scale=<var>value</var></td>
Cristy594d2772015-11-15 10:47:42 -05001912 <td>Sets the output scaling factor for use with <a href="command-line-options.html#distort"
1913 >-distort</a></td>
Cristy882d9f42015-10-29 16:48:39 -04001914 </tr>
1915
1916 <tr>
1917 <td>distort:viewport=<var>WxH+X+Y</var></td>
1918 <td>Sets the viewport for use with <a href="command-line-options.html#distort">-distort</a></td>
1919 </tr>
1920
1921 <tr>
1922 <td>dot:layout-engine=<var>value</var></td>
1923 <td>Specifies the layout engine for the DOT image format (e.g.
1924 <code>neato</code>).</td>
1925 </tr>
1926
1927 <tr>
1928 <td>filter:option=<var>value</var></td>
1929 <td>Set a filter option for use with <a href="command-line-options.html#resize">-resize</a>.
1930 See <a href="command-line-options.html#filter">-filter</a> for details.</td>
1931 </tr>
1932
1933 <tr>
1934 <td>fourier:normalize=<var>inverse</var></td>
1935 <td>Sets the location for the FFT/IFT normalization as use by
1936 <a href="command-line-options.html#fft">+-fft</a> and <a href="command-line-options.html#ift">+-ift</a>. The default is
1937 <var>forward</var>.</td>
1938 </tr>
1939
1940 <tr>
1941 <td>h:format=<var>value</var></td>
1942 <td>Set the image encoding format use when writing a C-style header.
1943 <var>format</var> can be any output format supported by ImageMagick
Cristy579a0cb2016-11-26 12:27:17 -05001944 except for <var>h</var> and <var>magick</var>. If this
Cristy882d9f42015-10-29 16:48:39 -04001945 option is omitted, the default is <var>GIF</var> for PseudoClass
1946 images and <var>PNM</var> for DirectClass images.
Cristy579a0cb2016-11-26 12:27:17 -05001947 </td>
Cristy882d9f42015-10-29 16:48:39 -04001948 </tr>
1949
1950 <tr>
1951 <td>icon:auto-resize</td>
1952 <td>Automatically stores multiple sizes when writing an ico image
1953 (requires a 256x256 input image).</td>
1954 </tr>
1955
1956 <tr>
1957 <td>jp2:layer-number=<var>value</var></td>
1958 <td>Sets the maximum number of quality layers to decode. Same for JPT, JC2,
1959 and J2K</td>
1960 </tr>
1961
1962 <tr>
1963 <td>jp2:number-resolutions=<var>value</var></td>
Cristybc232422016-11-22 07:46:18 -05001964 <td>Sets the number of resolutions to encode.Same for JPT, JC2, and
1965 J2K</td>
Cristy882d9f42015-10-29 16:48:39 -04001966 </tr>
1967
1968 <tr>
1969 <td>jp2:progression-order=<var>value</var></td>
1970 <td>choose from LRCP, RLCP, RPCL, PCRL or CPRL. Same for JPT, JC2, and
1971 J2K</td>
1972 </tr>
1973
1974 <tr>
1975 <td>jp2:quality=<var>value,value...</var></td>
1976 <td>Sets the quality layer PSNR, given in dB. The order is from left to
1977 right in ascending order. The default is a single lossless quality layer.
1978 Same for JPT, JC2, and J2K</td>
1979 </tr>
1980
1981 <tr>
1982 <td>jp2:rate=<var>value</var></td>
Cristybc232422016-11-22 07:46:18 -05001983 <td>Specify the compression factor to use while writing JPEG-2000 files.
1984 The compression factor is the reciprocal of the compression ratio. The
1985 valid range is 0.0 to 1.0, with 1.0 indicating lossless compression. If
1986 defined, this value overrides the -quality setting. A quality setting
1987 of 75 results in a rate value of 0.06641. Same for JPT, JC2, and J2K</td>
Cristy882d9f42015-10-29 16:48:39 -04001988 </tr>
1989
1990 <tr>
1991 <td>jp2:reduce-factor=<var>value</var></td>
1992 <td>Sets the number of highest resolution levels to be discarded.Same for
1993 JPT, JC2, and J2K</td>
1994 </tr>
1995
1996 <tr>
1997 <td>jpeg:block-smoothing=<var>on|off</var></td>
Cristybc232422016-11-22 07:46:18 -05001998 <td> </td>
Cristy882d9f42015-10-29 16:48:39 -04001999 </tr>
2000
2001 <tr>
2002 <td>jpeg:colors=<var>value</var></td>
2003 <td>Set the desired number of colors and let the JPEG encoder do the
2004 quantizing.</td>
2005 </tr>
2006
2007 <tr>
2008 <td>jpeg:dct-method=<var>value</var></td>
2009 <td>Choose from <code>default</code>, <code>fastest</code>,
2010 <code>float</code>, <code>ifast</code>, and <code>islow</code>.</td>
2011 </tr>
2012
2013 <tr>
2014 <td>jpeg:extent=<var>value</var></td>
2015 <td>Restrict the maximum JPEG file size, for example <code>-define
2016 jpeg:extent=400KB</code>. The JPEG encoder will search for the highest
2017 compression quality level that results in an output file that does not
Cristye93be682015-11-26 09:07:51 -05002018 exceed the value. The <code>-quality</code> option also will be respected
2019 starting with version 6.9.2-5. Between 6.9.1-0 and 6.9.2-4, add -quality
2020 100 in order for the jpeg:extent to work properly. Prior to 6.9.1-0, the
2021 -quality setting was ignored.</td>
Cristy882d9f42015-10-29 16:48:39 -04002022 </tr>
2023
2024 <tr>
2025 <td>jpeg:fancy-upsampling=<var>on|off</var></td>
Cristybc232422016-11-22 07:46:18 -05002026 <td> </td>
Cristy882d9f42015-10-29 16:48:39 -04002027 </tr>
2028
2029 <tr>
2030 <td>jpeg:optimize-coding=<var>on|off</var></td>
Cristybc232422016-11-22 07:46:18 -05002031 <td> </td>
Cristy882d9f42015-10-29 16:48:39 -04002032 </tr>
2033
2034 <tr>
2035 <td>jpeg:q-table=<var>table</var></td>
Cristybc232422016-11-22 07:46:18 -05002036 <td> </td>
Cristy882d9f42015-10-29 16:48:39 -04002037 </tr>
2038
2039 <tr>
2040 <td>jpeg:sampling-factor=<var>sampling-factor-string</var></td>
Cristybc232422016-11-22 07:46:18 -05002041 <td> </td>
Cristy882d9f42015-10-29 16:48:39 -04002042 </tr>
2043
2044 <tr>
2045 <td>jpeg:size=<var>geometry</var></td>
2046 <td>Set the size hint of a JPEG image, for
2047 example, <code>-define jpeg:size=128x128</code>.
2048 It is most useful for increasing performance and reducing the memory
2049 requirements when reducing the size of a large JPEG image.</td>
2050 </tr>
2051
2052 <tr>
2053 <td>json:features</td>
2054 <td>includes features in verbose information</td>
2055 </tr>
2056
2057 <tr>
2058 <td>json:limit</td>
Cristybc232422016-11-22 07:46:18 -05002059 <td> </td>
Cristy882d9f42015-10-29 16:48:39 -04002060 </tr>
2061
2062 <tr>
2063 <td>json:locate</td>
Cristybc232422016-11-22 07:46:18 -05002064 <td> </td>
Cristy882d9f42015-10-29 16:48:39 -04002065 </tr>
2066
2067 <tr>
2068 <td>json:moments</td>
2069 <td>includes image moments in verbose information</td>
2070 </tr>
2071
2072 <tr>
2073 <td>magick:format=<var>value</var></td>
2074 <td>Set the image encoding format use when writing a C-style header.
Cristy579a0cb2016-11-26 12:27:17 -05002075 This is the same as "h:format=format" described above.</td>
Cristy882d9f42015-10-29 16:48:39 -04002076 </tr>
2077
2078 <tr>
2079 <td>mng:need-cacheoff</td>
2080 <td>turn playback caching off for streaming MNG.</td>
2081 </tr>
2082
2083 <tr>
2084 <td>morphology:compose=<var>compose-method</var></td>
Cristy594d2772015-11-15 10:47:42 -05002085 <td>Specifies how to merge results generated by multiple<a
2086 href="command-line-options.html#morphology" >-morphology</a> kernel. The default is none. One
Cristy882d9f42015-10-29 16:48:39 -04002087 typical value is 'lighten' as used, for example, with the sobel edge
2088 kernels. </td>
2089 </tr>
2090
2091 <tr>
2092 <td>morphology:showkernel=<var>1</var></td>
Cristy594d2772015-11-15 10:47:42 -05002093 <td>Outputs (to 'standard error') all the information about a generated <a
2094 href="command-line-options.html#morphology" >-morphology</a> kernel.</td>
Cristy882d9f42015-10-29 16:48:39 -04002095 </tr>
2096
2097 <tr>
2098 <td>pcl:fit-to-page=<var>true</var></td>
Cristy579a0cb2016-11-26 12:27:17 -05002099 </tr>
Cristy882d9f42015-10-29 16:48:39 -04002100
Cristy594d2772015-11-15 10:47:42 -05002101 <tr>
Cristy882d9f42015-10-29 16:48:39 -04002102 <td>pdf:fit-page=<var>geometry</var></td>
2103 <td> geometry specifies the scaling dimensions for resizing when the PDF is
2104 being read. The geometry is either WxH{%} or page size. No offsets are
2105 allowed. (introduced in IM 6.8.8-8)</td>
2106 </tr>
2107
2108 <tr>
2109 <td>pdf:fit-to-page=<var>true</var></td>
Cristybc232422016-11-22 07:46:18 -05002110 <td> </td>
Cristy882d9f42015-10-29 16:48:39 -04002111 </tr>
2112
2113 <tr>
2114 <td>pdf:use-cropbox=<var>true</var></td>
Cristybc232422016-11-22 07:46:18 -05002115 <td> </td>
Cristy882d9f42015-10-29 16:48:39 -04002116 </tr>
2117
2118 <tr>
2119 <td>pdf:use-trimbox=<var>true</var></td>
Cristybc232422016-11-22 07:46:18 -05002120 <td> </td>
Cristy882d9f42015-10-29 16:48:39 -04002121 </tr>
2122
2123 <tr>
Cristy3b0b58d2016-11-06 07:40:23 -05002124 <td>phash:colorspaces=<var>colorspace,colorspace,...</var></td>
Cristybc232422016-11-22 07:46:18 -05002125 <td>the perceptual hash defaults to the sRGB and HCLp colorspaces. When
2126 using this define, you can specify up to six alternative colorspaces. (as
2127 of IM 7.0.3-8)</td>
2128 </tr>
2129
2130 <tr>
2131 <td>phash:normalize=<var>true</var></td>
2132 <td>normalizes the phash metric by dividing by the number of channels
2133 specified by <code>-define phash:colorspaces</code> when using compare
2134 -metric phash. (as of IM 7.0.3-8)</td>
Cristy3b0b58d2016-11-06 07:40:23 -05002135 </tr>
2136
2137 <tr>
Cristy882d9f42015-10-29 16:48:39 -04002138 <td>png:bit-depth=<var>value</var></td>
Cristybc232422016-11-22 07:46:18 -05002139 <td> </td>
Cristy882d9f42015-10-29 16:48:39 -04002140 </tr>
Cristy3b0b58d2016-11-06 07:40:23 -05002141
Cristy882d9f42015-10-29 16:48:39 -04002142 <tr>
2143 <td>png:color-type=<var>value</var></td>
2144 <td>desired bit-depth and color-type for PNG output. You can force the PNG
2145 encoder to use a different bit-depth and color-type than it would have
2146 normally selected, but only if this does not cause any loss of image
2147 quality. Any attempt to reduce image quality is treated as an error and no
2148 PNG file is written. E.g., if you have a 1-bit black-and-white image, you
2149 can use these "defines" to cause it to be written as an 8-bit grayscale,
2150 indexed, or even a 64-bit RGBA. But if you have a 16-million color image,
2151 you cannot force it to be written as a grayscale or indexed PNG. If you
2152 wish to do this, you must use the appropriate <a href="command-line-options.html#depth">-depth</a>,
2153 <a href="command-line-options.html#colors">-colors</a>, or <a href="command-line-options.html#type">-type</a> directives to
2154 reduce the image quality prior to using the PNG encoder. Note that in
2155 indexed PNG files, "bit-depth" refers to the number of bits per index,
2156 which can be 1, 2, 4, or 8. In such files, the color samples always have
2157 8-bit depth.</td>
2158 </tr>
2159
2160 <tr>
2161 <td>png:compression-filter=<var>value</var></td>
2162 <td> valid values are 0 through 9. 0-4 are the corresponding PNG filters,
2163 5 means adaptive filtering except for images with a colormap, 6 means
2164 adaptive filtering for all images, 7 means MNG "loco" compression, 8 means
2165 Z_RLE strategy with adaptive filtering, and 9 means Z_RLE strategy with no
2166 filtering.</td>
2167 </tr>
2168
2169 <tr>
2170 <td>png:compression-level=<var>value</var></td>
2171 <td> valid values are 0 through 9, with 0 providing the least but fastest
2172 compression and 9 usually providing the best and always the slowest.</td>
2173 </tr>
2174
2175 <tr>
2176 <td>png:compression-strategy=<var>value</var></td>
2177 <td> valid values are 0 through 4, meaning default, filtered, huffman_only,
2178 rle, and fixed ZLIB compression strategy. If you are using an old zlib
2179 that does not support Z_RLE (before 1.2.0) or Z_FIXED (before 1.2.2.2),
2180 values 3 and 4, respectively, will use the zlib default strategy
2181 instead.</td>
2182 </tr>
2183
2184 <tr>
2185 <td>png:format=<var>value</var></td>
2186 <td> valid values are <var>png8</var>, <var>png24</var>,
2187 <var>png32</var>, <var>png48</var>,
2188 <var>png64</var>, and <var>png00</var>.
2189 This property can be useful for specifying
2190 the specific PNG format to be used, when the usual method of prepending the
2191 format name to the output filename is inconvenient, such as when writing
2192 a PNG-encoded ICO file or when using <a href="mogrify.html">mogrify</a>.
2193 Value = <var>png8</var> reduces the number of colors to 256,
2194 only one of which may be fully transparent, if necessary. The other
2195 values do not force any reduction of quality; it is an error to request
2196 a format that cannot represent the image data without loss (except that
2197 it is allowed to reduce the bit-depth from 16 to 8 for all formats).
2198 Value = <var>png24</var> and <var>png48</var>
2199 allow transparency, only if a single color is fully transparent and that
2200 color does not also appear in an opaque pixel; such transparency is
2201 written in a PNG <code>tRNS</code> chunk.
2202 Value = <var>png00</var> causes the image to inherit its
2203 color-type and bit-depth from the input image, if the input was also
2204 a PNG.</td>
2205 </tr>
2206
2207 <tr>
2208 <td>png:exclude-chunk=<var>value</var></td>
2209
Cristy594d2772015-11-15 10:47:42 -05002210 <tr>
Cristy882d9f42015-10-29 16:48:39 -04002211 <td>png:include-chunk=<var>value</var></td>
2212 <td>ancillary chunks to be excluded from or included in PNG output.
2213
2214 <p>The <var>value</var> can be the name of a PNG chunk-type such
2215 as <var>bKGD</var>, a comma-separated list of chunk-names
2216 (which can include the word <var>date</var>, the word
2217 <var>all</var>, or the word <var>none</var>).
2218 Although PNG chunk-names are case-dependent, you can use all lowercase
2219 names if you prefer.</p>
2220
2221 <p>The "include-chunk" and "exclude-chunk" lists only affect the behavior
2222 of the PNG encoder and have no effect on the PNG decoder.</p>
2223
2224 <p>As a special case, if the <code>sRGB</code> chunk is excluded and
2225 the <code>gAMA</code> chunk is included, the <code>gAMA</code> chunk will
2226 only be written if gamma is not 1/2.2, since most decoders assume
2227 sRGB and gamma=1/2.2 when no colorspace information is included in
2228 the PNG file. Because the list is processed from left to right, you
2229 can achieve this with a single define:</p>
2230
2231<pre>
2232-define png:include-chunk=none,gAMA
2233</pre>
2234
2235 <p>As a special case, if the <code>sRGB</code> chunk is not excluded and
2236 the PNG encoder recognizes that the image contains the sRGB ICC profile,
2237 the PNG encoder will write the <code>sRGB</code> chunk instead of the
2238 entire ICC profile. To force the PNG encoder to write the sRGB
2239 profile as an <code>iCCP</code> chunk in the output PNG instead of the
2240 <code>sRGB</code> chunk, exclude the <code>sRGB</code> chunk.</p>
2241
2242 <p>The critical PNG chunks <code>IHDR</code>, <code>PLTE</code>,
2243 <code>IDAT</code>, and <code>IEND</code> cannot be excluded. Any such
2244 entries appearing in the list will be ignored.</p>
2245
2246 <p>If the ancillary PNG <code>tRNS</code> chunk is excluded and the
2247 image has transparency, the PNG colortype is forced to be 4 or 6
2248 (GRAY_ALPHA or RGBA). If the image is not transparent, then the
2249 <code>tRNS</code> chunk isn't written anyhow, and there is no effect
2250 on the PNG colortype of the output image.</p>
2251
2252 <p>The <a href="command-line-options.html#strip">-strip</a> option does the equivalent of the
2253 following for PNG output:</p>
2254
2255<pre>
2256-define png:exclude-chunk=EXIF,iCCP,iTXt,sRGB,tEXt,zCCP,zTXt,date
2257</pre>
2258
2259 <p>The default behavior is to include all known PNG ancillary chunks
2260 plus ImageMagick's private <code>vpAg</code> ("virtual page") chunk,
2261 and to exclude all PNG chunks that are unknown to ImageMagick,
2262 regardless of their PNG "copy-safe" status as described in the
2263 PNG specification.</p>
2264
2265 <p>Any chunk names that are not known to ImageMagick are ignored
2266 if they appear in either the "include-chunk" or "exclude-chunk" list.
2267 The ancillary chunks currently known to ImageMagick are
2268 <code>bKGD</code>, <code>cHRM</code>, <code>gAMA</code>, <code>iCCP</code>,
2269 <code>oFFs</code>, <code>pHYs</code>, <code>sRGB</code>, <code>tEXt</code>,
2270 <code>tRNS</code>, <code>vpAg</code>, and <code>zTXt</code>.</p>
2271
2272 <p>You can also put <code>date</code> in the list to include or exclude
2273 the "Date:create" and "Date:modify" text chunks that ImageMagick normally
2274 inserts in the output PNG.</p></td>
2275 </tr>
2276
2277 <tr>
2278 <td>png:preserve-colormap[=<var>true</var>]</td>
Cristy594d2772015-11-15 10:47:42 -05002279 <td>Use the existing image->colormap. Normally the PNG encoder will
Cristy882d9f42015-10-29 16:48:39 -04002280 try to optimize the palette, eliminating unused entries and putting
2281 the transparent colors first. If this flag is set, that behavior
2282 is suppressed.</td>
2283 </tr>
2284
2285 <tr>
2286 <td>png:preserve-iCCP[=<var>true</var>]</td>
2287 <td>By default, the PNG decoder and encoder examine any ICC profile
2288 that is present, either from an <code>iCCP</code> chunk in the PNG
2289 input or supplied via an option, and if the profile is recognized
2290 to be the sRGB profile, converts it to the <code>sRGB</code> chunk.
2291 You can use <code>-define png:preserve-iCCP</code> to prevent
2292 this from happening; in such cases the <code>iCCP</code> chunk
2293 will be read or written and no <code>sRGB</code> chunk will be
2294 written. There are some ICC profiles that claim to be sRGB but
2295 have various errors that cause them to be rejected by libpng16; such
2296 profiles are recognized anyhow and converted to the <code>sRGB</code>
2297 chunk, but are rejected if the <code>-define png:preserve-iCCP</code>
2298 is present. Note that not all "sRGB" ICC profiles are recognized
2299 yet; we will add them to the list as we encounter them.</td>
2300 </tr>
2301
2302 <tr>
2303 <td>png:swap-bytes[=<var>true</var>]</td>
2304 <td>The PNG specification requires that any multi-byte integers be stored in
2305 network byte order (MSB-LSB endian). This option allows you to
2306 fix any invalid PNG files that have 16-bit samples stored incorrectly
2307 in little-endian order (LSB-MSB). The "-define png:swap-bytes" option
2308 must appear before the input filename on the commandline. The swapping
2309 is done during the libpng decoding operation.</td>
2310 </tr>
2311
2312 <tr>
2313 <td>profile:skip=<var>name1,name2,...</var></td>
2314 <td>Skip the named profile[s] when reading the image. Use skip="*" to
2315 skip all named profiles in the image. Many named profiles exist,
2316 including ICC, EXIF, APP1, IPTC, XMP, and others.</td>
2317 </tr>
2318
2319 <tr>
2320 <td>ps:imagemask</td>
2321 <td>If the ps:imagemask flag is defined, the PS3 and EPS3 coders will
2322 create Postscript files that render bilevel images with the Postscript
2323 imagemask operator instead of the image operator.</td>
2324 </tr>
2325
2326 <tr>
Cristy3b0b58d2016-11-06 07:40:23 -05002327 <td>psd:additional-info=all|selective</td>
Cristybc232422016-11-22 07:46:18 -05002328 <td>This option should only be used when converting from a PSD file to
2329 another PSD file. This should be placed after the image is read. The two
2330 options are 'all' and 'selective'. The 'selective' option will preserve
2331 all additional information that is not related to the geometry of the
2332 image. The 'all' option should only be used when the geometry of the
2333 image has not been changed. This option is helpful when transferring
2334 non-simple layers, such as adjustment layers from the input PSD file to
2335 the output PSD file. If this option is not used, the additional
2336 information will not be preserved. This define is available as of
2337 Imagemagick version 6.9.5-8.
Cristy3b0b58d2016-11-06 07:40:23 -05002338</td>
2339 </tr>
2340
2341 <tr>
Cristy882d9f42015-10-29 16:48:39 -04002342 <td>psd:alpha-unblend=off</td>
2343 <td>Disables new automatic un-blending of transparency with the base image
2344 for the flattened layer 0 before adding the alpha channel to the output
2345 image. This define must be placed before the input psd image. (Available
2346 as of IM 6.9.2.5). The automatic un-blending is new to IM 6.9.2.5 and
2347 prevents the transparency from being applied twice in the output
Cristy3b0b58d2016-11-06 07:40:23 -05002348 image. This option should be set before reading the image.</td>
2349 </tr>
2350
2351 <tr>
2352 <td>psd:preserve-opacity-mask=true</td>
Cristybc232422016-11-22 07:46:18 -05002353 <td>This option should only be used when converting from a PSD file to
2354 another PSD file. It will preserve the opacity mask of a layer and add it
2355 back to the layer when the image is saved. Setting this to 'true' will
2356 enable this feature. This define is available as of Imagemagick version
2357 6.9.5-10.
Cristy3b0b58d2016-11-06 07:40:23 -05002358</td>
Cristy882d9f42015-10-29 16:48:39 -04002359 </tr>
2360
2361 <tr>
Cristy1f1f3a02016-06-01 07:25:42 -04002362 <td>preserve-timestamp=<var>{True, False}</var></td>
2363 <td>Preserve file timestamp (<code>mogrify</code> only).</td>
2364 </tr>
2365
2366 <tr>
Cristy882d9f42015-10-29 16:48:39 -04002367 <td>quantum:format=<var>type</var></td>
2368 <td>Set the type to <code>floating-point</code> to specify a floating-point
2369 format for raw files (e.g. GRAY:) or for MIFF and TIFF images in HDRI mode
2370 to preserve negative values. If <a href="command-line-options.html#depth">-depth</a> 16 is
2371 included, the result is a single precision floating point format.
2372 If <a href="command-line-options.html#depth">-depth</a> 32 is included, the result is
2373 double precision floating point format.</td>
2374 </tr>
2375
2376 <tr>
2377 <td>quantum:polarity=<var>photometric-interpretation</var></td>
Cristybc232422016-11-22 07:46:18 -05002378 <td>Set the photometric-interpretation of an image (typically for TIFF
2379 image file format) to either <code>min-is-black</code> (default) or
Cristy882d9f42015-10-29 16:48:39 -04002380 <code>min-is-white</code>.</td>
2381 </tr>
2382
2383 <tr>
2384 <td>sample:offset=<var>geometry</var></td>
2385 <td>Location of the sampling point within the sub-region being sampled,
Cristy594d2772015-11-15 10:47:42 -05002386 expressed as percentages (see <a href="command-line-options.html#sample" >-sample</a>).</td>
Cristy882d9f42015-10-29 16:48:39 -04002387 </tr>
2388
2389 <tr>
2390 <td>showkernel=<var>1</var></td>
Cristy594d2772015-11-15 10:47:42 -05002391 <td>Outputs (to 'standard error') all the information about a generated <a
2392 href="command-line-options.html#morphology" >-morphology</a> kernel.</td>
Cristy882d9f42015-10-29 16:48:39 -04002393 </tr>
2394
2395 <tr>
2396 <td>stream:buffer-size=<var>value</var></td>
2397 <td>Set the stream buffer size. Select 0 for unbuffered I/O.</td>
2398 </tr>
2399
2400 <tr>
2401 <td>tiff:alpha=<var>associated|unassociated|unspecified</var></td>
Cristybc232422016-11-22 07:46:18 -05002402 <td>Specify the alpha extra samples as associated, unassociated or
2403 unspecified </td>
Cristy882d9f42015-10-29 16:48:39 -04002404 </tr>
2405
2406 <tr>
2407 <td>tiff:endian=<var>msb|lsb</var></td>
Cristybc232422016-11-22 07:46:18 -05002408 <td> </td>
Cristy882d9f42015-10-29 16:48:39 -04002409 </tr>
2410
2411 <tr>
2412 <td>tiff:exif-properties=<var>false</var></td>
2413 <td>Skips reading the EXIF properties.</td>
2414 </tr>
2415
2416 <tr>
2417 <td>tiff:fill-order=<var>msb|lsb</var></td>
Cristybc232422016-11-22 07:46:18 -05002418 <td> </td>
Cristy882d9f42015-10-29 16:48:39 -04002419 </tr>
2420
2421 <tr>
2422 <td>tiff:ignore-layers=<var>true</var></td>
2423 <td>Ignores the photoshop layers.</td>
2424 </tr>
2425
2426 <tr>
2427 <td>tiff:ignore-tags=<var>comma-separate-list-of-tag-IDs</var></td>
2428 <td>Allows one or more tag ID values to be ignored.</td>
2429 </tr>
2430
2431 <tr>
2432 <td>tiff:rows-per-strip=<var>value</var></td>
2433 <td>Sets the number of rows per strip</td>
2434 </tr>
2435
2436 <tr>
2437 <td>tiff:tile-geometry=<var>WxH</var></td>
2438 <td>Sets the tile size for pyramid tiffs. Requires the suffix
2439 PTIF: before the outputname</td>
2440 </tr>
Cristye09ed312016-03-06 08:07:39 -05002441
2442 <tr>
2443 <td>type:features=<var>string</var></td>
Cristybc232422016-11-22 07:46:18 -05002444 <td> </td>
Cristye09ed312016-03-06 08:07:39 -05002445 </tr>
2446
2447 <tr>
2448 <td>type:hinting=<var>off</var></td>
Cristybc232422016-11-22 07:46:18 -05002449 <td> </td>
Cristye09ed312016-03-06 08:07:39 -05002450 </tr>
Cristy882d9f42015-10-29 16:48:39 -04002451</table>
2452
2453<p>For example, to create a postscript file that will render only the black
2454pixels of a bilevel image, use:</p>
2455
2456<pre>
2457convert bilevel.tif -define ps:imagemask eps3:stencil.ps
2458</pre>
2459
2460<p>Set attributes of the image registry by prefixing the value with
2461<code>registry:</code>. For example, to set a temporary path to put work files,
2462use:</p>
2463
2464<pre>
2465-define registry:temporary-path=/data/tmp
2466</pre>
2467
2468<div style="margin: auto;">
Cristy594d2772015-11-15 10:47:42 -05002469 <h3 class="magick-header"><a id="delay"></a>-delay <var>ticks</var> <br />-delay <var>ticks</var>x<var>ticks-per-second</var> {<var>&lt;</var>} {<var>&gt;</var>}</h3>
Cristy882d9f42015-10-29 16:48:39 -04002470</div>
2471
2472<p class="magick-description">display the next image after pausing.</p>
2473
2474<p>This option is useful for regulating the animation of image sequences
2475<var>ticks/ticks-per-second</var> seconds must expire before the display of the
2476next image. The default is no delay between each showing of the image
2477sequence. The default ticks-per-second is 100.</p>
2478
2479<p>Use <code>&gt;</code> to change the image delay <var>only</var> if its current
2480value exceeds the given delay. <code>&lt;</code> changes the image delay
2481<var>only</var> if current value is less than the given delay. For example, if
2482you specify <code>30&gt;</code> and the image delay is 20, the image delay does
2483not change. However, if the image delay is 40 or 50, the delay it is changed
2484to 30. Enclose the given delay in quotation marks to prevent the
2485<code>&lt;</code> or <code>&gt;</code> from being interpreted by your shell as
2486a file redirection.</p>
2487
2488
2489<div style="margin: auto;">
2490 <h3 class="magick-header"><a id="delete"></a>-delete <var>indexes</var></h3>
2491</div>
2492
2493<p class="magick-description">delete the images specified by index, from the image sequence.</p>
2494
2495<p>Specify the image by its index in the sequence. The first image is index
24960. Negative indexes are relative to the end of the sequence, for example, -1
2497represents the last image of the sequence. Specify a range of images with
2498a dash (e.g. 0-4). Separate indexes with a comma (e.g. 0,2). Use
Cristy912a9222016-06-17 15:37:28 -04002499<code>+delete</code> to delete the last image in the current image sequence. Use <code>-delete 0--1</code> to delete the entire image sequence.</p>
Cristy882d9f42015-10-29 16:48:39 -04002500
2501
2502<div style="margin: auto;">
Cristy594d2772015-11-15 10:47:42 -05002503 <h3 class="magick-header"><a id="density"></a>-density <var>width</var><br />-density <var>width</var>x<var>height</var></h3>
Cristy882d9f42015-10-29 16:48:39 -04002504</div>
2505
2506<p class="magick-description">Set the horizontal and vertical resolution of an image for rendering to devices.</p>
2507
2508<p>This option specifies the image resolution to store while encoding a raster
2509image or the canvas resolution while rendering (reading) vector formats such
2510as Postscript, PDF, WMF, and SVG into a raster image. Image resolution
2511provides the unit of measure to apply when rendering to an output device or
Cristy594d2772015-11-15 10:47:42 -05002512raster image. The default unit of measure is in dots per inch (DPI). The <a
2513href="command-line-options.html#units">-units</a> option may be used to select dots per centimeter
Cristy882d9f42015-10-29 16:48:39 -04002514instead.</p>
2515
2516<p>The default resolution is 72 dots per inch, which is equivalent to one
2517point per pixel (Macintosh and Postscript standard). Computer screens are
2518normally 72 or 96 dots per inch, while printers typically support 150, 300,
2519600, or 1200 dots per inch. To determine the resolution of your display, use
2520a ruler to measure the width of your screen in inches, and divide by the
2521number of horizontal pixels (1024 on a 1024x768 display).</p>
2522
2523<p>If the file format supports it, this option may be used to update the
2524stored image resolution. Note that Photoshop stores and obtains image
2525resolution from a proprietary embedded profile. If this profile is not
2526stripped from the image, then Photoshop will continue to treat the image using
2527its former resolution, ignoring the image resolution specified in the standard
2528file header.</p>
2529
2530<p>The <a href="command-line-options.html#density">-density</a> option sets an <var>attribute</var> and
2531does not alter the underlying raster image. It may be used to adjust the
2532rendered size for desktop publishing purposes by adjusting the scale applied
2533to the pixels. To resize the image so that it is the same size at a different
2534resolution, use the <a href="command-line-options.html#resample">-resample</a> option.</p>
2535
2536<div style="margin: auto;">
2537 <h3 class="magick-header"><a id="depth"></a>-depth <var>value</var></h3>
2538</div>
2539
2540<p class="magick-description">depth of the image.</p>
2541
2542<p>This the number of bits in a color sample within a pixel. Use this option
2543to specify the depth of raw images whose depth is unknown such as GRAY, RGB,
2544or CMYK, or to change the depth of any image after it has been read.</p>
2545
2546<div style="margin: auto;">
2547 <h3 class="magick-header"><a id="descend"></a>-descend</h3>
2548</div>
2549
2550<p class="magick-description">obtain image by descending window hierarchy.</p>
2551
2552<div style="margin: auto;">
Cristy769d8892016-01-19 18:11:14 -05002553 <h3 class="magick-header"><a id="deskew"></a>-deskew <var>threshold{%}</var></h3>
Cristy882d9f42015-10-29 16:48:39 -04002554</div>
2555
2556<p class="magick-description">straighten an image. A threshold of 40% works for most images.</p>
2557
2558<p>Use <a href="command-line-options.html#set">-set</a> <code>option:deskew:auto-crop
Cristy3b0b58d2016-11-06 07:40:23 -05002559<var>true | false</var></code> to auto crop the image.</p>
Cristy882d9f42015-10-29 16:48:39 -04002560
2561<div style="margin: auto;">
2562 <h3 class="magick-header"><a id="despeckle"></a>-despeckle</h3>
2563</div>
2564
2565<p class="magick-description">reduce the speckles within an image.</p>
2566
2567<div style="margin: auto;">
2568 <h3 class="magick-header"><a id="direction"></a>-direction <var>type</var></h3>
2569</div>
2570
2571<p class="magick-description">render text right-to-left or left-to-right.</p>
2572
2573<div style="margin: auto;">
Cristy769d8892016-01-19 18:11:14 -05002574 <h3 class="magick-header"><a id="displace"></a>-displace <var>horizontal-scale</var>{%}{!}<br />-displace <var>horizontal-scale</var>x<var>vertical-scale</var>{%}{!}</h3>
Cristy882d9f42015-10-29 16:48:39 -04002575</div>
2576
2577<p class="magick-description">shift image pixels as defined by a displacement map.</p>
2578
2579<p>With this option, the 'overlay' image, and optionally the 'mask' image,
2580is used as a displacement map, which is used to displace the lookup of
2581what part of the 'background' image is seen at each point of the overlaid
2582area. Much like the displacement map is a 'lens' that redirects light shining
2583through it so as to present a distorted view the original 'background' image
2584behind it. </p>
2585
2586<p>Any perfect grey areas of the displacement map produce a zero
2587displacement of the image. Black areas produce the given maximum negative
2588displacement of the lookup point, while white produce a maximum positive
2589displacement of the lookup. </p>
2590
2591<p>Note that it is the lookup of the 'background' that is displaced, not a
2592displacement of the image itself. As such an area of the displacement map
2593containing 'white' will have the lookup point 'shifted' by a positive amount,
2594and thus generating a copy of the destination image to the right/downward from
2595the correct position. That is the image will look like it may have been
2596'shifted' in a negative left/upward direction. Understanding this is a very
2597important in understanding how displacement maps work. </p>
2598
2599<p>The given arguments define the maximum amount of displacement in pixels
2600that a particular map can produce. If the displacement scale is large enough
2601it is also possible to lookup parts of the 'background' image that lie well
2602outside the bounds of the displacement map itself. That is you could very
2603easily copy a section of the original image from outside the overlay area
2604into the overlay area. </p>
2605
2606<p>The '%' flag makes the displacement scale relative to the size of the
2607overlay image (100% = half width/height of image). Using '!' switches
2608percentage arguments to refer to the destination image size instead.
2609these flags were added as of IM v6.5.3-5.</p>
2610
2611<p>Normally a single grayscale displacement map is provided, which with the
2612given scaling values will determine a single direction (vector) in which
2613displacements can occur (positively or negatively). However, if you also
2614specify a third image which is normally used as a <var>mask</var>,
2615the <var>composite image</var> is used for horizontal X
2616displacement, while the <var>mask image</var> is used for vertical Y
2617displacement. This allows you to define completely different displacement
2618values for the X and Y directions, and allowing you to lookup any point within
2619the <var>scale</var> bounds. In other words each pixel can lookup
2620any other nearby pixel, producing complex 2 dimensional displacements, rather
2621than a simple 1 dimensional vector displacements. </p>
2622
2623<p>Alternatively rather than supplying two separate images, as of IM v6.4.4-0,
2624you can use the 'red' channel of the overlay image to specify the horizontal
2625or X displacement, and the 'green' channel for the vertical or Y displacement.
2626</p>
2627
2628<p>As of IM v6.5.3-5 any alpha channel in the overlay image is used as a
2629mask the transparency of the destination image. However areas outside the
2630overlaid areas will not be effected. </p>
2631
2632
2633<div style="margin: auto;">
2634 <h3 class="magick-header"><a id="display"></a>-display <var>host:display[.screen]</var></h3>
2635</div>
2636
2637<p class="magick-description">Specifies the X server to contact.</p>
2638
2639<p>This option is used with convert for obtaining image or font from this
2640X server. See <var>X(1)</var>.</p>
2641
2642<div style="margin: auto;">
2643 <h3 class="magick-header"><a id="dispose"></a>-dispose <var>method</var></h3>
2644</div>
2645
2646<p class="magick-description">define the GIF disposal image setting for images that are being created or read in. </p>
2647
2648<p>The layer disposal method defines the way each the displayed image is to be
2649modified after the current 'frame' of an animation has finished being
2650displayed (after its 'delay' period), but before the next frame on an
2651animation is to be overlaid onto the display. </p>
2652
2653<p>Here are the valid methods:</p>
2654
2655<dl class="dl-horizontal">
2656<dt>Undefined</dt><dd>0: No disposal specified (equivalent to '<code>none</code>').</dd>
2657<dt>None</dt><dd>1: Do not dispose, just overlay next frame image.</dd>
2658<dt>Background</dt><dd>2: Clear the frame area with the background color.</dd>
2659<dt>Previous</dt><dd>3: Clear to the image prior to this frames overlay.</dd>
2660</dl>
2661
2662<p>You can also use the numbers given above, which is what the GIF format
2663uses internally to represent the above settings. </p>
2664
2665<p>To print a complete list of dispose methods, use <a href="command-line-options.html#list">-list dispose</a>.</p>
2666
Cristy594d2772015-11-15 10:47:42 -05002667<p>Use <a href="command-line-options.html#dispose" >+dispose</a>, turn off the setting and prevent
Cristy882d9f42015-10-29 16:48:39 -04002668resetting the layer disposal methods of images being read in. </p>
2669
2670<p>Use <a href="command-line-options.html#set">-set</a> '<code>dispose</code>' method to set the image
2671disposal method for images already in memory.</p>
2672
2673<div style="margin: auto;">
2674 <h3 class="magick-header"><a id="dissimilarity-threshold"></a>-dissimilarity-threshold <var>value</var></h3>
2675</div>
2676
2677<p class="magick-description">maximum RMSE for subimage match (default 0.2).</p>
2678
2679
2680<div style="margin: auto;">
2681 <h3 class="magick-header"><a id="dissolve"></a>-dissolve <var>src_percent</var>[x<var>dst_percent</var>]</h3>
2682</div>
2683
2684<p class="magick-description">dissolve an image into another by the given percent.</p>
2685
2686<p>The opacity of the composite image is multiplied by the given percent, then
2687it is composited 'over' the main image. If <var>src_percent</var>
2688is greater than 100, start dissolving the main image so it becomes
2689transparent at a value of '<code>200</code>'. If both percentages
2690are given, each image are dissolved to the percentages given. </p>
2691
2692<p>Note that dissolve percentages do not add, two opaque images dissolved
2693'50,50', produce a 75% transparency. For a 50% + 50% blending of the two
2694images, you would need to use dissolve values of '50,100'. </p>
2695
2696<div style="margin: auto;">
2697 <h3 class="magick-header"><a id="distort"></a>-distort <var>method arguments</var></h3>
2698</div>
2699
2700<p class="magick-description">distort an image, using the given <var>method</var> and its required <var>arguments</var>.</p>
2701
2702<p>The <var>arguments</var> is a single string containing a list
2703of floating point numbers separated by commas or spaces. The number of
2704and meaning of the floating point values depends on the distortion <var>method</var> being used. </p>
2705
2706<p>Choose from these distortion types:</p>
2707
2708<table class="table table-condensed table-striped">
2709 <tr>
2710 <th style="width: 8%">Method</th>
2711 <th>Description</th>
2712 </tr>
2713
2714 <tr>
Cristy594d2772015-11-15 10:47:42 -05002715 <td>ScaleRotateTranslate <br/> SRT</td>
Cristy882d9f42015-10-29 16:48:39 -04002716 <td>
2717 Distort image by first scaling and rotating about a given 'center',
2718 before translating that 'center' to the new location, in that order. It
2719 is an alternative method of specifying a 'Affine' type of
2720 distortion, but without shearing effects. It also provides a good way
2721 of rotating and displacing a smaller image for tiling onto a larger
Cristy594d2772015-11-15 10:47:42 -05002722 background (IE 2-dimensional animations). <br/>
Cristy882d9f42015-10-29 16:48:39 -04002723
2724 The number of arguments determine the specific meaning of each
Cristy594d2772015-11-15 10:47:42 -05002725 argument for the scales, rotation, and translation operations. <br/>
Cristy882d9f42015-10-29 16:48:39 -04002726
2727 <dl class="dl-horizontal">
2728 <dt>2:</dt><dd><var>Scale Angle</var></dd>
2729 <dt>3:</dt><dd><var>X,Y Angle</var></dd>
2730 <dt>4:</dt><dd><var>X,Y Scale Angle</var></dd>
2731 <dt>5:</dt> <dd><var>X,Y ScaleX,ScaleY Angle</var></dd>
2732 <dt>6:</dt> <dd><var>X,Y Scale Angle NewX,NewY</var></dd>
2733 <dt>7:</dt> <dd><var>X,Y ScaleX,ScaleY Angle NewX,NewY</var></dd>
2734 </dl>
2735
2736 This is actually an alternative way of specifying a 2 dimensional linear
2737 'Affine' or 'AffineProjection' distortion. </td> </tr>
2738
2739 <tr>
2740 <td>Affine</td>
2741 <td>
2742 Distort the image linearly by moving a list of at least 3 or more sets
2743 of control points (as defined below). Ideally 3 sets or 12 floating
2744 point values are given allowing the image to be linearly scaled,
2745 rotated, sheared, and translated, according to those three points. See
2746 also the related 'AffineProjection' and 'SRT'
Cristy594d2772015-11-15 10:47:42 -05002747 distortions. <br/>
Cristy882d9f42015-10-29 16:48:39 -04002748
2749 More than 3 sets given control point pairs (12 numbers) is least
2750 squares fitted to best match a linear affine distortion. If only 2
2751 control point pairs (8 numbers) are given a two point image translation
2752 rotation and scaling is performed, without any possible shearing,
2753 flipping or changes in aspect ratio to the resulting image. If only one
2754 control point pair is provides the image is only translated, (which may
Cristy594d2772015-11-15 10:47:42 -05002755 be a floating point non-integer translation). <br/>
Cristy882d9f42015-10-29 16:48:39 -04002756
2757 This distortion does not include any form of perspective distortion.
2758 </td>
2759
2760 </tr>
2761
2762 <tr>
2763 <td>AffineProjection</td>
2764 <td>
2765 Linearly distort an image using the given Affine Matrix of 6
2766 pre-calculated coefficients forming a set of Affine Equations to map
2767 the source image to the destination image.
2768
2769 <p class="text-center"><var>
2770 s<sub>x</sub>, r<sub>x</sub>,
2771 r<sub>y</sub>, s<sub>y</sub>,
2772 t<sub>x</sub>, t<sub>y</sub>
2773 </var></p>
2774
Cristy594d2772015-11-15 10:47:42 -05002775 See <a href="command-line-options.html#affine" >-affine</a> setting for more detail, and
2776 meanings of these coefficients. <br/>
Cristy882d9f42015-10-29 16:48:39 -04002777
2778 The distortions 'Affine' and 'SRT' provide
2779 alternative methods of defining this distortion, with ImageMagick doing
2780 the calculations needed to generate the required coefficients. You can
Cristy594d2772015-11-15 10:47:42 -05002781 see the internally generated coefficients, by using a <a
2782 href="command-line-options.html#verbose" >-verbose</a> setting with those other variants. </td>
Cristy882d9f42015-10-29 16:48:39 -04002783
2784 </tr>
2785
2786 <tr>
Cristy594d2772015-11-15 10:47:42 -05002787 <td>BilinearForward<br/>
Cristy882d9f42015-10-29 16:48:39 -04002788 BilinearReverse</td>
2789 <td>
2790 Bilinear Distortion, given a minimum of 4 sets of coordinate pairs, or
2791 16 values (see below). Not that lines may not appear straight after
2792 distortion, though the distance between coordinates will remain
Cristy594d2772015-11-15 10:47:42 -05002793 consistent. <br/>
Cristy882d9f42015-10-29 16:48:39 -04002794
2795 The 'BilinearForward' is used to map rectangles to any
2796 quadrilateral, while the 'BilinearReverse' form maps any
2797 quadrilateral to a rectangle, while preserving the straight line edges
Cristy594d2772015-11-15 10:47:42 -05002798 in each case. <br/>
Cristy882d9f42015-10-29 16:48:39 -04002799
2800 Note that 'BilinearForward' can generate invalid pixels
Cristyb7f455a2017-03-03 19:30:34 -05002801 which will be colored using the <a href="command-line-options.html#mattecolor" >-mattecolor</a>
Cristy882d9f42015-10-29 16:48:39 -04002802 color setting. Also if the quadrilateral becomes 'flipped' the image
Cristy594d2772015-11-15 10:47:42 -05002803 may disappear. <br/>
Cristy882d9f42015-10-29 16:48:39 -04002804
2805 There are future plans to produce a true Bilinear distortion that will
2806 attempt to map any quadrilateral to any other quadrilateral, while
2807 preserving edges (and edge distance ratios).
2808
2809 </td>
2810 </tr>
2811
2812 <tr>
2813 <td>Perspective</td>
2814 <td>
2815 Perspective distort the images, using a list of 4 or more sets of
2816 control points (as defined below). More that 4 sets (16 numbers) of
2817 control points provide least squares fitting for more accurate
2818 distortions (for the purposes of image registration and panorama
2819 effects). Less than 4 sets will fall back to a 'Affine'
Cristy594d2772015-11-15 10:47:42 -05002820 linear distortion. <br/>
Cristy882d9f42015-10-29 16:48:39 -04002821
2822 Perspective Distorted images ensures that straight lines remain
2823 straight, but the scale of the distorted image will vary. The horizon
2824 is anti-aliased, and the 'sky' color may be set using the
Cristyb7f455a2017-03-03 19:30:34 -05002825 <a href="command-line-options.html#mattecolor" >-mattecolor</a> setting. </td>
Cristy882d9f42015-10-29 16:48:39 -04002826 </tr>
2827
2828 <tr>
2829 <td>PerspectiveProjection </td>
2830 <td>
2831 Do a 'Perspective' distortion biased on a set of 8
2832 pre-calculated coefficients. You can get these coefficients by looking
Cristy594d2772015-11-15 10:47:42 -05002833 at the <a href="command-line-options.html#verbose" >-verbose</a> output of a
Cristy882d9f42015-10-29 16:48:39 -04002834 'Perspective' distortion, or by calculating them yourself.
2835 If the last two perspective scaling coefficients are zero, the
2836 remaining 6 represents a transposed 'Affine Matrix'. </td>
2837
2838 </tr>
2839
2840 <tr>
2841 <td>Arc</td>
2842 <td>
2843 Arc the image (variation of polar mapping) over the angle given around
2844 a circle.
2845
Cristy579a0cb2016-11-26 12:27:17 -05002846 <dl class="dl-horizontal">
Cristy882d9f42015-10-29 16:48:39 -04002847 <dt>arc_angle</dt>
2848 <dd>The angle over which to arc the image side-to-side</dd>
2849 <dt>rotate_angle</dt>
2850 <dd>Angle to rotate resulting image from vertical center</dd>
2851 <dt>top_radius</dt>
2852 <dd>Set top edge of source image at this radius</dd>
2853 <dt>bottom_radius </dt>
2854 <dd>Set bottom edge to this radius (radial scaling)</dd>
Cristy579a0cb2016-11-26 12:27:17 -05002855 </dl>
Cristy882d9f42015-10-29 16:48:39 -04002856
2857 The resulting image is always resized to best fit the resulting image,
Cristy594d2772015-11-15 10:47:42 -05002858 (as if using <a href="command-line-options.html#distort" >+distort</a>) while attempting to
Cristy882d9f42015-10-29 16:48:39 -04002859 preserve scale and aspect ratio of the original image as much as
2860 possible with the arguments given by the user. All four arguments will
Cristy594d2772015-11-15 10:47:42 -05002861 be needed to change the overall aspect ratio of an 'Arc'ed image. <br/>
Cristy882d9f42015-10-29 16:48:39 -04002862
2863 This a variation of a polar distortion designed to try to preserve the
2864 aspect ratio of the image rather than direct Cartesian to Polar
2865 conversion. </td>
2866 </tr>
2867
2868 <tr>
2869 <td>Polar</td>
2870 <td>
2871 Like 'Arc' but do a complete Cartesian to Polar mapping of
2872 the image. that is the height of the input image is mapped to the
2873 radius limits, while the width is wrapped around between the
Cristy594d2772015-11-15 10:47:42 -05002874 angle limits. <br/>
Cristy882d9f42015-10-29 16:48:39 -04002875
Cristy594d2772015-11-15 10:47:42 -05002876 Arguments: <var>Rmax,Rmin CenterX,CenterY, start,end_angle</var> <br/>
Cristy882d9f42015-10-29 16:48:39 -04002877
2878 All arguments are optional. With <var>Rmin</var> defaulting to zero, the
2879 center to the center of the image, and the angles going from -180 (top)
2880 to +180 (top). If <var>Rmax</var> is given the special value of
2881 '0', the the distance from the center to the nearest edge
2882 is used for the radius of the output image, which will ensure the whole
2883 image is visible (though scaled smaller). However a special value of
2884 '-1' will use the distance from the center to the furthest
2885 corner, This may 'clip' the corners from the input rectangular image,
2886 but will generate the exact reverse of a 'DePolar' with
Cristy594d2772015-11-15 10:47:42 -05002887 the same arguments. <br/>
Cristy882d9f42015-10-29 16:48:39 -04002888
Cristy594d2772015-11-15 10:47:42 -05002889 If the plus form of distort (<a href="command-line-options.html#distort" >+distort</a>) is used
Cristy882d9f42015-10-29 16:48:39 -04002890 output image center will default to 0,0 of the virtual
2891 canvas, and the image size adjusted to ensure the whole input image is
2892 made visible in the output image on the virtual canvas. </td>
2893
2894 </tr>
2895
2896 <tr>
2897 <td>DePolar</td>
2898 <td>
2899 Uses the same arguments and meanings as a 'Polar' distortion
Cristy594d2772015-11-15 10:47:42 -05002900 but generates the reverse Polar to Cartesian distortion. <br/>
Cristy882d9f42015-10-29 16:48:39 -04002901
2902 The special <var>Rmax</var> setting of '0' may however clip
2903 the corners of the input image. However using the special
2904 <var>Rmax</var> setting of '-1' (maximum center to corner
2905 distance) will ensure the whole distorted image is preserved in the
2906 generated result, so that the same argument to 'Polar' will
2907 reverse the distortion re-producing the original.
2908
2909 Note that as this distortion requires the area resampling of a circular
2910 arc, which can not be handled by the builtin EWA resampling function.
2911 As such the normal EWA filters are turned off. It is recommended some
2912 form of 'super-sampling' image processing technique be used to produce
2913 a high quality result. </td>
2914
2915 </tr>
2916
2917 <tr>
2918 <td>Barrel</td>
2919 <td>
Cristy594d2772015-11-15 10:47:42 -05002920 Given the four coefficients (A,B,C,D) as defined by <a
2921 href="http://wiki.panotools.org/Lens_correction_model" >Helmut
Cristy882d9f42015-10-29 16:48:39 -04002922 Dersch</a>, perform a barrel or pin-cushion distortion appropriate to
2923 correct radial lens distortions. That is in photographs, make straight
Cristy594d2772015-11-15 10:47:42 -05002924 lines straight again. <br/>
Cristy882d9f42015-10-29 16:48:39 -04002925
2926 <p class="text-center">Arguments: <var>A B C</var> [ <var>D</var> [
Cristy594d2772015-11-15 10:47:42 -05002927 <var>X</var> , <var>Y</var> ] ] <br/>
Cristy882d9f42015-10-29 16:48:39 -04002928 or <var>A<sub>x</sub> B<sub>x</sub> C<sub>x</sub> D<sub>x</sub>
2929 A<sub>y</sub> B<sub>y</sub> C<sub>y</sub> D<sub>y</sub></var>
2930 [ <var>X</var> , <var>Y</var> ] </p>
2931 So that it forms the function
2932 <p class="text-center">Rsrc = r * ( <var>A</var>*r<sup>3</sup> + <var>B</var>*r<sup>2</sup> +
2933 <var>C</var>*r + <var>D</var> )</p>
2934
2935 Where <var>X</var>,<var>Y</var> is the optional center of the distortion
Cristy594d2772015-11-15 10:47:42 -05002936 (defaulting to the center of the image). <br/>
Cristy882d9f42015-10-29 16:48:39 -04002937 The second form is typically used to distort images, rather than
Cristy594d2772015-11-15 10:47:42 -05002938 correct lens distortions. <br/>
Cristy882d9f42015-10-29 16:48:39 -04002939 </td>
2940
2941 </tr>
2942
2943 <tr>
2944 <td>BarrelInverse</td>
2945 <td>
2946 This is very similar to 'Barrel' with the same set of
2947 arguments, and argument handling. However it uses the inverse
2948 of the radial polynomial,
2949 so that it forms the function
2950 <p class="text-center">Rsrc = r / ( <var>A</var>*r<sup>3</sup> + <var>B</var>*r<sup>2</sup> +
2951 <var>C</var>*r + <var>D</var> )</p>
2952 Note that this is not the reverse of the 'Barrel'
2953 distortion, just a different barrel-like radial distortion method.
2954
2955 </td>
2956 </tr>
2957
2958 <tr>
2959 <td>Shepards</td>
2960 <td>
2961 Distort the given list control points (any number) using an Inverse
Cristy594d2772015-11-15 10:47:42 -05002962 Squared Distance Interpolation Method (<a
2963 href="http://en.wikipedia.org/wiki/Shepard%27s_method" >Shepards
Cristy882d9f42015-10-29 16:48:39 -04002964 Method</a>). The control points in effect do 'localized' displacement
2965 of the image around the given control point (preserving the look and
2966 the rotation of the area near the control points. For best results
2967 extra control points should be added to 'lock' the positions of the
2968 corners, edges and other unchanging parts of the image, to prevent
Cristy594d2772015-11-15 10:47:42 -05002969 their movement. <br/>
Cristy882d9f42015-10-29 16:48:39 -04002970
2971 The distortion has been likened to 'taffy pulling' using nails, or
2972 pins' stuck in a block of 'jelly' which is then moved to the new
Cristy594d2772015-11-15 10:47:42 -05002973 position, distorting the surface of the jelly. <br/>
Cristy882d9f42015-10-29 16:48:39 -04002974
Cristy594d2772015-11-15 10:47:42 -05002975 Internally it is equivalent to generating a displacement map (see <a
2976 href="command-line-options.html#displace" >-displace</a>) for source image color look-up using
2977 the <a href="command-line-options.html#sparse-color" >-sparse-color</a> method of the same name.
Cristy882d9f42015-10-29 16:48:39 -04002978
2979 </td>
2980 </tr>
2981
2982</table>
2983
2984<p>To print a complete list of distortion methods, use <a href="command-line-options.html#list">-list
2985distort</a>.</p>
2986
2987<p>Many of the above distortion methods such as '<code>Affine</code>',
2988'<code>Perspective</code>', and '<code>Shepards</code>' use a list control points
2989defining how these points in the given image should be distorted in the
2990destination image. Each set of four floating point values represent a source
2991image coordinate, followed immediately by the destination image coordinate.
2992This produces a list of values such as...</p>
2993<p class="text-center"><var>
2994 U<sub>1</sub>,V<sub>1</sub> X<sub>1</sub>,Y<sub>1</sub>
2995 U<sub>2</sub>,V<sub>2</sub> X<sub>2</sub>,Y<sub>2</sub>
2996 U<sub>3</sub>,V<sub>3</sub> X<sub>3</sub>,Y<sub>3</sub>
2997 ...
2998 U<sub>n</sub>,V<sub>n</sub> X<sub>n</sub>,Y<sub>n</sub>
2999</var></p>
3000<p>where <var>U,V</var> on the source image is mapped to <var>X,Y</var> on the
3001destination image. </p>
3002
3003<p>For example, to warp an image using '<code>perspective</code>' distortion,
3004needs a list of at least 4 sets of coordinates, or 16 numbers. Here is the
3005perspective distortion of the built-in "rose:" image. Note how spaces were
3006used to group the 4 sets of coordinate pairs, to make it easier to read and
3007understand.</p>
3008
3009<pre>
3010convert rose: -virtual-pixel black \
3011 -distort Perspective '0,0,0,0 0,45,0,45 69,0,60,10 69,45,60,35' \
3012 rose_3d_rotated.gif"
3013</pre>
3014
3015<p>If more that the required number of coordinate pairs are given for
3016a distortion, the distortion method is 'least squares' fitted to produce the
3017best result for all the coordinate pairs given. If less than the ideal number
3018of points are given, the distort will generally fall back to a simpler form of
3019distortion that can handles the smaller number of coordinates (usually a linear
3020'<code>Affine</code>' distortion). </p>
3021
3022<p>By using more coordinates you can make use of image registration tool to
3023find matching coordinate pairs in overlapping images, so as to improve the
3024'fit' of the distortion. Of course a bad coordinate pair can also make the
3025'fit' worse. Caution is always advised. </p>
3026
3027<p>Colors are acquired from the source image according to a cylindrical
Cristy594d2772015-11-15 10:47:42 -05003028resampling <a href="command-line-options.html#filter" >-filter</a>, using a special technique known as
Cristy882d9f42015-10-29 16:48:39 -04003029EWA resampling. This produces very high quality results, especially when
3030images become smaller (minified) in the output, which is very common when
3031using '<code>perspective</code>' distortion. For example here we view
3032a infinitely tiled 'plane' all the way to the horizon. </p>
3033
3034<pre>
3035convert -size 90x90 pattern:checkerboard -normalize -virtual-pixel tile \
3036 -distort perspective '0,0,5,45 89,0,45,46 0,89,0,89 89,89,89,89' \
3037 checks_tiled.jpg
3038</pre>
3039
3040<p>Note that a infinitely tiled perspective images involving the horizon can
3041be very slow, because of the number of pixels that are compressed to generate
3042each individual pixel close to the 'horizon'. You can turn off EWA
Cristy594d2772015-11-15 10:47:42 -05003043resampling, by specifying the special <a href="command-line-options.html#filter" >-filter</a> setting of
Cristy882d9f42015-10-29 16:48:39 -04003044'<code>point</code>' (recommended if you plan to use super-sampling instead).
3045</p>
3046
3047<p>If an image generates <i>invalid pixels</i>, such as the 'sky' in the last
Cristy594d2772015-11-15 10:47:42 -05003048example, <a href="command-line-options.html#distort" >-distort</a> will use the current <a
Cristyb7f455a2017-03-03 19:30:34 -05003049href="command-line-options.html#mattecolor" >-mattecolor</a> setting for these pixels. If you do not
Cristy882d9f42015-10-29 16:48:39 -04003050what these pixels to be visible, set the color to match the rest of the
3051ground. </p>
3052
3053<p>The output image size will by default be the same as the input image. This
3054means that if the part of the distorted image falls outside the viewed area of
3055the 'distorted space', those parts is clipped and lost. However if you use
Cristy594d2772015-11-15 10:47:42 -05003056the plus form of the operator (<a href="command-line-options.html#distort" >+distort</a>) the operator
Cristy882d9f42015-10-29 16:48:39 -04003057will attempt (if possible) to show the whole of the distorted image, while
3058retaining a correct 'virtual canvas' offset, for image layering. This offset
Cristy594d2772015-11-15 10:47:42 -05003059may need to be removed using <a href="command-line-options.html#repage" >+repage</a>, to remove if it
Cristy882d9f42015-10-29 16:48:39 -04003060is unwanted. </p>
3061
Cristy594d2772015-11-15 10:47:42 -05003062<p>Setting <a href="command-line-options.html#verbose" >-verbose</a> setting, will cause <a
3063href="command-line-options.html#distort" >-distort</a> to attempt to output the internal coefficients,
3064and the <a href="command-line-options.html#fx" >-fx</a> equivalent to the distortion, for expert study,
Cristy882d9f42015-10-29 16:48:39 -04003065and debugging purposes. This many not be available for all distorts. </p>
3066
Cristy594d2772015-11-15 10:47:42 -05003067<p>You can alternatively specify a special "<code><a href="command-line-options.html#define"
3068>-define</a> distort:viewport={geometry_string}</code>" setting which will
Cristy882d9f42015-10-29 16:48:39 -04003069specify the size and the offset of the generated 'viewport' image of the
3070distorted image space.</p>
3071
Cristy594d2772015-11-15 10:47:42 -05003072<p>Setting a "<code><a href="command-line-options.html#define" >-define</a>
Cristy769d8892016-01-19 18:11:14 -05003073distort:scale=<var>scale_factor</var></code>" will scale the output image (viewport or
Cristy882d9f42015-10-29 16:48:39 -04003074otherwise) by that factor without changing the viewed contents of the
3075distorted image. This can be used either for 'super-sampling' the image for
3076a higher quality result, or for panning and zooming around the image (with
3077appropriate viewport changes, or post-distort cropping and resizing). </p>
3078
Cristy594d2772015-11-15 10:47:42 -05003079<p>Setting "<code><a href="command-line-options.html#define" >-define</a> resample:verbose=1</code>"
Cristy882d9f42015-10-29 16:48:39 -04003080will output the cylindrical filter lookup table created by the EWA (Elliptical
3081Weighted Average) resampling algorithm. Note this table uses a squared radius
3082lookup value. This is typically only used for debugging EWA resampling. </p>
3083
3084
3085<div style="margin: auto;">
3086 <h3 class="magick-header"><a id="distribute-cache"></a>-distribute-cache <var>port</var></h3>
3087</div>
3088
3089<p class="magick-description">launch a distributed pixel cache server. </p>
3090
3091<div style="margin: auto;">
3092 <h3 class="magick-header"><a id="dither"></a>-dither <var>method</var></h3>
3093</div>
3094
3095<p class="magick-description">Apply a Riemersma or Floyd-Steinberg error diffusion dither to
3096images when general color reduction is applied via an option, or automagically
3097when saving to specific formats. This enabled by default.</p>
3098
3099<p>Dithering places two or more colors in neighboring pixels so that to the
3100eye a closer approximation of the images original color is reproduced. This
3101reduces the number of colors needed to reproduce the image but at the cost of
3102a lower level pattern of colors. Error diffusion dithers can use any set of
3103colors (generated or user defined) to an image. </p>
3104
3105<p>Dithering is turned on by default, to turn it off use the plus form of the
3106setting, <a href="command-line-options.html#dither">+dither</a>. This will also also render PostScript
3107without text or graphic aliasing. Disabling dithering often (but not always)
3108leads to faster process, a smaller number of colors, but more cartoon like
3109image coloring. Generally resulting in 'color banding' effects in areas with
3110color gradients. </p>
3111
Cristy594d2772015-11-15 10:47:42 -05003112<p>The color reduction operators <a href="command-line-options.html#colors">-colors</a>, <a
3113href="command-line-options.html#monochrome">-monochrome</a>, <a href="command-line-options.html#remap ">-remap</a>, and <a
3114href="command-line-options.html#posterize">-posterize</a>, apply dithering to images using the reduced
Cristy882d9f42015-10-29 16:48:39 -04003115color set they created. These operators are also used as part of automatic
3116color reduction when saving images to formats with limited color support, such
3117as <code>GIF:</code>, <code>XBM:</code>, and others, so dithering may also be used
3118in these cases. </p>
3119
3120<p>Alternatively you can use <a href="command-line-options.html#random-threshold">-random-threshold</a>
Cristy594d2772015-11-15 10:47:42 -05003121to generate purely random dither. Or use <a
3122href="command-line-options.html#ordered-dither">-ordered-dither</a> to apply threshold mapped dither
Cristy882d9f42015-10-29 16:48:39 -04003123patterns, using uniform color maps, rather than specific color maps. </p>
3124
3125
3126<div style="margin: auto;">
3127 <h3 class="magick-header"><a id="draw"></a>-draw <var>string</var></h3>
3128</div>
3129
3130<p class="magick-description">Annotate an image with one or more graphic primitives.</p>
3131
3132<p>Use this option to annotate or decorate an image with one or more graphic
3133primitives. The primitives include shapes, text, transformations, and pixel
3134operations.</p>
3135
3136<p>The shape primitives:</p>
3137
3138<dl class="dl-horizontal">
3139<dt>point</dt><dd> x,y</dd>
3140<dt>line</dt><dd> x0,y0 x1,y1</dd>
3141<dt>rectangle</dt><dd> x0,y0 x1,y1</dd>
3142<dt>roundRectangle</dt><dd> x0,y0 x1,y1 wc,hc</dd>
3143<dt>arc</dt><dd> x0,y0 x1,y1 a0,a1</dd>
3144<dt>ellipse</dt><dd> x0,y0 rx,ry a0,a1</dd>
3145<dt>circle</dt><dd> x0,y0 x1,y1</dd>
3146<dt>polyline</dt><dd> x0,y0 ... xn,yn</dd>
3147<dt>polygon</dt><dd> x0,y0 ... xn,yn</dd>
3148<dt>bezier</dt><dd> x0,y0 ... xn,yn</dd>
3149<dt>path</dt><dd>specification </dd>
3150<dt>image</dt><dd> operator x0,y0 w,h filename</dd>
3151</dl>
3152
3153<p>The text primitive:</p>
3154
3155<dl class="dl-horizontal">
3156<dt>text</dt><dd>x0,y0 string</dd>
3157</dl>
3158<p>The text gravity primitive:</p>
3159
3160<dl class="dl-horizontal">
3161<dt>gravity</dt><dd>NorthWest, North, NorthEast, West, Center, East, SouthWest, South, or SouthEast</dd>
3162</dl>
3163
3164<p>The text gravity primitive only affects the placement of text and does not
Cristy594d2772015-11-15 10:47:42 -05003165interact with the other primitives. It is equivalent to using the <a
3166href="command-line-options.html#gravity">-gravity</a> command-line option, except that it is limited in
Cristy882d9f42015-10-29 16:48:39 -04003167scope to the <a href="command-line-options.html#draw">-draw</a> option in which it appears.</p>
3168
3169<p>The transformation primitives:</p>
3170
3171<dl class="dl-horizontal">
3172<dt>rotate</dt><dd>degrees</dd>
3173<dt>translate</dt><dd>dx,dy</dd>
3174<dt>scale</dt><dd>sx,sy</dd>
3175<dt>skewX</dt><dd>degrees</dd>
3176<dt>skewY</dt><dd>degrees</dd>
3177</dl>
3178
3179<p>The pixel operation primitives:</p>
3180
3181<dl class="dl-horizontal">
3182<dt>color</dt><dd>x0,y0 method</dd>
3183<dt>matte</dt><dd>x0,y0 method</dd>
3184</dl>
3185
Cristy594d2772015-11-15 10:47:42 -05003186<p>The shape primitives are drawn in the color specified by the preceding <a
3187href="command-line-options.html#fill">-fill</a> setting. For unfilled shapes, use <a
3188href="command-line-options.html#fill">-fill none</a>. You can optionally control the stroke (the
3189"outline" of a shape) with the <a href="command-line-options.html#stroke">-stroke</a> and <a
3190href="command-line-options.html#strokewidth">-strokewidth</a> settings.</p>
Cristy882d9f42015-10-29 16:48:39 -04003191
3192<p>A <code>point</code> primitive is specified by a single <var>point</var> in the
3193pixel plane, that is, by an ordered pair of integer coordinates,
3194<var>x</var>,<var>y</var>. (As it involves only a single pixel, a <code>point</code>
Cristy594d2772015-11-15 10:47:42 -05003195primitive is not affected by <a href="command-line-options.html#stroke">-stroke</a> or <a
3196href="command-line-options.html#strokewidth">-strokewidth</a>.)</p>
Cristy882d9f42015-10-29 16:48:39 -04003197
3198<p>A <code>line</code> primitive requires a start point and end point.</p>
3199
3200<p>A <code>rectangle</code> primitive is specified by the pair of points at the
3201upper left and lower right corners.</p>
3202
3203<p>A <code>roundRectangle</code> primitive takes the same corner points as
3204a <code>rectangle</code> followed by the width and height of the rounded corners
3205to be removed.</p>
3206
3207<p>The <code>circle</code> primitive makes a disk (filled) or circle (unfilled).
3208Give the center and any point on the perimeter (boundary).</p>
3209
3210<p>The <code>arc</code> primitive is used to inscribe an elliptical segment in
3211to a given rectangle. An <code>arc</code> requires the two corners used for
3212<code>rectangle</code> (see above) followed by the start and end angles of the
3213arc of the segment segment (e.g. 130,30 200,100 45,90). The start and end
3214points produced are then joined with a line segment and the resulting segment
3215of an ellipse is filled.</p>
3216
3217<p>Use <code>ellipse</code> to draw a partial (or whole) ellipse. Give the
3218center point, the horizontal and vertical "radii" (the <var>semi-axes</var> of
3219the ellipse) and start and end angles in degrees (e.g. 100,100 100,150
32200,360).</p>
3221
3222<p>The <code>polyline</code> and <code>polygon</code> primitives require three or
3223more points to define their perimeters. A <code>polyline</code> is simply
3224a <code>polygon</code> in which the final point is not stroked to the start
Cristy594d2772015-11-15 10:47:42 -05003225point. When unfilled, this is a <var>polygonal line</var>. If the <a
3226href="command-line-options.html#stroke">-stroke</a> setting is <code>none</code> (the default), then
Cristy882d9f42015-10-29 16:48:39 -04003227a <code>polyline</code> is identical to a <code>polygon</code>. </p>
3228
3229<p>A <var>coordinate</var> is a pair of integers separated by a space or
3230optional comma. </p>
3231
3232<p>As an example, to define a circle centered at 100,100 that extends to
3233150,150 use:</p>
3234
3235<pre>
3236-draw 'circle 100,100 150,150'
3237</pre>
3238
3239<p>The <code>Bezier</code> primitive creates a spline curve and requires three
3240or points to define its shape. The first and last points are the
3241<var>knots</var> and these points are attained by the curve, while any
3242intermediate coordinates are <var>control points</var>. If two control points
3243are specified, the line between each end knot and its sequentially respective
3244control point determines the tangent direction of the curve at that end. If
3245one control point is specified, the lines from the end knots to the one
3246control point determines the tangent directions of the curve at each end. If
3247more than two control points are specified, then the additional control points
3248act in combination to determine the intermediate shape of the curve. In order
3249to draw complex curves, it is highly recommended either to use the
3250<code>path</code> primitive or to draw multiple four-point bezier segments with
3251the start and end knots of each successive segment repeated. For example:</p>
3252
3253<pre>
3254-draw 'bezier 20,50 45,100 45,0 70,50'
3255-draw 'bezier 70,50 95,100 95,0 120,50'
3256</pre>
3257
3258<p>A <code>path</code> represents an outline of an object, defined in terms of
3259moveto (set a new current point), lineto (draw a straight line), curveto (draw
3260a Bezier curve), arc (elliptical or circular arc) and closepath (close the
3261current shape by drawing a line to the last moveto) elements. Compound paths
3262(i.e., a path with subpaths, each consisting of a single moveto followed by
3263one or more line or curve operations) are possible to allow effects such as
Cristy594d2772015-11-15 10:47:42 -05003264<var>donut holes</var> in objects. (See <a
3265href="http://www.w3.org/TR/SVG/paths.html">Paths</a>.)</p>
Cristy882d9f42015-10-29 16:48:39 -04003266
3267<p>Use <code>image</code> to composite an image with another image. Follow the
3268image keyword with the composite operator, image location, image size, and
3269filename:</p>
3270
3271<pre>
3272-draw 'image SrcOver 100,100 225,225 image.jpg'
3273</pre>
3274
3275<p>You can use 0,0 for the image size, which means to use the actual
3276dimensions found in the image header. Otherwise, it is scaled to the given
Cristy6549abb2016-11-10 08:25:55 -05003277dimensions. See <a href="http://www.imagemagick.org/www/compose.html">Alpha Compositing</a> for
Cristy882d9f42015-10-29 16:48:39 -04003278a detailed discussion of alpha composition methods that are available. </p>
3279
3280<p>The "special augmented compose operators" such as "dissolve" that require
3281arguments cannot be used at present with the <code>-draw image</code> option.
3282 </p>
3283
3284<p>Use <code>text</code> to annotate an image with text. Follow the text
3285coordinates with a string. If the string has embedded spaces, enclose it in
3286single or double quotes.</p>
3287
3288<p>For example, the following annotates the image with <code>Works like
3289magick!</code> for an image titled <code>bird.miff</code>. </p>
3290
3291<pre>
3292-draw "text 100,100 'Works like magick!' "
3293</pre>
3294
3295<p>See the <a href="command-line-options.html#annotate">-annotate</a> option for another convenient way
3296to annotate an image with text.</p>
3297
3298<p>The <code>rotate</code> primitive rotates subsequent shape primitives and
Cristy594d2772015-11-15 10:47:42 -05003299text primitives about the origin of the main image. If the <a
3300href="command-line-options.html#region">-region</a> option precedes the <a href="command-line-options.html#draw">-draw</a>
Cristy882d9f42015-10-29 16:48:39 -04003301option, the origin for transformations is the upper left corner of the
3302region.</p>
3303
3304<p>The <code>translate</code> primitive translates subsequent shape and text
3305primitives.</p>
3306
3307<p>The <code>scale</code> primitive scales them.</p>
3308
3309<p>The <code>skewX</code> and <code>skewY</code> primitives skew them with respect
3310to the origin of the main image or the region.</p>
3311
3312<p>The transformations modify the current affine matrix, which is initialized
3313from the initial affine matrix defined by the <a href="command-line-options.html#affine">-affine</a>
3314option. Transformations are cumulative within the <a href="command-line-options.html#draw">-draw</a>
3315option. The initial affine matrix is not affected; that matrix is only changed
3316by the appearance of another <a href="command-line-options.html#affine">-affine</a> option. If another
3317<a href="command-line-options.html#draw">-draw</a> option appears, the current affine matrix is
3318reinitialized from the initial affine matrix.</p>
3319
3320<p>Use the <code>color</code> primitive to change the color of a pixel to the
3321fill color (see <a href="command-line-options.html#fill">-fill</a>). Follow the pixel coordinate with
3322a method:</p>
3323
3324<pre>
3325point
3326replace
3327floodfill
3328filltoborder
3329reset
3330</pre>
3331
3332<p>Consider the target pixel as that specified by your coordinate. The
3333<code>point</code> method recolors the target pixel. The <code>replace</code>
3334method recolors any pixel that matches the color of the target pixel.
3335<code>Floodfill</code> recolors any pixel that matches the color of the target
3336pixel and is a neighbor, whereas <code>filltoborder</code> recolors any neighbor
3337pixel that is not the border color. Finally, <code>reset</code> recolors all
3338pixels.</p>
3339
3340<p>Use <code>matte</code> to the change the pixel matte value to transparent.
3341Follow the pixel coordinate with a method (see the <code>color</code> primitive
3342for a description of methods). The <code>point</code> method changes the matte
3343value of the target pixel. The <code>replace</code> method changes the matte
3344value of any pixel that matches the color of the target pixel.
3345<code>Floodfill</code> changes the matte value of any pixel that matches the
3346color of the target pixel and is a neighbor, whereas <code>filltoborder</code>
Cristy594d2772015-11-15 10:47:42 -05003347changes the matte value of any neighbor pixel that is not the border color (<a
3348href="command-line-options.html#bordercolor">-bordercolor</a>). Finally <code>reset</code> changes the
Cristy882d9f42015-10-29 16:48:39 -04003349matte value of all pixels.</p>
3350
Cristy594d2772015-11-15 10:47:42 -05003351<p>You can set the primitive color, font, and font bounding box color with <a
3352href="command-line-options.html#fill">-fill</a>, <a href="command-line-options.html#font">-font</a>, and <a href="command-line-options.html#box">-box</a>
Cristy882d9f42015-10-29 16:48:39 -04003353respectively. Options are processed in command line order so be sure to use
3354these options <var>before</var> the <a href="command-line-options.html#draw">-draw</a> option.</p>
3355
3356<p>Strings that begin with a number must be quoted (e.g. use '1.png' rather
3357than 1.png).</p>
3358
Cristy594d2772015-11-15 10:47:42 -05003359<p>Drawing primitives conform to the <a href="magick-vector-graphics.html" >Magick
Cristy882d9f42015-10-29 16:48:39 -04003360Vector Graphics</a> format.</p>
3361
3362
3363<div style="margin: auto;">
3364 <h3 class="magick-header"><a id="duplicate"></a>-duplicate <var>count,indexes</var></h3>
3365</div>
3366
3367<p class="magick-description">duplicate an image one or more times.</p>
3368
3369<p>Specify the count and the image to duplicate by its index in the sequence.
3370The first image is index 0. Negative indexes are relative to the end of the
3371sequence, for example, -1 represents the last image of the sequence. Specify
3372a range of images with a dash (e.g. 0-4). Separate indexes with a comma (e.g.
33730,2). Use <code>+duplicate</code> to duplicate the last image in the current
3374image sequence.</p>
3375
3376<div style="margin: auto;">
3377 <h3 class="magick-header"><a id="edge"></a>-edge <var>radius</var></h3>
3378</div>
3379
3380<p class="magick-description">detect edges within an image.</p>
3381
3382<div style="margin: auto;">
3383 <h3 class="magick-header"><a id="emboss"></a>-emboss <var>radius</var></h3>
3384</div>
3385
3386<p class="magick-description">emboss an image.</p>
3387
3388<div style="margin: auto;">
3389 <h3 class="magick-header"><a id="encipher"></a>-encipher <var>filename</var></h3>
3390</div>
3391
3392<p class="magick-description">Encipher pixels for later deciphering by <a href="command-line-options.html#decipher">-decipher</a>.</p>
3393
3394<p>Get the passphrase from the file specified by <var>filename</var>.</p>
3395
Cristy594d2772015-11-15 10:47:42 -05003396<p>For more information, see the webpage, <a
Cristy6549abb2016-11-10 08:25:55 -05003397href="https://www.imagemagick.org/script/cipher.html">ImageMagick: Encipher or
Cristy882d9f42015-10-29 16:48:39 -04003398Decipher an Image</a>.</p>
3399
3400
3401
3402<div style="margin: auto;">
3403 <h3 class="magick-header"><a id="encoding"></a>-encoding <var>type</var></h3>
3404</div>
3405
3406<p class="magick-description">specify the text encoding.</p>
3407
3408<p>Choose from</p>
3409
3410<pre>
3411AdobeCustom AdobeExpert
3412AdobeStandard AppleRoman
3413BIG5 GB2312
3414Latin 2 None
3415SJIScode Symbol
3416Unicode Wansung
3417</pre>
3418
3419<div style="margin: auto;">
3420 <h3 class="magick-header"><a id="endian"></a>-endian <var>type</var></h3>
3421</div>
3422
3423<p class="magick-description">Specify endianness (<code>MSB</code> or <code>LSB</code>) of the image.</p>
3424
3425<p>To print a complete list of endian types, use the <a href="command-line-options.html#list">-list endian</a> option.</p>
3426
3427<p>Use <a href="command-line-options.html#endian">+endian</a> to revert to unspecified endianness.</p>
3428
3429
3430<div style="margin: auto;">
3431 <h3 class="magick-header"><a id="enhance"></a>-enhance</h3>
3432</div>
3433
3434<p class="magick-description">Apply a digital filter to enhance a noisy image.</p>
3435
3436
3437<div style="margin: auto;">
3438 <h3 class="magick-header"><a id="equalize"></a>-equalize</h3>
3439</div>
3440
3441<p class="magick-description">perform histogram equalization on the image channel-by-channel.</p>
3442
3443<p>To perform histogram equalization on all channels in concert, transform the
3444image into some other color space, such as HSL, OHTA, YIQ or YUV, then
3445equalize the appropriate intensity-like channel, then convert back to RGB.</p>
3446
3447<p>For example using HSL, we have: ... <code>-colorspace HSL -channel lightness
3448-equalize -colorspace RGB</code> ...</p>
3449
3450<p>For YIQ, YUV and OHTA use the red channel. For example, OHTA is a principal
3451components transformation that puts most of the information in the first
3452channel. Here we have ... <code>-colorspace OHTA -channel red -equalize
3453-colorspace RGB</code> ...</p>
3454
3455<div style="margin: auto;">
3456 <h3 class="magick-header"><a id="evaluate"></a>-evaluate <var>operator value</var></h3>
3457</div>
3458
3459<p class="magick-description">Alter channel pixels by evaluating an arithmetic, relational, or logical expression.</p>
3460
Cristy594d2772015-11-15 10:47:42 -05003461<p>(See the <a href="command-line-options.html#function" >-function</a> operator for some
3462multi-parameter functions. See the <a href="command-line-options.html#fx" >-fx</a> operator if more
Cristy882d9f42015-10-29 16:48:39 -04003463elaborate calculations are needed.)</p>
3464
3465<p>The behaviors of each <var>operator</var> are summarized in the
3466following list. For brevity, the numerical value of a "pixel" referred to
3467below is the value of the corresponding channel of that pixel, while
3468a "normalized pixel" is that number divided by the maximum
3469(installation-dependent) value <var>QuantumRange</var>. (If
3470normalized pixels are used, they are restored, following the other
3471calculations, to the full range by multiplying by <var>QuantumRange</var>.)</p>
3472
3473<table class="table table-condensed table-striped">
Cristy594d2772015-11-15 10:47:42 -05003474 <col width="25%" />
3475 <col width="75%" />
Cristy882d9f42015-10-29 16:48:39 -04003476 <thead>
3477 <tr>
3478 <th><var>operator</var></th>
3479 <th>Summary (see further below for details)</th>
3480 </tr>
3481 </thead>
3482 <tbody>
3483
3484 <tr><td>Abs </td> <td>Add <var>value</var> to pixels and return absolute value. </td></tr>
3485 <tr><td>Add </td> <td>Add <var>value</var> to pixels. </td></tr>
3486 <tr><td>AddModulus </td> <td>Add <var>value</var> to pixels modulo <var>QuantumRange</var>.</td></tr>
3487 <tr><td>And </td> <td>Binary AND of pixels with <var>value</var>.</td></tr>
3488 <tr><td>Cos, Cosine </td> <td>Apply cosine to pixels with frequency <var>value</var> with 50% bias added.</td></tr>
3489 <tr><td>Divide </td> <td>Divide pixels by <var>value</var>.</td></tr>
3490 <tr><td>Exp </td> <td>base-e exponential function</td></tr>
3491 <tr><td>Exponential </td> <td>base-e exponential function</td></tr>
3492 <tr><td>LeftShift </td> <td>Shift the pixel values left by <var>value</var> bits (i.e., multiply pixels by 2<sup><var>value</var></sup>).</td></tr>
3493 <tr><td>Log </td> <td>Apply scaled logarithm to normalized pixels.</td></tr>
3494 <tr><td>Max </td> <td>Set pixels to maximum of <var>value</var> and current pixel <var>value</var> (i.e. set any pixels currently less than <var>value</var> to <var>value</var>).</td></tr>
3495 <tr><td>Mean </td> <td>Add the <var>value</var> and divide by 2.</td></tr>
3496 <tr><td>Median </td> <td>Choose the median value from an image sequence.</td></tr>
3497 <tr><td>Min </td> <td>Set pixels to minimum of <var>value</var> and current pixel <var>value</var> (i.e. set any pixels currently greater than <var>value</var> to <var>value</var>).</td></tr>
3498 <tr><td>Multiply </td> <td>Multiply pixels by <var>value</var>.</td></tr>
3499 <tr><td>Or </td> <td>Binary OR of pixels with <var>value</var>.</td></tr>
3500 <tr><td>Pow </td> <td>Raise normalized pixels to the power <var>value</var>.</td></tr>
3501 <tr><td>RightShift </td> <td>Shift the pixel values right by <var>value</var> bits (i.e., divide pixels by 2<sup><var>value</var></sup>).</td></tr>
3502 <tr><td>RMS</td> <td>Square the pixel and add the <var>value</var>.</td></tr>
3503 <tr><td>RootMeanSquare</td> <td>Square the pixel and add the <var>value</var>.</td></tr>
3504 <tr><td>Set </td> <td>Set pixel equal to <var>value</var>.</td></tr>
3505 <tr><td>Sin, Sine </td> <td>Apply sine to pixels with frequency <var>value</var> with 50% bias added.</td></tr>
3506 <tr><td>Subtract </td> <td>Subtract <var>value</var> from pixels.</td></tr>
3507 <tr><td>Xor </td> <td>Binary XOR of pixels with <var>value.</var></td></tr>
3508
3509 <tr><td> </td><td> </td></tr>
3510
3511 <tr><td>Gaussian-noise</td><td> </td></tr>
3512 <tr><td>Impulse-noise</td><td> </td></tr>
3513 <tr><td>Laplacian-noise</td><td> </td></tr>
Cristy594d2772015-11-15 10:47:42 -05003514 <tr><td>Multiplicative-noise</td> <td>(These are equivalent to the corresponding <a href="command-line-options.html#noise" >-noise</a> operators.)</td></tr>
Cristy882d9f42015-10-29 16:48:39 -04003515 <tr><td>PoissonNoise</td><td> </td></tr>
3516 <tr><td>Uniform-noise</td><td> </td></tr>
3517
3518 <tr><td> </td><td> </td></tr>
3519
3520 <tr><td>Threshold </td> <td>Threshold pixels larger than <var>value</var>.</td></tr>
3521 <tr><td>ThresholdBlack </td> <td>Threshold pixels to zero values equal to or below <var>value</var>.</td></tr>
3522 <tr><td>ThresholdWhite </td> <td>Threshold pixels to maximum values above <var>value</var>. </td></tr>
3523 </tbody>
3524 </table>
3525
Cristy594d2772015-11-15 10:47:42 -05003526<p>The specified functions are applied only to each previously set <a
3527href="command-line-options.html#channel" >-channel</a> in the image. If necessary, the results of the
Cristy882d9f42015-10-29 16:48:39 -04003528calculations are truncated (clipped) to fit in the interval [0, <var>QuantumRange</var>]. The transparency channel of the image is
3529represented as a 'alpha' values (0 = fully transparent), so, for example, a
3530<code>Divide</code> by 2 of the alpha channel will make the image
3531semi-transparent. Append the percent symbol '<code>%</code>' to specify a value
3532as a percentage of the <var>QuantumRange</var>.</p>
3533
3534<p>To print a complete list of <a href="command-line-options.html#evaluate">-evaluate</a> operators, use
3535<a href="command-line-options.html#list">-list evaluate</a>.</p>
3536
3537<p>The results of the <code>Add</code>, <code>Subtract</code> and
Cristy594d2772015-11-15 10:47:42 -05003538<code>Multiply</code> methods can also be achieved using either the <a
3539href="command-line-options.html#level" >-level</a> or the <a href="command-line-options.html#level" >+level</a> operator, with
Cristy882d9f42015-10-29 16:48:39 -04003540appropriate argument, to linearly modify the overall range of color values.
Cristy594d2772015-11-15 10:47:42 -05003541Please note, however, that <a href="command-line-options.html#level" >-level</a> treats transparency as
3542'matte' values (0 = opaque), while <a href="command-line-options.html#level" >-evaluate</a> works with
Cristy882d9f42015-10-29 16:48:39 -04003543'alpha' values.</p>
3544
3545<p><code>AddModulus</code> has been added as of ImageMagick 6.4.8-4 and provides
3546addition modulo the <var>QuantumRange</var>. It is therefore
3547equivalent to <code>Add</code> unless the resulting pixel value is outside the
3548interval [0, <var>QuantumRange</var>]. </p>
3549
3550<p><code>Exp or Exponential</code> has been added as of ImageMagick 6.6.5-1 and
3551works on normalized pixel values. The <var>value</var> used with
3552<code>Exp</code> should be negative so as to produce a decaying exponential
3553function. Non-negative values will always produce results larger unity and
3554thus outside the interval [0, <var>QuantumRange</var>]. The
3555formula is expressed below. </p>
3556
3557<p class="text-center">
3558exp(<var>value</var> × <b><var>u</var></b>)
3559</p>
3560
Cristy594d2772015-11-15 10:47:42 -05003561<p> If the input image is squared, for example, using <a href="command-line-options.html#-function"
3562>-function polynomial "2 0 0"</a>, then a decaying Gaussian function will be
Cristy882d9f42015-10-29 16:48:39 -04003563the result.</p>
3564
3565<p><code>Log</code> has been added as of ImageMagick 6.4.2-1 and works on
3566normalized pixel values. This a <var>scaled</var> log function. The <var>value</var> used with <code>Log</code> provides a <var>scaling
3567factor</var> that adjusts the curvature in the graph of the log function. The
3568formula applied to a normalized value <b><var>u</var></b> is below. </p>
3569
3570<p class="text-center">
3571log(<var>value</var> × <b><var>u</var></b> + 1) / log(<var>value</var> + 1)
3572</p>
3573
3574<p><code>Pow</code> has been added as of ImageMagick 6.4.1-9, and works on
Cristy594d2772015-11-15 10:47:42 -05003575normalized pixel values. Note that <code>Pow</code> is related to the <a
3576href="command-line-options.html#gamma" >-gamma</a> operator. For example, <b>-gamma 2</b> is equivalent
Cristy882d9f42015-10-29 16:48:39 -04003577to <b>-evaluate pow 0.5</b>, i.e., a 'square root' function. The value used
Cristy594d2772015-11-15 10:47:42 -05003578with <a href="command-line-options.html#gamma" >-gamma</a> is simply the reciprocal of the value used
Cristy882d9f42015-10-29 16:48:39 -04003579with <code>Pow</code>.</p>
3580
3581<p><code>Cosine</code> and <code>Sine</code> was added as of IM v6.4.8-8 and
3582converts the image values into a value according to a (co)sine wave function.
3583The synonyms <code>Cos</code> and <code>Sin</code> may also be used. The output
3584is biased 50% and normalized by 50% so as to fit in the respective color value
3585range. The <var>value</var> scaling of the <var>period</var> of the
3586function (its frequency), and thus determines the number of 'waves' that will
3587be generated over the input color range. For example, if the <var>value</var> is 1, the effective period is simply the <var>QuantumRange</var>; but if the <var>value</var> is 2,
3588then the effective period is the <var>half</var> the <var>QuantumRange</var>.</p>
3589
3590<p class="text-center">
35910.5 + 0.5 × cos(2 π <b><var>u</var></b> × <var>value</var>).
3592</p>
3593
Cristy594d2772015-11-15 10:47:42 -05003594<p>See also the <a href="command-line-options.html#function" >-function</a> operator, which is a
Cristy882d9f42015-10-29 16:48:39 -04003595multi-value version of evaluate. </p>
3596
3597<div style="margin: auto;">
3598 <h3 class="magick-header"><a id="evaluate-sequence"></a>-evaluate-sequence <var>operator</var></h3>
3599</div>
3600
3601<p class="magick-description">Alter channel pixels by evaluating an arithmetic, relational, or
3602logical expression over a sequence of images.</p>
3603
Cristy594d2772015-11-15 10:47:42 -05003604<p>To print a complete list of <a
3605href="command-line-options.html#evaluate-sequence">-evaluate-sequence</a> operators, use <a
3606href="command-line-options.html#list">-list evaluate</a>.</p>
Cristy882d9f42015-10-29 16:48:39 -04003607
3608<div style="margin: auto;">
3609 <h3 class="magick-header"><a id="extent"></a>-extent <var>geometry</var></h3>
3610</div>
3611
3612<p class="magick-description">Set the image size and offset.</p>
3613
3614<p>If the image is enlarged, unfilled areas are set to the background color.
3615To position the image, use offsets in the <var>geometry</var>
3616specification or precede with a <a href="command-line-options.html#gravity">-gravity</a> setting. To
Cristy594d2772015-11-15 10:47:42 -05003617specify how to compose the image with the background, use <a href="command-line-options.html#compose"
3618>-compose</a>.</p>
Cristy882d9f42015-10-29 16:48:39 -04003619
3620<p>This command reduces or expands a JPEG image to fit on an 800x600
3621display. If the aspect ratio of the input image isn't exactly 4:3, then the
3622image is centered on an 800x600 black canvas: </p>
3623
3624<pre>
3625convert input.jpg -resize 800x600 -background black -compose Copy \
3626 -gravity center -extent 800x600 -quality 92 output.jpg
3627</pre>
3628
3629<p>See <a href="command-line-processing.html#geometry">Image Geometry</a> for complete details about the <em class="arg">geometry</em> argument.</p>
3630
3631<div style="margin: auto;">
3632 <h3 class="magick-header"><a id="extract"></a>-extract <var>geometry</var></h3>
3633</div>
3634
3635<p class="magick-description">Extract the specified area from image.</p>
3636
3637<p>This option is most useful for extracting a subregion of a very large raw
3638image. Note that these two commands are equivalent:</p>
3639
3640<pre>
3641convert -size 16000x16000 -depth 8 -extract 640x480+1280+960 \
3642 image.rgb image.png",
3643convert -size 16000x16000 -depth 8 'image.rgb[640x480+1280+960]' \
3644 image.rgb image.png"
3645</pre>
3646
3647<p>If you omit the offsets, as in</p>
3648
3649<pre>
3650convert -size 16000x16000 -depth 8 -extract 640x480 \
3651 image.rgb image.png
3652</pre>
3653
3654<p>the image is <var>resized</var> to the specified dimensions instead,
3655equivalent to:</p>
3656
3657<pre>
3658convert -size 16000x16000 -depth 8 -resize 640x480 image.rgb image.png
3659</pre>
3660
3661<p>See <a href="command-line-processing.html#geometry">Image Geometry</a> for complete details about the <em class="arg">geometry</em> argument.</p>
3662
3663<div style="margin: auto;">
3664 <h3 class="magick-header"><a id="family"></a>-family <var>fontFamily</var></h3>
3665</div>
3666
3667<p class="magick-description">Set a font family for text.</p>
3668
3669<p>This setting suggests a font family that ImageMagick should try to use for
3670rendering text. If the family can be found it is used; if not, a default font
3671(e.g., "Arial") or a family known to be similar is substituted (e.g.,
3672"Courier" might be used if "System" is requested but not found). </p>
3673
Cristy594d2772015-11-15 10:47:42 -05003674<p>For other settings that affect fonts, see the options <a
3675href="command-line-options.html#font">-font</a>, <a href="command-line-options.html#stretch">-stretch</a>, <a
3676href="command-line-options.html#style">-style</a>, and <a href="command-line-options.html#weight">-weight</a>. </p>
Cristy882d9f42015-10-29 16:48:39 -04003677
3678<div style="margin: auto;">
3679 <h3 class="magick-header"><a id="features"></a>-features <var>distance</var></h3>
3680</div>
3681
3682<p class="magick-description">display (co-occurrence matrix) texture measure features for each channel in the image in each of four directions (horizontal, vertical, left and right diagonals) for the specified distance.</p>
3683
3684<pre>
3685Angular Second Moment Sum Entropy
3686Contrast Entropy
3687Correlation Difference Variance
3688Sum of Squares Variance Difference Entropy
3689Inverse Difference Moment Information Measure of Correlation 1
3690Sum Average Information Measure of Correlation 2
3691Sum Variance Maximum Correlation Coefficient
3692</pre>
3693
3694<div style="margin: auto;">
3695 <h3 class="magick-header"><a id="fft"></a>-fft</h3>
3696</div>
3697
3698<p class="magick-description">implements the forward discrete Fourier transform (DFT).</p>
3699
3700<p>This option is new as of ImageMagick 6.5.4-3 (and now working for Windows
3701users in ImageMagick 6.6.0-9). It transforms an image from the normal
3702(spatial) domain to the frequency domain. In the frequency domain, an image is
3703represented as a superposition of complex sinusoidal waves of varying
3704amplitudes. The image x and y coordinates are the possible frequencies along
3705the x and y directions, respectively, and the pixel intensity values are
3706complex numbers that correspond to the sinusoidal wave amplitudes. See for
3707example, <a href="http://en.wikipedia.org/wiki/Fourier_transform">Fourier
3708Transform</a>, <a href="http://en.wikipedia.org/wiki/DFT">Discrete Fourier
3709Transform</a> and <a href="http://en.wikipedia.org/wiki/FFT">Fast Fourier
3710Transform</a>.</p>
3711
3712<p>A single image name is provided as output for this option. However, the
3713output result will have two components. It is either a two-frame image or two
3714separate images, depending upon whether the image format specified supports
3715multi-frame images. The reason that we get a dual output result is because the
3716frequency domain represents an image using complex numbers, which cannot be
3717visualized directly. Therefore, the complex values are automagically separated
3718into a two-component image representation. The first component is the
3719magnitude of the complex number and the second is the phase of the complex
Cristy594d2772015-11-15 10:47:42 -05003720number. See for example, <a
3721href="http://en.wikipedia.org/wiki/Complex_numbers">Complex Numbers</a>.</p>
Cristy882d9f42015-10-29 16:48:39 -04003722
3723<p>The magnitude and phase component images must be specified using image
3724formats that do not limit the color or compress the image. Thus, MIFF, TIF,
3725PFM, EXR and PNG are the recommended image formats to use. All of these
3726formats, except PNG support multi-frame images. So for example,</p>
3727
3728<pre>
3729convert image.png -fft fft_image.miff
3730</pre>
3731
3732<p>generates a magnitude image as <code>fft_image.miff[0]</code> and a phase
3733image as <code>fft_image.miff[1]</code>. Similarly,</p>
3734
3735<pre>
3736convert image.png -fft fft_image.png
3737</pre>
3738
3739<p>generates a magnitude image as <code>fft_image-0.png</code> and a phase image
3740as <code>fft_image-1.png</code>. If you prefer this representation, then you can
Cristy594d2772015-11-15 10:47:42 -05003741force any of the other formats to produce two output images by including <a
3742href="command-line-options.html#adjoin">+adjoin</a> following -fft in the command line.</p>
Cristy882d9f42015-10-29 16:48:39 -04003743
3744<p>The input image can be any size, but if not square and even-dimensioned, it
3745is padded automagically to the larger of the width or height of the input
3746image and to an even number of pixels. The padding will occur at the bottom
3747and/or right sides of the input image. The resulting output magnitude and
Cristy594d2772015-11-15 10:47:42 -05003748phase images is square at this size. The kind of padding relies on the <a
3749href="command-line-options.html#virtual-pixel">-virtual-pixel</a> setting.</p>
Cristy882d9f42015-10-29 16:48:39 -04003750
3751<p>Both output components will have dynamic ranges that fit within
3752[0, <var>QuantumRange</var>], so that HDRI need not be enabled.
3753Phase values nominally range from 0 to 2*π, but is scaled to span the full
3754dynamic range. (The first few releases had non-HDRI scaled but HDRI not
3755scaled). The magnitude image is not scaled and thus generally will contain
3756very small values. As such, the image normally will appear totally black. In
3757order to view any detail, the magnitude image typically is enhanced with a log
3758function into what is usually called the spectrum. A log function is used to
3759enhance the darker values more in comparison to the lighter values. This can
3760be done, for example, as follows:</p>
3761
3762<pre>
3763convert fft_image.miff[0] -contrast-stretch 0 \
3764 -evaluate log 1000 fft_image_spectrum.png"
3765</pre>
3766
Cristy594d2772015-11-15 10:47:42 -05003767<p>where either <a href="command-line-options.html#contrast-stretch">-contrast-stretch</a> 0 or <a
3768href="command-line-options.html#auto-level">-auto-level</a> is used to scale the image to full dynamic
Cristy882d9f42015-10-29 16:48:39 -04003769range, first. The argument to the <a href="command-line-options.html#evaluate">-evaluate</a> log
3770typically is specified between 100 and 10,000, depending upon the amount of
3771detail that one wants to bring out in the spectrum. Larger values produce more
3772visible detail. Too much detail, however, may hide the important features.</p>
3773
3774<p>The <a href="http://www.fftw.org/">FFTW</a> delegate library is required to
3775use <a href="command-line-options.html#fft">-fft</a>.</p>
3776
3777<p>Use <a href="command-line-options.html#fft">+fft</a> to produce two output images that are the real
3778and imaginary components of the complex valued Fourier transform.</p>
3779
3780<p>However, as the real and imaginary components can contain negative values,
3781this requires that IM be configured with HDRI enabled. In this case, you must
3782use either MIFF, TIF, PFM or MPC formats for the real and imaginary component
3783results, since they are formats that preserve both negative and fractional
3784values without clipping them or truncating the fractional part. With either
3785MIFF or TIF, one should add -define quantum:format=32, to allow those image
3786types to work properly in HDRI mode without clipping.</p>
3787
Cristy594d2772015-11-15 10:47:42 -05003788<p>The real and imaginary component images resulting from <a
3789href="command-line-options.html#fft">+fft</a> are also square, even dimensioned images due to the same
Cristy882d9f42015-10-29 16:48:39 -04003790padding that was discussed above for the magnitude and phase component
3791images.</p>
3792
Cristy594d2772015-11-15 10:47:42 -05003793<p>See the discussion on HDRI implementations of ImageMagick on the page <a
3794href="high-dynamic-range.html" >High Dynamic-Range Images</a>. For more
3795about HDRI go the ImageMagick <a
Cristy364a72f2016-11-04 22:38:41 -04003796href="https://www.imagemagick.org/Usage/basics/#hdri" >Usage</a> pages, <a
Cristy594d2772015-11-15 10:47:42 -05003797href="http://www.fmwconcepts.com/imagemagick/fourier_transforms/fourier.html"
3798>Fred's Fourier Processing With ImageMagick page</a> or this <a
3799 href="http://en.wikipedia.org/wiki/High_dynamic_range_imaging" >Wikipedia</a>
Cristy882d9f42015-10-29 16:48:39 -04003800 entry. </p>
3801
Cristy594d2772015-11-15 10:47:42 -05003802<p>By default the FFT is normalized (and the IFT is not). Use "<code><a href="command-line-options.html#define" >-define</a> fourier:normalize=forward</code> to explicitly normalize the FFT and unnormalize the IFT.</p>
Cristy882d9f42015-10-29 16:48:39 -04003803
3804
3805<div style="margin: auto;">
3806 <h3 class="magick-header"><a id="fill"></a>-fill <var>color</var></h3>
3807</div>
3808
3809<p class="magick-description">color to use when filling a graphic primitive.</p>
3810
3811<p>This option accepts a color name, a hex color, or a numerical RGB, RGBA,
Cristy594d2772015-11-15 10:47:42 -05003812HSL, HSLA, CMYK, or CMYKA specification. See <a href="color.html" >Color Names</a> for
Cristy882d9f42015-10-29 16:48:39 -04003813a description of how to properly specify the color argument.</p>
3814
3815<p>Enclose the color specification in quotation marks to prevent the "#" or
3816the parentheses from being interpreted by your shell.</p>
3817
3818<p>For example,</p>
3819
3820<pre>
3821-fill blue
3822-fill "#ddddff"
3823-fill "rgb(255,255,255)"
3824</pre>
3825
3826<p>See <a href="command-line-options.html#draw">-draw</a> for further details.</p>
3827
3828<p>To print a complete list of color names, use the <a href="command-line-options.html#list">-list color</a> option.</p>
3829
3830<div style="margin: auto;">
3831 <h3 class="magick-header"><a id="filter"></a>-filter <var>type</var></h3>
3832</div>
3833
3834<p class="magick-description">Use this <var>type</var> of filter when resizing or distorting an image.</p>
3835
3836<p>Use this option to affect the resizing operation of an image during
Cristy594d2772015-11-15 10:47:42 -05003837operations such as <a href="command-line-options.html#resize">-resize</a> and <a href="command-line-options.html#distort"
3838>-distort</a>. For example you can use a simple resize filter such as:</p>
Cristy882d9f42015-10-29 16:48:39 -04003839
3840<pre>
3841Point Hermite Cubic
3842Box Gaussian Catrom
3843Triangle Quadratic Mitchell
3844</pre>
3845
3846<p>The <code>Bessel</code> and <code>Sinc</code> filter is also provided (as well
3847as a faster <code>SincFast</code> equivalent form). However these filters are
3848generally useless on their own as they are infinite filters that are being
3849clipped to the filters support size. Their direct use is not recommended
3850except via expert settings (see below). </p>
3851
3852<p>Instead these special filter functions are typically windowed by a windowing
Cristy594d2772015-11-15 10:47:42 -05003853function that the <a href="command-line-options.html#filter" >-filter</a> setting defines. That is
Cristy882d9f42015-10-29 16:48:39 -04003854using these functions will define a 'Windowed' filter, appropriate to the
3855operator involved. Windowed filters include: </p>
3856
3857<pre>
3858Lanczos Hamming Parzen
3859Blackman Kaiser Welsh
3860Hanning Bartlett Bohman
3861</pre>
3862
3863<p>Also one special self-windowing filter is also provided
3864<code>Lagrange</code>, which will automagically re-adjust its function depending
3865on the current 'support' or 'lobes' expert settings (see below).</p>
3866
3867<p>If you do not select a filter with this option, the filter defaults to
3868<code>Mitchell</code> for a colormapped image, an image with a matte channel, or
3869if the image is enlarged. Otherwise the filter default to
3870<code>Lanczos</code>.</p>
3871
3872<p>To print a complete list of resize filters, use the <a href="command-line-options.html#list">-list
3873filter</a> option.</p>
3874
3875<p>You can modify how the filter behaves as it scales your image through the
Cristy594d2772015-11-15 10:47:42 -05003876use of these expert settings (see also <a href="command-line-options.html#define" >-define</a> and <a
3877href="command-line-options.html#set" >-set</a>):-</p>
Cristy882d9f42015-10-29 16:48:39 -04003878
3879<table class="table table-condensed table-striped">
3880 <tr>
3881 <td>-define filter:blur=<var>factor</var></td>
3882 <td>Scale the X axis of the filter (and its window). Use &gt; 1.0 for
3883 blurry or &lt; 1.0 for sharp. This should only be used with Gaussian and
3884 Gaussian-like filters simple filters, or you may not get the expected
3885 results. </td>
3886 </tr>
3887
3888 <tr>
3889 <td>-define filter:support=<var>radius</var></td>
3890 <td>Set the filter support radius. Defines how large the filter should be and
3891 thus directly defines how slow the filtered resampling process is. All
3892 filters have a default 'preferred' support size. Some filters like
3893 <code>Lagrange</code> and windowed filters adjust themselves depending on
3894 this value. With simple filters this value either does nothing (but slow
3895 the resampling), or will clip the filter function in a detrimental way.
3896 </td>
3897 </tr>
3898
3899 <tr>
3900 <td>-define filter:lobes=<var>count</var></td>
3901 <td>Set the number of lobes to use for the Sinc/Bessel filter. This an
3902 alternative way of specifying the 'support' range of the filter, that is
3903 designed to be more suited to windowed filters, especially when used for
3904 image distorts.</td>
3905 </tr>
3906
3907 <tr>
3908 <td>-define filter:sigma=<var>value</var></td>
3909 <td>The 'sigma' value used to define the <code>Gaussian</code> filter. Default
3910 sigma value is '<code>0.5</code>'. It only effects <code>Gaussian</code> but
3911 does not shrink (but may enlarge) the filter's 'support'. It can be used
3912 to generate very small blurs but without the filter 'missing' pixels due
3913 to using a small support setting. A larger value of '<code>0.707</code>'
3914 (a value of '1/sqrt(2)') is another common setting. </td>
3915 </tr>
3916
3917 <tr>
3918 <td>-define filter:b=<var>b-spline_factor</var></td>
Cristy579a0cb2016-11-26 12:27:17 -05003919 </tr>
3920
Cristy594d2772015-11-15 10:47:42 -05003921 <tr>
Cristy882d9f42015-10-29 16:48:39 -04003922 <td>-define filter:c=<var>keys_alpha_factor</var></td>
3923 <td>Redefine the values used for cubic filters such as <code>Cubic</code>,
3924 <code>Catrom</code>, <code>Mitchel</code>, and <code>Hermite</code>, as well as
3925 the <code>Parzen</code> cubic windowing function. If only one of the values
3926 are defined, the other is set so as to generate a 'Cubic-Keys' filter.
3927 The values meaning was defined by a research paper by
3928 Mitchell-Netravali.</td>
3929 </tr>
3930
3931 <tr>
3932 <td>-define filter:kaiser-beta=<var>value</var></td>
3933 <td>The 'alpha' value used to as part of the Kaiser Windowing function.
3934 Default value is '6.5'. It only effects Kaiser windowing function, and
3935 does not effect any other attributes.
3936 Before ImageMagick v6.7.6-10, this option was known as "filter:alpha", (an
3937 inheritance from the very old "zoom" program). It was changed to bring the
3938 function in line with more modern academic research usage, and better
3939 assign it be more definitive. </td>
3940 </tr>
3941
3942 <tr>
3943 <td>-define filter:kaiser-alpha=<var>value</var></td>
3944 <td>This value when multiplied by 'PI' is equivalent to "kaiser-beta", and
3945 will override that setting. It only effects Kaiser windowing function,
3946 and does not effect any other attributes. </td>
3947 </tr>
3948
3949 <tr>
3950 <td>-define filter:filter=<var>filter_function</var></td>
3951 <td>Use this function directly as the weighting filter. This will allow
3952 you to directly use a windowing function such as <code>Blackman</code>,
3953 as a resampling filter, rather than as its normal usage as a windowing
3954 function. If defined, no windowing function also defined, the window function is set
3955 to <code>Box</code>). Directly specifying <code>Sinc</code> or <code>Jinc</code>
3956 as a filter will also do this. </td>
3957 </tr>
3958
3959 <tr>
3960 <td>-define filter:window=<var>filter_function</var></td>
3961 <td>The IIR (infinite impulse response) filters <code>Sinc</code> and
3962 <code>Jinc</code> are windowed (brought down to zero over the defined
3963 support range) with the given filter. This allows you to specify a filter
3964 function to be used as a windowing function for these IIR filters.
3965 Many of the defined filters are actually windowing functions for these IIR
3966 filters. A typical choices is <code>Box</code>, (which effectively turns
3967 off the windowing function). </td>
3968 </tr>
3969
3970 <tr>
3971 <td>-define filter:win-support=<var>radius</var></td>
3972 <td>Scale windowing function to this size instead. This causes the windowing
3973 (or self-windowing Lagrange filter) to act is if the support window is
3974 larger than what is actually supplied to the calling operator. The filter
3975 however is still clipped to the real support size given. If unset this
3976 will equal the normal filter support size. </td>
3977 </tr>
3978
3979 <tr>
3980 <td>-define filter:verbose=<var>1</var></td>
3981 <td>This causes IM to print information on the final internal filter
3982 selection to standard output. This includes a commented header on the
3983 filter settings being used, and data allowing the filter weights to be
3984 easily graphed. Note however that some filters are internally defined in terms of other filters. The <code>Lanczos</code> filter for example is defined in terms of
3985 a <code>SincFast</code> windowed <code>SincFast</code> filter, while
3986 <code>Mitchell</code> is defined as a general <code>Cubic</code> family filter
3987 with specific 'B' and 'C' settings. </td>
3988 </tr>
3989
3990</table>
3991
3992<p>For example, to get a 8 lobe jinc windowed sinc filter (Genseng filter?):</p>
3993
3994<pre>
3995convert image.png \
3996 -filter sinc \
3997 -set filter:window=jinc \
3998 -set filter:lobes=8 \
3999 -resize 150% image.jpg"
4000</pre>
4001
4002<p>Or a raw un-windowed Sinc filter with 4 lobes:</p>
4003
4004<pre>
4005convert image.png \
4006 -set filter:filter=sinc \
4007 -set filter:lobes=4 \
4008 -resize 150% image.jpg"
4009</pre>
4010
4011<p>To extract the data for a raw windowing function, combine it with
4012a '<code>Box</code>' filter. For example the '<code>Welch</code> parabolic
4013windowing function. </p>
4014
4015<pre>
4016convert null: -define filter:filter=Box \
4017 -define filter:window=Welch \
4018 -define filter:support=1.0 \
4019 -define filter:verbose=1 \
Cristy594d2772015-11-15 10:47:42 -05004020 -resize 2 null: > window_welch.dat
Cristy882d9f42015-10-29 16:48:39 -04004021gnuplot
4022 set grid
4023 plot \"window_welch.dat\" with lines
4024</pre>
4025
4026<p>Note that the use of expert options is provided for image processing experts
4027who have studied and understand how resize filters work. Without this
4028knowledge, and an understanding of the definition of the actual filters
4029involved, using expert settings are more likely to be detrimental to your image
4030resizing.</p>
4031
4032
4033<div style="margin: auto;">
4034 <h3 class="magick-header"><a id="flatten"></a>-flatten</h3>
4035</div>
4036
Cristy594d2772015-11-15 10:47:42 -05004037<p class="magick-description">This is a simple alias for the <a href="command-line-options.html#layers" >-layers</a> method "flatten".</p>
Cristy882d9f42015-10-29 16:48:39 -04004038
4039
4040<div style="margin: auto;">
4041 <h3 class="magick-header"><a id="flip"></a>-flip</h3>
4042</div>
4043
4044<p class="magick-description">create a <var>mirror image</var></p>
4045
4046<p>reflect the scanlines in the vertical direction. The image will be mirrored
4047upside-down. </p>
4048
4049
4050<div style="margin: auto;">
4051 <h3 class="magick-header"><a id="floodfill"></a>-floodfill {<var>+-</var>}<var>x</var>{<var>+-</var>}<var>y</var> <var>color</var></h3>
4052</div>
4053
4054<p class="magick-description">floodfill the image with color at the specified offset.</p>
4055
4056<p>Flood fill starts from the given 'seed point' which is not gravity effected.
Cristy594d2772015-11-15 10:47:42 -05004057Any color that matches within <a href="command-line-options.html#fuzz" >-fuzz</a> color distance of the
Cristy882d9f42015-10-29 16:48:39 -04004058given <var>color</var> argument, connected to that 'seed point'
Cristy594d2772015-11-15 10:47:42 -05004059will be replaced with the current <a href="command-line-options.html#fill" >-fill</a> color. </p>
Cristy882d9f42015-10-29 16:48:39 -04004060
4061<p>Note that if the pixel at the 'seed point' does not itself match the given
Cristy594d2772015-11-15 10:47:42 -05004062<var>color</var> (according to <a href="command-line-options.html#fuzz" >-fuzz</a>), then no
Cristy882d9f42015-10-29 16:48:39 -04004063action will be taken. </p>
4064
Cristy594d2772015-11-15 10:47:42 -05004065<p>This operator works more like the <a href="command-line-options.html#opaque" >-opaque</a> option, than
Cristy882d9f42015-10-29 16:48:39 -04004066a more general flood fill that reads the matching color directly at the 'seed
Cristy594d2772015-11-15 10:47:42 -05004067point'. For this form of flood fill, look at <a href="command-line-options.html#draw" >-draw</a> and
Cristy882d9f42015-10-29 16:48:39 -04004068its 'color floodfill' drawing method. </p>
4069
4070
4071<div style="margin: auto;">
4072 <h3 class="magick-header"><a id="flop"></a>-flop</h3>
4073</div>
4074
4075<p class="magick-description">create a <var>mirror image</var>.</p>
4076
4077<p>Reflect the scanlines in the horizontal direction, just like the image in
4078a vertical mirror. </p>
4079
4080
4081<div style="margin: auto;">
4082 <h3 class="magick-header"><a id="font"></a>-font <var>name</var></h3>
4083</div>
4084
4085<p class="magick-description">set the font to use when annotating images with text, or creating labels.</p>
4086
4087<p>To print a complete list of fonts, use the <a href="command-line-options.html#list">-list font</a>
4088option (for versions prior to 6.3.6, use 'type' instead of 'font').</p>
4089
4090<p>In addition to the fonts specified by the above pre-defined list, you can
4091also specify a font from a specific source. For example <code>Arial.ttf</code>
4092is a TrueType font file, <code>ps:helvetica</code> is PostScript font, and
4093<code>x:fixed</code> is X11 font.</p>
4094
Cristy594d2772015-11-15 10:47:42 -05004095<p>For other settings that affect fonts, see the options <a
4096href="command-line-options.html#family">-family</a>, <a href="command-line-options.html#stretch">-stretch</a>, <a
4097href="command-line-options.html#style">-style</a>, and <a href="command-line-options.html#weight">-weight</a>. </p>
Cristy882d9f42015-10-29 16:48:39 -04004098
4099
4100<div style="margin: auto;">
4101 <h3 class="magick-header"><a id="foreground"></a>-foreground <var>color</var></h3>
4102</div>
4103
4104<p class="magick-description">Define the foreground color for menus.", "display</p>
4105
Cristy594d2772015-11-15 10:47:42 -05004106<p>The color is specified using the format described under the <a
4107href="command-line-options.html#fill">-fill</a> option.</p>
Cristy882d9f42015-10-29 16:48:39 -04004108
4109<p>The default foreground color is black.</p>
4110
4111<div style="margin: auto;">
4112 <h3 class="magick-header"><a id="format"></a>-format <var>type</var></h3>
4113</div>
4114
4115<p class="magick-description">the image format type.</p>
4116
4117<p>When used with the <code>mogrify</code> utility, this option converts any
4118image to the image <a href="formats.html">format</a> you specify.
Cristy594d2772015-11-15 10:47:42 -05004119For a list of image format types supported by ImageMagick, use <a
4120href="command-line-options.html#list">-list format</a>.</p>
Cristy882d9f42015-10-29 16:48:39 -04004121
4122<p>By default the file is written to its original name. However, if the
4123filename extension matches a supported format, the extension is replaced with
4124the image format type specified with <a href="command-line-options.html#format">-format</a>. For
4125example, if you specify <var>tiff</var> as the format type and the
4126input image filename is <var>image.gif</var>, the output image
4127filename becomes <var>image.tiff</var>.</p>
4128
4129<div style="margin: auto;">
4130 <h3 class="magick-header"><a id="format_identify_"></a>-format <var>string</var></h3>
4131</div>
4132
4133<p class="magick-description">output formatted image characteristics.</p>
4134
4135<p>See <a href="escape.html">Format and Print Image
4136Properties</a> for an explanation on how to specify the argument to this
4137option.</p>
4138
4139<div style="margin: auto;">
4140 <h3 class="magick-header"><a id="frame"></a>-frame <var>geometry</var></h3>
4141</div>
4142
4143<p class="magick-description">Surround the image with a border or beveled frame.</p>
4144
Cristyb7f455a2017-03-03 19:30:34 -05004145<p>The color of the border is specified with the <a href="command-line-options.html#mattecolor"
4146>-mattecolor</a> command line option. </p>
Cristy882d9f42015-10-29 16:48:39 -04004147
4148<p>See <a href="command-line-processing.html#geometry">Image Geometry</a> for complete details about the <em class="arg">geometry</em> argument. The <var>size</var> portion of the <var>geometry</var> argument indicates the amount of extra width and
4149height that is added to the dimensions of the image. If no offsets are given
4150in the <var>geometry</var> argument, then the border added is
4151a solid color. Offsets <var>x</var> and <var>y</var>, if present, specify that
4152the width and height of the border is partitioned to form an outer bevel of
4153thickness <var>x</var> pixels and an inner bevel of thickness
4154<var>y</var> pixels. Negative offsets make no sense as frame arguments.
4155</p>
4156
Cristy594d2772015-11-15 10:47:42 -05004157<p>The <a href="command-line-options.html#frame">-frame</a> option is affected by the current <a
4158href="command-line-options.html#compose">-compose</a> setting and assumes that this is using the default
Cristy882d9f42015-10-29 16:48:39 -04004159'<code>Over</code>' composition method. It generates an image of the appropriate
4160size with the current <a href="command-line-options.html#bordercolor">-bordercolor</a> setting, and then
Cristy594d2772015-11-15 10:47:42 -05004161draws the frame of four distinct colors close to the current <a
Cristyb7f455a2017-03-03 19:30:34 -05004162href="command-line-options.html#mattecolor">-mattecolor</a>. The original image is then overlaid onto
Cristy882d9f42015-10-29 16:48:39 -04004163center of this image. This means that with the default compose method of
Cristy594d2772015-11-15 10:47:42 -05004164'<code>Over</code>' any transparent parts may be replaced by the current <a
4165href="command-line-options.html#bordercolor">-bordercolor</a> setting.</p>
Cristy882d9f42015-10-29 16:48:39 -04004166
4167<p>The image composition is not
4168affected by the <a href="command-line-options.html#gravity">-gravity</a> option.</p>
4169
4170
4171<div style="margin: auto;">
4172 <h3 class="magick-header"><a id="frame_import_"></a>-frame</h3>
4173</div>
4174
4175<p class="magick-description">include the X window frame in the imported image. </p>
4176<div style="margin: auto;">
4177 <h3 class="magick-header"><a id="function"></a>-function <var>function</var> <var>parameters</var></h3>
4178</div>
4179
4180<p class="magick-description">Apply a function to channel values.</p>
4181
4182<p>This operator performs calculations based on the given arguments to modify
Cristy594d2772015-11-15 10:47:42 -05004183each of the color values for each previously set <a
4184href="command-line-options.html#channel">-channel</a> in the image. See <a
4185href="command-line-options.html#evaluate">-evaluate</a> for details concerning how the results of the
Cristy882d9f42015-10-29 16:48:39 -04004186calculations are handled.</p>
4187
Cristy594d2772015-11-15 10:47:42 -05004188<p>This is can be considered a multi-argument version of the <a
4189href="command-line-options.html#evaluate">-evaluate</a> operator. (Added in
Cristy882d9f42015-10-29 16:48:39 -04004190ImageMagick 6.4.8−8.)</p>
4191
4192<p>Here, <var>parameters</var> is a comma-separated list of
4193numerical values. The number of values varies depending on which <var>function</var> is selected. Choose the <var>function</var> from:</p>
4194
4195<pre>
4196Polynomial
4197Sinusoid
4198Arcsin
4199Arctan
4200</pre>
4201
4202<p>To print a complete list of <a href="command-line-options.html#function">-function</a> operators,
4203use <a href="command-line-options.html#list">-list function</a>. Descriptions follow.</p>
4204
4205<dl class="dl-horizontal">
4206 <dt>Polynomial</dt>
4207 <dd><p>The <code>Polynomial</code> function takes an arbitrary number of parameters,
4208these being the coefficients of a polynomial, in decreasing order of degree.
4209That is, entering</p>
4210
4211<pre>
4212-function Polynomial <var>a</var><sub><var>n</var></sub>,<var>a</var><sub><var>n</var>-1</sub>,...<var>a</var><sub>1</sub>,<var>a</var><sub>0</sub>
4213</pre>
4214
4215<p>will invoke a polynomial function given by</p>
4216
4217<pre>
4218<var>a</var><sub><var>n</var></sub> <b><var>u</var></b><sup><var>n</var></sup> + <var>a</var><sub><var>n</var>-1</sub> <b><var>u</var></b><sup><var>n</var>-1</sup> + ··· <var>a</var><sub>1</sub> <b><var>u</var></b> + <var>a</var><sub>0</sub>,
4219</pre>
4220
4221<p>where <b><var>u</var></b> is pixel's original normalized channel value.</p>
4222
4223<p>The <code>Polynomial</code> function can be used in place of <code>Set</code>
4224(the <var>constant</var> polynomial) and <code>Add</code>, <code>Divide</code>,
4225<code>Multiply</code>, and <code>Subtract</code> (some <var>linear</var>
Cristy594d2772015-11-15 10:47:42 -05004226polynomials) of the <a href="command-line-options.html#evaluate">-evaluate</a> operator. The <a
4227href="command-line-options.html#level">-level</a> operator also affects channels linearly. Some
Cristy882d9f42015-10-29 16:48:39 -04004228correspondences follow.</p>
4229
4230<table class="table table-condensed table-striped">
4231 <tr>
4232 <td>-evaluate Set <var>value</var> </td>
4233 <td>-function Polynomial <var>value</var></td>
4234 <td>(Constant functions; set <var>value</var>×100% gray when channels are RGB.)</td>
4235 </tr>
4236 <tr>
4237 <td>-evaluate Add <var>value</var> </td>
4238 <td>-function Polynomial 1,<var>value</var></td>
4239 </tr>
4240 <tr>
4241 <td>-evaluate Subtract <var>value</var> </td>
4242 <td>-function Polynomial 1,−<var>value</var></td>
4243 </tr>
4244 <tr>
4245 <td>-evaluate Multiply <var>value</var> </td>
4246 <td>-function Polynomial <var>value</var>,0</td>
4247 </tr>
4248 <tr>
4249 <td>+level black% x white%</td>
4250 <td>-function Polynomial A,B</td>
4251 <td>(Reduce contrast. Here, A=(white-black)/100 and B=black/100.)</td>
4252 </tr>
4253</table>
4254
4255<p>The <code>Polynomial</code> function gives great versatility, since
4256polynomials can be used to fit any continuous curve to any degree of accuracy
4257desired.</p>
4258
4259</dd>
4260<dt>Sinusoid</dt>
4261<dd>
4262<p>The <code>Sinusoid</code> function can be used to vary the channel values
4263sinusoidally by setting frequency, phase shift, amplitude, and a bias. These
4264values are given as one to four parameters, as follows,</p>
4265
4266<pre>
4267-function <code>Sinusoid</code> <var>freq</var>,[<var>phase</var>,[<var>amp</var>,[<var>bias</var>]]]
4268</pre>
4269
4270<p>where <var>phase</var> is in degrees. (The domain [0,1] of the function
4271corresponds to 0 through <var>freq</var>×360 degrees.)
4272The result is that if a pixel's normalized channel value is originally
4273<b><var>u</var></b>, its resulting normalized value is given by </p>
4274
4275<pre>
4276<var>amp</var> * sin(2*π* (<var>freq</var> * <b><var>u</var></b> + <var>phase</var> / 360)) + <var>bias</var>
4277</pre>
4278
4279<p> For example, the following generates a curve that starts and ends at 0.9
4280(when <b><var>u</var></b>=0 and 1, resp.), oscillating three times between
4281.7−.2=.5 and .7+.2=.9. </p>
4282
4283<pre>
4284-function Sinusoid 3,-90,.2,.7
4285</pre>
4286
4287<p>The default values of <var>amp</var> and <var>bias</var> are both .5. The default for <var>phase</var>
4288is 0.</p>
4289
4290<p>The <code>Sinusoid</code> function generalizes <code>Sin</code> and
4291<code>Cos</code> of the <a href="command-line-options.html#evaluate">-evaluate</a> operator by allowing
4292varying amplitude, phase and bias. The correspondence is as follows.</p>
4293
4294<table class="table table-condensed table-striped">
4295 <tr>
4296 <td>-evaluate Sin <var>freq</var> </td>
4297 <td>-function Sinusoid <var>freq</var>,0 </td>
4298 </tr>
4299 <tr>
4300 <td>-evaluate Cos <var>freq</var> </td>
4301 <td>-function Sinusoid <var>freq</var>,90 </td>
4302 </tr>
4303</table>
4304 </dd>
4305<dt>ArcSin</dt>
4306<dd>
4307<p>The <code>ArcSin</code> function generates the inverse curve of a Sinusoid,
4308and can be used to generate cylindrical distortion and displacement maps.
4309The curve can be adjusted relative to both the input values and output range
4310of values.</p>
4311
4312<pre>
4313-function <code>ArcSin</code> <var>width</var>,[<var>center</var>,[<var>range</var>,[<var>bias</var>]]]
4314</pre>
4315
4316<p>with all values given in terms of normalized color values (0.0 for black,
43171.0 for white). Defaulting to values covering the full range from 0.0 to 1.0
4318for bout input (<var>width</var>), and output (<var>width</var>) values. '<code>1.0,0.5,1.0,0.5</code>' </p>
4319
4320<pre>
4321<var>range</var>/π * asin( 2/<var>width</var> * ( <b><var>u</var></b> - <var>center</var> ) ) + <var>bias</var>
4322</pre>
4323
4324</dd>
4325<dt>ArcTan</dt>
4326<dd>
4327<p>The <code>ArcTan</code> function generates a curve that smooth crosses from
4328limit values at infinities, though a center using the given slope value.
4329All these values can be adjusted via the arguments.</p>
4330
4331<pre>
4332-function <code>ArcTan</code> <var>slope</var>,[<var>center</var>,[<var>range</var>,[<var>bias</var>]]]
4333</pre>
4334
4335<p>Defaulting to '<code>1.0,0.5,1.0,0.5</code>'.
4336</p>
4337
4338<pre>
4339<var>range</var>/π * atan( <var>slope</var>*π * ( <b><var>u</var></b> - <var>center</var> ) ) + <var>bias</var>
4340</pre>
4341 </dd>
Cristy882d9f42015-10-29 16:48:39 -04004342</dl>
4343
4344
4345
4346<div style="margin: auto;">
4347 <h3 class="magick-header"><a id="fuzz"></a>-fuzz <var>distance</var>{<var>%</var>}</h3>
4348</div>
4349
4350<p class="magick-description">Colors within this <var>distance</var> are considered equal.</p>
4351
4352<p>A number of algorithms search for a target color. By default the color must
4353be exact. Use this option to match colors that are close to the target color
4354in RGB space. For example, if you want to automagically trim the edges of an
4355image with <a href="command-line-options.html#trim">-trim</a> but the image was scanned and the target
4356background color may differ by a small amount. This option can account for
4357these differences.</p>
4358
4359<p>The <var>distance</var> can be in absolute intensity units or, by
4360appending <code>%</code> as a percentage of the maximum possible intensity (255,
436165535, or 4294967295).</p>
4362
Cristy594d2772015-11-15 10:47:42 -05004363<p>Use <a href="command-line-options.html#fuzz" >+fuzz</a> to reset the fuzz value to 0.</p>
Cristy882d9f42015-10-29 16:48:39 -04004364
4365
4366<div style="margin: auto;">
4367 <h3 class="magick-header"><a id="fx"></a>-fx <var>expression</var></h3>
4368</div>
4369
4370<p class="magick-description">apply a mathematical expression to an image or image channels.</p>
4371
4372<p>If the first character of <var>expression</var> is <code>@</code>,
4373the expression is read from a file titled by the remaining characters in the
4374string.</p>
4375
4376<p>See <a href="fx.html">FX,
4377The Special Effects Image Operator</a> for a detailed discussion of this
4378option.</p>
4379
4380
4381<div style="margin: auto;">
4382 <h3 class="magick-header"><a id="gamma"></a>-gamma <var>value</var></h3>
4383</div>
4384
4385<p class="magick-description">level of gamma correction.</p>
4386
4387<p>The same color image displayed on two different workstations may look
4388different due to differences in the display monitor. Use gamma correction to
4389adjust for this color difference. Reasonable values extend from
4390<code>0.8</code> to <code>2.3</code>. Gamma less than 1.0 darkens the image and
4391gamma greater than 1.0 lightens it. Large adjustments to image gamma may
4392result in the loss of some image information if the pixel quantum size is only
4393eight bits (quantum range 0 to 255).</p>
4394
4395<p>Gamma adjusts the image's channel values pixel-by-pixel according to
4396a power law, namely, pow(pixel,1/gamma) or pixel^(1/gamma), where pixel is the
4397normalized or 0 to 1 color value. For example, using a value of gamma=2 is the
4398same as taking the square root of the image.</p>
4399
4400<p>You can apply separate gamma values to the red, green, and blue channels of
4401the image with a gamma value list delimited with commas (e.g.,
4402<code>1.7,2.3,1.2</code>).</p>
4403
4404<p>Use <a href="command-line-options.html#gamma">+gamma <var>value</var></a> to set the
4405image gamma level without actually adjusting the image pixels. This option
4406is useful if the image is of a known gamma but not set as an image attribute
4407(e.g. PNG images). Write the "file gamma" which is the reciprocal of the
4408display gamma; e.g., if your image is sRGB and you want to write a PNG gAMA
4409chunk, use</p>
4410
4411<pre>
4412convert input.png +gamma .45455 output.png
4413</pre>
4414
4415<p>(0.45455 is 1/2.2)</p>
4416
4417<p>Note that gamma adjustments are also available via the <a href="command-line-options.html#level">-level</a> operator.</p>
4418
4419<div style="margin: auto;">
Cristy594d2772015-11-15 10:47:42 -05004420 <h3 class="magick-header"><a id="gaussian-blur"></a>-gaussian-blur <var>radius</var><br />-gaussian-blur <var>radius</var>x<var>sigma</var></h3>
Cristy882d9f42015-10-29 16:48:39 -04004421</div>
4422
4423<p class="magick-description">Blur the image with a Gaussian operator.</p>
4424
4425<p>Convolve the image with a Gaussian or normal distribution using the given
Cristy594d2772015-11-15 10:47:42 -05004426<var >Sigma</var> value. The formula is:</p>
Cristy882d9f42015-10-29 16:48:39 -04004427
Cristy594d2772015-11-15 10:47:42 -05004428<p class="text-center"><img class="img-thumbnail" alt="gaussian distribution" width="243px" height="42px" src="../images/gaussian-blur.png"/> </p>
Cristy882d9f42015-10-29 16:48:39 -04004429
Cristy594d2772015-11-15 10:47:42 -05004430<p>The <var >Sigma</var> value is the important argument, and
Cristy882d9f42015-10-29 16:48:39 -04004431determines the actual amount of blurring that will take place. </p>
4432
Cristy594d2772015-11-15 10:47:42 -05004433<p>The <var >Radius</var> is only used to determine the size of the
Cristy882d9f42015-10-29 16:48:39 -04004434array which will hold the calculated Gaussian distribution. It should be an
4435integer. If not given, or set to zero, IM will calculate the largest possible
4436radius that will provide meaningful results for the Gaussian distribution.
4437</p>
4438
Cristy594d2772015-11-15 10:47:42 -05004439<p>The larger the <var >Radius</var> the radius the slower the
4440operation is. However too small a <var >Radius</var>, and sever
4441aliasing effects may result. As a guideline, <var >Radius</var>
4442should be at least twice the <var >Sigma</var> value, though three
Cristy882d9f42015-10-29 16:48:39 -04004443times will produce a more accurate result. </p>
4444
4445<p>This differs from the faster <a href="command-line-options.html#blur">-blur</a> operator in that a
4446full 2-dimensional convolution is used to generate the weighted average of the
4447neighboring pixels. </p>
4448
4449<p>The <a href="command-line-options.html#virtual-pixel">-virtual-pixel</a> setting will determine how
4450pixels which are outside the image proper are blurred into the final result.
4451</p>
4452
4453
4454<div style="margin: auto;">
4455 <h3 class="magick-header"><a id="geometry"></a>-geometry <var>geometry</var></h3>
4456</div>
4457
4458<p class="magick-description">Set the preferred size and location of the image.</p>
4459
4460<p>See <a href="command-line-processing.html#geometry">Image Geometry</a> for complete details about the <em class="arg">geometry</em> argument.</p>
4461
4462<div style="margin: auto;">
4463 <h3 class="magick-header"><a id="gravity"></a>-gravity <var>type</var></h3>
4464</div>
4465
4466<p class="magick-description">Sets the current gravity suggestion for various other settings and options.</p>
4467
4468<p>Choices include: <code>NorthWest</code>, <code>North</code>,
4469<code>NorthEast</code>, <code>West</code>, <code>Center</code>, <code>East</code>,
Cristy594d2772015-11-15 10:47:42 -05004470<code>SouthWest</code>, <code>South</code>, <code>SouthEast</code>. Use <a
4471href="command-line-options.html#list">-list gravity</a> to get a complete list of <a
4472href="command-line-options.html#gravity">-gravity</a> settings available in your ImageMagick
Cristy882d9f42015-10-29 16:48:39 -04004473installation.</p>
4474
4475<p>The direction you choose specifies where to position text or subimages. For
4476example, a gravity of <code>Center</code> forces the text to be centered within
Cristy776113a2016-04-29 12:01:19 -04004477the image. By default, the image gravity is <code>undefined</code>. See <a
Cristy594d2772015-11-15 10:47:42 -05004478href="command-line-options.html#draw">-draw</a> for more details about graphic primitives. Only the
4479text primitive of <a href="command-line-options.html#draw">-draw</a> is affected by the <a
4480href="command-line-options.html#gravity">-gravity</a> option.</p>
Cristy882d9f42015-10-29 16:48:39 -04004481
4482<p>The <a href="command-line-options.html#gravity">-gravity</a> option is also used in concert with the
4483<a href="command-line-options.html#geometry">-geometry</a> setting and other settings or options that
Cristy594d2772015-11-15 10:47:42 -05004484take <var>geometry</var> as an argument, such as the <a
4485href="command-line-options.html#crop">-crop</a> option. </p>
Cristy882d9f42015-10-29 16:48:39 -04004486
4487<p>If a <a href="command-line-options.html#gravity">-gravity</a> setting occurs before another option
4488or setting having a <var>geometry</var> argument that specifies an
4489offset, the offset is usually applied to the point within the image suggested
4490by the <a href="command-line-options.html#gravity">-gravity</a> argument. Thus, in the following
4491command, for example, suppose the file <code>image.png</code> has dimensions
4492200x100. The offset specified by the argument to <a href="command-line-options.html#region">-region</a>
4493is (−40,+20). The argument to <a href="command-line-options.html#gravity">-gravity</a> is
4494<code>Center</code>, which suggests the midpoint of the image, at the point
4495(100,50). The offset (−40,20) is applied to that point, giving
4496(100−40,50+20)=(60,70), so the specified 10x10 region is located at
4497that point. (In addition, the <a href="command-line-options.html#gravity">-gravity</a> affects the
4498region itself, which is <var>centered</var> at the pixel
4499coordinate (60,70). (See <a href="command-line-processing.html#geometry">Image Geometry</a> for complete details about the <em class="arg">geometry</em> argument.)</p>
4500
4501<pre>
4502convert image.png -gravity Center -region 10x10-40+20 \
4503 -negate output.png
4504</pre>
4505
Cristy594d2772015-11-15 10:47:42 -05004506<p>When used as an option to <a href="composite.html">composite</a>, <a
4507href="command-line-options.html#gravity">-gravity</a> gives the direction that the image gravitates
Cristy882d9f42015-10-29 16:48:39 -04004508within the composite.</p>
4509
Cristy594d2772015-11-15 10:47:42 -05004510<p>When used as an option to <a href="montage.html">montage</a>, <a
4511href="command-line-options.html#gravity">-gravity</a> gives the direction that an image gravitates
Cristy882d9f42015-10-29 16:48:39 -04004512within a tile. The default gravity is <code>Center</code> for this purpose.</p>
4513
4514
4515<div style="margin: auto;">
4516 <h3 class="magick-header"><a id="grayscale"></a>-grayscale <var>method</var></h3>
4517</div>
4518
4519<p class="magick-description">convert image to grayscale.</p>
4520
Cristy594d2772015-11-15 10:47:42 -05004521<p>This will use one of the <a href="command-line-options.html#intensity" >-intensity</a> methods to
Cristy882d9f42015-10-29 16:48:39 -04004522convert the given image into a linear-grayscale image. </p>
4523
4524<p>For example, to convert an image to (linear) Rec709Luminance grayscale, type:</p>
4525
4526<pre>
4527convert in.png -grayscale Rec709Luminance out.png
4528</pre>
4529
4530<p>which is equivalent to:</p>
4531
4532<pre>
4533convert in.png -colorspace gray out.png
4534</pre>
4535
4536<p>Similarly, to convert an image to (non-linear) Rec709Luma grayscale, type:</p>
4537
4538<pre>
4539convert in.png -grayscale Rec709Luma out.png
4540</pre>
4541
4542<p>which is equivalent to:</p>
4543
4544<pre>
4545convert in.png -set colorspace RGB -colorspace gray out.png
4546</pre>
4547
4548<p>Note that a 'colorspace' intensity method will produce the same result
4549regardless of the current colorpsace of the image. But a 'mathematical'
4550intensity method will depend on the current colorspace the image is currently
4551using. </p>
4552
Cristy594d2772015-11-15 10:47:42 -05004553<p>While this operation uses an <a href="command-line-options.html#intensity" >-intensity</a> method,
4554it does not use or set the <a href="command-line-options.html#intensity" >-intensity</a> setting, so
Cristy882d9f42015-10-29 16:48:39 -04004555will not effect other operations that may use that setting.</p>
4556
4557
4558<div style="margin: auto;">
4559 <h3 class="magick-header"><a id="green-primary"></a>-green-primary <var>x,y</var></h3>
4560</div>
4561
4562<p class="magick-description">green chromaticity primary point.</p>
4563
4564
4565<div style="margin: auto;">
4566 <h3 class="magick-header"><a id="hald-clut"></a>-hald-clut</h3>
4567</div>
4568
4569<p class="magick-description">apply a Hald color lookup table to the image.</p>
4570
4571<p>A Hald color lookup table is a 3-dimensional color cube mapped to 2
4572dimensions. Create it with the <code>HALD:</code> prefix (e.g. HALD:8). You
4573can apply any color transformation to the Hald image and then use this option
4574to apply the transform to the image. </p>
4575
4576<pre>
4577convert image.png hald.png -hald-clut transform.png
4578</pre>
4579
4580<p>This option provides a convenient method for you to use Gimp or Photoshop
4581to make color corrections to the Hald CLUT image and subsequently apply them
4582to multiple images using an ImageMagick script. </p>
4583
4584<p>Note that the representation is only of the normal RGB color space and that
4585the whole color value triplet is used for the interpolated lookup of the
Cristy594d2772015-11-15 10:47:42 -05004586represented Hald color cube image. Because of this the operation is not <a
4587href="command-line-options.html#channel" >-channel</a> setting effected, nor can it adjust or modify an
Cristy882d9f42015-10-29 16:48:39 -04004588images transparency or alpha/matte channel.</p>
4589
Cristy594d2772015-11-15 10:47:42 -05004590<p>See also <a href="command-line-options.html#clut" >-clut</a> which provides color value replacement
Cristy769d8892016-01-19 18:11:14 -05004591of the individual color channels, usually involving a simpler grayscale
4592image. E.g: grayscale to color replacement, or modification by a histogram
Cristy882d9f42015-10-29 16:48:39 -04004593mapping. </p>
4594
4595
4596<div style="margin: auto;">
4597 <h3 class="magick-header"><a id="help"></a>-help</h3>
4598</div>
4599
4600<p class="magick-description">print usage instructions.</p>
4601
4602<div style="margin: auto;">
4603 <h3 class="magick-header"><a id="highlight-color"></a>-highlight-color <var>color</var></h3>
4604</div>
4605
4606<p class="magick-description">when comparing images, emphasize pixel differences with this color.</p>
4607
4608<div style="margin: auto;">
4609 <h3 class="magick-header"><a id="hough-lines"></a>-hough-lines <var>width</var>x<var>height</var>{<var>+threshold</var>}</h3>
4610</div>
4611
4612<p class="magick-description">identify straight lines in the image (e.g. -hough-lines 9x9+195).</p>
4613
4614<p>Use the Hough line detector with any binary edge extracted image to locate and draw any straight lines that it finds.</p>
4615
4616<p>The process accumulates counts for every white pixel in the binary edge image for every possible orientation (for angles from 0 to 179 in 1 deg increments) and distance from the center of the image to the corners (in 1 px increments). It stores the counts in an accumulator matrix of angle vs distance. The size of the accumulator will be 180x(diagonal/2). Next it searches the accumulator for peaks in counts and converts the locations of the peaks to slope and intercept in the normal x,y input image space. The algorithm uses slope/intercepts to find the endpoints clipped to the bounds of the image. The lines are drawn from the given endpoints. The counts are a measure of the length of the lines.</p>.
4617
4618<p>The WxH arguments specify the filter size for locating the peaks in the Hough accumulator. The threshold excludes lines whose counts are less than the threshold value.</p>
4619
Cristy594d2772015-11-15 10:47:42 -05004620<p>Use <code><a href="command-line-options.html#background" >-background</a></code> to specify the color of the background onto which the lines will be drawn. The default is black.</p>
Cristy882d9f42015-10-29 16:48:39 -04004621
Cristy594d2772015-11-15 10:47:42 -05004622<p>Use <code><a href="command-line-options.html#fill" >-fill</a></code> to specify the color of the lines. The default is black.</p>
Cristy882d9f42015-10-29 16:48:39 -04004623
Cristy594d2772015-11-15 10:47:42 -05004624<p>Use <code><a href="command-line-options.html#stroke" >-stroke</a></code> and <code><a href="command-line-options.html#strokewidth" >-strokewidth</a></code> to specify the thickness of the lines. The default is black and no strokewidth.</p>
Cristy882d9f42015-10-29 16:48:39 -04004625
4626<p>A text file listing the endpoints and counts may be created by using the suffix, .mvg, for the output image.</p>
4627
Cristy594d2772015-11-15 10:47:42 -05004628<p>Use <code><a href="command-line-options.html#define" >-define</a> hough-lines:accumulator=true</code> to return the accumulator image in addition to the lines image.</p>
Cristy882d9f42015-10-29 16:48:39 -04004629
4630<div style="margin: auto;">
4631 <h3 class="magick-header"><a id="iconGeometry"></a>-iconGeometry <var>geometry</var></h3>
4632</div>
4633
4634<p class="magick-description">specify the icon geometry.</p>
4635
4636<p>Offsets, if present in the geometry specification, are handled in the same
4637manner as the <a href="command-line-options.html#geometry">-geometry</a> option, using X11 style to
4638handle negative offsets.</p>
4639
4640<p>See <a href="command-line-processing.html#geometry">Image Geometry</a> for complete details about the <em class="arg">geometry</em> argument.</p>
4641
4642<div style="margin: auto;">
4643 <h3 class="magick-header"><a id="iconic"></a>-iconic</h3>
4644</div>
4645
4646<p class="magick-description">start in icon mode in X Windows", 'animate', 'display</p>
4647
4648<div style="margin: auto;">
4649 <h3 class="magick-header"><a id="identify"></a>-identify</h3>
4650</div>
4651
4652<p class="magick-description">identify the format and characteristics of the image.</p>
4653
4654<p>This information is printed: image scene number; image name; image size;
4655the image class (<var>DirectClass</var> or <var>PseudoClass</var>); the total number of unique colors; and the
4656number of seconds to read and transform the image. Refer to <a href="miff.html">MIFF</a> for
4657a description of the image class.</p>
4658
4659<p>If <a href="command-line-options.html#colors">-colors</a> is also specified, the total unique colors
Cristy594d2772015-11-15 10:47:42 -05004660in the image and color reduction error values are printed. Refer to <a
Cristy6549abb2016-11-10 08:25:55 -05004661href="http://www.imagemagick.org/www/quantize.html">color
Cristy882d9f42015-10-29 16:48:39 -04004662reduction algorithm</a> for a description of these values.</p>
4663
4664<p>If <a href="command-line-options.html#verbose">-verbose</a> precedes this option, copious
4665amounts of image properties are displayed including image statistics, profiles,
4666image histogram, and others.</p>
4667
4668<div style="margin: auto;">
4669 <h3 class="magick-header"><a id="ift"></a>-ift</h3>
4670</div>
4671
4672<p class="magick-description">implements the inverse discrete Fourier transform (DFT).</p>
4673
4674<p>This option is new as of ImageMagick 6.5.4-3 (and now working for Windows
4675users in ImageMagick 6.6.0-9). It transforms a pair of magnitude and phase
4676images from the frequency domain to a single image in the normal or spatial
Cristy594d2772015-11-15 10:47:42 -05004677domain. See for example, <a
4678href="http://en.wikipedia.org/wiki/Fourier_transform">Fourier Transform</a>,
Cristy882d9f42015-10-29 16:48:39 -04004679<a href="http://en.wikipedia.org/wiki/DFT">Discrete Fourier Transform</a> and
4680<a href="http://en.wikipedia.org/wiki/FFT">Fast Fourier Transform</a>.</p>
4681
4682<p>For example, depending upon the image format used to store the result of
4683the <a href="command-line-options.html#fft">-fft</a>, one would use either</p>
4684
4685<pre>
4686convert fft_image.miff -ift fft_image_ift.png
4687</pre>
4688
4689<p>or</p>
4690
4691<pre>
4692convert fft_image-0.png fft_image-1.png -ift fft_image_ift.png
4693</pre>
4694
4695<p>The resulting image may need to be cropped due to padding introduced when
Cristy594d2772015-11-15 10:47:42 -05004696the original image, prior to the <a href="command-line-options.html#fft">-fft</a> or <a
4697href="command-line-options.html#fft">+fft</a>, was not square or even dimensioned. Any padding is at
Cristy882d9f42015-10-29 16:48:39 -04004698the right and/or bottom sides of the image.</p>
4699
4700<p>The <a href="http://www.fftw.org/">FFTW</a> delegate library is required to
4701use <a href="command-line-options.html#ift">-ift</a>.</p>
4702
4703<p>Use <a href="command-line-options.html#ift">+ift</a> (with HDRI enabled) to transform a pair of real
4704and imaginary images from the frequency domain to a single image in the normal
4705(spatial) domain.</p>
4706
Cristy594d2772015-11-15 10:47:42 -05004707<p>By default the IFT is not normalized (and the FFT is). Use "<code><a href="command-line-options.html#define" >-define</a> fourier:normalize=inverse</code> to explicitly normalize the IFT and unnormalize the FFT.</p>
Cristy882d9f42015-10-29 16:48:39 -04004708
4709<div style="margin: auto;">
4710 <h3 class="magick-header"><a id="immutable"></a>-immutable</h3>
4711</div>
4712
4713<p class="magick-description">make image immutable.</p>
4714
4715<div style="margin: auto;">
4716 <h3 class="magick-header"><a id="implode"></a>-implode <var>factor</var></h3>
4717</div>
4718
4719<p class="magick-description">implode image pixels about the center.</p>
4720
4721<div style="margin: auto;">
4722 <h3 class="magick-header"><a id="insert"></a>-insert <var>index</var></h3>
4723</div>
4724
4725<p class="magick-description">insert the last image into the image sequence.</p>
4726
4727<p>This option takes last image in the current image sequence and inserts it
4728at the given index. If a negative index is used, the insert position is
4729calculated before the last image is removed from the sequence. As such
4730<code>-insert -1</code> will result in no change to the image sequence.</p>
4731
4732<p>The <code>+insert</code> option is equivalent to <code>-insert -1</code>. In
4733other words, insert the last image, at the end of the current image sequence.
4734Consequently this has no effect on the image sequence order.</p>
4735
4736<div style="margin: auto;">
4737 <h3 class="magick-header"><a id="intensity"></a>-intensity <var>method</var></h3>
4738</div>
4739
4740<p class="magick-description">method to generate intensity value from pixel.</p>
4741
4742<p>ImageMagick provides a number of methods used in situations where an
4743operator needs to determine a single grayscale value for some purpose, from
4744an image with red, green, and blue pixel components. Typically the linear
4745<code>Rec709Luminance</code> formula is used, which is the same formula used when
4746converting images to <code>-colorspace gray</code>. </p>
4747
4748<p>The following formulas are currently provided, and will first convert
4749the pixel values to linear-RGB or non-linear sRGB colorspace before
4750being applied to calculate the final greyscale value. </p>
4751
4752<dl class="dl-horizontal">
4753<dt>Rec601Luma</dt><dd> 0.298839R' + 0.586811G'+ 0.114350B'</dd>
4754<dt>Rec601Luminance</dt><dd> 0.298839R + 0.586811G + 0.114350B</dd>
4755<dt>Rec709Luma</dt><dd> 0.212656R' + 0.715158G' + 0.072186B'</dd>
4756<dt>Rec709Luminance</dt><dd> 0.212656R + 0.715158G + 0.072186B</dd>
4757<dt>Brightness</dt><dd> max(R', G', B')</dd>
4758<dt>Lightness</dt><dd> (min(R', G', B') + max(R', G', B')) / 2.0</dd>
4759</dl>
4760
4761<p>Note that the above R,G,B values is the image's linear-RGB values, while
4762R',G',B' are sRGB non-linear values. </p>
4763
4764<p>These intensity methods are mathematical in nature and will use the
4765current value in the images respective R,G,B channel regardless of
4766what that is, or what colorspace the image is currently using.</p>
4767
4768<dl class="dl-horizontal">
4769<dt>Average</dt><dd>(R + G + B) / 3.0</dd>
4770<dt>MS</dt><dd>(R^2 + G^2 + B^2) / 3.0</dd>
4771<dt>RMS</dt><dd>sqrt( (R^2 + G^2 + B^2) / 3.0 )</dd>
4772</dl>
4773
4774<p>These methods are often used for other purposes, such as generating a
Cristy594d2772015-11-15 10:47:42 -05004775grayscale difference image between two color images (using <a href="command-line-options.html#compose"
4776>-compose</a> '<code>Difference</code>' composition. </p>
Cristy882d9f42015-10-29 16:48:39 -04004777
4778<p> For example The 'MS' (Mean Squared) setting is good for minimizing color
4779error comparisions. While... The method 'RMS' (Root Mean Squared) for
4780example is appropriate for calculating color vector distance, from a color
Cristy594d2772015-11-15 10:47:42 -05004781difference image. This is equivalent to the color only component of the <a
4782href="command-line-options.html#fuzz" >-fuzz</a> factor color compare setting. </p>
Cristy882d9f42015-10-29 16:48:39 -04004783
Cristy594d2772015-11-15 10:47:42 -05004784<p>See also <a href="command-line-options.html#grayscale" >-grayscale</a> which applies one of the above
4785grayscaling formula directly to an image without setting the <a
4786href="command-line-options.html#intensity" >-intensity</a> setting.</p>
Cristy882d9f42015-10-29 16:48:39 -04004787
Cristy594d2772015-11-15 10:47:42 -05004788<p>The <a href="command-line-options.html#colorspace" >-colorspace gray</a> image conversion also uses
Cristy882d9f42015-10-29 16:48:39 -04004789the current intensity setting, but will always convert the image to the
4790appropriate sRGB or linear-RGB colorspace before appling the above
4791function.</p>
4792
4793<p>To print a complete list of possible pixel intensity setting methods, use <a href="command-line-options.html#list">-list intensity</a>.</p>
4794
Cristy594d2772015-11-15 10:47:42 -05004795<p>Operators affected by the <a href="command-line-options.html#intensity" >-intensity</a> setting include:</p>
Cristy882d9f42015-10-29 16:48:39 -04004796
4797<pre>
4798-adaptive-blur
4799-adaptive-sharpen
4800-black-threshold
4801-clut (when mapping greyscale CLUT image to alpha channel if set by -channels)
4802-colors for gray colorspace
4803-compose {LightenIntensity, DarkenIntensity, CopyOpacity, CopyBlack}
4804-contrast-stretch
4805-distort {ErodeIntensity, DilateIntensity}
4806-normalize
4807-random-threshold
4808-selective-blur
4809-shade
4810-threshold
4811-tint
4812-white-threshold
4813</pre>
4814
4815<div style="margin: auto;">
4816 <h3 class="magick-header"><a id="intent"></a>-intent <var>type</var></h3>
4817</div>
4818
4819<p class="magick-description">use this type of rendering intent when managing the image color.</p>
4820
4821<p>Use this option to affect the color management operation of an image (see
4822<a href="command-line-options.html#profile">-profile</a>). Choose from these intents: <code>Absolute,
4823Perceptual, Relative, Saturation</code>.</p>
4824
4825<p>The default intent is Perceptual for the sRGB colorspace and undefined for the RGB and gray colorspaces.</p>
4826
4827<p>To print a complete list of rendering intents, use <a href="command-line-options.html#list">-list intent</a>.</p>
4828
4829<div style="margin: auto;">
4830 <h3 class="magick-header"><a id="interlace"></a>-interlace <var>type</var></h3>
4831</div>
4832
4833<p class="magick-description">the type of interlacing scheme.</p>
4834
4835<p>Choose from:</p>
4836
4837<pre>
4838none
4839line
4840plane
4841partition
4842JPEG
4843GIF
4844PNG
4845</pre>
4846
4847<p>This option is used to specify the type of interlacing scheme for raw image
4848formats such as <code>RGB</code> or <code>YUV</code>.</p>
4849
4850<p><code>None</code> means do not interlace (RGBRGBRGBRGBRGBRGB...),</p>
4851
4852<p><code>Line</code> uses scanline interlacing (RRR...GGG...BBB...RRR...GGG...BBB...), and.</p>
4853
4854<p><code>Plane</code> uses plane interlacing (RRRRRR...GGGGGG...BBBBBB...).</p>
4855
4856<p><code>Partition</code> is like plane except the different planes are saved to
4857individual files (e.g. image.R, image.G, and image.B).</p>
4858
4859<p>Use <code>Line</code> or <code>Plane</code> to create an <code>interlaced
4860PNG</code> or <code>GIF</code> or <code>progressive JPEG</code> image.</p>
4861
4862<p>To print a complete list of interlacing schemes, use <a href="command-line-options.html#list">-list
4863interlace</a>.</p>
4864
4865<div style="margin: auto;">
4866 <h3 class="magick-header"><a id="interpolate"></a>-interpolate <var>type</var></h3>
4867</div>
4868
4869<p class="magick-description">Set the pixel color interpolation method to use when looking up a color based on a floating point or real value.</p>
4870
4871<p>When looking up the color of a pixel using a non-integer floating point
4872value, you typically fall in between the pixel colors defined by the source
4873image. This setting determines how the color is determined from the colors of
4874the pixels surrounding that point. That is how to determine the color of a
4875point that falls between two, or even four different colored pixels. </p>
4876
4877<dl class="dl-horizontal">
4878 <dt>integer</dt>
4879 <dd>The color of the top-left pixel (floor function)</dd>
4880 <dt>nearest-neighbor</dt>
4881 <dd>The nearest pixel to the lookup point (rounded function)</dd>
4882 <dt>average</dt>
4883 <dd>The average color of the surrounding four pixels</dd>
4884 <dt>bilinear</dt>
4885 <dd>A double linear interpolation of pixels (the default)</dd>
4886 <dt>mesh</dt>
4887 <dd>Divide area into two flat triangular interpolations</dd>
4888 <dt>bicubic</dt>
4889 <dd>Fitted bicubic-spines of surrounding 16 pixels</dd>
4890 <dt>spline</dt>
4891 <dd>Direct spline curves (colors are blurred)</dd>
4892 <dt>filter</dt>
4893 <dd>Use resize <a href="command-line-options.html#filter">-filter</a> settings</dd>
4894</dl>
4895
Cristy594d2772015-11-15 10:47:42 -05004896<p>This most important for distortion operators such as <a href="command-line-options.html#distort"
4897>-distort</a>, <a href="command-line-options.html#implode" >-implode</a>, <a href="command-line-options.html#transform"
4898>-transform</a> and <a href="command-line-options.html#fx" >-fx</a>. </p>
Cristy882d9f42015-10-29 16:48:39 -04004899
4900<p>To print a complete list of interpolation methods, use <a href="command-line-options.html#list">-list interpolate</a>.</p>
4901
Cristy594d2772015-11-15 10:47:42 -05004902<p>See also <a href="command-line-options.html#virtual-pixel" >-virtual-pixel</a>, for control of the
Cristy882d9f42015-10-29 16:48:39 -04004903lookup for positions outside the boundaries of the image. </p>
4904
4905
4906<div style="margin: auto;">
4907 <h3 class="magick-header"><a id="interline-spacing"></a>-interline-spacing <var>value</var></h3>
4908</div>
4909
4910<p class="magick-description">the space between two text lines.</p>
4911
4912<div style="margin: auto;">
4913 <h3 class="magick-header"><a id="interword-spacing"></a>-interword-spacing <var>value</var></h3>
4914</div>
4915
4916<p class="magick-description">the space between two words.</p>
4917
4918<div style="margin: auto;">
4919 <h3 class="magick-header"><a id="kerning"></a>-kerning <var>value</var></h3>
4920</div>
4921
4922<p class="magick-description">the space between two letters.</p>
4923
4924<div style="margin: auto;">
Cristy594d2772015-11-15 10:47:42 -05004925 <h3 class="magick-header"><a id="kuwahara"></a>-kuwahara <var>radius</var><br />-kuwahara <var>radius</var>x<var>sigma</var></h3>
Cristy882d9f42015-10-29 16:48:39 -04004926</div>
4927
4928<p class="magick-description">edge preserving noise reduction filter.</p>
4929
Cristy594d2772015-11-15 10:47:42 -05004930<p>The <var >radius</var> is more important than the <var >sigma</var>. If <var >sigma</var> is left off, it will be computed automatically from the <var >radius</var> as <var >sigma</var>=<var >radius</var>-0.5. The <var >sigma</var> provides a bit of additional smoothing control.</p>
Cristy882d9f42015-10-29 16:48:39 -04004931
4932
4933<div style="margin: auto;">
4934 <h3 class="magick-header"><a id="label"></a>-label <var>name</var></h3>
4935</div>
4936
4937<p class="magick-description">assign a label to an image.</p>
4938
4939<p>Use this option to assign a specific label to the image, as it is read in
Cristy594d2772015-11-15 10:47:42 -05004940or created. You can use the <a href="command-line-options.html#set" >-set</a> operation to re-assign
Cristy882d9f42015-10-29 16:48:39 -04004941a the labels of images already read in. Image formats such as TIFF, PNG,
4942MIFF, supports saving the label information with the image.</p>
4943
4944<p>When saving an image to a <var>PostScript</var> file, any label
4945assigned to an image is used as a header string to print above the postscript
4946image. </p>
4947
4948<p>You can include the image filename, type, width, height, or other image
4949attribute by embedding special format character. See <a href="escape.html">Format and Print Image
4950Properties</a> for details of the percent escape codes.</p>
4951
4952<p>For example,</p>
4953
4954<pre>
4955-label "%m:%f %wx%h" bird.miff
4956</pre>
4957
4958<p>assigns an image label of <code>MIFF:bird.miff 512x480</code> to the
4959"<code>bird.miff</code>" image and whose width is 512 and height is 480, as it
4960is read in. If a <a href="command-line-options.html#label">+label</a> option was used instead, any
4961existing label present in the image would be used. You can remove all labels
4962from an image by assigning the empty string. </p>
4963
4964<p>A label is not drawn on the image, but is embedded in the image datastream
4965via <var>Label</var> tag or similar mechanism. If you want the label to be
4966visible on the image itself, use the <a href="command-line-options.html#draw">-draw</a> option, or
4967during the final processing in the creation of an image montage.</p>
4968
4969<p>If the first character of <var>string</var> is <var>@</var>, the image label is read from a file titled by the
4970remaining characters in the string. Labels in a file are literal, no embedded
4971formatting characters are recognized.</p>
4972
4973
4974<div style="margin: auto;">
Cristy594d2772015-11-15 10:47:42 -05004975 <h3 class="magick-header"><a id="lat"></a>-lat <var>width</var><br />-lat <var>width</var>x<var>height</var>{<var>+-</var>}<var>offset</var>{<var>%</var>}</h3>
Cristy882d9f42015-10-29 16:48:39 -04004976</div>
4977
4978<p class="magick-description">perform local adaptive threshold.</p>
4979
4980<p>Adaptively threshold each pixel based on the value of pixels in a
4981surrounding window. If the current pixel is lighter than this average plus
4982the optional <code>offset</code>, then it is made white, otherwise it is made
4983black. Small variations in pixel values such as found in scanned documents
4984can be ignored if offset is positive. A negative offset will make it more
4985sensitive to those small variations. </p>
4986
4987<p>This is commonly used to threshold images with an uneven background. It is
4988based on the assumption that average color of the small window is the
4989the local background color, from which to separate the foreground color. </p>
4990
4991
4992<div style="margin: auto;">
4993 <h3 class="magick-header"><a id="layers"></a>-layers <var>method</var></h3>
4994</div>
4995
4996<p class="magick-description">handle multiple images forming a set of image layers or animation frames.</p>
4997
4998<p>Perform various image operation methods to a ordered sequence of images
4999which may represent either a set of overlaid 'image layers', a GIF disposal
5000animation, or a fully-'coalesced' animation sequence. </p>
5001
5002<table class="table table-condensed table-striped">
5003 <tbody>
5004 <tr>
5005 <th style="width: 8%">Method</th>
5006 <th>Description</th>
5007 </tr>
5008
5009 <tr>
5010 <td>compare-any</td>
5011 <td>Crop the second and later frames to the smallest rectangle
Cristy594d2772015-11-15 10:47:42 -05005012 that contains all the differences between the two images. No GIF <a
5013 href="command-line-options.html#dispose" >-dispose</a> methods are taken into account. </td>
Cristy882d9f42015-10-29 16:48:39 -04005014 </tr>
5015
Cristy594d2772015-11-15 10:47:42 -05005016 <tr><td></td><td>This exactly the same as the <a href="command-line-options.html#deconstruct"
5017 >-deconstruct</a> operator, and does not preserve animations normal
Cristy882d9f42015-10-29 16:48:39 -04005018 working, especially when animation used layer disposal methods such as
5019 '<code>Previous</code>' or '<code>Background</code>'. </td>
5020 </tr>
5021
5022 <tr>
5023 <td>compare-clear</td>
5024 <td>As '<code>compare-any</code>' but crop to the bounds of any
5025 opaque pixels which become transparent in the second frame. That is the
5026 smallest image needed to mask or erase pixels for the next frame. </td>
5027 </tr>
5028
5029 <tr>
5030 <td>compare-overlay</td>
5031 <td>As '<code>compare-any</code>' but crop to pixels that add
5032 extra color to the next image, as a result of overlaying color pixels.
5033 That is the smallest single overlaid image to add or change colors. </td>
5034 </tr>
5035
Cristy594d2772015-11-15 10:47:42 -05005036 <tr><td></td><td>This can be used with the <a href="command-line-options.html#compose" >-compose</a> alpha
Cristy882d9f42015-10-29 16:48:39 -04005037 composition method '<code>change-mask</code>', to reduce the image to
5038 just the pixels that need to be overlaid. </td>
5039 </tr>
5040
5041 <tr>
5042 <td>coalesce</td>
Cristy594d2772015-11-15 10:47:42 -05005043 <td>Equivalent to a call to the <a href="command-line-options.html#coalesce"
5044 >-coalesce</a> operator. Apply the layer disposal methods set in the
Cristy882d9f42015-10-29 16:48:39 -04005045 current image sequence to form a fully defined animation sequence, as
5046 it should be displayed. Effectively converting a GIF animation into a
5047 'film strip'-like animation. </td>
5048 </tr>
5049
5050 <tr>
5051 <td>composite</td>
5052 <td>Alpha Composition of two image lists, separated by a
5053 "<code>null:</code>" image, with the destination image list first, and
5054 the source images last. An image from each list are composited
5055 together until one list is finished. The separator image and source
5056 image lists are removed. </td>
5057 </tr>
5058
5059
5060 <tr><td></td>
Cristy594d2772015-11-15 10:47:42 -05005061 <td>The <a href="command-line-options.html#geometry" >-geometry</a> offset is adjusted according
5062 to <a href="command-line-options.html#gravity" >-gravity</a> in accordance of the virtual
5063 canvas size of the first image in each list. Unlike a normal <a
5064 href="command-line-options.html#composite" >-composite</a> operation, the canvas offset is also
Cristy882d9f42015-10-29 16:48:39 -04005065 added to the final composite positioning of each image. </td> </tr>
5066
5067 <tr><td></td>
5068 <td>If one of the image lists only contains one image, that image is
5069 applied to all the images in the other image list, regardless of which
5070 list it is. In this case it is the image meta-data of the list which
5071 preserved. </td>
5072 </tr>
5073
5074
5075 <tr>
5076 <td>dispose</td>
5077 <td>This like '<code>coalesce</code>' but shows the look of
5078 the animation after the layer disposal method has been applied, before
5079 the next sub-frame image is overlaid. That is the 'dispose' image that
Cristy594d2772015-11-15 10:47:42 -05005080 results from the application of the GIF <a href="command-line-options.html#dispose"
5081 >-dispose</a> method. This allows you to check what
Cristy882d9f42015-10-29 16:48:39 -04005082 is going wrong with a particular animation you may be developing.
5083 </td>
5084 </tr>
5085
5086 <tr>
5087 <td>flatten</td>
5088 <td>Create a canvas the size of the first images virtual
Cristy594d2772015-11-15 10:47:42 -05005089 canvas using the current <a href="command-line-options.html#background" >-background</a> color,
5090 and <a href="command-line-options.html#compose" >-compose</a> each image in turn onto that
Cristy882d9f42015-10-29 16:48:39 -04005091 canvas. Images falling outside that canvas is clipped. Final
5092 image will have a zero virtual canvas offset. </td>
5093 </tr>
5094
5095 <tr><td></td>
5096 <td>This usually used as one of the final 'image layering' operations
5097 overlaying all the prepared image layers into a final image. </td>
5098 </tr>
5099
5100 <tr><td></td>
5101 <td>For a single image this method can also be used to fillout a virtual
5102 canvas with real pixels, or to underlay an opaque color to remove
5103 transparency from an image.</td>
5104 </tr>
5105
5106
5107 <tr>
5108 <td>merge</td>
5109 <td>As 'flatten' method but merging all the given image
5110 layers to create a new layer image just large enough to hold all the
5111 image without clipping or extra space. The new images virtual offset
5112 will preserve the position of the new layer, even if this offset is
5113 negative. The virtual canvas size of the first image is preserved.
5114 </td>
5115 </tr>
5116
5117 <tr><td></td><td>Caution is advised when handling image layers with
5118 negative offsets as few image file formats handle them correctly.
Cristy594d2772015-11-15 10:47:42 -05005119 Following this operation method with <a href="command-line-options.html#repage" >+repage</a>
Cristy882d9f42015-10-29 16:48:39 -04005120 will remove the layer offset, and create an image in which all the
5121 overlaid image positions relative to each other is preserved, though
5122 not necessarily exactly where you specified them.
5123 </td>
5124 </tr>
5125
5126 <tr><td></td><td>See also 'trim-bounds' below which is closely related but
5127 without doing the'flatten' to merge the images together. </td>
5128 </tr>
5129
5130 <tr>
5131 <td>mosaic</td>
5132 <td>As 'flatten' method but expanding the initial canvas size
5133 of the first image in a positive direction only so as to hold all the
5134 image layers. However as a virtual canvas is 'locked' to the origin,
5135 by its own definition, image layers with a negative offsets will still
5136 become clipped by the top and left edges. See 'merge' or 'trim-bounds'
5137 if this could be a problem. </td>
5138
5139 </tr>
5140
5141 <tr><td></td><td>This method is commonly used to layout individual image
5142 using various offset but without knowing the final canvas size. The
5143 resulting image will, like 'flatten' not have any virtual offset, so
5144 can be saved to any image file format. </td>
5145 </tr>
5146
5147
5148 <tr>
5149 <td>optimize</td>
5150 <td>Optimize a coalesced animation, into GIF animation using
5151 a number of general techniques. This currently a short cut to
5152 apply both the '<code>optimize-frame</code>', and
5153 '<code>optimize-transparency</code>' methods but may be expanded to
5154 include other optimization methods as they are developed. </td>
5155 </tr>
5156
5157 <tr>
5158 <td>optimize-frame</td>
5159 <td>Optimize a coalesced animation, into GIF animation by
5160 reducing the number of pixels per frame as much as possible by
5161 attempting to pick the best layer disposal method to use, while ensuring
5162 the result will continue to animate properly. </td>
5163 </tr>
5164
5165 <tr><td></td><td> There is no guarantee that the best optimization is found.
5166 But then no reasonably fast GIF optimization algorithm can do this.
5167 However this does seem to do better than most other GIF frame
5168 optimizers seen. </td>
5169 </tr>
5170
5171 <tr>
5172 <td>optimize-plus</td>
5173 <td>As '<code>optimize-frame</code>' but attempt to improve the
5174 overall optimization by adding extra frames to the animation, without
5175 changing the final look or timing of the animation. The frames are
5176 added to attempt to separate the clearing of pixels from the
5177 overlaying of new additional pixels from one animation frame to the
5178 next. If this does not improve the optimization (for the next frame
5179 only), it will fall back to the results of the previous normal
5180 '<code>optimize-frame</code>' technique. </td>
5181 </tr>
5182
5183 <tr><td></td><td>There is the possibility that the change in the disposal
5184 style will result in a worsening in the optimization of later frames,
5185 though this is unlikely. In other words there no guarantee that it is
5186 better than the normal '<code>optimize-frame</code>' technique. For some
5187 animations however you can get a vast improvement in the final
5188 animation size. </td>
5189 </tr>
5190
5191 <tr>
5192 <td>optimize-transparency</td>
5193 <td>Given a GIF animation, replace any pixel in the sub-frame
5194 overlay images with transparency, if it does not change the resulting
Cristy594d2772015-11-15 10:47:42 -05005195 animation by more than the current <a href="command-line-options.html#fuzz" >-fuzz</a> factor.
Cristy882d9f42015-10-29 16:48:39 -04005196 </td>
5197 </tr>
5198
5199 <tr><td></td><td>This should allow a existing frame optimized GIF animation
5200 to compress into a smaller file size due to larger areas of one
5201 (transparent) color rather than a pattern of multiple colors repeating
5202 the current disposed image of the last frame. </td>
5203 </tr>
5204
5205 <tr>
5206 <td>remove-dups</td>
5207 <td>Remove (and merge time delays) of duplicate consecutive
5208 images, so as to simplify layer overlays of coalesced animations.
5209 </td>
5210 </tr>
5211
5212 <tr><td></td><td>Usually this a result of using a constant time delay
5213 across the whole animation, or after a larger animation was split into
5214 smaller sub-animations. The duplicate frames could also have been
5215 used as part of some frame optimization methods. </td>
5216 </tr>
5217
5218 <tr>
5219 <td>remove-zero</td>
5220 <td>Remove any image with a zero time delay, unless ALL the
5221 images have a zero time delay (and is not a proper timed animation, a
5222 warning is then issued). </td>
5223 </tr>
5224
5225 <tr><td></td><td>In a GIF animation, such images are usually frames which
5226 provide partial intermediary updates between the frames that are
5227 actually displayed to users. These frames are usually added for
5228 improved frame optimization in GIF animations. </td>
5229 </tr>
5230
5231 <tr>
5232 <td>trim-bounds</td>
5233 <td>Find the bounds of all the images in the current
5234 image sequence, then adjust the offsets so all images are contained on
5235 a minimal positive canvas. None of the image data is modified or
5236 merged, only the individual image virtual canvas size and offset.
5237 All the images is given the same canvas size, and and will have
5238 a positive offset, but will remain in the same position relative to
5239 each other. As a result of the minimal canvas size at least one image
5240 will touch every edge of that canvas. The image data touching those
5241 edges however may be transparent. </td>
5242 </tr>
5243
5244 <tr><td></td><td>The result is much like if you used 'merge' followed by a
Cristy594d2772015-11-15 10:47:42 -05005245 <a href="command-line-options.html#repage" >+repage</a> option, except that all the images
Cristy882d9f42015-10-29 16:48:39 -04005246 have been kept separate. If 'flatten' is used after using
5247 'trim-bounds' you will get the same result. </td>
5248 </tr>
5249
5250 </tbody>
5251</table>
5252
5253<p>To print a complete list of layer types, use <a href="command-line-options.html#list">-list layers</a>.</p>
5254
Cristy594d2772015-11-15 10:47:42 -05005255<p>The operators <a href="command-line-options.html#coalesce" >-coalesce</a>, <a href="command-line-options.html#deconstruct"
5256>-deconstruct</a>, <a href="command-line-options.html#flatten" >-flatten</a>, and <a href="command-line-options.html#mosaic"
5257>-mosaic</a> are only aliases for the above methods and may be depreciated in
5258the future. Also see <a href="command-line-options.html#page" >-page</a>, <a href="command-line-options.html#repage"
5259>-repage</a> operators, the <a href="command-line-options.html#compose" >-compose</a> setting, and the
5260GIF <a href="command-line-options.html#dispose" >-dispose</a> and <a href="command-line-options.html#delay" >-delay</a>
Cristy882d9f42015-10-29 16:48:39 -04005261settings. </p>
5262
5263
5264<div style="margin: auto;">
5265 <h3 class="magick-header"><a id="level"></a>-level <var>black_point</var>{,<var>white_point</var>}{<var>%</var>}{,<var>gamma</var>}</h3>
5266</div>
5267
5268<p class="magick-description">adjust the level of image channels.</p>
5269
5270<p>Given one, two or three values delimited with commas: black-point,
5271white-point, gamma (for example: 10,250,1.0 or 2%,98%,0.5). The black and
5272white points range from 0 to <var>QuantumRange</var>, or from 0 to
5273100%; if the white point is omitted it is set to (<var>QuantumRange</var> - black_point), so as to center contrast changes.
5274If a <code>%</code> sign is present anywhere in the string, both black and white
Cristy594d2772015-11-15 10:47:42 -05005275points are percentages of the full color range. Gamma will do a <a
5276href="command-line-options.html#gamma">-gamma</a> adjustment of the values. If it is omitted, the
Cristy882d9f42015-10-29 16:48:39 -04005277default of 1.0 (no gamma correction) is assumed.</p>
5278
5279<p>In normal usage (<code>-level</code>) the image values are stretched so that
5280the given '<code>black_point</code>' value in the original image is set to zero
5281(or black), while the given '<code>white_point</code>' value is set to <var>QuantumRange</var> (or white). This provides you with direct
5282contrast adjustments to the image. The '<code>gamma</code>' of the resulting
5283image will then be adjusted. </p>
5284
5285<p>From ImageMagick v6.4.1-9 using the plus form of the operator
5286(<code>+level</code>) or adding the special '!' flag anywhere in the argument
5287list, will cause the operator to do the reverse of the level adjustment. That
5288is a zero, or <var>QuantumRange</var> value (black, and white, resp.)
5289in the original image, is adjusted to the given level values, allowing you to
5290de-contrast, or compress the channel values within the image. The
5291'<code>gamma</code>' is adjusted before the level adjustment to de-contrast the
5292image is made. </p>
5293
5294<p>Only the channels defined by the current <a href="command-line-options.html#channel">-channel</a>
5295setting are adjusted (defaults to RGB color channels only), allowing you to
5296limit the effect of this operator. </p>
5297
5298<p>Please note that the transparency channel is treated as 'matte'
5299values (0 is opaque) and not as 'alpha' values (0 is transparent).</p>
5300
5301
5302<div style="margin: auto;">
5303 <h3 class="magick-header"><a id="level-colors"></a>-level-colors {<var>black_color</var>}{,}{<var>white_color</var>}</h3>
5304</div>
5305
5306<p class="magick-description">adjust the level of an image using the provided dash separated colors.</p>
5307
5308<p>This function is exactly like <a href="command-line-options.html#level">-level</a>, except that the
5309value value for each color channel is determined by the
5310'<code>black_color</code>' and '<code>white_color</code>' colors given (as
5311described under the <a href="command-line-options.html#fill">-fill</a> option). </p>
5312
5313<p>This effectually means the colors provided to <code>-level-colors</code>
5314is mapped to become 'black' and 'white' respectively, with all the other
5315colors linearly adjusted (or clipped) to match that change. Each channel is
5316adjusted separately using the channel values of the colors specified. </p>
5317
5318<p>On the other hand the plus form of the operator (<code>+level-colors</code>)
5319will map the image color 'black' and 'white' to the given colors
5320respectively, resulting in a gradient (de-contrasting) tint of the image to
Cristy769d8892016-01-19 18:11:14 -05005321those colors. This can also be used to convert a plain grayscale image into a
Cristy882d9f42015-10-29 16:48:39 -04005322one using the gradient of colors specified. </p>
5323
5324<p>By supplying a single color with a comma separator either before or after
5325that color, will just replace the respective 'black' or 'white' point
5326respectively. But if no comma separator is provided, the given color is
5327used for both the black and white color points, making the operator either
5328threshold the images around that color (- form) or set all colors to that
5329color (+ form). </p>
5330
5331
5332<div style="margin: auto;">
5333 <h3 class="magick-header"><a id="limit"></a>-limit <var>type value</var></h3>
5334</div>
5335
5336<p class="magick-description">Set the pixel cache resource limit.</p>
5337
Cristye09ed312016-03-06 08:07:39 -05005338<p>Choose from: <code>width</code>, <code>height</code>, <code>area</code>, <code>memory</code>, <code>map</code>, <code>disk</code>, <code>file</code>, <code>thread</code>, <code>throttle</code>, or <code>time</code>.</p>
Cristy882d9f42015-10-29 16:48:39 -04005339
5340<p>The value for <code>file</code> is in number of files. The other limits are
5341in bytes. Define arguments for the memory, map, area, and disk resource limits
5342with SI prefixes (.e.g 100MB).</p>
5343
5344<p>By default the limits are 768 files, 3GB of image area, 1.5GiB memory, 3GiB
5345memory map, and 18.45EB of disk. These limits are adjusted relative to the
5346available resources on your computer if this information is available. When
5347any limit is reached, ImageMagick fails in some fashion but attempts to take
5348compensating actions, if possible. For example, the following limits
5349memory:</p>
5350
5351<pre>
5352-limit memory 32MiB -limit map 64MiB
5353</pre>
5354
5355<p>Use <a href="command-line-options.html#list">-list resource</a> to list the current limits. For example, our system shows these limits:</p>
5356
5357<pre>
Cristy594d2772015-11-15 10:47:42 -05005358-> identify -list resource
Cristy882d9f42015-10-29 16:48:39 -04005359Resource limits:
5360 Width: 100MP
5361 Height: 100MP
5362 Area: 25.181GB
5363 Memory: 11.726GiB
5364 Map: 23.452GiB
5365 Disk: unlimited
5366 File: 768
5367 Thread: 12
5368 Throttle: 0
5369 Time: unlimited
5370</pre>
5371
5372<p>Requests for pixel storage to keep intermediate images are satisfied by one
5373of three resource categories: in-memory pool, memory-mapped files pool, and
Cristy594d2772015-11-15 10:47:42 -05005374disk pool (in that order) depending on the <a href="command-line-options.html#limit">&#x2011;limit</a> settings
Cristy882d9f42015-10-29 16:48:39 -04005375and whether the system honors a resource request. If the total size of
5376allocated pixel storage in the given pool reaches the corresponding limit, the
5377request is passed to the next pool. Additionally, requests that exceed the
5378<code>area</code> limit automagically are allocated on disk.</p>
5379
5380<p>To illustrate how ImageMagick utilizes resource limits, consider a typical
5381image resource request. First, ImageMagick tries to allocate the pixels in
5382memory. The request might be denied if the resource request exceeds the
5383<code>memory</code> limit or if the system does not honor the request. If
5384a memory request is not honored, the pixels are allocated to disk and the file
5385is memory-mapped. However, if the allocation request exceeds the
5386<code>map</code> limit, the resource allocation goes to disk. In all cases, if
5387the resource request exceeds the <code>area</code> limit, the pixels are
5388automagically cached to disk. If the disk has a hard limit, the program
5389fails.</p>
5390
5391<p>In most cases you simply do not need to concern yourself with resource
5392limits. ImageMagick chooses reasonable defaults and most images do not tax
5393your computer resources. Where limits do come in handy is when you process
5394images that are large or on shared systems where ImageMagick can consume all
5395or most of the available memory. In this case, the ImageMagick workflow slows
5396other processes or, in extreme cases, brings the system to a halt. Under
5397these circumstances, setting limits give some assurances that the ImageMagick
5398workflow will not interfere with other concurrent uses of the computer. For
5399example, assume you have a web interface that processes images uploaded from
5400the Internet. To assure ImageMagick does not exceed 10MiB of memory you can
5401simply set the area limit to 10MiB:</p>
5402
5403<pre>
5404-limit area 10MB
5405</pre>
5406
5407<p>Now whenever a large image is processed, the pixels are automagically
5408cached to disk instead of memory. This of course implies that large images
5409typically process very slowly, simply because pixel processing in memory can
5410be an order of magnitude faster than on disk. Because your web site users
5411might inadvertently upload a huge image to process, you should set a disk
5412limit as well:</p>
5413
5414<pre>
5415-limit area 10MB -limit disk 500MB
5416</pre>
5417
5418<p>Here ImageMagick stops processing if an image requires more than 500MB of disk storage.</p>
5419
5420<p>In addition to command-line resource limit option, resources can be set
Cristy594d2772015-11-15 10:47:42 -05005421with <a href="resources.html#environment" >environment variables</a>. Set the
Cristy882d9f42015-10-29 16:48:39 -04005422environment variables <code>MAGICK_AREA_LIMIT</code>,
5423<code>MAGICK_DISK_LIMIT</code>, <code>MAGICK_FILE_LIMIT</code>,
5424<code>MAGICK_MEMORY_LIMIT</code>, <code>MAGICK_MAP_LIMIT</code>,
5425<code>MAGICK_THREAD_LIMIT</code>, <code>MAGICK_TIME_LIMIT</code> for limits of
5426image area, disk space, open files, heap memory, memory map, number of threads
5427of execution, and maximum elapsed time in seconds respectively.</p>
5428
5429<p> Inquisitive users can try adding <a href="command-line-options.html#debug">-debug cache</a> to
5430their commands and then scouring the generated output for references to the
5431pixel cache, in order to determine how the pixel cache was allocated and how
5432resources were consumed. Advanced Unix/Linux users can pipe that output
5433through <code>grep memory|open|destroy|disk</code> for more readable sifting.
5434</p>
5435
5436<p>For more about ImageMagick's use of resources, see the section <b>Cache
Cristy594d2772015-11-15 10:47:42 -05005437Storage and Resource Requirements</b> on the <a href="architecture.html#cache
5438">Architecture</a> page. </p>
Cristy882d9f42015-10-29 16:48:39 -04005439
5440<div style="margin: auto;">
Cristy769d8892016-01-19 18:11:14 -05005441 <h3 class="magick-header"><a id="linear-stretch"></a>-linear-stretch <var>black-point</var><br />-linear-stretch <var>black-point</var>{x<var>white-point</var>}{<var>%</var>}</h3>
Cristy882d9f42015-10-29 16:48:39 -04005442</div>
5443
5444<p class="magick-description">Linear with saturation stretch.</p>
5445
Cristy594d2772015-11-15 10:47:42 -05005446<p>This is very similar to <a href="command-line-options.html#contrast-stretch" >-contrast-stretch</a>,
Cristy882d9f42015-10-29 16:48:39 -04005447and uses a 'histogram bin' to determine the range of color values that needs to
Cristy594d2772015-11-15 10:47:42 -05005448be stretched. However it then stretches those colors using the <a
5449href="command-line-options.html#level" >-level</a> operator.</p>
Cristy882d9f42015-10-29 16:48:39 -04005450
5451<p>As such while the initial determination may have 'binning' round off
5452effects, the image colors are stretched mathematically, rather than using the
5453histogram bins. This makes the operator more accurate. </p>
5454
Cristy594d2772015-11-15 10:47:42 -05005455<p>note however that a <a href="command-line-options.html#linear-stretch" >-linear-stretch</a> of
Cristy882d9f42015-10-29 16:48:39 -04005456'<code>0</code>' does nothing, while a value of '<code>1</code>' does a near
5457perfect stretch of the color range. </p>
5458
Cristy594d2772015-11-15 10:47:42 -05005459<p>See also <a href="command-line-options.html#auto-level" >-auto-level</a> for a 'perfect'
Cristy882d9f42015-10-29 16:48:39 -04005460normalization of mathematical images. </p>
5461
5462<p>This operator is under review for re-development. </p>
5463
5464
5465<div style="margin: auto;">
5466 <h3 class="magick-header"><a id="linewidth"></a>-linewidth</h3>
5467</div>
5468
5469<p class="magick-description">the line width for subsequent draw operations.</p>
5470
5471<div style="margin: auto;">
5472 <h3 class="magick-header"><a id="liquid-rescale"></a>-liquid-rescale <var>geometry</var></h3>
5473</div>
5474
5475<p class="magick-description">rescale image with seam-carving.</p>
5476
5477<p>See <a href="command-line-processing.html#geometry">Image Geometry</a> for complete details about the <em class="arg">geometry</em> argument.</p>
5478
5479<div style="margin: auto;">
5480 <h3 class="magick-header"><a id="list"></a>-list <var>type</var></h3>
5481</div>
5482
5483<p class="magick-description">Print a list of supported arguments for various options or settings. Choose from these list types:</p>
5484
5485<pre class="pre-scrollable">
5486Align
5487Alpha
5488Boolean
5489Cache
5490Channel
5491Class
5492ClipPath
5493Coder
5494Color
5495Colorspace
5496Command
5497Complex
5498Compose
5499Compress
5500Configure
5501DataType
5502Debug
5503Decoration
5504Delegate
5505Direction
5506Dispose
5507Distort
5508Dither
5509Endian
5510Evaluate
5511FillRule
5512Filter
5513Font
5514Format
5515Function
5516Gravity
5517Intensity
5518Intent
5519Interlace
5520Interpolate
5521Kernel
5522Layers
5523LineCap
5524LineJoin
5525List
5526Locale
5527LogEvent
5528Log
5529Magic
5530Method
5531Metric
5532Mime
5533Mode
5534Morphology
5535Module
5536Noise
5537Orientation
5538PixelIntensity
5539Policy
5540PolicyDomain
5541PolicyRights
5542Preview
5543Primitive
5544QuantumFormat
5545Resource
5546SparseColor
5547Statistic
5548Storage
5549Stretch
5550Style
5551Threshold
5552Type
5553Units
5554Validate
5555VirtualPixel
5556</pre>
5557
5558<p>These lists vary depending on your version of ImageMagick. Use "<code>-list
5559list</code>" to get a complete listing of all the "<code>-list</code>" arguments
5560available:</p>
5561
5562<pre>
5563identify -list list
5564</pre>
5565
5566<div style="margin: auto;">
5567 <h3 class="magick-header"><a id="log"></a>-log <var>string</var></h3>
5568</div>
5569
5570<p class="magick-description">Specify format for debug log.</p>
5571
Cristy594d2772015-11-15 10:47:42 -05005572<p>This option specifies the format for the log printed when the <a
5573href="command-line-options.html#debug">-debug</a> option is active.</p>
Cristy882d9f42015-10-29 16:48:39 -04005574
5575<p>You can display the following components by embedding special format
5576characters:</p>
5577
5578<dl class="dl-horizontal">
5579<dt>%d</dt><dd>domain</dd>
5580<dt>%e</dt><dd>event</dd>
5581<dt>%f</dt><dd>function</dd>
5582<dt>%l</dt><dd>line</dd>
5583<dt>%m</dt><dd>module</dd>
5584<dt>%p</dt><dd>process ID</dd>
5585<dt>%r</dt><dd>real CPU time</dd>
5586<dt>%t</dt><dd>wall clock time</dd>
5587<dt>%u</dt><dd>user CPU time</dd>
5588<dt>%%</dt><dd>percent sign</dd>
5589<dt>\n</dt><dd>newline</dd>
5590<dt>\r</dt><dd>carriage return</dd>
5591</dl>
5592
5593<p>For example:</p>
5594
5595<pre>
5596convert -debug coders -log "%u %m:%l %e" in.gif out.png
5597</pre>
5598
5599<p>The default behavior is to print all of the components.</p>
5600
5601<div style="margin: auto;">
5602 <h3 class="magick-header"><a id="loop"></a>-loop <var>iterations</var></h3>
5603</div>
5604
5605<p class="magick-description">add Netscape loop extension to your GIF animation.</p>
5606
5607<p>Set iterations to zero to repeat the animation an infinite number of times,
5608otherwise the animation repeats itself up to <var>iterations</var>
5609times.</p>
5610
5611<div style="margin: auto;">
5612 <h3 class="magick-header"><a id="lowlight-color"></a>-lowlight-color <var>color</var></h3>
5613</div>
5614
5615<p class="magick-description">when comparing images, de-emphasize pixel differences with this color.</p>
5616
5617<div style="margin: auto;">
5618 <h3 class="magick-header"><a id="magnify"></a>-magnify</h3>
5619</div>
5620
5621<p class="magick-description">double the size of the image with pixel art scaling.</p>
5622
5623
5624<div style="margin: auto;">
5625 <h3 class="magick-header"><a id="map"></a>-map <var>type</var></h3>
5626</div>
5627
5628<p class="magick-description">Display image using this <var>type</var>.</p>
5629
5630<p>Choose from these <var>Standard Colormap</var> types:</p>
5631
5632<pre>
5633best
5634default
5635gray
5636red
5637green
5638blue
5639</pre>
5640
5641<p>The <var>X server</var> must support the <var>Standard
5642Colormap</var> you choose, otherwise an error occurs. Use <code>list</code> as
5643the type and <code>display</code> searches the list of colormap types in
5644<code>top-to-bottom</code> order until one is located. See <var>xstdcmap(1)</var> for one way of creating Standard Colormaps.</p>
5645
5646
5647<div style="margin: auto;">
5648 <h3 class="magick-header"><a id="map_stream_"></a>-map <var>components</var></h3>
5649</div>
5650
5651<p class="magick-description">pixel map.</p>
5652
5653<p>Here are the valid components of a map:</p>
5654
5655<dl class="dl-horizontal">
5656<dt>r</dt><dd> red pixel component</dd>
5657<dt>g</dt><dd> green pixel component</dd>
5658<dt>b</dt><dd> blue pixel component</dd>
5659<dt>a</dt><dd> alpha pixel component (0 is transparent)</dd>
5660<dt>o</dt><dd> opacity pixel component (0 is opaque)</dd>
5661<dt>i</dt><dd> grayscale intensity pixel component</dd>
5662<dt>c</dt><dd> cyan pixel component</dd>
5663<dt>m</dt><dd> magenta pixel component</dd>
5664<dt>y</dt><dd> yellow pixel component</dd>
5665<dt>k</dt><dd> black pixel component</dd>
5666<dt>p</dt><dd> pad component (always 0)</dd>
5667</dl>
5668
5669<p>You can specify as many of these components as needed in any order (e.g.
5670bgr). The components can repeat as well (e.g. rgbr).</p>
5671
5672
5673<div style="margin: auto;">
Cristy882d9f42015-10-29 16:48:39 -04005674 <h3 class="magick-header"><a id="mattecolor"></a>-mattecolor <var>color</var></h3>
5675</div>
5676
5677<p class="magick-description">Specify the color to be used with the <a href="command-line-options.html#frame">-frame</a> option.</p>
5678
5679<p>The color is specified using the format described under the <a href="command-line-options.html#fill">-fill</a> option.</p>
5680
Cristy594d2772015-11-15 10:47:42 -05005681<p>The default matte color is <code>#BDBDBD</code>, <span
5682style="background-color: #bdbdbd;">this shade of gray</span>.</p>
Cristy882d9f42015-10-29 16:48:39 -04005683
5684<div style="margin: auto;">
5685 <h3 class="magick-header"><a id="maximum"></a>-maximum</h3>
5686</div>
5687
5688<p class="magick-description">return the maximum intensity of an image sequence.</p>
5689
5690<p>Select the 'maximum' value from all the surrounding pixels. </p>
5691
Cristy594d2772015-11-15 10:47:42 -05005692<p>This is legacy option from the <a href="command-line-options.html#statistic" >method</a> of the same
Cristy882d9f42015-10-29 16:48:39 -04005693name. </p>
5694
5695<div style="margin: auto;">
5696 <h3 class="magick-header"><a id="median"></a>-median <var>geometry</var></h3>
5697</div>
5698
5699<p class="magick-description">apply a median filter to the image.</p>
5700
5701<p>Select the 'middle' value from all the surrounding pixels. </p>
5702
Cristy594d2772015-11-15 10:47:42 -05005703<p>This is legacy option from the <a href="command-line-options.html#statistic" >method</a> of the same
Cristy882d9f42015-10-29 16:48:39 -04005704name. </p>
5705
5706<div style="margin: auto;">
Cristy769d8892016-01-19 18:11:14 -05005707 <h3 class="magick-header"><a id="mean-shift"></a>-mean-shift <var>width</var>x<var>height</var>{<var>+distance</var>{%}</h3>
Cristy882d9f42015-10-29 16:48:39 -04005708</div>
5709
5710<p class="magick-description">image noise removal and color reduction/segmentation (e.g. -mean-shift 7x7+10%).</p>
5711
5712<p><var>width</var>x<var>height</var> is the window size and <var>distance</var> is the color distance measured in the range 0 to 1 or 0 to 100%</p>
5713
5714<p>The mean shift algorithm is iterative and thus slower the larger the window size. For each pixel, it gets all the pixels in the window centered at the pixel and excludes those that are outside the <var>radius=sqrt((width-1)(height-1)/4)</var> surrounding the pixel. From those pixels, it finds which of them are within the specified squared color distance from the current mean. It then computes a new x,y centroid from those coordinates and a new mean. This new x,y centroid is used as the center for a new window. This process is iterated until it converges and the final mean is then used to replace the original pixel value. It repeats this process for the next pixel, etc, until it processes all pixels in the image. Results are better when using other colorspaces rather than RGB. Recommend YIQ, YUV or YCbCr, which seem to give equivalent results.</p>
5715
5716<div style="margin: auto;">
5717 <h3 class="magick-header"><a id="metric"></a>-metric <var>type</var></h3>
5718</div>
5719
5720<p class="magick-description">Output to STDERR a measure of the differences between images according to the <var>type</var> given metric.</p>
5721
5722<p>Choose from:</p>
5723
5724<dl class="dl-horizontal">
5725<dt>AE</dt><dd> absolute error count, number of different pixels (-fuzz effected)</dd>
5726<dt>FUZZ</dt><dd> mean color distance</dd>
5727<dt>MAE</dt><dd> mean absolute error (normalized), average channel error distance</dd>
5728<dt>MEPP</dt><dd> mean error per pixel (normalized mean error, normalized peak error)</dd>
5729<dt>MSE</dt><dd> mean error squared, average of the channel error squared</dd>
5730<dt>NCC</dt><dd> normalized cross correlation</dd>
5731<dt>PAE</dt><dd> peak absolute (normalized peak absolute)</dd>
Cristy3b0b58d2016-11-06 07:40:23 -05005732<dt>PHASH</dt><dd> perceptual hash for the sRGB and HCLp colorspaces. Specify an alternative colorspace with <code>-define phash:colorspaces=<var>colorspace,colorspace,...</var></code></dd>
Cristy882d9f42015-10-29 16:48:39 -04005733<dt>PSNR</dt><dd> peak signal to noise ratio</dd>
5734<dt>RMSE</dt><dd> root mean squared (normalized root mean squared)</dd>
5735</dl>
5736
5737<p>Control the '<code>AE</code>', or absolute count of pixels that are different,
Cristy594d2772015-11-15 10:47:42 -05005738with the <a href="command-line-options.html#fuzz" >-fuzz</a> factor (ignore pixels which
Cristy882d9f42015-10-29 16:48:39 -04005739only changed by a small amount). Use '<code>PAE</code>' to find the
Cristy594d2772015-11-15 10:47:42 -05005740size of the <a href="command-line-options.html#fuzz" >-fuzz</a> factor needed to make all pixels
Cristy882d9f42015-10-29 16:48:39 -04005741'similar', while '<code>MAE</code>' determines the factor needed
5742for about half the pixels to be similar. </p>
5743
5744<p>The '<code>MEPP</code>' metric returns three different metrics
5745('<code>MAE</code>', '<code>MAE</code>' normalized, and '<code>PAE</code>'
5746normalized) from a single comparison run. </p>
5747
5748<p>To print a complete list of metrics, use the <a href="command-line-options.html#list">-list
5749metric</a> option.</p>
5750
5751
5752<div style="margin: auto;">
5753 <h3 class="magick-header"><a id="minimum"></a>-minimum</h3>
5754</div>
5755
5756<p class="magick-description">return the minimum intensity of an image sequence.</p>
5757
5758<p>Select the 'minimal' value from all the surrounding pixels. </p>
5759
Cristy594d2772015-11-15 10:47:42 -05005760<p>This is legacy option from the <a href="command-line-options.html#statistic" >method</a> of the same
Cristy882d9f42015-10-29 16:48:39 -04005761name. </p>
5762
5763
5764
5765<div style="margin: auto;">
5766 <h3 class="magick-header"><a id="mode"></a>-mode <var>geometry</var></h3>
5767</div>
5768
5769<p class="magick-description">make each pixel the \'predominant color\' of the neighborhood.'</p>
5770
5771<div style="margin: auto;">
5772 <h3 class="magick-header">-mode <var>value</var></h3>
5773</div>
5774
5775<p class="magick-description">Mode of operation.</p>
5776
5777<p>Choose the <var>value</var> from these styles: <code>Frame,
5778Unframe, or Concatenate</code></p>
5779
Cristy594d2772015-11-15 10:47:42 -05005780<p>Use the <a href="command-line-options.html#list" >-list</a> option with a '<code>Mode</code>' argument
5781for a list of <a href="command-line-options.html#mode" >-mode</a> arguments available in your
Cristy882d9f42015-10-29 16:48:39 -04005782ImageMagick installation.</p>
5783
5784
5785<div style="margin: auto;">
5786 <h3 class="magick-header"><a id="modulate"></a>-modulate <var>brightness</var>[,<var>saturation</var>,<var>hue</var>]</h3>
5787</div>
5788
5789<p class="magick-description">Vary the <var>brightness</var>, <var>saturation</var>, and <var>hue</var> of an image.</p>
5790
5791<p>The arguments are given as a percentages of variation. A value of 100 means
5792no change, and any missing values are taken to mean 100.</p>
5793
5794<p>The <var>brightness</var> is a multiplier of the overall
5795brightness of the image, so 0 means pure black, 50 is half as bright, 200 is
5796twice as bright. To invert its meaning <a href="command-line-options.html#negate">-negate</a> the image
5797before and after. </p>
5798
5799<p>The <var>saturation</var> controls the amount of color in an
5800image. For example, 0 produce a grayscale image, while a large value such as
5801200 produce a very colorful, 'cartoonish' color.</p>
5802
5803<p>The <var>hue</var> argument causes a "rotation" of the colors
5804within the image by the amount specified. For example, 50 results in
5805a counter-clockwise rotation of 90, mapping red shades to purple, and so on.
5806A value of either 0 or 200 results in a complete 180 degree rotation of the
5807image. Using a value of 300 is a 360 degree rotation resulting in no change to
5808the original image. </p>
5809
5810<p>For example, to increase the color brightness by 20% and decrease the color
Cristy594d2772015-11-15 10:47:42 -05005811saturation by 10% and leave the hue unchanged, use <a
5812href="command-line-options.html#modulate">-modulate 120,90</a>.</p>
Cristy882d9f42015-10-29 16:48:39 -04005813
Cristy594d2772015-11-15 10:47:42 -05005814<p>Use <a href="command-line-options.html#set">-set</a> attribute of '<code
5815>option:modulate:colorspace</code>' to specify which colorspace to
Cristy882d9f42015-10-29 16:48:39 -04005816modulate. Choose from <code>HCL</code>, <code>HCLp</code>, <code>HSB</code>, <code>HSI</code>, <code>HSL</code> (the default), <code>HSV</code>, <code>HWB</code>, or <code>LCH</code> (LCHuv). For example,</p>
5817
5818<pre>
5819convert image.png -set option:modulate:colorspace hsb -modulate 120,90 modulate.png
5820</pre>
5821
5822<div style="margin: auto;">
5823 <h3 class="magick-header"><a id="moments"></a>-moments</h3>
5824</div>
5825
5826<p class="magick-description">report image moments and perceptual hash.</p>
5827
5828
5829<div style="margin: auto;">
5830 <h3 class="magick-header"><a id="monitor"></a>-monitor</h3>
5831</div>
5832
5833<p class="magick-description">monitor progress.</p>
5834
5835
5836<div style="margin: auto;">
5837 <h3 class="magick-header"><a id="monochrome"></a>-monochrome</h3>
5838</div>
5839
5840<p class="magick-description">transform the image to black and white.</p>
5841
5842<div style="margin: auto;">
5843 <h3 class="magick-header"><a id="morph"></a>-morph <var>frames</var></h3>
5844</div>
5845
5846<p class="magick-description">morphs an image sequence.</p>
5847
5848<p>Both the image pixels and size are linearly interpolated to give the
5849appearance of a metamorphosis from one image to the next, over all the images
Cristy594d2772015-11-15 10:47:42 -05005850in the current image list. The added images are the equivalent of a <a
5851href="command-line-options.html#blend">-blend</a> composition. The <var>frames</var>
Cristy882d9f42015-10-29 16:48:39 -04005852argument determine how many images to interpolate between each image. </p>
5853
5854
5855<div style="margin: auto;">
5856 <h3 class="magick-header"><a id="morphology"></a>-morphology</h3>
5857 <h3 class="magick-header">-morphology <var>method</var> <var>kernel</var></h3>
5858</div>
5859
5860<p class="magick-description">apply a morphology method to the image.</p>
5861
Cristy594d2772015-11-15 10:47:42 -05005862<p>Until I get around to writing an option summary for this, see <a
Cristy364a72f2016-11-04 22:38:41 -04005863href="https://www.imagemagick.org/Usage/morphology/" >IM Usage Examples,
Cristy882d9f42015-10-29 16:48:39 -04005864Morphology</a>. </p>
5865
5866
5867<div style="margin: auto;">
5868 <h3 class="magick-header"><a id="mosaic"></a>-mosaic</h3>
5869</div>
5870
Cristy594d2772015-11-15 10:47:42 -05005871<p class="magick-description">an simple alias for the <a href="command-line-options.html#layers" >-layers</a> method "mosaic"</p>
Cristy882d9f42015-10-29 16:48:39 -04005872
5873
5874<div style="margin: auto;">
Cristy594d2772015-11-15 10:47:42 -05005875 <h3 class="magick-header"><a id="motion-blur"></a>-motion-blur <var>radius</var><br />-motion-blur <var>radius</var>x<var>sigma</var>+<var>angle</var></h3>
Cristy882d9f42015-10-29 16:48:39 -04005876</div>
5877
5878<p class="magick-description">simulate motion blur.</p>
5879
5880<p>Blur with the given radius, standard deviation (sigma), and angle. The
5881angle given is the angle toward which the image is blurred. That is the
5882direction people would consider the object is coming from. </p>
5883
5884<p>Note that the blur is not uniform distribution, giving the motion a
5885definite sense of direction of movement. </p>
5886
5887<p>The <a href="command-line-options.html#virtual-pixel">-virtual-pixel</a> setting will determine how
5888pixels which are outside the image proper are blurred into the final result.
5889</p>
5890
5891<div style="margin: auto;">
5892 <h3 class="magick-header"><a id="name"></a>-name</h3>
5893</div>
5894
5895<p class="magick-description">name an image.</p>
5896<div style="margin: auto;">
5897 <h3 class="magick-header"><a id="negate"></a>-negate</h3>
5898</div>
5899
5900<p class="magick-description">replace each pixel with its complementary color.</p>
5901
5902<p>The red, green, and blue intensities of an image are negated. White becomes
5903black, yellow becomes blue, etc. Use <a href="command-line-options.html#negate">+negate</a> to only
5904negate the grayscale pixels of the image.</p>
5905
5906<div style="margin: auto;">
Cristy594d2772015-11-15 10:47:42 -05005907 <h3 class="magick-header"><a id="noise"></a>-noise <var>geometry</var><br/>
Cristy882d9f42015-10-29 16:48:39 -04005908 +noise <var>type</var></h3>
5909</div>
5910
5911<p class="magick-description">Add or reduce noise in an image.</p>
5912
5913<p>The principal function of noise peak elimination filter is to smooth the
5914objects within an image without losing edge information and without creating
5915undesired structures. The central idea of the algorithm is to replace a pixel
5916with its next neighbor in value within a pixel window, if this pixel has been
5917found to be noise. A pixel is defined as noise if and only if this pixel is
5918a maximum or minimum within the pixel window.</p>
5919
5920<p>Use <code><a href="command-line-options.html#noise">-noise</a> <var>radius</var></code> to
5921specify the width of the neighborhood when reducing noise. This is equivalent
Cristy594d2772015-11-15 10:47:42 -05005922to using a <code><a href="command-line-options.html#statistic" >-statistic</a> NonPeak</code> operation,
Cristy882d9f42015-10-29 16:48:39 -04005923which should be used in preference.</p>
5924
5925<p>Use <a href="command-line-options.html#noise">+noise</a> followed by a noise <var>type</var> to add noise to an image. Choose from these noise
5926types:</p>
5927
5928<pre>
5929Gaussian
5930Impulse
5931Laplacian
5932Multiplicative
5933Poisson
5934Random
5935Uniform
5936</pre>
5937
Cristy594d2772015-11-15 10:47:42 -05005938<p>The amount of noise added can be controlled by the <code><a
5939href="command-line-options.html#attenuate" >-attenuate</a></code> setting. If unset the value is
Cristy882d9f42015-10-29 16:48:39 -04005940equivalent to 1.0, or a maximum noise addition.</p>
5941
5942<p>Note that Random will replace the image with noise rather than add noise to the image. Use Uniform, if you wish to add random noise to the image.</p>
5943
5944<p>To print a complete list of noises, use the <a href="command-line-options.html#list">-list noise</a> option.</p>
5945
5946<p>Also see the <a href="command-line-options.html#evaluate">-evaluate</a> noise functions that allows
5947the use of a controlling value to specify the amount of noise that should be
5948added to an image. </p>
5949
5950
5951<div style="margin: auto;">
5952 <h3 class="magick-header"><a id="normalize"></a>-normalize</h3>
5953</div>
5954
5955<p class="magick-description">Increase the contrast in an image by <var>stretching</var> the range of intensity values.</p>
5956
5957<p>The intensity values are stretched to cover the entire range of possible
5958values. While doing so, black-out at most <var>2%</var> of the pixels and
5959white-out at most <var>1%</var> of the pixels.</p>
5960
Cristy594d2772015-11-15 10:47:42 -05005961<p>Note that as of ImageMagick 6.4.7-0, <a href="command-line-options.html#normalize" >-normalize</a>
5962is equivalent to <a href="command-line-options.html#contrast-stretch" >-contrast-stretch 2%x1%</a>.
5963(Before this version, it was equivalent to <a href="command-line-options.html#contrast-stretch"
5964>-contrast-stretch 2%x99%</a>).</p>
Cristy882d9f42015-10-29 16:48:39 -04005965
Cristy769d8892016-01-19 18:11:14 -05005966<p>All the channels are normalized in concert by the same amount so as to
Cristy594d2772015-11-15 10:47:42 -05005967preserve color integrity, when the default <a href="command-line-options.html#channel" >+channel</a>
5968setting is in use. Specifying any other <a href="command-line-options.html#channel" >-channel</a>
Cristy882d9f42015-10-29 16:48:39 -04005969setting will normalize the RGB channels independently.</p>
5970
Cristy594d2772015-11-15 10:47:42 -05005971<p>See <a href="command-line-options.html#contrast-stretch" >-contrast-stretch</a> for more details.
5972Also see <a href="command-line-options.html#auto-level" >-auto-level</a> for a 'perfect' normalization
Cristy882d9f42015-10-29 16:48:39 -04005973that is better suited to mathematically generated images. </p>
5974
5975<p>This operator is under review for re-development. </p>
5976
5977
5978<div style="margin: auto;">
5979 <h3 class="magick-header"><a id="opaque"></a>-opaque <var>color</var></h3>
5980</div>
5981
5982<p class="magick-description">change this color to the fill color within the image.</p>
5983
5984<p>The <var>color</var> argument is defined using the format
Cristy594d2772015-11-15 10:47:42 -05005985described under the <a href="command-line-options.html#fill" >-fill</a> option. The <a href="command-line-options.html#fuzz"
5986>-fuzz</a> setting can be used to match and replace colors similar to the one
Cristy882d9f42015-10-29 16:48:39 -04005987given.</p>
5988
5989<p>Use <a href="command-line-options.html#opaque">+opaque</a> to paint any pixel that does not match
5990the target color. </p>
5991
5992<p>The <a href="command-line-options.html#transparent">-transparent</a> operator is exactly the same
Cristy594d2772015-11-15 10:47:42 -05005993as <a href="command-line-options.html#opaque" >-opaque</a> but replaces the matching color with
Cristy882d9f42015-10-29 16:48:39 -04005994transparency rather than the current <a href="command-line-options.html#fill">-fill</a> color setting.
5995To ensure that it can do this it also ensures that the image has an alpha
Cristy594d2772015-11-15 10:47:42 -05005996channel enabled, as per "<code><a href="command-line-options.html#alpha" >-alpha</a> set</code>", for
5997the new transparent colors, and does not require you to modify the <a
5998href="command-line-options.html#channel">-channel</a> to enable alpha channel handling. </p>
Cristy882d9f42015-10-29 16:48:39 -04005999
6000
6001<div style="margin: auto;">
6002 <h3 class="magick-header"><a id="ordered-dither"></a>-ordered-dither <var>threshold_map</var>{,<var>level</var>...}</h3>
6003</div>
6004
6005<p class="magick-description">dither the image using a pre-defined ordered dither <var>threshold map</var> specified, and a uniform color map with the
6006given number of <var>levels</var> per color channel.</p>
6007
6008<p>You can choose from these standard threshold maps:</p>
6009
6010<pre class="pre-scrollable">
6011threshold 1x1 Threshold 1x1 (non-dither)
6012checks 2x1 Checkerboard 2x1 (dither)
6013o2x2 2x2 Ordered 2x2 (dispersed)
6014o3x3 3x3 Ordered 3x3 (dispersed)
6015o4x4 4x4 Ordered 4x4 (dispersed)
6016o8x8 8x8 Ordered 8x8 (dispersed)
6017h3x4a 4x1 Halftone 4x4 (angled)
6018h6x6a 6x1 Halftone 6x6 (angled)
6019h8x8a 8x1 Halftone 8x8 (angled)
6020h3x4o Halftone 4x4 (orthogonal)
6021h6x6o Halftone 6x6 (orthogonal)
6022h8x8o Halftone 8x8 (orthogonal)
6023h36x16o Halftone 16x16 (orthogonal)
6024c5x5b c5x5 Circles 5x5 (black)
6025c5x5w Circles 5x5 (white)
6026c6x6b c6x6 Circles 6x6 (black)
6027c6x6w Circles 6x6 (white)
6028c7x7b c7x7 Circles 7x7 (black)
6029c7x7w Circles 7x7 (white)
6030</pre>
6031
6032<p> The <code>threshold</code> generated a simple 50% threshold of the image.
Cristy594d2772015-11-15 10:47:42 -05006033This could be used with <var >level</var> to do the equivalent of <a
6034href="command-line-options.html#posterize" >-posterize</a> to reduce an image to basic primary colors.
Cristy882d9f42015-10-29 16:48:39 -04006035</p>
6036
6037<p>The <code>checks</code> pattern produces a 3 level checkerboard dither
6038pattern. That is a grayscale will become a pattern of solid black, solid
6039white, and mid-tone colors into a checkerboard pattern of black and white.
6040</p>
6041
Cristy594d2772015-11-15 10:47:42 -05006042<p>You can define your own <var >threshold map</var> for ordered
Cristy882d9f42015-10-29 16:48:39 -04006043dithering and halftoning your images, in either personal or system
Cristy594d2772015-11-15 10:47:42 -05006044<code>thresholds.xml</code> XML file. See <a href="resources.html" >Resources</a>
Cristy882d9f42015-10-29 16:48:39 -04006045for more details of configuration files. </p>
6046
6047<p>To print a complete list of the thresholds that have been defined, use the
Cristy594d2772015-11-15 10:47:42 -05006048<a href="command-line-options.html#list" >-list threshold</a> option.</p>
Cristy882d9f42015-10-29 16:48:39 -04006049
6050<p>Note that at this time the same threshold dithering map is used for all
6051color channels, no attempt is made to offset or rotate the map for different
6052channels is made, to create an offset printing effect. Also as the maps are
6053simple threshold levels, the halftone and circle maps will create incomplete
6054circles along the edges of a colored area. Also all the effects are purely
6055on/off boolean effects, without anti-aliasing to make the circles smooth
6056looking. Large dots can be made to look better with a small amount of blurring
6057after being created. </p>
6058
6059
6060<div style="margin: auto;">
6061 <h3 class="magick-header"><a id="orient"></a>-orient <var>image orientation</var></h3>
6062</div>
6063
6064<p class="magick-description">specify orientation of a digital camera image.</p>
6065
6066<p>Choose from these orientations:</p>
6067
6068<pre>
6069bottom-left right-top
6070bottom-right top-left
6071left-bottom top-right
6072left-top undefined
6073right-bottom
6074</pre>
6075
Cristy594d2772015-11-15 10:47:42 -05006076<p>To print a complete list of orientations, use the <a href="command-line-options.html#list" >-list
Cristy882d9f42015-10-29 16:48:39 -04006077orientation</a> option.</p>
6078
6079
6080<div style="margin: auto;">
Cristy594d2772015-11-15 10:47:42 -05006081 <h3 class="magick-header"><a id="page"></a>-page <var>geometry</var><br/>
6082 -page <var>media</var>[<var>offset</var>][{<var>^!&lt;&gt;</var>}]<br/>
Cristy882d9f42015-10-29 16:48:39 -04006083 +page
6084 </h3>
6085</div>
6086
6087<p class="magick-description">Set the size and location of an image on the larger virtual canvas.</p>
6088
6089<p>See <a href="command-line-processing.html#geometry">Image Geometry</a> for complete details about the <em class="arg">geometry</em> argument.</p>
6090
6091<p>For convenience you can specify the page size using <var>media</var> (see below). Offsets can then be added as with other
Cristy594d2772015-11-15 10:47:42 -05006092<var>geometry</var> arguments (e.g. <a
6093href="command-line-options.html#page">-page</a> <code>Letter+43+43</code>).</p>
Cristy882d9f42015-10-29 16:48:39 -04006094
6095<p>Use <var>media</var> as shorthand to specify the dimensions (<var>width</var>x<var>height</var>) of the <var>PostScript</var> page in dots per inch or a TEXT page in pixels.
6096The choices for a PostScript page are:</p>
6097
6098<dl class="dl-horizontal">
6099<dt> 11x17 </dt> <dd> 792 x 1224</dd>
6100<dt> Ledger </dt> <dd> 1224 x 792</dd>
6101<dt> Legal </dt> <dd> 612 x 1008</dd>
6102<dt> Letter </dt> <dd> 612 x 792</dd>
6103<dt> LetterSmall</dt> <dd> 612 x 792</dd>
6104<dt> ArchE </dt> <dd> 2592 x 3456</dd>
6105<dt> ArchD </dt> <dd> 1728 x 2592</dd>
6106<dt> ArchC </dt> <dd> 1296 x 1728</dd>
6107<dt> ArchB </dt> <dd> 864 x 1296</dd>
6108<dt> ArchA </dt> <dd> 648 x 864</dd>
6109<dt> A0 </dt> <dd> 2380 x 3368</dd>
6110<dt> A1 </dt> <dd> 1684 x 2380</dd>
6111<dt> A2 </dt> <dd> 1190 x 1684</dd>
6112<dt> A3 </dt> <dd> 842 x 1190</dd>
6113<dt> A4 </dt> <dd> 595 x 842</dd>
6114<dt> A4Small </dt> <dd> 595 x 842</dd>
6115<dt> A5 </dt> <dd> 421 x 595</dd>
6116<dt> A6 </dt> <dd> 297 x 421</dd>
6117<dt> A7 </dt> <dd> 210 x 297</dd>
6118<dt> A8 </dt> <dd> 148 x 210</dd>
6119<dt> A9 </dt> <dd> 105 x 148</dd>
6120<dt> A10 </dt> <dd> 74 x 105</dd>
6121<dt> B0 </dt> <dd> 2836 x 4008</dd>
6122<dt> B1 </dt> <dd> 2004 x 2836</dd>
6123<dt> B2 </dt> <dd> 1418 x 2004</dd>
6124<dt> B3 </dt> <dd> 1002 x 1418</dd>
6125<dt> B4 </dt> <dd> 709 x 1002</dd>
6126<dt> B5 </dt> <dd> 501 x 709</dd>
6127<dt> C0 </dt> <dd> 2600 x 3677</dd>
6128<dt> C1 </dt> <dd> 1837 x 2600</dd>
6129<dt> C2 </dt> <dd> 1298 x 1837</dd>
6130<dt> C3 </dt> <dd> 918 x 1298</dd>
6131<dt> C4 </dt> <dd> 649 x 918</dd>
6132<dt> C5 </dt> <dd> 459 x 649</dd>
6133<dt> C6 </dt> <dd> 323 x 459</dd>
6134<dt> Flsa </dt> <dd> 612 x 936</dd>
6135<dt> Flse </dt> <dd> 612 x 936</dd>
6136<dt> HalfLetter </dt> <dd> 396 x 612</dd>
6137</dl>
6138
6139<p>This option is also used to place subimages when writing to a multi-image
6140format that supports offsets, such as GIF89 and MNG. When used for this
6141purpose the offsets are always measured from the top left corner of the canvas
6142and are not affected by the <a href="command-line-options.html#gravity">-gravity</a> option. To
6143position a GIF or MNG image, use <a href="command-line-options.html#page">-page</a><var>{+-}x{+-}y</var> (e.g. -page +100+200). When writing to a MNG
6144file, a <a href="command-line-options.html#page">-page</a> option appearing ahead of the first image in
6145the sequence with nonzero width and height defines the width and height values
6146that are written in the <code>MHDR</code> chunk. Otherwise, the MNG width and
6147height are computed from the bounding box that contains all images in the
6148sequence. When writing a GIF89 file, only the bounding box method is used to
6149determine its dimensions.</p>
6150
Cristy594d2772015-11-15 10:47:42 -05006151<p>For a PostScript page, the image is sized as in <a
6152href="command-line-options.html#geometry">-geometry</a> but positioned relative to the <var>lower
6153left-hand corner</var> of the page by {+-}<code>x</code><var>offset</var>{+-}<code>y</code> <var>offset</var>. Use <a
6154href="command-line-options.html#page">-page 612x792</a>, for example, to center the image within the
Cristy882d9f42015-10-29 16:48:39 -04006155page. If the image size exceeds the PostScript page, it is reduced to fit the
6156page. The default gravity for the <a href="command-line-options.html#page">-page</a> option is <var>NorthWest</var>, i.e., positive <code>x</code> and <code>y</code> <var>offset</var> are measured rightward and downward from the top left
6157corner of the page, unless the <a href="command-line-options.html#gravity">-gravity</a> option is
6158present with a value other than <var>NorthWest</var>.</p>
6159
6160<p>The default page dimensions for a TEXT image is 612x792.</p>
6161
6162<p>This option is used in concert with <a href="command-line-options.html#density">-density</a>.</p>
6163
6164<p>Use <a href="command-line-options.html#page">+page</a> to remove the page settings for an image.</p>
6165
6166<div style="margin: auto;">
6167 <h3 class="magick-header"><a id="paint"></a>-paint <var>radius</var></h3>
6168</div>
6169
6170<p class="magick-description">simulate an oil painting.</p>
6171
6172<p>Each pixel is replaced by the most frequent color in a circular
6173neighborhood whose width is specified with <var>radius</var>.</p>
6174
6175<div style="margin: auto;">
6176 <h3 class="magick-header"><a id="path"></a>-path <var>path</var></h3></div>
6177
6178<p class="magick-description">write images to this path on disk.</p>
6179
6180<div style="margin: auto;">
6181 <h3 class="magick-header"><a id="pause_animate_"></a>-pause <var>seconds</var></h3>
6182</div>
6183
6184<p class="magick-description">Pause between animation loops</p>
6185
6186<p>Pause for the specified number of seconds before repeating the animation.</p>
6187
6188<div style="margin: auto;">
6189 <h3 class="magick-header"><a id="pause_import_"></a>-pause <var>seconds</var></h3>
6190</div>
6191
6192<p class="magick-description">Pause between snapshots.</p>
6193
6194<p>Pause for the specified number of seconds before taking the next snapshot.</p>
6195
6196<div style="margin: auto;">
6197 <h3 class="magick-header"><a id="perceptible"></a>-perceptible <var>epsilon</var></h3>
6198</div>
6199
6200<p class="magick-description">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.</p>
6201
6202<div style="margin: auto;">
6203 <h3 class="magick-header"><a id="ping"></a>-ping</h3>
6204</div>
6205
6206<p class="magick-description">efficiently determine image characteristics.</p>
6207
6208<div style="margin: auto;">
6209 <h3 class="magick-header"><a id="pointsize"></a>-pointsize <var>value</var></h3>
6210</div>
6211
6212<p class="magick-description">pointsize of the PostScript, OPTION1, or TrueType font.</p>
6213
6214<div style="margin: auto;">
6215 <h3 class="magick-header"><a id="polaroid"></a>-polaroid <var>angle</var></h3>
6216</div>
6217
6218<p class="magick-description">simulate a Polaroid picture.</p>
6219
6220<p>Use <code>+polaroid</code> to rotate the image at a random angle between -15 and +15 degrees.</p>
6221
6222<div style="margin: auto;">
6223 <h3 class="magick-header"><a id="poly"></a>-poly <var>"wt,exp ..."</var></h3>
6224</div>
6225
6226<p class="magick-description">combines multiple images according to a weighted sum of polynomials; one floating point weight (coefficient) and one floating point polynomial exponent (power) for each image expressed as comma separated pairs.</p>
6227
6228<p> The weights should typically be fractions between -1 and 1. But the sum of weights should be 1 or at least between 0 and 1 to avoid clamping in non-hdri mode at black and white.</p>
6229
6230<p>The exponents may be positive, negative or zero. A negative exponent is equivalent to 1 divided by the image raised to the corresponding positive exponent. A zero exponent always produces 1 scaled by quantumrange to white, i.e. wt*white, no matter what the image.</p>
6231
6232<p>The format is: <var>output = wt1*image1^exp1 + wt2*image2^exp2 </var>...</p>
6233
6234<p>Some simple uses are:</p>
6235<ul>
6236<li>A weighted sum of each image provided all weights add to unity and all exponents=1. If the the weights are all equal to 1/(number of images), then this is equivalent to <a href="command-line-options.html#profile">-evaluate-sequence</a> <var>mean</var>.</li>
6237<li>The sum of squares of two or more images, provided the weights are equal (and sum to 1 to avoid clamping) and the exponents equal 2.</li>
6238</ul>
6239
6240<p>Note that one may add a constant color to the expression simply by using xc:somecolor for one of the images and specifying the desired weight and exponent equal to 0.</p>
6241
6242<p>Similarly one may add white to the expression by simply using null: (or xc:white) for one of the images with the appropriate weight and exponent equal to 0.</p>
6243
6244
6245<div style="margin: auto;">
6246 <h3 class="magick-header"><a id="posterize"></a>-posterize <var>levels</var></h3>
6247</div>
6248
6249<p class="magick-description">reduce the image to a limited number of color levels per channel.</p>
6250
6251<p>Very low values of <var>levels</var>, e.g., 2, 3, 4, have the most
6252visible effect.</p>
6253
6254<div style="margin: auto;">
6255 <h3 class="magick-header"><a id="precision"></a>-precision <var>value</var></h3>
6256</div>
6257
6258<p class="magick-description">set the maximum number of significant digits to be printed.</p>
6259
6260<div style="margin: auto;">
6261 <h3 class="magick-header"><a id="preview"></a>-preview <var>type</var></h3>
6262</div>
6263
6264<p class="magick-description">image preview type.</p>
6265
6266<p>Use this option to affect the preview operation of an image (e.g.
6267<code>convert file.png -preview Gamma Preview:gamma.png</code>). Choose from
6268these previews:</p>
6269
6270<pre class="pre-scrollable">
6271AddNoise
6272Blur
6273Brightness
6274Charcoal
6275Despeckle
6276Dull
6277EdgeDetect
6278Gamma
6279Grayscale
6280Hue
6281Implode
6282JPEG
6283OilPaint
6284Quantize
6285Raise
6286ReduceNoise
6287Roll
6288Rotate
6289Saturation
6290Segment
6291Shade
6292Sharpen
6293Shear
6294Solarize
6295Spiff
6296Spread
6297Swirl
6298Threshold
6299Wave
6300</pre>
6301
6302<p>To print a complete list of previews, use the <a href="command-line-options.html#list">-list preview</a> option.</p>
6303
6304<p>The default preview is <code>JPEG</code>.</p>
6305
6306<div style="margin: auto;">
6307 <h3 class="magick-header"><a id="print"></a>-print <var>string</var></h3>
6308</div>
6309
6310<p class="magick-description">interpret string and print to console.</p>
6311
6312<div style="margin: auto;">
6313 <h3 class="magick-header"><a id="process"></a>-process <var>command</var></h3>
6314</div>
6315
6316<p class="magick-description">process the image with a custom image filter.</p>
6317
6318<p>The command arguments has the form <code>"module arg1 arg2 arg3 ...
6319argN"</code> where <code>module</code> is the name of the module to invoke (e.g.
6320"Analyze") and arg1 arg2 arg3 ... argN are an arbitrary number of arguments to
6321pass to the process module.</p>
6322
6323<div style="margin: auto;">
Cristy594d2772015-11-15 10:47:42 -05006324 <h3 class="magick-header"><a id="profile"></a>-profile <var>filename</var><br/>
Cristy882d9f42015-10-29 16:48:39 -04006325 +profile <var>profile_name</var></h3>
6326</div>
6327
6328<p class="magick-description">Manage ICM, IPTC, or generic profiles in an image.</p>
6329
6330<p>Using <a href="command-line-options.html#profile">-profile</a> <var>filename</var> adds an
6331ICM (ICC color management), IPTC (newswire information), or a generic profile
6332to the image.</p>
6333
6334<p>Use <a href="command-line-options.html#profile">+profile <var>profile_name</var></a> to
6335remove the indicated profile. ImageMagick uses standard filename globbing, so
6336wildcard expressions may be used to remove more than one profile. Here we
6337remove all profiles from the image except for the XMP profile: <code>+profile
6338"!xmp,*"</code>. </p>
6339
6340<p>Use <code>identify -verbose</code> to find out which profiles are in the
6341image file. Use <a href="command-line-options.html#strip">-strip</a> to remove all profiles (and
6342comments).</p>
6343
6344<p>To extract a profile, the <a href="command-line-options.html#profile">-profile</a> option is not
6345used. Instead, simply write the file to an image format such as <var>APP1, 8BIM, ICM,</var> or <var>IPTC</var>.</p>
6346
6347<p>For example, to extract the Exif data (which is stored in JPEG files in the
6348<var>APP1</var> profile), use.</p>
6349
6350<pre>
6351convert cockatoo.jpg profile.exif
6352</pre>
6353
6354<p>It is important to note that results may depend on whether or not the
Cristy594d2772015-11-15 10:47:42 -05006355original image already has an included profile. Also, keep in mind that <a
6356href="command-line-options.html#profile">-profile</a> is an "operator" (as opposed to a "setting") and
Cristy882d9f42015-10-29 16:48:39 -04006357therefore a conversion is made each time it is encountered, in order, in the
6358command-line. For instance, in the following example, if the original image is
6359CMYK with profile, a CMYK-CMYK-RGB conversion results.</p>
6360
6361<pre>
6362convert CMYK.tif -profile "CMYK.icc" -profile "RGB.icc" RGB.tiff
6363</pre>
6364
6365<p>Furthermore, since ICC profiles are not necessarily symmetric, extra
6366conversion steps can yield unwanted results. CMYK profiles are often very
6367asymmetric since they involve 3−&gt;4 and 4−&gt;3 channel mapping.
6368</p>
6369
6370<div style="margin: auto;">
6371 <h3 class="magick-header"><a id="quality"></a>-quality <var>value</var></h3>
6372</div>
6373
6374<p class="magick-description">JPEG/MIFF/PNG compression level.</p>
6375
6376<p>For the JPEG and MPEG image formats, quality is 1 (lowest image quality and
6377highest compression) to 100 (best quality but least effective compression).
6378The default is to use the estimated quality of your input image if it can
6379be determined, otherwise 92. When the quality is greater than 90, then the
6380chroma channels are not downsampled.
6381Use the <a href="command-line-options.html#sampling-factor">-sampling-factor</a> option to specify the
6382factors for chroma downsampling.</p>
6383
6384<p>For the JPEG-2000 image format, quality is mapped using a non-linear
6385equation to the compression ratio required by the Jasper library. This
6386non-linear equation is intended to loosely approximate the quality provided by
6387the JPEG v1 format. The default quality value 100, a request for non-lossy
6388compression. A quality of 75 results in a request for 16:1 compression.</p>
6389
6390<p>For the MNG and PNG image formats, the quality value sets the zlib
6391compression level (quality / 10) and filter-type (quality % 10). The default
6392PNG "quality" is 75, which means compression level 7 with adaptive PNG
6393filtering, unless the image has a color map, in which case it means
6394compression level 7 with no PNG filtering.</p>
6395
6396<p>For compression level 0 (quality value less than 10), the Huffman-only
6397strategy is used, which is fastest but not necessarily the worst
6398compression.</p>
6399
6400<p>If filter-type is 4 or less, the specified PNG filter-type is used for
6401all scanlines:</p>
6402
6403<dl class="dl-horizontal">
6404<dt>0</dt><dd>none</dd>
6405<dt>1</dt><dd>sub</dd>
6406<dt>2</dt><dd>up</dd>
6407<dt>3</dt><dd>average</dd>
6408<dt>4</dt><dd>Paeth</dd>
6409</dl>
6410
6411<p>If filter-type is 5, adaptive filtering is used when quality is greater
6412than 50 and the image does not have a color map, otherwise no filtering is
6413used.</p>
6414
6415<p>If filter-type is 6, adaptive filtering
6416with <var>minimum-sum-of-absolute-values</var> is used.</p>
6417
6418<p>Only if the output is MNG, if filter-type is 7, the LOCO color
6419transformation (intrapixel differencing) and adaptive filtering
6420with <var>minimum-sum-of-absolute-values</var> are used.</p>
6421
6422<p>If the filter-type is 8 the zlib Z_RLE compression strategy (or the
6423Z_HUFFMAN_ONLY strategy, when compression level is 0) is used with
6424adaptive PNG filtering.</p>
6425
6426<p>If the filter-type is 9 the zlib Z_RLE compression strategy (or the
6427Z_HUFFMAN_ONLY strategy, when compression level is 0) is used with
6428no PNG filtering.</p>
6429
6430<p>The quality setting has no effect on the appearance or signature of PNG
6431and MNG images, since the compression is always lossless.</p>
6432
6433<p>Not all combinations of compression level, strategy, and PNG filter type
6434can be obtained using the -quality option. For more precise control,
6435you can use the PNG:compression-level=N, PNG:compression-strategy=N, and
6436PNG:compression-filter=N defines, respectively, instead.
6437See <a href="command-line-options.html#define">-define</a>. Values from the defines take precedence
6438over values from the -quality option.</p>
6439
6440<p>For further information, see
6441the <a href="http://www.w3.org/pub/WWW/TR">PNG</a> specification.</p>
6442
6443<p>For the MIFF and TIFF image formats, quality/10 is the <a href="command-line-options.html#compress">Zip/BZip</a> compression level, which is 0 (worst but fastest compression) to 9 (best but slowest). It has no effect on the image appearance, since the compression is always lossless.</p>
6444
6445<p>For the BPG image format, quality/2 is the actual BPG compression level (range from 0 to 51).</p>
6446
6447<div style="margin: auto;">
6448 <h3 class="magick-header"><a id="quantize"></a>-quantize <var>colorspace</var></h3>
6449</div>
6450
6451<p class="magick-description">reduce colors using this colorspace.</p>
6452
6453<p>This setting defines the colorspace used to sort out and reduce the number
Cristy594d2772015-11-15 10:47:42 -05006454of colors needed by an image (for later dithering) by operators such as <a
6455href="command-line-options.html#colors" >-colors</a>, Note that color reduction also happens
Cristy882d9f42015-10-29 16:48:39 -04006456automatically when saving images to color-limited image file formats, such as
6457GIF, and PNG8.</p>
6458
6459
6460<div style="margin: auto;">
6461 <h3 class="magick-header"><a id="quiet"></a>-quiet</h3>
6462</div>
6463
6464<p class="magick-description">suppress all warning messages. Error messages are still reported.</p>
6465
6466<div style="margin: auto;">
6467 <h3 class="magick-header"><a id="radial-blur"></a>-radial-blur <var>angle</var></h3>
6468</div>
6469
6470<p class="magick-description">Blur around the center of the image.</p>
6471
6472<p>Note that this is actually a rotational blur rather than a radial and as
6473such actually mis-named. </p>
6474
6475<p>The <a href="command-line-options.html#virtual-pixel">-virtual-pixel</a> setting will determine how
6476pixels which are outside the image proper are blurred into the final result.
6477</p>
6478
6479
6480<div style="margin: auto;">
6481 <h3 class="magick-header"><a id="raise"></a>-raise <var>thickness</var></h3>
6482</div>
6483
6484<p class="magick-description">Lighten or darken image edges.</p>
6485
6486<p>This will create a 3-D effect. Use <a href="command-line-options.html#raise">-raise</a> to create
6487a raised effect, otherwise use <a href="command-line-options.html#raise">+raise</a>. </p>
6488
Cristy594d2772015-11-15 10:47:42 -05006489<p>Unlike the similar <a href="command-line-options.html#frame">-frame</a> option, <a
6490href="command-line-options.html#raise">-raise</a> does not alter the dimensions of the image.</p>
Cristy882d9f42015-10-29 16:48:39 -04006491
6492<div style="margin: auto;">
6493 <h3 class="magick-header"><a id="random-threshold"></a>-random-threshold <var>low</var>x<var>high</var></h3>
6494</div>
6495
6496<p class="magick-description">Apply a random threshold to the image.</p>
6497
6498<div style="margin: auto;">
Cristye0779712016-07-30 17:25:22 -04006499 <h3 class="magick-header"><a id="read-mask"></a>-read-mask
6500<var>filename</var></h3>
6501</div>
6502
6503<p class="magick-description">Prevent updates to image pixels specified by the mask.</p>
6504
6505<p>This the same as using a mask used for composite masking operations, with
6506grayscale values causing blended updates of the image the mask is attached to.
6507</p>
6508
6509<p>Use <a href="command-line-options.html#read-mask">+read-mask</a> to remove the mask from images.</p>
6510
6511<p>Also see <a href="command-line-options.html#clip-mask">-clip-mask</a> which work in the same way,
6512but with strict boolean masking. </p>
6513
6514<div style="margin: auto;">
Cristy882d9f42015-10-29 16:48:39 -04006515 <h3 class="magick-header"><a id="red-primary"></a>-red-primary <var>x,y</var></h3>
6516</div>
6517
6518<p class="magick-description">Set the red chromaticity primary point.</p>
6519
6520<div style="margin: auto;">
6521 <h3 class="magick-header"><a id="regard-warnings"></a>-regard-warnings</h3>
6522</div>
6523
6524<p class="magick-description">Pay attention to warning messages.</p>
6525
6526<p>This option causes some warnings in some image formats to be treated
6527as errors. </p>
6528
6529<div style="margin: auto;">
6530 <h3 class="magick-header"><a id="remap"></a>-remap <var>filename</var></h3>
6531</div>
6532
6533<p class="magick-description">Reduce the number of colors in an image to the colors used by this image.</p>
6534
6535<p>If the <a href="command-line-options.html#dither">-dither</a> setting is enabled (the default) then
6536the given colors are dithered over the image as necessary, otherwise the closest
6537color (in RGB colorspace) is selected to replace that pixel in the image. </p>
6538
6539<p>As a side effect of applying a <a href="command-line-options.html#remap">-remap</a> of colors across all
6540images in the current image sequence, all the images will have the same color
6541table. That means that when saved to a file format such as GIF, it will use
6542that color table as a single common or global color table, for all the images,
6543without requiring extra local color tables. </p>
6544
6545<p>Use <a href="command-line-options.html#remap">+remap</a> to reduce all images in the current image
6546sequence to use a common color map over all the images. This equivalent to
6547appending all the images together (without extra background colors) and color
6548reducing those images using <a href="command-line-options.html#colors">-colors</a> with a 256 color
6549limit, then <a href="command-line-options.html#remap">-remap</a> those colors over the original list of
6550images. This ensures all the images follow a single color map. </p>
6551
Cristy594d2772015-11-15 10:47:42 -05006552<p>If the number of colors over all the images is less than 256, then <a
6553href="command-line-options.html#remap">+remap</a> should not perform any color reduction or dithering, as
Cristy882d9f42015-10-29 16:48:39 -04006554no color changes are needed. In that case, its only effect is to force the use
Cristy594d2772015-11-15 10:47:42 -05006555of a global color table. This recommended after using either <a
6556href="command-line-options.html#colors">-colors</a> or <a href="command-line-options.html#ordered-dither">-ordered-dither</a> to
Cristy882d9f42015-10-29 16:48:39 -04006557reduce the number of colors in an animated image sequence. </p>
6558
6559<p>Note, the remap image colormap has at most 8-bits of precision. Deeper color maps are automagically coalesced with other colors to meet this requirement.</p>
6560
6561<div style="margin: auto;">
6562 <h3 class="magick-header"><a id="region"></a>-region <var>geometry</var></h3>
6563</div>
6564
6565<p class="magick-description">Set a region in which subsequent operations apply.</p>
6566
6567<p>The <var>x</var> and <var>y</var> offsets are treated
6568in the same manner as in <a href="command-line-options.html#crop">-crop</a>.</p>
6569
6570<p>See <a href="command-line-processing.html#geometry">Image Geometry</a> for complete details about the <em class="arg">geometry</em> argument.</p>
6571
6572<p>Use <code>+region</code> to remove any previously set regions.</p>
6573
Cristy882d9f42015-10-29 16:48:39 -04006574<div style="margin: auto;">
6575 <h3 class="magick-header"><a id="remote"></a>-remote</h3>
6576</div>
6577
6578<p class="magick-description">perform a remote operation.</p>
6579
6580<p>The only command recognized is the name of an image file to load.</p>
6581
6582<p>If you have more than one <a href="display.html">display</a> application
6583running simultaneously, use the <a href="command-line-options.html#window"> window</a> option to
6584specify which application to control.</p>
6585
6586<div style="margin: auto;">
6587 <h3 class="magick-header"><a id="render"></a>-render</h3>
6588</div>
6589
6590<p class="magick-description">render vector operations.</p>
6591
6592<p>Use <a href="command-line-options.html#render">+render</a> to turn off rendering vector operations.
6593This useful when saving the result to vector formats such as MVG or SVG.</p>
6594
6595<div style="margin: auto;">
6596<h3 class="magick-header"><a id="repage"></a>-repage <var>geometry</var></h3>
6597</div>
6598
6599<p class="magick-description">Adjust the canvas and offset information of the image.</p>
6600
6601<p>This option is like <a href="command-line-options.html#page">-page</a> but acts as an image operator
6602rather than a setting. You can separately set the canvas size or the offset
6603of the image on that canvas by only providing those components. </p>
6604
6605<p>See <a href="command-line-processing.html#geometry">Image Geometry</a> for complete details about the <em class="arg">geometry</em> argument.</p>
6606
6607<p>If a <code>!</code> flag is given the offset given is added to the existing
6608offset to move the image relative to its previous position. This useful for
6609animation sequences. </p>
6610
6611<p>A given a canvas size of zero such as '<code>0x0</code>' forces it to
6612recalculate the canvas size so the image (at its current offset) will appear
6613completely on that canvas (unless it has a negative offset).</p>
6614
6615<p>Use <a href="command-line-options.html#repage">+repage</a> to completely remove/reset the virtual
6616canvas meta-data from the images. </p>
6617
6618<p>The <a href="command-line-options.html#set">-set</a> '<code>page</code>' option can be used to
6619directly assign virtual canvas meta-data. </p>
6620
6621
6622<div style="margin: auto;">
6623 <h3 class="magick-header"><a id="resample"></a>-resample <var>horizontal</var>x<var>vertical</var></h3>
6624</div>
6625
6626<p class="magick-description">Resample image to specified horizontal and vertical resolution.</p>
6627
6628<p>Resize the image so that its rendered size remains the same as the original
6629at the specified target resolution. For example, if a 300 DPI image renders at
66303 inches by 2 inches on a 300 DPI device, when the image has been resampled to
663172 DPI, it will render at 3 inches by 2 inches on a 72 DPI device. Note that
6632only a small number of image formats (e.g. JPEG, PNG, and TIFF) are capable of
6633storing the image resolution. For formats which do not support an image
Cristy594d2772015-11-15 10:47:42 -05006634resolution, the original resolution of the image must be specified via <a
6635href="command-line-options.html#density">-density</a> on the command line prior to specifying the
Cristy882d9f42015-10-29 16:48:39 -04006636resample resolution.</p>
6637
6638<p>Note that Photoshop stores and obtains image resolution from a proprietary
6639embedded profile. If this profile exists in the image, then Photoshop will
6640continue to treat the image using its former resolution, ignoring the image
6641resolution specified in the standard file header.</p>
6642
6643<div style="margin: auto;">
6644 <h3 class="magick-header"><a id="resize"></a>-resize <var>geometry</var></h3>
6645</div>
6646
6647<p class="magick-description">Resize an image.</p>
6648
6649<p>See <a href="command-line-processing.html#geometry">Image Geometry</a> for complete details about the <em class="arg">geometry</em> argument. Offsets, if present in the geometry string, are
6650ignored, and the <a href="command-line-options.html#gravity">-gravity</a> option has no effect.</p>
6651
6652<p>If the <a href="command-line-options.html#filter">-filter</a> option
Cristy594d2772015-11-15 10:47:42 -05006653or <code>-define filter:option=value</code> precedes the <a
6654href="command-line-options.html#resize">-resize</a> option, the image is resized with the specified
Cristy882d9f42015-10-29 16:48:39 -04006655filter.</p>
6656
6657<p>Many image processing algorithms assume your image is in a linear-light
6658coding. If your image is gamma-corrected, you can remove the nonlinear gamma
6659correction, apply the transform, then restore it like this:</p>
6660
6661<pre>
6662convert portrait.jpg -gamma .45455 -resize 25% -gamma 2.2 \
6663 -quality 92 passport.jpg
6664</pre>
6665
6666<div style="margin: auto;">
6667 <h3 class="magick-header"><a id="respect-parentheses"></a>-respect-parentheses</h3>
6668</div>
6669
6670<p class="magick-description">settings remain in effect until parenthesis boundary.</p>
6671
6672<div style="margin: auto;">
6673 <h3 class="magick-header"><a id="reverse"></a>-reverse</h3>
6674</div>
6675
6676<p class="magick-description">Reverse the order of images in the current image list.</p>
6677
6678
6679<div style="margin: auto;">
6680 <h3 class="magick-header"><a id="roll"></a>-roll {<var>+-</var>}<var>x</var>{<var>+-</var>}<var>y</var></h3>
6681</div>
6682
6683<p class="magick-description">roll an image vertically or horizontally by the amount given.</p>
6684
6685<p>A negative <var>x</var> offset rolls the image right-to-left.
6686A negative <var>y</var> offset rolls the image bottom-to-top.</p>
6687
6688
6689<div style="margin: auto;">
6690 <h3 class="magick-header"><a id="rotate"></a>-rotate <var>degrees</var>{<var>&lt;</var>}{<var>&gt;</var>}</h3>
6691</div>
6692
6693<p class="magick-description">Apply Paeth image rotation (using shear operations) to the image.</p>
6694
6695<p>Use <code>&gt;</code> to rotate the image only if its width exceeds the
6696height. <code>&lt;</code> rotates the image <var>only</var> if its width is less
6697than the height. For example, if you specify <code>-rotate "-90&gt;"</code> and
6698the image size is 480x640, the image is not rotated. However, if the image is
6699640x480, it is rotated by -90 degrees. If you use <code>&gt;</code> or
6700<code>&lt;</code>, enclose it in quotation marks to prevent it from being
6701misinterpreted as a file redirection.</p>
6702
6703<p>Empty triangles in the corners, left over from rotating the image, are
6704filled with the <code>background</code> color. </p>
6705
6706<p>See also the <a href="command-line-options.html#distort">-distort</a> operator and specifically the
6707'<code>ScaleRotateTranslate</code>' distort method. </p>
6708
6709
6710<div style="margin: auto;">
6711 <h3 class="magick-header"><a id="sample"></a>-sample <var>geometry</var></h3>
6712</div>
6713
6714<p class="magick-description">minify / magnify the image with pixel subsampling and pixel replication, respectively.</p>
6715
6716<p>Change the image size simply by directly sampling the pixels original
6717from the image. When magnifying, pixels are replicated in blocks. When
6718minifying, pixels are sub-sampled (i.e., some rows and columns are skipped
6719over). </p>
6720
6721<p>The results are thus equivalent to using <a href="command-line-options.html#resize">-resize</a> with
6722a <a href="command-line-options.html#filter">-filter</a> setting of <code>point</code> (nearest
6723neighbor), though <a href="command-line-options.html#sample">-sample</a> is a lot faster, as it
6724avoids all the filter processing of the image. As such it completely ignores
6725the current <a href="command-line-options.html#filter">-filter</a> setting. </p>
6726
6727<p>The key feature of the <a href="command-line-options.html#sample">-sample</a> is that no new colors
6728will be added to the resulting image, though some colors may disappear. </p>
6729
6730<p>See <a href="command-line-processing.html#geometry">Image Geometry</a> for complete details about the <em class="arg">geometry</em> argument. Offsets, if present in the geometry string, are
6731ignored, unlike <a href="command-line-options.html#resize">-resize</a>. </p>
6732
6733
6734<p>The actual sampling point is the middle of the sub-region being sampled.
6735As such a single pixel sampling of an image will take the middle pixel, (or
Cristy594d2772015-11-15 10:47:42 -05006736top-left-middle if image has even dimensions). However the <a
6737href="command-line-options.html#define">-define</a> '<code>sample:offset</code>' can be set to modify
Cristy882d9f42015-10-29 16:48:39 -04006738this position some other location within each sub-region being sampled, as
6739a percentage offset.</p>
6740
6741<p>By default this value is '<code>50</code>' for the midpoint, but could be set
6742to '<code>0</code>' for top-left, '<code>100</code>' for bottom-right, or with
6743separate X and Y offsets such as '<code>0x50</code>' for left-middle edge of
6744sampling sub-region.</p>
6745
6746
6747<div style="margin: auto;">
6748 <h3 class="magick-header"><a id="sampling-factor"></a>-sampling-factor <var>horizontal-factor</var>x<var>vertical-factor</var></h3>
6749</div>
6750
6751<p class="magick-description">sampling factors used by JPEG or MPEG-2 encoder and YUV decoder/encoder.</p>
6752
6753<p>This option specifies the sampling factors to be used by the JPEG encoder
6754for chroma downsampling. If this option is omitted, the JPEG library will use
6755its own default values. When reading or writing the YUV format and when
Cristy594d2772015-11-15 10:47:42 -05006756writing the M2V (MPEG-2) format, use <a
6757href="command-line-options.html#sampling-factor">-sampling-factor 2x1</a> or <a
6758href="command-line-options.html#sampling-factor">-sampling-factor 4:2:2</a> to specify the 4:2:2
Cristy882d9f42015-10-29 16:48:39 -04006759downsampling method.</p>
6760
6761<div style="margin: auto;">
6762 <h3 class="magick-header"><a id="scale"></a>-scale <var>geometry</var></h3>
6763</div>
6764
6765<p class="magick-description">minify / magnify the image with pixel block averaging and pixel replication, respectively.</p>
6766
6767<p>Change the image size simply by replacing pixels by averaging pixels
6768together when minifying, or replacing pixels when magnifying. </p>
6769
6770<p>The results are thus equivalent to using <a href="command-line-options.html#resize">-resize</a> with
6771a <a href="command-line-options.html#filter">-filter</a> setting of <code>box</code>. Though it is a lot
6772faster, as it avoids all the filter processing of the image. As such it
6773completely ignores the current <a href="command-line-options.html#filter">-filter</a> setting. </p>
6774
6775<p>If when shrinking (minifying) images the original image is some integer
6776multiple of the new image size, the number of pixels averaged together to
6777produce the new pixel color is the same across the whole image. This is
6778a special case known as 'binning' and is often used as a method of reducing
6779noise in image such as those generated by digital cameras, especially in low
6780light conditions. </p>
6781
6782
6783<div style="margin: auto;">
6784 <h3 class="magick-header"><a id="scene"></a>-scene <var>value</var></h3>
6785</div>
6786
6787<p class="magick-description">set scene number.</p>
6788
6789<p>This option sets the scene number of an image or the first image in an image sequence.</p>
6790
6791<div style="margin: auto;">
6792 <h3 class="magick-header"><a id="screen"></a>-screen</h3>
6793</div>
6794
6795<p class="magick-description">specify the screen to capture.</p>
6796
6797<p>This option indicates that the GetImage request used to obtain the image
6798should be done on the root window, rather than directly on the specified
6799window. In this way, you can obtain pieces of other windows that overlap the
6800specified window, and more importantly, you can capture menus or other popups
6801that are independent windows but appear over the specified window.</p>
6802
6803<div style="margin: auto;">
6804 <h3 class="magick-header"><a id="seed"></a>-seed</h3>
6805</div>
6806
6807<p class="magick-description">seed a new sequence of pseudo-random numbers</p>
6808
6809<div style="margin: auto;">
6810 <h3 class="magick-header"><a id="segment"></a>-segment <var>cluster-threshold</var>x<var>smoothing-threshold</var></h3>
6811</div>
6812
6813<p class="magick-description">segment the colors of an image.</p>
6814
6815<p>Segment an image by analyzing the histograms of the color components and
6816identifying units that are homogeneous with the fuzzy c-means technique. This
6817is part of the ImageMagick color quantization routines. </p>
6818
6819<p>Specify <var>cluster threshold</var> as the number of pixels in
6820each cluster that must exceed the cluster threshold to be considered valid.
6821<var>Smoothing threshold</var> eliminates noise in the second
6822derivative of the histogram. As the value is increased, you can expect
6823a smoother second derivative. The default is 1.5.</p>
6824
6825<p>If the <a href="command-line-options.html#verbose">-verbose</a> setting is defined, a detailed report
6826of the color clusters is returned.</p>
6827
6828
6829<div style="margin: auto;">
Cristy594d2772015-11-15 10:47:42 -05006830 <h3 class="magick-header"><a id="selective-blur"></a>-selective-blur <var>radius</var><br />-selective-blur <var>radius</var>x<var>sigma</var>{<var>+threshold</var>}</h3>
Cristy882d9f42015-10-29 16:48:39 -04006831</div>
6832
6833<p class="magick-description">Selectively blur pixels within a contrast threshold.</p>
6834
6835<p>Blurs those pixels that are less than or equal to the threshold in
6836contrast. The threshold may be expressed as a fraction of <var>QuantumRange</var> or as a percentage.</p>
6837
6838<div style="margin: auto;">
6839 <h3 class="magick-header"><a id="separate"></a>-separate</h3>
6840</div>
6841
6842<p class="magick-description">separate an image channel into a grayscale image. Specify the channel with <a href="command-line-options.html#channel">-channel</a>.</p>
6843
6844<div style="margin: auto;">
Cristy769d8892016-01-19 18:11:14 -05006845 <h3 class="magick-header"><a id="sepia-tone"></a>-sepia-tone <var>percent-threshold</var></h3>
Cristy882d9f42015-10-29 16:48:39 -04006846</div>
6847
6848<p class="magick-description">simulate a sepia-toned photo.</p>
6849
6850<p>Specify <var>threshold</var> as the percent threshold of the intensity (0 - 99.9%).</p>
6851
6852<p>This option applies a special effect to the image, similar to the effect
6853achieved in a photo darkroom by sepia toning. Threshold ranges from 0 to <var>QuantumRange</var> and is a measure of the extent of the sepia
6854toning. A threshold of 80% is a good starting point for a reasonable
6855tone.</p>
6856
6857
6858
6859<div style="margin: auto;">
6860 <h3 class="magick-header"><a id="set"></a>-set <var>key value</var></h3>
6861 <h3 class="magick-header">+set <var>key</var></h3>
6862</div>
6863
6864<p class="magick-description">sets image attributes and properties for images in the current image sequence.</p>
6865
6866<p>This will assign (or modify) specific settings attached to all the images
6867in the current image sequence. Using the <a href="command-line-options.html#set">+set</a> form of the
6868option will either remove, or reset that setting to a default state, as
6869appropriate. </p>
6870
6871<p>For example, it will modify specific well known image meta-data
Cristy594d2772015-11-15 10:47:42 -05006872'attributes' such as those normally overridden by: the options <a
6873href="command-line-options.html#delay" >-delay</a>, <a href="command-line-options.html#dispose" >-dispose</a>, and <a
6874href="command-line-options.html#page" >-page</a>, <a href="command-line-options.html#colorspace" >-colorspace</a>; generally
Cristy882d9f42015-10-29 16:48:39 -04006875assigned before the image is read in, by using a <var>key</var> of
6876the same name. </p>
6877
6878<p>If the given <var>key</var> does not match a specific known
6879'attribute ', such as shown above, the setting is stored as a a free form
Cristy594d2772015-11-15 10:47:42 -05006880'property' string. Such settings are listed in <a href="command-line-options.html#verbose"
6881>-verbose</a> information ("<code>info:</code>" output format) as "Properties".
Cristy882d9f42015-10-29 16:48:39 -04006882</p>
6883
6884<p>This includes string 'properties' that are set by and assigned to images
Cristy594d2772015-11-15 10:47:42 -05006885using the options <a href="command-line-options.html#comment" >-comment</a>, <a href="command-line-options.html#label"
6886>-label</a>, <a href="command-line-options.html#caption" >-caption</a>. These options actually assign
6887a global 'artifact' which are automatically assigned (and any <a href="escape.html" >Format Percent
Cristy882d9f42015-10-29 16:48:39 -04006888Escapes</a> expanded) to images as they are read in. For example:</p>
6889
6890<pre>
Cristy594d2772015-11-15 10:47:42 -05006891-> convert rose: -set comment 'Rose is a rose is a rose is a rose' rose.png
Cristy882d9f42015-10-29 16:48:39 -04006892identify -format %c rose.png
6893Rose is a rose is a rose is a rose
6894</pre>
6895
Cristy594d2772015-11-15 10:47:42 -05006896<p>The set value can also make use of <a href="escape.html" >Format and Print Image
Cristy882d9f42015-10-29 16:48:39 -04006897Properties</a> in the defined value. For example:</p>
6898
6899<pre>
Cristy594d2772015-11-15 10:47:42 -05006900-> convert rose: -set origsize '%wx%h' -resize 50% \
Cristy882d9f42015-10-29 16:48:39 -04006901 -format 'Old size = %[origsize] New size = %wx%h' info:
6902Old size = 70x46 New size = 35x23
6903</pre>
6904
6905<p>Other well known 'properties' that are available include:
6906'<code>date:create</code>' and '<code>date:modify</code>' and
6907'<code>signature</code>'. </p>
6908
6909<p>The <a href="command-line-options.html#repage">-repage</a> operator will also allow you to modify
6910the '<code>page</code>' attribute of an image for images already in memory (also
6911see <a href="command-line-options.html#repage">-page</a>). However it is designed to provide a finer
6912control of the sub-parts of this 'attribute'. The <a href="command-line-options.html#set">-set page</a>
6913option will only provide a direct, unmodified assignment of '<code>page</code>'
6914attribute. </p>
6915
6916<p>This option can also associate a colorspace or profile with your image.
6917For example,</p>
6918
6919<pre>
6920convert image.psd -set profile ISOcoated_v2_eci.icc image-icc.psd
6921</pre>
6922
6923<p>Some 'properties' must be defined in a specific way to be used. For
6924example only 'properties' prefixed with "<code>filename:</code>" can be used to
6925modify the output filename of an image. For example</p>
6926
6927<pre>
6928convert rose: -set filename:mysize '%wx%h' 'rose_%[filename:mysize].png'
6929</pre>
6930
6931<p>If the setting value is prefixed with "<code>option:</code>" the setting will
Cristy594d2772015-11-15 10:47:42 -05006932be saved as a global "Artifact" exactly as if it was set using the <a
6933href="command-line-options.html#define" >-define</a> option. As such settings are global in scope, they
Cristy882d9f42015-10-29 16:48:39 -04006934can be used to pass 'attributes' and 'properties' of one specific image,
6935in a way that allows you to use them in a completely different image, even if
6936the original image has long since been modified or destroyed. For example: </p>
6937
6938<pre>
6939convert rose: -set option:rosesize '%wx%h' -delete 0 \
6940 label:'%[rosesize]' label_size_of_rose.gif"
6941</pre>
6942
Cristy594d2772015-11-15 10:47:42 -05006943<p>Note that <a href="escape.html" >Format Percent Escapes</a> will only match
Cristy882d9f42015-10-29 16:48:39 -04006944a 'artifact' if the given <var>key</var> does not match an existing
6945'attribute' or 'property'. </p>
6946
6947<p>You can set the attributes of the image registry by prefixing the value
6948with <code>registry:</code>.</p>
6949
6950<p>The <a href="command-line-options.html#set">-set profile</a> option can also be used to inject
6951previously-formatted ancillary chunks into the output PNG file, using
6952the commandline option as shown below or by setting the profile via a
6953programming interface:</p>
6954
6955<pre>
6956convert in.png -set profile PNG-chunk-x:&lt;filename&gt; out.png
6957</pre>
6958
6959<p>where <var>x</var> is a location flag and
6960<var>filename</var> is a file containing the chunk
6961name in the first 4 bytes, then a colon (":"), followed by the chunk data.
6962This encoder will compute the chunk length and CRC, so those must not
6963be included in the file.</p>
6964
6965<p>"x" can be "b" (before PLTE), "m" (middle, i.e., between PLTE and IDAT),
6966or "e" (end, i.e., after IDAT). If you want to write multiple chunks
6967of the same type, then add a short unique string after the "x" to prevent
6968subsequent profiles from overwriting the preceding ones, e.g.,</p>
6969
6970
6971<pre>
6972convert in.png -set profile PNG-chunk-b01:file01 \
6973 -profile PNG-chunk-b02:file02 out.png
6974</pre>
6975
6976<div style="margin: auto;">
6977 <h3 class="magick-header"><a id="shade"></a>-shade <var>azimuth</var>x<var>elevation</var></h3>
6978</div>
6979
6980<p class="magick-description">shade the image using a distant light source.</p>
6981
6982<p>Specify <var>azimuth</var> and <var>elevation</var> as
6983the position of the light source. Use <a href="command-line-options.html#shade">+shade</a> to return
6984the shading results as a grayscale image.</p>
6985
6986<div style="margin: auto;">
6987 <h3 class="magick-header"><a id="shadow"></a>-shadow <var>percent-opacity</var>{x<var>sigma</var>}{<var>+-</var>}<var>x</var>{<var>+-</var>}<var>y</var>{<var>%</var>}</h3>
6988</div>
6989
6990<p class="magick-description">simulate an image shadow.</p>
6991
6992<div style="margin: auto;">
Cristy594d2772015-11-15 10:47:42 -05006993 <h3 class="magick-header"><a
6994id="shared-memory"></a>-shared-memory</h3>
Cristy882d9f42015-10-29 16:48:39 -04006995</div>
6996
6997<p class="magick-description">use shared memory.</p>
6998
6999<p>This option specifies whether the utility should attempt to use shared
7000memory for pixmaps. ImageMagick must be compiled with shared memory support,
7001and the display must support the <var>MIT-SHM</var> extension.
7002Otherwise, this option is ignored. The default is <code>True</code>.</p>
7003
7004<div style="margin: auto;">
Cristy594d2772015-11-15 10:47:42 -05007005 <h3 class="magick-header"><a id="sharpen"></a>-sharpen <var>radius</var><br />-sharpen <var>radius</var>x<var>sigma</var></h3>
Cristy882d9f42015-10-29 16:48:39 -04007006</div>
7007
7008<p class="magick-description">sharpen the image.</p>
7009
7010<p>Use a Gaussian operator of the given radius and standard deviation (sigma).</p>
7011
7012<div style="margin: auto;">
7013 <h3 class="magick-header"><a id="shave"></a>-shave <var>geometry</var></h3>
7014</div>
7015
7016<p class="magick-description">Shave pixels from the image edges.</p>
7017
7018<p>The <var>size</var> portion of the <var>geometry</var>
7019argument specifies the width of the region to be removed from both sides of
7020the image and the height of the regions to be removed from top and bottom.
7021Offsets are ignored.</p>
7022
7023<p>See <a href="command-line-processing.html#geometry">Image Geometry</a> for complete details about the <em class="arg">geometry</em> argument.</p>
7024
7025<div style="margin: auto;">
7026 <h3 class="magick-header"><a id="shear"></a>-shear <var>Xdegrees</var>[x<var>Ydegrees</var>]</h3>
7027</div>
7028
7029<p class="magick-description">Shear the image along the x-axis and/or y-axis.</p>
7030
7031<p>The shear angles may be positive, negative, or zero. When <var>Ydegrees</var> is omitted it defaults to 0. When both angles are
7032given, the horizontal component of the shear is performed before the vertical
7033component.</p>
7034
7035<p>Shearing slides one edge of an image along the x-axis or y-axis (i.e.,
7036horizontally or vertically, respectively),creating a parallelogram. The amount
7037of each is controlled by the respective shear angle. For horizontal shears,
7038<var>Xdegrees</var> is measured clockwise relative to "up" (the
7039negative y-axis), sliding the top edge to the right when 0°&lt;<var>Xdegrees</var>&lt;90° and to the left when 90°&lt;<var>Xdegrees</var>&lt;180°. For vertical shears <var>Ydegrees</var> is measured clockwise relative to "right" (the
7040positive x-axis), sliding the right edge down when 0°&lt;<var>Ydegrees</var>&lt;90° and up when 90°&lt;<var>Ydegrees</var>&lt;180°.</p>
7041
7042<p>Empty triangles left over from shearing the image are filled with the color
7043defined by the <a href="command-line-options.html#fill">-background</a> option. The color is specified
7044using the format described under the <a href="command-line-options.html#fill">-fill</a> option.</p>
7045
7046<p>The horizontal shear is performed before the vertical part. This is
7047important to note, since horizontal and vertical shears do not
7048<var>commute</var>, i.e., the order matters in a sequence of shears. For
7049example, the following two commands are not equivalent.</p>
7050
7051<pre>
7052convert logo: -shear 20x0 -shear 0x60 logo-sheared.png
7053convert logo: -shear 0x60 -shear 20x0 logo-sheared.png
7054</pre>
7055
7056<p>The first of the two commands above is equivalent to the following, except
7057for the amount of empty space created; the command that follows generates
7058a smaller image, and so is a better choice in terms of time and space.</p>
7059
7060<pre>
7061convert logo: -shear 20x60 logo-sheared.png
7062</pre>
7063
7064<div style="margin: auto;">
7065 <h3 class="magick-header"><a id="sigmoidal-contrast"></a>-sigmoidal-contrast <var>contrast</var>x<var>mid-point</var></h3>
7066</div>
7067
7068<p class="magick-description">increase the contrast without saturating highlights or shadows.</p>
7069
7070<p>Increase the contrast of the image using a sigmoidal transfer function
7071without saturating highlights or shadows. <var>Contrast</var>
7072indicates how much to increase the contrast. For example, 0 is none, 3 is
7073typical and 20 is a lot.
7074</p>
7075
7076<p>The <var>mid-point</var> indicates where the maximum change
7077'slope' in contrast should fall in the resultant image (0 is white; 50% is
7078middle-gray; 100% is black). </p>
7079
7080<p>By default the image contrast is increased, use <var>+sigmoidal-contrast</var> to decrease the contrast.</p>
7081
7082<p>To achieve the equivalent of a sigmoidal brightness change (similar to
7083a gamma adjustment), you would use <var>-sigmoidal-contrast
7084{brightness}x0%</var> to increase brightness and <var>+sigmoidal-contrast {brightness}x0%</var> to decrease brightness.
7085Note the use of '0' fo rthe mid-point of the sigmoidal curve. </p>
7086
7087<p>Using a very high <var>contrast</var> will produce a sort of
7088'smoothed thresholding' of the image. Not as sharp (with high aliasing
7089effects) of a true threshold, but with tapered gray-levels around the threshold
7090<var>mid-point</var>. </p>
7091
7092<div style="margin: auto;">
7093 <h3 class="magick-header"><a id="silent"></a>-silent</h3>
Cristyf650f4f2016-04-01 10:53:07 -04007094
7095
Cristy882d9f42015-10-29 16:48:39 -04007096</div>
7097
Cristyf650f4f2016-04-01 10:53:07 -04007098<p class="magick-description">operate silently. This option is only used
7099by the <a href="import.html">import</a> tool.</p>
Cristy882d9f42015-10-29 16:48:39 -04007100
7101<div style="margin: auto;">
7102 <h3 class="magick-header"><a id="similarity-threshold"></a>-similarity-threshold <var>value</var></h3>
7103</div>
7104
7105<p class="magick-description">minimum RMSE for subimage match.</p>
7106
7107<p>If this setting is used, then the search will stop as soon as it finds a match whose metric is less than or equal to the value. A partially filled second output image will result. Using a value of zero, will cause the search to stop at the first perfect match it finds. If this setting is left off, then the search will proceed to completion or as limited by <var>-dissimilarity-threshold</var>.</p>
7108
7109<div style="margin: auto;">
7110 <h3 class="magick-header"><a id="size"></a>-size <var>width</var>[x<var>height</var>][<var>+offset</var>]</h3>
7111</div>
7112
7113<p class="magick-description">set the width and height of the image.</p>
7114
7115<p>Use this option to specify the width and height of raw images whose
7116dimensions are unknown such as <code>GRAY</code>, <code>RGB</code>, or
Cristy594d2772015-11-15 10:47:42 -05007117<code>CMYK</code>. In addition to width and height, use <a
7118href="command-line-options.html#size">-size</a> with an offset to skip any header information in the
Cristy882d9f42015-10-29 16:48:39 -04007119image or tell the number of colors in a <code>MAP</code> image file, (e.g. -size
7120640x512+256).</p>
7121
7122<p>For Photo CD images, choose from these sizes:</p>
7123
7124<pre>
7125192x128
7126384x256
7127768x512
71281536x1024
71293072x2048
7130</pre>
7131
7132<div style="margin: auto;">
Cristy594d2772015-11-15 10:47:42 -05007133 <h3 class="magick-header"><a id="sketch"></a>-sketch <var>radius</var><br />-sketch <var>radius</var>x<var>sigma</var>+<var>angle</var></h3>
Cristy882d9f42015-10-29 16:48:39 -04007134</div>
7135
7136<p class="magick-description">simulate a pencil sketch.</p>
7137
7138<p>Sketch with the given radius, standard deviation (sigma), and angle. The
7139angle given is the angle toward which the image is sketched. That is the
7140direction people would consider the object is coming from. </p>
7141
7142<div style="margin: auto;">
7143 <h3 class="magick-header"><a id="smush"></a>-smush <var>offset</var></h3>
7144</div>
7145
Cristybc232422016-11-22 07:46:18 -05007146<p class="magick-description">appends an image sequence together ignoring transparency.</p>
7147
7148<p>Smush is a more flexible version of <a href="command-line-options.html#append">-append</a>, joining the images in the sequence top-to-bottom (<a href="command-line-options.html#smush">-smush</a>) or left-to-right (<a href="command-line-options.html#smush">+smush</a>), with a gap between images according to the specified offset.</p>
7149
7150<p>If the offset is negative, images will overlap by that amount.</p>
7151
7152<p><a href="command-line-options.html#smush">-smush</a> respects <a href="command-line-options.html#gravity">-gravity</a>. Any empty space will be filled with the <a href="command-line-options.html#background">-background</a> color.</p>
7153
7154<p>For zero offset and transparent images, the non-transparent parts of the two images will be aligned as close as possible without overlapping.</p>
Cristy882d9f42015-10-29 16:48:39 -04007155
7156<div style="margin: auto;">
7157 <h3 class="magick-header"><a id="snaps"></a>-snaps <var>value</var></h3>
7158</div>
7159
7160<p class="magick-description">Set the number of screen snapshots.</p>
7161
7162<p>Use this option to grab more than one image from the X server screen, to create an animation sequence.</p>
7163
7164<div style="margin: auto;">
Cristy769d8892016-01-19 18:11:14 -05007165 <h3 class="magick-header"><a id="solarize"></a>-solarize <var>percent-threshold</var></h3>
Cristy882d9f42015-10-29 16:48:39 -04007166</div>
7167
7168<p class="magick-description">negate all pixels above the threshold level.</p>
7169
7170<p>Specify <var>factor</var> as the percent threshold of the intensity (0 - 99.9%).</p>
7171
7172<p>This option produces a <var>solarization</var> effect seen when
7173exposing a photographic film to light during the development process.</p>
7174
7175<div style="margin: auto;">
7176 <h3 class="magick-header"><a id="sparse-color"></a>-sparse-color <var>method</var> '<var>x</var>,<var>y</var> <var>color</var> ...'</h3>
7177</div>
7178
7179<p class="magick-description"> color the given image using the specified points of color, and filling the other intervening colors using the given methods. </p>
7180
7181
7182<dl class="dl-horizontal">
7183 <dt>barycentric</dt>
7184 <dd>three point triangle of color given 3 points.
7185 Giving only 2 points will form a linear gradient between those points.
7186 The gradient generated extends beyond the triangle created by those
7187 3 points. </dd>
7188 <dt>bilinear</dt>
7189 <dd>Like barycentric but for 4 points. Less than 4 points
7190 fall back to barycentric. </dd>
7191 <dt>voronoi</dt>
7192 <dd>Simply map each pixel to the to nearest color point
7193 given. The result are polygonal 'cells' of solid color. </dd>
7194 <dt>manhatten</dt>
7195 <dd>Like voronoi, but resulting polygonal 'cells' are mapped to a fixed coordinate system.</dd>
7196 <dt>shepards</dt>
7197 <dd>Colors points biased on the ratio of inverse distance
7198 squared. Generating spots of color in a sea of the average of
7199 colors. </dd>
7200 <dt>inverse</dt>
7201 <dd>Colors points biased on the ratio of inverse distance.
7202 This generates sharper points of color rather than rounded spots of
7203 '<code>shepards</code>' Generating spots of color in a sea of the
7204 average of colors. </dd>
7205</dl>
7206
7207<p>The points are placed according to the images location on the virtual
Cristy594d2772015-11-15 10:47:42 -05007208canvas (<a href="command-line-options.html#page" >-page</a> or <a href="command-line-options.html#repage" >-repage</a>
Cristy882d9f42015-10-29 16:48:39 -04007209offset), and do not actually have to exist on the given image, but may be
7210some point beyond the edge of the image. All points are floating point values.
7211</p>
7212
Cristy594d2772015-11-15 10:47:42 -05007213<p>Only the color channels defined by the <a href="command-line-options.html#channel" >-channel</a> are
Cristy882d9f42015-10-29 16:48:39 -04007214modified, which means that by default matte/alpha transparency channel is not
7215effected. Typically transparency channel is turned off either before or after
7216the operation. </p>
7217
7218<p>Of course if some color points are transparent to generate a transparent
7219gradient, then the image also requires transparency enabled to store the
7220values. </p>
7221
7222<p>All the above methods when given a single point of color will replace all
7223the colors in the image with the color given, regardless of the point. This is
7224logical, and provides an alternative technique to recolor an image to some
7225default value. </p>
7226
7227
7228<div style="margin: auto;">
7229 <h3 class="magick-header"><a id="splice"></a>-splice <var>geometry</var></h3>
7230</div>
7231
7232<p class="magick-description">Splice the current background color into the image.</p>
7233
Cristy594d2772015-11-15 10:47:42 -05007234<p>This will add rows and columns of the current <a
7235href="command-line-options.html#background">-background</a> color into the given image according to the
Cristy882d9f42015-10-29 16:48:39 -04007236given <a href="command-line-options.html#gravity">-gravity</a> geometry setting. See <a href="command-line-processing.html#geometry">Image Geometry</a> for complete details about the <em class="arg">geometry</em> argument. Essentially <a href="command-line-options.html#splice">-splice</a> will divide the
7237image into four quadrants, separating them by the inserted rows and columns.
7238</p>
7239
7240<p>If a dimension of geometry is zero no rows or columns will be added for that
Cristy594d2772015-11-15 10:47:42 -05007241dimension. Similarly using a zero offset with the appropriate <a
7242href="command-line-options.html#gravity">-gravity</a> setting will add rows and columns to the edges of
7243the image, padding the image only along that one edge. Edge padding is what <a
7244href="command-line-options.html#splice">-splice</a> is most commonly used for. </p>
Cristy882d9f42015-10-29 16:48:39 -04007245
Cristy594d2772015-11-15 10:47:42 -05007246<p>If the exact same <var>geometry</var> and <a
7247href="command-line-options.html#gravity">-gravity</a> is later used with <a href="command-line-options.html#chop">-chop</a> the
Cristy882d9f42015-10-29 16:48:39 -04007248added added all splices removed. </p>
7249
7250<div style="margin: auto;">
7251 <h3 class="magick-header"><a id="spread"></a>-spread <var>amount</var></h3>
7252</div>
7253
7254<p class="magick-description">displace image pixels by a random amount.</p>
7255
7256<p>The argument <var>amount</var> defines the size of the
7257neighborhood around each pixel from which to choose a candidate pixel to
7258blend.</p>
7259
7260<p>The lookup is controlled by the <a href="command-line-options.html#interpolate">-interpolate</a> setting.</p>
7261
7262<div style="margin: auto;">
7263 <h3 class="magick-header"><a id="statistic"></a>-statistic <var>type</var> <var>geometry</var></h3>
7264</div>
7265
7266<p class="magick-description">replace each pixel with corresponding statistic from the neighborhood.</p>
7267
7268<p>Choose from these statistic types:</p>
7269<dl class="dl-horizontal">
7270<dt>Gradient</dt><dd>maximum difference (max - min) value in neighborhood</dd>
7271<dt>Maximum</dt><dd>maximum value per channel in neighborhood</dd>
7272<dt>Minimum</dt><dd>minimum value per channel in neighborhood</dd>
7273<dt>Mean</dt><dd>average value per channel in neighborhood</dd>
7274<dt>Median</dt><dd>median value per channel in neighborhood</dd>
7275<dt>Mode</dt><dd>mode (most frequent) value per channel in neighborhood</dd>
7276<dt>Nonpeak</dt><dd>value just before or after the median value per channel in neighborhood</dd>
7277<dt>RMS</dt><dd>root mean square value per channel in neighborhood</dd>
7278<dt>StandardDeviation</dt><dd> standard deviation value per channel in neighborhood</dd>
7279</dl>
7280
7281<div style="margin: auto;">
7282 <h3 class="magick-header"><a id="stegano"></a>-stegano <var>offset</var></h3>
7283</div>
7284
7285<p class="magick-description">hide watermark within an image.</p>
7286
7287<p>Use an offset to start the image hiding some number of pixels from the
7288beginning of the image. Note this offset and the image size. You will need
7289this information to recover the steganographic image (e.g. display -size
7290320x256+35 stegano:image.png).</p>
7291
7292<div style="margin: auto;">
7293 <h3 class="magick-header"><a id="stereo"></a>-stereo <var>+x</var>{<var>+y</var>}</h3>
7294</div>
7295
7296<p class="magick-description">composite two images to create a red / cyan stereo anaglyph.</p>
7297
7298<p>The left side of the stereo pair (second image) is saved as the red channel of the output image. The right side (first image) is saved as the green and blue channels. Red-green stereo glasses are required to properly view the stereo image.</p>
7299
7300<div style="margin: auto;">
7301 <h3 class="magick-header"><a id="storage-type"></a>-storage-type <var>type</var></h3>
7302</div>
7303
7304<p class="magick-description">pixel storage type. Here are the valid types:</p>
7305
7306<dl class="dl-horizontal">
7307<dt>char</dt><dd>unsigned characters</dd>
7308<dt>double</dt><dd>doubles</dd>
7309<dt>float</dt><dd>floats</dd>
7310<dt>integer</dt><dd>integers</dd>
7311<dt>long</dt><dd>longs</dd>
7312<dt>quantum</dt><dd>pixels in the native depth of your ImageMagick distribution</dd>
7313<dt>short</dt><dd>unsigned shorts</dd>
7314</dl>
7315
7316<p>Float and double types are normalized from 0.0 to 1.0 otherwise the pixels
7317values range from 0 to the maximum value the storage type can support.</p>
7318
7319<div style="margin: auto;">
7320 <h3 class="magick-header"><a id="stretch"></a>-stretch <var>fontStretch</var></h3>
7321</div>
7322
7323<p class="magick-description">Set a type of stretch style for fonts.</p>
7324
7325<p>This setting suggests a type of stretch that ImageMagick should try to
7326apply to the currently selected font family. Select <var>fontStretch</var> from the following.</p>
7327
7328<pre>
7329Any
7330Condensed
7331Expanded
7332ExtraCondensed
7333ExtraExpanded
7334Normal
7335SemiCondensed
7336SemiExpanded
7337UltraCondensed
7338UltraExpanded
7339</pre>
7340
7341<p>To print a complete list of stretch types, use <a href="command-line-options.html#list">-list
7342stretch</a>.</p>
7343
Cristy594d2772015-11-15 10:47:42 -05007344<p>For other settings that affect fonts, see the options <a
7345href="command-line-options.html#font">-font</a>, <a href="command-line-options.html#family">-family</a>, <a
7346href="command-line-options.html#style">-style</a>, and <a href="command-line-options.html#weight">-weight</a>. </p>
Cristy882d9f42015-10-29 16:48:39 -04007347
7348<div style="margin: auto;">
7349 <h3 class="magick-header"><a id="strip"></a>-strip</h3>
7350</div>
7351
Cristy776113a2016-04-29 12:01:19 -04007352<p class="magick-description">strip the image of any profiles, comments or these PNG chunks: bKGD,cHRM,EXIF,gAMA,iCCP,iTXt,sRGB,tEXt,zCCP,zTXt,date.</p>
Cristy882d9f42015-10-29 16:48:39 -04007353
7354<div style="margin: auto;">
7355 <h3 class="magick-header"><a id="stroke"></a>-stroke <var>color</var></h3>
7356</div>
7357
7358<p class="magick-description">color to use when stroking a graphic primitive.</p>
7359
7360<p>The color is specified using the format described under the <a href="command-line-options.html#fill">-fill</a> option.</p>
7361
7362<p>See <a href="command-line-options.html#draw">-draw</a> for further details.</p>
7363
7364<div style="margin: auto;">
7365 <h3 class="magick-header"><a id="strokewidth"></a>-strokewidth <var>value</var></h3>
7366</div>
7367
7368<p class="magick-description">set the stroke width.</p>
7369
7370<p>See <a href="command-line-options.html#draw">-draw</a> for further details.</p>
7371
7372<div style="margin: auto;">
7373 <h3 class="magick-header"><a id="style"></a>-style <var>fontStyle</var></h3>
7374</div>
7375
7376<p class="magick-description">Set a font style for text.</p>
7377
7378<p>This setting suggests a font style that ImageMagick should try to apply to
7379the currently selected font family. Select <var>fontStyle</var> from
7380the following.</p>
7381
7382<pre>
7383Any
7384Italic
7385Normal
7386Oblique
7387</pre>
7388
Cristy594d2772015-11-15 10:47:42 -05007389<p>For other settings that affect fonts, see the options <a
7390href="command-line-options.html#font">-font</a>, <a href="command-line-options.html#family">-family</a>, <a
7391href="command-line-options.html#stretch">-stretch</a>, and <a href="command-line-options.html#weight">-weight</a>. </p>
Cristy882d9f42015-10-29 16:48:39 -04007392
7393<div style="margin: auto;">
7394 <h3 class="magick-header"><a id="subimage-search"></a>-subimage-search</h3>
7395</div>
7396
7397<p class="magick-description">search for subimage.</p>
7398
7399<p>This option is required to have compare search for the best match location
7400of a small image within a larger image. This search will produce two images
7401(or two frames). The first is the "difference" image and the second will
7402be the "match score" image.</p>
7403
7404<p>The "match-score" image is smaller containing a pixel for ever possible
7405position of the top-left corner of the given sub-image. that is its size will
7406be the size of the larger_image - sub_image + 1. The brightest location in
7407this image is the location s the locate on the best match that is also
7408reported. Note that this may or may not be a perfect match, and the actual
7409brightness will reflect this. Other bright 'peaks' can be used to locate other
7410possible matching locations. </p>
7411
7412<p>Note that the search will try to compare the sub-image at every possible
7413location in the larger image, as such it can be very slow. The smaller the
7414sub-image the faster this search is. </p>
7415
7416
7417<div style="margin: auto;">
7418 <h3 class="magick-header"><a id="swap"></a>-swap <var>index,index</var></h3>
7419</div>
7420
7421<p class="magick-description">Swap the positions of two images in the image sequence.</p>
7422
7423<p>For example, <a href="command-line-options.html#swap">-swap 0,2</a> swaps the first and the third
7424images in the current image sequence. Use <a href="command-line-options.html#swap">+swap</a> to switch
7425the last two images in the sequence.</p>
7426
7427<div style="margin: auto;">
7428 <h3 class="magick-header"><a id="swirl"></a>-swirl <var>degrees</var></h3>
7429</div>
7430
7431<p class="magick-description">swirl image pixels about the center.</p>
7432
7433<p><var>Degrees</var> defines the tightness of the swirl.</p>
7434
7435<div style="margin: auto;">
7436 <h3 class="magick-header"><a id="synchronize"></a>-synchronize</h3>
7437</div>
7438
7439<p class="magick-description">synchronize image to storage device.</p>
7440
7441<p>Set to "true" to ensure all image data is fully flushed and synchronized
7442to disk. There is a performance penalty, but the benefits include ensuring a
7443valid image file in the event of a system crash and early reporting if there
7444is not enough disk space for the image pixel cache.</p>
7445
7446<div style="margin: auto;">
7447 <h3 class="magick-header"><a id="taint"></a>-taint</h3>
7448</div>
7449
7450<p class="magick-description">Mark the image as modified.</p>
7451
7452<div style="margin: auto;">
7453 <h3 class="magick-header"><a id="text-font"></a>-text-font <var>name</var></h3>
7454</div>
7455
7456<p class="magick-description">font for writing fixed-width text.</p>
7457
7458<p>Specifies the name of the preferred font to use in fixed (typewriter style)
7459formatted text. The default is 14 point <var>Courier</var>.</p>
7460
7461<p>You can tag a font to specify whether it is a PostScript, TrueType, or
7462OPTION1 font. For example, <code>Courier.ttf</code> is a TrueType font and
7463<code>x:fixed</code> is OPTION1.</p>
7464
7465<div style="margin: auto;">
7466 <h3 class="magick-header"><a id="texture"></a>-texture <var>filename</var></h3>
7467</div>
7468
7469<p class="magick-description">name of texture to tile onto the image background.</p>
7470
7471<div style="margin: auto;">
7472 <h3 class="magick-header"><a id="threshold"></a>-threshold <var>value</var>{<var>%</var>}</h3>
7473</div>
7474
7475<!-- {<var>green,blue,opacity</var>}
7476<p>If the green or blue value is omitted, these channels use the same value as
7477the first one provided. If all three color values are the same, the result is
7478a bi-level image. If the opacity threshold is omitted, OpaqueOpacity is used
7479and any partially transparent pixel becomes fully transparent.</p>
7480-->
7481
7482<p class="magick-description">Apply simultaneous black/white threshold to the image.</p>
7483
Cristy594d2772015-11-15 10:47:42 -05007484<p>Any pixel values (more specifically, those channels set using <a href="command-line-options.html#channel">&#x2011;channel</a>) that exceed the specified threshold are reassigned the
Cristy882d9f42015-10-29 16:48:39 -04007485maximum channel value, while all other values are assigned the minimum.</p>
7486
7487<p> The threshold value can be given as a percentage or as an absolute integer
7488value corresponding to the desired channel value. When given as an integer,
7489the minimum attainable value is 0 (corresponding to black when all channels
7490are affected), but the maximum value (corresponding to white) is that of the
7491<code>quantum depth</code> of the particular build of ImageMagick, and is
7492therefore dependent on the installation. For that reason, a reasonable
7493recommendation for most applications is to specify the threshold values as
7494a percentage. </p>
7495
7496<p> The following would force pixels with red values above 50% to have 100%
7497red values, while those at or below 50% red would be set to 0 in the red
7498channel. The green, blue, and alpha channels (if present) would be unchanged.
7499</p>
7500
7501<pre>
7502convert in.png -channel red -threshold 50% out.png
7503</pre>
7504
7505<p>As (possibly) impractical but instructive examples, the following would
7506generate an all-black and an all-white image with the same dimensions as the
7507input image.</p>
7508
7509
7510<pre>
7511convert in.png -threshold 100% black.png
7512convert in.png -threshold -1 white.png
7513</pre>
7514
7515<p>Note that the values of the transparency channel is treated as 'matte'
7516values (0 is opaque) and not as 'alpha' values (0 is transparent).</p>
7517
Cristy594d2772015-11-15 10:47:42 -05007518<p> See also <a href="command-line-options.html#black-threshold">&#x2011;black&#x2011;threshold</a> and <a href="command-line-options.html#white-threshold">&#x2011;white&#x2011;threshold</a>.
Cristy882d9f42015-10-29 16:48:39 -04007519</p>
7520
7521<div style="margin: auto;">
7522 <h3 class="magick-header"><a id="thumbnail"></a>-thumbnail <var>geometry</var></h3>
7523</div>
7524
7525<p class="magick-description">Create a thumbnail of the image.</p>
7526
7527<p>This is similar to <a href="command-line-options.html#resize">-resize</a>, except it is optimized
7528for speed and any image profile, other than a color profile, is removed to
Cristy594d2772015-11-15 10:47:42 -05007529reduce the thumbnail size. To strip the color profiles as well, add <a
7530href="command-line-options.html#strip">-strip</a> just before of after this option.</p>
Cristy882d9f42015-10-29 16:48:39 -04007531
7532<p>See <a href="command-line-processing.html#geometry">Image Geometry</a> for complete details about the <em class="arg">geometry</em> argument.</p>
7533
7534<div style="margin: auto;">
7535 <h3 class="magick-header"><a id="tile"></a>-tile <var>filename</var></h3>
7536</div>
7537
7538<p class="magick-description">Set the tile image used for filling a subsequent graphic primitive.</p>
7539
7540<div style="margin: auto;">
7541 <h3 class="magick-header">-tile <var>geometry</var></h3>
7542</div>
7543
7544<p class="magick-description">Specify the layout of images.</p>
7545
7546<p>See <a href="command-line-processing.html#geometry">Image Geometry</a> for complete details about the <em class="arg">geometry</em> argument.</p>
7547
7548<div style="margin: auto;">
7549 <h3 class="magick-header">-tile</h3>
7550</div>
7551
7552<p class="magick-description">Specifies that a subsequent composite operation is repeated across and down image.</p>
7553
7554<div style="margin: auto;">
7555 <h3 class="magick-header"><a id="tile-offset"></a>-tile-offset {<var>+-</var>}<var>x</var>{<var>+-</var>}<var>y</var></h3>
7556</div>
7557
7558<p class="magick-description">Specify the offset for tile images, relative to the background image it is tiled on.</p>
7559
Cristy594d2772015-11-15 10:47:42 -05007560<p>This should be set before the tiling image is set by <a href="command-line-options.html#tile"
7561>-tile</a> or <a href="command-line-options.html#texture" >-texture</a>, or directly applied for
Cristy882d9f42015-10-29 16:48:39 -04007562creating a tiled canvas using <code>TILE:</code> or <code>PATTERN:</code> input
7563formats. </p>
7564
Cristy594d2772015-11-15 10:47:42 -05007565<p>Internally ImageMagick does a <a href="command-line-options.html#roll" >-roll</a> of the tile image
Cristy882d9f42015-10-29 16:48:39 -04007566by the arguments given when the tile image is set. </p>
7567
7568<div style="margin: auto;">
7569 <h3 class="magick-header"><a id="tint"></a>-tint <var>value</var></h3>
7570</div>
7571
7572<p class="magick-description">Tint the image with the fill color.</p>
7573
7574<p>Tint the image with the fill color.</p>
7575
7576<p>Specify the amount of tinting as a percentage. Pure colors like black,
7577white red, yellow, will not be affected by -tint. Only mid-range colors such
7578as the various shades of grey.</p>
7579
7580<div style="margin: auto;">
7581 <h3 class="magick-header"><a id="title"></a>-title <var>string</var></h3>
7582</div>
7583
7584<p class="magick-description">Assign a title to displayed image.", "animate", "display", "montage</p>
7585
7586<p>Use this option to assign a specific title to the image. This assigned to
7587the image window and is typically displayed in the window title bar.
7588Optionally you can include the image filename, type, width, height, Exif data,
7589or other image attribute by embedding special format characters described
7590under the <a href="command-line-options.html#format">-format</a> option.</p>
7591
7592<p>For example,</p>
7593
7594<pre>
7595-title "%m:%f %wx%h"
7596</pre>
7597
7598<p>produces an image title of <code>MIFF:bird.miff 512x480</code> for an image
7599titled <code>bird.miff</code> and whose width is 512 and height is 480.</p>
7600
7601
7602<div style="margin: auto;">
7603 <h3 class="magick-header"><a id="transform"></a>-transform</h3>
7604</div>
7605
7606<p class="magick-description">transform the image.</p>
7607
7608<p>This option applies the transformation matrix from a previous <a href="command-line-options.html#affine">-affine</a> option.</p>
7609
7610<pre>
7611convert -affine 2,2,-2,2,0,0 -transform bird.ppm bird.jpg
7612</pre>
7613
7614
Cristy594d2772015-11-15 10:47:42 -05007615<p>This operator has been now been superseded by the <a
7616href="command-line-options.html#distort">-distort</a> '<code>AffineProjection</code>' method. </p>
Cristy882d9f42015-10-29 16:48:39 -04007617
7618
7619<div style="margin: auto;">
7620 <h3 class="magick-header"><a id="transparent"></a>-transparent <var>color</var></h3>
7621</div>
7622
7623<p class="magick-description">Make this color transparent within the image.</p>
7624
7625<p>The <var>color</var> argument is defined using the format
Cristy594d2772015-11-15 10:47:42 -05007626described under the <a href="command-line-options.html#fill">-fill</a> option. The <a href="command-line-options.html#fuzz"
7627>-fuzz</a> setting can be used to match and replace colors similar to the one
Cristy882d9f42015-10-29 16:48:39 -04007628given. </p>
7629
Cristy594d2772015-11-15 10:47:42 -05007630<p>Use <a href="command-line-options.html#transparent" >+transparent</a> to invert the pixels matched.
Cristy882d9f42015-10-29 16:48:39 -04007631that is make all non-matching colors transparent. </p>
7632
Cristy594d2772015-11-15 10:47:42 -05007633<p>The <a href="command-line-options.html#opaque">-opaque</a> operator is exactly the same as <a
7634href="command-line-options.html#transparent" >-transparent</a> but replaces the matching color with the
Cristy882d9f42015-10-29 16:48:39 -04007635current <a href="command-line-options.html#fill">-fill</a> color setting, rather than transparent.
Cristy594d2772015-11-15 10:47:42 -05007636However the <a href="command-line-options.html#transparent" >-transparent</a> operator also ensures
7637that the image has an alpha channel enabled, as per "<code><a href="command-line-options.html#alpha"
7638>-alpha</a> set</code>", and does not require you to modify the <a
7639href="command-line-options.html#channel">-channel</a> to enable alpha channel handling. </p>
Cristy882d9f42015-10-29 16:48:39 -04007640
7641<p>Note that this does not define the color as being the 'transparency color'
Cristy594d2772015-11-15 10:47:42 -05007642used for color-mapped image formats, such as GIF. For that use <a
7643href="command-line-options.html#transparent-color" >-transparent-color</a> </p>
Cristy882d9f42015-10-29 16:48:39 -04007644
7645
7646<div style="margin: auto;">
7647 <h3 class="magick-header"><a id="transparent-color"></a>-transparent-color <var>color</var></h3>
7648</div>
7649
7650<p class="magick-description">Set the transparent color.</p>
7651
7652<p>Sometimes this is used for saving to image formats such as
7653GIF and PNG8 which uses this color to represent boolean transparency. This
7654does not make a color transparent, it only defines what color the transparent
Cristy594d2772015-11-15 10:47:42 -05007655color is in the color palette of the saved image. Use <a
7656href="command-line-options.html#transparent">-transparent</a> to make an opaque color transparent.</p>
Cristy882d9f42015-10-29 16:48:39 -04007657
7658<p>This option allows you to have both an opaque visible color, as well as a
7659transparent color of the same color value without conflict. That is, you can
7660use the same color for both the transparent and opaque color areas within an
7661image. This, in turn, frees to you to select a transparent color that is
7662appropriate when an image is displayed by an application that does not handle a
7663transparent color index, while allowing ImageMagick to correctly handle images of this
7664type. </p>
7665
7666<p>The default transparent color is <code>#00000000</code>, which is fully transparent black.</p>
7667
7668<div style="margin: auto;">
7669 <h3 class="magick-header"><a id="transpose"></a>-transpose</h3>
7670</div>
7671
7672<p class="magick-description">Mirror the image along the top-left to bottom-right diagonal.</p>
7673
7674<p> This option mathematically transposes the pixel array. It is equivalent to the sequence <code>-flip -rotate 90</code>.
7675</p>
7676
7677<div style="margin: auto;">
7678 <h3 class="magick-header"><a id="transverse"></a>-transverse</h3>
7679</div>
7680
7681<p class="magick-description">Mirror the image along the images bottom-left top-right diagonal. Equivalent to the operations <code>-flop -rotate 90</code>.</p>
7682
7683
7684<div style="margin: auto;">
7685 <h3 class="magick-header"><a id="treedepth"></a>-treedepth <var>value</var></h3>
7686</div>
7687
7688<p class="magick-description">tree depth for the color reduction algorithm.</p>
7689
7690<p>Normally, this integer value is zero or one. A value of zero or one causes
7691the use of an optimal tree depth for the color reduction algorithm.</p>
7692
7693<p>An optimal depth generally allows the best representation of the source
7694image with the fastest computational speed and the least amount of memory.
7695However, the default depth is inappropriate for some images. To assure the
7696best representation, try values between 2 and 8 for this parameter. Refer to
Cristy6549abb2016-11-10 08:25:55 -05007697the <a href="http://www.imagemagick.org/www/quantize.html"
Cristy594d2772015-11-15 10:47:42 -05007698>color reduction algorithm</a> for more details.</p>
Cristy882d9f42015-10-29 16:48:39 -04007699
7700<p>The <a href="command-line-options.html#colors">-colors</a> or <a href="command-line-options.html#monochrome">-monochrome</a>
7701option, or writing to an image format which requires color reduction, is
7702required for this option to take effect.</p>
7703
7704<div style="margin: auto;">
7705 <h3 class="magick-header"><a id="trim"></a>-trim</h3>
7706</div>
7707
7708<p class="magick-description">trim an image.</p>
7709
7710<p>This option removes any edges that are exactly the same color as the corner
7711pixels. Use <a href="command-line-options.html#fuzz">-fuzz</a> to make <a href="command-line-options.html#trim">-trim</a> remove
7712edges that are nearly the same color as the corner pixels.</p>
7713
7714<p>The page or virtual canvas information of the image is preserved allowing
7715you to extract the result of the <a href="command-line-options.html#trim">-trim</a> operation from the
7716image. Use a <a href="command-line-options.html#repage">+repage</a> to remove the virtual canvas page
7717information if it is unwanted.</p>
7718
7719<p>If the trimmed image 'disappears' an warning is produced, and a special
7720single pixel transparent 'missed' image is returned, in the same way as when a
7721<a href="command-line-options.html#crop">-crop</a> operation 'misses' the image proper. </p>
7722
7723
7724<div style="margin: auto;">
7725 <h3 class="magick-header"><a id="type"></a>-type <var>type</var></h3>
7726</div>
7727
7728<p class="magick-description">the image type.</p> <p>Choose from: <code>Bilevel</code>,
7729<code>Grayscale</code>, <code>GrayscaleMatte</code>, <code>Palette</code>,
7730<code>PaletteMatte</code>, <code>TrueColor</code>, <code>TrueColorMatte</code>,
7731<code>ColorSeparation</code>, or <code>ColorSeparationMatte</code>.</p>
7732
7733<p>Normally, when a format supports different subformats such as grayscale and
Cristy594d2772015-11-15 10:47:42 -05007734truecolor, the encoder will try to choose an efficient subformat. The <a
7735href="command-line-options.html#type">-type</a> option can be used to override this behavior. For
Cristy882d9f42015-10-29 16:48:39 -04007736example, to prevent a JPEG from being written in grayscale format even though
7737only gray pixels are present, use.</p>
7738
7739<pre>
7740convert bird.png -type TrueColor bird.jpg
7741</pre>
7742
7743<p>Similarly, use <a href="command-line-options.html#type">-type TrueColorMatte</a> to force the
7744encoder to write an alpha channel even though the image is opaque, if the
7745output format supports transparency.</p>
7746
7747<p>Use <a href="command-line-options.html#type">-type optimize</a> to ensure the image is written in the smallest possible file size.</p>
7748
7749<div style="margin: auto;">
7750 <h3 class="magick-header"><a id="undercolor"></a>-undercolor <var>color</var></h3>
7751</div>
7752
7753<p class="magick-description">set the color of the annotation bounding box.</p>
7754
7755<p>The color is specified using the format described under the <a href="command-line-options.html#fill">-fill</a> option.</p>
7756
7757<p>See <a href="command-line-options.html#draw">-draw</a> for further details.</p>
7758
7759
7760<div style="margin: auto;">
7761 <h3 class="magick-header"><a id="update"></a>-update <var>seconds</var></h3>
7762</div>
7763
7764<p class="magick-description">detect when image file is modified and redisplay.</p>
7765
7766<p>Suppose that while you are displaying an image the file that is currently
7767displayed is over-written. <code>display</code> will automagically detect that
7768the input file has been changed and update the displayed image
7769accordingly.</p>
7770
7771
7772<div style="margin: auto;">
7773 <h3 class="magick-header"><a id="unique-colors"></a>-unique-colors</h3>
7774</div>
7775
7776<p class="magick-description">discard all but one of any pixel color.</p>
7777
7778
7779<div style="margin: auto;">
7780 <h3 class="magick-header"><a id="units"></a>-units <var>type</var></h3>
7781</div>
7782
7783<p class="magick-description">the units of image resolution.</p>
7784
7785<p>Choose from: <code>Undefined</code>, <code>PixelsPerInch</code>, or
7786<code>PixelsPerCentimeter</code>. This option is normally used in conjunction
7787with the <a href="command-line-options.html#density">-density</a> option.</p>
7788
7789
7790<div style="margin: auto;">
Cristy594d2772015-11-15 10:47:42 -05007791 <h3 class="magick-header"><a id="unsharp"></a>-unsharp <var>radius</var><br />-unsharp <var>radius</var>x<var>sigma</var>{<var>+gain</var>}{<var>+threshold</var>}</h3>
Cristy882d9f42015-10-29 16:48:39 -04007792</div>
7793
7794<p class="magick-description">sharpen the image with an unsharp mask operator.</p>
7795
7796<p>The <a href="command-line-options.html#unsharp">-unsharp</a> option sharpens an image. The image is
7797convolved with a Gaussian operator of the given radius and standard deviation
7798(sigma). For reasonable results, radius should be larger than sigma. Use
7799a radius of 0 to have the method select a suitable radius.</p>
7800
7801<p>The parameters are:</p>
7802
7803<dl class="dl-horizontal">
7804<dt>radius</dt>
7805<dd>The radius of the Gaussian, in pixels, not counting the center pixel (default 0).</dd>
7806<dt>sigma</dt>
7807<dd>The standard deviation of the Gaussian, in pixels (default 1.0).</dd>
7808<dt>gain</dt>
7809<dd>The fraction of the difference between the original and the blur image that is added back into the original (default 1.0).</dd>
7810<dt>threshold</dt>
7811<dd>The threshold, as a fraction of <var>QuantumRange</var>, needed to apply the difference amount (default 0.05).</dd>
7812</dl>
7813
7814<div style="margin: auto;">
7815 <h3 class="magick-header"><a id="verbose"></a>-verbose</h3>
7816</div>
7817
7818<p class="magick-description">print detailed information about the image when this option precedes the <a href="command-line-options.html#identify">-identify</a> option or <code>info:</code>.</p>
7819
7820
7821<div style="margin: auto;">
7822 <h3 class="magick-header"><a id="version"></a>-version</h3>
7823</div>
7824
7825<p class="magick-description">print ImageMagick version string and exit.</p>
7826
7827
7828<div style="margin: auto;">
7829 <h3 class="magick-header"><a id="view"></a>-view <var>string</var></h3>
7830</div>
7831
7832<p class="magick-description">FlashPix viewing parameters.</p>
7833
7834
7835<div style="margin: auto;">
7836 <h3 class="magick-header"><a id="vignette"></a>-vignette <var>radius</var>{x<var>sigma</var>}{<var>+-</var>}<var>x</var>{<var>+-</var>}<var>y</var>{<var>%</var>}</h3>
7837</div>
7838
7839<p class="magick-description">soften the edges of the image in vignette style.</p>
7840
7841<p>The vignette effect rolloff is controlled by radiusxsigma. For nominal rolloff, this would be set to 0xsigma. A value of 0x0 will produce a circle/ellipse with no rolloff. The arguments x and y control the size of the circle. Larger values decrease the radii and smaller values increase the radii. Values of +0+0 will generate a circle/ellipse the same size as the image. The default values for x and y are 10% of the corresponding image dimension. Thus, the radii will be decreased by 10%, i.e., the diameters of the circle/ellipse will be 80% of the corresponding image dimension.</p>
7842
7843<div style="margin: auto;">
7844 <h3 class="magick-header"><a id="virtual-pixel"></a>-virtual-pixel <var>method</var></h3>
7845</div>
7846
7847<p class="magick-description">Specify contents of <var>virtual pixels</var>.</p>
7848
7849<p>This option defines what color source should be used if and when a color
7850lookup completely 'misses' the source image. The color(s) that appear to
7851surround the source image. Generally this color is derived from the source
7852image, but could also be set to a specify background color. </p>
7853
7854<p>Choose from these methods:</p>
7855
7856<dl class="dl-horizontal">
7857<dt>background</dt><dd>the area surrounding the image is the background color</dd>
7858<dt>black</dt><dd>the area surrounding the image is black</dd>
7859<dt>checker-tile</dt><dd>alternate squares with image and background color</dd>
7860<dt>dither</dt><dd>non-random 32x32 dithered pattern</dd>
7861<dt>edge</dt><dd>extend the edge pixel toward infinity</dd>
7862<dt>gray</dt><dd>the area surrounding the image is gray</dd>
7863<dt>horizontal-tile</dt><dd>horizontally tile the image, background color above/below</dd>
7864<dt>horizontal-tile-edge</dt><dd>horizontally tile the image and replicate the side edge pixels</dd>
7865<dt>mirror</dt><dd>mirror tile the image</dd>
7866<dt>random</dt><dd>choose a random pixel from the image</dd>
7867<dt>tile</dt><dd>tile the image (default)</dd>
7868<dt>transparent</dt><dd>the area surrounding the image is transparent blackness</dd>
7869<dt>vertical-tile</dt><dd>vertically tile the image, sides are background color</dd>
7870<dt>vertical-tile-edge</dt><dd>vertically tile the image and replicate the side edge pixels</dd>
7871<dt>white</dt><dd>the area surrounding the image is white</dd>
7872</dl>
7873
7874<p>The default value is "edge".</p>
7875
Cristy594d2772015-11-15 10:47:42 -05007876<p>This most important for distortion operators such as <a href="command-line-options.html#distort"
7877>-distort</a>, <a href="command-line-options.html#implode" >-implode</a>, and <a href="command-line-options.html#fx" >-fx</a>.
Cristy882d9f42015-10-29 16:48:39 -04007878However it also effects operations that may access pixels just outside the
Cristy594d2772015-11-15 10:47:42 -05007879image proper, such as <a href="command-line-options.html#convolve">-convolve</a>, <a
7880href="command-line-options.html#blur">-blur</a>, and <a href="command-line-options.html#sharpen">-sharpen</a>. </p>
Cristy882d9f42015-10-29 16:48:39 -04007881
Cristy594d2772015-11-15 10:47:42 -05007882<p>To print a complete list of virtual pixel types, use the <a
7883href="command-line-options.html#list">-list virtual-pixel</a> option.</p>
Cristy882d9f42015-10-29 16:48:39 -04007884
7885
7886<div style="margin: auto;">
7887 <h3 class="magick-header"><a id="visual"></a>-visual <var>type</var></h3>
7888</div>
7889
7890<p class="magick-description">Animate images using this X visual type.", 'animate', 'display'</p>
7891
7892<p>Choose from these visual classes:</p>
7893
7894<pre>
7895StaticGray TrueColor
7896GrayScale DirectColor
7897StaticColor default
7898PseudoColor visual id
7899</pre>
7900
7901<p>The X server must support the visual you choose, otherwise an error occurs.
7902If a visual is not specified, the visual class that can display the most
7903simultaneous colors on the default screen is chosen.</p>
7904
7905
7906<div style="margin: auto;">
7907 <h3 class="magick-header"><a id="watermark"></a>-watermark <var>brightness</var>x<var>saturation</var></h3>
7908</div>
7909
7910<p class="magick-description">Watermark an image using the given percentages of brightness and saturation.</p>
7911
7912<p>Take a grayscale image (with alpha mask) and modify the destination image's
7913brightness according to watermark image's grayscale value and the
7914<var>brightness</var> percentage. The destinations color saturation
7915attribute is just direct modified by the <var>saturation</var>
7916percentage, which defaults to 100 percent (no color change). </p>
7917
7918
7919<div style="margin: auto;">
Cristy594d2772015-11-15 10:47:42 -05007920 <h3 class="magick-header"><a id="wave"></a>-wave <var>amplitude</var><br />-wave <var>amplitude</var>x<var>wavelength</var></h3>
Cristy882d9f42015-10-29 16:48:39 -04007921</div>
7922
7923<p class="magick-description">Shear the columns of an image into a sine wave.</p>
7924
Cristye09ed312016-03-06 08:07:39 -05007925<div style="margin: auto;">
7926 <h3 class="magick-header"><a id="wavelet-denoise"></a>-wavelet-denoise <var>threshold</var><br />-wavelet-denoise <var>threshold</var>x<var>softness</var></h3>
7927</div>
7928
7929<p class="magick-description">removes noise from the image using a wavelet transform. The threshold is the value below which everything is considered noise and ranges from 0.0 (none) to QuantumRange or use percent (e.g. 5%). Softness attenuates the threshold and typically ranges from 0.0 (none) to 1.0. The higher the value the more noise that remains in the image.</p>
Cristy882d9f42015-10-29 16:48:39 -04007930
7931<div style="margin: auto;">
7932 <h3 class="magick-header"><a id="weight"></a>-weight <var>fontWeight</var></h3>
7933</div>
7934
7935<p class="magick-description">Set a font weight for text.</p>
7936
7937<p>This setting suggests a font weight that ImageMagick should try to apply to
7938the currently selected font family. Use a positive integer for
7939<var>fontWeight</var> or select from the following.</p>
7940
7941<dl class="dl-horizontal">
7942<dt>Thin </dt>
7943<dd>Same as <var>fontWeight</var> = 100.</dd>
7944<dt>ExtraLight </dt>
7945<dd>Same as <var>fontWeight</var> = 200.</dd>
7946<dt>Light </dt>
7947<dd>Same as <var>fontWeight</var> = 300.</dd>
7948<dt>Normal </dt>
7949<dd>Same as <var>fontWeight</var> = 400.</dd>
7950<dt>Medium </dt>
7951<dd>Same as <var>fontWeight</var> = 500.</dd>
7952<dt>DemiBold </dt>
7953<dd>Same as <var>fontWeight</var> = 600.</dd>
7954<dt>Bold </dt>
7955<dd>Same as <var>fontWeight</var> = 700.</dd>
7956<dt>ExtraBold </dt>
7957<dd>Same as <var>fontWeight</var> = 800.</dd>
7958<dt>Heavy </dt>
7959<dd>Same as <var>fontWeight</var> = 900.</dd>
7960</dl>
Cristy594d2772015-11-15 10:47:42 -05007961<br/>
Cristy882d9f42015-10-29 16:48:39 -04007962
7963<p>To print a complete list of weight types, use <a href="command-line-options.html#list">-list weight</a>.</p>
7964
Cristy594d2772015-11-15 10:47:42 -05007965<p>For other settings that affect fonts, see the options <a
7966href="command-line-options.html#font">-font</a>, <a href="command-line-options.html#family">-family</a>, <a
7967href="command-line-options.html#stretch">-stretch</a>, and <a href="command-line-options.html#style">-style</a>. </p>
Cristy882d9f42015-10-29 16:48:39 -04007968
7969<div style="margin: auto;">
7970 <h3 class="magick-header"><a id="white-point"></a>-white-point <var>x,y</var></h3>
7971</div>
7972
7973<p class="magick-description">chromaticity white point.</p>
7974
7975<div style="margin: auto;">
7976 <h3 class="magick-header"><a id="white-threshold"></a>-white-threshold <var>value</var>{<var>%</var>}</h3>
7977</div>
7978
7979<p class="magick-description">Force to white all pixels above the threshold while leaving all pixels at or below the threshold unchanged.</p>
7980
7981<p> The threshold value can be given as a percentage or as an absolute integer
7982value within [0, <var>QuantumRange</var>] corresponding to the
Cristy594d2772015-11-15 10:47:42 -05007983desired <a href="command-line-options.html#channel">&#x2011;channel</a> value. See <a href="command-line-options.html#threshold">&#x2011;threshold</a>for more details on thresholds and resulting values. </p>
Cristy882d9f42015-10-29 16:48:39 -04007984
7985<div style="margin: auto;">
7986 <h3 class="magick-header"><a id="window"></a>-window <var>id</var></h3>
7987</div>
7988
7989<p class="magick-description">Make the image the background of a window.", 'animate', 'display'</p>
7990
7991<p><var>id</var> can be a window id or name. Specify <code>root</code>
7992to select X's root window as the target window.</p>
7993
7994<p>By default the image is tiled onto the background of the target window. If
7995<code>backdrop</code> or <a href="command-line-options.html#geometry">-resize</a> are specified, the
7996image is surrounded by the background color. Refer to <code>X RESOURCES</code>
7997for details.</p>
7998
7999<p>The image will not display on the root window if the image has more unique
Cristy594d2772015-11-15 10:47:42 -05008000colors than the target window colormap allows. Use <a
8001href="command-line-options.html#colors">-colors</a> to reduce the number of colors.</p>
Cristy882d9f42015-10-29 16:48:39 -04008002
8003<div style="margin: auto;">
8004 <h3 class="magick-header"><a id="window-group"></a>-window-group</h3>
8005</div>
8006
8007<p class="magick-description">specify the window group.</p>
8008
8009<div style="margin: auto;">
8010 <h3 class="magick-header"><a id="write"></a>-write <var>filename</var></h3>
8011</div>
8012
8013<p class="magick-description">write an image sequence.</p>
8014
8015<p>The image sequence preceding the <a href="command-line-options.html#write">-write</a> <var>filename</var> option is written out, and processing continues with the same image in its current state if there are additional options. To restore the image to its original state after writing it, use the <a href="command-line-options.html#write">+write</a> <var>filename</var> option.</p>
8016
8017<p>Use <a href="command-line-options.html#compress">-compress</a> to specify the type of image compression.</p>
Cristye0779712016-07-30 17:25:22 -04008018
8019<div style="margin: auto;">
8020 <h3 class="magick-header"><a id="write-mask"></a>-write-mask <var>filename</var></h3>
8021</div>
8022
8023<p class="magick-description">Prevent updates to image pixels specified by the mask.</p>
8024
8025<p>This the same as using a mask used for composite masking operations, with
8026grayscale values causing blended updates of the image the mask is attached to.
8027</p>
8028
8029<p>Use <a href="command-line-options.html#write-mask">+write-mask</a> to remove the mask from images.</p>
8030
8031<p>Also see <a href="command-line-options.html#clip-mask">-clip-mask</a> which work in the same way,
8032but with strict boolean masking. </p>
Cristy882d9f42015-10-29 16:48:39 -04008033</div>
8034</div>
8035
8036
Cristye93be682015-11-26 09:07:51 -05008037
Cristy882d9f42015-10-29 16:48:39 -04008038 <footer class="magick-footer">
cristy29f2c972015-07-28 13:37:46 +00008039 <p><a href="support.html">Donate</a>
8040 <a href="sitemap.html">Sitemap</a>
cristyd2432012015-05-04 23:15:15 +00008041 <a href="links.html">Related</a>
Cristye0779712016-07-30 17:25:22 -04008042 <a href="security-policy.html">Security</a>
cristy29f2c972015-07-28 13:37:46 +00008043 <a href="architecture.html">Architecture</a>
cristyd2432012015-05-04 23:15:15 +00008044</p>
8045 <p><a href="command-line-options.html#">Back to top</a>
cristyea2793e2015-05-31 16:52:26 +00008046 <a href="http://pgp.mit.edu:11371/pks/lookup?op=get&amp;search=0x89AB63D48277377A">Public Key</a>
Cristy6549abb2016-11-10 08:25:55 -05008047 <a href="https://www.imagemagick.org/script/contact.php">Contact Us</a></p>
Cristyfe36f992016-12-29 20:24:13 -05008048 <p><small>© 1999-2017 ImageMagick Studio LLC</small></p>
cristyd2432012015-05-04 23:15:15 +00008049 </footer>
8050</div><!-- /.container -->
8051
Cristyb7f455a2017-03-03 19:30:34 -05008052 <script src="https://localhost/ajax/libs/jquery/1.12.4/jquery.min.js"></script>
Cristy1f1f3a02016-06-01 07:25:42 -04008053 <script src="../js/magick.html"></script>
cristyd2432012015-05-04 23:15:15 +00008054</div>
cristyad41c0c2012-10-31 00:49:28 +00008055</body>
cristy5a367e42015-05-05 12:39:18 +00008056</html>
Cristyb7f455a2017-03-03 19:30:34 -05008057<!-- Magick Cache 3rd March 2017 19:25 -->