blob: 5bdf788e6e4b960d0c915bc3650c81db530bc5d6 [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>
Cristy594d2772015-11-15 10:47:42 -05008 <meta name="google-site-verification" content="_bMOCDpkx9ZAzBwb2kF3PRHbfUUdFj2uO8Jd1AXArz4" />
cristy29f2c972015-07-28 13:37:46 +00009 <title>ImageMagick: Command-line Options</title>
Cristy594d2772015-11-15 10:47:42 -050010 <meta http-equiv="content-type" content="text/html; charset=utf-8"/>
11 <meta name="application-name" content="ImageMagick"/>
12 <meta name="description" content="ImageMagick® is a software suite to create, edit, compose, or convert bitmap images. It can read and write images in a variety of formats (over 200) including PNG, JPEG, JPEG-2000, GIF, WebP, Postscript, PDF, and SVG. Use ImageMagick to resize, flip, mirror, rotate, distort, shear and transform images, adjust image colors, apply various special effects, or draw text, lines, polygons, ellipses and Bézier curves."/>
13 <meta name="application-url" content="http://www.imagemagick.org"/>
14 <meta name="generator" content="PHP"/>
15 <meta name="keywords" content="command-line, options, ImageMagick, PerlMagick, image processing, image, photo, software, Magick++, OpenMP, convert"/>
16 <meta name="rating" content="GENERAL"/>
17 <meta name="robots" content="INDEX, FOLLOW"/>
18 <meta name="generator" content="ImageMagick Studio LLC"/>
19 <meta name="author" content="ImageMagick Studio LLC"/>
20 <meta name="revisit-after" content="2 DAYS"/>
21 <meta name="resource-type" content="document"/>
Cristyce4a3552015-12-14 13:53:35 -050022 <meta name="copyright" content="Copyright (c) 1999-2015 ImageMagick Studio LLC"/>
Cristy594d2772015-11-15 10:47:42 -050023 <meta name="distribution" content="Global"/>
24 <meta name="magick-serial" content="P131-S030410-R485315270133-P82224-A6668-G1245-1"/>
25 <link rel="icon" href="../images/wand.png"/>
26 <link rel="shortcut icon" href="../images/wand.ico"/>
Cristyce4a3552015-12-14 13:53:35 -050027 <link rel="stylesheet" href="css/magick.css"/>
cristyad41c0c2012-10-31 00:49:28 +000028</head>
cristyd2432012015-05-04 23:15:15 +000029<body>
cristyad41c0c2012-10-31 00:49:28 +000030<div class="main">
cristyd2432012015-05-04 23:15:15 +000031<div class="magick-masthead">
32 <div class="container">
Cristy594d2772015-11-15 10:47:42 -050033 <script async="async" src="http://localhost/pagead/js/adsbygoogle.js"></script> <ins class="adsbygoogle"
34 style="display:block"
35 data-ad-client="ca-pub-3129977114552745"
36 data-ad-slot="6345125851"
37 data-ad-format="auto"></ins>
cristy29f2c972015-07-28 13:37:46 +000038 <script>
Cristy542697a2015-10-12 20:10:32 -040039 (adsbygoogle = window.adsbygoogle || []).push({});
cristyd2432012015-05-04 23:15:15 +000040 </script>
cristyd2432012015-05-04 23:15:15 +000041 <nav class="magick-nav">
cristy44443b92015-05-05 00:06:07 +000042 <a class="magick-nav-item " href="../index.html">Home</a>
cristyea2793e2015-05-31 16:52:26 +000043 <a class="magick-nav-item " href="binary-releases.html">Download</a>
cristyd2432012015-05-04 23:15:15 +000044 <a class="magick-nav-item " href="command-line-tools.html">Tools</a>
Cristye93be682015-11-26 09:07:51 -050045 <a class="magick-nav-item " href="command-line-processing.html">Command-line</a>
cristyea2793e2015-05-31 16:52:26 +000046 <a class="magick-nav-item " href="resources.html">Resources</a>
47 <a class="magick-nav-item " href="api.html">Develop</a>
Cristy1f1f3a02016-06-01 07:25:42 -040048 <a class="magick-nav-item " href="http://www.imagemagick.org/script/search.php">Search</a>
Cristye09ed312016-03-06 08:07:39 -050049 <a class="magick-nav-item pull-right" href="https://www.imagemagick.org/discourse-server/">Community</a>
cristyd2432012015-05-04 23:15:15 +000050 </nav>
51 </div>
52</div>
53<div class="container">
Cristy882d9f42015-10-29 16:48:39 -040054<div class="magick-header">
Cristyf650f4f2016-04-01 10:53:07 -040055<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#alpha-color">&#x2011;alpha&#x2011;color</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#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#mask">&#x2011;mask</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#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> </p>
Cristy882d9f42015-10-29 16:48:39 -040056
57<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>
58
59<div style="margin: auto;">
60 <h3 class="magick-header"><a id="adaptive-blur"></a>-adaptive-blur <var>radius</var>[x<var>sigma</var>]</h3>
61</div>
62
63<p class="magick-description">Adaptively blur pixels, with decreasing effect near edges.</p>
64
65<p>A Gaussian operator of the given radius and standard deviation (<var>sigma</var>) is used. If <var>sigma</var> is not given it
66defaults to 1.</p>
67
68<div style="margin: auto;">
69 <h3 class="magick-header"><a id="adaptive-resize"></a>-adaptive-resize <var>geometry</var></h3>
70</div>
71
72<p class="magick-description">Resize the image using data-dependent triangulation.</p>
73
74<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 -050075option defaults to data-dependent triangulation. Use the <a
76href="command-line-options.html#filter">-filter</a> to choose a different resampling algorithm.
77Offsets, if present in the geometry string, are ignored, and the <a
78href="command-line-options.html#gravity">-gravity</a> option has no effect.</p>
Cristy882d9f42015-10-29 16:48:39 -040079
80<div style="margin: auto;">
81 <h3 class="magick-header"><a id="adaptive-sharpen"></a>-adaptive-sharpen <var>radius</var>[x<var>sigma</var>]</h3>
82</div>
83
84<p class="magick-description">Adaptively sharpen pixels, with increasing effect near edges.</p>
85
86<p>A Gaussian operator of the given radius and standard deviation
87(<var>sigma</var>) is used. If <var>sigma</var> is not given it
88defaults to 1.</p>
89
90<div style="margin: auto;">
91 <h3 class="magick-header"><a id="adjoin"></a>-adjoin</h3>
92</div>
93
94<p class="magick-description">Join images into a single multi-image file.</p>
95
96<p>This option is enabled by default. An attempt is made to save all images of
97an image sequence into the given output file. However, some formats, such as
98JPEG and PNG, do not support more than one image per file, and in that case
99ImageMagick is forced to write each image as a separate file. As such, if
100more than one image needs to be written, the filename given is modified by
101adding a <a href="command-line-options.html#scene">-scene</a> number before the suffix, in order to
102make distinct names for each image. </p>
103
104<p>Use <a href="command-line-options.html#adjoin">+adjoin</a> to force each image to be written to
105separate files, whether or not the file format allows multiple images per file
106(for example, GIF, MIFF, and TIFF). </p>
107
108<p>Including a C-style integer format string in the output filename will
109automagically enable <a href="command-line-options.html#adjoin">+adjoin</a> and are used to specify
110where the <a href="command-line-options.html#scene">-scene</a> number is placed in the filenames. These
111strings, such as '<code>%d</code>' or '<code>%03d</code>', are familiar to those
112who have used the standard <code>printf()</code>' C-library function. As an
113example, the command</p>
114
115<pre>
116convert logo: rose: -morph 15 my%02dmorph.jpg
117</pre>
118
119<p>will create a sequence of 17 images (the two given plus 15 more created by
120<a href="command-line-options.html#morph">-morph</a>), named: my00morph.jpg, my01morph.jpg,
121my02morph.jpg, ..., my16morph.jpg. </p>
122
123<p>In summary, ImageMagick tries to write all images to one file, but will
124save to multiple files, if any of the following conditions exist...</p>
125<ol>
126<li>the output image's file format does not allow multi-image files,</li>
127<li>the <a href="command-line-options.html#adjoin">+adjoin</a> option is given, or</li>
128<li>a printf() integer format string (eg: "%d") is present in the output
129 filename.</li>
130</ol>
131
132
133<div style="margin: auto;">
134 <h3 class="magick-header"><a id="affine"></a>-affine
135 <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>
136</div>
137
138<p class="magick-description">Set the drawing transformation matrix for combined rotating and scaling.</p>
139
Cristy594d2772015-11-15 10:47:42 -0500140<p>This option sets a transformation matrix, for use by subsequent <a
141href="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 -0400142
143<p>The matrix entries are entered as comma-separated numeric values either in
144quotes or without spaces. </p>
145
146<p>Internally, the transformation matrix has 3x3 elements, but three of them
147are omitted from the input because they are constant. The new (transformed)
148coordinates (<var>x'</var>, <var>y'</var>) of a pixel at
149position (<var>x</var>, <var>y</var>) in the original
150image are calculated using the following matrix equation.</p>
151
Cristy594d2772015-11-15 10:47:42 -0500152<p class="text-center"><img class="img-thumbnail" alt="affine transformation" src="../images/affine.png"/> </p>
Cristy882d9f42015-10-29 16:48:39 -0400153
154<p> The size of the resulting image is that of the smallest rectangle that
155contains the transformed source image. The parameters
156<var>t<sub>x</sub></var> and <var>t<sub>y</sub></var>
157subsequently shift the image pixels so that those that are moved out of the
158image area are cut off.</p>
159
160<p>The transformation matrix complies with the left-handed pixel coordinate
161system: positive <var>x</var> and <var>y</var> directions
162are rightward and downward, resp.; positive rotation is clockwise.</p>
163
164<p> If the translation coefficients <var>t<sub>x</sub></var> and
165<var>t<sub>y</sub></var> are omitted they default to 0,0. Therefore,
166four parameters suffice for rotation and scaling without translation.</p>
167
168<p>Scaling by the factors <var>s<sub>x</sub></var> and
169<var>s<sub>y</sub></var> in the <var>x</var> and <var>y</var> directions,
170respectively, is accomplished with the following.</p>
171
Cristy594d2772015-11-15 10:47:42 -0500172<p>See <a href="command-line-options.html#transform">-transform</a>, and the <a
173href="command-line-options.html#distort">-distort</a> method '<code>Affineprojection</code> for more
Cristy882d9f42015-10-29 16:48:39 -0400174information </p>
175
176
177<pre>
178-affine <var>s<sub>x</sub></var>,0,0,<var>s<sub>y</sub></var>
179</pre>
180
181<p>Translation by a displacement (<var>t<sub>x</sub></var>, <var>t<sub>y</sub></var>) is accomplished like so:</p>
182
183<pre>
184-affine 1,0,0,1,<var>t<sub>x</sub></var>,<var>t<sub>y</sub></var>
185</pre>
186
187<p>Rotate clockwise about the origin (the upper left-hand corner) by an angle
188<var>a</var> by letting <var>c</var> = cos(<var>a</var>), <var>s</var>
189= sin(<var>a</var>), and using the following.</p>
190
191<pre>
192-affine <var>c</var>,<var>s</var>,-<var>s</var>,<var>c</var>
193</pre>
194
Cristy594d2772015-11-15 10:47:42 -0500195<p>The cumulative effect of a sequence of <a href="command-line-options.html#affine" >-affine</a>
196transformations can be accomplished by instead by a single <a href="command-line-options.html#affine"
197>-affine</a> operation using the matrix equal to the product of the matrices
Cristy882d9f42015-10-29 16:48:39 -0400198of the individual transformations.</p>
199
200<p>An attempt is made to detect near-singular transformation matrices. If the
201matrix determinant has a sufficiently small absolute value it is rejected.</p>
202
203<div style="margin: auto;">
204 <h3 class="magick-header"><a id="alpha"></a>-alpha <var>type</var></h3>
205</div>
206
207<p class="magick-description">Gives control of the alpha/matte channel of an image.</p>
208
209<p>Used to set a flag on an image indicating whether or not to use existing alpha
210channel 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>
211
212<dl class="dl-horizontal">
213 <dt>Activate</dt>
214 <dd>
215 Enable the image's transparency channel. Note normally Set
216 should be used instead of this, unless you specifically need to
217 preserve existing (but specifically turned Off) transparency
218 channel. </dd>
219
220 <dt>Associate</dt>
221 <dd>
222 associate the alpha channel with the image.</dd>
223
224 <dt>Deactivate</dt>
225 <dd>
226 Disables the image's transparency channel. Does not delete or change the
227 existing data, just turns off the use of that data.</dd>
228
229 <dt>Disassociate</dt>
230 <dd>
231 disassociate the alpha channel from the image.</dd>
232
233 <dt>Set</dt>
234 <dd>
235 Activates the alpha/matte channel. If it was previously turned off
236 then it also resets the channel to opaque. If the image already had
237 the alpha channel turned on, it will have no effect.</dd>
238
239 <dt>Opaque</dt>
240 <dd>
241 Enables the alpha/matte channel and forces it to be fully opaque.
242 </dd>
243
244 <dt>Transparent</dt>
245 <dd>
246 Activates the alpha/matte channel and forces it to be fully
247 transparent. This effectively creates a fully transparent image the
248 same size as the original and with all its original RGB data still
249 intact, but fully transparent. </dd>
250
251 <dt>Extract</dt>
252 <dd>
253 Copies the alpha channel values into all the color channels and turns
254 'Off' the the image's transparency, so as to generate
Cristy769d8892016-01-19 18:11:14 -0500255 a grayscale mask of the image's shape. The alpha channel data is left
Cristy882d9f42015-10-29 16:48:39 -0400256 intact just deactivated. This is the inverse of 'Copy'.
257 </dd>
258
259 <dt>Copy</dt>
260 <dd>
261 Turns 'On' the alpha/matte channel, then copies the
Cristy769d8892016-01-19 18:11:14 -0500262 grayscale intensity of the image, into the alpha channel, converting
263 a grayscale mask into a transparent shaped mask ready to be colored
Cristy882d9f42015-10-29 16:48:39 -0400264 appropriately. The color channels are not modified. </dd>
265
266 <dt>Shape</dt>
267 <dd>
268 As per 'Copy' but also colors the resulting shape mask with
269 the current background color. That is the RGB color channels is
270 replaced, with appropriate alpha shape.
271 </dd>
272
273 <dt>Remove</dt>
274 <dd>
275 Composite the image over the background color.
276 </dd>
277
278 <dt>Background</dt>
279 <dd>
280 Set any fully-transparent pixel to the background color, while leaving
281 it fully-transparent. This can make some image file formats, such as
282 PNG, smaller as the RGB values of transparent pixels are more uniform,
283 and thus can compress better.
284 </dd>
285</dl>
286
287<p>Note that while the obsolete <code>+matte</code> operation was the
Cristy594d2772015-11-15 10:47:42 -0500288same as "<code><a href="command-line-options.html#alpha" >-alpha</a> Off</code>", the <code>
289>-matte</code> operation was the same as "<code><a href="command-line-options.html#alpha" >-alpha</a>
290Set</code>" and not "<code><a href="command-line-options.html#alpha" >-alpha</a> On</code>". </p>
Cristy882d9f42015-10-29 16:48:39 -0400291
Cristyf650f4f2016-04-01 10:53:07 -0400292<div style="margin: auto;">
293 <h3 class="magick-header"><a id="alpha-color"></a>-alpha-color <var>color</var></h3>
294</div>
295
296<p class="magick-description">Specify the color to be used with the <a href="command-line-options.html#frame">-frame</a> option.</p>
297
298<p>The color is specified using the format described under the <a href="command-line-options.html#fill">-fill</a> option.</p>
299
300<p>The default matte color is <code>#BDBDBD</code>, <span
301style="background-color: #bdbdbd;">this shade of gray</span>.</p>
302
303<p>This is an IMv7 option, use <a href="command-line-options.html#mattecolor">mattecolor</a> with IMv6.</p>
304
Cristy882d9f42015-10-29 16:48:39 -0400305
306<div style="margin: auto;">
307 <h3 class="magick-header"><a id="annotate"></a>
Cristy594d2772015-11-15 10:47:42 -0500308 -annotate <var>degrees</var> <var>text</var><br />
309 -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 -0400310</div>
311
312<p class="magick-description">Annotate an image with text</p>
313
314<p>This is a convenience for annotating an image with text. For more precise
315control over text annotations, use <a href="command-line-options.html#draw">-draw</a>.</p>
316
317
318<p>The values <var>Xdegrees</var> and <var>Ydegrees</var>
Cristy594d2772015-11-15 10:47:42 -0500319control 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 -0400320
321<p>Using <a href="command-line-options.html#annotate">-annotate</a> <var>degrees</var>
322or <a href="command-line-options.html#annotate">-annotate</a> <var>degrees</var>x<var>degrees</var> produces an unsheared rotation of the text. The
323direction of the rotation is positive, which means a clockwise rotation if <var>degrees</var> is positive. (This conforms to the usual mathematical
324convention once it is realized that the positive <var>y</var>–direction is
325conventionally considered to be <var>downward</var> for images.)</p>
326
327<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
328equation.</p>
329
Cristy594d2772015-11-15 10:47:42 -0500330<p class="text-center"><img class="img-thumbnail" alt="annotate transformation" src="../images/annotate.png"/></p>
Cristy882d9f42015-10-29 16:48:39 -0400331
332<p>If <var>t<sub>x</sub></var> and <var>t<sub>y</sub></var> are omitted, they default to 0. This makes the
333bottom-left of the text becomes the upper-left corner of the image, which is
Cristy594d2772015-11-15 10:47:42 -0500334probably undesirable. Adding a <a href="command-line-options.html#gravity" >-gravity</a> option in this
Cristy882d9f42015-10-29 16:48:39 -0400335case leads to nice results.</p>
336
337<p>Text is any UTF-8 encoded character sequence. If <var>text</var>
338is of the form '@mytext.txt', the text is read from the file
339<code>mytext.txt</code>. Text in a file is taken literally; no embedded
340formatting characters are recognized.</p>
341
342<div style="margin: auto;">
343 <h3 class="magick-header"><a id="antialias"></a>-antialias</h3>
344</div>
345
346<p class="magick-description">Enable/Disable of the rendering of anti-aliasing pixels when drawing fonts and lines.</p>
347
348<p>By default, objects (e.g. text, lines, polygons, etc.) are antialiased when
349drawn. Use <a href="command-line-options.html#antialias">+antialias</a> to disable the addition of
350antialiasing edge pixels. This will then reduce the number of colors added to
351an image to just the colors being directly drawn. That is, no mixed colors
352are added when drawing such objects. </p>
353
354<div style="margin: auto;">
355 <h3 class="magick-header"><a id="append"></a>-append</h3>
356</div>
357
358<p class="magick-description">Join current images vertically or horizontally.</p>
359
360<p>This option creates a single longer image, by joining all the current
361images in sequence top-to-bottom. Use <a href="command-line-options.html#append">+append</a> to
362stack images left-to-right. </p>
363
364<p>If they are not of the same width, narrower images are padded with the
365current <a href="command-line-options.html#background">-background</a> color setting, and their
Cristy594d2772015-11-15 10:47:42 -0500366position relative to each other can be controlled by the current <a
367href="command-line-options.html#gravity">-gravity</a> setting. </p>
Cristy882d9f42015-10-29 16:48:39 -0400368
369
370<div style="margin: auto;">
371 <h3 class="magick-header"><a id="attenuate"></a>-attenuate <var>value</var></h3>
372</div>
373
374<p class="magick-description">Lessen (or intensify) when adding noise to an image.</p>
375
376<p>If unset the value is equivalent to 1.0, or a maximum noise addition</p>
377
378<div style="margin: auto;">
379 <h3 class="magick-header"><a id="authenticate"></a>-authenticate <var>password</var></h3>
380</div>
381
382<p class="magick-description">Decrypt a PDF with a password.</p>
383
384<p>Use this option to supply a <var>password</var> for decrypting
385a PDF that has been encrypted using Microsoft Crypto API (MSC API). The
386encrypting using the MSC API is not supported.</p>
387
388<p>For a different encryption method, see <a href="command-line-options.html#encipher">-encipher</a>
389and <a href="command-line-options.html#decipher">-decipher</a>. </p>
390
391
392<div style="margin: auto;">
393 <h3 class="magick-header"><a id="auto-gamma"></a>-auto-gamma</h3>
394</div>
395
396<p class="magick-description">Automagically adjust gamma level of image.</p>
397
Cristy594d2772015-11-15 10:47:42 -0500398<p>This calculates the mean values of an image, then applies a calculated <a
399href="command-line-options.html#gamma" >-gamma</a> adjustment so that is the mean color exists in the
Cristy882d9f42015-10-29 16:48:39 -0400400image it will get a have a value of 50%. </p>
401
402<p>This means that any solid 'gray' image becomes 50% gray. </p>
403
404<p>This works well for real-life images with little or no extreme dark and
405light areas, but tend to fail for images with large amounts of bright sky or
406dark shadows. It also does not work well for diagrams or cartoon like images.
407</p>
408
Cristy594d2772015-11-15 10:47:42 -0500409<p>It uses the <a href="command-line-options.html#channel" >-channel</a> setting, (including the
Cristy882d9f42015-10-29 16:48:39 -0400410'<var>sync</var>' flag for channel synchronization), to determine which color
Cristy594d2772015-11-15 10:47:42 -0500411values is used and modified. As the default <a href="command-line-options.html#channel"
412>-channel</a> setting is '<var>RGB,sync</var>', channels are modified
Cristy882d9f42015-10-29 16:48:39 -0400413together by the same gamma value, preserving colors. </p>
414
415
416
417<div style="margin: auto;">
418 <h3 class="magick-header"><a id="auto-level"></a>-auto-level</h3>
419</div>
420
421<p class="magick-description">Automagically adjust color levels of image.</p>
422
423<p>This is a 'perfect' image normalization operator. It finds the exact
Cristy594d2772015-11-15 10:47:42 -0500424minimum and maximum color values in the image and then applies a <a
425href="command-line-options.html#level" >-level</a> operator to stretch the values to the full range of
Cristy882d9f42015-10-29 16:48:39 -0400426values. </p>
427
428<p>The operator is not typically used for real-life images, image scans, or
429JPEG format images, as a single 'out-rider' pixel can set a bad min/max values
Cristy594d2772015-11-15 10:47:42 -0500430for the <a href="command-line-options.html#level" >-level</a> operation. On the other hand it is the
Cristy882d9f42015-10-29 16:48:39 -0400431right operator to use for color stretching gradient images being used to
432generate Color lookup tables, distortion maps, or other 'mathematically'
433defined images. </p>
434
Cristy594d2772015-11-15 10:47:42 -0500435<p>The operator is very similar to the <a href="command-line-options.html#normalize">-normalize</a>, <a
436href="command-line-options.html#contrast-stretch" >-contrast-stretch</a>, and <a href="command-line-options.html#linear-stretch"
437>-linear-stretch</a> operators, but without 'histogram binning' or 'clipping'
438problems that these operators may have. That is <a href="command-line-options.html#auto-level"
439>-auto-level</a> is the perfect or ideal version these operators. </p>
Cristy882d9f42015-10-29 16:48:39 -0400440
Cristy594d2772015-11-15 10:47:42 -0500441<p>It uses the <a href="command-line-options.html#channel" >-channel</a> setting, (including the
Cristy882d9f42015-10-29 16:48:39 -0400442special '<var>sync</var>' flag for channel synchronization), to determine
Cristy594d2772015-11-15 10:47:42 -0500443which color values are used and modified. As the default <a
444href="command-line-options.html#channel" >+channel</a> setting is '<var>RGB,sync</var>', the
Cristy882d9f42015-10-29 16:48:39 -0400445'<var>sync</var>' ensures that the color channels will are modified
446together by the same gamma value, preserving colors, and ignoring
447transparency. </p>
448
449
450<div style="margin: auto;">
451 <h3 class="magick-header"><a id="auto-orient"></a>-auto-orient</h3>
452</div>
453
454<p class="magick-description">adjusts an image so that its orientation is suitable for viewing (i.e. top-left orientation).</p>
455
456<p>This operator reads and resets the EXIF image profile setting 'Orientation'
457and then performs the appropriate 90 degree rotation on the image to orient
458the image, for correct viewing. </p>
459
460<p>This EXIF profile setting is usually set using a gravity sensor in digital
461camera, however photos taken directly downward or upward may not have an
462appropriate value. Also images that have been orientation 'corrected' without
463reseting this setting, may be 'corrected' again resulting in a incorrect
Cristy594d2772015-11-15 10:47:42 -0500464result. If the EXIF profile was previously stripped, the <a
465href="command-line-options.html#auto-orient" >-auto-orient</a> operator will do nothing. </p>
Cristy882d9f42015-10-29 16:48:39 -0400466
467
468<div style="margin: auto;">
469 <h3 class="magick-header"><a id="average"></a>-average</h3>
470</div>
471
472<p class="magick-description">Average a set of images.</p>
473
474<p>An error results if the images are not identically sized.</p>
475
476
477<div style="margin: auto;">
478 <h3 class="magick-header"><a id="backdrop"></a>-backdrop</h3>
479</div>
480
481<p class="magick-description">Display the image centered on a backdrop.</p>
482
483<p>This backdrop covers the entire workstation screen and is useful for hiding
484other X window activity while viewing the image. The color of the backdrop is
485specified as the background color. The color is specified using the format
486described under the <a href="command-line-options.html#fill">-fill</a> option.</p>
487
488<div style="margin: auto;">
489 <h3 class="magick-header"><a id="background"></a>-background <var>color</var></h3>
490</div>
491
492<p class="magick-description">Set the background color.</p>
493
Cristy594d2772015-11-15 10:47:42 -0500494<p>The color is specified using the format described under the <a
495href="command-line-options.html#fill">-fill</a> option. The default background color (if none is
Cristy882d9f42015-10-29 16:48:39 -0400496specified or found in the image) is white.</p>
497
498<div style="margin: auto;">
499 <h3 class="magick-header"><a id="bench"></a>-bench <var>iterations</var></h3>
500</div>
501
502<p class="magick-description">Measure performance.</p>
503
504<p>Repeat the entire command for the given number of <var>iterations</var> and report the user-time and elapsed time. For instance,
505consider the following command and its output. Modify the benchmark with the
506-duration to run the benchmark for a fixed number of seconds and -concurrent
507to run the benchmark in parallel (requires the OpenMP feature).</p>
508
509<pre>
Cristye09ed312016-03-06 08:07:39 -0500510-> convert logo: -resize 200% -bench 5 logo.png
511Performance[1]: 5i 1.344ips 1.000e 3.710u 0:03.720
512Performance[2]: 5i 1.634ips 0.549e 3.890u 0:03.060
513Performance[3]: 5i 2.174ips 0.618e 3.190u 0:02.300
514Performance[4]: 5i 1.678ips 0.555e 3.810u 0:02.980
Cristy882d9f42015-10-29 16:48:39 -0400515Performance[4]: 5i 0.875657ips 6.880u 0:05.710
516</pre>
517
Cristye09ed312016-03-06 08:07:39 -0500518<p>In this example, 5 iterations were completed at 2.174 iterations per
519second, using 3 threads and 3.190 seconds of the user allotted time, for
520a total elapsed time of 2.300 seconds.</p>
Cristy882d9f42015-10-29 16:48:39 -0400521
522<div style="margin: auto;">
523 <h3 class="magick-header"><a id="bias"></a>-bias <var>value</var>{<var>%</var>}</h3>
524</div>
525
526<p class="magick-description">Add bias when convolving an image.</p>
527
Cristy594d2772015-11-15 10:47:42 -0500528<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 -0400529positive and negative results are relative to the specified bias value. </p>
530
531<p>This is important for non-HDRI compilations of ImageMagick when dealing
532with convolutions that contain negative as well as positive values. This is
533especially the case with convolutions involving high pass filters or edge
534detection. Without an output bias, the negative values are clipped at
535zero.</p>
536
Cristy594d2772015-11-15 10:47:42 -0500537<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 -0400538negative results without clipping to the color value range
539(0..QuantumRange).</p>
540
Cristy594d2772015-11-15 10:47:42 -0500541<p>See the discussion on HDRI implementations of ImageMagick on the page <a
542href="high-dynamic-range.html" >High Dynamic-Range Images</a>. For more
543about HDRI go the ImageMagick <a
544href="http://www.imagemagick.org/Usage/basics/#hdri" >Usage</a> pages or this
545<a
546href="http://en.wikipedia.org/wiki/High_dynamic_range_imaging">Wikipedia</a>
Cristy882d9f42015-10-29 16:48:39 -0400547entry. </p>
548
549<div style="margin: auto;">
550 <h3 class="magick-header"><a id="black-point-compensation"></a>-black-point-compensation</h3>
551</div>
552
553<p class="magick-description">Use black point compensation.</p>
554
555<div style="margin: auto;">
556 <h3 class="magick-header"><a id="black-threshold"></a>-black-threshold <var>value</var>{<var>%</var>}</h3>
557</div>
558
559<p class="magick-description">Force to black all pixels below the threshold while leaving all pixels at or above the threshold unchanged.</p>
560
561<p> The threshold value can be given as a percentage or as an absolute integer
562value within [0, <var>QuantumRange</var>] corresponding to the
Cristy594d2772015-11-15 10:47:42 -0500563desired <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 -0400564
565
566<div style="margin: auto;">
567 <h3 class="magick-header"><a id="blend"></a>-blend <var>geometry</var></h3>
568</div>
569
570<p class="magick-description">blend an image into another by the given absolute value or percent.</p>
571
572<p>Blend will average the images together ('plus') according to the
573percentages given and each pixels transparency. If only a single percentage
574value is given it sets the weight of the composite or 'source' image, while
575the background image is weighted by the exact opposite amount. That is a
576<code>-blend 30%</code> merges 30% of the 'source' image with 70% of the
577'destination' image. Thus it is equivalent to <code>-blend 30x70%</code>.</p>
578
579
580<div style="margin: auto;">
581 <h3 class="magick-header"><a id="blue-primary"></a>-blue-primary <var>x</var>,<var>y</var></h3>
582</div>
583
584<p class="magick-description">Set the blue chromaticity primary point.</p>
585
586<div style="margin: auto;">
587 <h3 class="magick-header"><a id="blue-shift"></a>-blue-shift <var>factor</var></h3>
588</div>
589
590<p class="magick-description">simulate a scene at nighttime in the moonlight. Start with a factor of 1.5</p>
591
592<div style="margin: auto;">
593
594<div style="margin: auto;">
Cristy594d2772015-11-15 10:47:42 -0500595 <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 -0400596</div>
597
598<p class="magick-description">Reduce image noise and reduce detail levels.</p>
599
600<p>Convolve the image with a Gaussian or normal distribution using the given
Cristy594d2772015-11-15 10:47:42 -0500601<var >Sigma</var> value. The formula is:</p>
Cristy882d9f42015-10-29 16:48:39 -0400602
Cristy594d2772015-11-15 10:47:42 -0500603<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 -0400604
Cristy594d2772015-11-15 10:47:42 -0500605<p>The <var >Sigma</var> value is the important argument, and
Cristy882d9f42015-10-29 16:48:39 -0400606determines the actual amount of blurring that will take place. </p>
607
Cristy594d2772015-11-15 10:47:42 -0500608<p>The <var >Radius</var> is only used to determine the size of the
Cristy882d9f42015-10-29 16:48:39 -0400609array which will hold the calculated Gaussian distribution. It should be an
610integer. If not given, or set to zero, IM will calculate the largest possible
611radius that will provide meaningful results for the Gaussian distribution.
612</p>
613
Cristy594d2772015-11-15 10:47:42 -0500614<p>The larger the <var >Radius</var> the slower the
615operation is. However too small a <var >Radius</var>, and sever
616aliasing effects may result. As a guideline, <var >Radius</var>
617should be at least twice the <var >Sigma</var> value, though three
Cristy882d9f42015-10-29 16:48:39 -0400618times will produce a more accurate result. </p>
619
620<p>This option differs from <a href="command-line-options.html#gaussian-blur">-gaussian-blur</a> simply
621by taking advantage of the separability properties of the distribution. Here
622we apply a single-dimensional Gaussian matrix in the horizontal direction,
623then repeat the process in the vertical direction.</p>
624
625<p>The <a href="command-line-options.html#virtual-pixel">-virtual-pixel</a> setting will determine how
626pixels which are outside the image proper are blurred into the final result.
627</p>
628
629
630<div style="margin: auto;">
631 <h3 class="magick-header">-blur <var>Width</var>[x<var>Height</var>[+<var>Angle</var>]]</h3>
632</div>
633
634<p class="magick-description">Variably blur an image according to the overlay mapping.</p>
635
636<p>Each pixel in the overlaid region is replaced with an Elliptical Weighted
637Average (EWA) of the source image, scaled according to the grayscale
638mapping. </p>
639
Cristy594d2772015-11-15 10:47:42 -0500640<p>The ellipse is weighted with sigma set to the given <var>Width</var> and <var >Height</var>. The <var >Height</var>
641defaults to the <var >Width</var> for a normal circular Gaussian
642weighting. The <var >Angle</var> will rotate the ellipse from
Cristy882d9f42015-10-29 16:48:39 -0400643horizontal clock-wise. </p>
644
645<p>The <a href="command-line-options.html#virtual-pixel">-virtual-pixel</a> setting will determine how
646pixels which are outside the image proper are blurred into the final result.
647</p>
648
649
650<div style="margin: auto;">
651 <h3 class="magick-header"><a id="border"></a>-border <var>geometry</var></h3>
652</div>
653
654<p class="magick-description">Surround the image with a border of color. </p>
655
656<p>Set the width and height using the <var>size</var> portion of the
657<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
658ignored. </p>
659
660<p>As of IM 6.7.8-8, the <var>geometry</var> arguments behave as follows:</p>
661
662<dl class="dl-horizontal">
663<dt><var>value</var></dt>
664<dd>value is added to both left/right and top/bottom</dd>
665<dt><var>value-x</var><kbd>x</kbd></dt>
666<dd>value-x is added only to left/right and top/bottom are unchanged</dd>
667<dt><kbd>x</kbd><var>value-y</var></dt>
668<dd>value-y is added only to top/bottom and left/right are unchanged</dd>
669<dt><var>value-x</var><kbd>x</kbd><var>value-y</var></dt>
670<dd>value-x is added to left/right and value-y added to top/bottom</dd>
671<dt><var>value-x</var><kbd>x</kbd>0</dt>
672<dd>value-x is added only to left/right and top/bottom are unchanged</dd>
673<dt>0<kbd>x</kbd><var>value-y</var></dt>
674<dd>value-y is added only to top/bottom and left/right are unchanged</dd>
675<dt><var>value</var>%</dt>
676<dd>value % of width is added to left/right and value % of height is added to top/bottom</dd>
677<dt><var>value-x</var><kbd>x</kbd>%</dt>
678<dd>value-x % of width is added to left/right and to top/bottom</dd>
679<dt>x<var>value-y</var>%</dt>
680<dd>value-y % of height is added to top/bottom and to left/right</dd>
681<dt><var>value-x</var>%<kbd>x</kbd><var>value-y</var>%</dt>
682<dd>value-x % of width is added to left/right and value-y % of height is added to top/bottom</dd>
683<dt><var>value-x</var>%<kbd>x</kbd>0%</dt>
684<dd>value-x % of width is added to left/right and top/bottom are unchanged</dd>
685<dt>0%<kbd>x</kbd><var>value-y</var>%</dt>
686<dd>value-y % of height is added to top/bottom and left/right are unchanged</dd>
687</dl>
688
Cristy594d2772015-11-15 10:47:42 -0500689<p>Set the border color by preceding with the <a
690href="command-line-options.html#bordercolor">-bordercolor</a> setting.</p>
Cristy882d9f42015-10-29 16:48:39 -0400691
Cristy594d2772015-11-15 10:47:42 -0500692<p>The <a href="command-line-options.html#border">-border</a> operation is affected by the current <a
693href="command-line-options.html#compose">-compose</a> setting and assumes that this is using the default
Cristy882d9f42015-10-29 16:48:39 -0400694'<code>Over</code>' composition method. It generates an image of the appropriate
695size colors by the current <a href="command-line-options.html#bordercolor">-bordercolor</a> before
696overlaying the original image in the center of this net image. This means that
697with the default compose method of '<code>Over</code>' any transparent parts may
698be replaced by the current <a href="command-line-options.html#bordercolor">-bordercolor</a> setting.</p>
699<p>See also the <a href="command-line-options.html#frame">-frame</a> option, which has more
700functionality.</p>
701
702<div style="margin: auto;">
703 <h3 class="magick-header"><a id="bordercolor"></a>-bordercolor <var>color</var></h3>
704</div>
705
706<p class="magick-description">Set the border color.</p>
707
708<p>The color is specified using the format described under the <a href="command-line-options.html#fill">-fill</a> option.</p>
709
710<p>The default border color is <code>#DFDFDF</code>, <span style="background-color: #dfdfdf;">this shade of gray</span>.</p>
711
712<div style="margin: auto;">
713 <h3 class="magick-header"><a id="borderwidth"></a>-borderwidth <var>geometry</var> </h3>
714</div>
715
716<p class="magick-description">Set the border width.</p>
717
718<div style="margin: auto;">
Cristy769d8892016-01-19 18:11:14 -0500719 <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 -0400720</div>
721
722<p class="magick-description">Adjust the brightness and/or contrast of the image.</p>
723
724<p>Brightness and Contrast values apply changes to the input image. They are
725not absolute settings. A brightness or contrast value of zero means no change.
726The range of values is -100 to +100 on each. Positive values increase the
727brightness or contrast and negative values decrease the brightness or contrast.
728To control only contrast, set the brightness=0. To control only brightness,
729set contrast=0 or just leave it off.</p>
730
731<p>You may also use <a href="command-line-options.html#fill">-channel</a> to control which channels to
732apply the brightness and/or contrast change. The default is to apply the same
733transformation to all channels.</p>
734
735<p>Brightness and Contrast arguments are converted to offset and slope of a
736linear transform and applied
737using <a href="command-line-options.html#fill">-function polynomial "slope,offset"</a>.</p>
738
739<p>The slope varies from 0 at contrast=-100 to almost vertical at
740contrast=+100. For brightness=0 and contrast=-100, the result are totally
741midgray. For brightness=0 and contrast=+100, the result will approach but
742not quite reach a threshold at midgray; that is the linear transformation
743is a very steep vertical line at mid gray.</p>
744
745<p>Negative slopes, i.e. negating the image, are not possible with this
746function. All achievable slopes are zero or positive.</p>
747
748<p>The offset varies from -0.5 at brightness=-100 to 0 at brightness=0 to +0.5
749at brightness=+100. Thus, when contrast=0 and brightness=100, the result is
750totally white. Similarly, when contrast=0 and brightness=-100, the result is
751totally black.</p>
752
753<p>As the range of values for the arguments are -100 to +100, adding the '%'
754symbol is no different than leaving it off.</p>
755
756<div style="margin: auto;">
757 <h3 class="magick-header"><a id="cache"></a>-cache <var>threshold</var></h3>
758</div>
759
Cristy594d2772015-11-15 10:47:42 -0500760<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 -0400761
762<div style="margin: auto;">
Cristy594d2772015-11-15 10:47:42 -0500763 <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 -0400764</div>
765
766<p class="magick-description">Canny edge detector uses a multi-stage algorithm to detect a wide range of edges in the image.</p>
767
768<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>
769
770<div style="margin: auto;">
771 <h3 class="magick-header"><a id="caption"></a>-caption <var>string</var></h3>
772</div>
773
774<p class="magick-description">Assign a caption to an image.</p>
775
776<p>This option sets the caption meta-data of an image read in after this
777option has been given. To modify a caption of images already in memory use
778"<code><a href="command-line-options.html#set">-set</a> caption</code>". </p>
779
Cristy594d2772015-11-15 10:47:42 -0500780<p>The caption can contain special format characters listed in the <a
781href="escape.html">Format and
Cristy882d9f42015-10-29 16:48:39 -0400782Print Image Properties</a>. These attributes are expanded when the caption
783is finally assigned to the individual images. </p>
784
785<p>If the first character of <var>string</var> is <var>@</var>, the image caption is read from a file titled by the
786remaining characters in the string. Comments read in from a file are literal;
787no embedded formatting characters are recognized.</p>
788
789<p>Caption meta-data is not visible on the image itself. To do that use the
790<a href="command-line-options.html#annotate">-annotate</a> or <a href="command-line-options.html#draw">-draw</a> options
791instead.</p>
792
793<p>For example,</p>
794
795<pre>
796-caption "%m:%f %wx%h" bird.miff
797</pre>
798
799<p>produces an image caption of <code>MIFF:bird.miff 512x480</code> (assuming
800that the image <code>bird.miff</code> has a width of 512 and a height of
801480.</p>
802
803
804<div style="margin: auto;">
805 <h3 class="magick-header"><a id="cdl"></a>-cdl <var>filename</var></h3>
806</div>
807
808<p class="magick-description">color correct with a color decision list.</p>
809
810<p>Here is an example color correction collection:</p>
811
812<pre>
813&lt;?xml version="1.0" encoding="UTF-8"?&gt;
814&lt;ColorCorrectionCollection xmlns="urn:ASC:CDL:v1.2"&gt;
815 &lt;ColorCorrection id="cc06668"&gt;
816 &lt;SOPNode&gt;
817 &lt;Slope&gt; 0.9 1.2 0.5 &lt;/Slope&gt;
818 &lt;Offset&gt; 0.4 -0.5 0.6 &lt;/Offset&gt;
819 &lt;Power&gt; 1.0 0.8 1.5 &lt;/Power&gt;
820 &lt;/SOPNode&gt;
821 &lt;SATNode&gt;
822 &lt;Saturation&gt; 0.85 &lt;/Saturation&gt;
823 &lt;/SATNode&gt;
824 &lt;/ColorCorrection&gt;
825&lt;/ColorCorrectionCollection&gt;
826</pre>
827
828<div style="margin: auto;">
829 <h3 class="magick-header"><a id="channel"></a>-channel <var>type</var></h3>
830</div>
831
832<p class="magick-description">Specify those image color channels to which subsequent operators are limited.</p>
833
834<p>Choose from: <code>Red</code>, <code>Green</code>, <code>Blue</code>,
835<code>Alpha</code>, <code>Gray</code>, <code>Cyan</code>, <code>Magenta</code>,
836<code>Yellow</code>, <code>Black</code>, <code>Opacity</code>,
837<code>Index</code>, <code>RGB</code>, <code>RGBA</code>, <code>CMYK</code>, or
838<code>CMYKA</code>.</p>
839
840<p>The channels above can also be specified as a comma-separated list or can be
841abbreviated as a concatenation of the letters '<code>R</code>', '<code>G</code>',
842'<code>B</code>', '<code>A</code>', '<code>O</code>', '<code>C</code>',
843'<code>M</code>', '<code>Y</code>', '<code>K</code>'.
844
845For example, to only select the <code>Red</code> and <code>Blue</code> channels
846you can either use </p>
847<pre>
848-channel Red,Blue
849</pre>
850<p>or you can use the short hand form</p>
851<pre>
852-channel RB
853</pre>
854
855<p>All the channels that are present in an image can be specified using the
856special channel type <code>All</code>. Not all operators are 'channel capable',
857but generally any operators that are generally 'grey-scale' image operators,
858will understand this setting. See individual operator documentation. </p>
859
Cristy594d2772015-11-15 10:47:42 -0500860<br/>
Cristy882d9f42015-10-29 16:48:39 -0400861
862<p>On top of the normal channel selection an extra flag can be specified,
863'<code>Sync</code>'. This is turned on by default and if set means that
864operators that understand this flag should perform: cross-channel
865synchronization of the channels. If not specified, then most grey-scale
866operators will apply their image processing operations to each individual
867channel (as specified by the rest of the <a href="command-line-options.html#channel">-channel</a>
868setting) completely independently from each other. </p>
869
870<p>For example for operators such as <a href="command-line-options.html#auto-level">-auto-level</a> and
871<a href="command-line-options.html#auto-gamma">-auto-gamma</a> the color channels are modified
872together in exactly the same way so that colors will remain in-sync. Without
873it being set, then each channel is modified separately and
874independently, which may produce color distortion. </p>
875
876<p>The <a href="command-line-options.html#morphology">-morphology</a> '<code>Convolve</code>' method
877and the <a href="command-line-options.html#compose">-compose</a> mathematical methods, also understands
878the '<code>Sync</code>' flag to modify the behavior of pixel colors according
879to the alpha channel (if present). That is to say it will modify the image
880processing with the understanding that fully-transparent colors should not
881contribute to the final result. </p>
882
883<p>Basically, by default, operators work with color channels in synchronous, and
884treats transparency as special, unless the <a href="command-line-options.html#channel">-channel</a>
885setting is modified so as to remove the effect of the '<code>Sync</code>' flag.
886How each operator does this depends on that operators current implementation.
887Not all operators understands this flag at this time, but that is changing.
888</p>
889
890<p>To print a complete list of channel types, use <a href="command-line-options.html#list">-list
891channel</a>.</p>
892
893<p>By default, ImageMagick sets <a href="command-line-options.html#channel">-channel</a> to the value
894'<code>RGBK,sync</code>', which specifies that operators act on all color
895channels except the transparency channel, and that all the color channels are
896to be modified in exactly the same way, with an understanding of transparency
Cristy594d2772015-11-15 10:47:42 -0500897(depending on the operation being applied). The 'plus' form <a
898href="command-line-options.html#channel" >+channel</a> will reset the value back to this default. </p>
Cristy882d9f42015-10-29 16:48:39 -0400899
Cristy594d2772015-11-15 10:47:42 -0500900<p>Options that are affected by the <a href="command-line-options.html#channel" >-channel</a> setting
Cristy882d9f42015-10-29 16:48:39 -0400901include the following.
902
903<a href="command-line-options.html#auto-gamma">-auto-gamma</a>,
904<a href="command-line-options.html#auto-level">-auto-level</a>,
905<a href="command-line-options.html#black-threshold">-black-threshold</a>,
906<a href="command-line-options.html#blur">-blur</a>,
907<a href="command-line-options.html#clamp">-clamp</a>,
908<a href="command-line-options.html#clut">-clut</a>,
909<a href="command-line-options.html#combine">-combine</a>,
910<a href="command-line-options.html#composite">-composite</a> (Mathematical compose methods only),
911<a href="command-line-options.html#convolve">-convolve</a>,
912<a href="command-line-options.html#contrast-stretch">-contrast-stretch</a>,
913<a href="command-line-options.html#evaluate">-evaluate</a>,
914<a href="command-line-options.html#function">-function</a>,
915<a href="command-line-options.html#fx">-fx</a>,
916<a href="command-line-options.html#gaussian-blur">-gaussian-blur</a>,
917<a href="command-line-options.html#hald-clut">-hald-clut</a>,
918<a href="command-line-options.html#motion-blur">-motion-blur</a>,
919<a href="command-line-options.html#morphology">-morphology</a>,
920<a href="command-line-options.html#negate">-negate</a>,
921<a href="command-line-options.html#normalize">-normalize</a>,
922<a href="command-line-options.html#ordered-dither">-ordered-dither</a>,
923<a href="command-line-options.html#radial-blur">-radial-blur</a>,
924<a href="command-line-options.html#random-threshold">-random-threshold</a>,
925<a href="command-line-options.html#separate">-separate</a>,
926<a href="command-line-options.html#threshold">-threshold</a>, and
927<a href="command-line-options.html#white-threshold">-white-threshold</a>.
928</p>
929
Cristy594d2772015-11-15 10:47:42 -0500930<p>Warning, some operators behave differently when the <a href="command-line-options.html#channel"
931>+channel</a> default setting is in effect, verses ANY user defined <a
932href="command-line-options.html#channel" >-channel</a> setting (including the equivalent of the
Cristy882d9f42015-10-29 16:48:39 -0400933default). These operators have yet to be made to understand the newer 'Sync'
934flag. </p>
935
Cristy769d8892016-01-19 18:11:14 -0500936<p>For example <a href="command-line-options.html#threshold">-threshold</a> will by default grayscale
Cristy594d2772015-11-15 10:47:42 -0500937the image before thresholding, if no <a href="command-line-options.html#channel" >-channel</a> setting
Cristy882d9f42015-10-29 16:48:39 -0400938has been defined. This is not 'Sync flag controlled, yet. </p>
939
Cristy594d2772015-11-15 10:47:42 -0500940<p>Also some operators such as <a href="command-line-options.html#blur">-blur</a>, <a
941href="command-line-options.html#gaussian-blur">-gaussian-blur</a>, will modify their handling of the
942color channels if the '<code>alpha</code>' channel is also enabled by <a
943href="command-line-options.html#channel" >-channel</a>. Generally this done to ensure that
Cristy882d9f42015-10-29 16:48:39 -0400944fully-transparent colors are treated as being fully-transparent, and thus any
945underlying 'hidden' color has no effect on the final results. Typically
946resulting in 'halo' effects. The newer <a href="command-line-options.html#morphology">-morphology</a>
947convolution equivalents however does have a understanding of the 'Sync' flag
948and will thus handle transparency correctly by default. </p>
949
950<p>As a alpha channel is optional within images, some operators will read the
951color channels of an image as a greyscale alpha mask, when the image has no
Cristy594d2772015-11-15 10:47:42 -0500952alpha channel present, and the <a href="command-line-options.html#channel" >-channel</a> setting tells
953the operator to apply the operation using alpha channels. The <a
954href="command-line-options.html#clut">-clut</a> operator is a good example of this. </p>
Cristy882d9f42015-10-29 16:48:39 -0400955
956
957
958<div style="margin: auto;">
959 <h3 class="magick-header"><a id="charcoal"></a>-charcoal <var>factor</var></h3>
960</div>
961
962<p class="magick-description">Simulate a charcoal drawing.</p>
963
964<div style="margin: auto;">
965 <h3 class="magick-header"><a id="chop"></a>-chop <var>geometry</var></h3>
966</div>
967
968<p class="magick-description">Remove pixels from the interior of an image.</p>
969
970<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>
971and <var>height</var> given in the of the <var>size</var>
972portion of the <var>geometry</var> argument give the number of
973columns and rows to remove. The <var>offset</var> portion of
974the <var>geometry</var> argument is influenced by
975a <a href="command-line-options.html#gravity">-gravity</a> setting, if present.</p>
976
977<p>The <a href="command-line-options.html#chop">-chop</a> option removes entire rows and columns,
978and moves the remaining corner blocks leftward and upward to close the gaps.</p>
979
980<p>While it can remove internal rows and columns of pixels, it is more
981typically used with as <a href="command-line-options.html#gravity">-gravity</a> setting and zero
Cristy594d2772015-11-15 10:47:42 -0500982offsets so as to remove a single edge from an image. Compare this to <a
983href="command-line-options.html#shave" >-shave</a> which removes equal numbers of pixels from opposite
Cristy882d9f42015-10-29 16:48:39 -0400984sides of the image. </p>
985
Cristy594d2772015-11-15 10:47:42 -0500986<p>Using <a href="command-line-options.html#chop">-chop</a> effectively undoes the results of a <a
987href="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 -0400988
989<div style="margin: auto;">
990 <h3 class="magick-header"><a id="clamp"></a>-clamp</h3>
991</div>
992
993<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>
994
995<div style="margin: auto;">
996 <h3 class="magick-header"><a id="clip"></a>-clip</h3>
997</div>
998
999<p class="magick-description">Apply the clipping path if one is present.</p>
1000
1001<p>If a clipping path is present, it is applied to subsequent operations.</p>
1002
1003<p>For example, in the command</p>
1004
1005<pre>
1006convert cockatoo.tif -clip -negate negated.tif
1007</pre>
1008
1009<p>only the pixels within the clipping path are negated.</p>
1010
1011<p>The <a href="command-line-options.html#clip">-clip</a> feature requires SVG support. If the SVG
1012delegate library is not present, the option is ignored.</p>
1013
1014<p>Use <a href="command-line-options.html#clip">+clip</a> to disable clipping for subsequent operations.</p>
1015
1016<div style="margin: auto;">
1017 <h3 class="magick-header"><a id="clip-mask"></a>-clip-mask</h3>
1018</div>
1019
1020<p class="magick-description">Clip the image as defined by this mask.</p>
1021
1022<p>Use the alpha channel of the current image as a mask. Any areas that is
1023white is not modified by any of the 'image processing operators' that follow,
1024until the mask is removed. Pixels in the black areas of the clip mask are
1025modified per the requirements of the operator. </p>
1026
1027<p>In some ways this is similar to (though not the same) as defining
Cristy594d2772015-11-15 10:47:42 -05001028a rectangular <a href="command-line-options.html#region" >-region</a>, or using the negative of the
1029mask (third) image in a three image <a href="command-line-options.html#composite" >-composite</a>,
Cristy882d9f42015-10-29 16:48:39 -04001030operation. </p>
1031
1032<p>Use <a href="command-line-options.html#clip-mask">+clip-mask</a> to disable clipping for subsequent operations.</p>
1033
1034<div style="margin: auto;">
1035 <h3 class="magick-header"><a id="clip-path"></a>-clip-path <var>id</var></h3>
1036</div>
1037
1038<p class="magick-description">Clip along a named path from the 8BIM profile.</p>
1039
1040<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>
1041
1042<p>Use <a href="command-line-options.html#clip-path">+clip-path</a> to disable clipping for subsequent operations.</p>
1043
1044<div style="margin: auto;">
1045 <h3 class="magick-header"><a id="clone"></a>-clone <var>index(s)</var></h3>
1046</div>
1047
1048<p class="magick-description">make a clone of an image (or images).</p>
1049
1050<p>Inside parenthesis (where the operator is normally used) it will make a
1051clone of the images from the last 'pushed' image sequence, and adds them to
1052the end of the current image sequence. Outside parenthesis
1053(not recommended) it clones the images from the current image sequence. </p>
1054
1055<p>Specify the image by its index in the sequence. The first image is index
10560. Negative indexes are relative to the end of the sequence; for
1057example, <code>−1</code>
1058represents the last image of the sequence. Specify a range of images with a
1059dash (e.g. <code>0−4</code>). Separate multiple indexes with commas but no
1060spaces (e.g. <code>0,2,5</code>). A value of '<code>0−−1</code> will
1061effectively clone all the images. </p>
1062
1063<p>The <a href="command-line-options.html#clone">+clone</a> will simply make a copy of the last image
1064in the image sequence, and is thus equivalent to using a argument of
1065'<code>−1</code>'. </p>
1066
1067<div style="margin: auto;">
1068 <h3 class="magick-header"><a id="clut"></a>-clut</h3>
1069</div>
1070
1071<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>
1072
1073<p>The second (LUT) image is ordinarily a gradient image containing the
1074histogram mapping of how each channel should be modified. Typically it is a
1075either a single row or column image of replacement color values. If larger
1076than a single row or column, values are taken from a diagonal line from
1077top-left to bottom-right corners.</p>
1078
Cristy594d2772015-11-15 10:47:42 -05001079<p>The lookup is further controlled by the <a
1080href="command-line-options.html#interpolate">-interpolate</a> setting, which is especially handy for an
Cristy882d9f42015-10-29 16:48:39 -04001081LUT which is not the full length needed by the ImageMagick installed Quality
1082(Q) level. Good settings for this are the '<code>bilinear</code>' and
1083'<code>bicubic</code>' interpolation settings, which give smooth color
1084gradients, and the '<code>integer</code>' setting for a direct, unsmoothed
1085lookup of color values. </p>
1086
1087<p>This operator is especially suited to replacing a grayscale image with a
1088specific color gradient from the CLUT image. </p>
1089
1090<p>Only the channel values defined by the <a href="command-line-options.html#channel">-channel</a>
Cristy594d2772015-11-15 10:47:42 -05001091setting will have their values replaced. In particular, since the default <a
1092href="command-line-options.html#channel">-channel</a> setting is <code>RGB</code>, this means that
1093transparency (alpha/matte channel) is not affected, unless the <a
1094href="command-line-options.html#channel">-channel</a> setting is modified. When the alpha channel is
1095set, 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 -04001096as the other channels, implying that alpha/matte values are replaced using the
1097alpha/matte values of the original image. </p>
1098
1099<p>If either the image being modified, or the lookup image, contains no
Cristy594d2772015-11-15 10:47:42 -05001100transparency (i.e. <a href="command-line-options.html#alpha" >-alpha</a> is turned 'off') but the <a
1101href="command-line-options.html#channel">-channel</a> setting includes alpha replacement, then it is
Cristy769d8892016-01-19 18:11:14 -05001102assumed that image represents a grayscale gradient which is used for the
1103replacement alpha values. That is you can use a grayscale CLUT image to
1104adjust a existing images alpha channel, or you can color a grayscale image
Cristy882d9f42015-10-29 16:48:39 -04001105using colors form CLUT containing the desired colors, including transparency.
1106</p>
1107
Cristy594d2772015-11-15 10:47:42 -05001108<p>See also <a href="command-line-options.html#hald-clut" >-hald-clut</a> which replaces colors
Cristy882d9f42015-10-29 16:48:39 -04001109according to the lookup of the full color RGB value from a 2D representation
1110of a 3D color cube. </p>
1111
1112
1113<div style="margin: auto;">
1114 <h3 class="magick-header"><a id="coalesce"></a>-coalesce</h3>
1115</div>
1116
1117<p class="magick-description">Fully define the look of each frame of an GIF animation sequence, to form a 'film strip' animation.</p>
1118
1119<p>Overlay each image in an image sequence according to
1120its <a href="command-line-options.html#dispose">-dispose</a> meta-data, to reproduce the look of
1121an animation at each point in the animation sequence. All images should be
1122the same size, and are assigned appropriate GIF disposal settings for the
1123animation to continue working as expected as a GIF animation. Such frames
1124are more easily viewed and processed than the highly optimized GIF overlay
1125images. </p>
1126
1127<p>The animation can be re-optimized after processing using
1128the <a href="command-line-options.html#layers">-layers</a> method '<code>optimize</code>', although
1129there is no guarantee that the restored GIF animation optimization is
1130better than the original. </p>
1131
1132
1133<div style="margin: auto;">
1134 <h3 class="magick-header"><a id="colorize"></a>-colorize <var>value</var></h3>
1135</div>
1136
Cristy594d2772015-11-15 10:47:42 -05001137<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 -04001138
1139<p>Specify the amount of colorization as a percentage. Separate colorization
1140values can be applied to the red, green, and blue channels of the image with
1141a comma-delimited list of colorization
1142values (e.g., <code>-colorize 0,0,50</code>).</p>
1143
1144<div style="margin: auto;">
1145 <h3 class="magick-header"><a id="colormap"></a>-colormap <var>type</var></h3>
1146</div>
1147
1148<p class="magick-description">Define the colormap type.</p>
1149
1150<p>The <var>type</var> can be <code>shared</code> or <code>private</code>.</p>
1151
1152<p>This option only applies when the default X server visual
1153is <code>PseudoColor</code> or <code>GrayScale</code>. Refer
1154to <a href="command-line-options.html#visual">-visual</a> for more details. By default,
1155a shared colormap is allocated. The image shares colors with
1156other X clients. Some image colors could be approximated,
1157therefore your image may look very different than intended.
1158If <code>private</code> is chosen, the image colors appear exactly
1159as they are defined. However, other clients may go <var>technicolor</var>
1160when the image colormap is installed.</p>
1161
1162<div style="margin: auto;">
1163 <h3 class="magick-header"><a id="colors"></a>-colors <var>value</var></h3>
1164</div>
1165
1166<p class="magick-description">Set the preferred number of colors in the image.</p>
1167
1168<p>The actual number of colors in the image may be less than your request,
1169but never more. Note that this a color reduction option. Images with fewer
1170unique colors than specified by <var>value</var> will have any
1171duplicate or unused colors removed. The ordering of an existing color
1172palette may be altered. When converting an image from color to grayscale,
1173it is more efficient to convert the image to the gray colorspace before
1174reducing the number of colors. Refer to
1175the <a href="quantize.html">
1176color reduction algorithm</a> for more details.</p>
1177
1178<div style="margin: auto;">
1179 <h3 class="magick-header"><a id="color-matrix"></a>-color-matrix <var>matrix</var></h3>
1180</div>
1181
1182<p class="magick-description">apply color correction to the image.</p>
1183
1184<p>This option permits saturation changes, hue rotation, luminance to alpha,
1185and various other effects. Although variable-sized transformation matrices
1186can be used, typically one uses a 5x5 matrix for an RGBA image and a 6x6
1187for CMYKA (or RGBA with offsets). The matrix is similar to those used by
1188Adobe Flash except offsets are in column 6 rather than 5 (in support of
1189CMYKA images) and offsets are normalized (divide Flash offset by 255).</p>
1190
1191<p>As an example, to add contrast to an image with offsets, try this command:</p>
1192
1193<pre>
1194convert kittens.jpg -color-matrix \
1195 " 1.5 0.0 0.0 0.0, 0.0, -0.157 \
1196 0.0 1.5 0.0 0.0, 0.0, -0.157 \
1197 0.0 0.0 1.5 0.0, 0.0, -0.157 \
1198 0.0 0.0 0.0 1.0, 0.0, 0.0 \
1199 0.0 0.0 0.0 0.0, 1.0, 0.0 \
1200 0.0 0.0 0.0 0.0, 0.0, 1.0" kittens.png
1201</pre>
1202<div style="margin: auto;">
1203 <h3 class="magick-header"><a id="colorspace"></a>-colorspace <var>value</var></h3>
1204</div>
1205
1206<p class="magick-description">Set the image colorspace.</p>
1207
1208<p>Choices are:</p>
1209
1210<pre>
1211CMY CMYK Gray HCL
1212HCLp HSB HSI HSL
1213HSV HWB Lab LCHab
1214LCHuv LMS Log Luv
1215OHTA Rec601YCbCr Rec709YCbCr RGB
1216scRGB sRGB Transparent xyY
1217XYZ YCbCr YCC YDbDr
1218YIQ YPbPr YUV
1219</pre>
1220
1221<p>To print a complete list of colorspaces, use <a href="command-line-options.html#list">-list colorspace</a>.</p>
1222
1223<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>
1224
1225<table class="table table-condensed table-striped">
1226 <caption>Conversion of RGB to Other Color Spaces</caption>
1227 <tr><th valign="middle">CMY</th></tr>
1228 <tr><td valign="middle">C=<var>QuantumRange</var>−R</td></tr>
1229 <tr><td valign="middle">M=<var>QuantumRange</var>−G</td></tr>
1230 <tr><td valign="middle">Y=<var>QuantumRange</var>−B</td></tr>
1231 <tr><th valign="middle">CMYK — starts with CMY from above</th></tr>
1232 <tr><td valign="middle">K=min(C,Y,M)</td></tr>
1233 <tr><td valign="middle">C=<var>QuantumRange</var>*(C−K)/(<var>QuantumRange</var>−K)</td></tr>
1234 <tr><td valign="middle">M=<var>QuantumRange</var>*(M−K)/(<var>QuantumRange</var>−K)</td></tr>
1235 <tr><td valign="middle">Y=<var>QuantumRange</var>*(Y−K)/(<var>QuantumRange</var>−K)</td></tr>
1236
1237 <tr><th valign="middle">Gray</th></tr>
1238 <tr><td valign="middle">Gray = 0.298839*R+0.586811*G+0.114350*B</td></tr>
1239
1240 <tr><th valign="middle">HSB — Hue, Saturation, Brightness; like a cone peak downward</th></tr>
1241 <tr><td valign="middle">H=angle around perimeter (0 to 360 deg); H=0 is red; increasing angles toward green</td></tr>
1242 <tr><td valign="middle">S=distance from axis outward</td></tr>
1243 <tr><td valign="middle">B=distance along axis from bottom upward; B=max(R,G,B); <var>intensity-like</var></td></tr>
1244
1245 <tr><th valign="middle">HSL — Hue, Saturation, Lightness; like a double cone end-to-end with peaks at very top and bottom</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">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>
1249
1250 <tr><th valign="middle">HWB — Hue, Whiteness, Blackness</th></tr>
1251 <tr><td valign="middle">Hue (complicated equation)</td></tr>
1252 <tr><td valign="middle">Whiteness (complicated equation)</td></tr>
1253 <tr><td valign="middle">Blackness (complicated equation)</td></tr>
1254
1255 <tr><th valign="middle">LAB</th></tr>
1256 <tr><td valign="middle">L (complicated equation relating X,Y,Z)</td></tr>
1257 <tr><td valign="middle">A (complicated equation relating X,Y,Z)</td></tr>
1258 <tr><td valign="middle">B (complicated equation relating X,Y,Z)</td></tr>
1259
1260 <tr><th valign="middle">LOG</th></tr>
1261 <tr><td valign="middle">I1 (complicated equation involving logarithm of R)</td></tr>
1262 <tr><td valign="middle">I2 (complicated equation involving logarithm of G)</td></tr>
1263 <tr><td valign="middle">I3 (complicated equation involving logarithm of B)</td></tr>
1264
1265 <tr><th valign="middle">OHTA — approximates principal components transformation</th></tr>
1266 <tr><td valign="middle">I1=0.33333*R+0.33334*G+0.33333*B; <var>intensity-like</var></td></tr>
1267 <tr><td valign="middle">I2=(0.50000*R+0.00000*G−0.50000*B)*(<var>QuantumRange</var>+1)/2</td></tr>
1268 <tr><td valign="middle">I3=(−0.25000*R+0.50000*G−0.25000*B)*(<var>QuantumRange</var>+1)/2</td></tr>
1269
1270 <tr><th valign="middle">Rec601Luma</th></tr>
1271 <tr><td valign="middle">Gray = 0.298839*R+0.586811*G+0.114350*B</td></tr>
1272
1273 <tr><th valign="middle">Rec601YCbCr</th></tr>
1274 <tr><td valign="middle">Y=0.2988390*R+0.5868110*G+0.1143500*B; <var>intensity-like</var></td></tr>
1275 <tr><td valign="middle">Cb=(−0.168736*R-0.331264*G+0.500000*B)*(<var>QuantumRange</var>+1)/2</td></tr>
1276 <tr><td valign="middle">Cr=(0.500000*R−0.418688*G−0.081312*B)*(<var>QuantumRange</var>+1)/2</td></tr>
1277
1278 <tr><th valign="middle">Rec709Luma</th></tr>
1279 <tr><td valign="middle">Gray=0.212656*R+0.715158*G+0.072186*B</td></tr>
1280
1281 <tr><th valign="middle">Rec709YCbCr</th></tr>
1282 <tr><td valign="middle">Y=0.212656*R+0.715158*G+0.072186*B; <var>intensity-like</var></td></tr>
1283 <tr><td valign="middle">Cb=(−0.114572*R−0.385428*G+0.500000*B)+(<var>QuantumRange</var>+1)/2</td></tr>
1284 <tr><td valign="middle">Cr=(0.500000*R−0.454153*G−0.045847*B)+(<var>QuantumRange</var>+1)/2</td></tr>
1285
1286 <tr><th valign="middle">sRGB</th></tr>
1287 <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>
1288 <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>
1289 <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>
1290
1291 <tr><th valign="middle">XYZ</th></tr>
1292 <tr><td valign="middle">X=0.4124564*R+0.3575761*G+0.1804375*B</td></tr>
1293 <tr><td valign="middle">Y=0.2126729*R+0.7151522*G+0.0721750*B</td></tr>
1294 <tr><td valign="middle">Z=0.0193339*R+0.1191920*G+0.9503041*B</td></tr>
1295
1296 <tr><th valign="middle">YCC</th></tr>
1297 <tr><td valign="middle">Y=(0.298839*R+0.586811*G+0.114350*B) (with complicated scaling); <var>intensity-like</var></td></tr>
1298 <tr><td valign="middle">C1=(−0.298839*R−0.586811*G+0.88600*B) (with complicated scaling)</td></tr>
1299 <tr><td valign="middle">C2=(0.70100*R−0.586811*G−0.114350*B) (with complicated scaling)</td></tr>
1300
1301 <tr><th valign="middle">YCbCr</th></tr>
1302 <tr><td valign="middle">Y=0.2988390*R+0.5868110*G+0.1143500*B; <var>intensity-like</var></td></tr>
1303 <tr><td valign="middle">Cb=(−0.168736*R−0.331264*G+0.500000*B)*(<var>QuantumRange</var>+1)/2</td></tr>
1304 <tr><td valign="middle">Cr=(0.500000*R−0.418688*G−0.081312*B)*(<var>QuantumRange</var>+1)/2</td></tr>
1305
1306 <tr><th valign="middle">YIQ</th></tr>
1307 <tr><td valign="middle">Y=0.298839*R+0.586811*G+0.114350*B; <var>intensity-like</var></td></tr>
1308 <tr><td valign="middle">I=(0.59600*R−0.27400*G−0.32200*B)*(<var>QuantumRange</var>+1)/2</td></tr>
1309 <tr><td valign="middle">Q=(0.21100*R−0.52300*G+0.31200*B)*(<var>QuantumRange</var>+1)/2</td></tr>
1310
1311 <tr><th valign="middle">YPbPr</th></tr>
1312 <tr><td valign="middle">Y=0.2988390*R+0.5868110*G+0.1143500*B; <var>intensity-like</var></td></tr>
1313 <tr><td valign="middle">Pb=(−0.168736*R−0.331264*G+0.500000*B)*(<var>QuantumRange</var>+1)/2</td></tr>
1314 <tr><td valign="middle">Pr=(0.500000*R−0.418688*G−0.081312*B)*(<var>QuantumRange</var>+1)/2</td></tr>
1315
1316 <tr><th valign="middle">YUV</th></tr>
1317 <tr><td valign="middle">Y=0.298839*R+0.586811*G+0.114350*B; <var>intensity-like</var></td></tr>
1318 <tr><td valign="middle">U=(−0.14740*R−0.28950*G+0.43690*B)*(<var>QuantumRange</var>+1)/2</td></tr>
1319 <tr><td valign="middle">V=(0.61500*R−0.51500*G−0.10000*B)*(<var>QuantumRange</var>+1)/2</td></tr>
1320</table>
1321
1322<p>Note the scRGB colorspace requires HDRI support otherwise it behaves just like linear RGB.</p>
1323
1324<div style="margin: auto;">
1325 <h3 class="magick-header"><a id="combine"></a>-combine</h3>
1326</div>
1327
1328<p class="magick-description">Combine one or more images into a single image.</p>
1329
1330<p>The channels (previously set by <a href="command-line-options.html#channel">-channel</a>) of the
1331combined image are taken from the grayscale values of each image in the
1332sequence, in order. For the default -channel setting of <code>RGB</code>, this
1333means the first image is assigned to the <code>Red</code> channel, the second
1334to the <code>Green</code> channel, the third to the <code>Blue</code>.</p>
1335
Cristy594d2772015-11-15 10:47:42 -05001336<p>This option can be thought of as the inverse to <a
1337href="command-line-options.html#separate">-separate</a>, so long as the channel settings are the same.
Cristy882d9f42015-10-29 16:48:39 -04001338Thus, in the following example, the final image should be a copy of the
1339original. </p>
1340
1341<pre>
1342convert original.png -channel RGB -separate sepimage.png
1343convert sepimage-0.png sepimage-1.png sepimage-2.png -channel RGB \
1344 -combine imagecopy.png
1345</pre>
1346
1347<div style="margin: auto;">
1348 <h3 class="magick-header"><a id="comment"></a>-comment <var>string</var></h3>
1349</div>
1350
1351<p class="magick-description">Embed a comment in an image.</p>
1352
1353<p>This option sets the comment meta-data of an image read in after this
1354option has been given. To modify a comment of images already in memory use
1355"<code><a href="command-line-options.html#set">-set</a> comment</code>". </p>
1356
Cristy594d2772015-11-15 10:47:42 -05001357<p>The comment can contain special format characters listed in the <a
1358href="escape.html">Format and
Cristy882d9f42015-10-29 16:48:39 -04001359Print Image Properties</a>. These attributes are expanded when the comment
1360is finally assigned to the individual images. </p>
1361
1362<p>If the first character of <var>string</var> is <var>@</var>, the image comment is read from a file titled by the
1363remaining characters in the string. Comments read in from a file are literal;
1364no embedded formatting characters are recognized.</p>
1365
1366<p>Comment meta-data are not visible on the image itself. To do that use the
1367<a href="command-line-options.html#annotate">-annotate</a> or <a href="command-line-options.html#draw">-draw</a> options
1368instead.</p>
1369
1370<p>For example,</p>
1371
1372<pre>
1373-comment "%m:%f %wx%h" bird.miff
1374</pre>
1375
1376<p>produces an image comment of <code>MIFF:bird.miff 512x480</code> (assuming
1377that the image <code>bird.miff</code> has a width of 512 and a height of
1378480.</p>
1379
1380<div style="margin: auto;">
1381 <h3 class="magick-header"><a id="compare"></a>-compare</h3>
1382</div>
1383
1384<p class="magick-description">mathematically and visually annotate the difference between an image and its reconstruction</p>
1385
1386<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>
1387
1388<pre>
Cristy594d2772015-11-15 10:47:42 -05001389convert image.png reference.png -metric RMSE -compare \ <br/> difference.png
Cristy882d9f42015-10-29 16:48:39 -04001390</pre>
1391
1392<p>To get the metric value use the string format "%[distortion]".</p>
1393
1394<pre>
1395convert image.png reference.png -metric RMSE -compare -format \
1396 "%[distortion]" info:
1397</pre>
1398
1399<div style="margin: auto;">
1400 <h3 class="magick-header"><a id="complex"></a>-complex <var>operator</var></h3>
1401</div>
1402
1403<p class="magick-description">perform complex mathematics on an image sequence</p>
1404
1405Choose from these operators:
1406
1407<pre>
1408add
1409conjugate
1410divide
1411magnitude-phase
1412multiply
1413real-imaginary
1414subtract
1415</pre>
1416
1417<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>
1418
1419<div style="margin: auto;">
1420 <h3 class="magick-header"><a id="compose"></a>-compose <var>operator</var></h3>
1421</div>
1422
1423<p class="magick-description">Set the type of image composition.</p>
1424
1425<p>See <a href="compose.html">Alpha Compositing</a> for
1426a detailed discussion of alpha compositing.</p>
1427
1428<p>This setting effects image processing operators that merge two (or more)
1429images together in some way. This includes the operators,
1430<a href="command-line-options.html#composite">-compare</a>,
1431<a href="command-line-options.html#composite">-composite</a>,
1432<a href="command-line-options.html#layers">-layers</a> composite,
1433<a href="command-line-options.html#flatten">-flatten</a>,
1434<a href="command-line-options.html#mosaic">-mosaic</a>,
1435<a href="command-line-options.html#layers">-layers</a> merge,
1436<a href="command-line-options.html#border">-border</a>,
1437<a href="command-line-options.html#frame">-frame</a>,
1438and <a href="command-line-options.html#extent">-extent</a>. </p>
1439
1440<p>It is also one of the primary options for the "<code>composite</code>"
1441command. </p>
1442
1443
1444<div style="margin: auto;">
1445 <h3 class="magick-header"><a id="composite"></a>-composite</h3>
1446</div>
1447
1448<p class="magick-description">Perform alpha composition on two images and an optional mask</p>
1449
1450<p>Take the first image 'destination' and overlay the second 'source' image
1451according to the current <a href="command-line-options.html#compose">-compose</a> setting. The location
Cristy594d2772015-11-15 10:47:42 -05001452of the 'source' or 'overlay' image is controlled according to <a
Cristye93be682015-11-26 09:07:51 -05001453href="command-line-options.html#gravity" >-gravity</a>, and <a href="command-line-options.html#geometry" >-geometry</a>
Cristy882d9f42015-10-29 16:48:39 -04001454settings. </p>
1455
Cristy769d8892016-01-19 18:11:14 -05001456<p>If a third image is given this is treated as a grayscale blending 'mask' image
Cristy882d9f42015-10-29 16:48:39 -04001457relative to the first 'destination' image. This mask is blended with the
1458source image. However for the '<code>displace</code>' compose method, the
1459mask is used to provide a separate Y-displacement image instead. </p>
1460
1461<p>If a <a href="command-line-options.html#compose">-compose</a> method requires extra numerical
Cristy594d2772015-11-15 10:47:42 -05001462arguments or flags these can be provided by setting the <a
1463href="command-line-options.html#set">-set</a> '<code>option:compose:args</code>'
Cristy882d9f42015-10-29 16:48:39 -04001464appropriately for the compose method. </p>
1465
1466<p>Some <a href="command-line-options.html#compose">-compose</a> methods can modify the 'destination'
Cristy594d2772015-11-15 10:47:42 -05001467image outside the overlay area. You can disable this by setting the special <a
1468href="command-line-options.html#set">-set</a> '<code>option:compose:outside-overlay</code>'
Cristy882d9f42015-10-29 16:48:39 -04001469to '<code>false</code>'. </p>
1470
1471<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>
1472
1473
1474<div style="margin: auto;">
1475 <h3 class="magick-header"><a id="compress"></a>-compress <var>type</var></h3>
1476</div>
1477
1478<p class="magick-description">Use pixel compression specified by <var>type</var> when writing the image.</p>
1479
Cristy594d2772015-11-15 10:47:42 -05001480<p>Choices are: <code>None</code>, <code>BZip</code>, <code
1481>Fax</code>, <code>Group4</code>, <code
1482>JPEG</code>, <code>JPEG2000</code>, <code
1483>Lossless</code>, <code>LZW</code>, <code
1484>RLE</code> or <code>Zip</code>.</p>
Cristy882d9f42015-10-29 16:48:39 -04001485
1486<p>To print a complete list of compression types, use <a href="command-line-options.html#list">-list
1487compress</a>.</p>
1488
1489<p>Specify <a href="command-line-options.html#compress">+compress</a> to store the binary image in an
1490uncompressed format. The default is the compression type of the specified
1491image file.</p>
1492
1493<p>If <code>LZW</code> compression is specified but LZW compression has not been
1494enabled, the image data is written in an uncompressed LZW format that can be
1495read by LZW decoders. This may result in larger-than-expected GIF files.</p>
1496
1497<p><code>Lossless</code> refers to lossless JPEG, which is only available if the
1498JPEG library has been patched to support it. Use of lossless JPEG is generally
1499not recommended.</p>
1500
1501<p>
1502When writing an ICO file, you may request that the images be encoded in
1503PNG format, by specifying <code>Zip</code> compression.</p>
1504
1505<p>
1506When writing a JNG file, specify <code>Zip</code> compression to request that
1507the alpha channel be encoded in PNG "IDAT" format, or <code>JPEG</code>
1508to request that it be encoded in JPG "JDAA" format.</p>
1509
1510<p>Use the <a href="command-line-options.html#quality">-quality</a> option to set the compression level
1511to be used by JPEG, PNG, MIFF, and MPEG encoders.
1512Use the <a href="command-line-options.html#sampling-factor">-sampling-factor</a> option to set the
1513sampling factor to be used by JPEG, MPEG, and YUV encoders for down-sampling
1514the chroma channels.</p>
1515
1516<div style="margin: auto;">
1517 <h3 class="magick-header"><a id="connected-components"></a>-connected-components <var>connectivity</var></h3>
1518</div>
1519
Cristyce4a3552015-12-14 13:53:35 -05001520<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 -04001521
Cristy594d2772015-11-15 10:47:42 -05001522<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 -04001523
1524<div style="margin: auto;">
1525 <h3 class="magick-header"><a id="contrast"></a>-contrast</h3>
1526</div>
1527
1528<p class="magick-description">Enhance or reduce the image contrast.</p>
1529
1530<p>This option enhances the intensity differences between the lighter and
1531darker elements of the image. Use <a href="command-line-options.html#contrast">-contrast</a> to enhance
1532the image or <a href="command-line-options.html#contrast">+contrast</a> to reduce the image
1533contrast.</p>
1534
1535<p>For a more pronounced effect you can repeat the option:</p>
1536
1537<pre>
1538convert rose: -contrast -contrast rose_c2.png
1539</pre>
1540
1541<div style="margin: auto;">
Cristy769d8892016-01-19 18:11:14 -05001542 <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 -04001543</div>
1544
1545<p class="magick-description">Increase the contrast in an image by <var>stretching</var> the range of intensity values.</p>
1546
1547<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 -05001548<var >black-point %</var> pixels and white-out at most <var>white-point %</var> pixels.</p>
Cristy882d9f42015-10-29 16:48:39 -04001549
Cristy594d2772015-11-15 10:47:42 -05001550<p>Prior to ImageMagick 6.4.7-0, <a href="command-line-options.html#contrast-stretch"
1551>-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 -04001552minus 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>
1553
1554<p>Note that <code>-contrast-stretch 0</code> will modify the image such that
1555the 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 -05001556clipping at either end. This is not the same as <a href="command-line-options.html#normalize"
1557>-normalize</a>, which is equivalent to <code>-contrast-stretch 0.15x0.05%</code> (or
Cristy882d9f42015-10-29 16:48:39 -04001558prior to ImageMagick 6.4.7-0, <code>-contrast-stretch 2%x99%</code>).</p>
1559
1560<p>Internally operator works by creating a histogram bin, and then uses that
1561bin to modify the image. As such some colors may be merged together when they
1562originally fell into the same 'bin'. </p>
1563
Cristy769d8892016-01-19 18:11:14 -05001564<p>All the channels are normalized in concert by the same amount so as to
Cristy594d2772015-11-15 10:47:42 -05001565preserve color integrity, when the default <a href="command-line-options.html#channel" >+channel</a>
1566setting is in use. Specifying any other <a href="command-line-options.html#channel" >-channel</a>
Cristy882d9f42015-10-29 16:48:39 -04001567setting will normalize the RGB channels independently.</p>
1568
Cristy594d2772015-11-15 10:47:42 -05001569<p>See also <a href="command-line-options.html#auto-level" >-auto-level</a> for a 'perfect'
Cristy882d9f42015-10-29 16:48:39 -04001570normalization of mathematical images. </p>
1571
1572<p>This operator is under review for re-development. </p>
1573
1574
1575<div style="margin: auto;">
1576 <h3 class="magick-header"><a id="convolve"></a>-convolve <var>kernel</var></h3>
1577</div>
1578
1579<p class="magick-description">Convolve an image with a user-supplied convolution kernel.</p>
1580
1581<p>The <var>kernel</var> is a matrix specified as
1582a comma-separated list of integers (with no spaces), ordered left-to right,
1583starting with the top row. Presently, only odd-dimensioned kernels are
1584supported, and therefore the number of entries in the specified <var>kernel</var> must be 3<sup>2</sup>=9, 5<sup>2</sup>=25,
15857<sup>2</sup>=49, etc. </p>
1586
Cristy594d2772015-11-15 10:47:42 -05001587<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 -04001588positive and negative results are relative to a user-specified bias value.
1589This is important for non-HDRI compilations of ImageMagick when dealing with
1590convolutions that contain negative as well as positive values. This is
1591especially the case with convolutions involving high pass filters or edge
1592detection. Without an output bias, the negative values is clipped at zero.
1593</p>
1594
Cristy594d2772015-11-15 10:47:42 -05001595<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 -04001596negative results without clipping to the color value range (0..QuantumRange).
Cristy594d2772015-11-15 10:47:42 -05001597See the discussion on HDRI implementations of ImageMagick on the page <a
1598href="high-dynamic-range.html">High
1599Dynamic-Range Images</a>. For more about HDRI go the ImageMagick <a
1600href="http://www.imagemagick.org/Usage/basics/#hdri">Usage</a> pages or this
Cristy882d9f42015-10-29 16:48:39 -04001601<a href="http://en.wikipedia.org/wiki/High_dynamic_range_imaging">Wikipedia</a>
1602entry. </p>
1603
1604
1605<div style="margin: auto;">
1606 <h3 class="magick-header"><a id="copy"></a>-copy <var>geometry</var> <var>offset</var></h3>
1607</div>
1608
1609<p class="magick-description">copy pixels from one area of an image to another.</p>
1610
1611<div style="margin: auto;">
1612 <h3 class="magick-header"><a id="crop"></a>-crop <var>geometry</var>{<var>@</var>}{<var>!</var>}</h3>
1613</div>
1614
1615<p class="magick-description">Cut out one or more rectangular regions of the image.</p>
1616
1617<p>See <a href="command-line-processing.html#geometry">Image Geometry</a> for complete details about the <em class="arg">geometry</em> argument.</p>
1618
1619<p>The <var>width</var> and <var>height</var> of the <var>geometry</var> argument give the size of the image that remains
1620after cropping, and <var>x</var> and <var>y</var> in the
1621<var>offset</var> (if present) gives the location of the top left
1622corner of the cropped image with respect to the original image. To specify the
1623amount to be removed, use <a href="command-line-options.html#shave">-shave</a> instead.</p>
1624
1625<p>If the <var>x</var> and <var>y</var> offsets are
1626present, a single image is generated, consisting of the pixels from the
1627cropping region. The offsets specify the location of the upper left corner of
1628the cropping region measured downward and rightward with respect to the upper
1629left corner of the image. If the <a href="command-line-options.html#gravity">-gravity</a> option is
1630present with <code>NorthEast</code>, <code>East</code>, or <code>SouthEast</code>
1631gravity, it gives the distance leftward from the right edge of the image to
Cristy594d2772015-11-15 10:47:42 -05001632the right edge of the cropping region. Similarly, if the <a
1633href="command-line-options.html#gravity">-gravity</a> option is present with <code>SouthWest</code>,
Cristy882d9f42015-10-29 16:48:39 -04001634<code>South</code>, or <code>SouthEast</code> gravity, the distance is measured
1635upward between the bottom edges.</p>
1636
1637<p>If the <var>x</var> and <var>y</var> offsets are
1638omitted, a set of tiles of the specified geometry, covering the entire input
1639image, is generated. The rightmost tiles and the bottom tiles are smaller if
1640the specified geometry extends beyond the dimensions of the input image.</p>
1641
1642<p>You can add the <var>@</var> to the geometry argument to equally divide the image into the number of tiles generated.</p>
1643
1644<p>By adding a exclamation character flag to the geometry argument, the
1645cropped images virtual canvas page size and offset is set as if the
1646geometry argument was a viewport or window. This means the canvas page size
1647is set to exactly the same size you specified, the image offset set
1648relative top left corner of the region cropped. </p>
1649
1650<p>If the cropped image 'missed' the actual image on its virtual canvas, a
1651special single pixel transparent 'missed' image is returned, and a 'crop
1652missed' warning given. </p>
1653
Cristy594d2772015-11-15 10:47:42 -05001654<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 -04001655cropping the image to ensure the crop coordinate frame is relocated to the
1656upper-left corner of the visible image.
1657
Cristy594d2772015-11-15 10:47:42 -05001658Similarly you may want to use <a href="command-line-options.html#repage" >+repage</a> after cropping to
Cristy882d9f42015-10-29 16:48:39 -04001659remove the page offset that will be left behind. This is especially true when
1660you are going to write to an image format such as PNG that supports an image
1661offset.</p>
1662
1663<div style="margin: auto;">
1664 <h3 class="magick-header"><a id="cycle"></a>-cycle <var>amount</var></h3>
1665</div>
1666
1667<p class="magick-description">displace image colormap by amount.</p>
1668
1669<p><var>Amount</var> defines the number of positions each
1670colormap entry is shifted.</p>
1671
1672
1673<div style="margin: auto;">
1674 <h3 class="magick-header"><a id="debug"></a>-debug <var>events</var></h3>
1675</div>
1676
1677<p class="magick-description">enable debug printout.</p>
1678
1679<p>The <code>events</code> parameter specifies which events are to be logged. It
1680can be either <code>None</code>, <code>All</code>, <code>Trace</code>, or
1681a comma-separated list consisting of one or more of the following domains:
1682<code>Accelerate</code>, <code>Annotate</code>, <code>Blob</code>, <code>Cache</code>,
1683<code>Coder</code>, <code>Configure</code>, <code>Deprecate</code>,
1684<code>Exception</code>, <code>Locale</code>, <code>Render</code>,
1685<code>Resource</code>, <code>Security</code>, <code>TemporaryFile</code>,
1686<code>Transform</code>, <code>X11</code>, or <code>User</code>. </p>
1687
1688
1689<p>For example, to log cache and blob events, use.</p>
1690
1691<pre>
1692convert -debug "Cache,Blob" rose: rose.png
1693</pre>
1694
1695<p>The <code>User</code> domain is normally empty, but developers can log user
1696events in their private copy of ImageMagick.</p>
1697
1698<p>To print the complete list of debug methods, use <a href="command-line-options.html#list">-list
1699debug</a>.</p>
1700
1701<p>Use the <a href="command-line-options.html#log">-log</a> option to specify the format for debugging
1702output.</p>
1703
1704<p>Use <a href="command-line-options.html#debug">+debug</a> to turn off all logging.</p>
1705
Cristy594d2772015-11-15 10:47:42 -05001706<p>Debugging may also be set using the <code>MAGICK_DEBUG</code> <a href="resources.html#environment"
1707>environment variable</a>. The allowed values for the <code>MAGICK_DEBUG</code>
Cristy882d9f42015-10-29 16:48:39 -04001708environment variable are the same as for the <a href="command-line-options.html#debug">-debug</a>
1709option.</p>
1710
1711
1712<div style="margin: auto;">
1713 <h3 class="magick-header"><a id="decipher"></a>-decipher <var>filename</var></h3>
1714</div>
1715
1716<p class="magick-description">Decipher and restore pixels that were previously transformed by <a href="command-line-options.html#encipher">-encipher</a>.</p>
1717
1718<p>Get the passphrase from the file specified by <var>filename</var>.</p>
1719
Cristy594d2772015-11-15 10:47:42 -05001720<p>For more information, see the webpage, <a
1721href="http://www.imagemagick.org/www/cipher.html">ImageMagick: Encipher or
Cristy882d9f42015-10-29 16:48:39 -04001722Decipher an Image</a>.</p>
1723
1724
1725<div style="margin: auto;">
1726 <h3 class="magick-header"><a id="deconstruct"></a>-deconstruct</h3>
1727</div>
1728
1729<p class="magick-description">find areas that has changed between images </p>
1730
Cristy594d2772015-11-15 10:47:42 -05001731<p>Given a sequence of images all the same size, such as produced by <a
1732href="command-line-options.html#coalesce">-coalesce</a>, replace the second and later images, with
Cristy882d9f42015-10-29 16:48:39 -04001733a smaller image of just the area that changed relative to the previous image.
1734</p>
1735
1736<p>The resulting sequence of images can be used to optimize an animation
1737sequence, though will not work correctly for GIF animations when parts of the
1738animation can go from opaque to transparent. </p>
1739
1740<p>This option is actually equivalent to the <a href="command-line-options.html#layers">-layers</a>
1741method '<code>compare-any</code>'. </p>
1742
1743
1744<div style="margin: auto;">
1745 <h3 class="magick-header"><a id="define"></a>-define <var>key</var>{<var>=value</var>}<var>...</var></h3>
1746</div>
1747
1748<p class="magick-description">add specific global settings generally used to control coders and image processing operations.</p>
1749
1750<p>This option creates one or more definitions for coders and decoders to use
1751while reading and writing image data. Definitions are generally used to
1752control image file format coder modules, and image processing operations,
Cristy594d2772015-11-15 10:47:42 -05001753beyond what is provided by normal means. Defined settings are listed in <a
1754href="command-line-options.html#verbose" >-verbose</a> information ("<code>info:</code>" output format)
Cristy882d9f42015-10-29 16:48:39 -04001755as "Artifacts". </p>
1756
1757<p>If <var>value</var> is missing for a definition, an empty-valued
1758definition of a flag is created with that name. This used to control on/off
1759options. Use <a href="command-line-options.html#define">+define key</a> to remove definitions
1760previously created. Use <a href="command-line-options.html#define">+define "*"</a> to remove all
1761existing definitions.</p>
1762
Cristy594d2772015-11-15 10:47:42 -05001763<p>The same 'artifact' settings can also be defined using the <a
1764href="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 -04001765Properties</a> in the defined value. </p>
1766
1767<p>The <var>option</var> and <var>key</var> are case-independent (they are
1768converted to lowercase for use within the decoders) while the <var>value</var>
1769is case-dependent.</p>
1770
1771<p>Such settings are global in scope, and affect all images and operations. </p>
1772
1773<p>The following definitions are just some of the artifacts that are
1774available:</p>
1775
1776<table class="table table-condensed table-striped">
1777 <tr>
1778 <td>bmp:format=<var>value</var></td>
1779 <td> valid values are <var>bmp2</var>, <var>bmp3</var>,
1780 and <var>bmp4</var>. This option can be useful when the
1781 method of prepending "BMP2:" to the output filename is inconvenient or
1782 is not available, such as when using the <a href="mogrify.html">mogrify</a> utility.</td>
1783 </tr>
1784
1785 <tr>
1786 <td>colorspace:auto-grayscale=<var>on|off</var></td>
1787 <td>prevent automatic conversion to grayscale inside coders that support
1788 grayscale. This should be accompanied by -type truecolor. PNG and TIF do
1789 not need this define. With PNG, just use PNG24:image. With TIF, just use
1790 -type truecolor. JPG and PSD will need this define.</td>
1791 </tr>
1792
1793 <tr>
1794 <td>complex:snr=<var>value</var></td>
1795 <td>Set the divide SNR constant<a href="command-line-options.html#complex">-complex</a></td>
1796 </tr>
1797
1798 <tr>
1799 <td>compose:args=<var>arguments</var></td>
1800 <td>Sets certain compose argument values when using convert ... -compose ...
Cristy1f1f3a02016-06-01 07:25:42 -04001801 -composite. See <a href="compose.html"
Cristy594d2772015-11-15 10:47:42 -05001802 >Image Composition</a></td>
Cristy882d9f42015-10-29 16:48:39 -04001803 </tr>
1804
1805 <tr>
1806 <td>compose:clamp=<var>on|off</var></td>
1807 <td>set each pixel whose value is below zero to zero and any the pixel whose value is above the quantum range to the quantum range (e.g. 65535) otherwise the pixel value remains unchanged. Define supported in ImageMagick 6.9.1-3 and above.</td>
1808 </tr>
1809
1810 <tr>
Cristyde27d762016-01-02 12:56:44 -05001811 <td>connected-components:area-threshold=<var>value</var></td>
1812 <td>Merges any region with area smaller than <var>value</var> into its surrounding region or largest neighbor.</td>
1813 </tr>
1814
1815 <tr>
1816 <td>connected-components:keep=<var>list-of-ids</var></td>
1817 <td>Command and/or hyphenated list of id values to keep in the output. Supported in Imagemagick 6.9.3-0.</td>
1818 </tr>
1819
1820 <tr>
1821 <td>connected-components:mean-color=<var>true</var></td>
1822 <td>Changes the output image from id values to mean color values. Supported in Imagemagick 6.9.2-8.</td>
1823 </tr>
1824
1825 <tr>
1826 <td>connected-components:remove=<var>list-of-ids</var></td>
1827 <td>Command and/or hyphenated list of id values to remove from the output. Supported in Imagemagick 6.9.2-9.</td>
1828 </tr>
1829
1830 <tr>
1831 <td>connected-components:verbose=<var>true</var></td>
1832 <td>Lists id, bounding box, centroid, area, mean color for each region.</td>
1833 </tr>
1834
1835 <tr>
Cristy882d9f42015-10-29 16:48:39 -04001836 <td>convolve:scale=<var>{kernel_scale}[!^] [,{origin_addition}] [%]</var></td>
1837 <td>Defines the kernel scaling. The special flag ! automatically scales to
1838 full dynamic range. The ! flag can be used in combination with a factor or
1839 percent. The factor or percent is then applied after the automatic scaling.
1840 An example is 50%!. This produces a result 50% darker than full dynamic
1841 range scaling. The ^ flag assures the kernel is 'zero-summing', for
1842 example when some values are positive and some are negative as in edge
1843 detection kernels. The origin addition adds that value to the center
1844 pixel of the kernel. This produces and effect that is like adding the image
1845 that many times to the result of the filtered image. The typical value
1846 is 1 so that the original image is added to the result of the convolution.
1847 The default is 0.</td>
1848 </tr>
1849
1850 <tr>
1851 <td>convolve:showkernel=<var>1</var></td>
Cristy594d2772015-11-15 10:47:42 -05001852 <td>Outputs (to 'standard error') all the information about a specified <a
1853 href="command-line-options.html#morphology" >-morphology convolve</a> kernel.</td>
Cristy882d9f42015-10-29 16:48:39 -04001854 </tr>
1855
1856 <tr>
1857 <td>dcm:display-range=<var>reset</var></td>
1858 <td>Sets the display range to the minimum and maximum pixel values for the
1859 DCM image format.</td>
1860 </tr>
1861
1862 <tr>
1863 <td>dds:cluster-fit=<var>true|false</var></td>
1864 <td>Enables the dds cluster-fit.</td>
1865 </tr>
1866
1867 <tr>
1868 <td>dds:compression=<var>dxt1|dxt5|none</var></td>
1869 <td>Sets the dds compression.</td>
1870 </tr>
1871
1872 <tr>
1873 <td>dds:mipmaps=<var>value</var></td>
1874 <td>Sets the dds number of mipmaps.</td>
1875 </tr>
1876
1877 <tr>
1878 <td>dds:weight-by-alpha=<var>true|false</var></td>
1879 <td>Enables the dds alpha weighting.</td>
1880 </tr>
1881
1882 <tr>
1883 <td>delegate:bimodal=<var>true</var></td>
1884 <td>Specifies direct conversion from Postscript to PDF.</td>
1885 </tr>
1886
1887 <tr>
1888 <td>distort:scale=<var>value</var></td>
Cristy594d2772015-11-15 10:47:42 -05001889 <td>Sets the output scaling factor for use with <a href="command-line-options.html#distort"
1890 >-distort</a></td>
Cristy882d9f42015-10-29 16:48:39 -04001891 </tr>
1892
1893 <tr>
1894 <td>distort:viewport=<var>WxH+X+Y</var></td>
1895 <td>Sets the viewport for use with <a href="command-line-options.html#distort">-distort</a></td>
1896 </tr>
1897
1898 <tr>
1899 <td>dot:layout-engine=<var>value</var></td>
1900 <td>Specifies the layout engine for the DOT image format (e.g.
1901 <code>neato</code>).</td>
1902 </tr>
1903
1904 <tr>
1905 <td>filter:option=<var>value</var></td>
1906 <td>Set a filter option for use with <a href="command-line-options.html#resize">-resize</a>.
1907 See <a href="command-line-options.html#filter">-filter</a> for details.</td>
1908 </tr>
1909
1910 <tr>
1911 <td>fourier:normalize=<var>inverse</var></td>
1912 <td>Sets the location for the FFT/IFT normalization as use by
1913 <a href="command-line-options.html#fft">+-fft</a> and <a href="command-line-options.html#ift">+-ift</a>. The default is
1914 <var>forward</var>.</td>
1915 </tr>
1916
1917 <tr>
1918 <td>h:format=<var>value</var></td>
1919 <td>Set the image encoding format use when writing a C-style header.
1920 <var>format</var> can be any output format supported by ImageMagick
1921 except for <var>h</var> and <var>magick</var></td>. If this
1922 option is omitted, the default is <var>GIF</var> for PseudoClass
1923 images and <var>PNM</var> for DirectClass images.
1924 </tr>
1925
1926 <tr>
1927 <td>icon:auto-resize</td>
1928 <td>Automatically stores multiple sizes when writing an ico image
1929 (requires a 256x256 input image).</td>
1930 </tr>
1931
1932 <tr>
1933 <td>jp2:layer-number=<var>value</var></td>
1934 <td>Sets the maximum number of quality layers to decode. Same for JPT, JC2,
1935 and J2K</td>
1936 </tr>
1937
1938 <tr>
1939 <td>jp2:number-resolutions=<var>value</var></td>
1940 <td>Sets the number of resolutions to encode.Same for JPT, JC2, and J2K</td>
1941 </tr>
1942
1943 <tr>
1944 <td>jp2:progression-order=<var>value</var></td>
1945 <td>choose from LRCP, RLCP, RPCL, PCRL or CPRL. Same for JPT, JC2, and
1946 J2K</td>
1947 </tr>
1948
1949 <tr>
1950 <td>jp2:quality=<var>value,value...</var></td>
1951 <td>Sets the quality layer PSNR, given in dB. The order is from left to
1952 right in ascending order. The default is a single lossless quality layer.
1953 Same for JPT, JC2, and J2K</td>
1954 </tr>
1955
1956 <tr>
1957 <td>jp2:rate=<var>value</var></td>
1958 <td>Specify the compression factor to use while writing JPEG-2000 files. The
1959 compression factor is the reciprocal of the compression ratio. The valid
1960 range is 0.0 to 1.0, with 1.0 indicating lossless compression. If defined,
1961 this value overrides the -quality setting. A quality setting of 75
1962 results in a rate value of 0.06641. Same for JPT, JC2, and J2K</td>
1963 </tr>
1964
1965 <tr>
1966 <td>jp2:reduce-factor=<var>value</var></td>
1967 <td>Sets the number of highest resolution levels to be discarded.Same for
1968 JPT, JC2, and J2K</td>
1969 </tr>
1970
1971 <tr>
1972 <td>jpeg:block-smoothing=<var>on|off</var></td>
Cristy594d2772015-11-15 10:47:42 -05001973 <td>&nbsp</td>
Cristy882d9f42015-10-29 16:48:39 -04001974 </tr>
1975
1976 <tr>
1977 <td>jpeg:colors=<var>value</var></td>
1978 <td>Set the desired number of colors and let the JPEG encoder do the
1979 quantizing.</td>
1980 </tr>
1981
1982 <tr>
1983 <td>jpeg:dct-method=<var>value</var></td>
1984 <td>Choose from <code>default</code>, <code>fastest</code>,
1985 <code>float</code>, <code>ifast</code>, and <code>islow</code>.</td>
1986 </tr>
1987
1988 <tr>
1989 <td>jpeg:extent=<var>value</var></td>
1990 <td>Restrict the maximum JPEG file size, for example <code>-define
1991 jpeg:extent=400KB</code>. The JPEG encoder will search for the highest
1992 compression quality level that results in an output file that does not
Cristye93be682015-11-26 09:07:51 -05001993 exceed the value. The <code>-quality</code> option also will be respected
1994 starting with version 6.9.2-5. Between 6.9.1-0 and 6.9.2-4, add -quality
1995 100 in order for the jpeg:extent to work properly. Prior to 6.9.1-0, the
1996 -quality setting was ignored.</td>
Cristy882d9f42015-10-29 16:48:39 -04001997 </tr>
1998
1999 <tr>
2000 <td>jpeg:fancy-upsampling=<var>on|off</var></td>
Cristy594d2772015-11-15 10:47:42 -05002001 <td>&nbsp</td>
Cristy882d9f42015-10-29 16:48:39 -04002002 </tr>
2003
2004 <tr>
2005 <td>jpeg:optimize-coding=<var>on|off</var></td>
Cristy594d2772015-11-15 10:47:42 -05002006 <td>&nbsp</td>
Cristy882d9f42015-10-29 16:48:39 -04002007 </tr>
2008
2009 <tr>
2010 <td>jpeg:q-table=<var>table</var></td>
Cristy594d2772015-11-15 10:47:42 -05002011 <td>&nbsp</td>
Cristy882d9f42015-10-29 16:48:39 -04002012 </tr>
2013
2014 <tr>
2015 <td>jpeg:sampling-factor=<var>sampling-factor-string</var></td>
Cristy594d2772015-11-15 10:47:42 -05002016 <td>&nbsp</td>
Cristy882d9f42015-10-29 16:48:39 -04002017 </tr>
2018
2019 <tr>
2020 <td>jpeg:size=<var>geometry</var></td>
2021 <td>Set the size hint of a JPEG image, for
2022 example, <code>-define jpeg:size=128x128</code>.
2023 It is most useful for increasing performance and reducing the memory
2024 requirements when reducing the size of a large JPEG image.</td>
2025 </tr>
2026
2027 <tr>
2028 <td>json:features</td>
2029 <td>includes features in verbose information</td>
2030 </tr>
2031
2032 <tr>
2033 <td>json:limit</td>
Cristy594d2772015-11-15 10:47:42 -05002034 <td>&nbsp</td>
Cristy882d9f42015-10-29 16:48:39 -04002035 </tr>
2036
2037 <tr>
2038 <td>json:locate</td>
Cristy594d2772015-11-15 10:47:42 -05002039 <td>&nbsp</td>
Cristy882d9f42015-10-29 16:48:39 -04002040 </tr>
2041
2042 <tr>
2043 <td>json:moments</td>
2044 <td>includes image moments in verbose information</td>
2045 </tr>
2046
2047 <tr>
2048 <td>magick:format=<var>value</var></td>
2049 <td>Set the image encoding format use when writing a C-style header.
2050 This is the same as "h:format=format" described above.</td>.
2051 </tr>
2052
2053 <tr>
2054 <td>mng:need-cacheoff</td>
2055 <td>turn playback caching off for streaming MNG.</td>
2056 </tr>
2057
2058 <tr>
2059 <td>morphology:compose=<var>compose-method</var></td>
Cristy594d2772015-11-15 10:47:42 -05002060 <td>Specifies how to merge results generated by multiple<a
2061 href="command-line-options.html#morphology" >-morphology</a> kernel. The default is none. One
Cristy882d9f42015-10-29 16:48:39 -04002062 typical value is 'lighten' as used, for example, with the sobel edge
2063 kernels. </td>
2064 </tr>
2065
2066 <tr>
2067 <td>morphology:showkernel=<var>1</var></td>
Cristy594d2772015-11-15 10:47:42 -05002068 <td>Outputs (to 'standard error') all the information about a generated <a
2069 href="command-line-options.html#morphology" >-morphology</a> kernel.</td>
Cristy882d9f42015-10-29 16:48:39 -04002070 </tr>
2071
2072 <tr>
2073 <td>pcl:fit-to-page=<var>true</var></td>
2074
Cristy594d2772015-11-15 10:47:42 -05002075 <tr>
Cristy882d9f42015-10-29 16:48:39 -04002076 <td>pdf:fit-page=<var>geometry</var></td>
2077 <td> geometry specifies the scaling dimensions for resizing when the PDF is
2078 being read. The geometry is either WxH{%} or page size. No offsets are
2079 allowed. (introduced in IM 6.8.8-8)</td>
2080 </tr>
2081
2082 <tr>
2083 <td>pdf:fit-to-page=<var>true</var></td>
Cristy594d2772015-11-15 10:47:42 -05002084 <td>&nbsp</td>
Cristy882d9f42015-10-29 16:48:39 -04002085 </tr>
2086
2087 <tr>
2088 <td>pdf:use-cropbox=<var>true</var></td>
Cristy594d2772015-11-15 10:47:42 -05002089 <td>&nbsp</td>
Cristy882d9f42015-10-29 16:48:39 -04002090 </tr>
2091
2092 <tr>
2093 <td>pdf:use-trimbox=<var>true</var></td>
Cristy594d2772015-11-15 10:47:42 -05002094 <td>&nbsp</td>
Cristy882d9f42015-10-29 16:48:39 -04002095 </tr>
2096
2097 <tr>
2098 <td>png:bit-depth=<var>value</var></td>
Cristy594d2772015-11-15 10:47:42 -05002099 <td>&nbsp</td>
Cristy882d9f42015-10-29 16:48:39 -04002100 </tr>
2101 <tr>
2102 <td>png:color-type=<var>value</var></td>
2103 <td>desired bit-depth and color-type for PNG output. You can force the PNG
2104 encoder to use a different bit-depth and color-type than it would have
2105 normally selected, but only if this does not cause any loss of image
2106 quality. Any attempt to reduce image quality is treated as an error and no
2107 PNG file is written. E.g., if you have a 1-bit black-and-white image, you
2108 can use these "defines" to cause it to be written as an 8-bit grayscale,
2109 indexed, or even a 64-bit RGBA. But if you have a 16-million color image,
2110 you cannot force it to be written as a grayscale or indexed PNG. If you
2111 wish to do this, you must use the appropriate <a href="command-line-options.html#depth">-depth</a>,
2112 <a href="command-line-options.html#colors">-colors</a>, or <a href="command-line-options.html#type">-type</a> directives to
2113 reduce the image quality prior to using the PNG encoder. Note that in
2114 indexed PNG files, "bit-depth" refers to the number of bits per index,
2115 which can be 1, 2, 4, or 8. In such files, the color samples always have
2116 8-bit depth.</td>
2117 </tr>
2118
2119 <tr>
2120 <td>png:compression-filter=<var>value</var></td>
2121 <td> valid values are 0 through 9. 0-4 are the corresponding PNG filters,
2122 5 means adaptive filtering except for images with a colormap, 6 means
2123 adaptive filtering for all images, 7 means MNG "loco" compression, 8 means
2124 Z_RLE strategy with adaptive filtering, and 9 means Z_RLE strategy with no
2125 filtering.</td>
2126 </tr>
2127
2128 <tr>
2129 <td>png:compression-level=<var>value</var></td>
2130 <td> valid values are 0 through 9, with 0 providing the least but fastest
2131 compression and 9 usually providing the best and always the slowest.</td>
2132 </tr>
2133
2134 <tr>
2135 <td>png:compression-strategy=<var>value</var></td>
2136 <td> valid values are 0 through 4, meaning default, filtered, huffman_only,
2137 rle, and fixed ZLIB compression strategy. If you are using an old zlib
2138 that does not support Z_RLE (before 1.2.0) or Z_FIXED (before 1.2.2.2),
2139 values 3 and 4, respectively, will use the zlib default strategy
2140 instead.</td>
2141 </tr>
2142
2143 <tr>
2144 <td>png:format=<var>value</var></td>
2145 <td> valid values are <var>png8</var>, <var>png24</var>,
2146 <var>png32</var>, <var>png48</var>,
2147 <var>png64</var>, and <var>png00</var>.
2148 This property can be useful for specifying
2149 the specific PNG format to be used, when the usual method of prepending the
2150 format name to the output filename is inconvenient, such as when writing
2151 a PNG-encoded ICO file or when using <a href="mogrify.html">mogrify</a>.
2152 Value = <var>png8</var> reduces the number of colors to 256,
2153 only one of which may be fully transparent, if necessary. The other
2154 values do not force any reduction of quality; it is an error to request
2155 a format that cannot represent the image data without loss (except that
2156 it is allowed to reduce the bit-depth from 16 to 8 for all formats).
2157 Value = <var>png24</var> and <var>png48</var>
2158 allow transparency, only if a single color is fully transparent and that
2159 color does not also appear in an opaque pixel; such transparency is
2160 written in a PNG <code>tRNS</code> chunk.
2161 Value = <var>png00</var> causes the image to inherit its
2162 color-type and bit-depth from the input image, if the input was also
2163 a PNG.</td>
2164 </tr>
2165
2166 <tr>
2167 <td>png:exclude-chunk=<var>value</var></td>
2168
Cristy594d2772015-11-15 10:47:42 -05002169 <tr>
Cristy882d9f42015-10-29 16:48:39 -04002170 <td>png:include-chunk=<var>value</var></td>
2171 <td>ancillary chunks to be excluded from or included in PNG output.
2172
2173 <p>The <var>value</var> can be the name of a PNG chunk-type such
2174 as <var>bKGD</var>, a comma-separated list of chunk-names
2175 (which can include the word <var>date</var>, the word
2176 <var>all</var>, or the word <var>none</var>).
2177 Although PNG chunk-names are case-dependent, you can use all lowercase
2178 names if you prefer.</p>
2179
2180 <p>The "include-chunk" and "exclude-chunk" lists only affect the behavior
2181 of the PNG encoder and have no effect on the PNG decoder.</p>
2182
2183 <p>As a special case, if the <code>sRGB</code> chunk is excluded and
2184 the <code>gAMA</code> chunk is included, the <code>gAMA</code> chunk will
2185 only be written if gamma is not 1/2.2, since most decoders assume
2186 sRGB and gamma=1/2.2 when no colorspace information is included in
2187 the PNG file. Because the list is processed from left to right, you
2188 can achieve this with a single define:</p>
2189
2190<pre>
2191-define png:include-chunk=none,gAMA
2192</pre>
2193
2194 <p>As a special case, if the <code>sRGB</code> chunk is not excluded and
2195 the PNG encoder recognizes that the image contains the sRGB ICC profile,
2196 the PNG encoder will write the <code>sRGB</code> chunk instead of the
2197 entire ICC profile. To force the PNG encoder to write the sRGB
2198 profile as an <code>iCCP</code> chunk in the output PNG instead of the
2199 <code>sRGB</code> chunk, exclude the <code>sRGB</code> chunk.</p>
2200
2201 <p>The critical PNG chunks <code>IHDR</code>, <code>PLTE</code>,
2202 <code>IDAT</code>, and <code>IEND</code> cannot be excluded. Any such
2203 entries appearing in the list will be ignored.</p>
2204
2205 <p>If the ancillary PNG <code>tRNS</code> chunk is excluded and the
2206 image has transparency, the PNG colortype is forced to be 4 or 6
2207 (GRAY_ALPHA or RGBA). If the image is not transparent, then the
2208 <code>tRNS</code> chunk isn't written anyhow, and there is no effect
2209 on the PNG colortype of the output image.</p>
2210
2211 <p>The <a href="command-line-options.html#strip">-strip</a> option does the equivalent of the
2212 following for PNG output:</p>
2213
2214<pre>
2215-define png:exclude-chunk=EXIF,iCCP,iTXt,sRGB,tEXt,zCCP,zTXt,date
2216</pre>
2217
2218 <p>The default behavior is to include all known PNG ancillary chunks
2219 plus ImageMagick's private <code>vpAg</code> ("virtual page") chunk,
2220 and to exclude all PNG chunks that are unknown to ImageMagick,
2221 regardless of their PNG "copy-safe" status as described in the
2222 PNG specification.</p>
2223
2224 <p>Any chunk names that are not known to ImageMagick are ignored
2225 if they appear in either the "include-chunk" or "exclude-chunk" list.
2226 The ancillary chunks currently known to ImageMagick are
2227 <code>bKGD</code>, <code>cHRM</code>, <code>gAMA</code>, <code>iCCP</code>,
2228 <code>oFFs</code>, <code>pHYs</code>, <code>sRGB</code>, <code>tEXt</code>,
2229 <code>tRNS</code>, <code>vpAg</code>, and <code>zTXt</code>.</p>
2230
2231 <p>You can also put <code>date</code> in the list to include or exclude
2232 the "Date:create" and "Date:modify" text chunks that ImageMagick normally
2233 inserts in the output PNG.</p></td>
2234 </tr>
2235
2236 <tr>
2237 <td>png:preserve-colormap[=<var>true</var>]</td>
Cristy594d2772015-11-15 10:47:42 -05002238 <td>Use the existing image->colormap. Normally the PNG encoder will
Cristy882d9f42015-10-29 16:48:39 -04002239 try to optimize the palette, eliminating unused entries and putting
2240 the transparent colors first. If this flag is set, that behavior
2241 is suppressed.</td>
2242 </tr>
2243
2244 <tr>
2245 <td>png:preserve-iCCP[=<var>true</var>]</td>
2246 <td>By default, the PNG decoder and encoder examine any ICC profile
2247 that is present, either from an <code>iCCP</code> chunk in the PNG
2248 input or supplied via an option, and if the profile is recognized
2249 to be the sRGB profile, converts it to the <code>sRGB</code> chunk.
2250 You can use <code>-define png:preserve-iCCP</code> to prevent
2251 this from happening; in such cases the <code>iCCP</code> chunk
2252 will be read or written and no <code>sRGB</code> chunk will be
2253 written. There are some ICC profiles that claim to be sRGB but
2254 have various errors that cause them to be rejected by libpng16; such
2255 profiles are recognized anyhow and converted to the <code>sRGB</code>
2256 chunk, but are rejected if the <code>-define png:preserve-iCCP</code>
2257 is present. Note that not all "sRGB" ICC profiles are recognized
2258 yet; we will add them to the list as we encounter them.</td>
2259 </tr>
2260
2261 <tr>
2262 <td>png:swap-bytes[=<var>true</var>]</td>
2263 <td>The PNG specification requires that any multi-byte integers be stored in
2264 network byte order (MSB-LSB endian). This option allows you to
2265 fix any invalid PNG files that have 16-bit samples stored incorrectly
2266 in little-endian order (LSB-MSB). The "-define png:swap-bytes" option
2267 must appear before the input filename on the commandline. The swapping
2268 is done during the libpng decoding operation.</td>
2269 </tr>
2270
2271 <tr>
2272 <td>profile:skip=<var>name1,name2,...</var></td>
2273 <td>Skip the named profile[s] when reading the image. Use skip="*" to
2274 skip all named profiles in the image. Many named profiles exist,
2275 including ICC, EXIF, APP1, IPTC, XMP, and others.</td>
2276 </tr>
2277
2278 <tr>
2279 <td>ps:imagemask</td>
2280 <td>If the ps:imagemask flag is defined, the PS3 and EPS3 coders will
2281 create Postscript files that render bilevel images with the Postscript
2282 imagemask operator instead of the image operator.</td>
2283 </tr>
2284
2285 <tr>
2286 <td>psd:alpha-unblend=off</td>
2287 <td>Disables new automatic un-blending of transparency with the base image
2288 for the flattened layer 0 before adding the alpha channel to the output
2289 image. This define must be placed before the input psd image. (Available
2290 as of IM 6.9.2.5). The automatic un-blending is new to IM 6.9.2.5 and
2291 prevents the transparency from being applied twice in the output
2292 image.</td>
2293 </tr>
2294
2295 <tr>
Cristy1f1f3a02016-06-01 07:25:42 -04002296 <td>preserve-timestamp=<var>{True, False}</var></td>
2297 <td>Preserve file timestamp (<code>mogrify</code> only).</td>
2298 </tr>
2299
2300 <tr>
Cristy882d9f42015-10-29 16:48:39 -04002301 <td>quantum:format=<var>type</var></td>
2302 <td>Set the type to <code>floating-point</code> to specify a floating-point
2303 format for raw files (e.g. GRAY:) or for MIFF and TIFF images in HDRI mode
2304 to preserve negative values. If <a href="command-line-options.html#depth">-depth</a> 16 is
2305 included, the result is a single precision floating point format.
2306 If <a href="command-line-options.html#depth">-depth</a> 32 is included, the result is
2307 double precision floating point format.</td>
2308 </tr>
2309
2310 <tr>
2311 <td>quantum:polarity=<var>photometric-interpretation</var></td>
2312 <td>Set the photometric-interpretation of an image (typically for TIFF image
2313 file format) to either <code>min-is-black</code> (default) or
2314 <code>min-is-white</code>.</td>
2315 </tr>
2316
2317 <tr>
2318 <td>sample:offset=<var>geometry</var></td>
2319 <td>Location of the sampling point within the sub-region being sampled,
Cristy594d2772015-11-15 10:47:42 -05002320 expressed as percentages (see <a href="command-line-options.html#sample" >-sample</a>).</td>
Cristy882d9f42015-10-29 16:48:39 -04002321 </tr>
2322
2323 <tr>
2324 <td>showkernel=<var>1</var></td>
Cristy594d2772015-11-15 10:47:42 -05002325 <td>Outputs (to 'standard error') all the information about a generated <a
2326 href="command-line-options.html#morphology" >-morphology</a> kernel.</td>
Cristy882d9f42015-10-29 16:48:39 -04002327 </tr>
2328
2329 <tr>
2330 <td>stream:buffer-size=<var>value</var></td>
2331 <td>Set the stream buffer size. Select 0 for unbuffered I/O.</td>
2332 </tr>
2333
2334 <tr>
2335 <td>tiff:alpha=<var>associated|unassociated|unspecified</var></td>
2336 <td>Specify the alpha extra samples as associated, unassociated or unspecified </td>
2337 </tr>
2338
2339 <tr>
2340 <td>tiff:endian=<var>msb|lsb</var></td>
Cristy594d2772015-11-15 10:47:42 -05002341 <td>&nbsp</td>
Cristy882d9f42015-10-29 16:48:39 -04002342 </tr>
2343
2344 <tr>
2345 <td>tiff:exif-properties=<var>false</var></td>
2346 <td>Skips reading the EXIF properties.</td>
2347 </tr>
2348
2349 <tr>
2350 <td>tiff:fill-order=<var>msb|lsb</var></td>
Cristy594d2772015-11-15 10:47:42 -05002351 <td>&nbsp</td>
Cristy882d9f42015-10-29 16:48:39 -04002352 </tr>
2353
2354 <tr>
2355 <td>tiff:ignore-layers=<var>true</var></td>
2356 <td>Ignores the photoshop layers.</td>
2357 </tr>
2358
2359 <tr>
2360 <td>tiff:ignore-tags=<var>comma-separate-list-of-tag-IDs</var></td>
2361 <td>Allows one or more tag ID values to be ignored.</td>
2362 </tr>
2363
2364 <tr>
2365 <td>tiff:rows-per-strip=<var>value</var></td>
2366 <td>Sets the number of rows per strip</td>
2367 </tr>
2368
2369 <tr>
2370 <td>tiff:tile-geometry=<var>WxH</var></td>
2371 <td>Sets the tile size for pyramid tiffs. Requires the suffix
2372 PTIF: before the outputname</td>
2373 </tr>
Cristye09ed312016-03-06 08:07:39 -05002374
2375 <tr>
2376 <td>type:features=<var>string</var></td>
2377 <td>&nbsp</td>
2378 </tr>
2379
2380 <tr>
2381 <td>type:hinting=<var>off</var></td>
2382 <td>&nbsp</td>
2383 </tr>
Cristy882d9f42015-10-29 16:48:39 -04002384</table>
2385
2386<p>For example, to create a postscript file that will render only the black
2387pixels of a bilevel image, use:</p>
2388
2389<pre>
2390convert bilevel.tif -define ps:imagemask eps3:stencil.ps
2391</pre>
2392
2393<p>Set attributes of the image registry by prefixing the value with
2394<code>registry:</code>. For example, to set a temporary path to put work files,
2395use:</p>
2396
2397<pre>
2398-define registry:temporary-path=/data/tmp
2399</pre>
2400
2401<div style="margin: auto;">
Cristy594d2772015-11-15 10:47:42 -05002402 <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 -04002403</div>
2404
2405<p class="magick-description">display the next image after pausing.</p>
2406
2407<p>This option is useful for regulating the animation of image sequences
2408<var>ticks/ticks-per-second</var> seconds must expire before the display of the
2409next image. The default is no delay between each showing of the image
2410sequence. The default ticks-per-second is 100.</p>
2411
2412<p>Use <code>&gt;</code> to change the image delay <var>only</var> if its current
2413value exceeds the given delay. <code>&lt;</code> changes the image delay
2414<var>only</var> if current value is less than the given delay. For example, if
2415you specify <code>30&gt;</code> and the image delay is 20, the image delay does
2416not change. However, if the image delay is 40 or 50, the delay it is changed
2417to 30. Enclose the given delay in quotation marks to prevent the
2418<code>&lt;</code> or <code>&gt;</code> from being interpreted by your shell as
2419a file redirection.</p>
2420
2421
2422<div style="margin: auto;">
2423 <h3 class="magick-header"><a id="delete"></a>-delete <var>indexes</var></h3>
2424</div>
2425
2426<p class="magick-description">delete the images specified by index, from the image sequence.</p>
2427
2428<p>Specify the image by its index in the sequence. The first image is index
24290. Negative indexes are relative to the end of the sequence, for example, -1
2430represents the last image of the sequence. Specify a range of images with
2431a dash (e.g. 0-4). Separate indexes with a comma (e.g. 0,2). Use
2432<code>+delete</code> to delete the last image in the current image sequence.</p>
2433
2434
2435<div style="margin: auto;">
Cristy594d2772015-11-15 10:47:42 -05002436 <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 -04002437</div>
2438
2439<p class="magick-description">Set the horizontal and vertical resolution of an image for rendering to devices.</p>
2440
2441<p>This option specifies the image resolution to store while encoding a raster
2442image or the canvas resolution while rendering (reading) vector formats such
2443as Postscript, PDF, WMF, and SVG into a raster image. Image resolution
2444provides the unit of measure to apply when rendering to an output device or
Cristy594d2772015-11-15 10:47:42 -05002445raster image. The default unit of measure is in dots per inch (DPI). The <a
2446href="command-line-options.html#units">-units</a> option may be used to select dots per centimeter
Cristy882d9f42015-10-29 16:48:39 -04002447instead.</p>
2448
2449<p>The default resolution is 72 dots per inch, which is equivalent to one
2450point per pixel (Macintosh and Postscript standard). Computer screens are
2451normally 72 or 96 dots per inch, while printers typically support 150, 300,
2452600, or 1200 dots per inch. To determine the resolution of your display, use
2453a ruler to measure the width of your screen in inches, and divide by the
2454number of horizontal pixels (1024 on a 1024x768 display).</p>
2455
2456<p>If the file format supports it, this option may be used to update the
2457stored image resolution. Note that Photoshop stores and obtains image
2458resolution from a proprietary embedded profile. If this profile is not
2459stripped from the image, then Photoshop will continue to treat the image using
2460its former resolution, ignoring the image resolution specified in the standard
2461file header.</p>
2462
2463<p>The <a href="command-line-options.html#density">-density</a> option sets an <var>attribute</var> and
2464does not alter the underlying raster image. It may be used to adjust the
2465rendered size for desktop publishing purposes by adjusting the scale applied
2466to the pixels. To resize the image so that it is the same size at a different
2467resolution, use the <a href="command-line-options.html#resample">-resample</a> option.</p>
2468
2469<div style="margin: auto;">
2470 <h3 class="magick-header"><a id="depth"></a>-depth <var>value</var></h3>
2471</div>
2472
2473<p class="magick-description">depth of the image.</p>
2474
2475<p>This the number of bits in a color sample within a pixel. Use this option
2476to specify the depth of raw images whose depth is unknown such as GRAY, RGB,
2477or CMYK, or to change the depth of any image after it has been read.</p>
2478
2479<div style="margin: auto;">
2480 <h3 class="magick-header"><a id="descend"></a>-descend</h3>
2481</div>
2482
2483<p class="magick-description">obtain image by descending window hierarchy.</p>
2484
2485<div style="margin: auto;">
Cristy769d8892016-01-19 18:11:14 -05002486 <h3 class="magick-header"><a id="deskew"></a>-deskew <var>threshold{%}</var></h3>
Cristy882d9f42015-10-29 16:48:39 -04002487</div>
2488
2489<p class="magick-description">straighten an image. A threshold of 40% works for most images.</p>
2490
2491<p>Use <a href="command-line-options.html#set">-set</a> <code>option:deskew:auto-crop
2492<var>width</var></code> to auto crop the image. The set argument is the pixel
2493width of the image background (e.g 40).</p>
2494
2495<div style="margin: auto;">
2496 <h3 class="magick-header"><a id="despeckle"></a>-despeckle</h3>
2497</div>
2498
2499<p class="magick-description">reduce the speckles within an image.</p>
2500
2501<div style="margin: auto;">
2502 <h3 class="magick-header"><a id="direction"></a>-direction <var>type</var></h3>
2503</div>
2504
2505<p class="magick-description">render text right-to-left or left-to-right.</p>
2506
2507<div style="margin: auto;">
Cristy769d8892016-01-19 18:11:14 -05002508 <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 -04002509</div>
2510
2511<p class="magick-description">shift image pixels as defined by a displacement map.</p>
2512
2513<p>With this option, the 'overlay' image, and optionally the 'mask' image,
2514is used as a displacement map, which is used to displace the lookup of
2515what part of the 'background' image is seen at each point of the overlaid
2516area. Much like the displacement map is a 'lens' that redirects light shining
2517through it so as to present a distorted view the original 'background' image
2518behind it. </p>
2519
2520<p>Any perfect grey areas of the displacement map produce a zero
2521displacement of the image. Black areas produce the given maximum negative
2522displacement of the lookup point, while white produce a maximum positive
2523displacement of the lookup. </p>
2524
2525<p>Note that it is the lookup of the 'background' that is displaced, not a
2526displacement of the image itself. As such an area of the displacement map
2527containing 'white' will have the lookup point 'shifted' by a positive amount,
2528and thus generating a copy of the destination image to the right/downward from
2529the correct position. That is the image will look like it may have been
2530'shifted' in a negative left/upward direction. Understanding this is a very
2531important in understanding how displacement maps work. </p>
2532
2533<p>The given arguments define the maximum amount of displacement in pixels
2534that a particular map can produce. If the displacement scale is large enough
2535it is also possible to lookup parts of the 'background' image that lie well
2536outside the bounds of the displacement map itself. That is you could very
2537easily copy a section of the original image from outside the overlay area
2538into the overlay area. </p>
2539
2540<p>The '%' flag makes the displacement scale relative to the size of the
2541overlay image (100% = half width/height of image). Using '!' switches
2542percentage arguments to refer to the destination image size instead.
2543these flags were added as of IM v6.5.3-5.</p>
2544
2545<p>Normally a single grayscale displacement map is provided, which with the
2546given scaling values will determine a single direction (vector) in which
2547displacements can occur (positively or negatively). However, if you also
2548specify a third image which is normally used as a <var>mask</var>,
2549the <var>composite image</var> is used for horizontal X
2550displacement, while the <var>mask image</var> is used for vertical Y
2551displacement. This allows you to define completely different displacement
2552values for the X and Y directions, and allowing you to lookup any point within
2553the <var>scale</var> bounds. In other words each pixel can lookup
2554any other nearby pixel, producing complex 2 dimensional displacements, rather
2555than a simple 1 dimensional vector displacements. </p>
2556
2557<p>Alternatively rather than supplying two separate images, as of IM v6.4.4-0,
2558you can use the 'red' channel of the overlay image to specify the horizontal
2559or X displacement, and the 'green' channel for the vertical or Y displacement.
2560</p>
2561
2562<p>As of IM v6.5.3-5 any alpha channel in the overlay image is used as a
2563mask the transparency of the destination image. However areas outside the
2564overlaid areas will not be effected. </p>
2565
2566
2567<div style="margin: auto;">
2568 <h3 class="magick-header"><a id="display"></a>-display <var>host:display[.screen]</var></h3>
2569</div>
2570
2571<p class="magick-description">Specifies the X server to contact.</p>
2572
2573<p>This option is used with convert for obtaining image or font from this
2574X server. See <var>X(1)</var>.</p>
2575
2576<div style="margin: auto;">
2577 <h3 class="magick-header"><a id="dispose"></a>-dispose <var>method</var></h3>
2578</div>
2579
2580<p class="magick-description">define the GIF disposal image setting for images that are being created or read in. </p>
2581
2582<p>The layer disposal method defines the way each the displayed image is to be
2583modified after the current 'frame' of an animation has finished being
2584displayed (after its 'delay' period), but before the next frame on an
2585animation is to be overlaid onto the display. </p>
2586
2587<p>Here are the valid methods:</p>
2588
2589<dl class="dl-horizontal">
2590<dt>Undefined</dt><dd>0: No disposal specified (equivalent to '<code>none</code>').</dd>
2591<dt>None</dt><dd>1: Do not dispose, just overlay next frame image.</dd>
2592<dt>Background</dt><dd>2: Clear the frame area with the background color.</dd>
2593<dt>Previous</dt><dd>3: Clear to the image prior to this frames overlay.</dd>
2594</dl>
2595
2596<p>You can also use the numbers given above, which is what the GIF format
2597uses internally to represent the above settings. </p>
2598
2599<p>To print a complete list of dispose methods, use <a href="command-line-options.html#list">-list dispose</a>.</p>
2600
Cristy594d2772015-11-15 10:47:42 -05002601<p>Use <a href="command-line-options.html#dispose" >+dispose</a>, turn off the setting and prevent
Cristy882d9f42015-10-29 16:48:39 -04002602resetting the layer disposal methods of images being read in. </p>
2603
2604<p>Use <a href="command-line-options.html#set">-set</a> '<code>dispose</code>' method to set the image
2605disposal method for images already in memory.</p>
2606
2607<div style="margin: auto;">
2608 <h3 class="magick-header"><a id="dissimilarity-threshold"></a>-dissimilarity-threshold <var>value</var></h3>
2609</div>
2610
2611<p class="magick-description">maximum RMSE for subimage match (default 0.2).</p>
2612
2613
2614<div style="margin: auto;">
2615 <h3 class="magick-header"><a id="dissolve"></a>-dissolve <var>src_percent</var>[x<var>dst_percent</var>]</h3>
2616</div>
2617
2618<p class="magick-description">dissolve an image into another by the given percent.</p>
2619
2620<p>The opacity of the composite image is multiplied by the given percent, then
2621it is composited 'over' the main image. If <var>src_percent</var>
2622is greater than 100, start dissolving the main image so it becomes
2623transparent at a value of '<code>200</code>'. If both percentages
2624are given, each image are dissolved to the percentages given. </p>
2625
2626<p>Note that dissolve percentages do not add, two opaque images dissolved
2627'50,50', produce a 75% transparency. For a 50% + 50% blending of the two
2628images, you would need to use dissolve values of '50,100'. </p>
2629
2630<div style="margin: auto;">
2631 <h3 class="magick-header"><a id="distort"></a>-distort <var>method arguments</var></h3>
2632</div>
2633
2634<p class="magick-description">distort an image, using the given <var>method</var> and its required <var>arguments</var>.</p>
2635
2636<p>The <var>arguments</var> is a single string containing a list
2637of floating point numbers separated by commas or spaces. The number of
2638and meaning of the floating point values depends on the distortion <var>method</var> being used. </p>
2639
2640<p>Choose from these distortion types:</p>
2641
2642<table class="table table-condensed table-striped">
2643 <tr>
2644 <th style="width: 8%">Method</th>
2645 <th>Description</th>
2646 </tr>
2647
2648 <tr>
Cristy594d2772015-11-15 10:47:42 -05002649 <td>ScaleRotateTranslate <br/> SRT</td>
Cristy882d9f42015-10-29 16:48:39 -04002650 <td>
2651 Distort image by first scaling and rotating about a given 'center',
2652 before translating that 'center' to the new location, in that order. It
2653 is an alternative method of specifying a 'Affine' type of
2654 distortion, but without shearing effects. It also provides a good way
2655 of rotating and displacing a smaller image for tiling onto a larger
Cristy594d2772015-11-15 10:47:42 -05002656 background (IE 2-dimensional animations). <br/>
Cristy882d9f42015-10-29 16:48:39 -04002657
2658 The number of arguments determine the specific meaning of each
Cristy594d2772015-11-15 10:47:42 -05002659 argument for the scales, rotation, and translation operations. <br/>
Cristy882d9f42015-10-29 16:48:39 -04002660
2661 <dl class="dl-horizontal">
2662 <dt>2:</dt><dd><var>Scale Angle</var></dd>
2663 <dt>3:</dt><dd><var>X,Y Angle</var></dd>
2664 <dt>4:</dt><dd><var>X,Y Scale Angle</var></dd>
2665 <dt>5:</dt> <dd><var>X,Y ScaleX,ScaleY Angle</var></dd>
2666 <dt>6:</dt> <dd><var>X,Y Scale Angle NewX,NewY</var></dd>
2667 <dt>7:</dt> <dd><var>X,Y ScaleX,ScaleY Angle NewX,NewY</var></dd>
2668 </dl>
2669
2670 This is actually an alternative way of specifying a 2 dimensional linear
2671 'Affine' or 'AffineProjection' distortion. </td> </tr>
2672
2673 <tr>
2674 <td>Affine</td>
2675 <td>
2676 Distort the image linearly by moving a list of at least 3 or more sets
2677 of control points (as defined below). Ideally 3 sets or 12 floating
2678 point values are given allowing the image to be linearly scaled,
2679 rotated, sheared, and translated, according to those three points. See
2680 also the related 'AffineProjection' and 'SRT'
Cristy594d2772015-11-15 10:47:42 -05002681 distortions. <br/>
Cristy882d9f42015-10-29 16:48:39 -04002682
2683 More than 3 sets given control point pairs (12 numbers) is least
2684 squares fitted to best match a linear affine distortion. If only 2
2685 control point pairs (8 numbers) are given a two point image translation
2686 rotation and scaling is performed, without any possible shearing,
2687 flipping or changes in aspect ratio to the resulting image. If only one
2688 control point pair is provides the image is only translated, (which may
Cristy594d2772015-11-15 10:47:42 -05002689 be a floating point non-integer translation). <br/>
Cristy882d9f42015-10-29 16:48:39 -04002690
2691 This distortion does not include any form of perspective distortion.
2692 </td>
2693
2694 </tr>
2695
2696 <tr>
2697 <td>AffineProjection</td>
2698 <td>
2699 Linearly distort an image using the given Affine Matrix of 6
2700 pre-calculated coefficients forming a set of Affine Equations to map
2701 the source image to the destination image.
2702
2703 <p class="text-center"><var>
2704 s<sub>x</sub>, r<sub>x</sub>,
2705 r<sub>y</sub>, s<sub>y</sub>,
2706 t<sub>x</sub>, t<sub>y</sub>
2707 </var></p>
2708
Cristy594d2772015-11-15 10:47:42 -05002709 See <a href="command-line-options.html#affine" >-affine</a> setting for more detail, and
2710 meanings of these coefficients. <br/>
Cristy882d9f42015-10-29 16:48:39 -04002711
2712 The distortions 'Affine' and 'SRT' provide
2713 alternative methods of defining this distortion, with ImageMagick doing
2714 the calculations needed to generate the required coefficients. You can
Cristy594d2772015-11-15 10:47:42 -05002715 see the internally generated coefficients, by using a <a
2716 href="command-line-options.html#verbose" >-verbose</a> setting with those other variants. </td>
Cristy882d9f42015-10-29 16:48:39 -04002717
2718 </tr>
2719
2720 <tr>
Cristy594d2772015-11-15 10:47:42 -05002721 <td>BilinearForward<br/>
Cristy882d9f42015-10-29 16:48:39 -04002722 BilinearReverse</td>
2723 <td>
2724 Bilinear Distortion, given a minimum of 4 sets of coordinate pairs, or
2725 16 values (see below). Not that lines may not appear straight after
2726 distortion, though the distance between coordinates will remain
Cristy594d2772015-11-15 10:47:42 -05002727 consistent. <br/>
Cristy882d9f42015-10-29 16:48:39 -04002728
2729 The 'BilinearForward' is used to map rectangles to any
2730 quadrilateral, while the 'BilinearReverse' form maps any
2731 quadrilateral to a rectangle, while preserving the straight line edges
Cristy594d2772015-11-15 10:47:42 -05002732 in each case. <br/>
Cristy882d9f42015-10-29 16:48:39 -04002733
2734 Note that 'BilinearForward' can generate invalid pixels
Cristyf650f4f2016-04-01 10:53:07 -04002735 which will be colored using the <a href="command-line-options.html#alpha-color" >-alpha-color</a>
Cristy882d9f42015-10-29 16:48:39 -04002736 color setting. Also if the quadrilateral becomes 'flipped' the image
Cristy594d2772015-11-15 10:47:42 -05002737 may disappear. <br/>
Cristy882d9f42015-10-29 16:48:39 -04002738
2739 There are future plans to produce a true Bilinear distortion that will
2740 attempt to map any quadrilateral to any other quadrilateral, while
2741 preserving edges (and edge distance ratios).
2742
2743 </td>
2744 </tr>
2745
2746 <tr>
2747 <td>Perspective</td>
2748 <td>
2749 Perspective distort the images, using a list of 4 or more sets of
2750 control points (as defined below). More that 4 sets (16 numbers) of
2751 control points provide least squares fitting for more accurate
2752 distortions (for the purposes of image registration and panorama
2753 effects). Less than 4 sets will fall back to a 'Affine'
Cristy594d2772015-11-15 10:47:42 -05002754 linear distortion. <br/>
Cristy882d9f42015-10-29 16:48:39 -04002755
2756 Perspective Distorted images ensures that straight lines remain
2757 straight, but the scale of the distorted image will vary. The horizon
2758 is anti-aliased, and the 'sky' color may be set using the
Cristyf650f4f2016-04-01 10:53:07 -04002759 <a href="command-line-options.html#alpha-color" >-alpha-color</a> setting. </td>
Cristy882d9f42015-10-29 16:48:39 -04002760 </tr>
2761
2762 <tr>
2763 <td>PerspectiveProjection </td>
2764 <td>
2765 Do a 'Perspective' distortion biased on a set of 8
2766 pre-calculated coefficients. You can get these coefficients by looking
Cristy594d2772015-11-15 10:47:42 -05002767 at the <a href="command-line-options.html#verbose" >-verbose</a> output of a
Cristy882d9f42015-10-29 16:48:39 -04002768 'Perspective' distortion, or by calculating them yourself.
2769 If the last two perspective scaling coefficients are zero, the
2770 remaining 6 represents a transposed 'Affine Matrix'. </td>
2771
2772 </tr>
2773
2774 <tr>
2775 <td>Arc</td>
2776 <td>
2777 Arc the image (variation of polar mapping) over the angle given around
2778 a circle.
2779
Cristy594d2772015-11-15 10:47:42 -05002780 <p><dl class="dl-horizontal">
Cristy882d9f42015-10-29 16:48:39 -04002781 <dt>arc_angle</dt>
2782 <dd>The angle over which to arc the image side-to-side</dd>
2783 <dt>rotate_angle</dt>
2784 <dd>Angle to rotate resulting image from vertical center</dd>
2785 <dt>top_radius</dt>
2786 <dd>Set top edge of source image at this radius</dd>
2787 <dt>bottom_radius </dt>
2788 <dd>Set bottom edge to this radius (radial scaling)</dd>
Cristy594d2772015-11-15 10:47:42 -05002789 </dl></p>
Cristy882d9f42015-10-29 16:48:39 -04002790
2791 The resulting image is always resized to best fit the resulting image,
Cristy594d2772015-11-15 10:47:42 -05002792 (as if using <a href="command-line-options.html#distort" >+distort</a>) while attempting to
Cristy882d9f42015-10-29 16:48:39 -04002793 preserve scale and aspect ratio of the original image as much as
2794 possible with the arguments given by the user. All four arguments will
Cristy594d2772015-11-15 10:47:42 -05002795 be needed to change the overall aspect ratio of an 'Arc'ed image. <br/>
Cristy882d9f42015-10-29 16:48:39 -04002796
2797 This a variation of a polar distortion designed to try to preserve the
2798 aspect ratio of the image rather than direct Cartesian to Polar
2799 conversion. </td>
2800 </tr>
2801
2802 <tr>
2803 <td>Polar</td>
2804 <td>
2805 Like 'Arc' but do a complete Cartesian to Polar mapping of
2806 the image. that is the height of the input image is mapped to the
2807 radius limits, while the width is wrapped around between the
Cristy594d2772015-11-15 10:47:42 -05002808 angle limits. <br/>
Cristy882d9f42015-10-29 16:48:39 -04002809
Cristy594d2772015-11-15 10:47:42 -05002810 Arguments: <var>Rmax,Rmin CenterX,CenterY, start,end_angle</var> <br/>
Cristy882d9f42015-10-29 16:48:39 -04002811
2812 All arguments are optional. With <var>Rmin</var> defaulting to zero, the
2813 center to the center of the image, and the angles going from -180 (top)
2814 to +180 (top). If <var>Rmax</var> is given the special value of
2815 '0', the the distance from the center to the nearest edge
2816 is used for the radius of the output image, which will ensure the whole
2817 image is visible (though scaled smaller). However a special value of
2818 '-1' will use the distance from the center to the furthest
2819 corner, This may 'clip' the corners from the input rectangular image,
2820 but will generate the exact reverse of a 'DePolar' with
Cristy594d2772015-11-15 10:47:42 -05002821 the same arguments. <br/>
Cristy882d9f42015-10-29 16:48:39 -04002822
Cristy594d2772015-11-15 10:47:42 -05002823 If the plus form of distort (<a href="command-line-options.html#distort" >+distort</a>) is used
Cristy882d9f42015-10-29 16:48:39 -04002824 output image center will default to 0,0 of the virtual
2825 canvas, and the image size adjusted to ensure the whole input image is
2826 made visible in the output image on the virtual canvas. </td>
2827
2828 </tr>
2829
2830 <tr>
2831 <td>DePolar</td>
2832 <td>
2833 Uses the same arguments and meanings as a 'Polar' distortion
Cristy594d2772015-11-15 10:47:42 -05002834 but generates the reverse Polar to Cartesian distortion. <br/>
Cristy882d9f42015-10-29 16:48:39 -04002835
2836 The special <var>Rmax</var> setting of '0' may however clip
2837 the corners of the input image. However using the special
2838 <var>Rmax</var> setting of '-1' (maximum center to corner
2839 distance) will ensure the whole distorted image is preserved in the
2840 generated result, so that the same argument to 'Polar' will
2841 reverse the distortion re-producing the original.
2842
2843 Note that as this distortion requires the area resampling of a circular
2844 arc, which can not be handled by the builtin EWA resampling function.
2845 As such the normal EWA filters are turned off. It is recommended some
2846 form of 'super-sampling' image processing technique be used to produce
2847 a high quality result. </td>
2848
2849 </tr>
2850
2851 <tr>
2852 <td>Barrel</td>
2853 <td>
Cristy594d2772015-11-15 10:47:42 -05002854 Given the four coefficients (A,B,C,D) as defined by <a
2855 href="http://wiki.panotools.org/Lens_correction_model" >Helmut
Cristy882d9f42015-10-29 16:48:39 -04002856 Dersch</a>, perform a barrel or pin-cushion distortion appropriate to
2857 correct radial lens distortions. That is in photographs, make straight
Cristy594d2772015-11-15 10:47:42 -05002858 lines straight again. <br/>
Cristy882d9f42015-10-29 16:48:39 -04002859
2860 <p class="text-center">Arguments: <var>A B C</var> [ <var>D</var> [
Cristy594d2772015-11-15 10:47:42 -05002861 <var>X</var> , <var>Y</var> ] ] <br/>
Cristy882d9f42015-10-29 16:48:39 -04002862 or <var>A<sub>x</sub> B<sub>x</sub> C<sub>x</sub> D<sub>x</sub>
2863 A<sub>y</sub> B<sub>y</sub> C<sub>y</sub> D<sub>y</sub></var>
2864 [ <var>X</var> , <var>Y</var> ] </p>
2865 So that it forms the function
2866 <p class="text-center">Rsrc = r * ( <var>A</var>*r<sup>3</sup> + <var>B</var>*r<sup>2</sup> +
2867 <var>C</var>*r + <var>D</var> )</p>
2868
2869 Where <var>X</var>,<var>Y</var> is the optional center of the distortion
Cristy594d2772015-11-15 10:47:42 -05002870 (defaulting to the center of the image). <br/>
Cristy882d9f42015-10-29 16:48:39 -04002871 The second form is typically used to distort images, rather than
Cristy594d2772015-11-15 10:47:42 -05002872 correct lens distortions. <br/>
Cristy882d9f42015-10-29 16:48:39 -04002873 </td>
2874
2875 </tr>
2876
2877 <tr>
2878 <td>BarrelInverse</td>
2879 <td>
2880 This is very similar to 'Barrel' with the same set of
2881 arguments, and argument handling. However it uses the inverse
2882 of the radial polynomial,
2883 so that it forms the function
2884 <p class="text-center">Rsrc = r / ( <var>A</var>*r<sup>3</sup> + <var>B</var>*r<sup>2</sup> +
2885 <var>C</var>*r + <var>D</var> )</p>
2886 Note that this is not the reverse of the 'Barrel'
2887 distortion, just a different barrel-like radial distortion method.
2888
2889 </td>
2890 </tr>
2891
2892 <tr>
2893 <td>Shepards</td>
2894 <td>
2895 Distort the given list control points (any number) using an Inverse
Cristy594d2772015-11-15 10:47:42 -05002896 Squared Distance Interpolation Method (<a
2897 href="http://en.wikipedia.org/wiki/Shepard%27s_method" >Shepards
Cristy882d9f42015-10-29 16:48:39 -04002898 Method</a>). The control points in effect do 'localized' displacement
2899 of the image around the given control point (preserving the look and
2900 the rotation of the area near the control points. For best results
2901 extra control points should be added to 'lock' the positions of the
2902 corners, edges and other unchanging parts of the image, to prevent
Cristy594d2772015-11-15 10:47:42 -05002903 their movement. <br/>
Cristy882d9f42015-10-29 16:48:39 -04002904
2905 The distortion has been likened to 'taffy pulling' using nails, or
2906 pins' stuck in a block of 'jelly' which is then moved to the new
Cristy594d2772015-11-15 10:47:42 -05002907 position, distorting the surface of the jelly. <br/>
Cristy882d9f42015-10-29 16:48:39 -04002908
Cristy594d2772015-11-15 10:47:42 -05002909 Internally it is equivalent to generating a displacement map (see <a
2910 href="command-line-options.html#displace" >-displace</a>) for source image color look-up using
2911 the <a href="command-line-options.html#sparse-color" >-sparse-color</a> method of the same name.
Cristy882d9f42015-10-29 16:48:39 -04002912
2913 </td>
2914 </tr>
2915
2916</table>
2917
2918<p>To print a complete list of distortion methods, use <a href="command-line-options.html#list">-list
2919distort</a>.</p>
2920
2921<p>Many of the above distortion methods such as '<code>Affine</code>',
2922'<code>Perspective</code>', and '<code>Shepards</code>' use a list control points
2923defining how these points in the given image should be distorted in the
2924destination image. Each set of four floating point values represent a source
2925image coordinate, followed immediately by the destination image coordinate.
2926This produces a list of values such as...</p>
2927<p class="text-center"><var>
2928 U<sub>1</sub>,V<sub>1</sub> X<sub>1</sub>,Y<sub>1</sub>
2929 U<sub>2</sub>,V<sub>2</sub> X<sub>2</sub>,Y<sub>2</sub>
2930 U<sub>3</sub>,V<sub>3</sub> X<sub>3</sub>,Y<sub>3</sub>
2931 ...
2932 U<sub>n</sub>,V<sub>n</sub> X<sub>n</sub>,Y<sub>n</sub>
2933</var></p>
2934<p>where <var>U,V</var> on the source image is mapped to <var>X,Y</var> on the
2935destination image. </p>
2936
2937<p>For example, to warp an image using '<code>perspective</code>' distortion,
2938needs a list of at least 4 sets of coordinates, or 16 numbers. Here is the
2939perspective distortion of the built-in "rose:" image. Note how spaces were
2940used to group the 4 sets of coordinate pairs, to make it easier to read and
2941understand.</p>
2942
2943<pre>
2944convert rose: -virtual-pixel black \
2945 -distort Perspective '0,0,0,0 0,45,0,45 69,0,60,10 69,45,60,35' \
2946 rose_3d_rotated.gif"
2947</pre>
2948
2949<p>If more that the required number of coordinate pairs are given for
2950a distortion, the distortion method is 'least squares' fitted to produce the
2951best result for all the coordinate pairs given. If less than the ideal number
2952of points are given, the distort will generally fall back to a simpler form of
2953distortion that can handles the smaller number of coordinates (usually a linear
2954'<code>Affine</code>' distortion). </p>
2955
2956<p>By using more coordinates you can make use of image registration tool to
2957find matching coordinate pairs in overlapping images, so as to improve the
2958'fit' of the distortion. Of course a bad coordinate pair can also make the
2959'fit' worse. Caution is always advised. </p>
2960
2961<p>Colors are acquired from the source image according to a cylindrical
Cristy594d2772015-11-15 10:47:42 -05002962resampling <a href="command-line-options.html#filter" >-filter</a>, using a special technique known as
Cristy882d9f42015-10-29 16:48:39 -04002963EWA resampling. This produces very high quality results, especially when
2964images become smaller (minified) in the output, which is very common when
2965using '<code>perspective</code>' distortion. For example here we view
2966a infinitely tiled 'plane' all the way to the horizon. </p>
2967
2968<pre>
2969convert -size 90x90 pattern:checkerboard -normalize -virtual-pixel tile \
2970 -distort perspective '0,0,5,45 89,0,45,46 0,89,0,89 89,89,89,89' \
2971 checks_tiled.jpg
2972</pre>
2973
2974<p>Note that a infinitely tiled perspective images involving the horizon can
2975be very slow, because of the number of pixels that are compressed to generate
2976each individual pixel close to the 'horizon'. You can turn off EWA
Cristy594d2772015-11-15 10:47:42 -05002977resampling, by specifying the special <a href="command-line-options.html#filter" >-filter</a> setting of
Cristy882d9f42015-10-29 16:48:39 -04002978'<code>point</code>' (recommended if you plan to use super-sampling instead).
2979</p>
2980
2981<p>If an image generates <i>invalid pixels</i>, such as the 'sky' in the last
Cristy594d2772015-11-15 10:47:42 -05002982example, <a href="command-line-options.html#distort" >-distort</a> will use the current <a
Cristyf650f4f2016-04-01 10:53:07 -04002983href="command-line-options.html#alpha-color" >-alpha-color</a> setting for these pixels. If you do not
Cristy882d9f42015-10-29 16:48:39 -04002984what these pixels to be visible, set the color to match the rest of the
2985ground. </p>
2986
2987<p>The output image size will by default be the same as the input image. This
2988means that if the part of the distorted image falls outside the viewed area of
2989the 'distorted space', those parts is clipped and lost. However if you use
Cristy594d2772015-11-15 10:47:42 -05002990the plus form of the operator (<a href="command-line-options.html#distort" >+distort</a>) the operator
Cristy882d9f42015-10-29 16:48:39 -04002991will attempt (if possible) to show the whole of the distorted image, while
2992retaining a correct 'virtual canvas' offset, for image layering. This offset
Cristy594d2772015-11-15 10:47:42 -05002993may need to be removed using <a href="command-line-options.html#repage" >+repage</a>, to remove if it
Cristy882d9f42015-10-29 16:48:39 -04002994is unwanted. </p>
2995
Cristy594d2772015-11-15 10:47:42 -05002996<p>Setting <a href="command-line-options.html#verbose" >-verbose</a> setting, will cause <a
2997href="command-line-options.html#distort" >-distort</a> to attempt to output the internal coefficients,
2998and the <a href="command-line-options.html#fx" >-fx</a> equivalent to the distortion, for expert study,
Cristy882d9f42015-10-29 16:48:39 -04002999and debugging purposes. This many not be available for all distorts. </p>
3000
Cristy594d2772015-11-15 10:47:42 -05003001<p>You can alternatively specify a special "<code><a href="command-line-options.html#define"
3002>-define</a> distort:viewport={geometry_string}</code>" setting which will
Cristy882d9f42015-10-29 16:48:39 -04003003specify the size and the offset of the generated 'viewport' image of the
3004distorted image space.</p>
3005
Cristy594d2772015-11-15 10:47:42 -05003006<p>Setting a "<code><a href="command-line-options.html#define" >-define</a>
Cristy769d8892016-01-19 18:11:14 -05003007distort:scale=<var>scale_factor</var></code>" will scale the output image (viewport or
Cristy882d9f42015-10-29 16:48:39 -04003008otherwise) by that factor without changing the viewed contents of the
3009distorted image. This can be used either for 'super-sampling' the image for
3010a higher quality result, or for panning and zooming around the image (with
3011appropriate viewport changes, or post-distort cropping and resizing). </p>
3012
Cristy594d2772015-11-15 10:47:42 -05003013<p>Setting "<code><a href="command-line-options.html#define" >-define</a> resample:verbose=1</code>"
Cristy882d9f42015-10-29 16:48:39 -04003014will output the cylindrical filter lookup table created by the EWA (Elliptical
3015Weighted Average) resampling algorithm. Note this table uses a squared radius
3016lookup value. This is typically only used for debugging EWA resampling. </p>
3017
3018
3019<div style="margin: auto;">
3020 <h3 class="magick-header"><a id="distribute-cache"></a>-distribute-cache <var>port</var></h3>
3021</div>
3022
3023<p class="magick-description">launch a distributed pixel cache server. </p>
3024
3025<div style="margin: auto;">
3026 <h3 class="magick-header"><a id="dither"></a>-dither <var>method</var></h3>
3027</div>
3028
3029<p class="magick-description">Apply a Riemersma or Floyd-Steinberg error diffusion dither to
3030images when general color reduction is applied via an option, or automagically
3031when saving to specific formats. This enabled by default.</p>
3032
3033<p>Dithering places two or more colors in neighboring pixels so that to the
3034eye a closer approximation of the images original color is reproduced. This
3035reduces the number of colors needed to reproduce the image but at the cost of
3036a lower level pattern of colors. Error diffusion dithers can use any set of
3037colors (generated or user defined) to an image. </p>
3038
3039<p>Dithering is turned on by default, to turn it off use the plus form of the
3040setting, <a href="command-line-options.html#dither">+dither</a>. This will also also render PostScript
3041without text or graphic aliasing. Disabling dithering often (but not always)
3042leads to faster process, a smaller number of colors, but more cartoon like
3043image coloring. Generally resulting in 'color banding' effects in areas with
3044color gradients. </p>
3045
Cristy594d2772015-11-15 10:47:42 -05003046<p>The color reduction operators <a href="command-line-options.html#colors">-colors</a>, <a
3047href="command-line-options.html#monochrome">-monochrome</a>, <a href="command-line-options.html#remap ">-remap</a>, and <a
3048href="command-line-options.html#posterize">-posterize</a>, apply dithering to images using the reduced
Cristy882d9f42015-10-29 16:48:39 -04003049color set they created. These operators are also used as part of automatic
3050color reduction when saving images to formats with limited color support, such
3051as <code>GIF:</code>, <code>XBM:</code>, and others, so dithering may also be used
3052in these cases. </p>
3053
3054<p>Alternatively you can use <a href="command-line-options.html#random-threshold">-random-threshold</a>
Cristy594d2772015-11-15 10:47:42 -05003055to generate purely random dither. Or use <a
3056href="command-line-options.html#ordered-dither">-ordered-dither</a> to apply threshold mapped dither
Cristy882d9f42015-10-29 16:48:39 -04003057patterns, using uniform color maps, rather than specific color maps. </p>
3058
3059
3060<div style="margin: auto;">
3061 <h3 class="magick-header"><a id="draw"></a>-draw <var>string</var></h3>
3062</div>
3063
3064<p class="magick-description">Annotate an image with one or more graphic primitives.</p>
3065
3066<p>Use this option to annotate or decorate an image with one or more graphic
3067primitives. The primitives include shapes, text, transformations, and pixel
3068operations.</p>
3069
3070<p>The shape primitives:</p>
3071
3072<dl class="dl-horizontal">
3073<dt>point</dt><dd> x,y</dd>
3074<dt>line</dt><dd> x0,y0 x1,y1</dd>
3075<dt>rectangle</dt><dd> x0,y0 x1,y1</dd>
3076<dt>roundRectangle</dt><dd> x0,y0 x1,y1 wc,hc</dd>
3077<dt>arc</dt><dd> x0,y0 x1,y1 a0,a1</dd>
3078<dt>ellipse</dt><dd> x0,y0 rx,ry a0,a1</dd>
3079<dt>circle</dt><dd> x0,y0 x1,y1</dd>
3080<dt>polyline</dt><dd> x0,y0 ... xn,yn</dd>
3081<dt>polygon</dt><dd> x0,y0 ... xn,yn</dd>
3082<dt>bezier</dt><dd> x0,y0 ... xn,yn</dd>
3083<dt>path</dt><dd>specification </dd>
3084<dt>image</dt><dd> operator x0,y0 w,h filename</dd>
3085</dl>
3086
3087<p>The text primitive:</p>
3088
3089<dl class="dl-horizontal">
3090<dt>text</dt><dd>x0,y0 string</dd>
3091</dl>
3092<p>The text gravity primitive:</p>
3093
3094<dl class="dl-horizontal">
3095<dt>gravity</dt><dd>NorthWest, North, NorthEast, West, Center, East, SouthWest, South, or SouthEast</dd>
3096</dl>
3097
3098<p>The text gravity primitive only affects the placement of text and does not
Cristy594d2772015-11-15 10:47:42 -05003099interact with the other primitives. It is equivalent to using the <a
3100href="command-line-options.html#gravity">-gravity</a> command-line option, except that it is limited in
Cristy882d9f42015-10-29 16:48:39 -04003101scope to the <a href="command-line-options.html#draw">-draw</a> option in which it appears.</p>
3102
3103<p>The transformation primitives:</p>
3104
3105<dl class="dl-horizontal">
3106<dt>rotate</dt><dd>degrees</dd>
3107<dt>translate</dt><dd>dx,dy</dd>
3108<dt>scale</dt><dd>sx,sy</dd>
3109<dt>skewX</dt><dd>degrees</dd>
3110<dt>skewY</dt><dd>degrees</dd>
3111</dl>
3112
3113<p>The pixel operation primitives:</p>
3114
3115<dl class="dl-horizontal">
3116<dt>color</dt><dd>x0,y0 method</dd>
3117<dt>matte</dt><dd>x0,y0 method</dd>
3118</dl>
3119
Cristy594d2772015-11-15 10:47:42 -05003120<p>The shape primitives are drawn in the color specified by the preceding <a
3121href="command-line-options.html#fill">-fill</a> setting. For unfilled shapes, use <a
3122href="command-line-options.html#fill">-fill none</a>. You can optionally control the stroke (the
3123"outline" of a shape) with the <a href="command-line-options.html#stroke">-stroke</a> and <a
3124href="command-line-options.html#strokewidth">-strokewidth</a> settings.</p>
Cristy882d9f42015-10-29 16:48:39 -04003125
3126<p>A <code>point</code> primitive is specified by a single <var>point</var> in the
3127pixel plane, that is, by an ordered pair of integer coordinates,
3128<var>x</var>,<var>y</var>. (As it involves only a single pixel, a <code>point</code>
Cristy594d2772015-11-15 10:47:42 -05003129primitive is not affected by <a href="command-line-options.html#stroke">-stroke</a> or <a
3130href="command-line-options.html#strokewidth">-strokewidth</a>.)</p>
Cristy882d9f42015-10-29 16:48:39 -04003131
3132<p>A <code>line</code> primitive requires a start point and end point.</p>
3133
3134<p>A <code>rectangle</code> primitive is specified by the pair of points at the
3135upper left and lower right corners.</p>
3136
3137<p>A <code>roundRectangle</code> primitive takes the same corner points as
3138a <code>rectangle</code> followed by the width and height of the rounded corners
3139to be removed.</p>
3140
3141<p>The <code>circle</code> primitive makes a disk (filled) or circle (unfilled).
3142Give the center and any point on the perimeter (boundary).</p>
3143
3144<p>The <code>arc</code> primitive is used to inscribe an elliptical segment in
3145to a given rectangle. An <code>arc</code> requires the two corners used for
3146<code>rectangle</code> (see above) followed by the start and end angles of the
3147arc of the segment segment (e.g. 130,30 200,100 45,90). The start and end
3148points produced are then joined with a line segment and the resulting segment
3149of an ellipse is filled.</p>
3150
3151<p>Use <code>ellipse</code> to draw a partial (or whole) ellipse. Give the
3152center point, the horizontal and vertical "radii" (the <var>semi-axes</var> of
3153the ellipse) and start and end angles in degrees (e.g. 100,100 100,150
31540,360).</p>
3155
3156<p>The <code>polyline</code> and <code>polygon</code> primitives require three or
3157more points to define their perimeters. A <code>polyline</code> is simply
3158a <code>polygon</code> in which the final point is not stroked to the start
Cristy594d2772015-11-15 10:47:42 -05003159point. When unfilled, this is a <var>polygonal line</var>. If the <a
3160href="command-line-options.html#stroke">-stroke</a> setting is <code>none</code> (the default), then
Cristy882d9f42015-10-29 16:48:39 -04003161a <code>polyline</code> is identical to a <code>polygon</code>. </p>
3162
3163<p>A <var>coordinate</var> is a pair of integers separated by a space or
3164optional comma. </p>
3165
3166<p>As an example, to define a circle centered at 100,100 that extends to
3167150,150 use:</p>
3168
3169<pre>
3170-draw 'circle 100,100 150,150'
3171</pre>
3172
3173<p>The <code>Bezier</code> primitive creates a spline curve and requires three
3174or points to define its shape. The first and last points are the
3175<var>knots</var> and these points are attained by the curve, while any
3176intermediate coordinates are <var>control points</var>. If two control points
3177are specified, the line between each end knot and its sequentially respective
3178control point determines the tangent direction of the curve at that end. If
3179one control point is specified, the lines from the end knots to the one
3180control point determines the tangent directions of the curve at each end. If
3181more than two control points are specified, then the additional control points
3182act in combination to determine the intermediate shape of the curve. In order
3183to draw complex curves, it is highly recommended either to use the
3184<code>path</code> primitive or to draw multiple four-point bezier segments with
3185the start and end knots of each successive segment repeated. For example:</p>
3186
3187<pre>
3188-draw 'bezier 20,50 45,100 45,0 70,50'
3189-draw 'bezier 70,50 95,100 95,0 120,50'
3190</pre>
3191
3192<p>A <code>path</code> represents an outline of an object, defined in terms of
3193moveto (set a new current point), lineto (draw a straight line), curveto (draw
3194a Bezier curve), arc (elliptical or circular arc) and closepath (close the
3195current shape by drawing a line to the last moveto) elements. Compound paths
3196(i.e., a path with subpaths, each consisting of a single moveto followed by
3197one or more line or curve operations) are possible to allow effects such as
Cristy594d2772015-11-15 10:47:42 -05003198<var>donut holes</var> in objects. (See <a
3199href="http://www.w3.org/TR/SVG/paths.html">Paths</a>.)</p>
Cristy882d9f42015-10-29 16:48:39 -04003200
3201<p>Use <code>image</code> to composite an image with another image. Follow the
3202image keyword with the composite operator, image location, image size, and
3203filename:</p>
3204
3205<pre>
3206-draw 'image SrcOver 100,100 225,225 image.jpg'
3207</pre>
3208
3209<p>You can use 0,0 for the image size, which means to use the actual
3210dimensions found in the image header. Otherwise, it is scaled to the given
3211dimensions. See <a href="compose.html">Alpha Compositing</a> for
3212a detailed discussion of alpha composition methods that are available. </p>
3213
3214<p>The "special augmented compose operators" such as "dissolve" that require
3215arguments cannot be used at present with the <code>-draw image</code> option.
3216 </p>
3217
3218<p>Use <code>text</code> to annotate an image with text. Follow the text
3219coordinates with a string. If the string has embedded spaces, enclose it in
3220single or double quotes.</p>
3221
3222<p>For example, the following annotates the image with <code>Works like
3223magick!</code> for an image titled <code>bird.miff</code>. </p>
3224
3225<pre>
3226-draw "text 100,100 'Works like magick!' "
3227</pre>
3228
3229<p>See the <a href="command-line-options.html#annotate">-annotate</a> option for another convenient way
3230to annotate an image with text.</p>
3231
3232<p>The <code>rotate</code> primitive rotates subsequent shape primitives and
Cristy594d2772015-11-15 10:47:42 -05003233text primitives about the origin of the main image. If the <a
3234href="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 -04003235option, the origin for transformations is the upper left corner of the
3236region.</p>
3237
3238<p>The <code>translate</code> primitive translates subsequent shape and text
3239primitives.</p>
3240
3241<p>The <code>scale</code> primitive scales them.</p>
3242
3243<p>The <code>skewX</code> and <code>skewY</code> primitives skew them with respect
3244to the origin of the main image or the region.</p>
3245
3246<p>The transformations modify the current affine matrix, which is initialized
3247from the initial affine matrix defined by the <a href="command-line-options.html#affine">-affine</a>
3248option. Transformations are cumulative within the <a href="command-line-options.html#draw">-draw</a>
3249option. The initial affine matrix is not affected; that matrix is only changed
3250by the appearance of another <a href="command-line-options.html#affine">-affine</a> option. If another
3251<a href="command-line-options.html#draw">-draw</a> option appears, the current affine matrix is
3252reinitialized from the initial affine matrix.</p>
3253
3254<p>Use the <code>color</code> primitive to change the color of a pixel to the
3255fill color (see <a href="command-line-options.html#fill">-fill</a>). Follow the pixel coordinate with
3256a method:</p>
3257
3258<pre>
3259point
3260replace
3261floodfill
3262filltoborder
3263reset
3264</pre>
3265
3266<p>Consider the target pixel as that specified by your coordinate. The
3267<code>point</code> method recolors the target pixel. The <code>replace</code>
3268method recolors any pixel that matches the color of the target pixel.
3269<code>Floodfill</code> recolors any pixel that matches the color of the target
3270pixel and is a neighbor, whereas <code>filltoborder</code> recolors any neighbor
3271pixel that is not the border color. Finally, <code>reset</code> recolors all
3272pixels.</p>
3273
3274<p>Use <code>matte</code> to the change the pixel matte value to transparent.
3275Follow the pixel coordinate with a method (see the <code>color</code> primitive
3276for a description of methods). The <code>point</code> method changes the matte
3277value of the target pixel. The <code>replace</code> method changes the matte
3278value of any pixel that matches the color of the target pixel.
3279<code>Floodfill</code> changes the matte value of any pixel that matches the
3280color of the target pixel and is a neighbor, whereas <code>filltoborder</code>
Cristy594d2772015-11-15 10:47:42 -05003281changes the matte value of any neighbor pixel that is not the border color (<a
3282href="command-line-options.html#bordercolor">-bordercolor</a>). Finally <code>reset</code> changes the
Cristy882d9f42015-10-29 16:48:39 -04003283matte value of all pixels.</p>
3284
Cristy594d2772015-11-15 10:47:42 -05003285<p>You can set the primitive color, font, and font bounding box color with <a
3286href="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 -04003287respectively. Options are processed in command line order so be sure to use
3288these options <var>before</var> the <a href="command-line-options.html#draw">-draw</a> option.</p>
3289
3290<p>Strings that begin with a number must be quoted (e.g. use '1.png' rather
3291than 1.png).</p>
3292
Cristy594d2772015-11-15 10:47:42 -05003293<p>Drawing primitives conform to the <a href="magick-vector-graphics.html" >Magick
Cristy882d9f42015-10-29 16:48:39 -04003294Vector Graphics</a> format.</p>
3295
3296
3297<div style="margin: auto;">
3298 <h3 class="magick-header"><a id="duplicate"></a>-duplicate <var>count,indexes</var></h3>
3299</div>
3300
3301<p class="magick-description">duplicate an image one or more times.</p>
3302
3303<p>Specify the count and the image to duplicate by its index in the sequence.
3304The first image is index 0. Negative indexes are relative to the end of the
3305sequence, for example, -1 represents the last image of the sequence. Specify
3306a range of images with a dash (e.g. 0-4). Separate indexes with a comma (e.g.
33070,2). Use <code>+duplicate</code> to duplicate the last image in the current
3308image sequence.</p>
3309
3310<div style="margin: auto;">
3311 <h3 class="magick-header"><a id="edge"></a>-edge <var>radius</var></h3>
3312</div>
3313
3314<p class="magick-description">detect edges within an image.</p>
3315
3316<div style="margin: auto;">
3317 <h3 class="magick-header"><a id="emboss"></a>-emboss <var>radius</var></h3>
3318</div>
3319
3320<p class="magick-description">emboss an image.</p>
3321
3322<div style="margin: auto;">
3323 <h3 class="magick-header"><a id="encipher"></a>-encipher <var>filename</var></h3>
3324</div>
3325
3326<p class="magick-description">Encipher pixels for later deciphering by <a href="command-line-options.html#decipher">-decipher</a>.</p>
3327
3328<p>Get the passphrase from the file specified by <var>filename</var>.</p>
3329
Cristy594d2772015-11-15 10:47:42 -05003330<p>For more information, see the webpage, <a
3331href="http://www.imagemagick.org/www/cipher.html">ImageMagick: Encipher or
Cristy882d9f42015-10-29 16:48:39 -04003332Decipher an Image</a>.</p>
3333
3334
3335
3336<div style="margin: auto;">
3337 <h3 class="magick-header"><a id="encoding"></a>-encoding <var>type</var></h3>
3338</div>
3339
3340<p class="magick-description">specify the text encoding.</p>
3341
3342<p>Choose from</p>
3343
3344<pre>
3345AdobeCustom AdobeExpert
3346AdobeStandard AppleRoman
3347BIG5 GB2312
3348Latin 2 None
3349SJIScode Symbol
3350Unicode Wansung
3351</pre>
3352
3353<div style="margin: auto;">
3354 <h3 class="magick-header"><a id="endian"></a>-endian <var>type</var></h3>
3355</div>
3356
3357<p class="magick-description">Specify endianness (<code>MSB</code> or <code>LSB</code>) of the image.</p>
3358
3359<p>To print a complete list of endian types, use the <a href="command-line-options.html#list">-list endian</a> option.</p>
3360
3361<p>Use <a href="command-line-options.html#endian">+endian</a> to revert to unspecified endianness.</p>
3362
3363
3364<div style="margin: auto;">
3365 <h3 class="magick-header"><a id="enhance"></a>-enhance</h3>
3366</div>
3367
3368<p class="magick-description">Apply a digital filter to enhance a noisy image.</p>
3369
3370
3371<div style="margin: auto;">
3372 <h3 class="magick-header"><a id="equalize"></a>-equalize</h3>
3373</div>
3374
3375<p class="magick-description">perform histogram equalization on the image channel-by-channel.</p>
3376
3377<p>To perform histogram equalization on all channels in concert, transform the
3378image into some other color space, such as HSL, OHTA, YIQ or YUV, then
3379equalize the appropriate intensity-like channel, then convert back to RGB.</p>
3380
3381<p>For example using HSL, we have: ... <code>-colorspace HSL -channel lightness
3382-equalize -colorspace RGB</code> ...</p>
3383
3384<p>For YIQ, YUV and OHTA use the red channel. For example, OHTA is a principal
3385components transformation that puts most of the information in the first
3386channel. Here we have ... <code>-colorspace OHTA -channel red -equalize
3387-colorspace RGB</code> ...</p>
3388
3389<div style="margin: auto;">
3390 <h3 class="magick-header"><a id="evaluate"></a>-evaluate <var>operator value</var></h3>
3391</div>
3392
3393<p class="magick-description">Alter channel pixels by evaluating an arithmetic, relational, or logical expression.</p>
3394
Cristy594d2772015-11-15 10:47:42 -05003395<p>(See the <a href="command-line-options.html#function" >-function</a> operator for some
3396multi-parameter functions. See the <a href="command-line-options.html#fx" >-fx</a> operator if more
Cristy882d9f42015-10-29 16:48:39 -04003397elaborate calculations are needed.)</p>
3398
3399<p>The behaviors of each <var>operator</var> are summarized in the
3400following list. For brevity, the numerical value of a "pixel" referred to
3401below is the value of the corresponding channel of that pixel, while
3402a "normalized pixel" is that number divided by the maximum
3403(installation-dependent) value <var>QuantumRange</var>. (If
3404normalized pixels are used, they are restored, following the other
3405calculations, to the full range by multiplying by <var>QuantumRange</var>.)</p>
3406
3407<table class="table table-condensed table-striped">
Cristy594d2772015-11-15 10:47:42 -05003408 <col width="25%" />
3409 <col width="75%" />
Cristy882d9f42015-10-29 16:48:39 -04003410 <thead>
3411 <tr>
3412 <th><var>operator</var></th>
3413 <th>Summary (see further below for details)</th>
3414 </tr>
3415 </thead>
3416 <tbody>
3417
3418 <tr><td>Abs </td> <td>Add <var>value</var> to pixels and return absolute value. </td></tr>
3419 <tr><td>Add </td> <td>Add <var>value</var> to pixels. </td></tr>
3420 <tr><td>AddModulus </td> <td>Add <var>value</var> to pixels modulo <var>QuantumRange</var>.</td></tr>
3421 <tr><td>And </td> <td>Binary AND of pixels with <var>value</var>.</td></tr>
3422 <tr><td>Cos, Cosine </td> <td>Apply cosine to pixels with frequency <var>value</var> with 50% bias added.</td></tr>
3423 <tr><td>Divide </td> <td>Divide pixels by <var>value</var>.</td></tr>
3424 <tr><td>Exp </td> <td>base-e exponential function</td></tr>
3425 <tr><td>Exponential </td> <td>base-e exponential function</td></tr>
3426 <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>
3427 <tr><td>Log </td> <td>Apply scaled logarithm to normalized pixels.</td></tr>
3428 <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>
3429 <tr><td>Mean </td> <td>Add the <var>value</var> and divide by 2.</td></tr>
3430 <tr><td>Median </td> <td>Choose the median value from an image sequence.</td></tr>
3431 <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>
3432 <tr><td>Multiply </td> <td>Multiply pixels by <var>value</var>.</td></tr>
3433 <tr><td>Or </td> <td>Binary OR of pixels with <var>value</var>.</td></tr>
3434 <tr><td>Pow </td> <td>Raise normalized pixels to the power <var>value</var>.</td></tr>
3435 <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>
3436 <tr><td>RMS</td> <td>Square the pixel and add the <var>value</var>.</td></tr>
3437 <tr><td>RootMeanSquare</td> <td>Square the pixel and add the <var>value</var>.</td></tr>
3438 <tr><td>Set </td> <td>Set pixel equal to <var>value</var>.</td></tr>
3439 <tr><td>Sin, Sine </td> <td>Apply sine to pixels with frequency <var>value</var> with 50% bias added.</td></tr>
3440 <tr><td>Subtract </td> <td>Subtract <var>value</var> from pixels.</td></tr>
3441 <tr><td>Xor </td> <td>Binary XOR of pixels with <var>value.</var></td></tr>
3442
3443 <tr><td> </td><td> </td></tr>
3444
3445 <tr><td>Gaussian-noise</td><td> </td></tr>
3446 <tr><td>Impulse-noise</td><td> </td></tr>
3447 <tr><td>Laplacian-noise</td><td> </td></tr>
Cristy594d2772015-11-15 10:47:42 -05003448 <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 -04003449 <tr><td>PoissonNoise</td><td> </td></tr>
3450 <tr><td>Uniform-noise</td><td> </td></tr>
3451
3452 <tr><td> </td><td> </td></tr>
3453
3454 <tr><td>Threshold </td> <td>Threshold pixels larger than <var>value</var>.</td></tr>
3455 <tr><td>ThresholdBlack </td> <td>Threshold pixels to zero values equal to or below <var>value</var>.</td></tr>
3456 <tr><td>ThresholdWhite </td> <td>Threshold pixels to maximum values above <var>value</var>. </td></tr>
3457 </tbody>
3458 </table>
3459
Cristy594d2772015-11-15 10:47:42 -05003460<p>The specified functions are applied only to each previously set <a
3461href="command-line-options.html#channel" >-channel</a> in the image. If necessary, the results of the
Cristy882d9f42015-10-29 16:48:39 -04003462calculations are truncated (clipped) to fit in the interval [0, <var>QuantumRange</var>]. The transparency channel of the image is
3463represented as a 'alpha' values (0 = fully transparent), so, for example, a
3464<code>Divide</code> by 2 of the alpha channel will make the image
3465semi-transparent. Append the percent symbol '<code>%</code>' to specify a value
3466as a percentage of the <var>QuantumRange</var>.</p>
3467
3468<p>To print a complete list of <a href="command-line-options.html#evaluate">-evaluate</a> operators, use
3469<a href="command-line-options.html#list">-list evaluate</a>.</p>
3470
3471<p>The results of the <code>Add</code>, <code>Subtract</code> and
Cristy594d2772015-11-15 10:47:42 -05003472<code>Multiply</code> methods can also be achieved using either the <a
3473href="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 -04003474appropriate argument, to linearly modify the overall range of color values.
Cristy594d2772015-11-15 10:47:42 -05003475Please note, however, that <a href="command-line-options.html#level" >-level</a> treats transparency as
3476'matte' values (0 = opaque), while <a href="command-line-options.html#level" >-evaluate</a> works with
Cristy882d9f42015-10-29 16:48:39 -04003477'alpha' values.</p>
3478
3479<p><code>AddModulus</code> has been added as of ImageMagick 6.4.8-4 and provides
3480addition modulo the <var>QuantumRange</var>. It is therefore
3481equivalent to <code>Add</code> unless the resulting pixel value is outside the
3482interval [0, <var>QuantumRange</var>]. </p>
3483
3484<p><code>Exp or Exponential</code> has been added as of ImageMagick 6.6.5-1 and
3485works on normalized pixel values. The <var>value</var> used with
3486<code>Exp</code> should be negative so as to produce a decaying exponential
3487function. Non-negative values will always produce results larger unity and
3488thus outside the interval [0, <var>QuantumRange</var>]. The
3489formula is expressed below. </p>
3490
3491<p class="text-center">
3492exp(<var>value</var> × <b><var>u</var></b>)
3493</p>
3494
Cristy594d2772015-11-15 10:47:42 -05003495<p> If the input image is squared, for example, using <a href="command-line-options.html#-function"
3496>-function polynomial "2 0 0"</a>, then a decaying Gaussian function will be
Cristy882d9f42015-10-29 16:48:39 -04003497the result.</p>
3498
3499<p><code>Log</code> has been added as of ImageMagick 6.4.2-1 and works on
3500normalized pixel values. This a <var>scaled</var> log function. The <var>value</var> used with <code>Log</code> provides a <var>scaling
3501factor</var> that adjusts the curvature in the graph of the log function. The
3502formula applied to a normalized value <b><var>u</var></b> is below. </p>
3503
3504<p class="text-center">
3505log(<var>value</var> × <b><var>u</var></b> + 1) / log(<var>value</var> + 1)
3506</p>
3507
3508<p><code>Pow</code> has been added as of ImageMagick 6.4.1-9, and works on
Cristy594d2772015-11-15 10:47:42 -05003509normalized pixel values. Note that <code>Pow</code> is related to the <a
3510href="command-line-options.html#gamma" >-gamma</a> operator. For example, <b>-gamma 2</b> is equivalent
Cristy882d9f42015-10-29 16:48:39 -04003511to <b>-evaluate pow 0.5</b>, i.e., a 'square root' function. The value used
Cristy594d2772015-11-15 10:47:42 -05003512with <a href="command-line-options.html#gamma" >-gamma</a> is simply the reciprocal of the value used
Cristy882d9f42015-10-29 16:48:39 -04003513with <code>Pow</code>.</p>
3514
3515<p><code>Cosine</code> and <code>Sine</code> was added as of IM v6.4.8-8 and
3516converts the image values into a value according to a (co)sine wave function.
3517The synonyms <code>Cos</code> and <code>Sin</code> may also be used. The output
3518is biased 50% and normalized by 50% so as to fit in the respective color value
3519range. The <var>value</var> scaling of the <var>period</var> of the
3520function (its frequency), and thus determines the number of 'waves' that will
3521be 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,
3522then the effective period is the <var>half</var> the <var>QuantumRange</var>.</p>
3523
3524<p class="text-center">
35250.5 + 0.5 × cos(2 π <b><var>u</var></b> × <var>value</var>).
3526</p>
3527
Cristy594d2772015-11-15 10:47:42 -05003528<p>See also the <a href="command-line-options.html#function" >-function</a> operator, which is a
Cristy882d9f42015-10-29 16:48:39 -04003529multi-value version of evaluate. </p>
3530
3531<div style="margin: auto;">
3532 <h3 class="magick-header"><a id="evaluate-sequence"></a>-evaluate-sequence <var>operator</var></h3>
3533</div>
3534
3535<p class="magick-description">Alter channel pixels by evaluating an arithmetic, relational, or
3536logical expression over a sequence of images.</p>
3537
Cristy594d2772015-11-15 10:47:42 -05003538<p>To print a complete list of <a
3539href="command-line-options.html#evaluate-sequence">-evaluate-sequence</a> operators, use <a
3540href="command-line-options.html#list">-list evaluate</a>.</p>
Cristy882d9f42015-10-29 16:48:39 -04003541
3542<div style="margin: auto;">
3543 <h3 class="magick-header"><a id="extent"></a>-extent <var>geometry</var></h3>
3544</div>
3545
3546<p class="magick-description">Set the image size and offset.</p>
3547
3548<p>If the image is enlarged, unfilled areas are set to the background color.
3549To position the image, use offsets in the <var>geometry</var>
3550specification or precede with a <a href="command-line-options.html#gravity">-gravity</a> setting. To
Cristy594d2772015-11-15 10:47:42 -05003551specify how to compose the image with the background, use <a href="command-line-options.html#compose"
3552>-compose</a>.</p>
Cristy882d9f42015-10-29 16:48:39 -04003553
3554<p>This command reduces or expands a JPEG image to fit on an 800x600
3555display. If the aspect ratio of the input image isn't exactly 4:3, then the
3556image is centered on an 800x600 black canvas: </p>
3557
3558<pre>
3559convert input.jpg -resize 800x600 -background black -compose Copy \
3560 -gravity center -extent 800x600 -quality 92 output.jpg
3561</pre>
3562
3563<p>See <a href="command-line-processing.html#geometry">Image Geometry</a> for complete details about the <em class="arg">geometry</em> argument.</p>
3564
3565<div style="margin: auto;">
3566 <h3 class="magick-header"><a id="extract"></a>-extract <var>geometry</var></h3>
3567</div>
3568
3569<p class="magick-description">Extract the specified area from image.</p>
3570
3571<p>This option is most useful for extracting a subregion of a very large raw
3572image. Note that these two commands are equivalent:</p>
3573
3574<pre>
3575convert -size 16000x16000 -depth 8 -extract 640x480+1280+960 \
3576 image.rgb image.png",
3577convert -size 16000x16000 -depth 8 'image.rgb[640x480+1280+960]' \
3578 image.rgb image.png"
3579</pre>
3580
3581<p>If you omit the offsets, as in</p>
3582
3583<pre>
3584convert -size 16000x16000 -depth 8 -extract 640x480 \
3585 image.rgb image.png
3586</pre>
3587
3588<p>the image is <var>resized</var> to the specified dimensions instead,
3589equivalent to:</p>
3590
3591<pre>
3592convert -size 16000x16000 -depth 8 -resize 640x480 image.rgb image.png
3593</pre>
3594
3595<p>See <a href="command-line-processing.html#geometry">Image Geometry</a> for complete details about the <em class="arg">geometry</em> argument.</p>
3596
3597<div style="margin: auto;">
3598 <h3 class="magick-header"><a id="family"></a>-family <var>fontFamily</var></h3>
3599</div>
3600
3601<p class="magick-description">Set a font family for text.</p>
3602
3603<p>This setting suggests a font family that ImageMagick should try to use for
3604rendering text. If the family can be found it is used; if not, a default font
3605(e.g., "Arial") or a family known to be similar is substituted (e.g.,
3606"Courier" might be used if "System" is requested but not found). </p>
3607
Cristy594d2772015-11-15 10:47:42 -05003608<p>For other settings that affect fonts, see the options <a
3609href="command-line-options.html#font">-font</a>, <a href="command-line-options.html#stretch">-stretch</a>, <a
3610href="command-line-options.html#style">-style</a>, and <a href="command-line-options.html#weight">-weight</a>. </p>
Cristy882d9f42015-10-29 16:48:39 -04003611
3612<div style="margin: auto;">
3613 <h3 class="magick-header"><a id="features"></a>-features <var>distance</var></h3>
3614</div>
3615
3616<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>
3617
3618<pre>
3619Angular Second Moment Sum Entropy
3620Contrast Entropy
3621Correlation Difference Variance
3622Sum of Squares Variance Difference Entropy
3623Inverse Difference Moment Information Measure of Correlation 1
3624Sum Average Information Measure of Correlation 2
3625Sum Variance Maximum Correlation Coefficient
3626</pre>
3627
3628<div style="margin: auto;">
3629 <h3 class="magick-header"><a id="fft"></a>-fft</h3>
3630</div>
3631
3632<p class="magick-description">implements the forward discrete Fourier transform (DFT).</p>
3633
3634<p>This option is new as of ImageMagick 6.5.4-3 (and now working for Windows
3635users in ImageMagick 6.6.0-9). It transforms an image from the normal
3636(spatial) domain to the frequency domain. In the frequency domain, an image is
3637represented as a superposition of complex sinusoidal waves of varying
3638amplitudes. The image x and y coordinates are the possible frequencies along
3639the x and y directions, respectively, and the pixel intensity values are
3640complex numbers that correspond to the sinusoidal wave amplitudes. See for
3641example, <a href="http://en.wikipedia.org/wiki/Fourier_transform">Fourier
3642Transform</a>, <a href="http://en.wikipedia.org/wiki/DFT">Discrete Fourier
3643Transform</a> and <a href="http://en.wikipedia.org/wiki/FFT">Fast Fourier
3644Transform</a>.</p>
3645
3646<p>A single image name is provided as output for this option. However, the
3647output result will have two components. It is either a two-frame image or two
3648separate images, depending upon whether the image format specified supports
3649multi-frame images. The reason that we get a dual output result is because the
3650frequency domain represents an image using complex numbers, which cannot be
3651visualized directly. Therefore, the complex values are automagically separated
3652into a two-component image representation. The first component is the
3653magnitude of the complex number and the second is the phase of the complex
Cristy594d2772015-11-15 10:47:42 -05003654number. See for example, <a
3655href="http://en.wikipedia.org/wiki/Complex_numbers">Complex Numbers</a>.</p>
Cristy882d9f42015-10-29 16:48:39 -04003656
3657<p>The magnitude and phase component images must be specified using image
3658formats that do not limit the color or compress the image. Thus, MIFF, TIF,
3659PFM, EXR and PNG are the recommended image formats to use. All of these
3660formats, except PNG support multi-frame images. So for example,</p>
3661
3662<pre>
3663convert image.png -fft fft_image.miff
3664</pre>
3665
3666<p>generates a magnitude image as <code>fft_image.miff[0]</code> and a phase
3667image as <code>fft_image.miff[1]</code>. Similarly,</p>
3668
3669<pre>
3670convert image.png -fft fft_image.png
3671</pre>
3672
3673<p>generates a magnitude image as <code>fft_image-0.png</code> and a phase image
3674as <code>fft_image-1.png</code>. If you prefer this representation, then you can
Cristy594d2772015-11-15 10:47:42 -05003675force any of the other formats to produce two output images by including <a
3676href="command-line-options.html#adjoin">+adjoin</a> following -fft in the command line.</p>
Cristy882d9f42015-10-29 16:48:39 -04003677
3678<p>The input image can be any size, but if not square and even-dimensioned, it
3679is padded automagically to the larger of the width or height of the input
3680image and to an even number of pixels. The padding will occur at the bottom
3681and/or right sides of the input image. The resulting output magnitude and
Cristy594d2772015-11-15 10:47:42 -05003682phase images is square at this size. The kind of padding relies on the <a
3683href="command-line-options.html#virtual-pixel">-virtual-pixel</a> setting.</p>
Cristy882d9f42015-10-29 16:48:39 -04003684
3685<p>Both output components will have dynamic ranges that fit within
3686[0, <var>QuantumRange</var>], so that HDRI need not be enabled.
3687Phase values nominally range from 0 to 2*π, but is scaled to span the full
3688dynamic range. (The first few releases had non-HDRI scaled but HDRI not
3689scaled). The magnitude image is not scaled and thus generally will contain
3690very small values. As such, the image normally will appear totally black. In
3691order to view any detail, the magnitude image typically is enhanced with a log
3692function into what is usually called the spectrum. A log function is used to
3693enhance the darker values more in comparison to the lighter values. This can
3694be done, for example, as follows:</p>
3695
3696<pre>
3697convert fft_image.miff[0] -contrast-stretch 0 \
3698 -evaluate log 1000 fft_image_spectrum.png"
3699</pre>
3700
Cristy594d2772015-11-15 10:47:42 -05003701<p>where either <a href="command-line-options.html#contrast-stretch">-contrast-stretch</a> 0 or <a
3702href="command-line-options.html#auto-level">-auto-level</a> is used to scale the image to full dynamic
Cristy882d9f42015-10-29 16:48:39 -04003703range, first. The argument to the <a href="command-line-options.html#evaluate">-evaluate</a> log
3704typically is specified between 100 and 10,000, depending upon the amount of
3705detail that one wants to bring out in the spectrum. Larger values produce more
3706visible detail. Too much detail, however, may hide the important features.</p>
3707
3708<p>The <a href="http://www.fftw.org/">FFTW</a> delegate library is required to
3709use <a href="command-line-options.html#fft">-fft</a>.</p>
3710
3711<p>Use <a href="command-line-options.html#fft">+fft</a> to produce two output images that are the real
3712and imaginary components of the complex valued Fourier transform.</p>
3713
3714<p>However, as the real and imaginary components can contain negative values,
3715this requires that IM be configured with HDRI enabled. In this case, you must
3716use either MIFF, TIF, PFM or MPC formats for the real and imaginary component
3717results, since they are formats that preserve both negative and fractional
3718values without clipping them or truncating the fractional part. With either
3719MIFF or TIF, one should add -define quantum:format=32, to allow those image
3720types to work properly in HDRI mode without clipping.</p>
3721
Cristy594d2772015-11-15 10:47:42 -05003722<p>The real and imaginary component images resulting from <a
3723href="command-line-options.html#fft">+fft</a> are also square, even dimensioned images due to the same
Cristy882d9f42015-10-29 16:48:39 -04003724padding that was discussed above for the magnitude and phase component
3725images.</p>
3726
Cristy594d2772015-11-15 10:47:42 -05003727<p>See the discussion on HDRI implementations of ImageMagick on the page <a
3728href="high-dynamic-range.html" >High Dynamic-Range Images</a>. For more
3729about HDRI go the ImageMagick <a
3730href="http://www.imagemagick.org/Usage/basics/#hdri" >Usage</a> pages, <a
3731href="http://www.fmwconcepts.com/imagemagick/fourier_transforms/fourier.html"
3732>Fred's Fourier Processing With ImageMagick page</a> or this <a
3733 href="http://en.wikipedia.org/wiki/High_dynamic_range_imaging" >Wikipedia</a>
Cristy882d9f42015-10-29 16:48:39 -04003734 entry. </p>
3735
Cristy594d2772015-11-15 10:47:42 -05003736<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 -04003737
3738
3739<div style="margin: auto;">
3740 <h3 class="magick-header"><a id="fill"></a>-fill <var>color</var></h3>
3741</div>
3742
3743<p class="magick-description">color to use when filling a graphic primitive.</p>
3744
3745<p>This option accepts a color name, a hex color, or a numerical RGB, RGBA,
Cristy594d2772015-11-15 10:47:42 -05003746HSL, HSLA, CMYK, or CMYKA specification. See <a href="color.html" >Color Names</a> for
Cristy882d9f42015-10-29 16:48:39 -04003747a description of how to properly specify the color argument.</p>
3748
3749<p>Enclose the color specification in quotation marks to prevent the "#" or
3750the parentheses from being interpreted by your shell.</p>
3751
3752<p>For example,</p>
3753
3754<pre>
3755-fill blue
3756-fill "#ddddff"
3757-fill "rgb(255,255,255)"
3758</pre>
3759
3760<p>See <a href="command-line-options.html#draw">-draw</a> for further details.</p>
3761
3762<p>To print a complete list of color names, use the <a href="command-line-options.html#list">-list color</a> option.</p>
3763
3764<div style="margin: auto;">
3765 <h3 class="magick-header"><a id="filter"></a>-filter <var>type</var></h3>
3766</div>
3767
3768<p class="magick-description">Use this <var>type</var> of filter when resizing or distorting an image.</p>
3769
3770<p>Use this option to affect the resizing operation of an image during
Cristy594d2772015-11-15 10:47:42 -05003771operations such as <a href="command-line-options.html#resize">-resize</a> and <a href="command-line-options.html#distort"
3772>-distort</a>. For example you can use a simple resize filter such as:</p>
Cristy882d9f42015-10-29 16:48:39 -04003773
3774<pre>
3775Point Hermite Cubic
3776Box Gaussian Catrom
3777Triangle Quadratic Mitchell
3778</pre>
3779
3780<p>The <code>Bessel</code> and <code>Sinc</code> filter is also provided (as well
3781as a faster <code>SincFast</code> equivalent form). However these filters are
3782generally useless on their own as they are infinite filters that are being
3783clipped to the filters support size. Their direct use is not recommended
3784except via expert settings (see below). </p>
3785
3786<p>Instead these special filter functions are typically windowed by a windowing
Cristy594d2772015-11-15 10:47:42 -05003787function that the <a href="command-line-options.html#filter" >-filter</a> setting defines. That is
Cristy882d9f42015-10-29 16:48:39 -04003788using these functions will define a 'Windowed' filter, appropriate to the
3789operator involved. Windowed filters include: </p>
3790
3791<pre>
3792Lanczos Hamming Parzen
3793Blackman Kaiser Welsh
3794Hanning Bartlett Bohman
3795</pre>
3796
3797<p>Also one special self-windowing filter is also provided
3798<code>Lagrange</code>, which will automagically re-adjust its function depending
3799on the current 'support' or 'lobes' expert settings (see below).</p>
3800
3801<p>If you do not select a filter with this option, the filter defaults to
3802<code>Mitchell</code> for a colormapped image, an image with a matte channel, or
3803if the image is enlarged. Otherwise the filter default to
3804<code>Lanczos</code>.</p>
3805
3806<p>To print a complete list of resize filters, use the <a href="command-line-options.html#list">-list
3807filter</a> option.</p>
3808
3809<p>You can modify how the filter behaves as it scales your image through the
Cristy594d2772015-11-15 10:47:42 -05003810use of these expert settings (see also <a href="command-line-options.html#define" >-define</a> and <a
3811href="command-line-options.html#set" >-set</a>):-</p>
Cristy882d9f42015-10-29 16:48:39 -04003812
3813<table class="table table-condensed table-striped">
3814 <tr>
3815 <td>-define filter:blur=<var>factor</var></td>
3816 <td>Scale the X axis of the filter (and its window). Use &gt; 1.0 for
3817 blurry or &lt; 1.0 for sharp. This should only be used with Gaussian and
3818 Gaussian-like filters simple filters, or you may not get the expected
3819 results. </td>
3820 </tr>
3821
3822 <tr>
3823 <td>-define filter:support=<var>radius</var></td>
3824 <td>Set the filter support radius. Defines how large the filter should be and
3825 thus directly defines how slow the filtered resampling process is. All
3826 filters have a default 'preferred' support size. Some filters like
3827 <code>Lagrange</code> and windowed filters adjust themselves depending on
3828 this value. With simple filters this value either does nothing (but slow
3829 the resampling), or will clip the filter function in a detrimental way.
3830 </td>
3831 </tr>
3832
3833 <tr>
3834 <td>-define filter:lobes=<var>count</var></td>
3835 <td>Set the number of lobes to use for the Sinc/Bessel filter. This an
3836 alternative way of specifying the 'support' range of the filter, that is
3837 designed to be more suited to windowed filters, especially when used for
3838 image distorts.</td>
3839 </tr>
3840
3841 <tr>
3842 <td>-define filter:sigma=<var>value</var></td>
3843 <td>The 'sigma' value used to define the <code>Gaussian</code> filter. Default
3844 sigma value is '<code>0.5</code>'. It only effects <code>Gaussian</code> but
3845 does not shrink (but may enlarge) the filter's 'support'. It can be used
3846 to generate very small blurs but without the filter 'missing' pixels due
3847 to using a small support setting. A larger value of '<code>0.707</code>'
3848 (a value of '1/sqrt(2)') is another common setting. </td>
3849 </tr>
3850
3851 <tr>
3852 <td>-define filter:b=<var>b-spline_factor</var></td>
Cristy594d2772015-11-15 10:47:42 -05003853 <tr>
Cristy882d9f42015-10-29 16:48:39 -04003854 <td>-define filter:c=<var>keys_alpha_factor</var></td>
3855 <td>Redefine the values used for cubic filters such as <code>Cubic</code>,
3856 <code>Catrom</code>, <code>Mitchel</code>, and <code>Hermite</code>, as well as
3857 the <code>Parzen</code> cubic windowing function. If only one of the values
3858 are defined, the other is set so as to generate a 'Cubic-Keys' filter.
3859 The values meaning was defined by a research paper by
3860 Mitchell-Netravali.</td>
3861 </tr>
3862
3863 <tr>
3864 <td>-define filter:kaiser-beta=<var>value</var></td>
3865 <td>The 'alpha' value used to as part of the Kaiser Windowing function.
3866 Default value is '6.5'. It only effects Kaiser windowing function, and
3867 does not effect any other attributes.
3868 Before ImageMagick v6.7.6-10, this option was known as "filter:alpha", (an
3869 inheritance from the very old "zoom" program). It was changed to bring the
3870 function in line with more modern academic research usage, and better
3871 assign it be more definitive. </td>
3872 </tr>
3873
3874 <tr>
3875 <td>-define filter:kaiser-alpha=<var>value</var></td>
3876 <td>This value when multiplied by 'PI' is equivalent to "kaiser-beta", and
3877 will override that setting. It only effects Kaiser windowing function,
3878 and does not effect any other attributes. </td>
3879 </tr>
3880
3881 <tr>
3882 <td>-define filter:filter=<var>filter_function</var></td>
3883 <td>Use this function directly as the weighting filter. This will allow
3884 you to directly use a windowing function such as <code>Blackman</code>,
3885 as a resampling filter, rather than as its normal usage as a windowing
3886 function. If defined, no windowing function also defined, the window function is set
3887 to <code>Box</code>). Directly specifying <code>Sinc</code> or <code>Jinc</code>
3888 as a filter will also do this. </td>
3889 </tr>
3890
3891 <tr>
3892 <td>-define filter:window=<var>filter_function</var></td>
3893 <td>The IIR (infinite impulse response) filters <code>Sinc</code> and
3894 <code>Jinc</code> are windowed (brought down to zero over the defined
3895 support range) with the given filter. This allows you to specify a filter
3896 function to be used as a windowing function for these IIR filters.
3897 Many of the defined filters are actually windowing functions for these IIR
3898 filters. A typical choices is <code>Box</code>, (which effectively turns
3899 off the windowing function). </td>
3900 </tr>
3901
3902 <tr>
3903 <td>-define filter:win-support=<var>radius</var></td>
3904 <td>Scale windowing function to this size instead. This causes the windowing
3905 (or self-windowing Lagrange filter) to act is if the support window is
3906 larger than what is actually supplied to the calling operator. The filter
3907 however is still clipped to the real support size given. If unset this
3908 will equal the normal filter support size. </td>
3909 </tr>
3910
3911 <tr>
3912 <td>-define filter:verbose=<var>1</var></td>
3913 <td>This causes IM to print information on the final internal filter
3914 selection to standard output. This includes a commented header on the
3915 filter settings being used, and data allowing the filter weights to be
3916 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
3917 a <code>SincFast</code> windowed <code>SincFast</code> filter, while
3918 <code>Mitchell</code> is defined as a general <code>Cubic</code> family filter
3919 with specific 'B' and 'C' settings. </td>
3920 </tr>
3921
3922</table>
3923
3924<p>For example, to get a 8 lobe jinc windowed sinc filter (Genseng filter?):</p>
3925
3926<pre>
3927convert image.png \
3928 -filter sinc \
3929 -set filter:window=jinc \
3930 -set filter:lobes=8 \
3931 -resize 150% image.jpg"
3932</pre>
3933
3934<p>Or a raw un-windowed Sinc filter with 4 lobes:</p>
3935
3936<pre>
3937convert image.png \
3938 -set filter:filter=sinc \
3939 -set filter:lobes=4 \
3940 -resize 150% image.jpg"
3941</pre>
3942
3943<p>To extract the data for a raw windowing function, combine it with
3944a '<code>Box</code>' filter. For example the '<code>Welch</code> parabolic
3945windowing function. </p>
3946
3947<pre>
3948convert null: -define filter:filter=Box \
3949 -define filter:window=Welch \
3950 -define filter:support=1.0 \
3951 -define filter:verbose=1 \
Cristy594d2772015-11-15 10:47:42 -05003952 -resize 2 null: > window_welch.dat
Cristy882d9f42015-10-29 16:48:39 -04003953gnuplot
3954 set grid
3955 plot \"window_welch.dat\" with lines
3956</pre>
3957
3958<p>Note that the use of expert options is provided for image processing experts
3959who have studied and understand how resize filters work. Without this
3960knowledge, and an understanding of the definition of the actual filters
3961involved, using expert settings are more likely to be detrimental to your image
3962resizing.</p>
3963
3964
3965<div style="margin: auto;">
3966 <h3 class="magick-header"><a id="flatten"></a>-flatten</h3>
3967</div>
3968
Cristy594d2772015-11-15 10:47:42 -05003969<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 -04003970
3971
3972<div style="margin: auto;">
3973 <h3 class="magick-header"><a id="flip"></a>-flip</h3>
3974</div>
3975
3976<p class="magick-description">create a <var>mirror image</var></p>
3977
3978<p>reflect the scanlines in the vertical direction. The image will be mirrored
3979upside-down. </p>
3980
3981
3982<div style="margin: auto;">
3983 <h3 class="magick-header"><a id="floodfill"></a>-floodfill {<var>+-</var>}<var>x</var>{<var>+-</var>}<var>y</var> <var>color</var></h3>
3984</div>
3985
3986<p class="magick-description">floodfill the image with color at the specified offset.</p>
3987
3988<p>Flood fill starts from the given 'seed point' which is not gravity effected.
Cristy594d2772015-11-15 10:47:42 -05003989Any color that matches within <a href="command-line-options.html#fuzz" >-fuzz</a> color distance of the
Cristy882d9f42015-10-29 16:48:39 -04003990given <var>color</var> argument, connected to that 'seed point'
Cristy594d2772015-11-15 10:47:42 -05003991will be replaced with the current <a href="command-line-options.html#fill" >-fill</a> color. </p>
Cristy882d9f42015-10-29 16:48:39 -04003992
3993<p>Note that if the pixel at the 'seed point' does not itself match the given
Cristy594d2772015-11-15 10:47:42 -05003994<var>color</var> (according to <a href="command-line-options.html#fuzz" >-fuzz</a>), then no
Cristy882d9f42015-10-29 16:48:39 -04003995action will be taken. </p>
3996
Cristy594d2772015-11-15 10:47:42 -05003997<p>This operator works more like the <a href="command-line-options.html#opaque" >-opaque</a> option, than
Cristy882d9f42015-10-29 16:48:39 -04003998a more general flood fill that reads the matching color directly at the 'seed
Cristy594d2772015-11-15 10:47:42 -05003999point'. For this form of flood fill, look at <a href="command-line-options.html#draw" >-draw</a> and
Cristy882d9f42015-10-29 16:48:39 -04004000its 'color floodfill' drawing method. </p>
4001
4002
4003<div style="margin: auto;">
4004 <h3 class="magick-header"><a id="flop"></a>-flop</h3>
4005</div>
4006
4007<p class="magick-description">create a <var>mirror image</var>.</p>
4008
4009<p>Reflect the scanlines in the horizontal direction, just like the image in
4010a vertical mirror. </p>
4011
4012
4013<div style="margin: auto;">
4014 <h3 class="magick-header"><a id="font"></a>-font <var>name</var></h3>
4015</div>
4016
4017<p class="magick-description">set the font to use when annotating images with text, or creating labels.</p>
4018
4019<p>To print a complete list of fonts, use the <a href="command-line-options.html#list">-list font</a>
4020option (for versions prior to 6.3.6, use 'type' instead of 'font').</p>
4021
4022<p>In addition to the fonts specified by the above pre-defined list, you can
4023also specify a font from a specific source. For example <code>Arial.ttf</code>
4024is a TrueType font file, <code>ps:helvetica</code> is PostScript font, and
4025<code>x:fixed</code> is X11 font.</p>
4026
Cristy594d2772015-11-15 10:47:42 -05004027<p>For other settings that affect fonts, see the options <a
4028href="command-line-options.html#family">-family</a>, <a href="command-line-options.html#stretch">-stretch</a>, <a
4029href="command-line-options.html#style">-style</a>, and <a href="command-line-options.html#weight">-weight</a>. </p>
Cristy882d9f42015-10-29 16:48:39 -04004030
4031
4032<div style="margin: auto;">
4033 <h3 class="magick-header"><a id="foreground"></a>-foreground <var>color</var></h3>
4034</div>
4035
4036<p class="magick-description">Define the foreground color for menus.", "display</p>
4037
Cristy594d2772015-11-15 10:47:42 -05004038<p>The color is specified using the format described under the <a
4039href="command-line-options.html#fill">-fill</a> option.</p>
Cristy882d9f42015-10-29 16:48:39 -04004040
4041<p>The default foreground color is black.</p>
4042
4043<div style="margin: auto;">
4044 <h3 class="magick-header"><a id="format"></a>-format <var>type</var></h3>
4045</div>
4046
4047<p class="magick-description">the image format type.</p>
4048
4049<p>When used with the <code>mogrify</code> utility, this option converts any
4050image to the image <a href="formats.html">format</a> you specify.
Cristy594d2772015-11-15 10:47:42 -05004051For a list of image format types supported by ImageMagick, use <a
4052href="command-line-options.html#list">-list format</a>.</p>
Cristy882d9f42015-10-29 16:48:39 -04004053
4054<p>By default the file is written to its original name. However, if the
4055filename extension matches a supported format, the extension is replaced with
4056the image format type specified with <a href="command-line-options.html#format">-format</a>. For
4057example, if you specify <var>tiff</var> as the format type and the
4058input image filename is <var>image.gif</var>, the output image
4059filename becomes <var>image.tiff</var>.</p>
4060
4061<div style="margin: auto;">
4062 <h3 class="magick-header"><a id="format_identify_"></a>-format <var>string</var></h3>
4063</div>
4064
4065<p class="magick-description">output formatted image characteristics.</p>
4066
4067<p>See <a href="escape.html">Format and Print Image
4068Properties</a> for an explanation on how to specify the argument to this
4069option.</p>
4070
4071<div style="margin: auto;">
4072 <h3 class="magick-header"><a id="frame"></a>-frame <var>geometry</var></h3>
4073</div>
4074
4075<p class="magick-description">Surround the image with a border or beveled frame.</p>
4076
Cristyf650f4f2016-04-01 10:53:07 -04004077<p>The color of the border is specified with the <a href="command-line-options.html#alpha-color"
4078>-alpha-color</a> command line option. </p>
Cristy882d9f42015-10-29 16:48:39 -04004079
4080<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
4081height that is added to the dimensions of the image. If no offsets are given
4082in the <var>geometry</var> argument, then the border added is
4083a solid color. Offsets <var>x</var> and <var>y</var>, if present, specify that
4084the width and height of the border is partitioned to form an outer bevel of
4085thickness <var>x</var> pixels and an inner bevel of thickness
4086<var>y</var> pixels. Negative offsets make no sense as frame arguments.
4087</p>
4088
Cristy594d2772015-11-15 10:47:42 -05004089<p>The <a href="command-line-options.html#frame">-frame</a> option is affected by the current <a
4090href="command-line-options.html#compose">-compose</a> setting and assumes that this is using the default
Cristy882d9f42015-10-29 16:48:39 -04004091'<code>Over</code>' composition method. It generates an image of the appropriate
4092size with the current <a href="command-line-options.html#bordercolor">-bordercolor</a> setting, and then
Cristy594d2772015-11-15 10:47:42 -05004093draws the frame of four distinct colors close to the current <a
Cristyf650f4f2016-04-01 10:53:07 -04004094href="command-line-options.html#alpha-color">-alpha-color</a>. The original image is then overlaid onto
Cristy882d9f42015-10-29 16:48:39 -04004095center of this image. This means that with the default compose method of
Cristy594d2772015-11-15 10:47:42 -05004096'<code>Over</code>' any transparent parts may be replaced by the current <a
4097href="command-line-options.html#bordercolor">-bordercolor</a> setting.</p>
Cristy882d9f42015-10-29 16:48:39 -04004098
4099<p>The image composition is not
4100affected by the <a href="command-line-options.html#gravity">-gravity</a> option.</p>
4101
4102
4103<div style="margin: auto;">
4104 <h3 class="magick-header"><a id="frame_import_"></a>-frame</h3>
4105</div>
4106
4107<p class="magick-description">include the X window frame in the imported image. </p>
4108<div style="margin: auto;">
4109 <h3 class="magick-header"><a id="function"></a>-function <var>function</var> <var>parameters</var></h3>
4110</div>
4111
4112<p class="magick-description">Apply a function to channel values.</p>
4113
4114<p>This operator performs calculations based on the given arguments to modify
Cristy594d2772015-11-15 10:47:42 -05004115each of the color values for each previously set <a
4116href="command-line-options.html#channel">-channel</a> in the image. See <a
4117href="command-line-options.html#evaluate">-evaluate</a> for details concerning how the results of the
Cristy882d9f42015-10-29 16:48:39 -04004118calculations are handled.</p>
4119
Cristy594d2772015-11-15 10:47:42 -05004120<p>This is can be considered a multi-argument version of the <a
4121href="command-line-options.html#evaluate">-evaluate</a> operator. (Added in
Cristy882d9f42015-10-29 16:48:39 -04004122ImageMagick 6.4.8−8.)</p>
4123
4124<p>Here, <var>parameters</var> is a comma-separated list of
4125numerical values. The number of values varies depending on which <var>function</var> is selected. Choose the <var>function</var> from:</p>
4126
4127<pre>
4128Polynomial
4129Sinusoid
4130Arcsin
4131Arctan
4132</pre>
4133
4134<p>To print a complete list of <a href="command-line-options.html#function">-function</a> operators,
4135use <a href="command-line-options.html#list">-list function</a>. Descriptions follow.</p>
4136
4137<dl class="dl-horizontal">
4138 <dt>Polynomial</dt>
4139 <dd><p>The <code>Polynomial</code> function takes an arbitrary number of parameters,
4140these being the coefficients of a polynomial, in decreasing order of degree.
4141That is, entering</p>
4142
4143<pre>
4144-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>
4145</pre>
4146
4147<p>will invoke a polynomial function given by</p>
4148
4149<pre>
4150<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>,
4151</pre>
4152
4153<p>where <b><var>u</var></b> is pixel's original normalized channel value.</p>
4154
4155<p>The <code>Polynomial</code> function can be used in place of <code>Set</code>
4156(the <var>constant</var> polynomial) and <code>Add</code>, <code>Divide</code>,
4157<code>Multiply</code>, and <code>Subtract</code> (some <var>linear</var>
Cristy594d2772015-11-15 10:47:42 -05004158polynomials) of the <a href="command-line-options.html#evaluate">-evaluate</a> operator. The <a
4159href="command-line-options.html#level">-level</a> operator also affects channels linearly. Some
Cristy882d9f42015-10-29 16:48:39 -04004160correspondences follow.</p>
4161
4162<table class="table table-condensed table-striped">
4163 <tr>
4164 <td>-evaluate Set <var>value</var> </td>
4165 <td>-function Polynomial <var>value</var></td>
4166 <td>(Constant functions; set <var>value</var>×100% gray when channels are RGB.)</td>
4167 </tr>
4168 <tr>
4169 <td>-evaluate Add <var>value</var> </td>
4170 <td>-function Polynomial 1,<var>value</var></td>
4171 </tr>
4172 <tr>
4173 <td>-evaluate Subtract <var>value</var> </td>
4174 <td>-function Polynomial 1,−<var>value</var></td>
4175 </tr>
4176 <tr>
4177 <td>-evaluate Multiply <var>value</var> </td>
4178 <td>-function Polynomial <var>value</var>,0</td>
4179 </tr>
4180 <tr>
4181 <td>+level black% x white%</td>
4182 <td>-function Polynomial A,B</td>
4183 <td>(Reduce contrast. Here, A=(white-black)/100 and B=black/100.)</td>
4184 </tr>
4185</table>
4186
4187<p>The <code>Polynomial</code> function gives great versatility, since
4188polynomials can be used to fit any continuous curve to any degree of accuracy
4189desired.</p>
4190
4191</dd>
4192<dt>Sinusoid</dt>
4193<dd>
4194<p>The <code>Sinusoid</code> function can be used to vary the channel values
4195sinusoidally by setting frequency, phase shift, amplitude, and a bias. These
4196values are given as one to four parameters, as follows,</p>
4197
4198<pre>
4199-function <code>Sinusoid</code> <var>freq</var>,[<var>phase</var>,[<var>amp</var>,[<var>bias</var>]]]
4200</pre>
4201
4202<p>where <var>phase</var> is in degrees. (The domain [0,1] of the function
4203corresponds to 0 through <var>freq</var>×360 degrees.)
4204The result is that if a pixel's normalized channel value is originally
4205<b><var>u</var></b>, its resulting normalized value is given by </p>
4206
4207<pre>
4208<var>amp</var> * sin(2*π* (<var>freq</var> * <b><var>u</var></b> + <var>phase</var> / 360)) + <var>bias</var>
4209</pre>
4210
4211<p> For example, the following generates a curve that starts and ends at 0.9
4212(when <b><var>u</var></b>=0 and 1, resp.), oscillating three times between
4213.7−.2=.5 and .7+.2=.9. </p>
4214
4215<pre>
4216-function Sinusoid 3,-90,.2,.7
4217</pre>
4218
4219<p>The default values of <var>amp</var> and <var>bias</var> are both .5. The default for <var>phase</var>
4220is 0.</p>
4221
4222<p>The <code>Sinusoid</code> function generalizes <code>Sin</code> and
4223<code>Cos</code> of the <a href="command-line-options.html#evaluate">-evaluate</a> operator by allowing
4224varying amplitude, phase and bias. The correspondence is as follows.</p>
4225
4226<table class="table table-condensed table-striped">
4227 <tr>
4228 <td>-evaluate Sin <var>freq</var> </td>
4229 <td>-function Sinusoid <var>freq</var>,0 </td>
4230 </tr>
4231 <tr>
4232 <td>-evaluate Cos <var>freq</var> </td>
4233 <td>-function Sinusoid <var>freq</var>,90 </td>
4234 </tr>
4235</table>
4236 </dd>
4237<dt>ArcSin</dt>
4238<dd>
4239<p>The <code>ArcSin</code> function generates the inverse curve of a Sinusoid,
4240and can be used to generate cylindrical distortion and displacement maps.
4241The curve can be adjusted relative to both the input values and output range
4242of values.</p>
4243
4244<pre>
4245-function <code>ArcSin</code> <var>width</var>,[<var>center</var>,[<var>range</var>,[<var>bias</var>]]]
4246</pre>
4247
4248<p>with all values given in terms of normalized color values (0.0 for black,
42491.0 for white). Defaulting to values covering the full range from 0.0 to 1.0
4250for bout input (<var>width</var>), and output (<var>width</var>) values. '<code>1.0,0.5,1.0,0.5</code>' </p>
4251
4252<pre>
4253<var>range</var>/π * asin( 2/<var>width</var> * ( <b><var>u</var></b> - <var>center</var> ) ) + <var>bias</var>
4254</pre>
4255
4256</dd>
4257<dt>ArcTan</dt>
4258<dd>
4259<p>The <code>ArcTan</code> function generates a curve that smooth crosses from
4260limit values at infinities, though a center using the given slope value.
4261All these values can be adjusted via the arguments.</p>
4262
4263<pre>
4264-function <code>ArcTan</code> <var>slope</var>,[<var>center</var>,[<var>range</var>,[<var>bias</var>]]]
4265</pre>
4266
4267<p>Defaulting to '<code>1.0,0.5,1.0,0.5</code>'.
4268</p>
4269
4270<pre>
4271<var>range</var>/π * atan( <var>slope</var>*π * ( <b><var>u</var></b> - <var>center</var> ) ) + <var>bias</var>
4272</pre>
4273 </dd>
Cristy594d2772015-11-15 10:47:42 -05004274 </tr>
Cristy882d9f42015-10-29 16:48:39 -04004275</dl>
4276
4277
4278
4279<div style="margin: auto;">
4280 <h3 class="magick-header"><a id="fuzz"></a>-fuzz <var>distance</var>{<var>%</var>}</h3>
4281</div>
4282
4283<p class="magick-description">Colors within this <var>distance</var> are considered equal.</p>
4284
4285<p>A number of algorithms search for a target color. By default the color must
4286be exact. Use this option to match colors that are close to the target color
4287in RGB space. For example, if you want to automagically trim the edges of an
4288image with <a href="command-line-options.html#trim">-trim</a> but the image was scanned and the target
4289background color may differ by a small amount. This option can account for
4290these differences.</p>
4291
4292<p>The <var>distance</var> can be in absolute intensity units or, by
4293appending <code>%</code> as a percentage of the maximum possible intensity (255,
429465535, or 4294967295).</p>
4295
Cristy594d2772015-11-15 10:47:42 -05004296<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 -04004297
4298
4299<div style="margin: auto;">
4300 <h3 class="magick-header"><a id="fx"></a>-fx <var>expression</var></h3>
4301</div>
4302
4303<p class="magick-description">apply a mathematical expression to an image or image channels.</p>
4304
4305<p>If the first character of <var>expression</var> is <code>@</code>,
4306the expression is read from a file titled by the remaining characters in the
4307string.</p>
4308
4309<p>See <a href="fx.html">FX,
4310The Special Effects Image Operator</a> for a detailed discussion of this
4311option.</p>
4312
4313
4314<div style="margin: auto;">
4315 <h3 class="magick-header"><a id="gamma"></a>-gamma <var>value</var></h3>
4316</div>
4317
4318<p class="magick-description">level of gamma correction.</p>
4319
4320<p>The same color image displayed on two different workstations may look
4321different due to differences in the display monitor. Use gamma correction to
4322adjust for this color difference. Reasonable values extend from
4323<code>0.8</code> to <code>2.3</code>. Gamma less than 1.0 darkens the image and
4324gamma greater than 1.0 lightens it. Large adjustments to image gamma may
4325result in the loss of some image information if the pixel quantum size is only
4326eight bits (quantum range 0 to 255).</p>
4327
4328<p>Gamma adjusts the image's channel values pixel-by-pixel according to
4329a power law, namely, pow(pixel,1/gamma) or pixel^(1/gamma), where pixel is the
4330normalized or 0 to 1 color value. For example, using a value of gamma=2 is the
4331same as taking the square root of the image.</p>
4332
4333<p>You can apply separate gamma values to the red, green, and blue channels of
4334the image with a gamma value list delimited with commas (e.g.,
4335<code>1.7,2.3,1.2</code>).</p>
4336
4337<p>Use <a href="command-line-options.html#gamma">+gamma <var>value</var></a> to set the
4338image gamma level without actually adjusting the image pixels. This option
4339is useful if the image is of a known gamma but not set as an image attribute
4340(e.g. PNG images). Write the "file gamma" which is the reciprocal of the
4341display gamma; e.g., if your image is sRGB and you want to write a PNG gAMA
4342chunk, use</p>
4343
4344<pre>
4345convert input.png +gamma .45455 output.png
4346</pre>
4347
4348<p>(0.45455 is 1/2.2)</p>
4349
4350<p>Note that gamma adjustments are also available via the <a href="command-line-options.html#level">-level</a> operator.</p>
4351
4352<div style="margin: auto;">
Cristy594d2772015-11-15 10:47:42 -05004353 <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 -04004354</div>
4355
4356<p class="magick-description">Blur the image with a Gaussian operator.</p>
4357
4358<p>Convolve the image with a Gaussian or normal distribution using the given
Cristy594d2772015-11-15 10:47:42 -05004359<var >Sigma</var> value. The formula is:</p>
Cristy882d9f42015-10-29 16:48:39 -04004360
Cristy594d2772015-11-15 10:47:42 -05004361<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 -04004362
Cristy594d2772015-11-15 10:47:42 -05004363<p>The <var >Sigma</var> value is the important argument, and
Cristy882d9f42015-10-29 16:48:39 -04004364determines the actual amount of blurring that will take place. </p>
4365
Cristy594d2772015-11-15 10:47:42 -05004366<p>The <var >Radius</var> is only used to determine the size of the
Cristy882d9f42015-10-29 16:48:39 -04004367array which will hold the calculated Gaussian distribution. It should be an
4368integer. If not given, or set to zero, IM will calculate the largest possible
4369radius that will provide meaningful results for the Gaussian distribution.
4370</p>
4371
Cristy594d2772015-11-15 10:47:42 -05004372<p>The larger the <var >Radius</var> the radius the slower the
4373operation is. However too small a <var >Radius</var>, and sever
4374aliasing effects may result. As a guideline, <var >Radius</var>
4375should be at least twice the <var >Sigma</var> value, though three
Cristy882d9f42015-10-29 16:48:39 -04004376times will produce a more accurate result. </p>
4377
4378<p>This differs from the faster <a href="command-line-options.html#blur">-blur</a> operator in that a
4379full 2-dimensional convolution is used to generate the weighted average of the
4380neighboring pixels. </p>
4381
4382<p>The <a href="command-line-options.html#virtual-pixel">-virtual-pixel</a> setting will determine how
4383pixels which are outside the image proper are blurred into the final result.
4384</p>
4385
4386
4387<div style="margin: auto;">
4388 <h3 class="magick-header"><a id="geometry"></a>-geometry <var>geometry</var></h3>
4389</div>
4390
4391<p class="magick-description">Set the preferred size and location of the image.</p>
4392
4393<p>See <a href="command-line-processing.html#geometry">Image Geometry</a> for complete details about the <em class="arg">geometry</em> argument.</p>
4394
4395<div style="margin: auto;">
4396 <h3 class="magick-header"><a id="gravity"></a>-gravity <var>type</var></h3>
4397</div>
4398
4399<p class="magick-description">Sets the current gravity suggestion for various other settings and options.</p>
4400
4401<p>Choices include: <code>NorthWest</code>, <code>North</code>,
4402<code>NorthEast</code>, <code>West</code>, <code>Center</code>, <code>East</code>,
Cristy594d2772015-11-15 10:47:42 -05004403<code>SouthWest</code>, <code>South</code>, <code>SouthEast</code>. Use <a
4404href="command-line-options.html#list">-list gravity</a> to get a complete list of <a
4405href="command-line-options.html#gravity">-gravity</a> settings available in your ImageMagick
Cristy882d9f42015-10-29 16:48:39 -04004406installation.</p>
4407
4408<p>The direction you choose specifies where to position text or subimages. For
4409example, a gravity of <code>Center</code> forces the text to be centered within
Cristy776113a2016-04-29 12:01:19 -04004410the image. By default, the image gravity is <code>undefined</code>. See <a
Cristy594d2772015-11-15 10:47:42 -05004411href="command-line-options.html#draw">-draw</a> for more details about graphic primitives. Only the
4412text primitive of <a href="command-line-options.html#draw">-draw</a> is affected by the <a
4413href="command-line-options.html#gravity">-gravity</a> option.</p>
Cristy882d9f42015-10-29 16:48:39 -04004414
4415<p>The <a href="command-line-options.html#gravity">-gravity</a> option is also used in concert with the
4416<a href="command-line-options.html#geometry">-geometry</a> setting and other settings or options that
Cristy594d2772015-11-15 10:47:42 -05004417take <var>geometry</var> as an argument, such as the <a
4418href="command-line-options.html#crop">-crop</a> option. </p>
Cristy882d9f42015-10-29 16:48:39 -04004419
4420<p>If a <a href="command-line-options.html#gravity">-gravity</a> setting occurs before another option
4421or setting having a <var>geometry</var> argument that specifies an
4422offset, the offset is usually applied to the point within the image suggested
4423by the <a href="command-line-options.html#gravity">-gravity</a> argument. Thus, in the following
4424command, for example, suppose the file <code>image.png</code> has dimensions
4425200x100. The offset specified by the argument to <a href="command-line-options.html#region">-region</a>
4426is (−40,+20). The argument to <a href="command-line-options.html#gravity">-gravity</a> is
4427<code>Center</code>, which suggests the midpoint of the image, at the point
4428(100,50). The offset (−40,20) is applied to that point, giving
4429(100−40,50+20)=(60,70), so the specified 10x10 region is located at
4430that point. (In addition, the <a href="command-line-options.html#gravity">-gravity</a> affects the
4431region itself, which is <var>centered</var> at the pixel
4432coordinate (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>
4433
4434<pre>
4435convert image.png -gravity Center -region 10x10-40+20 \
4436 -negate output.png
4437</pre>
4438
Cristy594d2772015-11-15 10:47:42 -05004439<p>When used as an option to <a href="composite.html">composite</a>, <a
4440href="command-line-options.html#gravity">-gravity</a> gives the direction that the image gravitates
Cristy882d9f42015-10-29 16:48:39 -04004441within the composite.</p>
4442
Cristy594d2772015-11-15 10:47:42 -05004443<p>When used as an option to <a href="montage.html">montage</a>, <a
4444href="command-line-options.html#gravity">-gravity</a> gives the direction that an image gravitates
Cristy882d9f42015-10-29 16:48:39 -04004445within a tile. The default gravity is <code>Center</code> for this purpose.</p>
4446
4447
4448<div style="margin: auto;">
4449 <h3 class="magick-header"><a id="grayscale"></a>-grayscale <var>method</var></h3>
4450</div>
4451
4452<p class="magick-description">convert image to grayscale.</p>
4453
Cristy594d2772015-11-15 10:47:42 -05004454<p>This will use one of the <a href="command-line-options.html#intensity" >-intensity</a> methods to
Cristy882d9f42015-10-29 16:48:39 -04004455convert the given image into a linear-grayscale image. </p>
4456
4457<p>For example, to convert an image to (linear) Rec709Luminance grayscale, type:</p>
4458
4459<pre>
4460convert in.png -grayscale Rec709Luminance out.png
4461</pre>
4462
4463<p>which is equivalent to:</p>
4464
4465<pre>
4466convert in.png -colorspace gray out.png
4467</pre>
4468
4469<p>Similarly, to convert an image to (non-linear) Rec709Luma grayscale, type:</p>
4470
4471<pre>
4472convert in.png -grayscale Rec709Luma out.png
4473</pre>
4474
4475<p>which is equivalent to:</p>
4476
4477<pre>
4478convert in.png -set colorspace RGB -colorspace gray out.png
4479</pre>
4480
4481<p>Note that a 'colorspace' intensity method will produce the same result
4482regardless of the current colorpsace of the image. But a 'mathematical'
4483intensity method will depend on the current colorspace the image is currently
4484using. </p>
4485
Cristy594d2772015-11-15 10:47:42 -05004486<p>While this operation uses an <a href="command-line-options.html#intensity" >-intensity</a> method,
4487it does not use or set the <a href="command-line-options.html#intensity" >-intensity</a> setting, so
Cristy882d9f42015-10-29 16:48:39 -04004488will not effect other operations that may use that setting.</p>
4489
4490
4491<div style="margin: auto;">
4492 <h3 class="magick-header"><a id="green-primary"></a>-green-primary <var>x,y</var></h3>
4493</div>
4494
4495<p class="magick-description">green chromaticity primary point.</p>
4496
4497
4498<div style="margin: auto;">
4499 <h3 class="magick-header"><a id="hald-clut"></a>-hald-clut</h3>
4500</div>
4501
4502<p class="magick-description">apply a Hald color lookup table to the image.</p>
4503
4504<p>A Hald color lookup table is a 3-dimensional color cube mapped to 2
4505dimensions. Create it with the <code>HALD:</code> prefix (e.g. HALD:8). You
4506can apply any color transformation to the Hald image and then use this option
4507to apply the transform to the image. </p>
4508
4509<pre>
4510convert image.png hald.png -hald-clut transform.png
4511</pre>
4512
4513<p>This option provides a convenient method for you to use Gimp or Photoshop
4514to make color corrections to the Hald CLUT image and subsequently apply them
4515to multiple images using an ImageMagick script. </p>
4516
4517<p>Note that the representation is only of the normal RGB color space and that
4518the whole color value triplet is used for the interpolated lookup of the
Cristy594d2772015-11-15 10:47:42 -05004519represented Hald color cube image. Because of this the operation is not <a
4520href="command-line-options.html#channel" >-channel</a> setting effected, nor can it adjust or modify an
Cristy882d9f42015-10-29 16:48:39 -04004521images transparency or alpha/matte channel.</p>
4522
Cristy594d2772015-11-15 10:47:42 -05004523<p>See also <a href="command-line-options.html#clut" >-clut</a> which provides color value replacement
Cristy769d8892016-01-19 18:11:14 -05004524of the individual color channels, usually involving a simpler grayscale
4525image. E.g: grayscale to color replacement, or modification by a histogram
Cristy882d9f42015-10-29 16:48:39 -04004526mapping. </p>
4527
4528
4529<div style="margin: auto;">
4530 <h3 class="magick-header"><a id="help"></a>-help</h3>
4531</div>
4532
4533<p class="magick-description">print usage instructions.</p>
4534
4535<div style="margin: auto;">
4536 <h3 class="magick-header"><a id="highlight-color"></a>-highlight-color <var>color</var></h3>
4537</div>
4538
4539<p class="magick-description">when comparing images, emphasize pixel differences with this color.</p>
4540
4541<div style="margin: auto;">
4542 <h3 class="magick-header"><a id="hough-lines"></a>-hough-lines <var>width</var>x<var>height</var>{<var>+threshold</var>}</h3>
4543</div>
4544
4545<p class="magick-description">identify straight lines in the image (e.g. -hough-lines 9x9+195).</p>
4546
4547<p>Use the Hough line detector with any binary edge extracted image to locate and draw any straight lines that it finds.</p>
4548
4549<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>.
4550
4551<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>
4552
Cristy594d2772015-11-15 10:47:42 -05004553<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 -04004554
Cristy594d2772015-11-15 10:47:42 -05004555<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 -04004556
Cristy594d2772015-11-15 10:47:42 -05004557<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 -04004558
4559<p>A text file listing the endpoints and counts may be created by using the suffix, .mvg, for the output image.</p>
4560
Cristy594d2772015-11-15 10:47:42 -05004561<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 -04004562
4563<div style="margin: auto;">
4564 <h3 class="magick-header"><a id="iconGeometry"></a>-iconGeometry <var>geometry</var></h3>
4565</div>
4566
4567<p class="magick-description">specify the icon geometry.</p>
4568
4569<p>Offsets, if present in the geometry specification, are handled in the same
4570manner as the <a href="command-line-options.html#geometry">-geometry</a> option, using X11 style to
4571handle negative offsets.</p>
4572
4573<p>See <a href="command-line-processing.html#geometry">Image Geometry</a> for complete details about the <em class="arg">geometry</em> argument.</p>
4574
4575<div style="margin: auto;">
4576 <h3 class="magick-header"><a id="iconic"></a>-iconic</h3>
4577</div>
4578
4579<p class="magick-description">start in icon mode in X Windows", 'animate', 'display</p>
4580
4581<div style="margin: auto;">
4582 <h3 class="magick-header"><a id="identify"></a>-identify</h3>
4583</div>
4584
4585<p class="magick-description">identify the format and characteristics of the image.</p>
4586
4587<p>This information is printed: image scene number; image name; image size;
4588the image class (<var>DirectClass</var> or <var>PseudoClass</var>); the total number of unique colors; and the
4589number of seconds to read and transform the image. Refer to <a href="miff.html">MIFF</a> for
4590a description of the image class.</p>
4591
4592<p>If <a href="command-line-options.html#colors">-colors</a> is also specified, the total unique colors
Cristy594d2772015-11-15 10:47:42 -05004593in the image and color reduction error values are printed. Refer to <a
4594href="quantize.html">color
Cristy882d9f42015-10-29 16:48:39 -04004595reduction algorithm</a> for a description of these values.</p>
4596
4597<p>If <a href="command-line-options.html#verbose">-verbose</a> precedes this option, copious
4598amounts of image properties are displayed including image statistics, profiles,
4599image histogram, and others.</p>
4600
4601<div style="margin: auto;">
4602 <h3 class="magick-header"><a id="ift"></a>-ift</h3>
4603</div>
4604
4605<p class="magick-description">implements the inverse discrete Fourier transform (DFT).</p>
4606
4607<p>This option is new as of ImageMagick 6.5.4-3 (and now working for Windows
4608users in ImageMagick 6.6.0-9). It transforms a pair of magnitude and phase
4609images from the frequency domain to a single image in the normal or spatial
Cristy594d2772015-11-15 10:47:42 -05004610domain. See for example, <a
4611href="http://en.wikipedia.org/wiki/Fourier_transform">Fourier Transform</a>,
Cristy882d9f42015-10-29 16:48:39 -04004612<a href="http://en.wikipedia.org/wiki/DFT">Discrete Fourier Transform</a> and
4613<a href="http://en.wikipedia.org/wiki/FFT">Fast Fourier Transform</a>.</p>
4614
4615<p>For example, depending upon the image format used to store the result of
4616the <a href="command-line-options.html#fft">-fft</a>, one would use either</p>
4617
4618<pre>
4619convert fft_image.miff -ift fft_image_ift.png
4620</pre>
4621
4622<p>or</p>
4623
4624<pre>
4625convert fft_image-0.png fft_image-1.png -ift fft_image_ift.png
4626</pre>
4627
4628<p>The resulting image may need to be cropped due to padding introduced when
Cristy594d2772015-11-15 10:47:42 -05004629the original image, prior to the <a href="command-line-options.html#fft">-fft</a> or <a
4630href="command-line-options.html#fft">+fft</a>, was not square or even dimensioned. Any padding is at
Cristy882d9f42015-10-29 16:48:39 -04004631the right and/or bottom sides of the image.</p>
4632
4633<p>The <a href="http://www.fftw.org/">FFTW</a> delegate library is required to
4634use <a href="command-line-options.html#ift">-ift</a>.</p>
4635
4636<p>Use <a href="command-line-options.html#ift">+ift</a> (with HDRI enabled) to transform a pair of real
4637and imaginary images from the frequency domain to a single image in the normal
4638(spatial) domain.</p>
4639
Cristy594d2772015-11-15 10:47:42 -05004640<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 -04004641
4642<div style="margin: auto;">
4643 <h3 class="magick-header"><a id="immutable"></a>-immutable</h3>
4644</div>
4645
4646<p class="magick-description">make image immutable.</p>
4647
4648<div style="margin: auto;">
4649 <h3 class="magick-header"><a id="implode"></a>-implode <var>factor</var></h3>
4650</div>
4651
4652<p class="magick-description">implode image pixels about the center.</p>
4653
4654<div style="margin: auto;">
4655 <h3 class="magick-header"><a id="insert"></a>-insert <var>index</var></h3>
4656</div>
4657
4658<p class="magick-description">insert the last image into the image sequence.</p>
4659
4660<p>This option takes last image in the current image sequence and inserts it
4661at the given index. If a negative index is used, the insert position is
4662calculated before the last image is removed from the sequence. As such
4663<code>-insert -1</code> will result in no change to the image sequence.</p>
4664
4665<p>The <code>+insert</code> option is equivalent to <code>-insert -1</code>. In
4666other words, insert the last image, at the end of the current image sequence.
4667Consequently this has no effect on the image sequence order.</p>
4668
4669<div style="margin: auto;">
4670 <h3 class="magick-header"><a id="intensity"></a>-intensity <var>method</var></h3>
4671</div>
4672
4673<p class="magick-description">method to generate intensity value from pixel.</p>
4674
4675<p>ImageMagick provides a number of methods used in situations where an
4676operator needs to determine a single grayscale value for some purpose, from
4677an image with red, green, and blue pixel components. Typically the linear
4678<code>Rec709Luminance</code> formula is used, which is the same formula used when
4679converting images to <code>-colorspace gray</code>. </p>
4680
4681<p>The following formulas are currently provided, and will first convert
4682the pixel values to linear-RGB or non-linear sRGB colorspace before
4683being applied to calculate the final greyscale value. </p>
4684
4685<dl class="dl-horizontal">
4686<dt>Rec601Luma</dt><dd> 0.298839R' + 0.586811G'+ 0.114350B'</dd>
4687<dt>Rec601Luminance</dt><dd> 0.298839R + 0.586811G + 0.114350B</dd>
4688<dt>Rec709Luma</dt><dd> 0.212656R' + 0.715158G' + 0.072186B'</dd>
4689<dt>Rec709Luminance</dt><dd> 0.212656R + 0.715158G + 0.072186B</dd>
4690<dt>Brightness</dt><dd> max(R', G', B')</dd>
4691<dt>Lightness</dt><dd> (min(R', G', B') + max(R', G', B')) / 2.0</dd>
4692</dl>
4693
4694<p>Note that the above R,G,B values is the image's linear-RGB values, while
4695R',G',B' are sRGB non-linear values. </p>
4696
4697<p>These intensity methods are mathematical in nature and will use the
4698current value in the images respective R,G,B channel regardless of
4699what that is, or what colorspace the image is currently using.</p>
4700
4701<dl class="dl-horizontal">
4702<dt>Average</dt><dd>(R + G + B) / 3.0</dd>
4703<dt>MS</dt><dd>(R^2 + G^2 + B^2) / 3.0</dd>
4704<dt>RMS</dt><dd>sqrt( (R^2 + G^2 + B^2) / 3.0 )</dd>
4705</dl>
4706
4707<p>These methods are often used for other purposes, such as generating a
Cristy594d2772015-11-15 10:47:42 -05004708grayscale difference image between two color images (using <a href="command-line-options.html#compose"
4709>-compose</a> '<code>Difference</code>' composition. </p>
Cristy882d9f42015-10-29 16:48:39 -04004710
4711<p> For example The 'MS' (Mean Squared) setting is good for minimizing color
4712error comparisions. While... The method 'RMS' (Root Mean Squared) for
4713example is appropriate for calculating color vector distance, from a color
Cristy594d2772015-11-15 10:47:42 -05004714difference image. This is equivalent to the color only component of the <a
4715href="command-line-options.html#fuzz" >-fuzz</a> factor color compare setting. </p>
Cristy882d9f42015-10-29 16:48:39 -04004716
Cristy594d2772015-11-15 10:47:42 -05004717<p>See also <a href="command-line-options.html#grayscale" >-grayscale</a> which applies one of the above
4718grayscaling formula directly to an image without setting the <a
4719href="command-line-options.html#intensity" >-intensity</a> setting.</p>
Cristy882d9f42015-10-29 16:48:39 -04004720
Cristy594d2772015-11-15 10:47:42 -05004721<p>The <a href="command-line-options.html#colorspace" >-colorspace gray</a> image conversion also uses
Cristy882d9f42015-10-29 16:48:39 -04004722the current intensity setting, but will always convert the image to the
4723appropriate sRGB or linear-RGB colorspace before appling the above
4724function.</p>
4725
4726<p>To print a complete list of possible pixel intensity setting methods, use <a href="command-line-options.html#list">-list intensity</a>.</p>
4727
Cristy594d2772015-11-15 10:47:42 -05004728<p>Operators affected by the <a href="command-line-options.html#intensity" >-intensity</a> setting include:</p>
Cristy882d9f42015-10-29 16:48:39 -04004729
4730<pre>
4731-adaptive-blur
4732-adaptive-sharpen
4733-black-threshold
4734-clut (when mapping greyscale CLUT image to alpha channel if set by -channels)
4735-colors for gray colorspace
4736-compose {LightenIntensity, DarkenIntensity, CopyOpacity, CopyBlack}
4737-contrast-stretch
4738-distort {ErodeIntensity, DilateIntensity}
4739-normalize
4740-random-threshold
4741-selective-blur
4742-shade
4743-threshold
4744-tint
4745-white-threshold
4746</pre>
4747
4748<div style="margin: auto;">
4749 <h3 class="magick-header"><a id="intent"></a>-intent <var>type</var></h3>
4750</div>
4751
4752<p class="magick-description">use this type of rendering intent when managing the image color.</p>
4753
4754<p>Use this option to affect the color management operation of an image (see
4755<a href="command-line-options.html#profile">-profile</a>). Choose from these intents: <code>Absolute,
4756Perceptual, Relative, Saturation</code>.</p>
4757
4758<p>The default intent is Perceptual for the sRGB colorspace and undefined for the RGB and gray colorspaces.</p>
4759
4760<p>To print a complete list of rendering intents, use <a href="command-line-options.html#list">-list intent</a>.</p>
4761
4762<div style="margin: auto;">
4763 <h3 class="magick-header"><a id="interlace"></a>-interlace <var>type</var></h3>
4764</div>
4765
4766<p class="magick-description">the type of interlacing scheme.</p>
4767
4768<p>Choose from:</p>
4769
4770<pre>
4771none
4772line
4773plane
4774partition
4775JPEG
4776GIF
4777PNG
4778</pre>
4779
4780<p>This option is used to specify the type of interlacing scheme for raw image
4781formats such as <code>RGB</code> or <code>YUV</code>.</p>
4782
4783<p><code>None</code> means do not interlace (RGBRGBRGBRGBRGBRGB...),</p>
4784
4785<p><code>Line</code> uses scanline interlacing (RRR...GGG...BBB...RRR...GGG...BBB...), and.</p>
4786
4787<p><code>Plane</code> uses plane interlacing (RRRRRR...GGGGGG...BBBBBB...).</p>
4788
4789<p><code>Partition</code> is like plane except the different planes are saved to
4790individual files (e.g. image.R, image.G, and image.B).</p>
4791
4792<p>Use <code>Line</code> or <code>Plane</code> to create an <code>interlaced
4793PNG</code> or <code>GIF</code> or <code>progressive JPEG</code> image.</p>
4794
4795<p>To print a complete list of interlacing schemes, use <a href="command-line-options.html#list">-list
4796interlace</a>.</p>
4797
4798<div style="margin: auto;">
4799 <h3 class="magick-header"><a id="interpolate"></a>-interpolate <var>type</var></h3>
4800</div>
4801
4802<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>
4803
4804<p>When looking up the color of a pixel using a non-integer floating point
4805value, you typically fall in between the pixel colors defined by the source
4806image. This setting determines how the color is determined from the colors of
4807the pixels surrounding that point. That is how to determine the color of a
4808point that falls between two, or even four different colored pixels. </p>
4809
4810<dl class="dl-horizontal">
4811 <dt>integer</dt>
4812 <dd>The color of the top-left pixel (floor function)</dd>
4813 <dt>nearest-neighbor</dt>
4814 <dd>The nearest pixel to the lookup point (rounded function)</dd>
4815 <dt>average</dt>
4816 <dd>The average color of the surrounding four pixels</dd>
4817 <dt>bilinear</dt>
4818 <dd>A double linear interpolation of pixels (the default)</dd>
4819 <dt>mesh</dt>
4820 <dd>Divide area into two flat triangular interpolations</dd>
4821 <dt>bicubic</dt>
4822 <dd>Fitted bicubic-spines of surrounding 16 pixels</dd>
4823 <dt>spline</dt>
4824 <dd>Direct spline curves (colors are blurred)</dd>
4825 <dt>filter</dt>
4826 <dd>Use resize <a href="command-line-options.html#filter">-filter</a> settings</dd>
4827</dl>
4828
Cristy594d2772015-11-15 10:47:42 -05004829<p>This most important for distortion operators such as <a href="command-line-options.html#distort"
4830>-distort</a>, <a href="command-line-options.html#implode" >-implode</a>, <a href="command-line-options.html#transform"
4831>-transform</a> and <a href="command-line-options.html#fx" >-fx</a>. </p>
Cristy882d9f42015-10-29 16:48:39 -04004832
4833<p>To print a complete list of interpolation methods, use <a href="command-line-options.html#list">-list interpolate</a>.</p>
4834
Cristy594d2772015-11-15 10:47:42 -05004835<p>See also <a href="command-line-options.html#virtual-pixel" >-virtual-pixel</a>, for control of the
Cristy882d9f42015-10-29 16:48:39 -04004836lookup for positions outside the boundaries of the image. </p>
4837
4838
4839<div style="margin: auto;">
4840 <h3 class="magick-header"><a id="interline-spacing"></a>-interline-spacing <var>value</var></h3>
4841</div>
4842
4843<p class="magick-description">the space between two text lines.</p>
4844
4845<div style="margin: auto;">
4846 <h3 class="magick-header"><a id="interword-spacing"></a>-interword-spacing <var>value</var></h3>
4847</div>
4848
4849<p class="magick-description">the space between two words.</p>
4850
4851<div style="margin: auto;">
4852 <h3 class="magick-header"><a id="kerning"></a>-kerning <var>value</var></h3>
4853</div>
4854
4855<p class="magick-description">the space between two letters.</p>
4856
4857<div style="margin: auto;">
Cristy594d2772015-11-15 10:47:42 -05004858 <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 -04004859</div>
4860
4861<p class="magick-description">edge preserving noise reduction filter.</p>
4862
Cristy594d2772015-11-15 10:47:42 -05004863<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 -04004864
4865
4866<div style="margin: auto;">
4867 <h3 class="magick-header"><a id="label"></a>-label <var>name</var></h3>
4868</div>
4869
4870<p class="magick-description">assign a label to an image.</p>
4871
4872<p>Use this option to assign a specific label to the image, as it is read in
Cristy594d2772015-11-15 10:47:42 -05004873or created. You can use the <a href="command-line-options.html#set" >-set</a> operation to re-assign
Cristy882d9f42015-10-29 16:48:39 -04004874a the labels of images already read in. Image formats such as TIFF, PNG,
4875MIFF, supports saving the label information with the image.</p>
4876
4877<p>When saving an image to a <var>PostScript</var> file, any label
4878assigned to an image is used as a header string to print above the postscript
4879image. </p>
4880
4881<p>You can include the image filename, type, width, height, or other image
4882attribute by embedding special format character. See <a href="escape.html">Format and Print Image
4883Properties</a> for details of the percent escape codes.</p>
4884
4885<p>For example,</p>
4886
4887<pre>
4888-label "%m:%f %wx%h" bird.miff
4889</pre>
4890
4891<p>assigns an image label of <code>MIFF:bird.miff 512x480</code> to the
4892"<code>bird.miff</code>" image and whose width is 512 and height is 480, as it
4893is read in. If a <a href="command-line-options.html#label">+label</a> option was used instead, any
4894existing label present in the image would be used. You can remove all labels
4895from an image by assigning the empty string. </p>
4896
4897<p>A label is not drawn on the image, but is embedded in the image datastream
4898via <var>Label</var> tag or similar mechanism. If you want the label to be
4899visible on the image itself, use the <a href="command-line-options.html#draw">-draw</a> option, or
4900during the final processing in the creation of an image montage.</p>
4901
4902<p>If the first character of <var>string</var> is <var>@</var>, the image label is read from a file titled by the
4903remaining characters in the string. Labels in a file are literal, no embedded
4904formatting characters are recognized.</p>
4905
4906
4907<div style="margin: auto;">
Cristy594d2772015-11-15 10:47:42 -05004908 <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 -04004909</div>
4910
4911<p class="magick-description">perform local adaptive threshold.</p>
4912
4913<p>Adaptively threshold each pixel based on the value of pixels in a
4914surrounding window. If the current pixel is lighter than this average plus
4915the optional <code>offset</code>, then it is made white, otherwise it is made
4916black. Small variations in pixel values such as found in scanned documents
4917can be ignored if offset is positive. A negative offset will make it more
4918sensitive to those small variations. </p>
4919
4920<p>This is commonly used to threshold images with an uneven background. It is
4921based on the assumption that average color of the small window is the
4922the local background color, from which to separate the foreground color. </p>
4923
4924
4925<div style="margin: auto;">
4926 <h3 class="magick-header"><a id="layers"></a>-layers <var>method</var></h3>
4927</div>
4928
4929<p class="magick-description">handle multiple images forming a set of image layers or animation frames.</p>
4930
4931<p>Perform various image operation methods to a ordered sequence of images
4932which may represent either a set of overlaid 'image layers', a GIF disposal
4933animation, or a fully-'coalesced' animation sequence. </p>
4934
4935<table class="table table-condensed table-striped">
4936 <tbody>
4937 <tr>
4938 <th style="width: 8%">Method</th>
4939 <th>Description</th>
4940 </tr>
4941
4942 <tr>
4943 <td>compare-any</td>
4944 <td>Crop the second and later frames to the smallest rectangle
Cristy594d2772015-11-15 10:47:42 -05004945 that contains all the differences between the two images. No GIF <a
4946 href="command-line-options.html#dispose" >-dispose</a> methods are taken into account. </td>
Cristy882d9f42015-10-29 16:48:39 -04004947 </tr>
4948
Cristy594d2772015-11-15 10:47:42 -05004949 <tr><td></td><td>This exactly the same as the <a href="command-line-options.html#deconstruct"
4950 >-deconstruct</a> operator, and does not preserve animations normal
Cristy882d9f42015-10-29 16:48:39 -04004951 working, especially when animation used layer disposal methods such as
4952 '<code>Previous</code>' or '<code>Background</code>'. </td>
4953 </tr>
4954
4955 <tr>
4956 <td>compare-clear</td>
4957 <td>As '<code>compare-any</code>' but crop to the bounds of any
4958 opaque pixels which become transparent in the second frame. That is the
4959 smallest image needed to mask or erase pixels for the next frame. </td>
4960 </tr>
4961
4962 <tr>
4963 <td>compare-overlay</td>
4964 <td>As '<code>compare-any</code>' but crop to pixels that add
4965 extra color to the next image, as a result of overlaying color pixels.
4966 That is the smallest single overlaid image to add or change colors. </td>
4967 </tr>
4968
Cristy594d2772015-11-15 10:47:42 -05004969 <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 -04004970 composition method '<code>change-mask</code>', to reduce the image to
4971 just the pixels that need to be overlaid. </td>
4972 </tr>
4973
4974 <tr>
4975 <td>coalesce</td>
Cristy594d2772015-11-15 10:47:42 -05004976 <td>Equivalent to a call to the <a href="command-line-options.html#coalesce"
4977 >-coalesce</a> operator. Apply the layer disposal methods set in the
Cristy882d9f42015-10-29 16:48:39 -04004978 current image sequence to form a fully defined animation sequence, as
4979 it should be displayed. Effectively converting a GIF animation into a
4980 'film strip'-like animation. </td>
4981 </tr>
4982
4983 <tr>
4984 <td>composite</td>
4985 <td>Alpha Composition of two image lists, separated by a
4986 "<code>null:</code>" image, with the destination image list first, and
4987 the source images last. An image from each list are composited
4988 together until one list is finished. The separator image and source
4989 image lists are removed. </td>
4990 </tr>
4991
4992
4993 <tr><td></td>
Cristy594d2772015-11-15 10:47:42 -05004994 <td>The <a href="command-line-options.html#geometry" >-geometry</a> offset is adjusted according
4995 to <a href="command-line-options.html#gravity" >-gravity</a> in accordance of the virtual
4996 canvas size of the first image in each list. Unlike a normal <a
4997 href="command-line-options.html#composite" >-composite</a> operation, the canvas offset is also
Cristy882d9f42015-10-29 16:48:39 -04004998 added to the final composite positioning of each image. </td> </tr>
4999
5000 <tr><td></td>
5001 <td>If one of the image lists only contains one image, that image is
5002 applied to all the images in the other image list, regardless of which
5003 list it is. In this case it is the image meta-data of the list which
5004 preserved. </td>
5005 </tr>
5006
5007
5008 <tr>
5009 <td>dispose</td>
5010 <td>This like '<code>coalesce</code>' but shows the look of
5011 the animation after the layer disposal method has been applied, before
5012 the next sub-frame image is overlaid. That is the 'dispose' image that
Cristy594d2772015-11-15 10:47:42 -05005013 results from the application of the GIF <a href="command-line-options.html#dispose"
5014 >-dispose</a> method. This allows you to check what
Cristy882d9f42015-10-29 16:48:39 -04005015 is going wrong with a particular animation you may be developing.
5016 </td>
5017 </tr>
5018
5019 <tr>
5020 <td>flatten</td>
5021 <td>Create a canvas the size of the first images virtual
Cristy594d2772015-11-15 10:47:42 -05005022 canvas using the current <a href="command-line-options.html#background" >-background</a> color,
5023 and <a href="command-line-options.html#compose" >-compose</a> each image in turn onto that
Cristy882d9f42015-10-29 16:48:39 -04005024 canvas. Images falling outside that canvas is clipped. Final
5025 image will have a zero virtual canvas offset. </td>
5026 </tr>
5027
5028 <tr><td></td>
5029 <td>This usually used as one of the final 'image layering' operations
5030 overlaying all the prepared image layers into a final image. </td>
5031 </tr>
5032
5033 <tr><td></td>
5034 <td>For a single image this method can also be used to fillout a virtual
5035 canvas with real pixels, or to underlay an opaque color to remove
5036 transparency from an image.</td>
5037 </tr>
5038
5039
5040 <tr>
5041 <td>merge</td>
5042 <td>As 'flatten' method but merging all the given image
5043 layers to create a new layer image just large enough to hold all the
5044 image without clipping or extra space. The new images virtual offset
5045 will preserve the position of the new layer, even if this offset is
5046 negative. The virtual canvas size of the first image is preserved.
5047 </td>
5048 </tr>
5049
5050 <tr><td></td><td>Caution is advised when handling image layers with
5051 negative offsets as few image file formats handle them correctly.
Cristy594d2772015-11-15 10:47:42 -05005052 Following this operation method with <a href="command-line-options.html#repage" >+repage</a>
Cristy882d9f42015-10-29 16:48:39 -04005053 will remove the layer offset, and create an image in which all the
5054 overlaid image positions relative to each other is preserved, though
5055 not necessarily exactly where you specified them.
5056 </td>
5057 </tr>
5058
5059 <tr><td></td><td>See also 'trim-bounds' below which is closely related but
5060 without doing the'flatten' to merge the images together. </td>
5061 </tr>
5062
5063 <tr>
5064 <td>mosaic</td>
5065 <td>As 'flatten' method but expanding the initial canvas size
5066 of the first image in a positive direction only so as to hold all the
5067 image layers. However as a virtual canvas is 'locked' to the origin,
5068 by its own definition, image layers with a negative offsets will still
5069 become clipped by the top and left edges. See 'merge' or 'trim-bounds'
5070 if this could be a problem. </td>
5071
5072 </tr>
5073
5074 <tr><td></td><td>This method is commonly used to layout individual image
5075 using various offset but without knowing the final canvas size. The
5076 resulting image will, like 'flatten' not have any virtual offset, so
5077 can be saved to any image file format. </td>
5078 </tr>
5079
5080
5081 <tr>
5082 <td>optimize</td>
5083 <td>Optimize a coalesced animation, into GIF animation using
5084 a number of general techniques. This currently a short cut to
5085 apply both the '<code>optimize-frame</code>', and
5086 '<code>optimize-transparency</code>' methods but may be expanded to
5087 include other optimization methods as they are developed. </td>
5088 </tr>
5089
5090 <tr>
5091 <td>optimize-frame</td>
5092 <td>Optimize a coalesced animation, into GIF animation by
5093 reducing the number of pixels per frame as much as possible by
5094 attempting to pick the best layer disposal method to use, while ensuring
5095 the result will continue to animate properly. </td>
5096 </tr>
5097
5098 <tr><td></td><td> There is no guarantee that the best optimization is found.
5099 But then no reasonably fast GIF optimization algorithm can do this.
5100 However this does seem to do better than most other GIF frame
5101 optimizers seen. </td>
5102 </tr>
5103
5104 <tr>
5105 <td>optimize-plus</td>
5106 <td>As '<code>optimize-frame</code>' but attempt to improve the
5107 overall optimization by adding extra frames to the animation, without
5108 changing the final look or timing of the animation. The frames are
5109 added to attempt to separate the clearing of pixels from the
5110 overlaying of new additional pixels from one animation frame to the
5111 next. If this does not improve the optimization (for the next frame
5112 only), it will fall back to the results of the previous normal
5113 '<code>optimize-frame</code>' technique. </td>
5114 </tr>
5115
5116 <tr><td></td><td>There is the possibility that the change in the disposal
5117 style will result in a worsening in the optimization of later frames,
5118 though this is unlikely. In other words there no guarantee that it is
5119 better than the normal '<code>optimize-frame</code>' technique. For some
5120 animations however you can get a vast improvement in the final
5121 animation size. </td>
5122 </tr>
5123
5124 <tr>
5125 <td>optimize-transparency</td>
5126 <td>Given a GIF animation, replace any pixel in the sub-frame
5127 overlay images with transparency, if it does not change the resulting
Cristy594d2772015-11-15 10:47:42 -05005128 animation by more than the current <a href="command-line-options.html#fuzz" >-fuzz</a> factor.
Cristy882d9f42015-10-29 16:48:39 -04005129 </td>
5130 </tr>
5131
5132 <tr><td></td><td>This should allow a existing frame optimized GIF animation
5133 to compress into a smaller file size due to larger areas of one
5134 (transparent) color rather than a pattern of multiple colors repeating
5135 the current disposed image of the last frame. </td>
5136 </tr>
5137
5138 <tr>
5139 <td>remove-dups</td>
5140 <td>Remove (and merge time delays) of duplicate consecutive
5141 images, so as to simplify layer overlays of coalesced animations.
5142 </td>
5143 </tr>
5144
5145 <tr><td></td><td>Usually this a result of using a constant time delay
5146 across the whole animation, or after a larger animation was split into
5147 smaller sub-animations. The duplicate frames could also have been
5148 used as part of some frame optimization methods. </td>
5149 </tr>
5150
5151 <tr>
5152 <td>remove-zero</td>
5153 <td>Remove any image with a zero time delay, unless ALL the
5154 images have a zero time delay (and is not a proper timed animation, a
5155 warning is then issued). </td>
5156 </tr>
5157
5158 <tr><td></td><td>In a GIF animation, such images are usually frames which
5159 provide partial intermediary updates between the frames that are
5160 actually displayed to users. These frames are usually added for
5161 improved frame optimization in GIF animations. </td>
5162 </tr>
5163
5164 <tr>
5165 <td>trim-bounds</td>
5166 <td>Find the bounds of all the images in the current
5167 image sequence, then adjust the offsets so all images are contained on
5168 a minimal positive canvas. None of the image data is modified or
5169 merged, only the individual image virtual canvas size and offset.
5170 All the images is given the same canvas size, and and will have
5171 a positive offset, but will remain in the same position relative to
5172 each other. As a result of the minimal canvas size at least one image
5173 will touch every edge of that canvas. The image data touching those
5174 edges however may be transparent. </td>
5175 </tr>
5176
5177 <tr><td></td><td>The result is much like if you used 'merge' followed by a
Cristy594d2772015-11-15 10:47:42 -05005178 <a href="command-line-options.html#repage" >+repage</a> option, except that all the images
Cristy882d9f42015-10-29 16:48:39 -04005179 have been kept separate. If 'flatten' is used after using
5180 'trim-bounds' you will get the same result. </td>
5181 </tr>
5182
5183 </tbody>
5184</table>
5185
5186<p>To print a complete list of layer types, use <a href="command-line-options.html#list">-list layers</a>.</p>
5187
Cristy594d2772015-11-15 10:47:42 -05005188<p>The operators <a href="command-line-options.html#coalesce" >-coalesce</a>, <a href="command-line-options.html#deconstruct"
5189>-deconstruct</a>, <a href="command-line-options.html#flatten" >-flatten</a>, and <a href="command-line-options.html#mosaic"
5190>-mosaic</a> are only aliases for the above methods and may be depreciated in
5191the future. Also see <a href="command-line-options.html#page" >-page</a>, <a href="command-line-options.html#repage"
5192>-repage</a> operators, the <a href="command-line-options.html#compose" >-compose</a> setting, and the
5193GIF <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 -04005194settings. </p>
5195
5196
5197<div style="margin: auto;">
5198 <h3 class="magick-header"><a id="level"></a>-level <var>black_point</var>{,<var>white_point</var>}{<var>%</var>}{,<var>gamma</var>}</h3>
5199</div>
5200
5201<p class="magick-description">adjust the level of image channels.</p>
5202
5203<p>Given one, two or three values delimited with commas: black-point,
5204white-point, gamma (for example: 10,250,1.0 or 2%,98%,0.5). The black and
5205white points range from 0 to <var>QuantumRange</var>, or from 0 to
5206100%; if the white point is omitted it is set to (<var>QuantumRange</var> - black_point), so as to center contrast changes.
5207If a <code>%</code> sign is present anywhere in the string, both black and white
Cristy594d2772015-11-15 10:47:42 -05005208points are percentages of the full color range. Gamma will do a <a
5209href="command-line-options.html#gamma">-gamma</a> adjustment of the values. If it is omitted, the
Cristy882d9f42015-10-29 16:48:39 -04005210default of 1.0 (no gamma correction) is assumed.</p>
5211
5212<p>In normal usage (<code>-level</code>) the image values are stretched so that
5213the given '<code>black_point</code>' value in the original image is set to zero
5214(or black), while the given '<code>white_point</code>' value is set to <var>QuantumRange</var> (or white). This provides you with direct
5215contrast adjustments to the image. The '<code>gamma</code>' of the resulting
5216image will then be adjusted. </p>
5217
5218<p>From ImageMagick v6.4.1-9 using the plus form of the operator
5219(<code>+level</code>) or adding the special '!' flag anywhere in the argument
5220list, will cause the operator to do the reverse of the level adjustment. That
5221is a zero, or <var>QuantumRange</var> value (black, and white, resp.)
5222in the original image, is adjusted to the given level values, allowing you to
5223de-contrast, or compress the channel values within the image. The
5224'<code>gamma</code>' is adjusted before the level adjustment to de-contrast the
5225image is made. </p>
5226
5227<p>Only the channels defined by the current <a href="command-line-options.html#channel">-channel</a>
5228setting are adjusted (defaults to RGB color channels only), allowing you to
5229limit the effect of this operator. </p>
5230
5231<p>Please note that the transparency channel is treated as 'matte'
5232values (0 is opaque) and not as 'alpha' values (0 is transparent).</p>
5233
5234
5235<div style="margin: auto;">
5236 <h3 class="magick-header"><a id="level-colors"></a>-level-colors {<var>black_color</var>}{,}{<var>white_color</var>}</h3>
5237</div>
5238
5239<p class="magick-description">adjust the level of an image using the provided dash separated colors.</p>
5240
5241<p>This function is exactly like <a href="command-line-options.html#level">-level</a>, except that the
5242value value for each color channel is determined by the
5243'<code>black_color</code>' and '<code>white_color</code>' colors given (as
5244described under the <a href="command-line-options.html#fill">-fill</a> option). </p>
5245
5246<p>This effectually means the colors provided to <code>-level-colors</code>
5247is mapped to become 'black' and 'white' respectively, with all the other
5248colors linearly adjusted (or clipped) to match that change. Each channel is
5249adjusted separately using the channel values of the colors specified. </p>
5250
5251<p>On the other hand the plus form of the operator (<code>+level-colors</code>)
5252will map the image color 'black' and 'white' to the given colors
5253respectively, resulting in a gradient (de-contrasting) tint of the image to
Cristy769d8892016-01-19 18:11:14 -05005254those colors. This can also be used to convert a plain grayscale image into a
Cristy882d9f42015-10-29 16:48:39 -04005255one using the gradient of colors specified. </p>
5256
5257<p>By supplying a single color with a comma separator either before or after
5258that color, will just replace the respective 'black' or 'white' point
5259respectively. But if no comma separator is provided, the given color is
5260used for both the black and white color points, making the operator either
5261threshold the images around that color (- form) or set all colors to that
5262color (+ form). </p>
5263
5264
5265<div style="margin: auto;">
5266 <h3 class="magick-header"><a id="limit"></a>-limit <var>type value</var></h3>
5267</div>
5268
5269<p class="magick-description">Set the pixel cache resource limit.</p>
5270
Cristye09ed312016-03-06 08:07:39 -05005271<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 -04005272
5273<p>The value for <code>file</code> is in number of files. The other limits are
5274in bytes. Define arguments for the memory, map, area, and disk resource limits
5275with SI prefixes (.e.g 100MB).</p>
5276
5277<p>By default the limits are 768 files, 3GB of image area, 1.5GiB memory, 3GiB
5278memory map, and 18.45EB of disk. These limits are adjusted relative to the
5279available resources on your computer if this information is available. When
5280any limit is reached, ImageMagick fails in some fashion but attempts to take
5281compensating actions, if possible. For example, the following limits
5282memory:</p>
5283
5284<pre>
5285-limit memory 32MiB -limit map 64MiB
5286</pre>
5287
5288<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>
5289
5290<pre>
Cristy594d2772015-11-15 10:47:42 -05005291-> identify -list resource
Cristy882d9f42015-10-29 16:48:39 -04005292Resource limits:
5293 Width: 100MP
5294 Height: 100MP
5295 Area: 25.181GB
5296 Memory: 11.726GiB
5297 Map: 23.452GiB
5298 Disk: unlimited
5299 File: 768
5300 Thread: 12
5301 Throttle: 0
5302 Time: unlimited
5303</pre>
5304
5305<p>Requests for pixel storage to keep intermediate images are satisfied by one
5306of three resource categories: in-memory pool, memory-mapped files pool, and
Cristy594d2772015-11-15 10:47:42 -05005307disk pool (in that order) depending on the <a href="command-line-options.html#limit">&#x2011;limit</a> settings
Cristy882d9f42015-10-29 16:48:39 -04005308and whether the system honors a resource request. If the total size of
5309allocated pixel storage in the given pool reaches the corresponding limit, the
5310request is passed to the next pool. Additionally, requests that exceed the
5311<code>area</code> limit automagically are allocated on disk.</p>
5312
5313<p>To illustrate how ImageMagick utilizes resource limits, consider a typical
5314image resource request. First, ImageMagick tries to allocate the pixels in
5315memory. The request might be denied if the resource request exceeds the
5316<code>memory</code> limit or if the system does not honor the request. If
5317a memory request is not honored, the pixels are allocated to disk and the file
5318is memory-mapped. However, if the allocation request exceeds the
5319<code>map</code> limit, the resource allocation goes to disk. In all cases, if
5320the resource request exceeds the <code>area</code> limit, the pixels are
5321automagically cached to disk. If the disk has a hard limit, the program
5322fails.</p>
5323
5324<p>In most cases you simply do not need to concern yourself with resource
5325limits. ImageMagick chooses reasonable defaults and most images do not tax
5326your computer resources. Where limits do come in handy is when you process
5327images that are large or on shared systems where ImageMagick can consume all
5328or most of the available memory. In this case, the ImageMagick workflow slows
5329other processes or, in extreme cases, brings the system to a halt. Under
5330these circumstances, setting limits give some assurances that the ImageMagick
5331workflow will not interfere with other concurrent uses of the computer. For
5332example, assume you have a web interface that processes images uploaded from
5333the Internet. To assure ImageMagick does not exceed 10MiB of memory you can
5334simply set the area limit to 10MiB:</p>
5335
5336<pre>
5337-limit area 10MB
5338</pre>
5339
5340<p>Now whenever a large image is processed, the pixels are automagically
5341cached to disk instead of memory. This of course implies that large images
5342typically process very slowly, simply because pixel processing in memory can
5343be an order of magnitude faster than on disk. Because your web site users
5344might inadvertently upload a huge image to process, you should set a disk
5345limit as well:</p>
5346
5347<pre>
5348-limit area 10MB -limit disk 500MB
5349</pre>
5350
5351<p>Here ImageMagick stops processing if an image requires more than 500MB of disk storage.</p>
5352
5353<p>In addition to command-line resource limit option, resources can be set
Cristy594d2772015-11-15 10:47:42 -05005354with <a href="resources.html#environment" >environment variables</a>. Set the
Cristy882d9f42015-10-29 16:48:39 -04005355environment variables <code>MAGICK_AREA_LIMIT</code>,
5356<code>MAGICK_DISK_LIMIT</code>, <code>MAGICK_FILE_LIMIT</code>,
5357<code>MAGICK_MEMORY_LIMIT</code>, <code>MAGICK_MAP_LIMIT</code>,
5358<code>MAGICK_THREAD_LIMIT</code>, <code>MAGICK_TIME_LIMIT</code> for limits of
5359image area, disk space, open files, heap memory, memory map, number of threads
5360of execution, and maximum elapsed time in seconds respectively.</p>
5361
5362<p> Inquisitive users can try adding <a href="command-line-options.html#debug">-debug cache</a> to
5363their commands and then scouring the generated output for references to the
5364pixel cache, in order to determine how the pixel cache was allocated and how
5365resources were consumed. Advanced Unix/Linux users can pipe that output
5366through <code>grep memory|open|destroy|disk</code> for more readable sifting.
5367</p>
5368
5369<p>For more about ImageMagick's use of resources, see the section <b>Cache
Cristy594d2772015-11-15 10:47:42 -05005370Storage and Resource Requirements</b> on the <a href="architecture.html#cache
5371">Architecture</a> page. </p>
Cristy882d9f42015-10-29 16:48:39 -04005372
5373<div style="margin: auto;">
Cristy769d8892016-01-19 18:11:14 -05005374 <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 -04005375</div>
5376
5377<p class="magick-description">Linear with saturation stretch.</p>
5378
Cristy594d2772015-11-15 10:47:42 -05005379<p>This is very similar to <a href="command-line-options.html#contrast-stretch" >-contrast-stretch</a>,
Cristy882d9f42015-10-29 16:48:39 -04005380and uses a 'histogram bin' to determine the range of color values that needs to
Cristy594d2772015-11-15 10:47:42 -05005381be stretched. However it then stretches those colors using the <a
5382href="command-line-options.html#level" >-level</a> operator.</p>
Cristy882d9f42015-10-29 16:48:39 -04005383
5384<p>As such while the initial determination may have 'binning' round off
5385effects, the image colors are stretched mathematically, rather than using the
5386histogram bins. This makes the operator more accurate. </p>
5387
Cristy594d2772015-11-15 10:47:42 -05005388<p>note however that a <a href="command-line-options.html#linear-stretch" >-linear-stretch</a> of
Cristy882d9f42015-10-29 16:48:39 -04005389'<code>0</code>' does nothing, while a value of '<code>1</code>' does a near
5390perfect stretch of the color range. </p>
5391
Cristy594d2772015-11-15 10:47:42 -05005392<p>See also <a href="command-line-options.html#auto-level" >-auto-level</a> for a 'perfect'
Cristy882d9f42015-10-29 16:48:39 -04005393normalization of mathematical images. </p>
5394
5395<p>This operator is under review for re-development. </p>
5396
5397
5398<div style="margin: auto;">
5399 <h3 class="magick-header"><a id="linewidth"></a>-linewidth</h3>
5400</div>
5401
5402<p class="magick-description">the line width for subsequent draw operations.</p>
5403
5404<div style="margin: auto;">
5405 <h3 class="magick-header"><a id="liquid-rescale"></a>-liquid-rescale <var>geometry</var></h3>
5406</div>
5407
5408<p class="magick-description">rescale image with seam-carving.</p>
5409
5410<p>See <a href="command-line-processing.html#geometry">Image Geometry</a> for complete details about the <em class="arg">geometry</em> argument.</p>
5411
5412<div style="margin: auto;">
5413 <h3 class="magick-header"><a id="list"></a>-list <var>type</var></h3>
5414</div>
5415
5416<p class="magick-description">Print a list of supported arguments for various options or settings. Choose from these list types:</p>
5417
5418<pre class="pre-scrollable">
5419Align
5420Alpha
5421Boolean
5422Cache
5423Channel
5424Class
5425ClipPath
5426Coder
5427Color
5428Colorspace
5429Command
5430Complex
5431Compose
5432Compress
5433Configure
5434DataType
5435Debug
5436Decoration
5437Delegate
5438Direction
5439Dispose
5440Distort
5441Dither
5442Endian
5443Evaluate
5444FillRule
5445Filter
5446Font
5447Format
5448Function
5449Gravity
5450Intensity
5451Intent
5452Interlace
5453Interpolate
5454Kernel
5455Layers
5456LineCap
5457LineJoin
5458List
5459Locale
5460LogEvent
5461Log
5462Magic
5463Method
5464Metric
5465Mime
5466Mode
5467Morphology
5468Module
5469Noise
5470Orientation
5471PixelIntensity
5472Policy
5473PolicyDomain
5474PolicyRights
5475Preview
5476Primitive
5477QuantumFormat
5478Resource
5479SparseColor
5480Statistic
5481Storage
5482Stretch
5483Style
5484Threshold
5485Type
5486Units
5487Validate
5488VirtualPixel
5489</pre>
5490
5491<p>These lists vary depending on your version of ImageMagick. Use "<code>-list
5492list</code>" to get a complete listing of all the "<code>-list</code>" arguments
5493available:</p>
5494
5495<pre>
5496identify -list list
5497</pre>
5498
5499<div style="margin: auto;">
5500 <h3 class="magick-header"><a id="log"></a>-log <var>string</var></h3>
5501</div>
5502
5503<p class="magick-description">Specify format for debug log.</p>
5504
Cristy594d2772015-11-15 10:47:42 -05005505<p>This option specifies the format for the log printed when the <a
5506href="command-line-options.html#debug">-debug</a> option is active.</p>
Cristy882d9f42015-10-29 16:48:39 -04005507
5508<p>You can display the following components by embedding special format
5509characters:</p>
5510
5511<dl class="dl-horizontal">
5512<dt>%d</dt><dd>domain</dd>
5513<dt>%e</dt><dd>event</dd>
5514<dt>%f</dt><dd>function</dd>
5515<dt>%l</dt><dd>line</dd>
5516<dt>%m</dt><dd>module</dd>
5517<dt>%p</dt><dd>process ID</dd>
5518<dt>%r</dt><dd>real CPU time</dd>
5519<dt>%t</dt><dd>wall clock time</dd>
5520<dt>%u</dt><dd>user CPU time</dd>
5521<dt>%%</dt><dd>percent sign</dd>
5522<dt>\n</dt><dd>newline</dd>
5523<dt>\r</dt><dd>carriage return</dd>
5524</dl>
5525
5526<p>For example:</p>
5527
5528<pre>
5529convert -debug coders -log "%u %m:%l %e" in.gif out.png
5530</pre>
5531
5532<p>The default behavior is to print all of the components.</p>
5533
5534<div style="margin: auto;">
5535 <h3 class="magick-header"><a id="loop"></a>-loop <var>iterations</var></h3>
5536</div>
5537
5538<p class="magick-description">add Netscape loop extension to your GIF animation.</p>
5539
5540<p>Set iterations to zero to repeat the animation an infinite number of times,
5541otherwise the animation repeats itself up to <var>iterations</var>
5542times.</p>
5543
5544<div style="margin: auto;">
5545 <h3 class="magick-header"><a id="lowlight-color"></a>-lowlight-color <var>color</var></h3>
5546</div>
5547
5548<p class="magick-description">when comparing images, de-emphasize pixel differences with this color.</p>
5549
5550<div style="margin: auto;">
5551 <h3 class="magick-header"><a id="magnify"></a>-magnify</h3>
5552</div>
5553
5554<p class="magick-description">double the size of the image with pixel art scaling.</p>
5555
5556
5557<div style="margin: auto;">
5558 <h3 class="magick-header"><a id="map"></a>-map <var>type</var></h3>
5559</div>
5560
5561<p class="magick-description">Display image using this <var>type</var>.</p>
5562
5563<p>Choose from these <var>Standard Colormap</var> types:</p>
5564
5565<pre>
5566best
5567default
5568gray
5569red
5570green
5571blue
5572</pre>
5573
5574<p>The <var>X server</var> must support the <var>Standard
5575Colormap</var> you choose, otherwise an error occurs. Use <code>list</code> as
5576the type and <code>display</code> searches the list of colormap types in
5577<code>top-to-bottom</code> order until one is located. See <var>xstdcmap(1)</var> for one way of creating Standard Colormaps.</p>
5578
5579
5580<div style="margin: auto;">
5581 <h3 class="magick-header"><a id="map_stream_"></a>-map <var>components</var></h3>
5582</div>
5583
5584<p class="magick-description">pixel map.</p>
5585
5586<p>Here are the valid components of a map:</p>
5587
5588<dl class="dl-horizontal">
5589<dt>r</dt><dd> red pixel component</dd>
5590<dt>g</dt><dd> green pixel component</dd>
5591<dt>b</dt><dd> blue pixel component</dd>
5592<dt>a</dt><dd> alpha pixel component (0 is transparent)</dd>
5593<dt>o</dt><dd> opacity pixel component (0 is opaque)</dd>
5594<dt>i</dt><dd> grayscale intensity pixel component</dd>
5595<dt>c</dt><dd> cyan pixel component</dd>
5596<dt>m</dt><dd> magenta pixel component</dd>
5597<dt>y</dt><dd> yellow pixel component</dd>
5598<dt>k</dt><dd> black pixel component</dd>
5599<dt>p</dt><dd> pad component (always 0)</dd>
5600</dl>
5601
5602<p>You can specify as many of these components as needed in any order (e.g.
5603bgr). The components can repeat as well (e.g. rgbr).</p>
5604
5605
5606<div style="margin: auto;">
5607 <h3 class="magick-header"><a id="mask"></a>-mask
5608<var>filename</var></h3>
5609</div>
5610
5611<p class="magick-description">Prevent updates to image pixels specified by the mask.</p>
5612
5613<p>This the same as using a mask used for composite masking operations, with
5614grayscale values causing blended updates of the image the mask is attached to.
5615</p>
5616
5617<p>Use <a href="command-line-options.html#mask">+mask</a> to remove the mask from images.</p>
5618
5619<p>Also see <a href="command-line-options.html#clip-mask">-clip-mask</a> which work in the same way,
5620but with strict boolean masking. </p>
5621
5622<div style="margin: auto;">
5623 <h3 class="magick-header"><a id="mattecolor"></a>-mattecolor <var>color</var></h3>
5624</div>
5625
5626<p class="magick-description">Specify the color to be used with the <a href="command-line-options.html#frame">-frame</a> option.</p>
5627
5628<p>The color is specified using the format described under the <a href="command-line-options.html#fill">-fill</a> option.</p>
5629
Cristy594d2772015-11-15 10:47:42 -05005630<p>The default matte color is <code>#BDBDBD</code>, <span
5631style="background-color: #bdbdbd;">this shade of gray</span>.</p>
Cristy882d9f42015-10-29 16:48:39 -04005632
Cristyf650f4f2016-04-01 10:53:07 -04005633<p>This is an IMv6 option, use <a href="command-line-options.html#alpha-color">-alpha-color</a> with IMv7.</p>
5634
Cristy882d9f42015-10-29 16:48:39 -04005635<div style="margin: auto;">
5636 <h3 class="magick-header"><a id="maximum"></a>-maximum</h3>
5637</div>
5638
5639<p class="magick-description">return the maximum intensity of an image sequence.</p>
5640
5641<p>Select the 'maximum' value from all the surrounding pixels. </p>
5642
Cristy594d2772015-11-15 10:47:42 -05005643<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 -04005644name. </p>
5645
5646<div style="margin: auto;">
5647 <h3 class="magick-header"><a id="median"></a>-median <var>geometry</var></h3>
5648</div>
5649
5650<p class="magick-description">apply a median filter to the image.</p>
5651
5652<p>Select the 'middle' value from all the surrounding pixels. </p>
5653
Cristy594d2772015-11-15 10:47:42 -05005654<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 -04005655name. </p>
5656
5657<div style="margin: auto;">
Cristy769d8892016-01-19 18:11:14 -05005658 <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 -04005659</div>
5660
5661<p class="magick-description">image noise removal and color reduction/segmentation (e.g. -mean-shift 7x7+10%).</p>
5662
5663<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>
5664
5665<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>
5666
5667<div style="margin: auto;">
5668 <h3 class="magick-header"><a id="metric"></a>-metric <var>type</var></h3>
5669</div>
5670
5671<p class="magick-description">Output to STDERR a measure of the differences between images according to the <var>type</var> given metric.</p>
5672
5673<p>Choose from:</p>
5674
5675<dl class="dl-horizontal">
5676<dt>AE</dt><dd> absolute error count, number of different pixels (-fuzz effected)</dd>
5677<dt>FUZZ</dt><dd> mean color distance</dd>
5678<dt>MAE</dt><dd> mean absolute error (normalized), average channel error distance</dd>
5679<dt>MEPP</dt><dd> mean error per pixel (normalized mean error, normalized peak error)</dd>
5680<dt>MSE</dt><dd> mean error squared, average of the channel error squared</dd>
5681<dt>NCC</dt><dd> normalized cross correlation</dd>
5682<dt>PAE</dt><dd> peak absolute (normalized peak absolute)</dd>
5683<dt>PHASH</dt><dd> perceptual hash</dd>
5684<dt>PSNR</dt><dd> peak signal to noise ratio</dd>
5685<dt>RMSE</dt><dd> root mean squared (normalized root mean squared)</dd>
5686</dl>
5687
5688<p>Control the '<code>AE</code>', or absolute count of pixels that are different,
Cristy594d2772015-11-15 10:47:42 -05005689with the <a href="command-line-options.html#fuzz" >-fuzz</a> factor (ignore pixels which
Cristy882d9f42015-10-29 16:48:39 -04005690only changed by a small amount). Use '<code>PAE</code>' to find the
Cristy594d2772015-11-15 10:47:42 -05005691size of the <a href="command-line-options.html#fuzz" >-fuzz</a> factor needed to make all pixels
Cristy882d9f42015-10-29 16:48:39 -04005692'similar', while '<code>MAE</code>' determines the factor needed
5693for about half the pixels to be similar. </p>
5694
5695<p>The '<code>MEPP</code>' metric returns three different metrics
5696('<code>MAE</code>', '<code>MAE</code>' normalized, and '<code>PAE</code>'
5697normalized) from a single comparison run. </p>
5698
5699<p>To print a complete list of metrics, use the <a href="command-line-options.html#list">-list
5700metric</a> option.</p>
5701
5702
5703<div style="margin: auto;">
5704 <h3 class="magick-header"><a id="minimum"></a>-minimum</h3>
5705</div>
5706
5707<p class="magick-description">return the minimum intensity of an image sequence.</p>
5708
5709<p>Select the 'minimal' value from all the surrounding pixels. </p>
5710
Cristy594d2772015-11-15 10:47:42 -05005711<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 -04005712name. </p>
5713
5714
5715
5716<div style="margin: auto;">
5717 <h3 class="magick-header"><a id="mode"></a>-mode <var>geometry</var></h3>
5718</div>
5719
5720<p class="magick-description">make each pixel the \'predominant color\' of the neighborhood.'</p>
5721
5722<div style="margin: auto;">
5723 <h3 class="magick-header">-mode <var>value</var></h3>
5724</div>
5725
5726<p class="magick-description">Mode of operation.</p>
5727
5728<p>Choose the <var>value</var> from these styles: <code>Frame,
5729Unframe, or Concatenate</code></p>
5730
Cristy594d2772015-11-15 10:47:42 -05005731<p>Use the <a href="command-line-options.html#list" >-list</a> option with a '<code>Mode</code>' argument
5732for a list of <a href="command-line-options.html#mode" >-mode</a> arguments available in your
Cristy882d9f42015-10-29 16:48:39 -04005733ImageMagick installation.</p>
5734
5735
5736<div style="margin: auto;">
5737 <h3 class="magick-header"><a id="modulate"></a>-modulate <var>brightness</var>[,<var>saturation</var>,<var>hue</var>]</h3>
5738</div>
5739
5740<p class="magick-description">Vary the <var>brightness</var>, <var>saturation</var>, and <var>hue</var> of an image.</p>
5741
5742<p>The arguments are given as a percentages of variation. A value of 100 means
5743no change, and any missing values are taken to mean 100.</p>
5744
5745<p>The <var>brightness</var> is a multiplier of the overall
5746brightness of the image, so 0 means pure black, 50 is half as bright, 200 is
5747twice as bright. To invert its meaning <a href="command-line-options.html#negate">-negate</a> the image
5748before and after. </p>
5749
5750<p>The <var>saturation</var> controls the amount of color in an
5751image. For example, 0 produce a grayscale image, while a large value such as
5752200 produce a very colorful, 'cartoonish' color.</p>
5753
5754<p>The <var>hue</var> argument causes a "rotation" of the colors
5755within the image by the amount specified. For example, 50 results in
5756a counter-clockwise rotation of 90, mapping red shades to purple, and so on.
5757A value of either 0 or 200 results in a complete 180 degree rotation of the
5758image. Using a value of 300 is a 360 degree rotation resulting in no change to
5759the original image. </p>
5760
5761<p>For example, to increase the color brightness by 20% and decrease the color
Cristy594d2772015-11-15 10:47:42 -05005762saturation by 10% and leave the hue unchanged, use <a
5763href="command-line-options.html#modulate">-modulate 120,90</a>.</p>
Cristy882d9f42015-10-29 16:48:39 -04005764
Cristy594d2772015-11-15 10:47:42 -05005765<p>Use <a href="command-line-options.html#set">-set</a> attribute of '<code
5766>option:modulate:colorspace</code>' to specify which colorspace to
Cristy882d9f42015-10-29 16:48:39 -04005767modulate. 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>
5768
5769<pre>
5770convert image.png -set option:modulate:colorspace hsb -modulate 120,90 modulate.png
5771</pre>
5772
5773<div style="margin: auto;">
5774 <h3 class="magick-header"><a id="moments"></a>-moments</h3>
5775</div>
5776
5777<p class="magick-description">report image moments and perceptual hash.</p>
5778
5779
5780<div style="margin: auto;">
5781 <h3 class="magick-header"><a id="monitor"></a>-monitor</h3>
5782</div>
5783
5784<p class="magick-description">monitor progress.</p>
5785
5786
5787<div style="margin: auto;">
5788 <h3 class="magick-header"><a id="monochrome"></a>-monochrome</h3>
5789</div>
5790
5791<p class="magick-description">transform the image to black and white.</p>
5792
5793<div style="margin: auto;">
5794 <h3 class="magick-header"><a id="morph"></a>-morph <var>frames</var></h3>
5795</div>
5796
5797<p class="magick-description">morphs an image sequence.</p>
5798
5799<p>Both the image pixels and size are linearly interpolated to give the
5800appearance of a metamorphosis from one image to the next, over all the images
Cristy594d2772015-11-15 10:47:42 -05005801in the current image list. The added images are the equivalent of a <a
5802href="command-line-options.html#blend">-blend</a> composition. The <var>frames</var>
Cristy882d9f42015-10-29 16:48:39 -04005803argument determine how many images to interpolate between each image. </p>
5804
5805
5806<div style="margin: auto;">
5807 <h3 class="magick-header"><a id="morphology"></a>-morphology</h3>
5808 <h3 class="magick-header">-morphology <var>method</var> <var>kernel</var></h3>
5809</div>
5810
5811<p class="magick-description">apply a morphology method to the image.</p>
5812
Cristy594d2772015-11-15 10:47:42 -05005813<p>Until I get around to writing an option summary for this, see <a
5814href="http://www.imagemagick.org/Usage/morphology/" >IM Usage Examples,
Cristy882d9f42015-10-29 16:48:39 -04005815Morphology</a>. </p>
5816
5817
5818<div style="margin: auto;">
5819 <h3 class="magick-header"><a id="mosaic"></a>-mosaic</h3>
5820</div>
5821
Cristy594d2772015-11-15 10:47:42 -05005822<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 -04005823
5824
5825<div style="margin: auto;">
Cristy594d2772015-11-15 10:47:42 -05005826 <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 -04005827</div>
5828
5829<p class="magick-description">simulate motion blur.</p>
5830
5831<p>Blur with the given radius, standard deviation (sigma), and angle. The
5832angle given is the angle toward which the image is blurred. That is the
5833direction people would consider the object is coming from. </p>
5834
5835<p>Note that the blur is not uniform distribution, giving the motion a
5836definite sense of direction of movement. </p>
5837
5838<p>The <a href="command-line-options.html#virtual-pixel">-virtual-pixel</a> setting will determine how
5839pixels which are outside the image proper are blurred into the final result.
5840</p>
5841
5842<div style="margin: auto;">
5843 <h3 class="magick-header"><a id="name"></a>-name</h3>
5844</div>
5845
5846<p class="magick-description">name an image.</p>
5847<div style="margin: auto;">
5848 <h3 class="magick-header"><a id="negate"></a>-negate</h3>
5849</div>
5850
5851<p class="magick-description">replace each pixel with its complementary color.</p>
5852
5853<p>The red, green, and blue intensities of an image are negated. White becomes
5854black, yellow becomes blue, etc. Use <a href="command-line-options.html#negate">+negate</a> to only
5855negate the grayscale pixels of the image.</p>
5856
5857<div style="margin: auto;">
Cristy594d2772015-11-15 10:47:42 -05005858 <h3 class="magick-header"><a id="noise"></a>-noise <var>geometry</var><br/>
Cristy882d9f42015-10-29 16:48:39 -04005859 +noise <var>type</var></h3>
5860</div>
5861
5862<p class="magick-description">Add or reduce noise in an image.</p>
5863
5864<p>The principal function of noise peak elimination filter is to smooth the
5865objects within an image without losing edge information and without creating
5866undesired structures. The central idea of the algorithm is to replace a pixel
5867with its next neighbor in value within a pixel window, if this pixel has been
5868found to be noise. A pixel is defined as noise if and only if this pixel is
5869a maximum or minimum within the pixel window.</p>
5870
5871<p>Use <code><a href="command-line-options.html#noise">-noise</a> <var>radius</var></code> to
5872specify the width of the neighborhood when reducing noise. This is equivalent
Cristy594d2772015-11-15 10:47:42 -05005873to using a <code><a href="command-line-options.html#statistic" >-statistic</a> NonPeak</code> operation,
Cristy882d9f42015-10-29 16:48:39 -04005874which should be used in preference.</p>
5875
5876<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
5877types:</p>
5878
5879<pre>
5880Gaussian
5881Impulse
5882Laplacian
5883Multiplicative
5884Poisson
5885Random
5886Uniform
5887</pre>
5888
Cristy594d2772015-11-15 10:47:42 -05005889<p>The amount of noise added can be controlled by the <code><a
5890href="command-line-options.html#attenuate" >-attenuate</a></code> setting. If unset the value is
Cristy882d9f42015-10-29 16:48:39 -04005891equivalent to 1.0, or a maximum noise addition.</p>
5892
5893<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>
5894
5895<p>To print a complete list of noises, use the <a href="command-line-options.html#list">-list noise</a> option.</p>
5896
5897<p>Also see the <a href="command-line-options.html#evaluate">-evaluate</a> noise functions that allows
5898the use of a controlling value to specify the amount of noise that should be
5899added to an image. </p>
5900
5901
5902<div style="margin: auto;">
5903 <h3 class="magick-header"><a id="normalize"></a>-normalize</h3>
5904</div>
5905
5906<p class="magick-description">Increase the contrast in an image by <var>stretching</var> the range of intensity values.</p>
5907
5908<p>The intensity values are stretched to cover the entire range of possible
5909values. While doing so, black-out at most <var>2%</var> of the pixels and
5910white-out at most <var>1%</var> of the pixels.</p>
5911
Cristy594d2772015-11-15 10:47:42 -05005912<p>Note that as of ImageMagick 6.4.7-0, <a href="command-line-options.html#normalize" >-normalize</a>
5913is equivalent to <a href="command-line-options.html#contrast-stretch" >-contrast-stretch 2%x1%</a>.
5914(Before this version, it was equivalent to <a href="command-line-options.html#contrast-stretch"
5915>-contrast-stretch 2%x99%</a>).</p>
Cristy882d9f42015-10-29 16:48:39 -04005916
Cristy769d8892016-01-19 18:11:14 -05005917<p>All the channels are normalized in concert by the same amount so as to
Cristy594d2772015-11-15 10:47:42 -05005918preserve color integrity, when the default <a href="command-line-options.html#channel" >+channel</a>
5919setting is in use. Specifying any other <a href="command-line-options.html#channel" >-channel</a>
Cristy882d9f42015-10-29 16:48:39 -04005920setting will normalize the RGB channels independently.</p>
5921
Cristy594d2772015-11-15 10:47:42 -05005922<p>See <a href="command-line-options.html#contrast-stretch" >-contrast-stretch</a> for more details.
5923Also see <a href="command-line-options.html#auto-level" >-auto-level</a> for a 'perfect' normalization
Cristy882d9f42015-10-29 16:48:39 -04005924that is better suited to mathematically generated images. </p>
5925
5926<p>This operator is under review for re-development. </p>
5927
5928
5929<div style="margin: auto;">
5930 <h3 class="magick-header"><a id="opaque"></a>-opaque <var>color</var></h3>
5931</div>
5932
5933<p class="magick-description">change this color to the fill color within the image.</p>
5934
5935<p>The <var>color</var> argument is defined using the format
Cristy594d2772015-11-15 10:47:42 -05005936described under the <a href="command-line-options.html#fill" >-fill</a> option. The <a href="command-line-options.html#fuzz"
5937>-fuzz</a> setting can be used to match and replace colors similar to the one
Cristy882d9f42015-10-29 16:48:39 -04005938given.</p>
5939
5940<p>Use <a href="command-line-options.html#opaque">+opaque</a> to paint any pixel that does not match
5941the target color. </p>
5942
5943<p>The <a href="command-line-options.html#transparent">-transparent</a> operator is exactly the same
Cristy594d2772015-11-15 10:47:42 -05005944as <a href="command-line-options.html#opaque" >-opaque</a> but replaces the matching color with
Cristy882d9f42015-10-29 16:48:39 -04005945transparency rather than the current <a href="command-line-options.html#fill">-fill</a> color setting.
5946To ensure that it can do this it also ensures that the image has an alpha
Cristy594d2772015-11-15 10:47:42 -05005947channel enabled, as per "<code><a href="command-line-options.html#alpha" >-alpha</a> set</code>", for
5948the new transparent colors, and does not require you to modify the <a
5949href="command-line-options.html#channel">-channel</a> to enable alpha channel handling. </p>
Cristy882d9f42015-10-29 16:48:39 -04005950
5951
5952<div style="margin: auto;">
5953 <h3 class="magick-header"><a id="ordered-dither"></a>-ordered-dither <var>threshold_map</var>{,<var>level</var>...}</h3>
5954</div>
5955
5956<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
5957given number of <var>levels</var> per color channel.</p>
5958
5959<p>You can choose from these standard threshold maps:</p>
5960
5961<pre class="pre-scrollable">
5962threshold 1x1 Threshold 1x1 (non-dither)
5963checks 2x1 Checkerboard 2x1 (dither)
5964o2x2 2x2 Ordered 2x2 (dispersed)
5965o3x3 3x3 Ordered 3x3 (dispersed)
5966o4x4 4x4 Ordered 4x4 (dispersed)
5967o8x8 8x8 Ordered 8x8 (dispersed)
5968h3x4a 4x1 Halftone 4x4 (angled)
5969h6x6a 6x1 Halftone 6x6 (angled)
5970h8x8a 8x1 Halftone 8x8 (angled)
5971h3x4o Halftone 4x4 (orthogonal)
5972h6x6o Halftone 6x6 (orthogonal)
5973h8x8o Halftone 8x8 (orthogonal)
5974h36x16o Halftone 16x16 (orthogonal)
5975c5x5b c5x5 Circles 5x5 (black)
5976c5x5w Circles 5x5 (white)
5977c6x6b c6x6 Circles 6x6 (black)
5978c6x6w Circles 6x6 (white)
5979c7x7b c7x7 Circles 7x7 (black)
5980c7x7w Circles 7x7 (white)
5981</pre>
5982
5983<p> The <code>threshold</code> generated a simple 50% threshold of the image.
Cristy594d2772015-11-15 10:47:42 -05005984This could be used with <var >level</var> to do the equivalent of <a
5985href="command-line-options.html#posterize" >-posterize</a> to reduce an image to basic primary colors.
Cristy882d9f42015-10-29 16:48:39 -04005986</p>
5987
5988<p>The <code>checks</code> pattern produces a 3 level checkerboard dither
5989pattern. That is a grayscale will become a pattern of solid black, solid
5990white, and mid-tone colors into a checkerboard pattern of black and white.
5991</p>
5992
Cristy594d2772015-11-15 10:47:42 -05005993<p>You can define your own <var >threshold map</var> for ordered
Cristy882d9f42015-10-29 16:48:39 -04005994dithering and halftoning your images, in either personal or system
Cristy594d2772015-11-15 10:47:42 -05005995<code>thresholds.xml</code> XML file. See <a href="resources.html" >Resources</a>
Cristy882d9f42015-10-29 16:48:39 -04005996for more details of configuration files. </p>
5997
5998<p>To print a complete list of the thresholds that have been defined, use the
Cristy594d2772015-11-15 10:47:42 -05005999<a href="command-line-options.html#list" >-list threshold</a> option.</p>
Cristy882d9f42015-10-29 16:48:39 -04006000
6001<p>Note that at this time the same threshold dithering map is used for all
6002color channels, no attempt is made to offset or rotate the map for different
6003channels is made, to create an offset printing effect. Also as the maps are
6004simple threshold levels, the halftone and circle maps will create incomplete
6005circles along the edges of a colored area. Also all the effects are purely
6006on/off boolean effects, without anti-aliasing to make the circles smooth
6007looking. Large dots can be made to look better with a small amount of blurring
6008after being created. </p>
6009
6010
6011<div style="margin: auto;">
6012 <h3 class="magick-header"><a id="orient"></a>-orient <var>image orientation</var></h3>
6013</div>
6014
6015<p class="magick-description">specify orientation of a digital camera image.</p>
6016
6017<p>Choose from these orientations:</p>
6018
6019<pre>
6020bottom-left right-top
6021bottom-right top-left
6022left-bottom top-right
6023left-top undefined
6024right-bottom
6025</pre>
6026
Cristy594d2772015-11-15 10:47:42 -05006027<p>To print a complete list of orientations, use the <a href="command-line-options.html#list" >-list
Cristy882d9f42015-10-29 16:48:39 -04006028orientation</a> option.</p>
6029
6030
6031<div style="margin: auto;">
Cristy594d2772015-11-15 10:47:42 -05006032 <h3 class="magick-header"><a id="page"></a>-page <var>geometry</var><br/>
6033 -page <var>media</var>[<var>offset</var>][{<var>^!&lt;&gt;</var>}]<br/>
Cristy882d9f42015-10-29 16:48:39 -04006034 +page
6035 </h3>
6036</div>
6037
6038<p class="magick-description">Set the size and location of an image on the larger virtual canvas.</p>
6039
6040<p>See <a href="command-line-processing.html#geometry">Image Geometry</a> for complete details about the <em class="arg">geometry</em> argument.</p>
6041
6042<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 -05006043<var>geometry</var> arguments (e.g. <a
6044href="command-line-options.html#page">-page</a> <code>Letter+43+43</code>).</p>
Cristy882d9f42015-10-29 16:48:39 -04006045
6046<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.
6047The choices for a PostScript page are:</p>
6048
6049<dl class="dl-horizontal">
6050<dt> 11x17 </dt> <dd> 792 x 1224</dd>
6051<dt> Ledger </dt> <dd> 1224 x 792</dd>
6052<dt> Legal </dt> <dd> 612 x 1008</dd>
6053<dt> Letter </dt> <dd> 612 x 792</dd>
6054<dt> LetterSmall</dt> <dd> 612 x 792</dd>
6055<dt> ArchE </dt> <dd> 2592 x 3456</dd>
6056<dt> ArchD </dt> <dd> 1728 x 2592</dd>
6057<dt> ArchC </dt> <dd> 1296 x 1728</dd>
6058<dt> ArchB </dt> <dd> 864 x 1296</dd>
6059<dt> ArchA </dt> <dd> 648 x 864</dd>
6060<dt> A0 </dt> <dd> 2380 x 3368</dd>
6061<dt> A1 </dt> <dd> 1684 x 2380</dd>
6062<dt> A2 </dt> <dd> 1190 x 1684</dd>
6063<dt> A3 </dt> <dd> 842 x 1190</dd>
6064<dt> A4 </dt> <dd> 595 x 842</dd>
6065<dt> A4Small </dt> <dd> 595 x 842</dd>
6066<dt> A5 </dt> <dd> 421 x 595</dd>
6067<dt> A6 </dt> <dd> 297 x 421</dd>
6068<dt> A7 </dt> <dd> 210 x 297</dd>
6069<dt> A8 </dt> <dd> 148 x 210</dd>
6070<dt> A9 </dt> <dd> 105 x 148</dd>
6071<dt> A10 </dt> <dd> 74 x 105</dd>
6072<dt> B0 </dt> <dd> 2836 x 4008</dd>
6073<dt> B1 </dt> <dd> 2004 x 2836</dd>
6074<dt> B2 </dt> <dd> 1418 x 2004</dd>
6075<dt> B3 </dt> <dd> 1002 x 1418</dd>
6076<dt> B4 </dt> <dd> 709 x 1002</dd>
6077<dt> B5 </dt> <dd> 501 x 709</dd>
6078<dt> C0 </dt> <dd> 2600 x 3677</dd>
6079<dt> C1 </dt> <dd> 1837 x 2600</dd>
6080<dt> C2 </dt> <dd> 1298 x 1837</dd>
6081<dt> C3 </dt> <dd> 918 x 1298</dd>
6082<dt> C4 </dt> <dd> 649 x 918</dd>
6083<dt> C5 </dt> <dd> 459 x 649</dd>
6084<dt> C6 </dt> <dd> 323 x 459</dd>
6085<dt> Flsa </dt> <dd> 612 x 936</dd>
6086<dt> Flse </dt> <dd> 612 x 936</dd>
6087<dt> HalfLetter </dt> <dd> 396 x 612</dd>
6088</dl>
6089
6090<p>This option is also used to place subimages when writing to a multi-image
6091format that supports offsets, such as GIF89 and MNG. When used for this
6092purpose the offsets are always measured from the top left corner of the canvas
6093and are not affected by the <a href="command-line-options.html#gravity">-gravity</a> option. To
6094position 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
6095file, a <a href="command-line-options.html#page">-page</a> option appearing ahead of the first image in
6096the sequence with nonzero width and height defines the width and height values
6097that are written in the <code>MHDR</code> chunk. Otherwise, the MNG width and
6098height are computed from the bounding box that contains all images in the
6099sequence. When writing a GIF89 file, only the bounding box method is used to
6100determine its dimensions.</p>
6101
Cristy594d2772015-11-15 10:47:42 -05006102<p>For a PostScript page, the image is sized as in <a
6103href="command-line-options.html#geometry">-geometry</a> but positioned relative to the <var>lower
6104left-hand corner</var> of the page by {+-}<code>x</code><var>offset</var>{+-}<code>y</code> <var>offset</var>. Use <a
6105href="command-line-options.html#page">-page 612x792</a>, for example, to center the image within the
Cristy882d9f42015-10-29 16:48:39 -04006106page. If the image size exceeds the PostScript page, it is reduced to fit the
6107page. 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
6108corner of the page, unless the <a href="command-line-options.html#gravity">-gravity</a> option is
6109present with a value other than <var>NorthWest</var>.</p>
6110
6111<p>The default page dimensions for a TEXT image is 612x792.</p>
6112
6113<p>This option is used in concert with <a href="command-line-options.html#density">-density</a>.</p>
6114
6115<p>Use <a href="command-line-options.html#page">+page</a> to remove the page settings for an image.</p>
6116
6117<div style="margin: auto;">
6118 <h3 class="magick-header"><a id="paint"></a>-paint <var>radius</var></h3>
6119</div>
6120
6121<p class="magick-description">simulate an oil painting.</p>
6122
6123<p>Each pixel is replaced by the most frequent color in a circular
6124neighborhood whose width is specified with <var>radius</var>.</p>
6125
6126<div style="margin: auto;">
6127 <h3 class="magick-header"><a id="path"></a>-path <var>path</var></h3></div>
6128
6129<p class="magick-description">write images to this path on disk.</p>
6130
6131<div style="margin: auto;">
6132 <h3 class="magick-header"><a id="pause_animate_"></a>-pause <var>seconds</var></h3>
6133</div>
6134
6135<p class="magick-description">Pause between animation loops</p>
6136
6137<p>Pause for the specified number of seconds before repeating the animation.</p>
6138
6139<div style="margin: auto;">
6140 <h3 class="magick-header"><a id="pause_import_"></a>-pause <var>seconds</var></h3>
6141</div>
6142
6143<p class="magick-description">Pause between snapshots.</p>
6144
6145<p>Pause for the specified number of seconds before taking the next snapshot.</p>
6146
6147<div style="margin: auto;">
6148 <h3 class="magick-header"><a id="perceptible"></a>-perceptible <var>epsilon</var></h3>
6149</div>
6150
6151<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>
6152
6153<div style="margin: auto;">
6154 <h3 class="magick-header"><a id="ping"></a>-ping</h3>
6155</div>
6156
6157<p class="magick-description">efficiently determine image characteristics.</p>
6158
6159<div style="margin: auto;">
6160 <h3 class="magick-header"><a id="pointsize"></a>-pointsize <var>value</var></h3>
6161</div>
6162
6163<p class="magick-description">pointsize of the PostScript, OPTION1, or TrueType font.</p>
6164
6165<div style="margin: auto;">
6166 <h3 class="magick-header"><a id="polaroid"></a>-polaroid <var>angle</var></h3>
6167</div>
6168
6169<p class="magick-description">simulate a Polaroid picture.</p>
6170
6171<p>Use <code>+polaroid</code> to rotate the image at a random angle between -15 and +15 degrees.</p>
6172
6173<div style="margin: auto;">
6174 <h3 class="magick-header"><a id="poly"></a>-poly <var>"wt,exp ..."</var></h3>
6175</div>
6176
6177<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>
6178
6179<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>
6180
6181<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>
6182
6183<p>The format is: <var>output = wt1*image1^exp1 + wt2*image2^exp2 </var>...</p>
6184
6185<p>Some simple uses are:</p>
6186<ul>
6187<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>
6188<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>
6189</ul>
6190
6191<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>
6192
6193<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>
6194
6195
6196<div style="margin: auto;">
6197 <h3 class="magick-header"><a id="posterize"></a>-posterize <var>levels</var></h3>
6198</div>
6199
6200<p class="magick-description">reduce the image to a limited number of color levels per channel.</p>
6201
6202<p>Very low values of <var>levels</var>, e.g., 2, 3, 4, have the most
6203visible effect.</p>
6204
6205<div style="margin: auto;">
6206 <h3 class="magick-header"><a id="precision"></a>-precision <var>value</var></h3>
6207</div>
6208
6209<p class="magick-description">set the maximum number of significant digits to be printed.</p>
6210
6211<div style="margin: auto;">
6212 <h3 class="magick-header"><a id="preview"></a>-preview <var>type</var></h3>
6213</div>
6214
6215<p class="magick-description">image preview type.</p>
6216
6217<p>Use this option to affect the preview operation of an image (e.g.
6218<code>convert file.png -preview Gamma Preview:gamma.png</code>). Choose from
6219these previews:</p>
6220
6221<pre class="pre-scrollable">
6222AddNoise
6223Blur
6224Brightness
6225Charcoal
6226Despeckle
6227Dull
6228EdgeDetect
6229Gamma
6230Grayscale
6231Hue
6232Implode
6233JPEG
6234OilPaint
6235Quantize
6236Raise
6237ReduceNoise
6238Roll
6239Rotate
6240Saturation
6241Segment
6242Shade
6243Sharpen
6244Shear
6245Solarize
6246Spiff
6247Spread
6248Swirl
6249Threshold
6250Wave
6251</pre>
6252
6253<p>To print a complete list of previews, use the <a href="command-line-options.html#list">-list preview</a> option.</p>
6254
6255<p>The default preview is <code>JPEG</code>.</p>
6256
6257<div style="margin: auto;">
6258 <h3 class="magick-header"><a id="print"></a>-print <var>string</var></h3>
6259</div>
6260
6261<p class="magick-description">interpret string and print to console.</p>
6262
6263<div style="margin: auto;">
6264 <h3 class="magick-header"><a id="process"></a>-process <var>command</var></h3>
6265</div>
6266
6267<p class="magick-description">process the image with a custom image filter.</p>
6268
6269<p>The command arguments has the form <code>"module arg1 arg2 arg3 ...
6270argN"</code> where <code>module</code> is the name of the module to invoke (e.g.
6271"Analyze") and arg1 arg2 arg3 ... argN are an arbitrary number of arguments to
6272pass to the process module.</p>
6273
6274<div style="margin: auto;">
Cristy594d2772015-11-15 10:47:42 -05006275 <h3 class="magick-header"><a id="profile"></a>-profile <var>filename</var><br/>
Cristy882d9f42015-10-29 16:48:39 -04006276 +profile <var>profile_name</var></h3>
6277</div>
6278
6279<p class="magick-description">Manage ICM, IPTC, or generic profiles in an image.</p>
6280
6281<p>Using <a href="command-line-options.html#profile">-profile</a> <var>filename</var> adds an
6282ICM (ICC color management), IPTC (newswire information), or a generic profile
6283to the image.</p>
6284
6285<p>Use <a href="command-line-options.html#profile">+profile <var>profile_name</var></a> to
6286remove the indicated profile. ImageMagick uses standard filename globbing, so
6287wildcard expressions may be used to remove more than one profile. Here we
6288remove all profiles from the image except for the XMP profile: <code>+profile
6289"!xmp,*"</code>. </p>
6290
6291<p>Use <code>identify -verbose</code> to find out which profiles are in the
6292image file. Use <a href="command-line-options.html#strip">-strip</a> to remove all profiles (and
6293comments).</p>
6294
6295<p>To extract a profile, the <a href="command-line-options.html#profile">-profile</a> option is not
6296used. Instead, simply write the file to an image format such as <var>APP1, 8BIM, ICM,</var> or <var>IPTC</var>.</p>
6297
6298<p>For example, to extract the Exif data (which is stored in JPEG files in the
6299<var>APP1</var> profile), use.</p>
6300
6301<pre>
6302convert cockatoo.jpg profile.exif
6303</pre>
6304
6305<p>It is important to note that results may depend on whether or not the
Cristy594d2772015-11-15 10:47:42 -05006306original image already has an included profile. Also, keep in mind that <a
6307href="command-line-options.html#profile">-profile</a> is an "operator" (as opposed to a "setting") and
Cristy882d9f42015-10-29 16:48:39 -04006308therefore a conversion is made each time it is encountered, in order, in the
6309command-line. For instance, in the following example, if the original image is
6310CMYK with profile, a CMYK-CMYK-RGB conversion results.</p>
6311
6312<pre>
6313convert CMYK.tif -profile "CMYK.icc" -profile "RGB.icc" RGB.tiff
6314</pre>
6315
6316<p>Furthermore, since ICC profiles are not necessarily symmetric, extra
6317conversion steps can yield unwanted results. CMYK profiles are often very
6318asymmetric since they involve 3−&gt;4 and 4−&gt;3 channel mapping.
6319</p>
6320
6321<div style="margin: auto;">
6322 <h3 class="magick-header"><a id="quality"></a>-quality <var>value</var></h3>
6323</div>
6324
6325<p class="magick-description">JPEG/MIFF/PNG compression level.</p>
6326
6327<p>For the JPEG and MPEG image formats, quality is 1 (lowest image quality and
6328highest compression) to 100 (best quality but least effective compression).
6329The default is to use the estimated quality of your input image if it can
6330be determined, otherwise 92. When the quality is greater than 90, then the
6331chroma channels are not downsampled.
6332Use the <a href="command-line-options.html#sampling-factor">-sampling-factor</a> option to specify the
6333factors for chroma downsampling.</p>
6334
6335<p>For the JPEG-2000 image format, quality is mapped using a non-linear
6336equation to the compression ratio required by the Jasper library. This
6337non-linear equation is intended to loosely approximate the quality provided by
6338the JPEG v1 format. The default quality value 100, a request for non-lossy
6339compression. A quality of 75 results in a request for 16:1 compression.</p>
6340
6341<p>For the MNG and PNG image formats, the quality value sets the zlib
6342compression level (quality / 10) and filter-type (quality % 10). The default
6343PNG "quality" is 75, which means compression level 7 with adaptive PNG
6344filtering, unless the image has a color map, in which case it means
6345compression level 7 with no PNG filtering.</p>
6346
6347<p>For compression level 0 (quality value less than 10), the Huffman-only
6348strategy is used, which is fastest but not necessarily the worst
6349compression.</p>
6350
6351<p>If filter-type is 4 or less, the specified PNG filter-type is used for
6352all scanlines:</p>
6353
6354<dl class="dl-horizontal">
6355<dt>0</dt><dd>none</dd>
6356<dt>1</dt><dd>sub</dd>
6357<dt>2</dt><dd>up</dd>
6358<dt>3</dt><dd>average</dd>
6359<dt>4</dt><dd>Paeth</dd>
6360</dl>
6361
6362<p>If filter-type is 5, adaptive filtering is used when quality is greater
6363than 50 and the image does not have a color map, otherwise no filtering is
6364used.</p>
6365
6366<p>If filter-type is 6, adaptive filtering
6367with <var>minimum-sum-of-absolute-values</var> is used.</p>
6368
6369<p>Only if the output is MNG, if filter-type is 7, the LOCO color
6370transformation (intrapixel differencing) and adaptive filtering
6371with <var>minimum-sum-of-absolute-values</var> are used.</p>
6372
6373<p>If the filter-type is 8 the zlib Z_RLE compression strategy (or the
6374Z_HUFFMAN_ONLY strategy, when compression level is 0) is used with
6375adaptive PNG filtering.</p>
6376
6377<p>If the filter-type is 9 the zlib Z_RLE compression strategy (or the
6378Z_HUFFMAN_ONLY strategy, when compression level is 0) is used with
6379no PNG filtering.</p>
6380
6381<p>The quality setting has no effect on the appearance or signature of PNG
6382and MNG images, since the compression is always lossless.</p>
6383
6384<p>Not all combinations of compression level, strategy, and PNG filter type
6385can be obtained using the -quality option. For more precise control,
6386you can use the PNG:compression-level=N, PNG:compression-strategy=N, and
6387PNG:compression-filter=N defines, respectively, instead.
6388See <a href="command-line-options.html#define">-define</a>. Values from the defines take precedence
6389over values from the -quality option.</p>
6390
6391<p>For further information, see
6392the <a href="http://www.w3.org/pub/WWW/TR">PNG</a> specification.</p>
6393
6394<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>
6395
6396<p>For the BPG image format, quality/2 is the actual BPG compression level (range from 0 to 51).</p>
6397
6398<div style="margin: auto;">
6399 <h3 class="magick-header"><a id="quantize"></a>-quantize <var>colorspace</var></h3>
6400</div>
6401
6402<p class="magick-description">reduce colors using this colorspace.</p>
6403
6404<p>This setting defines the colorspace used to sort out and reduce the number
Cristy594d2772015-11-15 10:47:42 -05006405of colors needed by an image (for later dithering) by operators such as <a
6406href="command-line-options.html#colors" >-colors</a>, Note that color reduction also happens
Cristy882d9f42015-10-29 16:48:39 -04006407automatically when saving images to color-limited image file formats, such as
6408GIF, and PNG8.</p>
6409
6410
6411<div style="margin: auto;">
6412 <h3 class="magick-header"><a id="quiet"></a>-quiet</h3>
6413</div>
6414
6415<p class="magick-description">suppress all warning messages. Error messages are still reported.</p>
6416
6417<div style="margin: auto;">
6418 <h3 class="magick-header"><a id="radial-blur"></a>-radial-blur <var>angle</var></h3>
6419</div>
6420
6421<p class="magick-description">Blur around the center of the image.</p>
6422
6423<p>Note that this is actually a rotational blur rather than a radial and as
6424such actually mis-named. </p>
6425
6426<p>The <a href="command-line-options.html#virtual-pixel">-virtual-pixel</a> setting will determine how
6427pixels which are outside the image proper are blurred into the final result.
6428</p>
6429
6430
6431<div style="margin: auto;">
6432 <h3 class="magick-header"><a id="raise"></a>-raise <var>thickness</var></h3>
6433</div>
6434
6435<p class="magick-description">Lighten or darken image edges.</p>
6436
6437<p>This will create a 3-D effect. Use <a href="command-line-options.html#raise">-raise</a> to create
6438a raised effect, otherwise use <a href="command-line-options.html#raise">+raise</a>. </p>
6439
Cristy594d2772015-11-15 10:47:42 -05006440<p>Unlike the similar <a href="command-line-options.html#frame">-frame</a> option, <a
6441href="command-line-options.html#raise">-raise</a> does not alter the dimensions of the image.</p>
Cristy882d9f42015-10-29 16:48:39 -04006442
6443<div style="margin: auto;">
6444 <h3 class="magick-header"><a id="random-threshold"></a>-random-threshold <var>low</var>x<var>high</var></h3>
6445</div>
6446
6447<p class="magick-description">Apply a random threshold to the image.</p>
6448
6449<div style="margin: auto;">
6450 <h3 class="magick-header"><a id="red-primary"></a>-red-primary <var>x,y</var></h3>
6451</div>
6452
6453<p class="magick-description">Set the red chromaticity primary point.</p>
6454
6455<div style="margin: auto;">
6456 <h3 class="magick-header"><a id="regard-warnings"></a>-regard-warnings</h3>
6457</div>
6458
6459<p class="magick-description">Pay attention to warning messages.</p>
6460
6461<p>This option causes some warnings in some image formats to be treated
6462as errors. </p>
6463
6464<div style="margin: auto;">
6465 <h3 class="magick-header"><a id="remap"></a>-remap <var>filename</var></h3>
6466</div>
6467
6468<p class="magick-description">Reduce the number of colors in an image to the colors used by this image.</p>
6469
6470<p>If the <a href="command-line-options.html#dither">-dither</a> setting is enabled (the default) then
6471the given colors are dithered over the image as necessary, otherwise the closest
6472color (in RGB colorspace) is selected to replace that pixel in the image. </p>
6473
6474<p>As a side effect of applying a <a href="command-line-options.html#remap">-remap</a> of colors across all
6475images in the current image sequence, all the images will have the same color
6476table. That means that when saved to a file format such as GIF, it will use
6477that color table as a single common or global color table, for all the images,
6478without requiring extra local color tables. </p>
6479
6480<p>Use <a href="command-line-options.html#remap">+remap</a> to reduce all images in the current image
6481sequence to use a common color map over all the images. This equivalent to
6482appending all the images together (without extra background colors) and color
6483reducing those images using <a href="command-line-options.html#colors">-colors</a> with a 256 color
6484limit, then <a href="command-line-options.html#remap">-remap</a> those colors over the original list of
6485images. This ensures all the images follow a single color map. </p>
6486
Cristy594d2772015-11-15 10:47:42 -05006487<p>If the number of colors over all the images is less than 256, then <a
6488href="command-line-options.html#remap">+remap</a> should not perform any color reduction or dithering, as
Cristy882d9f42015-10-29 16:48:39 -04006489no color changes are needed. In that case, its only effect is to force the use
Cristy594d2772015-11-15 10:47:42 -05006490of a global color table. This recommended after using either <a
6491href="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 -04006492reduce the number of colors in an animated image sequence. </p>
6493
6494<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>
6495
6496<div style="margin: auto;">
6497 <h3 class="magick-header"><a id="region"></a>-region <var>geometry</var></h3>
6498</div>
6499
6500<p class="magick-description">Set a region in which subsequent operations apply.</p>
6501
6502<p>The <var>x</var> and <var>y</var> offsets are treated
6503in the same manner as in <a href="command-line-options.html#crop">-crop</a>.</p>
6504
6505<p>See <a href="command-line-processing.html#geometry">Image Geometry</a> for complete details about the <em class="arg">geometry</em> argument.</p>
6506
6507<p>Use <code>+region</code> to remove any previously set regions.</p>
6508
Cristy882d9f42015-10-29 16:48:39 -04006509<div style="margin: auto;">
6510 <h3 class="magick-header"><a id="remote"></a>-remote</h3>
6511</div>
6512
6513<p class="magick-description">perform a remote operation.</p>
6514
6515<p>The only command recognized is the name of an image file to load.</p>
6516
6517<p>If you have more than one <a href="display.html">display</a> application
6518running simultaneously, use the <a href="command-line-options.html#window"> window</a> option to
6519specify which application to control.</p>
6520
6521<div style="margin: auto;">
6522 <h3 class="magick-header"><a id="render"></a>-render</h3>
6523</div>
6524
6525<p class="magick-description">render vector operations.</p>
6526
6527<p>Use <a href="command-line-options.html#render">+render</a> to turn off rendering vector operations.
6528This useful when saving the result to vector formats such as MVG or SVG.</p>
6529
6530<div style="margin: auto;">
6531<h3 class="magick-header"><a id="repage"></a>-repage <var>geometry</var></h3>
6532</div>
6533
6534<p class="magick-description">Adjust the canvas and offset information of the image.</p>
6535
6536<p>This option is like <a href="command-line-options.html#page">-page</a> but acts as an image operator
6537rather than a setting. You can separately set the canvas size or the offset
6538of the image on that canvas by only providing those components. </p>
6539
6540<p>See <a href="command-line-processing.html#geometry">Image Geometry</a> for complete details about the <em class="arg">geometry</em> argument.</p>
6541
6542<p>If a <code>!</code> flag is given the offset given is added to the existing
6543offset to move the image relative to its previous position. This useful for
6544animation sequences. </p>
6545
6546<p>A given a canvas size of zero such as '<code>0x0</code>' forces it to
6547recalculate the canvas size so the image (at its current offset) will appear
6548completely on that canvas (unless it has a negative offset).</p>
6549
6550<p>Use <a href="command-line-options.html#repage">+repage</a> to completely remove/reset the virtual
6551canvas meta-data from the images. </p>
6552
6553<p>The <a href="command-line-options.html#set">-set</a> '<code>page</code>' option can be used to
6554directly assign virtual canvas meta-data. </p>
6555
6556
6557<div style="margin: auto;">
6558 <h3 class="magick-header"><a id="resample"></a>-resample <var>horizontal</var>x<var>vertical</var></h3>
6559</div>
6560
6561<p class="magick-description">Resample image to specified horizontal and vertical resolution.</p>
6562
6563<p>Resize the image so that its rendered size remains the same as the original
6564at the specified target resolution. For example, if a 300 DPI image renders at
65653 inches by 2 inches on a 300 DPI device, when the image has been resampled to
656672 DPI, it will render at 3 inches by 2 inches on a 72 DPI device. Note that
6567only a small number of image formats (e.g. JPEG, PNG, and TIFF) are capable of
6568storing the image resolution. For formats which do not support an image
Cristy594d2772015-11-15 10:47:42 -05006569resolution, the original resolution of the image must be specified via <a
6570href="command-line-options.html#density">-density</a> on the command line prior to specifying the
Cristy882d9f42015-10-29 16:48:39 -04006571resample resolution.</p>
6572
6573<p>Note that Photoshop stores and obtains image resolution from a proprietary
6574embedded profile. If this profile exists in the image, then Photoshop will
6575continue to treat the image using its former resolution, ignoring the image
6576resolution specified in the standard file header.</p>
6577
6578<div style="margin: auto;">
6579 <h3 class="magick-header"><a id="resize"></a>-resize <var>geometry</var></h3>
6580</div>
6581
6582<p class="magick-description">Resize an image.</p>
6583
6584<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
6585ignored, and the <a href="command-line-options.html#gravity">-gravity</a> option has no effect.</p>
6586
6587<p>If the <a href="command-line-options.html#filter">-filter</a> option
Cristy594d2772015-11-15 10:47:42 -05006588or <code>-define filter:option=value</code> precedes the <a
6589href="command-line-options.html#resize">-resize</a> option, the image is resized with the specified
Cristy882d9f42015-10-29 16:48:39 -04006590filter.</p>
6591
6592<p>Many image processing algorithms assume your image is in a linear-light
6593coding. If your image is gamma-corrected, you can remove the nonlinear gamma
6594correction, apply the transform, then restore it like this:</p>
6595
6596<pre>
6597convert portrait.jpg -gamma .45455 -resize 25% -gamma 2.2 \
6598 -quality 92 passport.jpg
6599</pre>
6600
6601<div style="margin: auto;">
6602 <h3 class="magick-header"><a id="respect-parentheses"></a>-respect-parentheses</h3>
6603</div>
6604
6605<p class="magick-description">settings remain in effect until parenthesis boundary.</p>
6606
6607<div style="margin: auto;">
6608 <h3 class="magick-header"><a id="reverse"></a>-reverse</h3>
6609</div>
6610
6611<p class="magick-description">Reverse the order of images in the current image list.</p>
6612
6613
6614<div style="margin: auto;">
6615 <h3 class="magick-header"><a id="roll"></a>-roll {<var>+-</var>}<var>x</var>{<var>+-</var>}<var>y</var></h3>
6616</div>
6617
6618<p class="magick-description">roll an image vertically or horizontally by the amount given.</p>
6619
6620<p>A negative <var>x</var> offset rolls the image right-to-left.
6621A negative <var>y</var> offset rolls the image bottom-to-top.</p>
6622
6623
6624<div style="margin: auto;">
6625 <h3 class="magick-header"><a id="rotate"></a>-rotate <var>degrees</var>{<var>&lt;</var>}{<var>&gt;</var>}</h3>
6626</div>
6627
6628<p class="magick-description">Apply Paeth image rotation (using shear operations) to the image.</p>
6629
6630<p>Use <code>&gt;</code> to rotate the image only if its width exceeds the
6631height. <code>&lt;</code> rotates the image <var>only</var> if its width is less
6632than the height. For example, if you specify <code>-rotate "-90&gt;"</code> and
6633the image size is 480x640, the image is not rotated. However, if the image is
6634640x480, it is rotated by -90 degrees. If you use <code>&gt;</code> or
6635<code>&lt;</code>, enclose it in quotation marks to prevent it from being
6636misinterpreted as a file redirection.</p>
6637
6638<p>Empty triangles in the corners, left over from rotating the image, are
6639filled with the <code>background</code> color. </p>
6640
6641<p>See also the <a href="command-line-options.html#distort">-distort</a> operator and specifically the
6642'<code>ScaleRotateTranslate</code>' distort method. </p>
6643
6644
6645<div style="margin: auto;">
6646 <h3 class="magick-header"><a id="sample"></a>-sample <var>geometry</var></h3>
6647</div>
6648
6649<p class="magick-description">minify / magnify the image with pixel subsampling and pixel replication, respectively.</p>
6650
6651<p>Change the image size simply by directly sampling the pixels original
6652from the image. When magnifying, pixels are replicated in blocks. When
6653minifying, pixels are sub-sampled (i.e., some rows and columns are skipped
6654over). </p>
6655
6656<p>The results are thus equivalent to using <a href="command-line-options.html#resize">-resize</a> with
6657a <a href="command-line-options.html#filter">-filter</a> setting of <code>point</code> (nearest
6658neighbor), though <a href="command-line-options.html#sample">-sample</a> is a lot faster, as it
6659avoids all the filter processing of the image. As such it completely ignores
6660the current <a href="command-line-options.html#filter">-filter</a> setting. </p>
6661
6662<p>The key feature of the <a href="command-line-options.html#sample">-sample</a> is that no new colors
6663will be added to the resulting image, though some colors may disappear. </p>
6664
6665<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
6666ignored, unlike <a href="command-line-options.html#resize">-resize</a>. </p>
6667
6668
6669<p>The actual sampling point is the middle of the sub-region being sampled.
6670As such a single pixel sampling of an image will take the middle pixel, (or
Cristy594d2772015-11-15 10:47:42 -05006671top-left-middle if image has even dimensions). However the <a
6672href="command-line-options.html#define">-define</a> '<code>sample:offset</code>' can be set to modify
Cristy882d9f42015-10-29 16:48:39 -04006673this position some other location within each sub-region being sampled, as
6674a percentage offset.</p>
6675
6676<p>By default this value is '<code>50</code>' for the midpoint, but could be set
6677to '<code>0</code>' for top-left, '<code>100</code>' for bottom-right, or with
6678separate X and Y offsets such as '<code>0x50</code>' for left-middle edge of
6679sampling sub-region.</p>
6680
6681
6682<div style="margin: auto;">
6683 <h3 class="magick-header"><a id="sampling-factor"></a>-sampling-factor <var>horizontal-factor</var>x<var>vertical-factor</var></h3>
6684</div>
6685
6686<p class="magick-description">sampling factors used by JPEG or MPEG-2 encoder and YUV decoder/encoder.</p>
6687
6688<p>This option specifies the sampling factors to be used by the JPEG encoder
6689for chroma downsampling. If this option is omitted, the JPEG library will use
6690its own default values. When reading or writing the YUV format and when
Cristy594d2772015-11-15 10:47:42 -05006691writing the M2V (MPEG-2) format, use <a
6692href="command-line-options.html#sampling-factor">-sampling-factor 2x1</a> or <a
6693href="command-line-options.html#sampling-factor">-sampling-factor 4:2:2</a> to specify the 4:2:2
Cristy882d9f42015-10-29 16:48:39 -04006694downsampling method.</p>
6695
6696<div style="margin: auto;">
6697 <h3 class="magick-header"><a id="scale"></a>-scale <var>geometry</var></h3>
6698</div>
6699
6700<p class="magick-description">minify / magnify the image with pixel block averaging and pixel replication, respectively.</p>
6701
6702<p>Change the image size simply by replacing pixels by averaging pixels
6703together when minifying, or replacing pixels when magnifying. </p>
6704
6705<p>The results are thus equivalent to using <a href="command-line-options.html#resize">-resize</a> with
6706a <a href="command-line-options.html#filter">-filter</a> setting of <code>box</code>. Though it is a lot
6707faster, as it avoids all the filter processing of the image. As such it
6708completely ignores the current <a href="command-line-options.html#filter">-filter</a> setting. </p>
6709
6710<p>If when shrinking (minifying) images the original image is some integer
6711multiple of the new image size, the number of pixels averaged together to
6712produce the new pixel color is the same across the whole image. This is
6713a special case known as 'binning' and is often used as a method of reducing
6714noise in image such as those generated by digital cameras, especially in low
6715light conditions. </p>
6716
6717
6718<div style="margin: auto;">
6719 <h3 class="magick-header"><a id="scene"></a>-scene <var>value</var></h3>
6720</div>
6721
6722<p class="magick-description">set scene number.</p>
6723
6724<p>This option sets the scene number of an image or the first image in an image sequence.</p>
6725
6726<div style="margin: auto;">
6727 <h3 class="magick-header"><a id="screen"></a>-screen</h3>
6728</div>
6729
6730<p class="magick-description">specify the screen to capture.</p>
6731
6732<p>This option indicates that the GetImage request used to obtain the image
6733should be done on the root window, rather than directly on the specified
6734window. In this way, you can obtain pieces of other windows that overlap the
6735specified window, and more importantly, you can capture menus or other popups
6736that are independent windows but appear over the specified window.</p>
6737
6738<div style="margin: auto;">
6739 <h3 class="magick-header"><a id="seed"></a>-seed</h3>
6740</div>
6741
6742<p class="magick-description">seed a new sequence of pseudo-random numbers</p>
6743
6744<div style="margin: auto;">
6745 <h3 class="magick-header"><a id="segment"></a>-segment <var>cluster-threshold</var>x<var>smoothing-threshold</var></h3>
6746</div>
6747
6748<p class="magick-description">segment the colors of an image.</p>
6749
6750<p>Segment an image by analyzing the histograms of the color components and
6751identifying units that are homogeneous with the fuzzy c-means technique. This
6752is part of the ImageMagick color quantization routines. </p>
6753
6754<p>Specify <var>cluster threshold</var> as the number of pixels in
6755each cluster that must exceed the cluster threshold to be considered valid.
6756<var>Smoothing threshold</var> eliminates noise in the second
6757derivative of the histogram. As the value is increased, you can expect
6758a smoother second derivative. The default is 1.5.</p>
6759
6760<p>If the <a href="command-line-options.html#verbose">-verbose</a> setting is defined, a detailed report
6761of the color clusters is returned.</p>
6762
6763
6764<div style="margin: auto;">
Cristy594d2772015-11-15 10:47:42 -05006765 <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 -04006766</div>
6767
6768<p class="magick-description">Selectively blur pixels within a contrast threshold.</p>
6769
6770<p>Blurs those pixels that are less than or equal to the threshold in
6771contrast. The threshold may be expressed as a fraction of <var>QuantumRange</var> or as a percentage.</p>
6772
6773<div style="margin: auto;">
6774 <h3 class="magick-header"><a id="separate"></a>-separate</h3>
6775</div>
6776
6777<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>
6778
6779<div style="margin: auto;">
Cristy769d8892016-01-19 18:11:14 -05006780 <h3 class="magick-header"><a id="sepia-tone"></a>-sepia-tone <var>percent-threshold</var></h3>
Cristy882d9f42015-10-29 16:48:39 -04006781</div>
6782
6783<p class="magick-description">simulate a sepia-toned photo.</p>
6784
6785<p>Specify <var>threshold</var> as the percent threshold of the intensity (0 - 99.9%).</p>
6786
6787<p>This option applies a special effect to the image, similar to the effect
6788achieved 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
6789toning. A threshold of 80% is a good starting point for a reasonable
6790tone.</p>
6791
6792
6793
6794<div style="margin: auto;">
6795 <h3 class="magick-header"><a id="set"></a>-set <var>key value</var></h3>
6796 <h3 class="magick-header">+set <var>key</var></h3>
6797</div>
6798
6799<p class="magick-description">sets image attributes and properties for images in the current image sequence.</p>
6800
6801<p>This will assign (or modify) specific settings attached to all the images
6802in the current image sequence. Using the <a href="command-line-options.html#set">+set</a> form of the
6803option will either remove, or reset that setting to a default state, as
6804appropriate. </p>
6805
6806<p>For example, it will modify specific well known image meta-data
Cristy594d2772015-11-15 10:47:42 -05006807'attributes' such as those normally overridden by: the options <a
6808href="command-line-options.html#delay" >-delay</a>, <a href="command-line-options.html#dispose" >-dispose</a>, and <a
6809href="command-line-options.html#page" >-page</a>, <a href="command-line-options.html#colorspace" >-colorspace</a>; generally
Cristy882d9f42015-10-29 16:48:39 -04006810assigned before the image is read in, by using a <var>key</var> of
6811the same name. </p>
6812
6813<p>If the given <var>key</var> does not match a specific known
6814'attribute ', such as shown above, the setting is stored as a a free form
Cristy594d2772015-11-15 10:47:42 -05006815'property' string. Such settings are listed in <a href="command-line-options.html#verbose"
6816>-verbose</a> information ("<code>info:</code>" output format) as "Properties".
Cristy882d9f42015-10-29 16:48:39 -04006817</p>
6818
6819<p>This includes string 'properties' that are set by and assigned to images
Cristy594d2772015-11-15 10:47:42 -05006820using the options <a href="command-line-options.html#comment" >-comment</a>, <a href="command-line-options.html#label"
6821>-label</a>, <a href="command-line-options.html#caption" >-caption</a>. These options actually assign
6822a global 'artifact' which are automatically assigned (and any <a href="escape.html" >Format Percent
Cristy882d9f42015-10-29 16:48:39 -04006823Escapes</a> expanded) to images as they are read in. For example:</p>
6824
6825<pre>
Cristy594d2772015-11-15 10:47:42 -05006826-> convert rose: -set comment 'Rose is a rose is a rose is a rose' rose.png
Cristy882d9f42015-10-29 16:48:39 -04006827identify -format %c rose.png
6828Rose is a rose is a rose is a rose
6829</pre>
6830
Cristy594d2772015-11-15 10:47:42 -05006831<p>The set value can also make use of <a href="escape.html" >Format and Print Image
Cristy882d9f42015-10-29 16:48:39 -04006832Properties</a> in the defined value. For example:</p>
6833
6834<pre>
Cristy594d2772015-11-15 10:47:42 -05006835-> convert rose: -set origsize '%wx%h' -resize 50% \
Cristy882d9f42015-10-29 16:48:39 -04006836 -format 'Old size = %[origsize] New size = %wx%h' info:
6837Old size = 70x46 New size = 35x23
6838</pre>
6839
6840<p>Other well known 'properties' that are available include:
6841'<code>date:create</code>' and '<code>date:modify</code>' and
6842'<code>signature</code>'. </p>
6843
6844<p>The <a href="command-line-options.html#repage">-repage</a> operator will also allow you to modify
6845the '<code>page</code>' attribute of an image for images already in memory (also
6846see <a href="command-line-options.html#repage">-page</a>). However it is designed to provide a finer
6847control of the sub-parts of this 'attribute'. The <a href="command-line-options.html#set">-set page</a>
6848option will only provide a direct, unmodified assignment of '<code>page</code>'
6849attribute. </p>
6850
6851<p>This option can also associate a colorspace or profile with your image.
6852For example,</p>
6853
6854<pre>
6855convert image.psd -set profile ISOcoated_v2_eci.icc image-icc.psd
6856</pre>
6857
6858<p>Some 'properties' must be defined in a specific way to be used. For
6859example only 'properties' prefixed with "<code>filename:</code>" can be used to
6860modify the output filename of an image. For example</p>
6861
6862<pre>
6863convert rose: -set filename:mysize '%wx%h' 'rose_%[filename:mysize].png'
6864</pre>
6865
6866<p>If the setting value is prefixed with "<code>option:</code>" the setting will
Cristy594d2772015-11-15 10:47:42 -05006867be saved as a global "Artifact" exactly as if it was set using the <a
6868href="command-line-options.html#define" >-define</a> option. As such settings are global in scope, they
Cristy882d9f42015-10-29 16:48:39 -04006869can be used to pass 'attributes' and 'properties' of one specific image,
6870in a way that allows you to use them in a completely different image, even if
6871the original image has long since been modified or destroyed. For example: </p>
6872
6873<pre>
6874convert rose: -set option:rosesize '%wx%h' -delete 0 \
6875 label:'%[rosesize]' label_size_of_rose.gif"
6876</pre>
6877
Cristy594d2772015-11-15 10:47:42 -05006878<p>Note that <a href="escape.html" >Format Percent Escapes</a> will only match
Cristy882d9f42015-10-29 16:48:39 -04006879a 'artifact' if the given <var>key</var> does not match an existing
6880'attribute' or 'property'. </p>
6881
6882<p>You can set the attributes of the image registry by prefixing the value
6883with <code>registry:</code>.</p>
6884
6885<p>The <a href="command-line-options.html#set">-set profile</a> option can also be used to inject
6886previously-formatted ancillary chunks into the output PNG file, using
6887the commandline option as shown below or by setting the profile via a
6888programming interface:</p>
6889
6890<pre>
6891convert in.png -set profile PNG-chunk-x:&lt;filename&gt; out.png
6892</pre>
6893
6894<p>where <var>x</var> is a location flag and
6895<var>filename</var> is a file containing the chunk
6896name in the first 4 bytes, then a colon (":"), followed by the chunk data.
6897This encoder will compute the chunk length and CRC, so those must not
6898be included in the file.</p>
6899
6900<p>"x" can be "b" (before PLTE), "m" (middle, i.e., between PLTE and IDAT),
6901or "e" (end, i.e., after IDAT). If you want to write multiple chunks
6902of the same type, then add a short unique string after the "x" to prevent
6903subsequent profiles from overwriting the preceding ones, e.g.,</p>
6904
6905
6906<pre>
6907convert in.png -set profile PNG-chunk-b01:file01 \
6908 -profile PNG-chunk-b02:file02 out.png
6909</pre>
6910
6911<div style="margin: auto;">
6912 <h3 class="magick-header"><a id="shade"></a>-shade <var>azimuth</var>x<var>elevation</var></h3>
6913</div>
6914
6915<p class="magick-description">shade the image using a distant light source.</p>
6916
6917<p>Specify <var>azimuth</var> and <var>elevation</var> as
6918the position of the light source. Use <a href="command-line-options.html#shade">+shade</a> to return
6919the shading results as a grayscale image.</p>
6920
6921<div style="margin: auto;">
6922 <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>
6923</div>
6924
6925<p class="magick-description">simulate an image shadow.</p>
6926
6927<div style="margin: auto;">
Cristy594d2772015-11-15 10:47:42 -05006928 <h3 class="magick-header"><a
6929id="shared-memory"></a>-shared-memory</h3>
Cristy882d9f42015-10-29 16:48:39 -04006930</div>
6931
6932<p class="magick-description">use shared memory.</p>
6933
6934<p>This option specifies whether the utility should attempt to use shared
6935memory for pixmaps. ImageMagick must be compiled with shared memory support,
6936and the display must support the <var>MIT-SHM</var> extension.
6937Otherwise, this option is ignored. The default is <code>True</code>.</p>
6938
6939<div style="margin: auto;">
Cristy594d2772015-11-15 10:47:42 -05006940 <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 -04006941</div>
6942
6943<p class="magick-description">sharpen the image.</p>
6944
6945<p>Use a Gaussian operator of the given radius and standard deviation (sigma).</p>
6946
6947<div style="margin: auto;">
6948 <h3 class="magick-header"><a id="shave"></a>-shave <var>geometry</var></h3>
6949</div>
6950
6951<p class="magick-description">Shave pixels from the image edges.</p>
6952
6953<p>The <var>size</var> portion of the <var>geometry</var>
6954argument specifies the width of the region to be removed from both sides of
6955the image and the height of the regions to be removed from top and bottom.
6956Offsets are ignored.</p>
6957
6958<p>See <a href="command-line-processing.html#geometry">Image Geometry</a> for complete details about the <em class="arg">geometry</em> argument.</p>
6959
6960<div style="margin: auto;">
6961 <h3 class="magick-header"><a id="shear"></a>-shear <var>Xdegrees</var>[x<var>Ydegrees</var>]</h3>
6962</div>
6963
6964<p class="magick-description">Shear the image along the x-axis and/or y-axis.</p>
6965
6966<p>The shear angles may be positive, negative, or zero. When <var>Ydegrees</var> is omitted it defaults to 0. When both angles are
6967given, the horizontal component of the shear is performed before the vertical
6968component.</p>
6969
6970<p>Shearing slides one edge of an image along the x-axis or y-axis (i.e.,
6971horizontally or vertically, respectively),creating a parallelogram. The amount
6972of each is controlled by the respective shear angle. For horizontal shears,
6973<var>Xdegrees</var> is measured clockwise relative to "up" (the
6974negative 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
6975positive 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>
6976
6977<p>Empty triangles left over from shearing the image are filled with the color
6978defined by the <a href="command-line-options.html#fill">-background</a> option. The color is specified
6979using the format described under the <a href="command-line-options.html#fill">-fill</a> option.</p>
6980
6981<p>The horizontal shear is performed before the vertical part. This is
6982important to note, since horizontal and vertical shears do not
6983<var>commute</var>, i.e., the order matters in a sequence of shears. For
6984example, the following two commands are not equivalent.</p>
6985
6986<pre>
6987convert logo: -shear 20x0 -shear 0x60 logo-sheared.png
6988convert logo: -shear 0x60 -shear 20x0 logo-sheared.png
6989</pre>
6990
6991<p>The first of the two commands above is equivalent to the following, except
6992for the amount of empty space created; the command that follows generates
6993a smaller image, and so is a better choice in terms of time and space.</p>
6994
6995<pre>
6996convert logo: -shear 20x60 logo-sheared.png
6997</pre>
6998
6999<div style="margin: auto;">
7000 <h3 class="magick-header"><a id="sigmoidal-contrast"></a>-sigmoidal-contrast <var>contrast</var>x<var>mid-point</var></h3>
7001</div>
7002
7003<p class="magick-description">increase the contrast without saturating highlights or shadows.</p>
7004
7005<p>Increase the contrast of the image using a sigmoidal transfer function
7006without saturating highlights or shadows. <var>Contrast</var>
7007indicates how much to increase the contrast. For example, 0 is none, 3 is
7008typical and 20 is a lot.
7009</p>
7010
7011<p>The <var>mid-point</var> indicates where the maximum change
7012'slope' in contrast should fall in the resultant image (0 is white; 50% is
7013middle-gray; 100% is black). </p>
7014
7015<p>By default the image contrast is increased, use <var>+sigmoidal-contrast</var> to decrease the contrast.</p>
7016
7017<p>To achieve the equivalent of a sigmoidal brightness change (similar to
7018a gamma adjustment), you would use <var>-sigmoidal-contrast
7019{brightness}x0%</var> to increase brightness and <var>+sigmoidal-contrast {brightness}x0%</var> to decrease brightness.
7020Note the use of '0' fo rthe mid-point of the sigmoidal curve. </p>
7021
7022<p>Using a very high <var>contrast</var> will produce a sort of
7023'smoothed thresholding' of the image. Not as sharp (with high aliasing
7024effects) of a true threshold, but with tapered gray-levels around the threshold
7025<var>mid-point</var>. </p>
7026
7027<div style="margin: auto;">
7028 <h3 class="magick-header"><a id="silent"></a>-silent</h3>
Cristyf650f4f2016-04-01 10:53:07 -04007029
7030
Cristy882d9f42015-10-29 16:48:39 -04007031</div>
7032
Cristyf650f4f2016-04-01 10:53:07 -04007033<p class="magick-description">operate silently. This option is only used
7034by the <a href="import.html">import</a> tool.</p>
Cristy882d9f42015-10-29 16:48:39 -04007035
7036<div style="margin: auto;">
7037 <h3 class="magick-header"><a id="similarity-threshold"></a>-similarity-threshold <var>value</var></h3>
7038</div>
7039
7040<p class="magick-description">minimum RMSE for subimage match.</p>
7041
7042<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>
7043
7044<div style="margin: auto;">
7045 <h3 class="magick-header"><a id="size"></a>-size <var>width</var>[x<var>height</var>][<var>+offset</var>]</h3>
7046</div>
7047
7048<p class="magick-description">set the width and height of the image.</p>
7049
7050<p>Use this option to specify the width and height of raw images whose
7051dimensions are unknown such as <code>GRAY</code>, <code>RGB</code>, or
Cristy594d2772015-11-15 10:47:42 -05007052<code>CMYK</code>. In addition to width and height, use <a
7053href="command-line-options.html#size">-size</a> with an offset to skip any header information in the
Cristy882d9f42015-10-29 16:48:39 -04007054image or tell the number of colors in a <code>MAP</code> image file, (e.g. -size
7055640x512+256).</p>
7056
7057<p>For Photo CD images, choose from these sizes:</p>
7058
7059<pre>
7060192x128
7061384x256
7062768x512
70631536x1024
70643072x2048
7065</pre>
7066
7067<div style="margin: auto;">
Cristy594d2772015-11-15 10:47:42 -05007068 <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 -04007069</div>
7070
7071<p class="magick-description">simulate a pencil sketch.</p>
7072
7073<p>Sketch with the given radius, standard deviation (sigma), and angle. The
7074angle given is the angle toward which the image is sketched. That is the
7075direction people would consider the object is coming from. </p>
7076
7077<div style="margin: auto;">
7078 <h3 class="magick-header"><a id="smush"></a>-smush <var>offset</var></h3>
7079</div>
7080
7081<p class="magick-description">smush an image sequence together.</p>
7082
7083<div style="margin: auto;">
7084 <h3 class="magick-header"><a id="snaps"></a>-snaps <var>value</var></h3>
7085</div>
7086
7087<p class="magick-description">Set the number of screen snapshots.</p>
7088
7089<p>Use this option to grab more than one image from the X server screen, to create an animation sequence.</p>
7090
7091<div style="margin: auto;">
Cristy769d8892016-01-19 18:11:14 -05007092 <h3 class="magick-header"><a id="solarize"></a>-solarize <var>percent-threshold</var></h3>
Cristy882d9f42015-10-29 16:48:39 -04007093</div>
7094
7095<p class="magick-description">negate all pixels above the threshold level.</p>
7096
7097<p>Specify <var>factor</var> as the percent threshold of the intensity (0 - 99.9%).</p>
7098
7099<p>This option produces a <var>solarization</var> effect seen when
7100exposing a photographic film to light during the development process.</p>
7101
7102<div style="margin: auto;">
7103 <h3 class="magick-header"><a id="sparse-color"></a>-sparse-color <var>method</var> '<var>x</var>,<var>y</var> <var>color</var> ...'</h3>
7104</div>
7105
7106<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>
7107
7108
7109<dl class="dl-horizontal">
7110 <dt>barycentric</dt>
7111 <dd>three point triangle of color given 3 points.
7112 Giving only 2 points will form a linear gradient between those points.
7113 The gradient generated extends beyond the triangle created by those
7114 3 points. </dd>
7115 <dt>bilinear</dt>
7116 <dd>Like barycentric but for 4 points. Less than 4 points
7117 fall back to barycentric. </dd>
7118 <dt>voronoi</dt>
7119 <dd>Simply map each pixel to the to nearest color point
7120 given. The result are polygonal 'cells' of solid color. </dd>
7121 <dt>manhatten</dt>
7122 <dd>Like voronoi, but resulting polygonal 'cells' are mapped to a fixed coordinate system.</dd>
7123 <dt>shepards</dt>
7124 <dd>Colors points biased on the ratio of inverse distance
7125 squared. Generating spots of color in a sea of the average of
7126 colors. </dd>
7127 <dt>inverse</dt>
7128 <dd>Colors points biased on the ratio of inverse distance.
7129 This generates sharper points of color rather than rounded spots of
7130 '<code>shepards</code>' Generating spots of color in a sea of the
7131 average of colors. </dd>
7132</dl>
7133
7134<p>The points are placed according to the images location on the virtual
Cristy594d2772015-11-15 10:47:42 -05007135canvas (<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 -04007136offset), and do not actually have to exist on the given image, but may be
7137some point beyond the edge of the image. All points are floating point values.
7138</p>
7139
Cristy594d2772015-11-15 10:47:42 -05007140<p>Only the color channels defined by the <a href="command-line-options.html#channel" >-channel</a> are
Cristy882d9f42015-10-29 16:48:39 -04007141modified, which means that by default matte/alpha transparency channel is not
7142effected. Typically transparency channel is turned off either before or after
7143the operation. </p>
7144
7145<p>Of course if some color points are transparent to generate a transparent
7146gradient, then the image also requires transparency enabled to store the
7147values. </p>
7148
7149<p>All the above methods when given a single point of color will replace all
7150the colors in the image with the color given, regardless of the point. This is
7151logical, and provides an alternative technique to recolor an image to some
7152default value. </p>
7153
7154
7155<div style="margin: auto;">
7156 <h3 class="magick-header"><a id="splice"></a>-splice <var>geometry</var></h3>
7157</div>
7158
7159<p class="magick-description">Splice the current background color into the image.</p>
7160
Cristy594d2772015-11-15 10:47:42 -05007161<p>This will add rows and columns of the current <a
7162href="command-line-options.html#background">-background</a> color into the given image according to the
Cristy882d9f42015-10-29 16:48:39 -04007163given <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
7164image into four quadrants, separating them by the inserted rows and columns.
7165</p>
7166
7167<p>If a dimension of geometry is zero no rows or columns will be added for that
Cristy594d2772015-11-15 10:47:42 -05007168dimension. Similarly using a zero offset with the appropriate <a
7169href="command-line-options.html#gravity">-gravity</a> setting will add rows and columns to the edges of
7170the image, padding the image only along that one edge. Edge padding is what <a
7171href="command-line-options.html#splice">-splice</a> is most commonly used for. </p>
Cristy882d9f42015-10-29 16:48:39 -04007172
Cristy594d2772015-11-15 10:47:42 -05007173<p>If the exact same <var>geometry</var> and <a
7174href="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 -04007175added added all splices removed. </p>
7176
7177<div style="margin: auto;">
7178 <h3 class="magick-header"><a id="spread"></a>-spread <var>amount</var></h3>
7179</div>
7180
7181<p class="magick-description">displace image pixels by a random amount.</p>
7182
7183<p>The argument <var>amount</var> defines the size of the
7184neighborhood around each pixel from which to choose a candidate pixel to
7185blend.</p>
7186
7187<p>The lookup is controlled by the <a href="command-line-options.html#interpolate">-interpolate</a> setting.</p>
7188
7189<div style="margin: auto;">
7190 <h3 class="magick-header"><a id="statistic"></a>-statistic <var>type</var> <var>geometry</var></h3>
7191</div>
7192
7193<p class="magick-description">replace each pixel with corresponding statistic from the neighborhood.</p>
7194
7195<p>Choose from these statistic types:</p>
7196<dl class="dl-horizontal">
7197<dt>Gradient</dt><dd>maximum difference (max - min) value in neighborhood</dd>
7198<dt>Maximum</dt><dd>maximum value per channel in neighborhood</dd>
7199<dt>Minimum</dt><dd>minimum value per channel in neighborhood</dd>
7200<dt>Mean</dt><dd>average value per channel in neighborhood</dd>
7201<dt>Median</dt><dd>median value per channel in neighborhood</dd>
7202<dt>Mode</dt><dd>mode (most frequent) value per channel in neighborhood</dd>
7203<dt>Nonpeak</dt><dd>value just before or after the median value per channel in neighborhood</dd>
7204<dt>RMS</dt><dd>root mean square value per channel in neighborhood</dd>
7205<dt>StandardDeviation</dt><dd> standard deviation value per channel in neighborhood</dd>
7206</dl>
7207
7208<div style="margin: auto;">
7209 <h3 class="magick-header"><a id="stegano"></a>-stegano <var>offset</var></h3>
7210</div>
7211
7212<p class="magick-description">hide watermark within an image.</p>
7213
7214<p>Use an offset to start the image hiding some number of pixels from the
7215beginning of the image. Note this offset and the image size. You will need
7216this information to recover the steganographic image (e.g. display -size
7217320x256+35 stegano:image.png).</p>
7218
7219<div style="margin: auto;">
7220 <h3 class="magick-header"><a id="stereo"></a>-stereo <var>+x</var>{<var>+y</var>}</h3>
7221</div>
7222
7223<p class="magick-description">composite two images to create a red / cyan stereo anaglyph.</p>
7224
7225<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>
7226
7227<div style="margin: auto;">
7228 <h3 class="magick-header"><a id="storage-type"></a>-storage-type <var>type</var></h3>
7229</div>
7230
7231<p class="magick-description">pixel storage type. Here are the valid types:</p>
7232
7233<dl class="dl-horizontal">
7234<dt>char</dt><dd>unsigned characters</dd>
7235<dt>double</dt><dd>doubles</dd>
7236<dt>float</dt><dd>floats</dd>
7237<dt>integer</dt><dd>integers</dd>
7238<dt>long</dt><dd>longs</dd>
7239<dt>quantum</dt><dd>pixels in the native depth of your ImageMagick distribution</dd>
7240<dt>short</dt><dd>unsigned shorts</dd>
7241</dl>
7242
7243<p>Float and double types are normalized from 0.0 to 1.0 otherwise the pixels
7244values range from 0 to the maximum value the storage type can support.</p>
7245
7246<div style="margin: auto;">
7247 <h3 class="magick-header"><a id="stretch"></a>-stretch <var>fontStretch</var></h3>
7248</div>
7249
7250<p class="magick-description">Set a type of stretch style for fonts.</p>
7251
7252<p>This setting suggests a type of stretch that ImageMagick should try to
7253apply to the currently selected font family. Select <var>fontStretch</var> from the following.</p>
7254
7255<pre>
7256Any
7257Condensed
7258Expanded
7259ExtraCondensed
7260ExtraExpanded
7261Normal
7262SemiCondensed
7263SemiExpanded
7264UltraCondensed
7265UltraExpanded
7266</pre>
7267
7268<p>To print a complete list of stretch types, use <a href="command-line-options.html#list">-list
7269stretch</a>.</p>
7270
Cristy594d2772015-11-15 10:47:42 -05007271<p>For other settings that affect fonts, see the options <a
7272href="command-line-options.html#font">-font</a>, <a href="command-line-options.html#family">-family</a>, <a
7273href="command-line-options.html#style">-style</a>, and <a href="command-line-options.html#weight">-weight</a>. </p>
Cristy882d9f42015-10-29 16:48:39 -04007274
7275<div style="margin: auto;">
7276 <h3 class="magick-header"><a id="strip"></a>-strip</h3>
7277</div>
7278
Cristy776113a2016-04-29 12:01:19 -04007279<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 -04007280
7281<div style="margin: auto;">
7282 <h3 class="magick-header"><a id="stroke"></a>-stroke <var>color</var></h3>
7283</div>
7284
7285<p class="magick-description">color to use when stroking a graphic primitive.</p>
7286
7287<p>The color is specified using the format described under the <a href="command-line-options.html#fill">-fill</a> option.</p>
7288
7289<p>See <a href="command-line-options.html#draw">-draw</a> for further details.</p>
7290
7291<div style="margin: auto;">
7292 <h3 class="magick-header"><a id="strokewidth"></a>-strokewidth <var>value</var></h3>
7293</div>
7294
7295<p class="magick-description">set the stroke width.</p>
7296
7297<p>See <a href="command-line-options.html#draw">-draw</a> for further details.</p>
7298
7299<div style="margin: auto;">
7300 <h3 class="magick-header"><a id="style"></a>-style <var>fontStyle</var></h3>
7301</div>
7302
7303<p class="magick-description">Set a font style for text.</p>
7304
7305<p>This setting suggests a font style that ImageMagick should try to apply to
7306the currently selected font family. Select <var>fontStyle</var> from
7307the following.</p>
7308
7309<pre>
7310Any
7311Italic
7312Normal
7313Oblique
7314</pre>
7315
Cristy594d2772015-11-15 10:47:42 -05007316<p>For other settings that affect fonts, see the options <a
7317href="command-line-options.html#font">-font</a>, <a href="command-line-options.html#family">-family</a>, <a
7318href="command-line-options.html#stretch">-stretch</a>, and <a href="command-line-options.html#weight">-weight</a>. </p>
Cristy882d9f42015-10-29 16:48:39 -04007319
7320<div style="margin: auto;">
7321 <h3 class="magick-header"><a id="subimage-search"></a>-subimage-search</h3>
7322</div>
7323
7324<p class="magick-description">search for subimage.</p>
7325
7326<p>This option is required to have compare search for the best match location
7327of a small image within a larger image. This search will produce two images
7328(or two frames). The first is the "difference" image and the second will
7329be the "match score" image.</p>
7330
7331<p>The "match-score" image is smaller containing a pixel for ever possible
7332position of the top-left corner of the given sub-image. that is its size will
7333be the size of the larger_image - sub_image + 1. The brightest location in
7334this image is the location s the locate on the best match that is also
7335reported. Note that this may or may not be a perfect match, and the actual
7336brightness will reflect this. Other bright 'peaks' can be used to locate other
7337possible matching locations. </p>
7338
7339<p>Note that the search will try to compare the sub-image at every possible
7340location in the larger image, as such it can be very slow. The smaller the
7341sub-image the faster this search is. </p>
7342
7343
7344<div style="margin: auto;">
7345 <h3 class="magick-header"><a id="swap"></a>-swap <var>index,index</var></h3>
7346</div>
7347
7348<p class="magick-description">Swap the positions of two images in the image sequence.</p>
7349
7350<p>For example, <a href="command-line-options.html#swap">-swap 0,2</a> swaps the first and the third
7351images in the current image sequence. Use <a href="command-line-options.html#swap">+swap</a> to switch
7352the last two images in the sequence.</p>
7353
7354<div style="margin: auto;">
7355 <h3 class="magick-header"><a id="swirl"></a>-swirl <var>degrees</var></h3>
7356</div>
7357
7358<p class="magick-description">swirl image pixels about the center.</p>
7359
7360<p><var>Degrees</var> defines the tightness of the swirl.</p>
7361
7362<div style="margin: auto;">
7363 <h3 class="magick-header"><a id="synchronize"></a>-synchronize</h3>
7364</div>
7365
7366<p class="magick-description">synchronize image to storage device.</p>
7367
7368<p>Set to "true" to ensure all image data is fully flushed and synchronized
7369to disk. There is a performance penalty, but the benefits include ensuring a
7370valid image file in the event of a system crash and early reporting if there
7371is not enough disk space for the image pixel cache.</p>
7372
7373<div style="margin: auto;">
7374 <h3 class="magick-header"><a id="taint"></a>-taint</h3>
7375</div>
7376
7377<p class="magick-description">Mark the image as modified.</p>
7378
7379<div style="margin: auto;">
7380 <h3 class="magick-header"><a id="text-font"></a>-text-font <var>name</var></h3>
7381</div>
7382
7383<p class="magick-description">font for writing fixed-width text.</p>
7384
7385<p>Specifies the name of the preferred font to use in fixed (typewriter style)
7386formatted text. The default is 14 point <var>Courier</var>.</p>
7387
7388<p>You can tag a font to specify whether it is a PostScript, TrueType, or
7389OPTION1 font. For example, <code>Courier.ttf</code> is a TrueType font and
7390<code>x:fixed</code> is OPTION1.</p>
7391
7392<div style="margin: auto;">
7393 <h3 class="magick-header"><a id="texture"></a>-texture <var>filename</var></h3>
7394</div>
7395
7396<p class="magick-description">name of texture to tile onto the image background.</p>
7397
7398<div style="margin: auto;">
7399 <h3 class="magick-header"><a id="threshold"></a>-threshold <var>value</var>{<var>%</var>}</h3>
7400</div>
7401
7402<!-- {<var>green,blue,opacity</var>}
7403<p>If the green or blue value is omitted, these channels use the same value as
7404the first one provided. If all three color values are the same, the result is
7405a bi-level image. If the opacity threshold is omitted, OpaqueOpacity is used
7406and any partially transparent pixel becomes fully transparent.</p>
7407-->
7408
7409<p class="magick-description">Apply simultaneous black/white threshold to the image.</p>
7410
Cristy594d2772015-11-15 10:47:42 -05007411<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 -04007412maximum channel value, while all other values are assigned the minimum.</p>
7413
7414<p> The threshold value can be given as a percentage or as an absolute integer
7415value corresponding to the desired channel value. When given as an integer,
7416the minimum attainable value is 0 (corresponding to black when all channels
7417are affected), but the maximum value (corresponding to white) is that of the
7418<code>quantum depth</code> of the particular build of ImageMagick, and is
7419therefore dependent on the installation. For that reason, a reasonable
7420recommendation for most applications is to specify the threshold values as
7421a percentage. </p>
7422
7423<p> The following would force pixels with red values above 50% to have 100%
7424red values, while those at or below 50% red would be set to 0 in the red
7425channel. The green, blue, and alpha channels (if present) would be unchanged.
7426</p>
7427
7428<pre>
7429convert in.png -channel red -threshold 50% out.png
7430</pre>
7431
7432<p>As (possibly) impractical but instructive examples, the following would
7433generate an all-black and an all-white image with the same dimensions as the
7434input image.</p>
7435
7436
7437<pre>
7438convert in.png -threshold 100% black.png
7439convert in.png -threshold -1 white.png
7440</pre>
7441
7442<p>Note that the values of the transparency channel is treated as 'matte'
7443values (0 is opaque) and not as 'alpha' values (0 is transparent).</p>
7444
Cristy594d2772015-11-15 10:47:42 -05007445<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 -04007446</p>
7447
7448<div style="margin: auto;">
7449 <h3 class="magick-header"><a id="thumbnail"></a>-thumbnail <var>geometry</var></h3>
7450</div>
7451
7452<p class="magick-description">Create a thumbnail of the image.</p>
7453
7454<p>This is similar to <a href="command-line-options.html#resize">-resize</a>, except it is optimized
7455for speed and any image profile, other than a color profile, is removed to
Cristy594d2772015-11-15 10:47:42 -05007456reduce the thumbnail size. To strip the color profiles as well, add <a
7457href="command-line-options.html#strip">-strip</a> just before of after this option.</p>
Cristy882d9f42015-10-29 16:48:39 -04007458
7459<p>See <a href="command-line-processing.html#geometry">Image Geometry</a> for complete details about the <em class="arg">geometry</em> argument.</p>
7460
7461<div style="margin: auto;">
7462 <h3 class="magick-header"><a id="tile"></a>-tile <var>filename</var></h3>
7463</div>
7464
7465<p class="magick-description">Set the tile image used for filling a subsequent graphic primitive.</p>
7466
7467<div style="margin: auto;">
7468 <h3 class="magick-header">-tile <var>geometry</var></h3>
7469</div>
7470
7471<p class="magick-description">Specify the layout of images.</p>
7472
7473<p>See <a href="command-line-processing.html#geometry">Image Geometry</a> for complete details about the <em class="arg">geometry</em> argument.</p>
7474
7475<div style="margin: auto;">
7476 <h3 class="magick-header">-tile</h3>
7477</div>
7478
7479<p class="magick-description">Specifies that a subsequent composite operation is repeated across and down image.</p>
7480
7481<div style="margin: auto;">
7482 <h3 class="magick-header"><a id="tile-offset"></a>-tile-offset {<var>+-</var>}<var>x</var>{<var>+-</var>}<var>y</var></h3>
7483</div>
7484
7485<p class="magick-description">Specify the offset for tile images, relative to the background image it is tiled on.</p>
7486
Cristy594d2772015-11-15 10:47:42 -05007487<p>This should be set before the tiling image is set by <a href="command-line-options.html#tile"
7488>-tile</a> or <a href="command-line-options.html#texture" >-texture</a>, or directly applied for
Cristy882d9f42015-10-29 16:48:39 -04007489creating a tiled canvas using <code>TILE:</code> or <code>PATTERN:</code> input
7490formats. </p>
7491
Cristy594d2772015-11-15 10:47:42 -05007492<p>Internally ImageMagick does a <a href="command-line-options.html#roll" >-roll</a> of the tile image
Cristy882d9f42015-10-29 16:48:39 -04007493by the arguments given when the tile image is set. </p>
7494
7495<div style="margin: auto;">
7496 <h3 class="magick-header"><a id="tint"></a>-tint <var>value</var></h3>
7497</div>
7498
7499<p class="magick-description">Tint the image with the fill color.</p>
7500
7501<p>Tint the image with the fill color.</p>
7502
7503<p>Specify the amount of tinting as a percentage. Pure colors like black,
7504white red, yellow, will not be affected by -tint. Only mid-range colors such
7505as the various shades of grey.</p>
7506
7507<div style="margin: auto;">
7508 <h3 class="magick-header"><a id="title"></a>-title <var>string</var></h3>
7509</div>
7510
7511<p class="magick-description">Assign a title to displayed image.", "animate", "display", "montage</p>
7512
7513<p>Use this option to assign a specific title to the image. This assigned to
7514the image window and is typically displayed in the window title bar.
7515Optionally you can include the image filename, type, width, height, Exif data,
7516or other image attribute by embedding special format characters described
7517under the <a href="command-line-options.html#format">-format</a> option.</p>
7518
7519<p>For example,</p>
7520
7521<pre>
7522-title "%m:%f %wx%h"
7523</pre>
7524
7525<p>produces an image title of <code>MIFF:bird.miff 512x480</code> for an image
7526titled <code>bird.miff</code> and whose width is 512 and height is 480.</p>
7527
7528
7529<div style="margin: auto;">
7530 <h3 class="magick-header"><a id="transform"></a>-transform</h3>
7531</div>
7532
7533<p class="magick-description">transform the image.</p>
7534
7535<p>This option applies the transformation matrix from a previous <a href="command-line-options.html#affine">-affine</a> option.</p>
7536
7537<pre>
7538convert -affine 2,2,-2,2,0,0 -transform bird.ppm bird.jpg
7539</pre>
7540
7541
Cristy594d2772015-11-15 10:47:42 -05007542<p>This operator has been now been superseded by the <a
7543href="command-line-options.html#distort">-distort</a> '<code>AffineProjection</code>' method. </p>
Cristy882d9f42015-10-29 16:48:39 -04007544
7545
7546<div style="margin: auto;">
7547 <h3 class="magick-header"><a id="transparent"></a>-transparent <var>color</var></h3>
7548</div>
7549
7550<p class="magick-description">Make this color transparent within the image.</p>
7551
7552<p>The <var>color</var> argument is defined using the format
Cristy594d2772015-11-15 10:47:42 -05007553described under the <a href="command-line-options.html#fill">-fill</a> option. The <a href="command-line-options.html#fuzz"
7554>-fuzz</a> setting can be used to match and replace colors similar to the one
Cristy882d9f42015-10-29 16:48:39 -04007555given. </p>
7556
Cristy594d2772015-11-15 10:47:42 -05007557<p>Use <a href="command-line-options.html#transparent" >+transparent</a> to invert the pixels matched.
Cristy882d9f42015-10-29 16:48:39 -04007558that is make all non-matching colors transparent. </p>
7559
Cristy594d2772015-11-15 10:47:42 -05007560<p>The <a href="command-line-options.html#opaque">-opaque</a> operator is exactly the same as <a
7561href="command-line-options.html#transparent" >-transparent</a> but replaces the matching color with the
Cristy882d9f42015-10-29 16:48:39 -04007562current <a href="command-line-options.html#fill">-fill</a> color setting, rather than transparent.
Cristy594d2772015-11-15 10:47:42 -05007563However the <a href="command-line-options.html#transparent" >-transparent</a> operator also ensures
7564that the image has an alpha channel enabled, as per "<code><a href="command-line-options.html#alpha"
7565>-alpha</a> set</code>", and does not require you to modify the <a
7566href="command-line-options.html#channel">-channel</a> to enable alpha channel handling. </p>
Cristy882d9f42015-10-29 16:48:39 -04007567
7568<p>Note that this does not define the color as being the 'transparency color'
Cristy594d2772015-11-15 10:47:42 -05007569used for color-mapped image formats, such as GIF. For that use <a
7570href="command-line-options.html#transparent-color" >-transparent-color</a> </p>
Cristy882d9f42015-10-29 16:48:39 -04007571
7572
7573<div style="margin: auto;">
7574 <h3 class="magick-header"><a id="transparent-color"></a>-transparent-color <var>color</var></h3>
7575</div>
7576
7577<p class="magick-description">Set the transparent color.</p>
7578
7579<p>Sometimes this is used for saving to image formats such as
7580GIF and PNG8 which uses this color to represent boolean transparency. This
7581does not make a color transparent, it only defines what color the transparent
Cristy594d2772015-11-15 10:47:42 -05007582color is in the color palette of the saved image. Use <a
7583href="command-line-options.html#transparent">-transparent</a> to make an opaque color transparent.</p>
Cristy882d9f42015-10-29 16:48:39 -04007584
7585<p>This option allows you to have both an opaque visible color, as well as a
7586transparent color of the same color value without conflict. That is, you can
7587use the same color for both the transparent and opaque color areas within an
7588image. This, in turn, frees to you to select a transparent color that is
7589appropriate when an image is displayed by an application that does not handle a
7590transparent color index, while allowing ImageMagick to correctly handle images of this
7591type. </p>
7592
7593<p>The default transparent color is <code>#00000000</code>, which is fully transparent black.</p>
7594
7595<div style="margin: auto;">
7596 <h3 class="magick-header"><a id="transpose"></a>-transpose</h3>
7597</div>
7598
7599<p class="magick-description">Mirror the image along the top-left to bottom-right diagonal.</p>
7600
7601<p> This option mathematically transposes the pixel array. It is equivalent to the sequence <code>-flip -rotate 90</code>.
7602</p>
7603
7604<div style="margin: auto;">
7605 <h3 class="magick-header"><a id="transverse"></a>-transverse</h3>
7606</div>
7607
7608<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>
7609
7610
7611<div style="margin: auto;">
7612 <h3 class="magick-header"><a id="treedepth"></a>-treedepth <var>value</var></h3>
7613</div>
7614
7615<p class="magick-description">tree depth for the color reduction algorithm.</p>
7616
7617<p>Normally, this integer value is zero or one. A value of zero or one causes
7618the use of an optimal tree depth for the color reduction algorithm.</p>
7619
7620<p>An optimal depth generally allows the best representation of the source
7621image with the fastest computational speed and the least amount of memory.
7622However, the default depth is inappropriate for some images. To assure the
7623best representation, try values between 2 and 8 for this parameter. Refer to
Cristy594d2772015-11-15 10:47:42 -05007624the <a href="quantize.html"
7625>color reduction algorithm</a> for more details.</p>
Cristy882d9f42015-10-29 16:48:39 -04007626
7627<p>The <a href="command-line-options.html#colors">-colors</a> or <a href="command-line-options.html#monochrome">-monochrome</a>
7628option, or writing to an image format which requires color reduction, is
7629required for this option to take effect.</p>
7630
7631<div style="margin: auto;">
7632 <h3 class="magick-header"><a id="trim"></a>-trim</h3>
7633</div>
7634
7635<p class="magick-description">trim an image.</p>
7636
7637<p>This option removes any edges that are exactly the same color as the corner
7638pixels. Use <a href="command-line-options.html#fuzz">-fuzz</a> to make <a href="command-line-options.html#trim">-trim</a> remove
7639edges that are nearly the same color as the corner pixels.</p>
7640
7641<p>The page or virtual canvas information of the image is preserved allowing
7642you to extract the result of the <a href="command-line-options.html#trim">-trim</a> operation from the
7643image. Use a <a href="command-line-options.html#repage">+repage</a> to remove the virtual canvas page
7644information if it is unwanted.</p>
7645
7646<p>If the trimmed image 'disappears' an warning is produced, and a special
7647single pixel transparent 'missed' image is returned, in the same way as when a
7648<a href="command-line-options.html#crop">-crop</a> operation 'misses' the image proper. </p>
7649
7650
7651<div style="margin: auto;">
7652 <h3 class="magick-header"><a id="type"></a>-type <var>type</var></h3>
7653</div>
7654
7655<p class="magick-description">the image type.</p> <p>Choose from: <code>Bilevel</code>,
7656<code>Grayscale</code>, <code>GrayscaleMatte</code>, <code>Palette</code>,
7657<code>PaletteMatte</code>, <code>TrueColor</code>, <code>TrueColorMatte</code>,
7658<code>ColorSeparation</code>, or <code>ColorSeparationMatte</code>.</p>
7659
7660<p>Normally, when a format supports different subformats such as grayscale and
Cristy594d2772015-11-15 10:47:42 -05007661truecolor, the encoder will try to choose an efficient subformat. The <a
7662href="command-line-options.html#type">-type</a> option can be used to override this behavior. For
Cristy882d9f42015-10-29 16:48:39 -04007663example, to prevent a JPEG from being written in grayscale format even though
7664only gray pixels are present, use.</p>
7665
7666<pre>
7667convert bird.png -type TrueColor bird.jpg
7668</pre>
7669
7670<p>Similarly, use <a href="command-line-options.html#type">-type TrueColorMatte</a> to force the
7671encoder to write an alpha channel even though the image is opaque, if the
7672output format supports transparency.</p>
7673
7674<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>
7675
7676<div style="margin: auto;">
7677 <h3 class="magick-header"><a id="undercolor"></a>-undercolor <var>color</var></h3>
7678</div>
7679
7680<p class="magick-description">set the color of the annotation bounding box.</p>
7681
7682<p>The color is specified using the format described under the <a href="command-line-options.html#fill">-fill</a> option.</p>
7683
7684<p>See <a href="command-line-options.html#draw">-draw</a> for further details.</p>
7685
7686
7687<div style="margin: auto;">
7688 <h3 class="magick-header"><a id="update"></a>-update <var>seconds</var></h3>
7689</div>
7690
7691<p class="magick-description">detect when image file is modified and redisplay.</p>
7692
7693<p>Suppose that while you are displaying an image the file that is currently
7694displayed is over-written. <code>display</code> will automagically detect that
7695the input file has been changed and update the displayed image
7696accordingly.</p>
7697
7698
7699<div style="margin: auto;">
7700 <h3 class="magick-header"><a id="unique-colors"></a>-unique-colors</h3>
7701</div>
7702
7703<p class="magick-description">discard all but one of any pixel color.</p>
7704
7705
7706<div style="margin: auto;">
7707 <h3 class="magick-header"><a id="units"></a>-units <var>type</var></h3>
7708</div>
7709
7710<p class="magick-description">the units of image resolution.</p>
7711
7712<p>Choose from: <code>Undefined</code>, <code>PixelsPerInch</code>, or
7713<code>PixelsPerCentimeter</code>. This option is normally used in conjunction
7714with the <a href="command-line-options.html#density">-density</a> option.</p>
7715
7716
7717<div style="margin: auto;">
Cristy594d2772015-11-15 10:47:42 -05007718 <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 -04007719</div>
7720
7721<p class="magick-description">sharpen the image with an unsharp mask operator.</p>
7722
7723<p>The <a href="command-line-options.html#unsharp">-unsharp</a> option sharpens an image. The image is
7724convolved with a Gaussian operator of the given radius and standard deviation
7725(sigma). For reasonable results, radius should be larger than sigma. Use
7726a radius of 0 to have the method select a suitable radius.</p>
7727
7728<p>The parameters are:</p>
7729
7730<dl class="dl-horizontal">
7731<dt>radius</dt>
7732<dd>The radius of the Gaussian, in pixels, not counting the center pixel (default 0).</dd>
7733<dt>sigma</dt>
7734<dd>The standard deviation of the Gaussian, in pixels (default 1.0).</dd>
7735<dt>gain</dt>
7736<dd>The fraction of the difference between the original and the blur image that is added back into the original (default 1.0).</dd>
7737<dt>threshold</dt>
7738<dd>The threshold, as a fraction of <var>QuantumRange</var>, needed to apply the difference amount (default 0.05).</dd>
7739</dl>
7740
7741<div style="margin: auto;">
7742 <h3 class="magick-header"><a id="verbose"></a>-verbose</h3>
7743</div>
7744
7745<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>
7746
7747
7748<div style="margin: auto;">
7749 <h3 class="magick-header"><a id="version"></a>-version</h3>
7750</div>
7751
7752<p class="magick-description">print ImageMagick version string and exit.</p>
7753
7754
7755<div style="margin: auto;">
7756 <h3 class="magick-header"><a id="view"></a>-view <var>string</var></h3>
7757</div>
7758
7759<p class="magick-description">FlashPix viewing parameters.</p>
7760
7761
7762<div style="margin: auto;">
7763 <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>
7764</div>
7765
7766<p class="magick-description">soften the edges of the image in vignette style.</p>
7767
7768<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>
7769
7770<div style="margin: auto;">
7771 <h3 class="magick-header"><a id="virtual-pixel"></a>-virtual-pixel <var>method</var></h3>
7772</div>
7773
7774<p class="magick-description">Specify contents of <var>virtual pixels</var>.</p>
7775
7776<p>This option defines what color source should be used if and when a color
7777lookup completely 'misses' the source image. The color(s) that appear to
7778surround the source image. Generally this color is derived from the source
7779image, but could also be set to a specify background color. </p>
7780
7781<p>Choose from these methods:</p>
7782
7783<dl class="dl-horizontal">
7784<dt>background</dt><dd>the area surrounding the image is the background color</dd>
7785<dt>black</dt><dd>the area surrounding the image is black</dd>
7786<dt>checker-tile</dt><dd>alternate squares with image and background color</dd>
7787<dt>dither</dt><dd>non-random 32x32 dithered pattern</dd>
7788<dt>edge</dt><dd>extend the edge pixel toward infinity</dd>
7789<dt>gray</dt><dd>the area surrounding the image is gray</dd>
7790<dt>horizontal-tile</dt><dd>horizontally tile the image, background color above/below</dd>
7791<dt>horizontal-tile-edge</dt><dd>horizontally tile the image and replicate the side edge pixels</dd>
7792<dt>mirror</dt><dd>mirror tile the image</dd>
7793<dt>random</dt><dd>choose a random pixel from the image</dd>
7794<dt>tile</dt><dd>tile the image (default)</dd>
7795<dt>transparent</dt><dd>the area surrounding the image is transparent blackness</dd>
7796<dt>vertical-tile</dt><dd>vertically tile the image, sides are background color</dd>
7797<dt>vertical-tile-edge</dt><dd>vertically tile the image and replicate the side edge pixels</dd>
7798<dt>white</dt><dd>the area surrounding the image is white</dd>
7799</dl>
7800
7801<p>The default value is "edge".</p>
7802
Cristy594d2772015-11-15 10:47:42 -05007803<p>This most important for distortion operators such as <a href="command-line-options.html#distort"
7804>-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 -04007805However it also effects operations that may access pixels just outside the
Cristy594d2772015-11-15 10:47:42 -05007806image proper, such as <a href="command-line-options.html#convolve">-convolve</a>, <a
7807href="command-line-options.html#blur">-blur</a>, and <a href="command-line-options.html#sharpen">-sharpen</a>. </p>
Cristy882d9f42015-10-29 16:48:39 -04007808
Cristy594d2772015-11-15 10:47:42 -05007809<p>To print a complete list of virtual pixel types, use the <a
7810href="command-line-options.html#list">-list virtual-pixel</a> option.</p>
Cristy882d9f42015-10-29 16:48:39 -04007811
7812
7813<div style="margin: auto;">
7814 <h3 class="magick-header"><a id="visual"></a>-visual <var>type</var></h3>
7815</div>
7816
7817<p class="magick-description">Animate images using this X visual type.", 'animate', 'display'</p>
7818
7819<p>Choose from these visual classes:</p>
7820
7821<pre>
7822StaticGray TrueColor
7823GrayScale DirectColor
7824StaticColor default
7825PseudoColor visual id
7826</pre>
7827
7828<p>The X server must support the visual you choose, otherwise an error occurs.
7829If a visual is not specified, the visual class that can display the most
7830simultaneous colors on the default screen is chosen.</p>
7831
7832
7833<div style="margin: auto;">
7834 <h3 class="magick-header"><a id="watermark"></a>-watermark <var>brightness</var>x<var>saturation</var></h3>
7835</div>
7836
7837<p class="magick-description">Watermark an image using the given percentages of brightness and saturation.</p>
7838
7839<p>Take a grayscale image (with alpha mask) and modify the destination image's
7840brightness according to watermark image's grayscale value and the
7841<var>brightness</var> percentage. The destinations color saturation
7842attribute is just direct modified by the <var>saturation</var>
7843percentage, which defaults to 100 percent (no color change). </p>
7844
7845
7846<div style="margin: auto;">
Cristy594d2772015-11-15 10:47:42 -05007847 <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 -04007848</div>
7849
7850<p class="magick-description">Shear the columns of an image into a sine wave.</p>
7851
Cristye09ed312016-03-06 08:07:39 -05007852<div style="margin: auto;">
7853 <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>
7854</div>
7855
7856<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 -04007857
7858<div style="margin: auto;">
7859 <h3 class="magick-header"><a id="weight"></a>-weight <var>fontWeight</var></h3>
7860</div>
7861
7862<p class="magick-description">Set a font weight for text.</p>
7863
7864<p>This setting suggests a font weight that ImageMagick should try to apply to
7865the currently selected font family. Use a positive integer for
7866<var>fontWeight</var> or select from the following.</p>
7867
7868<dl class="dl-horizontal">
7869<dt>Thin </dt>
7870<dd>Same as <var>fontWeight</var> = 100.</dd>
7871<dt>ExtraLight </dt>
7872<dd>Same as <var>fontWeight</var> = 200.</dd>
7873<dt>Light </dt>
7874<dd>Same as <var>fontWeight</var> = 300.</dd>
7875<dt>Normal </dt>
7876<dd>Same as <var>fontWeight</var> = 400.</dd>
7877<dt>Medium </dt>
7878<dd>Same as <var>fontWeight</var> = 500.</dd>
7879<dt>DemiBold </dt>
7880<dd>Same as <var>fontWeight</var> = 600.</dd>
7881<dt>Bold </dt>
7882<dd>Same as <var>fontWeight</var> = 700.</dd>
7883<dt>ExtraBold </dt>
7884<dd>Same as <var>fontWeight</var> = 800.</dd>
7885<dt>Heavy </dt>
7886<dd>Same as <var>fontWeight</var> = 900.</dd>
7887</dl>
Cristy594d2772015-11-15 10:47:42 -05007888<br/>
Cristy882d9f42015-10-29 16:48:39 -04007889
7890<p>To print a complete list of weight types, use <a href="command-line-options.html#list">-list weight</a>.</p>
7891
Cristy594d2772015-11-15 10:47:42 -05007892<p>For other settings that affect fonts, see the options <a
7893href="command-line-options.html#font">-font</a>, <a href="command-line-options.html#family">-family</a>, <a
7894href="command-line-options.html#stretch">-stretch</a>, and <a href="command-line-options.html#style">-style</a>. </p>
Cristy882d9f42015-10-29 16:48:39 -04007895
7896<div style="margin: auto;">
7897 <h3 class="magick-header"><a id="white-point"></a>-white-point <var>x,y</var></h3>
7898</div>
7899
7900<p class="magick-description">chromaticity white point.</p>
7901
7902<div style="margin: auto;">
7903 <h3 class="magick-header"><a id="white-threshold"></a>-white-threshold <var>value</var>{<var>%</var>}</h3>
7904</div>
7905
7906<p class="magick-description">Force to white all pixels above the threshold while leaving all pixels at or below the threshold unchanged.</p>
7907
7908<p> The threshold value can be given as a percentage or as an absolute integer
7909value within [0, <var>QuantumRange</var>] corresponding to the
Cristy594d2772015-11-15 10:47:42 -05007910desired <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 -04007911
7912<div style="margin: auto;">
7913 <h3 class="magick-header"><a id="window"></a>-window <var>id</var></h3>
7914</div>
7915
7916<p class="magick-description">Make the image the background of a window.", 'animate', 'display'</p>
7917
7918<p><var>id</var> can be a window id or name. Specify <code>root</code>
7919to select X's root window as the target window.</p>
7920
7921<p>By default the image is tiled onto the background of the target window. If
7922<code>backdrop</code> or <a href="command-line-options.html#geometry">-resize</a> are specified, the
7923image is surrounded by the background color. Refer to <code>X RESOURCES</code>
7924for details.</p>
7925
7926<p>The image will not display on the root window if the image has more unique
Cristy594d2772015-11-15 10:47:42 -05007927colors than the target window colormap allows. Use <a
7928href="command-line-options.html#colors">-colors</a> to reduce the number of colors.</p>
Cristy882d9f42015-10-29 16:48:39 -04007929
7930<div style="margin: auto;">
7931 <h3 class="magick-header"><a id="window-group"></a>-window-group</h3>
7932</div>
7933
7934<p class="magick-description">specify the window group.</p>
7935
7936<div style="margin: auto;">
7937 <h3 class="magick-header"><a id="write"></a>-write <var>filename</var></h3>
7938</div>
7939
7940<p class="magick-description">write an image sequence.</p>
7941
7942<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>
7943
7944<p>Use <a href="command-line-options.html#compress">-compress</a> to specify the type of image compression.</p>
7945</div>
7946</div>
7947
7948
Cristye93be682015-11-26 09:07:51 -05007949
Cristy882d9f42015-10-29 16:48:39 -04007950 <footer class="magick-footer">
cristy29f2c972015-07-28 13:37:46 +00007951 <p><a href="support.html">Donate</a>
7952 <a href="sitemap.html">Sitemap</a>
cristyd2432012015-05-04 23:15:15 +00007953 <a href="links.html">Related</a>
cristy29f2c972015-07-28 13:37:46 +00007954 <a href="architecture.html">Architecture</a>
cristyd2432012015-05-04 23:15:15 +00007955</p>
7956 <p><a href="command-line-options.html#">Back to top</a>
cristyea2793e2015-05-31 16:52:26 +00007957 <a href="http://pgp.mit.edu:11371/pks/lookup?op=get&amp;search=0x89AB63D48277377A">Public Key</a>
Cristy1f1f3a02016-06-01 07:25:42 -04007958 <a href="http://www.imagemagick.org/script/contact.php">Contact Us</a></p>
Cristyde27d762016-01-02 12:56:44 -05007959 <p><small>© 1999-2016 ImageMagick Studio LLC</small></p>
cristyd2432012015-05-04 23:15:15 +00007960 </footer>
7961</div><!-- /.container -->
7962
Cristy542697a2015-10-12 20:10:32 -04007963 <script src="https://localhost/ajax/libs/jquery/1.11.3/jquery.min.js"></script>
Cristy1f1f3a02016-06-01 07:25:42 -04007964 <script src="../js/magick.html"></script>
cristyd2432012015-05-04 23:15:15 +00007965</div>
cristyad41c0c2012-10-31 00:49:28 +00007966</body>
cristy5a367e42015-05-05 12:39:18 +00007967</html>
Cristy1f1f3a02016-06-01 07:25:42 -04007968<!-- Magick Cache 30th May 2016 12:34 -->