blob: c51ff66b06fedb5b170c2c194236c8b29720086a [file] [log] [blame]
Cristy594d2772015-11-15 10:47:42 -05001
2
3
4
cristy29dc8652015-05-12 16:26:21 +00005<!DOCTYPE html>
cristyd2432012015-05-04 23:15:15 +00006<html lang="en">
cristyad41c0c2012-10-31 00:49:28 +00007<head>
Cristy912a9222016-06-17 15:37:28 -04008 <meta charset="utf-8" />
Cristy3b0b58d2016-11-06 07:40:23 -05009 <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no" />
10 <meta http-equiv="x-ua-compatible" content="ie=edge" />
Cristy6549abb2016-11-10 08:25:55 -050011 <title>Command-line Options @ ImageMagick</title>
Cristy594d2772015-11-15 10:47:42 -050012 <meta http-equiv="content-type" content="text/html; charset=utf-8"/>
13 <meta name="application-name" content="ImageMagick"/>
14 <meta name="description" content="ImageMagick® is a software suite to create, edit, compose, or convert bitmap images. It can read and write images in a variety of formats (over 200) including PNG, JPEG, JPEG-2000, GIF, WebP, Postscript, PDF, and SVG. Use ImageMagick to resize, flip, mirror, rotate, distort, shear and transform images, adjust image colors, apply various special effects, or draw text, lines, polygons, ellipses and Bézier curves."/>
Cristy364a72f2016-11-04 22:38:41 -040015 <meta name="application-url" content="https://www.imagemagick.org"/>
Cristy594d2772015-11-15 10:47:42 -050016 <meta name="generator" content="PHP"/>
17 <meta name="keywords" content="command-line, options, ImageMagick, PerlMagick, image processing, image, photo, software, Magick++, OpenMP, convert"/>
18 <meta name="rating" content="GENERAL"/>
19 <meta name="robots" content="INDEX, FOLLOW"/>
20 <meta name="generator" content="ImageMagick Studio LLC"/>
21 <meta name="author" content="ImageMagick Studio LLC"/>
22 <meta name="revisit-after" content="2 DAYS"/>
23 <meta name="resource-type" content="document"/>
Cristyfe36f992016-12-29 20:24:13 -050024 <meta name="copyright" content="Copyright (c) 1999-2017 ImageMagick Studio LLC"/>
Cristy594d2772015-11-15 10:47:42 -050025 <meta name="distribution" content="Global"/>
26 <meta name="magick-serial" content="P131-S030410-R485315270133-P82224-A6668-G1245-1"/>
Cristy912a9222016-06-17 15:37:28 -040027 <meta name="google-site-verification" content="_bMOCDpkx9ZAzBwb2kF3PRHbfUUdFj2uO8Jd1AXArz4" />
Cristyfe36f992016-12-29 20:24:13 -050028 <link rel="canonical" href="https://www.imagemagick.org/script/command-line-options.html"/>
Cristy594d2772015-11-15 10:47:42 -050029 <link rel="icon" href="../images/wand.png"/>
30 <link rel="shortcut icon" href="../images/wand.ico"/>
Cristybc232422016-11-22 07:46:18 -050031 <link rel="stylesheet" type="text/css" href="http://fonts.googleapis.com/css?family=Roboto:900,400,400italic,700,700italic,300,300italic|Open+Sans:300italic,400italic,700italic,300,400,600,700" />
Cristyce4a3552015-12-14 13:53:35 -050032 <link rel="stylesheet" href="css/magick.css"/>
cristyad41c0c2012-10-31 00:49:28 +000033</head>
cristyd2432012015-05-04 23:15:15 +000034<body>
cristyad41c0c2012-10-31 00:49:28 +000035<div class="main">
cristyd2432012015-05-04 23:15:15 +000036<div class="magick-masthead">
37 <div class="container">
Cristy6549abb2016-11-10 08:25:55 -050038 <script async="async" src="http://localhost/pagead/js/adsbygoogle.js"></script> <ins class="adsbygoogle"
Cristy594d2772015-11-15 10:47:42 -050039 style="display:block"
40 data-ad-client="ca-pub-3129977114552745"
41 data-ad-slot="6345125851"
42 data-ad-format="auto"></ins>
cristy29f2c972015-07-28 13:37:46 +000043 <script>
Cristy542697a2015-10-12 20:10:32 -040044 (adsbygoogle = window.adsbygoogle || []).push({});
cristyd2432012015-05-04 23:15:15 +000045 </script>
cristyd2432012015-05-04 23:15:15 +000046 <nav class="magick-nav">
cristy44443b92015-05-05 00:06:07 +000047 <a class="magick-nav-item " href="../index.html">Home</a>
Cristy9017f3a2017-01-21 10:51:11 -050048 <a class="magick-nav-item " href="download.html">Download</a>
cristyd2432012015-05-04 23:15:15 +000049 <a class="magick-nav-item " href="command-line-tools.html">Tools</a>
Cristye93be682015-11-26 09:07:51 -050050 <a class="magick-nav-item " href="command-line-processing.html">Command-line</a>
cristyea2793e2015-05-31 16:52:26 +000051 <a class="magick-nav-item " href="resources.html">Resources</a>
Cristy9017f3a2017-01-21 10:51:11 -050052 <a class="magick-nav-item " href="develop.html">Develop</a>
Cristy6549abb2016-11-10 08:25:55 -050053 <a class="magick-nav-item " href="https://www.imagemagick.org/script/search.php">Search</a>
54 <a class="magick-nav-item pull-right" href="https://www.imagemagick.org/discourse-server/">Community</a>
cristyd2432012015-05-04 23:15:15 +000055 </nav>
56 </div>
57</div>
58<div class="container">
Cristy882d9f42015-10-29 16:48:39 -040059<div class="magick-header">
Cristyb7f455a2017-03-03 19:30:34 -050060<p class="text-center"><a href="command-line-options.html#adaptive-blur">&#x2011;adaptive&#x2011;blur</a><a href="command-line-options.html#adaptive-resize">&#x2011;adaptive&#x2011;resize</a><a href="command-line-options.html#adaptive-sharpen">&#x2011;adaptive&#x2011;sharpen</a><a href="command-line-options.html#adjoin">&#x2011;adjoin</a><a href="command-line-options.html#affine">&#x2011;affine</a><a href="command-line-options.html#alpha">&#x2011;alpha</a><a href="command-line-options.html#annotate">&#x2011;annotate</a><a href="command-line-options.html#antialias">&#x2011;antialias</a><a href="command-line-options.html#append">&#x2011;append</a><a href="command-line-options.html#attenuate">&#x2011;attenuate</a><a href="command-line-options.html#authenticate">&#x2011;authenticate</a><a href="command-line-options.html#auto-gamma">&#x2011;auto&#x2011;gamma</a><a href="command-line-options.html#auto-level">&#x2011;auto&#x2011;level</a><a href="command-line-options.html#auto-orient">&#x2011;auto&#x2011;orient</a><a href="command-line-options.html#backdrop">&#x2011;backdrop</a><a href="command-line-options.html#background">&#x2011;background</a><a href="command-line-options.html#bench">&#x2011;bench</a><a href="command-line-options.html#bias">&#x2011;bias</a><a href="command-line-options.html#black-point-compensation">&#x2011;black&#x2011;point&#x2011;compensation</a><a href="command-line-options.html#black-threshold">&#x2011;black&#x2011;threshold</a><a href="command-line-options.html#blend">&#x2011;blend</a><a href="command-line-options.html#blue-primary">&#x2011;blue&#x2011;primary</a><a href="command-line-options.html#blue-shift">&#x2011;blue&#x2011;shift</a><a href="command-line-options.html#blur">&#x2011;blur</a><a href="command-line-options.html#border">&#x2011;border</a><a href="command-line-options.html#bordercolor">&#x2011;bordercolor</a><a href="command-line-options.html#borderwidth">&#x2011;borderwidth</a><a href="command-line-options.html#brightness-contrast">&#x2011;brightness&#x2011;contrast</a><a href="command-line-options.html#cache">&#x2011;cache</a><a href="command-line-options.html#canny">&#x2011;canny</a><a href="command-line-options.html#caption">&#x2011;caption</a><a href="command-line-options.html#cdl">&#x2011;cdl</a><a href="command-line-options.html#channel">&#x2011;channel</a><a href="command-line-options.html#charcoal">&#x2011;charcoal</a><a href="command-line-options.html#channel-fx">&#x2011;channel&#x2011;fx</a><a href="command-line-options.html#chop">&#x2011;chop</a><a href="command-line-options.html#clamp">&#x2011;clamp</a><a href="command-line-options.html#clip">&#x2011;clip</a><a href="command-line-options.html#clip-mask">&#x2011;clip&#x2011;mask</a><a href="command-line-options.html#clip-path">&#x2011;clip&#x2011;path</a><a href="command-line-options.html#clone">&#x2011;clone</a><a href="command-line-options.html#clut">&#x2011;clut</a><a href="command-line-options.html#coalesce">&#x2011;coalesce</a><a href="command-line-options.html#colorize">&#x2011;colorize</a><a href="command-line-options.html#colormap">&#x2011;colormap</a><a href="command-line-options.html#color-matrix">&#x2011;color&#x2011;matrix</a><a href="command-line-options.html#colors">&#x2011;colors</a><a href="command-line-options.html#colorspace">&#x2011;colorspace</a><a href="command-line-options.html#combine">&#x2011;combine</a><a href="command-line-options.html#comment">&#x2011;comment</a><a href="command-line-options.html#compare">&#x2011;compare</a><a href="command-line-options.html#complex">&#x2011;complex</a><a href="command-line-options.html#compose">&#x2011;compose</a><a href="command-line-options.html#composite">&#x2011;composite</a><a href="command-line-options.html#compress">&#x2011;compress</a><a href="command-line-options.html#connected-components">&#x2011;connected&#x2011;components</a><a href="command-line-options.html#contrast">&#x2011;contrast</a><a href="command-line-options.html#contrast-stretch">&#x2011;contrast&#x2011;stretch</a><a href="command-line-options.html#convolve">&#x2011;convolve</a><a href="command-line-options.html#copy">&#x2011;copy</a><a href="command-line-options.html#crop">&#x2011;crop</a><a href="command-line-options.html#cycle">&#x2011;cycle</a><a href="command-line-options.html#debug">&#x2011;debug</a><a href="command-line-options.html#decipher">&#x2011;decipher</a><a href="command-line-options.html#deconstruct">&#x2011;deconstruct</a><a href="command-line-options.html#define">&#x2011;define</a><a href="command-line-options.html#delay">&#x2011;delay</a><a href="command-line-options.html#delete">&#x2011;delete</a><a href="command-line-options.html#density">&#x2011;density</a><a href="command-line-options.html#depth">&#x2011;depth</a><a href="command-line-options.html#descend">&#x2011;descend</a><a href="command-line-options.html#deskew">&#x2011;deskew</a><a href="command-line-options.html#despeckle">&#x2011;despeckle</a><a href="command-line-options.html#direction">&#x2011;direction</a><a href="command-line-options.html#displace">&#x2011;displace</a><a href="command-line-options.html#display">&#x2011;display</a><a href="command-line-options.html#dispose">&#x2011;dispose</a><a href="command-line-options.html#dissimilarity-threshold">&#x2011;dissimilarity&#x2011;threshold</a><a href="command-line-options.html#dissolve">&#x2011;dissolve</a><a href="command-line-options.html#distort">&#x2011;distort</a><a href="command-line-options.html#distribute-cache">&#x2011;distribute&#x2011;cache</a><a href="command-line-options.html#dither">&#x2011;dither</a><a href="command-line-options.html#draw">&#x2011;draw</a><a href="command-line-options.html#duplicate">&#x2011;duplicate</a><a href="command-line-options.html#edge">&#x2011;edge</a><a href="command-line-options.html#emboss">&#x2011;emboss</a><a href="command-line-options.html#encipher">&#x2011;encipher</a><a href="command-line-options.html#encoding">&#x2011;encoding</a><a href="command-line-options.html#endian">&#x2011;endian</a><a href="command-line-options.html#enhance">&#x2011;enhance</a><a href="command-line-options.html#equalize">&#x2011;equalize</a><a href="command-line-options.html#evaluate">&#x2011;evaluate</a><a href="command-line-options.html#evaluate-sequence">&#x2011;evaluate&#x2011;sequence</a><a href="command-line-options.html#extent">&#x2011;extent</a><a href="command-line-options.html#extract">&#x2011;extract</a><a href="command-line-options.html#family">&#x2011;family</a><a href="command-line-options.html#features">&#x2011;features</a><a href="command-line-options.html#fft">&#x2011;fft</a><a href="command-line-options.html#fill">&#x2011;fill</a><a href="command-line-options.html#filter">&#x2011;filter</a><a href="command-line-options.html#flatten">&#x2011;flatten</a><a href="command-line-options.html#flip">&#x2011;flip</a><a href="command-line-options.html#floodfill">&#x2011;floodfill</a><a href="command-line-options.html#flop">&#x2011;flop</a><a href="command-line-options.html#font">&#x2011;font</a><a href="command-line-options.html#foreground">&#x2011;foreground</a><a href="command-line-options.html#format">&#x2011;format</a><a href="command-line-options.html#format_identify_">&#x2011;format[identify]</a><a href="command-line-options.html#frame">&#x2011;frame</a><a href="command-line-options.html#frame_import_">&#x2011;frame[import]</a><a href="command-line-options.html#function">&#x2011;function</a><a href="command-line-options.html#fuzz">&#x2011;fuzz</a><a href="command-line-options.html#fx">&#x2011;fx</a><a href="command-line-options.html#gamma">&#x2011;gamma</a><a href="command-line-options.html#gaussian-blur">&#x2011;gaussian&#x2011;blur</a><a href="command-line-options.html#geometry">&#x2011;geometry</a><a href="command-line-options.html#gravity">&#x2011;gravity</a><a href="command-line-options.html#grayscale">&#x2011;grayscale</a><a href="command-line-options.html#green-primary">&#x2011;green&#x2011;primary</a><a href="command-line-options.html#hald-clut">&#x2011;hald&#x2011;clut</a><a href="command-line-options.html#help">&#x2011;help</a><a href="command-line-options.html#highlight-color">&#x2011;highlight&#x2011;color</a><a href="command-line-options.html#hough-lines">&#x2011;hough&#x2011;lines</a><a href="command-line-options.html#iconGeometry">&#x2011;iconGeometry</a><a href="command-line-options.html#iconic">&#x2011;iconic</a><a href="command-line-options.html#identify">&#x2011;identify</a><a href="command-line-options.html#ift">&#x2011;ift</a><a href="command-line-options.html#immutable">&#x2011;immutable</a><a href="command-line-options.html#implode">&#x2011;implode</a><a href="command-line-options.html#insert">&#x2011;insert</a><a href="command-line-options.html#intensity">&#x2011;intensity</a><a href="command-line-options.html#intent">&#x2011;intent</a><a href="command-line-options.html#interlace">&#x2011;interlace</a><a href="command-line-options.html#interpolate">&#x2011;interpolate</a><a href="command-line-options.html#interline-spacing">&#x2011;interline&#x2011;spacing</a><a href="command-line-options.html#interword-spacing">&#x2011;interword&#x2011;spacing</a><a href="command-line-options.html#kerning">&#x2011;kerning</a><a href="command-line-options.html#kuwahara">&#x2011;kuwahara</a><a href="command-line-options.html#label">&#x2011;label</a><a href="command-line-options.html#lat">&#x2011;lat</a><a href="command-line-options.html#layers">&#x2011;layers</a><a href="command-line-options.html#level">&#x2011;level</a><a href="command-line-options.html#level-colors">&#x2011;level&#x2011;colors</a><a href="command-line-options.html#limit">&#x2011;limit</a><a href="command-line-options.html#linear-stretch">&#x2011;linear&#x2011;stretch</a><a href="command-line-options.html#linewidth">&#x2011;linewidth</a><a href="command-line-options.html#liquid-rescale">&#x2011;liquid&#x2011;rescale</a><a href="command-line-options.html#list">&#x2011;list</a><a href="command-line-options.html#log">&#x2011;log</a><a href="command-line-options.html#loop">&#x2011;loop</a><a href="command-line-options.html#lowlight-color">&#x2011;lowlight&#x2011;color</a><a href="command-line-options.html#magnify">&#x2011;magnify</a><a href="command-line-options.html#map">&#x2011;map</a><a href="command-line-options.html#map_stream_">&#x2011;map[stream]</a><a href="command-line-options.html#mattecolor">&#x2011;mattecolor</a><a href="command-line-options.html#median">&#x2011;median</a><a href="command-line-options.html#mean-shift">&#x2011;mean&#x2011;shift</a><a href="command-line-options.html#metric">&#x2011;metric</a><a href="command-line-options.html#mode">&#x2011;mode</a><a href="command-line-options.html#modulate">&#x2011;modulate</a><a href="command-line-options.html#moments">&#x2011;moments</a><a href="command-line-options.html#monitor">&#x2011;monitor</a><a href="command-line-options.html#monochrome">&#x2011;monochrome</a><a href="command-line-options.html#morph">&#x2011;morph</a><a href="command-line-options.html#morphology">&#x2011;morphology</a><a href="command-line-options.html#mosaic">&#x2011;mosaic</a><a href="command-line-options.html#motion-blur">&#x2011;motion&#x2011;blur</a><a href="command-line-options.html#name">&#x2011;name</a><a href="command-line-options.html#negate">&#x2011;negate</a><a href="command-line-options.html#noise">&#x2011;noise</a><a href="command-line-options.html#normalize">&#x2011;normalize</a><a href="command-line-options.html#opaque">&#x2011;opaque</a><a href="command-line-options.html#ordered-dither">&#x2011;ordered&#x2011;dither</a><a href="command-line-options.html#orient">&#x2011;orient</a><a href="command-line-options.html#page">&#x2011;page</a><a href="command-line-options.html#paint">&#x2011;paint</a><a href="command-line-options.html#path">&#x2011;path</a><a href="command-line-options.html#pause_animate_">&#x2011;pause[animate]</a><a href="command-line-options.html#pause_import_">&#x2011;pause[import]</a><a href="command-line-options.html#perceptible">&#x2011;perceptible</a><a href="command-line-options.html#ping">&#x2011;ping</a><a href="command-line-options.html#pointsize">&#x2011;pointsize</a><a href="command-line-options.html#polaroid">&#x2011;polaroid</a><a href="command-line-options.html#poly">&#x2011;poly</a><a href="command-line-options.html#posterize">&#x2011;posterize</a><a href="command-line-options.html#precision">&#x2011;precision</a><a href="command-line-options.html#preview">&#x2011;preview</a><a href="command-line-options.html#print">&#x2011;print</a><a href="command-line-options.html#process">&#x2011;process</a><a href="command-line-options.html#profile">&#x2011;profile</a><a href="command-line-options.html#quality">&#x2011;quality</a><a href="command-line-options.html#quantize">&#x2011;quantize</a><a href="command-line-options.html#quiet">&#x2011;quiet</a><a href="command-line-options.html#radial-blur">&#x2011;radial&#x2011;blur</a><a href="command-line-options.html#raise">&#x2011;raise</a><a href="command-line-options.html#random-threshold">&#x2011;random&#x2011;threshold</a><a href="command-line-options.html#read-mask">&#x2011;read&#x2011;mask</a><a href="command-line-options.html#red-primary">&#x2011;red&#x2011;primary</a><a href="command-line-options.html#regard-warnings">&#x2011;regard&#x2011;warnings</a><a href="command-line-options.html#region">&#x2011;region</a><a href="command-line-options.html#remap">&#x2011;remap</a><a href="command-line-options.html#remote">&#x2011;remote</a><a href="command-line-options.html#render">&#x2011;render</a><a href="command-line-options.html#repage">&#x2011;repage</a><a href="command-line-options.html#resample">&#x2011;resample</a><a href="command-line-options.html#resize">&#x2011;resize</a><a href="command-line-options.html#respect-parentheses">&#x2011;respect&#x2011;parentheses</a><a href="command-line-options.html#reverse">&#x2011;reverse</a><a href="command-line-options.html#roll">&#x2011;roll</a><a href="command-line-options.html#rotate">&#x2011;rotate</a><a href="command-line-options.html#sample">&#x2011;sample</a><a href="command-line-options.html#sampling-factor">&#x2011;sampling&#x2011;factor</a><a href="command-line-options.html#scale">&#x2011;scale</a><a href="command-line-options.html#scene">&#x2011;scene</a><a href="command-line-options.html#screen">&#x2011;screen</a><a href="command-line-options.html#seed">&#x2011;seed</a><a href="command-line-options.html#segment">&#x2011;segment</a><a href="command-line-options.html#selective-blur">&#x2011;selective&#x2011;blur</a><a href="command-line-options.html#separate">&#x2011;separate</a><a href="command-line-options.html#sepia-tone">&#x2011;sepia&#x2011;tone</a><a href="command-line-options.html#set">&#x2011;set</a><a href="command-line-options.html#shade">&#x2011;shade</a><a href="command-line-options.html#shadow">&#x2011;shadow</a><a href="command-line-options.html#shared-memory">&#x2011;shared&#x2011;memory</a><a href="command-line-options.html#sharpen">&#x2011;sharpen</a><a href="command-line-options.html#shave">&#x2011;shave</a><a href="command-line-options.html#shear">&#x2011;shear</a><a href="command-line-options.html#sigmoidal-contrast">&#x2011;sigmoidal&#x2011;contrast</a><a href="command-line-options.html#silent">&#x2011;silent</a><a href="command-line-options.html#similarity-threshold">&#x2011;similarity&#x2011;threshold</a><a href="command-line-options.html#size">&#x2011;size</a><a href="command-line-options.html#sketch">&#x2011;sketch</a><a href="command-line-options.html#smush">&#x2011;smush</a><a href="command-line-options.html#snaps">&#x2011;snaps</a><a href="command-line-options.html#solarize">&#x2011;solarize</a><a href="command-line-options.html#sparse-color">&#x2011;sparse&#x2011;color</a><a href="command-line-options.html#splice">&#x2011;splice</a><a href="command-line-options.html#spread">&#x2011;spread</a><a href="command-line-options.html#statistic">&#x2011;statistic</a><a href="command-line-options.html#stegano">&#x2011;stegano</a><a href="command-line-options.html#stereo">&#x2011;stereo</a><a href="command-line-options.html#storage-type">&#x2011;storage&#x2011;type</a><a href="command-line-options.html#stretch">&#x2011;stretch</a><a href="command-line-options.html#strip">&#x2011;strip</a><a href="command-line-options.html#stroke">&#x2011;stroke</a><a href="command-line-options.html#strokewidth">&#x2011;strokewidth</a><a href="command-line-options.html#style">&#x2011;style</a><a href="command-line-options.html#subimage-search">&#x2011;subimage&#x2011;search</a><a href="command-line-options.html#swap">&#x2011;swap</a><a href="command-line-options.html#swirl">&#x2011;swirl</a><a href="command-line-options.html#synchronize">&#x2011;synchronize</a><a href="command-line-options.html#taint">&#x2011;taint</a><a href="command-line-options.html#text-font">&#x2011;text&#x2011;font</a><a href="command-line-options.html#texture">&#x2011;texture</a><a href="command-line-options.html#threshold">&#x2011;threshold</a><a href="command-line-options.html#thumbnail">&#x2011;thumbnail</a><a href="command-line-options.html#tile">&#x2011;tile</a><a href="command-line-options.html#tile-offset">&#x2011;tile&#x2011;offset</a><a href="command-line-options.html#tint">&#x2011;tint</a><a href="command-line-options.html#title">&#x2011;title</a><a href="command-line-options.html#transform">&#x2011;transform</a><a href="command-line-options.html#transparent">&#x2011;transparent</a><a href="command-line-options.html#transparent-color">&#x2011;transparent&#x2011;color</a><a href="command-line-options.html#transpose">&#x2011;transpose</a><a href="command-line-options.html#transverse">&#x2011;transverse</a><a href="command-line-options.html#treedepth">&#x2011;treedepth</a><a href="command-line-options.html#trim">&#x2011;trim</a><a href="command-line-options.html#type">&#x2011;type</a><a href="command-line-options.html#undercolor">&#x2011;undercolor</a><a href="command-line-options.html#unique-colors">&#x2011;unique&#x2011;colors</a><a href="command-line-options.html#units">&#x2011;units</a><a href="command-line-options.html#unsharp">&#x2011;unsharp</a><a href="command-line-options.html#update">&#x2011;update</a><a href="command-line-options.html#verbose">&#x2011;verbose</a><a href="command-line-options.html#version">&#x2011;version</a><a href="command-line-options.html#view">&#x2011;view</a><a href="command-line-options.html#vignette">&#x2011;vignette</a><a href="command-line-options.html#virtual-pixel">&#x2011;virtual&#x2011;pixel</a><a href="command-line-options.html#visual">&#x2011;visual</a><a href="command-line-options.html#watermark">&#x2011;watermark</a><a href="command-line-options.html#wave">&#x2011;wave</a><a href="command-line-options.html#wavelet-denoise">&#x2011;wavelet&#x2011;denoise</a><a href="command-line-options.html#weight">&#x2011;weight</a><a href="command-line-options.html#white-point">&#x2011;white&#x2011;point</a><a href="command-line-options.html#white-threshold">&#x2011;white&#x2011;threshold</a><a href="command-line-options.html#window">&#x2011;window</a><a href="command-line-options.html#window-group">&#x2011;window&#x2011;group</a><a href="command-line-options.html#write">&#x2011;write</a><a href="command-line-options.html#write-mask">&#x2011;write&#x2011;mask</a> </p>
Cristy882d9f42015-10-29 16:48:39 -040061<p class="lead magick-description">Below is list of command-line options recognized by the ImageMagick <a href="command-line-tools.html">command-line tools</a>. If you want a description of a particular option, click on the option name in the navigation bar above and you will go right to it. Unless otherwise noted, each option is recognized by the commands: <a href="convert.html">convert</a> and <a href="mogrify.html">mogrify</a>.</p>
62
63<div style="margin: auto;">
64 <h3 class="magick-header"><a id="adaptive-blur"></a>-adaptive-blur <var>radius</var>[x<var>sigma</var>]</h3>
65</div>
66
67<p class="magick-description">Adaptively blur pixels, with decreasing effect near edges.</p>
68
69<p>A Gaussian operator of the given radius and standard deviation (<var>sigma</var>) is used. If <var>sigma</var> is not given it
70defaults to 1.</p>
71
72<div style="margin: auto;">
73 <h3 class="magick-header"><a id="adaptive-resize"></a>-adaptive-resize <var>geometry</var></h3>
74</div>
75
76<p class="magick-description">Resize the image using data-dependent triangulation.</p>
77
78<p>See <a href="command-line-processing.html#geometry">Image Geometry</a> for complete details about the <em class="arg">geometry</em> argument. The <a href="command-line-options.html#adaptive-resize">-adaptive-resize</a>
Cristy594d2772015-11-15 10:47:42 -050079option defaults to data-dependent triangulation. Use the <a
80href="command-line-options.html#filter">-filter</a> to choose a different resampling algorithm.
81Offsets, if present in the geometry string, are ignored, and the <a
82href="command-line-options.html#gravity">-gravity</a> option has no effect.</p>
Cristy882d9f42015-10-29 16:48:39 -040083
84<div style="margin: auto;">
85 <h3 class="magick-header"><a id="adaptive-sharpen"></a>-adaptive-sharpen <var>radius</var>[x<var>sigma</var>]</h3>
86</div>
87
88<p class="magick-description">Adaptively sharpen pixels, with increasing effect near edges.</p>
89
90<p>A Gaussian operator of the given radius and standard deviation
91(<var>sigma</var>) is used. If <var>sigma</var> is not given it
92defaults to 1.</p>
93
94<div style="margin: auto;">
95 <h3 class="magick-header"><a id="adjoin"></a>-adjoin</h3>
96</div>
97
98<p class="magick-description">Join images into a single multi-image file.</p>
99
100<p>This option is enabled by default. An attempt is made to save all images of
101an image sequence into the given output file. However, some formats, such as
102JPEG and PNG, do not support more than one image per file, and in that case
103ImageMagick is forced to write each image as a separate file. As such, if
104more than one image needs to be written, the filename given is modified by
105adding a <a href="command-line-options.html#scene">-scene</a> number before the suffix, in order to
106make distinct names for each image. </p>
107
108<p>Use <a href="command-line-options.html#adjoin">+adjoin</a> to force each image to be written to
109separate files, whether or not the file format allows multiple images per file
110(for example, GIF, MIFF, and TIFF). </p>
111
112<p>Including a C-style integer format string in the output filename will
113automagically enable <a href="command-line-options.html#adjoin">+adjoin</a> and are used to specify
114where the <a href="command-line-options.html#scene">-scene</a> number is placed in the filenames. These
115strings, such as '<code>%d</code>' or '<code>%03d</code>', are familiar to those
116who have used the standard <code>printf()</code>' C-library function. As an
117example, the command</p>
118
119<pre>
120convert logo: rose: -morph 15 my%02dmorph.jpg
121</pre>
122
123<p>will create a sequence of 17 images (the two given plus 15 more created by
124<a href="command-line-options.html#morph">-morph</a>), named: my00morph.jpg, my01morph.jpg,
125my02morph.jpg, ..., my16morph.jpg. </p>
126
127<p>In summary, ImageMagick tries to write all images to one file, but will
128save to multiple files, if any of the following conditions exist...</p>
129<ol>
130<li>the output image's file format does not allow multi-image files,</li>
131<li>the <a href="command-line-options.html#adjoin">+adjoin</a> option is given, or</li>
132<li>a printf() integer format string (eg: "%d") is present in the output
133 filename.</li>
134</ol>
135
136
137<div style="margin: auto;">
138 <h3 class="magick-header"><a id="affine"></a>-affine
139 <var>s<sub>x</sub></var>,<var>r<sub>x</sub></var>,<var>r<sub>y</sub></var>,<var>s<sub>y</sub></var>[,<var>t<sub>x</sub></var>,<var>t<sub>y</sub></var>]</h3>
140</div>
141
142<p class="magick-description">Set the drawing transformation matrix for combined rotating and scaling.</p>
143
Cristy594d2772015-11-15 10:47:42 -0500144<p>This option sets a transformation matrix, for use by subsequent <a
145href="command-line-options.html#draw">-draw</a> or <a href="command-line-options.html#transform">-transform</a> options. </p>
Cristy882d9f42015-10-29 16:48:39 -0400146
147<p>The matrix entries are entered as comma-separated numeric values either in
148quotes or without spaces. </p>
149
150<p>Internally, the transformation matrix has 3x3 elements, but three of them
151are omitted from the input because they are constant. The new (transformed)
152coordinates (<var>x'</var>, <var>y'</var>) of a pixel at
153position (<var>x</var>, <var>y</var>) in the original
154image are calculated using the following matrix equation.</p>
155
Cristy594d2772015-11-15 10:47:42 -0500156<p class="text-center"><img class="img-thumbnail" alt="affine transformation" src="../images/affine.png"/> </p>
Cristy882d9f42015-10-29 16:48:39 -0400157
158<p> The size of the resulting image is that of the smallest rectangle that
159contains the transformed source image. The parameters
160<var>t<sub>x</sub></var> and <var>t<sub>y</sub></var>
161subsequently shift the image pixels so that those that are moved out of the
162image area are cut off.</p>
163
164<p>The transformation matrix complies with the left-handed pixel coordinate
165system: positive <var>x</var> and <var>y</var> directions
166are rightward and downward, resp.; positive rotation is clockwise.</p>
167
168<p> If the translation coefficients <var>t<sub>x</sub></var> and
169<var>t<sub>y</sub></var> are omitted they default to 0,0. Therefore,
170four parameters suffice for rotation and scaling without translation.</p>
171
172<p>Scaling by the factors <var>s<sub>x</sub></var> and
173<var>s<sub>y</sub></var> in the <var>x</var> and <var>y</var> directions,
174respectively, is accomplished with the following.</p>
175
Cristy594d2772015-11-15 10:47:42 -0500176<p>See <a href="command-line-options.html#transform">-transform</a>, and the <a
177href="command-line-options.html#distort">-distort</a> method '<code>Affineprojection</code> for more
Cristy882d9f42015-10-29 16:48:39 -0400178information </p>
179
180
181<pre>
182-affine <var>s<sub>x</sub></var>,0,0,<var>s<sub>y</sub></var>
183</pre>
184
185<p>Translation by a displacement (<var>t<sub>x</sub></var>, <var>t<sub>y</sub></var>) is accomplished like so:</p>
186
187<pre>
188-affine 1,0,0,1,<var>t<sub>x</sub></var>,<var>t<sub>y</sub></var>
189</pre>
190
191<p>Rotate clockwise about the origin (the upper left-hand corner) by an angle
192<var>a</var> by letting <var>c</var> = cos(<var>a</var>), <var>s</var>
193= sin(<var>a</var>), and using the following.</p>
194
195<pre>
196-affine <var>c</var>,<var>s</var>,-<var>s</var>,<var>c</var>
197</pre>
198
Cristy594d2772015-11-15 10:47:42 -0500199<p>The cumulative effect of a sequence of <a href="command-line-options.html#affine" >-affine</a>
200transformations can be accomplished by instead by a single <a href="command-line-options.html#affine"
201>-affine</a> operation using the matrix equal to the product of the matrices
Cristy882d9f42015-10-29 16:48:39 -0400202of the individual transformations.</p>
203
204<p>An attempt is made to detect near-singular transformation matrices. If the
205matrix determinant has a sufficiently small absolute value it is rejected.</p>
206
207<div style="margin: auto;">
208 <h3 class="magick-header"><a id="alpha"></a>-alpha <var>type</var></h3>
209</div>
210
211<p class="magick-description">Gives control of the alpha/matte channel of an image.</p>
212
213<p>Used to set a flag on an image indicating whether or not to use existing alpha
214channel data, to create an alpha channel, or to perform other operations on the alpha channel. Choose the argument <var>type</var> from the list below.</p>
215
216<dl class="dl-horizontal">
217 <dt>Activate</dt>
218 <dd>
219 Enable the image's transparency channel. Note normally Set
220 should be used instead of this, unless you specifically need to
221 preserve existing (but specifically turned Off) transparency
222 channel. </dd>
223
224 <dt>Associate</dt>
225 <dd>
226 associate the alpha channel with the image.</dd>
227
228 <dt>Deactivate</dt>
229 <dd>
230 Disables the image's transparency channel. Does not delete or change the
231 existing data, just turns off the use of that data.</dd>
232
233 <dt>Disassociate</dt>
234 <dd>
235 disassociate the alpha channel from the image.</dd>
236
237 <dt>Set</dt>
238 <dd>
239 Activates the alpha/matte channel. If it was previously turned off
240 then it also resets the channel to opaque. If the image already had
241 the alpha channel turned on, it will have no effect.</dd>
242
243 <dt>Opaque</dt>
244 <dd>
245 Enables the alpha/matte channel and forces it to be fully opaque.
246 </dd>
247
248 <dt>Transparent</dt>
249 <dd>
250 Activates the alpha/matte channel and forces it to be fully
251 transparent. This effectively creates a fully transparent image the
252 same size as the original and with all its original RGB data still
253 intact, but fully transparent. </dd>
254
255 <dt>Extract</dt>
256 <dd>
257 Copies the alpha channel values into all the color channels and turns
258 'Off' the the image's transparency, so as to generate
Cristy769d8892016-01-19 18:11:14 -0500259 a grayscale mask of the image's shape. The alpha channel data is left
Cristy882d9f42015-10-29 16:48:39 -0400260 intact just deactivated. This is the inverse of 'Copy'.
261 </dd>
262
263 <dt>Copy</dt>
264 <dd>
265 Turns 'On' the alpha/matte channel, then copies the
Cristy769d8892016-01-19 18:11:14 -0500266 grayscale intensity of the image, into the alpha channel, converting
267 a grayscale mask into a transparent shaped mask ready to be colored
Cristy882d9f42015-10-29 16:48:39 -0400268 appropriately. The color channels are not modified. </dd>
269
270 <dt>Shape</dt>
271 <dd>
272 As per 'Copy' but also colors the resulting shape mask with
273 the current background color. That is the RGB color channels is
274 replaced, with appropriate alpha shape.
275 </dd>
276
277 <dt>Remove</dt>
278 <dd>
279 Composite the image over the background color.
280 </dd>
281
282 <dt>Background</dt>
283 <dd>
284 Set any fully-transparent pixel to the background color, while leaving
285 it fully-transparent. This can make some image file formats, such as
286 PNG, smaller as the RGB values of transparent pixels are more uniform,
287 and thus can compress better.
288 </dd>
289</dl>
290
291<p>Note that while the obsolete <code>+matte</code> operation was the
Cristy594d2772015-11-15 10:47:42 -0500292same as "<code><a href="command-line-options.html#alpha" >-alpha</a> Off</code>", the <code>
293>-matte</code> operation was the same as "<code><a href="command-line-options.html#alpha" >-alpha</a>
294Set</code>" and not "<code><a href="command-line-options.html#alpha" >-alpha</a> On</code>". </p>
Cristy882d9f42015-10-29 16:48:39 -0400295
Cristyf650f4f2016-04-01 10:53:07 -0400296<div style="margin: auto;">
Cristy882d9f42015-10-29 16:48:39 -0400297 <h3 class="magick-header"><a id="annotate"></a>
Cristy594d2772015-11-15 10:47:42 -0500298 -annotate <var>degrees</var> <var>text</var><br />
299 -annotate <var>Xdegrees</var>x<var>Ydegrees</var> <var>text</var><br /> -annotate <var>Xdegrees</var>x<var>Ydegrees</var> {+-}<var>t<sub>x</sub></var>{+-}<var>t<sub>y</sub></var> <var>text</var><br /> -annotate {+-}<var>t<sub>x</sub></var>{+-}<var>t<sub>y</sub></var> <var>text</var></h3>
Cristy882d9f42015-10-29 16:48:39 -0400300</div>
301
302<p class="magick-description">Annotate an image with text</p>
303
304<p>This is a convenience for annotating an image with text. For more precise
305control over text annotations, use <a href="command-line-options.html#draw">-draw</a>.</p>
306
307
308<p>The values <var>Xdegrees</var> and <var>Ydegrees</var>
Cristy594d2772015-11-15 10:47:42 -0500309control the shears applied to the text, while <var>t<sub>x</sub></var> and <var>t<sub>y</sub></var> are offsets that give the location of the text relative any <a href="command-line-options.html#gravity" >-gravity</a> setting and defaults to the upper left corner of the image.</p>
Cristy882d9f42015-10-29 16:48:39 -0400310
311<p>Using <a href="command-line-options.html#annotate">-annotate</a> <var>degrees</var>
312or <a href="command-line-options.html#annotate">-annotate</a> <var>degrees</var>x<var>degrees</var> produces an unsheared rotation of the text. The
313direction of the rotation is positive, which means a clockwise rotation if <var>degrees</var> is positive. (This conforms to the usual mathematical
314convention once it is realized that the positive <var>y</var>–direction is
315conventionally considered to be <var>downward</var> for images.)</p>
316
317<p>The new (transformed) coordinates (<var>x'</var>, <var>y'</var>) of a pixel at position (<var>x</var>, <var>y</var>) in the image are calculated using the following matrix
318equation.</p>
319
Cristy594d2772015-11-15 10:47:42 -0500320<p class="text-center"><img class="img-thumbnail" alt="annotate transformation" src="../images/annotate.png"/></p>
Cristy882d9f42015-10-29 16:48:39 -0400321
322<p>If <var>t<sub>x</sub></var> and <var>t<sub>y</sub></var> are omitted, they default to 0. This makes the
323bottom-left of the text becomes the upper-left corner of the image, which is
Cristy594d2772015-11-15 10:47:42 -0500324probably undesirable. Adding a <a href="command-line-options.html#gravity" >-gravity</a> option in this
Cristy882d9f42015-10-29 16:48:39 -0400325case leads to nice results.</p>
326
327<p>Text is any UTF-8 encoded character sequence. If <var>text</var>
328is of the form '@mytext.txt', the text is read from the file
329<code>mytext.txt</code>. Text in a file is taken literally; no embedded
330formatting characters are recognized.</p>
331
332<div style="margin: auto;">
333 <h3 class="magick-header"><a id="antialias"></a>-antialias</h3>
334</div>
335
336<p class="magick-description">Enable/Disable of the rendering of anti-aliasing pixels when drawing fonts and lines.</p>
337
338<p>By default, objects (e.g. text, lines, polygons, etc.) are antialiased when
339drawn. Use <a href="command-line-options.html#antialias">+antialias</a> to disable the addition of
340antialiasing edge pixels. This will then reduce the number of colors added to
341an image to just the colors being directly drawn. That is, no mixed colors
342are added when drawing such objects. </p>
343
344<div style="margin: auto;">
345 <h3 class="magick-header"><a id="append"></a>-append</h3>
346</div>
347
348<p class="magick-description">Join current images vertically or horizontally.</p>
349
350<p>This option creates a single longer image, by joining all the current
351images in sequence top-to-bottom. Use <a href="command-line-options.html#append">+append</a> to
352stack images left-to-right. </p>
353
354<p>If they are not of the same width, narrower images are padded with the
355current <a href="command-line-options.html#background">-background</a> color setting, and their
Cristy594d2772015-11-15 10:47:42 -0500356position relative to each other can be controlled by the current <a
357href="command-line-options.html#gravity">-gravity</a> setting. </p>
Cristy882d9f42015-10-29 16:48:39 -0400358
359
360<div style="margin: auto;">
361 <h3 class="magick-header"><a id="attenuate"></a>-attenuate <var>value</var></h3>
362</div>
363
364<p class="magick-description">Lessen (or intensify) when adding noise to an image.</p>
365
366<p>If unset the value is equivalent to 1.0, or a maximum noise addition</p>
367
368<div style="margin: auto;">
369 <h3 class="magick-header"><a id="authenticate"></a>-authenticate <var>password</var></h3>
370</div>
371
372<p class="magick-description">Decrypt a PDF with a password.</p>
373
374<p>Use this option to supply a <var>password</var> for decrypting
375a PDF that has been encrypted using Microsoft Crypto API (MSC API). The
376encrypting using the MSC API is not supported.</p>
377
378<p>For a different encryption method, see <a href="command-line-options.html#encipher">-encipher</a>
379and <a href="command-line-options.html#decipher">-decipher</a>. </p>
380
381
382<div style="margin: auto;">
383 <h3 class="magick-header"><a id="auto-gamma"></a>-auto-gamma</h3>
384</div>
385
386<p class="magick-description">Automagically adjust gamma level of image.</p>
387
Cristy594d2772015-11-15 10:47:42 -0500388<p>This calculates the mean values of an image, then applies a calculated <a
389href="command-line-options.html#gamma" >-gamma</a> adjustment so that is the mean color exists in the
Cristy882d9f42015-10-29 16:48:39 -0400390image it will get a have a value of 50%. </p>
391
392<p>This means that any solid 'gray' image becomes 50% gray. </p>
393
394<p>This works well for real-life images with little or no extreme dark and
395light areas, but tend to fail for images with large amounts of bright sky or
396dark shadows. It also does not work well for diagrams or cartoon like images.
397</p>
398
Cristy594d2772015-11-15 10:47:42 -0500399<p>It uses the <a href="command-line-options.html#channel" >-channel</a> setting, (including the
Cristy882d9f42015-10-29 16:48:39 -0400400'<var>sync</var>' flag for channel synchronization), to determine which color
Cristy594d2772015-11-15 10:47:42 -0500401values is used and modified. As the default <a href="command-line-options.html#channel"
402>-channel</a> setting is '<var>RGB,sync</var>', channels are modified
Cristy882d9f42015-10-29 16:48:39 -0400403together by the same gamma value, preserving colors. </p>
404
405
406
407<div style="margin: auto;">
408 <h3 class="magick-header"><a id="auto-level"></a>-auto-level</h3>
409</div>
410
411<p class="magick-description">Automagically adjust color levels of image.</p>
412
413<p>This is a 'perfect' image normalization operator. It finds the exact
Cristy594d2772015-11-15 10:47:42 -0500414minimum and maximum color values in the image and then applies a <a
415href="command-line-options.html#level" >-level</a> operator to stretch the values to the full range of
Cristy882d9f42015-10-29 16:48:39 -0400416values. </p>
417
418<p>The operator is not typically used for real-life images, image scans, or
419JPEG format images, as a single 'out-rider' pixel can set a bad min/max values
Cristy594d2772015-11-15 10:47:42 -0500420for the <a href="command-line-options.html#level" >-level</a> operation. On the other hand it is the
Cristy882d9f42015-10-29 16:48:39 -0400421right operator to use for color stretching gradient images being used to
422generate Color lookup tables, distortion maps, or other 'mathematically'
423defined images. </p>
424
Cristy594d2772015-11-15 10:47:42 -0500425<p>The operator is very similar to the <a href="command-line-options.html#normalize">-normalize</a>, <a
426href="command-line-options.html#contrast-stretch" >-contrast-stretch</a>, and <a href="command-line-options.html#linear-stretch"
427>-linear-stretch</a> operators, but without 'histogram binning' or 'clipping'
428problems that these operators may have. That is <a href="command-line-options.html#auto-level"
429>-auto-level</a> is the perfect or ideal version these operators. </p>
Cristy882d9f42015-10-29 16:48:39 -0400430
Cristy594d2772015-11-15 10:47:42 -0500431<p>It uses the <a href="command-line-options.html#channel" >-channel</a> setting, (including the
Cristy882d9f42015-10-29 16:48:39 -0400432special '<var>sync</var>' flag for channel synchronization), to determine
Cristy594d2772015-11-15 10:47:42 -0500433which color values are used and modified. As the default <a
434href="command-line-options.html#channel" >+channel</a> setting is '<var>RGB,sync</var>', the
Cristy882d9f42015-10-29 16:48:39 -0400435'<var>sync</var>' ensures that the color channels will are modified
436together by the same gamma value, preserving colors, and ignoring
437transparency. </p>
438
439
440<div style="margin: auto;">
441 <h3 class="magick-header"><a id="auto-orient"></a>-auto-orient</h3>
442</div>
443
444<p class="magick-description">adjusts an image so that its orientation is suitable for viewing (i.e. top-left orientation).</p>
445
446<p>This operator reads and resets the EXIF image profile setting 'Orientation'
447and then performs the appropriate 90 degree rotation on the image to orient
448the image, for correct viewing. </p>
449
450<p>This EXIF profile setting is usually set using a gravity sensor in digital
451camera, however photos taken directly downward or upward may not have an
452appropriate value. Also images that have been orientation 'corrected' without
453reseting this setting, may be 'corrected' again resulting in a incorrect
Cristy594d2772015-11-15 10:47:42 -0500454result. If the EXIF profile was previously stripped, the <a
455href="command-line-options.html#auto-orient" >-auto-orient</a> operator will do nothing. </p>
Cristy882d9f42015-10-29 16:48:39 -0400456
457
458<div style="margin: auto;">
459 <h3 class="magick-header"><a id="average"></a>-average</h3>
460</div>
461
462<p class="magick-description">Average a set of images.</p>
463
464<p>An error results if the images are not identically sized.</p>
465
466
467<div style="margin: auto;">
468 <h3 class="magick-header"><a id="backdrop"></a>-backdrop</h3>
469</div>
470
471<p class="magick-description">Display the image centered on a backdrop.</p>
472
473<p>This backdrop covers the entire workstation screen and is useful for hiding
474other X window activity while viewing the image. The color of the backdrop is
475specified as the background color. The color is specified using the format
476described under the <a href="command-line-options.html#fill">-fill</a> option.</p>
477
478<div style="margin: auto;">
479 <h3 class="magick-header"><a id="background"></a>-background <var>color</var></h3>
480</div>
481
482<p class="magick-description">Set the background color.</p>
483
Cristy594d2772015-11-15 10:47:42 -0500484<p>The color is specified using the format described under the <a
485href="command-line-options.html#fill">-fill</a> option. The default background color (if none is
Cristy882d9f42015-10-29 16:48:39 -0400486specified or found in the image) is white.</p>
487
488<div style="margin: auto;">
489 <h3 class="magick-header"><a id="bench"></a>-bench <var>iterations</var></h3>
490</div>
491
492<p class="magick-description">Measure performance.</p>
493
494<p>Repeat the entire command for the given number of <var>iterations</var> and report the user-time and elapsed time. For instance,
495consider the following command and its output. Modify the benchmark with the
496-duration to run the benchmark for a fixed number of seconds and -concurrent
497to run the benchmark in parallel (requires the OpenMP feature).</p>
498
499<pre>
Cristye09ed312016-03-06 08:07:39 -0500500-> convert logo: -resize 200% -bench 5 logo.png
501Performance[1]: 5i 1.344ips 1.000e 3.710u 0:03.720
502Performance[2]: 5i 1.634ips 0.549e 3.890u 0:03.060
503Performance[3]: 5i 2.174ips 0.618e 3.190u 0:02.300
504Performance[4]: 5i 1.678ips 0.555e 3.810u 0:02.980
Cristy882d9f42015-10-29 16:48:39 -0400505Performance[4]: 5i 0.875657ips 6.880u 0:05.710
506</pre>
507
Cristye09ed312016-03-06 08:07:39 -0500508<p>In this example, 5 iterations were completed at 2.174 iterations per
509second, using 3 threads and 3.190 seconds of the user allotted time, for
510a total elapsed time of 2.300 seconds.</p>
Cristy882d9f42015-10-29 16:48:39 -0400511
512<div style="margin: auto;">
513 <h3 class="magick-header"><a id="bias"></a>-bias <var>value</var>{<var>%</var>}</h3>
514</div>
515
516<p class="magick-description">Add bias when convolving an image.</p>
517
Cristy594d2772015-11-15 10:47:42 -0500518<p>This option shifts the output of <a href="command-line-options.html#convolve">&#x2011;convolve</a> so that
Cristy882d9f42015-10-29 16:48:39 -0400519positive and negative results are relative to the specified bias value. </p>
520
521<p>This is important for non-HDRI compilations of ImageMagick when dealing
522with convolutions that contain negative as well as positive values. This is
523especially the case with convolutions involving high pass filters or edge
524detection. Without an output bias, the negative values are clipped at
525zero.</p>
526
Cristy594d2772015-11-15 10:47:42 -0500527<p>When using an ImageMagick with the HDRI compile-time setting, <a href="command-line-options.html#bias">&#x2011;bias</a> is not needed, as ImageMagick is able to store/handle any
Cristy882d9f42015-10-29 16:48:39 -0400528negative results without clipping to the color value range
529(0..QuantumRange).</p>
530
Cristy594d2772015-11-15 10:47:42 -0500531<p>See the discussion on HDRI implementations of ImageMagick on the page <a
532href="high-dynamic-range.html" >High Dynamic-Range Images</a>. For more
533about HDRI go the ImageMagick <a
Cristy364a72f2016-11-04 22:38:41 -0400534href="https://www.imagemagick.org/Usage/basics/#hdri" >Usage</a> pages or this
Cristy594d2772015-11-15 10:47:42 -0500535<a
536href="http://en.wikipedia.org/wiki/High_dynamic_range_imaging">Wikipedia</a>
Cristy882d9f42015-10-29 16:48:39 -0400537entry. </p>
538
539<div style="margin: auto;">
540 <h3 class="magick-header"><a id="black-point-compensation"></a>-black-point-compensation</h3>
541</div>
542
543<p class="magick-description">Use black point compensation.</p>
544
545<div style="margin: auto;">
546 <h3 class="magick-header"><a id="black-threshold"></a>-black-threshold <var>value</var>{<var>%</var>}</h3>
547</div>
548
549<p class="magick-description">Force to black all pixels below the threshold while leaving all pixels at or above the threshold unchanged.</p>
550
551<p> The threshold value can be given as a percentage or as an absolute integer
552value within [0, <var>QuantumRange</var>] corresponding to the
Cristy594d2772015-11-15 10:47:42 -0500553desired <a href="command-line-options.html#channel">&#x2011;channel</a> value. See <a href="command-line-options.html#threshold">&#x2011;threshold</a>for more details on thresholds and resulting values. </p>
Cristy882d9f42015-10-29 16:48:39 -0400554
555
556<div style="margin: auto;">
557 <h3 class="magick-header"><a id="blend"></a>-blend <var>geometry</var></h3>
558</div>
559
560<p class="magick-description">blend an image into another by the given absolute value or percent.</p>
561
562<p>Blend will average the images together ('plus') according to the
563percentages given and each pixels transparency. If only a single percentage
564value is given it sets the weight of the composite or 'source' image, while
565the background image is weighted by the exact opposite amount. That is a
566<code>-blend 30%</code> merges 30% of the 'source' image with 70% of the
567'destination' image. Thus it is equivalent to <code>-blend 30x70%</code>.</p>
568
569
570<div style="margin: auto;">
571 <h3 class="magick-header"><a id="blue-primary"></a>-blue-primary <var>x</var>,<var>y</var></h3>
572</div>
573
574<p class="magick-description">Set the blue chromaticity primary point.</p>
575
576<div style="margin: auto;">
577 <h3 class="magick-header"><a id="blue-shift"></a>-blue-shift <var>factor</var></h3>
578</div>
579
580<p class="magick-description">simulate a scene at nighttime in the moonlight. Start with a factor of 1.5</p>
581
582<div style="margin: auto;">
583
584<div style="margin: auto;">
Cristy594d2772015-11-15 10:47:42 -0500585 <h3 class="magick-header"><a id="blur"></a>-blur <var>radius</var><br />-blur <var>radius</var>x<var>sigma</var></h3>
Cristy882d9f42015-10-29 16:48:39 -0400586</div>
587
588<p class="magick-description">Reduce image noise and reduce detail levels.</p>
589
590<p>Convolve the image with a Gaussian or normal distribution using the given
Cristy594d2772015-11-15 10:47:42 -0500591<var >Sigma</var> value. The formula is:</p>
Cristy882d9f42015-10-29 16:48:39 -0400592
Cristy594d2772015-11-15 10:47:42 -0500593<p class="text-center"><img class="img-thumbnail" alt="gaussian distribution" width="243px" height="42px" src="../images/gaussian-blur.png"/></p>
Cristy882d9f42015-10-29 16:48:39 -0400594
Cristy594d2772015-11-15 10:47:42 -0500595<p>The <var >Sigma</var> value is the important argument, and
Cristy882d9f42015-10-29 16:48:39 -0400596determines the actual amount of blurring that will take place. </p>
597
Cristy594d2772015-11-15 10:47:42 -0500598<p>The <var >Radius</var> is only used to determine the size of the
Cristy882d9f42015-10-29 16:48:39 -0400599array which will hold the calculated Gaussian distribution. It should be an
600integer. If not given, or set to zero, IM will calculate the largest possible
601radius that will provide meaningful results for the Gaussian distribution.
602</p>
603
Cristy594d2772015-11-15 10:47:42 -0500604<p>The larger the <var >Radius</var> the slower the
605operation is. However too small a <var >Radius</var>, and sever
606aliasing effects may result. As a guideline, <var >Radius</var>
607should be at least twice the <var >Sigma</var> value, though three
Cristy882d9f42015-10-29 16:48:39 -0400608times will produce a more accurate result. </p>
609
610<p>This option differs from <a href="command-line-options.html#gaussian-blur">-gaussian-blur</a> simply
611by taking advantage of the separability properties of the distribution. Here
612we apply a single-dimensional Gaussian matrix in the horizontal direction,
613then repeat the process in the vertical direction.</p>
614
615<p>The <a href="command-line-options.html#virtual-pixel">-virtual-pixel</a> setting will determine how
616pixels which are outside the image proper are blurred into the final result.
617</p>
618
619
620<div style="margin: auto;">
Cristy882d9f42015-10-29 16:48:39 -0400621 <h3 class="magick-header"><a id="border"></a>-border <var>geometry</var></h3>
622</div>
623
624<p class="magick-description">Surround the image with a border of color. </p>
625
626<p>Set the width and height using the <var>size</var> portion of the
627<var>geometry</var> argument. See <a href="command-line-processing.html#geometry">Image Geometry</a> for complete details about the <em class="arg">geometry</em> argument. Offsets are
628ignored. </p>
629
630<p>As of IM 6.7.8-8, the <var>geometry</var> arguments behave as follows:</p>
631
632<dl class="dl-horizontal">
633<dt><var>value</var></dt>
634<dd>value is added to both left/right and top/bottom</dd>
635<dt><var>value-x</var><kbd>x</kbd></dt>
636<dd>value-x is added only to left/right and top/bottom are unchanged</dd>
637<dt><kbd>x</kbd><var>value-y</var></dt>
638<dd>value-y is added only to top/bottom and left/right are unchanged</dd>
639<dt><var>value-x</var><kbd>x</kbd><var>value-y</var></dt>
640<dd>value-x is added to left/right and value-y added to top/bottom</dd>
641<dt><var>value-x</var><kbd>x</kbd>0</dt>
642<dd>value-x is added only to left/right and top/bottom are unchanged</dd>
643<dt>0<kbd>x</kbd><var>value-y</var></dt>
644<dd>value-y is added only to top/bottom and left/right are unchanged</dd>
645<dt><var>value</var>%</dt>
646<dd>value % of width is added to left/right and value % of height is added to top/bottom</dd>
647<dt><var>value-x</var><kbd>x</kbd>%</dt>
648<dd>value-x % of width is added to left/right and to top/bottom</dd>
649<dt>x<var>value-y</var>%</dt>
650<dd>value-y % of height is added to top/bottom and to left/right</dd>
651<dt><var>value-x</var>%<kbd>x</kbd><var>value-y</var>%</dt>
652<dd>value-x % of width is added to left/right and value-y % of height is added to top/bottom</dd>
653<dt><var>value-x</var>%<kbd>x</kbd>0%</dt>
654<dd>value-x % of width is added to left/right and top/bottom are unchanged</dd>
655<dt>0%<kbd>x</kbd><var>value-y</var>%</dt>
656<dd>value-y % of height is added to top/bottom and left/right are unchanged</dd>
657</dl>
658
Cristy594d2772015-11-15 10:47:42 -0500659<p>Set the border color by preceding with the <a
660href="command-line-options.html#bordercolor">-bordercolor</a> setting.</p>
Cristy882d9f42015-10-29 16:48:39 -0400661
Cristy594d2772015-11-15 10:47:42 -0500662<p>The <a href="command-line-options.html#border">-border</a> operation is affected by the current <a
663href="command-line-options.html#compose">-compose</a> setting and assumes that this is using the default
Cristy882d9f42015-10-29 16:48:39 -0400664'<code>Over</code>' composition method. It generates an image of the appropriate
665size colors by the current <a href="command-line-options.html#bordercolor">-bordercolor</a> before
666overlaying the original image in the center of this net image. This means that
667with the default compose method of '<code>Over</code>' any transparent parts may
668be replaced by the current <a href="command-line-options.html#bordercolor">-bordercolor</a> setting.</p>
669<p>See also the <a href="command-line-options.html#frame">-frame</a> option, which has more
670functionality.</p>
671
672<div style="margin: auto;">
673 <h3 class="magick-header"><a id="bordercolor"></a>-bordercolor <var>color</var></h3>
674</div>
675
676<p class="magick-description">Set the border color.</p>
677
678<p>The color is specified using the format described under the <a href="command-line-options.html#fill">-fill</a> option.</p>
679
680<p>The default border color is <code>#DFDFDF</code>, <span style="background-color: #dfdfdf;">this shade of gray</span>.</p>
681
682<div style="margin: auto;">
683 <h3 class="magick-header"><a id="borderwidth"></a>-borderwidth <var>geometry</var> </h3>
684</div>
685
686<p class="magick-description">Set the border width.</p>
687
688<div style="margin: auto;">
Cristy769d8892016-01-19 18:11:14 -0500689 <h3 class="magick-header"><a id="brightness-contrast"></a>-brightness-contrast <var>brightness</var><br />-brightness-contrast <var>brightness</var>{x<var>contrast</var>}{<var>%</var>}</h3>
Cristy882d9f42015-10-29 16:48:39 -0400690</div>
691
692<p class="magick-description">Adjust the brightness and/or contrast of the image.</p>
693
694<p>Brightness and Contrast values apply changes to the input image. They are
695not absolute settings. A brightness or contrast value of zero means no change.
696The range of values is -100 to +100 on each. Positive values increase the
697brightness or contrast and negative values decrease the brightness or contrast.
698To control only contrast, set the brightness=0. To control only brightness,
699set contrast=0 or just leave it off.</p>
700
701<p>You may also use <a href="command-line-options.html#fill">-channel</a> to control which channels to
702apply the brightness and/or contrast change. The default is to apply the same
703transformation to all channels.</p>
704
705<p>Brightness and Contrast arguments are converted to offset and slope of a
706linear transform and applied
707using <a href="command-line-options.html#fill">-function polynomial "slope,offset"</a>.</p>
708
709<p>The slope varies from 0 at contrast=-100 to almost vertical at
710contrast=+100. For brightness=0 and contrast=-100, the result are totally
711midgray. For brightness=0 and contrast=+100, the result will approach but
712not quite reach a threshold at midgray; that is the linear transformation
713is a very steep vertical line at mid gray.</p>
714
715<p>Negative slopes, i.e. negating the image, are not possible with this
716function. All achievable slopes are zero or positive.</p>
717
718<p>The offset varies from -0.5 at brightness=-100 to 0 at brightness=0 to +0.5
719at brightness=+100. Thus, when contrast=0 and brightness=100, the result is
720totally white. Similarly, when contrast=0 and brightness=-100, the result is
721totally black.</p>
722
723<p>As the range of values for the arguments are -100 to +100, adding the '%'
724symbol is no different than leaving it off.</p>
725
726<div style="margin: auto;">
727 <h3 class="magick-header"><a id="cache"></a>-cache <var>threshold</var></h3>
728</div>
729
Cristy594d2772015-11-15 10:47:42 -0500730<p class="magick-description">(This option has been replaced by the <a href='command-line-options.html#limit'>-limit</a> option).</p>
Cristy882d9f42015-10-29 16:48:39 -0400731
732<div style="margin: auto;">
Cristy594d2772015-11-15 10:47:42 -0500733 <h3 class="magick-header"><a id="canny"></a>-canny <var>radius</var><br/>-canny <var>radius</var>x<var>sigma</var>{<var>+lower-percent</var>}{<var>+upper-percent</var>}</h3>
Cristy882d9f42015-10-29 16:48:39 -0400734</div>
735
736<p class="magick-description">Canny edge detector uses a multi-stage algorithm to detect a wide range of edges in the image.</p>
737
738<p>The thresholds range from 0 to 100% (e.g. -canny 0x1+10%+30%) with {<var>+lower-percent</var>} &lt; {<var>+upper-percent</var>}. If {<var>+upper-percent</var>} is increased but {<var>+lower-percent</var>} remains the same, lesser edge components will be detected, but their lengths will be the same. If {<var>+lower-percent</var>} is increased but {<var>+upper-percent</var>} is the same, the same number of edge components will be detected but their lengths will be shorter. The default thresholds are shown. The <var>radius</var>x<var>sigma</var> controls a gaussian blur applied to the input image to reduce noise and smooth the edges.</p>
739
740<div style="margin: auto;">
741 <h3 class="magick-header"><a id="caption"></a>-caption <var>string</var></h3>
742</div>
743
744<p class="magick-description">Assign a caption to an image.</p>
745
746<p>This option sets the caption meta-data of an image read in after this
747option has been given. To modify a caption of images already in memory use
748"<code><a href="command-line-options.html#set">-set</a> caption</code>". </p>
749
Cristy594d2772015-11-15 10:47:42 -0500750<p>The caption can contain special format characters listed in the <a
751href="escape.html">Format and
Cristy882d9f42015-10-29 16:48:39 -0400752Print Image Properties</a>. These attributes are expanded when the caption
753is finally assigned to the individual images. </p>
754
755<p>If the first character of <var>string</var> is <var>@</var>, the image caption is read from a file titled by the
756remaining characters in the string. Comments read in from a file are literal;
757no embedded formatting characters are recognized.</p>
758
759<p>Caption meta-data is not visible on the image itself. To do that use the
760<a href="command-line-options.html#annotate">-annotate</a> or <a href="command-line-options.html#draw">-draw</a> options
761instead.</p>
762
763<p>For example,</p>
764
765<pre>
766-caption "%m:%f %wx%h" bird.miff
767</pre>
768
769<p>produces an image caption of <code>MIFF:bird.miff 512x480</code> (assuming
770that the image <code>bird.miff</code> has a width of 512 and a height of
771480.</p>
772
773
774<div style="margin: auto;">
775 <h3 class="magick-header"><a id="cdl"></a>-cdl <var>filename</var></h3>
776</div>
777
778<p class="magick-description">color correct with a color decision list.</p>
779
780<p>Here is an example color correction collection:</p>
781
782<pre>
783&lt;?xml version="1.0" encoding="UTF-8"?&gt;
784&lt;ColorCorrectionCollection xmlns="urn:ASC:CDL:v1.2"&gt;
785 &lt;ColorCorrection id="cc06668"&gt;
786 &lt;SOPNode&gt;
787 &lt;Slope&gt; 0.9 1.2 0.5 &lt;/Slope&gt;
788 &lt;Offset&gt; 0.4 -0.5 0.6 &lt;/Offset&gt;
789 &lt;Power&gt; 1.0 0.8 1.5 &lt;/Power&gt;
790 &lt;/SOPNode&gt;
791 &lt;SATNode&gt;
792 &lt;Saturation&gt; 0.85 &lt;/Saturation&gt;
793 &lt;/SATNode&gt;
794 &lt;/ColorCorrection&gt;
795&lt;/ColorCorrectionCollection&gt;
796</pre>
797
798<div style="margin: auto;">
799 <h3 class="magick-header"><a id="channel"></a>-channel <var>type</var></h3>
800</div>
801
802<p class="magick-description">Specify those image color channels to which subsequent operators are limited.</p>
803
804<p>Choose from: <code>Red</code>, <code>Green</code>, <code>Blue</code>,
805<code>Alpha</code>, <code>Gray</code>, <code>Cyan</code>, <code>Magenta</code>,
806<code>Yellow</code>, <code>Black</code>, <code>Opacity</code>,
807<code>Index</code>, <code>RGB</code>, <code>RGBA</code>, <code>CMYK</code>, or
808<code>CMYKA</code>.</p>
809
810<p>The channels above can also be specified as a comma-separated list or can be
811abbreviated as a concatenation of the letters '<code>R</code>', '<code>G</code>',
812'<code>B</code>', '<code>A</code>', '<code>O</code>', '<code>C</code>',
813'<code>M</code>', '<code>Y</code>', '<code>K</code>'.
814
815For example, to only select the <code>Red</code> and <code>Blue</code> channels
816you can either use </p>
817<pre>
818-channel Red,Blue
819</pre>
820<p>or you can use the short hand form</p>
821<pre>
822-channel RB
823</pre>
824
825<p>All the channels that are present in an image can be specified using the
826special channel type <code>All</code>. Not all operators are 'channel capable',
827but generally any operators that are generally 'grey-scale' image operators,
828will understand this setting. See individual operator documentation. </p>
829
Cristy594d2772015-11-15 10:47:42 -0500830<br/>
Cristy882d9f42015-10-29 16:48:39 -0400831
832<p>On top of the normal channel selection an extra flag can be specified,
833'<code>Sync</code>'. This is turned on by default and if set means that
834operators that understand this flag should perform: cross-channel
835synchronization of the channels. If not specified, then most grey-scale
836operators will apply their image processing operations to each individual
837channel (as specified by the rest of the <a href="command-line-options.html#channel">-channel</a>
838setting) completely independently from each other. </p>
839
840<p>For example for operators such as <a href="command-line-options.html#auto-level">-auto-level</a> and
841<a href="command-line-options.html#auto-gamma">-auto-gamma</a> the color channels are modified
842together in exactly the same way so that colors will remain in-sync. Without
843it being set, then each channel is modified separately and
844independently, which may produce color distortion. </p>
845
846<p>The <a href="command-line-options.html#morphology">-morphology</a> '<code>Convolve</code>' method
847and the <a href="command-line-options.html#compose">-compose</a> mathematical methods, also understands
848the '<code>Sync</code>' flag to modify the behavior of pixel colors according
849to the alpha channel (if present). That is to say it will modify the image
850processing with the understanding that fully-transparent colors should not
851contribute to the final result. </p>
852
853<p>Basically, by default, operators work with color channels in synchronous, and
854treats transparency as special, unless the <a href="command-line-options.html#channel">-channel</a>
855setting is modified so as to remove the effect of the '<code>Sync</code>' flag.
856How each operator does this depends on that operators current implementation.
857Not all operators understands this flag at this time, but that is changing.
858</p>
859
860<p>To print a complete list of channel types, use <a href="command-line-options.html#list">-list
861channel</a>.</p>
862
863<p>By default, ImageMagick sets <a href="command-line-options.html#channel">-channel</a> to the value
864'<code>RGBK,sync</code>', which specifies that operators act on all color
865channels except the transparency channel, and that all the color channels are
866to be modified in exactly the same way, with an understanding of transparency
Cristy594d2772015-11-15 10:47:42 -0500867(depending on the operation being applied). The 'plus' form <a
868href="command-line-options.html#channel" >+channel</a> will reset the value back to this default. </p>
Cristy882d9f42015-10-29 16:48:39 -0400869
Cristy594d2772015-11-15 10:47:42 -0500870<p>Options that are affected by the <a href="command-line-options.html#channel" >-channel</a> setting
Cristy882d9f42015-10-29 16:48:39 -0400871include the following.
872
873<a href="command-line-options.html#auto-gamma">-auto-gamma</a>,
874<a href="command-line-options.html#auto-level">-auto-level</a>,
875<a href="command-line-options.html#black-threshold">-black-threshold</a>,
876<a href="command-line-options.html#blur">-blur</a>,
877<a href="command-line-options.html#clamp">-clamp</a>,
878<a href="command-line-options.html#clut">-clut</a>,
879<a href="command-line-options.html#combine">-combine</a>,
880<a href="command-line-options.html#composite">-composite</a> (Mathematical compose methods only),
881<a href="command-line-options.html#convolve">-convolve</a>,
882<a href="command-line-options.html#contrast-stretch">-contrast-stretch</a>,
883<a href="command-line-options.html#evaluate">-evaluate</a>,
884<a href="command-line-options.html#function">-function</a>,
885<a href="command-line-options.html#fx">-fx</a>,
886<a href="command-line-options.html#gaussian-blur">-gaussian-blur</a>,
887<a href="command-line-options.html#hald-clut">-hald-clut</a>,
888<a href="command-line-options.html#motion-blur">-motion-blur</a>,
889<a href="command-line-options.html#morphology">-morphology</a>,
890<a href="command-line-options.html#negate">-negate</a>,
891<a href="command-line-options.html#normalize">-normalize</a>,
892<a href="command-line-options.html#ordered-dither">-ordered-dither</a>,
893<a href="command-line-options.html#radial-blur">-radial-blur</a>,
894<a href="command-line-options.html#random-threshold">-random-threshold</a>,
895<a href="command-line-options.html#separate">-separate</a>,
896<a href="command-line-options.html#threshold">-threshold</a>, and
897<a href="command-line-options.html#white-threshold">-white-threshold</a>.
898</p>
899
Cristy594d2772015-11-15 10:47:42 -0500900<p>Warning, some operators behave differently when the <a href="command-line-options.html#channel"
901>+channel</a> default setting is in effect, verses ANY user defined <a
902href="command-line-options.html#channel" >-channel</a> setting (including the equivalent of the
Cristy882d9f42015-10-29 16:48:39 -0400903default). These operators have yet to be made to understand the newer 'Sync'
904flag. </p>
905
Cristy769d8892016-01-19 18:11:14 -0500906<p>For example <a href="command-line-options.html#threshold">-threshold</a> will by default grayscale
Cristy594d2772015-11-15 10:47:42 -0500907the image before thresholding, if no <a href="command-line-options.html#channel" >-channel</a> setting
Cristy882d9f42015-10-29 16:48:39 -0400908has been defined. This is not 'Sync flag controlled, yet. </p>
909
Cristy594d2772015-11-15 10:47:42 -0500910<p>Also some operators such as <a href="command-line-options.html#blur">-blur</a>, <a
911href="command-line-options.html#gaussian-blur">-gaussian-blur</a>, will modify their handling of the
912color channels if the '<code>alpha</code>' channel is also enabled by <a
913href="command-line-options.html#channel" >-channel</a>. Generally this done to ensure that
Cristy882d9f42015-10-29 16:48:39 -0400914fully-transparent colors are treated as being fully-transparent, and thus any
915underlying 'hidden' color has no effect on the final results. Typically
916resulting in 'halo' effects. The newer <a href="command-line-options.html#morphology">-morphology</a>
917convolution equivalents however does have a understanding of the 'Sync' flag
918and will thus handle transparency correctly by default. </p>
919
920<p>As a alpha channel is optional within images, some operators will read the
921color channels of an image as a greyscale alpha mask, when the image has no
Cristy594d2772015-11-15 10:47:42 -0500922alpha channel present, and the <a href="command-line-options.html#channel" >-channel</a> setting tells
923the operator to apply the operation using alpha channels. The <a
924href="command-line-options.html#clut">-clut</a> operator is a good example of this. </p>
Cristy882d9f42015-10-29 16:48:39 -0400925
Cristyd474b372017-02-14 12:19:13 -0500926<div style="margin: auto;">
927 <h3 class="magick-header"><a id="channel-fx"></a>-channel-fx <var>expression</var></h3>
928</div>
Cristy882d9f42015-10-29 16:48:39 -0400929
Cristyd474b372017-02-14 12:19:13 -0500930<p class="magick-description">exchange, extract, or copy one or more image channels.</p>
931
932<p>The expression consists of one or more channels, either mnemonic or numeric (e.g. red or 0, green or 1, etc.), separated by certain operation symbols as follows:</p>
933
934<pre>
935&lt;=&gt; exchange two channels (e.g. red&lt;=&gt;blue)
936=&gt; copy one channel to another channel (e.g. red=&gt;green)
937= assign a constant value to a channel (e.g. red=50%)
938, write new image with channels in the specified order (e.g. red, green)
939; add a new output image for the next set of channel operations (e.g. red; green; blue)
940| move to the next input image for the source of channel data (e.g. | gray=>alpha)
941</pre>
942
943<p>For example, to create 3 grayscale images from the red, green, and blue channels of an image, use:</p>
944
945<pre>
946-channel-fx "red; green; blue"
947</pre>
948
949<p>A channel without an operation symbol implies separate (i.e, semicolon).</p>
950
951<p>Here we take an sRGB image and a grayscale image and inject the grayscale image into the alpha channel:</p>
952<pre>
953convert wizard.png mask.pgm -channel-fx '| gray=>alpha' wizard-alpha.png
954</pre>
955<p>Use a similar command to define a read mask:</p>
956<pre>
957convert wizard.png mask.pgm -channel-fx '| gray=>read-mask' wizard-mask.png
958</pre>
959
960<p>Add <code>-debug pixel</code> prior to the <code>-channel-fx</code> option to track the channel morphology.</p>
Cristy882d9f42015-10-29 16:48:39 -0400961
962<div style="margin: auto;">
963 <h3 class="magick-header"><a id="charcoal"></a>-charcoal <var>factor</var></h3>
964</div>
965
966<p class="magick-description">Simulate a charcoal drawing.</p>
967
Cristyd474b372017-02-14 12:19:13 -0500968
Cristy882d9f42015-10-29 16:48:39 -0400969<div style="margin: auto;">
970 <h3 class="magick-header"><a id="chop"></a>-chop <var>geometry</var></h3>
971</div>
972
973<p class="magick-description">Remove pixels from the interior of an image.</p>
974
975<p>See <a href="command-line-processing.html#geometry">Image Geometry</a> for complete details about the <em class="arg">geometry</em> argument. The <var>width</var>
976and <var>height</var> given in the of the <var>size</var>
977portion of the <var>geometry</var> argument give the number of
978columns and rows to remove. The <var>offset</var> portion of
979the <var>geometry</var> argument is influenced by
980a <a href="command-line-options.html#gravity">-gravity</a> setting, if present.</p>
981
982<p>The <a href="command-line-options.html#chop">-chop</a> option removes entire rows and columns,
983and moves the remaining corner blocks leftward and upward to close the gaps.</p>
984
985<p>While it can remove internal rows and columns of pixels, it is more
986typically used with as <a href="command-line-options.html#gravity">-gravity</a> setting and zero
Cristy594d2772015-11-15 10:47:42 -0500987offsets so as to remove a single edge from an image. Compare this to <a
988href="command-line-options.html#shave" >-shave</a> which removes equal numbers of pixels from opposite
Cristy882d9f42015-10-29 16:48:39 -0400989sides of the image. </p>
990
Cristy594d2772015-11-15 10:47:42 -0500991<p>Using <a href="command-line-options.html#chop">-chop</a> effectively undoes the results of a <a
992href="command-line-options.html#splice">-splice</a> that was given the same <var>geometry</var> and <a href="command-line-options.html#gravity">-gravity</a> settings. </p>
Cristy882d9f42015-10-29 16:48:39 -0400993
994<div style="margin: auto;">
995 <h3 class="magick-header"><a id="clamp"></a>-clamp</h3>
996</div>
997
998<p class="magick-description">set each pixel whose value is below zero to zero and any the pixel whose value is above the quantum range to the quantum range (e.g. 65535) otherwise the pixel value remains unchanged.</p>
999
1000<div style="margin: auto;">
1001 <h3 class="magick-header"><a id="clip"></a>-clip</h3>
1002</div>
1003
1004<p class="magick-description">Apply the clipping path if one is present.</p>
1005
1006<p>If a clipping path is present, it is applied to subsequent operations.</p>
1007
1008<p>For example, in the command</p>
1009
1010<pre>
1011convert cockatoo.tif -clip -negate negated.tif
1012</pre>
1013
1014<p>only the pixels within the clipping path are negated.</p>
1015
1016<p>The <a href="command-line-options.html#clip">-clip</a> feature requires SVG support. If the SVG
1017delegate library is not present, the option is ignored.</p>
1018
1019<p>Use <a href="command-line-options.html#clip">+clip</a> to disable clipping for subsequent operations.</p>
1020
1021<div style="margin: auto;">
1022 <h3 class="magick-header"><a id="clip-mask"></a>-clip-mask</h3>
1023</div>
1024
1025<p class="magick-description">Clip the image as defined by this mask.</p>
1026
1027<p>Use the alpha channel of the current image as a mask. Any areas that is
1028white is not modified by any of the 'image processing operators' that follow,
1029until the mask is removed. Pixels in the black areas of the clip mask are
1030modified per the requirements of the operator. </p>
1031
1032<p>In some ways this is similar to (though not the same) as defining
Cristy594d2772015-11-15 10:47:42 -05001033a rectangular <a href="command-line-options.html#region" >-region</a>, or using the negative of the
1034mask (third) image in a three image <a href="command-line-options.html#composite" >-composite</a>,
Cristy882d9f42015-10-29 16:48:39 -04001035operation. </p>
1036
1037<p>Use <a href="command-line-options.html#clip-mask">+clip-mask</a> to disable clipping for subsequent operations.</p>
1038
1039<div style="margin: auto;">
1040 <h3 class="magick-header"><a id="clip-path"></a>-clip-path <var>id</var></h3>
1041</div>
1042
1043<p class="magick-description">Clip along a named path from the 8BIM profile.</p>
1044
1045<p>This is identical to <a href="command-line-options.html#clip">-clip</a> except choose a specific clip path in the event the image has more than one path available. </p>
1046
1047<p>Use <a href="command-line-options.html#clip-path">+clip-path</a> to disable clipping for subsequent operations.</p>
1048
1049<div style="margin: auto;">
1050 <h3 class="magick-header"><a id="clone"></a>-clone <var>index(s)</var></h3>
1051</div>
1052
1053<p class="magick-description">make a clone of an image (or images).</p>
1054
1055<p>Inside parenthesis (where the operator is normally used) it will make a
1056clone of the images from the last 'pushed' image sequence, and adds them to
1057the end of the current image sequence. Outside parenthesis
1058(not recommended) it clones the images from the current image sequence. </p>
1059
1060<p>Specify the image by its index in the sequence. The first image is index
10610. Negative indexes are relative to the end of the sequence; for
1062example, <code>−1</code>
1063represents the last image of the sequence. Specify a range of images with a
1064dash (e.g. <code>0−4</code>). Separate multiple indexes with commas but no
1065spaces (e.g. <code>0,2,5</code>). A value of '<code>0−−1</code> will
1066effectively clone all the images. </p>
1067
1068<p>The <a href="command-line-options.html#clone">+clone</a> will simply make a copy of the last image
1069in the image sequence, and is thus equivalent to using a argument of
1070'<code>−1</code>'. </p>
1071
1072<div style="margin: auto;">
1073 <h3 class="magick-header"><a id="clut"></a>-clut</h3>
1074</div>
1075
1076<p class="magick-description">Replace the channel values in the first image using each corresponding channel in the second image as a <b>c</b>olor <b>l</b>ook<b>u</b>p <b>t</b>able.</p>
1077
1078<p>The second (LUT) image is ordinarily a gradient image containing the
1079histogram mapping of how each channel should be modified. Typically it is a
1080either a single row or column image of replacement color values. If larger
1081than a single row or column, values are taken from a diagonal line from
1082top-left to bottom-right corners.</p>
1083
Cristy594d2772015-11-15 10:47:42 -05001084<p>The lookup is further controlled by the <a
1085href="command-line-options.html#interpolate">-interpolate</a> setting, which is especially handy for an
Cristy882d9f42015-10-29 16:48:39 -04001086LUT which is not the full length needed by the ImageMagick installed Quality
1087(Q) level. Good settings for this are the '<code>bilinear</code>' and
1088'<code>bicubic</code>' interpolation settings, which give smooth color
1089gradients, and the '<code>integer</code>' setting for a direct, unsmoothed
1090lookup of color values. </p>
1091
1092<p>This operator is especially suited to replacing a grayscale image with a
1093specific color gradient from the CLUT image. </p>
1094
1095<p>Only the channel values defined by the <a href="command-line-options.html#channel">-channel</a>
Cristy594d2772015-11-15 10:47:42 -05001096setting will have their values replaced. In particular, since the default <a
1097href="command-line-options.html#channel">-channel</a> setting is <code>RGB</code>, this means that
1098transparency (alpha/matte channel) is not affected, unless the <a
1099href="command-line-options.html#channel">-channel</a> setting is modified. When the alpha channel is
1100set, it is treated by the <a href="command-line-options.html#clut" >-clut</a> operator in the same way
Cristy882d9f42015-10-29 16:48:39 -04001101as the other channels, implying that alpha/matte values are replaced using the
1102alpha/matte values of the original image. </p>
1103
1104<p>If either the image being modified, or the lookup image, contains no
Cristy594d2772015-11-15 10:47:42 -05001105transparency (i.e. <a href="command-line-options.html#alpha" >-alpha</a> is turned 'off') but the <a
1106href="command-line-options.html#channel">-channel</a> setting includes alpha replacement, then it is
Cristy769d8892016-01-19 18:11:14 -05001107assumed that image represents a grayscale gradient which is used for the
1108replacement alpha values. That is you can use a grayscale CLUT image to
1109adjust a existing images alpha channel, or you can color a grayscale image
Cristy882d9f42015-10-29 16:48:39 -04001110using colors form CLUT containing the desired colors, including transparency.
1111</p>
1112
Cristy594d2772015-11-15 10:47:42 -05001113<p>See also <a href="command-line-options.html#hald-clut" >-hald-clut</a> which replaces colors
Cristy882d9f42015-10-29 16:48:39 -04001114according to the lookup of the full color RGB value from a 2D representation
1115of a 3D color cube. </p>
1116
1117
1118<div style="margin: auto;">
1119 <h3 class="magick-header"><a id="coalesce"></a>-coalesce</h3>
1120</div>
1121
1122<p class="magick-description">Fully define the look of each frame of an GIF animation sequence, to form a 'film strip' animation.</p>
1123
1124<p>Overlay each image in an image sequence according to
1125its <a href="command-line-options.html#dispose">-dispose</a> meta-data, to reproduce the look of
1126an animation at each point in the animation sequence. All images should be
1127the same size, and are assigned appropriate GIF disposal settings for the
1128animation to continue working as expected as a GIF animation. Such frames
1129are more easily viewed and processed than the highly optimized GIF overlay
1130images. </p>
1131
1132<p>The animation can be re-optimized after processing using
1133the <a href="command-line-options.html#layers">-layers</a> method '<code>optimize</code>', although
1134there is no guarantee that the restored GIF animation optimization is
1135better than the original. </p>
1136
1137
1138<div style="margin: auto;">
1139 <h3 class="magick-header"><a id="colorize"></a>-colorize <var>value</var></h3>
1140</div>
1141
Cristy594d2772015-11-15 10:47:42 -05001142<p class="magick-description">Colorize the image by an amount specified by <var>value</var> using the color specified by the most recent <a href="command-line-options.html#fill" >-fill</a> setting.</p>
Cristy882d9f42015-10-29 16:48:39 -04001143
1144<p>Specify the amount of colorization as a percentage. Separate colorization
1145values can be applied to the red, green, and blue channels of the image with
1146a comma-delimited list of colorization
1147values (e.g., <code>-colorize 0,0,50</code>).</p>
1148
1149<div style="margin: auto;">
1150 <h3 class="magick-header"><a id="colormap"></a>-colormap <var>type</var></h3>
1151</div>
1152
1153<p class="magick-description">Define the colormap type.</p>
1154
1155<p>The <var>type</var> can be <code>shared</code> or <code>private</code>.</p>
1156
1157<p>This option only applies when the default X server visual
1158is <code>PseudoColor</code> or <code>GrayScale</code>. Refer
1159to <a href="command-line-options.html#visual">-visual</a> for more details. By default,
1160a shared colormap is allocated. The image shares colors with
1161other X clients. Some image colors could be approximated,
1162therefore your image may look very different than intended.
1163If <code>private</code> is chosen, the image colors appear exactly
1164as they are defined. However, other clients may go <var>technicolor</var>
1165when the image colormap is installed.</p>
1166
1167<div style="margin: auto;">
1168 <h3 class="magick-header"><a id="colors"></a>-colors <var>value</var></h3>
1169</div>
1170
1171<p class="magick-description">Set the preferred number of colors in the image.</p>
1172
1173<p>The actual number of colors in the image may be less than your request,
1174but never more. Note that this a color reduction option. Images with fewer
1175unique colors than specified by <var>value</var> will have any
1176duplicate or unused colors removed. The ordering of an existing color
1177palette may be altered. When converting an image from color to grayscale,
1178it is more efficient to convert the image to the gray colorspace before
1179reducing the number of colors. Refer to
Cristy6549abb2016-11-10 08:25:55 -05001180the <a href="http://www.imagemagick.org/www/quantize.html">
Cristy882d9f42015-10-29 16:48:39 -04001181color reduction algorithm</a> for more details.</p>
1182
1183<div style="margin: auto;">
1184 <h3 class="magick-header"><a id="color-matrix"></a>-color-matrix <var>matrix</var></h3>
1185</div>
1186
1187<p class="magick-description">apply color correction to the image.</p>
1188
1189<p>This option permits saturation changes, hue rotation, luminance to alpha,
1190and various other effects. Although variable-sized transformation matrices
1191can be used, typically one uses a 5x5 matrix for an RGBA image and a 6x6
1192for CMYKA (or RGBA with offsets). The matrix is similar to those used by
1193Adobe Flash except offsets are in column 6 rather than 5 (in support of
1194CMYKA images) and offsets are normalized (divide Flash offset by 255).</p>
1195
1196<p>As an example, to add contrast to an image with offsets, try this command:</p>
1197
1198<pre>
1199convert kittens.jpg -color-matrix \
1200 " 1.5 0.0 0.0 0.0, 0.0, -0.157 \
1201 0.0 1.5 0.0 0.0, 0.0, -0.157 \
1202 0.0 0.0 1.5 0.0, 0.0, -0.157 \
1203 0.0 0.0 0.0 1.0, 0.0, 0.0 \
1204 0.0 0.0 0.0 0.0, 1.0, 0.0 \
1205 0.0 0.0 0.0 0.0, 0.0, 1.0" kittens.png
1206</pre>
1207<div style="margin: auto;">
1208 <h3 class="magick-header"><a id="colorspace"></a>-colorspace <var>value</var></h3>
1209</div>
1210
1211<p class="magick-description">Set the image colorspace.</p>
1212
1213<p>Choices are:</p>
1214
1215<pre>
1216CMY CMYK Gray HCL
1217HCLp HSB HSI HSL
1218HSV HWB Lab LCHab
1219LCHuv LMS Log Luv
1220OHTA Rec601YCbCr Rec709YCbCr RGB
1221scRGB sRGB Transparent xyY
1222XYZ YCbCr YCC YDbDr
Cristyd474b372017-02-14 12:19:13 -05001223YIQ YPbPr YUV Undefined
Cristy882d9f42015-10-29 16:48:39 -04001224</pre>
1225
1226<p>To print a complete list of colorspaces, use <a href="command-line-options.html#list">-list colorspace</a>.</p>
1227
1228<p>For a more accurate color conversion to or from the linear RGB, CMYK, or grayscale colorspaces, use the <a href="command-line-options.html#profile">-profile</a> option. Note, ImageMagick assumes the sRGB colorspace if the image format does not indicate otherwise. For colorspace conversion, the gamma function is first removed to produce linear RGB.</p>
1229
1230<table class="table table-condensed table-striped">
1231 <caption>Conversion of RGB to Other Color Spaces</caption>
1232 <tr><th valign="middle">CMY</th></tr>
1233 <tr><td valign="middle">C=<var>QuantumRange</var>−R</td></tr>
1234 <tr><td valign="middle">M=<var>QuantumRange</var>−G</td></tr>
1235 <tr><td valign="middle">Y=<var>QuantumRange</var>−B</td></tr>
1236 <tr><th valign="middle">CMYK — starts with CMY from above</th></tr>
1237 <tr><td valign="middle">K=min(C,Y,M)</td></tr>
1238 <tr><td valign="middle">C=<var>QuantumRange</var>*(C−K)/(<var>QuantumRange</var>−K)</td></tr>
1239 <tr><td valign="middle">M=<var>QuantumRange</var>*(M−K)/(<var>QuantumRange</var>−K)</td></tr>
1240 <tr><td valign="middle">Y=<var>QuantumRange</var>*(Y−K)/(<var>QuantumRange</var>−K)</td></tr>
1241
1242 <tr><th valign="middle">Gray</th></tr>
1243 <tr><td valign="middle">Gray = 0.298839*R+0.586811*G+0.114350*B</td></tr>
1244
1245 <tr><th valign="middle">HSB — Hue, Saturation, Brightness; like a cone peak downward</th></tr>
1246 <tr><td valign="middle">H=angle around perimeter (0 to 360 deg); H=0 is red; increasing angles toward green</td></tr>
1247 <tr><td valign="middle">S=distance from axis outward</td></tr>
1248 <tr><td valign="middle">B=distance along axis from bottom upward; B=max(R,G,B); <var>intensity-like</var></td></tr>
1249
1250 <tr><th valign="middle">HSL — Hue, Saturation, Lightness; like a double cone end-to-end with peaks at very top and bottom</th></tr>
1251 <tr><td valign="middle">H=angle around perimeter (0 to 360 deg); H=0 is red; increasing angles toward green</td></tr>
1252 <tr><td valign="middle">S=distance from axis outward</td></tr>
1253 <tr><td valign="middle">L=distance along axis from bottom upward; L=0.5*max(R,G,B) + 0.5*min(R,G,B); <var>intensity-like</var></td></tr>
1254
1255 <tr><th valign="middle">HWB — Hue, Whiteness, Blackness</th></tr>
1256 <tr><td valign="middle">Hue (complicated equation)</td></tr>
1257 <tr><td valign="middle">Whiteness (complicated equation)</td></tr>
1258 <tr><td valign="middle">Blackness (complicated equation)</td></tr>
1259
1260 <tr><th valign="middle">LAB</th></tr>
1261 <tr><td valign="middle">L (complicated equation relating X,Y,Z)</td></tr>
1262 <tr><td valign="middle">A (complicated equation relating X,Y,Z)</td></tr>
1263 <tr><td valign="middle">B (complicated equation relating X,Y,Z)</td></tr>
1264
1265 <tr><th valign="middle">LOG</th></tr>
1266 <tr><td valign="middle">I1 (complicated equation involving logarithm of R)</td></tr>
1267 <tr><td valign="middle">I2 (complicated equation involving logarithm of G)</td></tr>
1268 <tr><td valign="middle">I3 (complicated equation involving logarithm of B)</td></tr>
1269
1270 <tr><th valign="middle">OHTA — approximates principal components transformation</th></tr>
1271 <tr><td valign="middle">I1=0.33333*R+0.33334*G+0.33333*B; <var>intensity-like</var></td></tr>
1272 <tr><td valign="middle">I2=(0.50000*R+0.00000*G−0.50000*B)*(<var>QuantumRange</var>+1)/2</td></tr>
1273 <tr><td valign="middle">I3=(−0.25000*R+0.50000*G−0.25000*B)*(<var>QuantumRange</var>+1)/2</td></tr>
1274
1275 <tr><th valign="middle">Rec601Luma</th></tr>
1276 <tr><td valign="middle">Gray = 0.298839*R+0.586811*G+0.114350*B</td></tr>
1277
1278 <tr><th valign="middle">Rec601YCbCr</th></tr>
1279 <tr><td valign="middle">Y=0.2988390*R+0.5868110*G+0.1143500*B; <var>intensity-like</var></td></tr>
1280 <tr><td valign="middle">Cb=(−0.168736*R-0.331264*G+0.500000*B)*(<var>QuantumRange</var>+1)/2</td></tr>
1281 <tr><td valign="middle">Cr=(0.500000*R−0.418688*G−0.081312*B)*(<var>QuantumRange</var>+1)/2</td></tr>
1282
1283 <tr><th valign="middle">Rec709Luma</th></tr>
1284 <tr><td valign="middle">Gray=0.212656*R+0.715158*G+0.072186*B</td></tr>
1285
1286 <tr><th valign="middle">Rec709YCbCr</th></tr>
1287 <tr><td valign="middle">Y=0.212656*R+0.715158*G+0.072186*B; <var>intensity-like</var></td></tr>
1288 <tr><td valign="middle">Cb=(−0.114572*R−0.385428*G+0.500000*B)+(<var>QuantumRange</var>+1)/2</td></tr>
1289 <tr><td valign="middle">Cr=(0.500000*R−0.454153*G−0.045847*B)+(<var>QuantumRange</var>+1)/2</td></tr>
1290
1291 <tr><th valign="middle">sRGB</th></tr>
1292 <tr><td valign="middle">if R ≤ .0.0031308 then Rs=R/12.92 else Rs=1.055 R ^ (1.0 / 2.4) ? 0.055</td></tr>
1293 <tr><td valign="middle">if G ≤ .0.0031308 then Gs=B/12.92 else Gs=1.055 R ^ (1.0 / 2.4) ? 0.055</td></tr>
1294 <tr><td valign="middle">if B ≤ .0.0031308 then Bs=B/12.92 else Bs=1.055 R ^ (1.0 / 2.4) ? 0.055</td></tr>
1295
1296 <tr><th valign="middle">XYZ</th></tr>
1297 <tr><td valign="middle">X=0.4124564*R+0.3575761*G+0.1804375*B</td></tr>
1298 <tr><td valign="middle">Y=0.2126729*R+0.7151522*G+0.0721750*B</td></tr>
1299 <tr><td valign="middle">Z=0.0193339*R+0.1191920*G+0.9503041*B</td></tr>
1300
1301 <tr><th valign="middle">YCC</th></tr>
1302 <tr><td valign="middle">Y=(0.298839*R+0.586811*G+0.114350*B) (with complicated scaling); <var>intensity-like</var></td></tr>
1303 <tr><td valign="middle">C1=(−0.298839*R−0.586811*G+0.88600*B) (with complicated scaling)</td></tr>
1304 <tr><td valign="middle">C2=(0.70100*R−0.586811*G−0.114350*B) (with complicated scaling)</td></tr>
1305
1306 <tr><th valign="middle">YCbCr</th></tr>
1307 <tr><td valign="middle">Y=0.2988390*R+0.5868110*G+0.1143500*B; <var>intensity-like</var></td></tr>
1308 <tr><td valign="middle">Cb=(−0.168736*R−0.331264*G+0.500000*B)*(<var>QuantumRange</var>+1)/2</td></tr>
1309 <tr><td valign="middle">Cr=(0.500000*R−0.418688*G−0.081312*B)*(<var>QuantumRange</var>+1)/2</td></tr>
1310
1311 <tr><th valign="middle">YIQ</th></tr>
1312 <tr><td valign="middle">Y=0.298839*R+0.586811*G+0.114350*B; <var>intensity-like</var></td></tr>
1313 <tr><td valign="middle">I=(0.59600*R−0.27400*G−0.32200*B)*(<var>QuantumRange</var>+1)/2</td></tr>
1314 <tr><td valign="middle">Q=(0.21100*R−0.52300*G+0.31200*B)*(<var>QuantumRange</var>+1)/2</td></tr>
1315
1316 <tr><th valign="middle">YPbPr</th></tr>
1317 <tr><td valign="middle">Y=0.2988390*R+0.5868110*G+0.1143500*B; <var>intensity-like</var></td></tr>
1318 <tr><td valign="middle">Pb=(−0.168736*R−0.331264*G+0.500000*B)*(<var>QuantumRange</var>+1)/2</td></tr>
1319 <tr><td valign="middle">Pr=(0.500000*R−0.418688*G−0.081312*B)*(<var>QuantumRange</var>+1)/2</td></tr>
1320
1321 <tr><th valign="middle">YUV</th></tr>
1322 <tr><td valign="middle">Y=0.298839*R+0.586811*G+0.114350*B; <var>intensity-like</var></td></tr>
1323 <tr><td valign="middle">U=(−0.14740*R−0.28950*G+0.43690*B)*(<var>QuantumRange</var>+1)/2</td></tr>
1324 <tr><td valign="middle">V=(0.61500*R−0.51500*G−0.10000*B)*(<var>QuantumRange</var>+1)/2</td></tr>
1325</table>
1326
1327<p>Note the scRGB colorspace requires HDRI support otherwise it behaves just like linear RGB.</p>
1328
Cristyd474b372017-02-14 12:19:13 -05001329<p>Use the <code>Undefined</code> colorspace to identify multi-spectral images.</p>
1330
Cristy882d9f42015-10-29 16:48:39 -04001331<div style="margin: auto;">
1332 <h3 class="magick-header"><a id="combine"></a>-combine</h3>
1333</div>
1334
1335<p class="magick-description">Combine one or more images into a single image.</p>
1336
1337<p>The channels (previously set by <a href="command-line-options.html#channel">-channel</a>) of the
1338combined image are taken from the grayscale values of each image in the
1339sequence, in order. For the default -channel setting of <code>RGB</code>, this
1340means the first image is assigned to the <code>Red</code> channel, the second
1341to the <code>Green</code> channel, the third to the <code>Blue</code>.</p>
1342
Cristy594d2772015-11-15 10:47:42 -05001343<p>This option can be thought of as the inverse to <a
1344href="command-line-options.html#separate">-separate</a>, so long as the channel settings are the same.
Cristy882d9f42015-10-29 16:48:39 -04001345Thus, in the following example, the final image should be a copy of the
1346original. </p>
1347
1348<pre>
1349convert original.png -channel RGB -separate sepimage.png
1350convert sepimage-0.png sepimage-1.png sepimage-2.png -channel RGB \
1351 -combine imagecopy.png
1352</pre>
1353
1354<div style="margin: auto;">
1355 <h3 class="magick-header"><a id="comment"></a>-comment <var>string</var></h3>
1356</div>
1357
1358<p class="magick-description">Embed a comment in an image.</p>
1359
1360<p>This option sets the comment meta-data of an image read in after this
1361option has been given. To modify a comment of images already in memory use
1362"<code><a href="command-line-options.html#set">-set</a> comment</code>". </p>
1363
Cristy594d2772015-11-15 10:47:42 -05001364<p>The comment can contain special format characters listed in the <a
1365href="escape.html">Format and
Cristy882d9f42015-10-29 16:48:39 -04001366Print Image Properties</a>. These attributes are expanded when the comment
1367is finally assigned to the individual images. </p>
1368
1369<p>If the first character of <var>string</var> is <var>@</var>, the image comment is read from a file titled by the
1370remaining characters in the string. Comments read in from a file are literal;
1371no embedded formatting characters are recognized.</p>
1372
1373<p>Comment meta-data are not visible on the image itself. To do that use the
1374<a href="command-line-options.html#annotate">-annotate</a> or <a href="command-line-options.html#draw">-draw</a> options
1375instead.</p>
1376
1377<p>For example,</p>
1378
1379<pre>
1380-comment "%m:%f %wx%h" bird.miff
1381</pre>
1382
1383<p>produces an image comment of <code>MIFF:bird.miff 512x480</code> (assuming
1384that the image <code>bird.miff</code> has a width of 512 and a height of
1385480.</p>
1386
1387<div style="margin: auto;">
1388 <h3 class="magick-header"><a id="compare"></a>-compare</h3>
1389</div>
1390
1391<p class="magick-description">mathematically and visually annotate the difference between an image and its reconstruction</p>
1392
1393<p>This is a convert version of "<code>compare</code>" for two same sized images. The syntax is as follows, but other metrics are allowed.</p>
1394
1395<pre>
Cristy594d2772015-11-15 10:47:42 -05001396convert image.png reference.png -metric RMSE -compare \ <br/> difference.png
Cristy882d9f42015-10-29 16:48:39 -04001397</pre>
1398
1399<p>To get the metric value use the string format "%[distortion]".</p>
1400
1401<pre>
1402convert image.png reference.png -metric RMSE -compare -format \
1403 "%[distortion]" info:
1404</pre>
1405
1406<div style="margin: auto;">
1407 <h3 class="magick-header"><a id="complex"></a>-complex <var>operator</var></h3>
1408</div>
1409
1410<p class="magick-description">perform complex mathematics on an image sequence</p>
1411
1412Choose from these operators:
1413
1414<pre>
1415add
1416conjugate
1417divide
1418magnitude-phase
1419multiply
1420real-imaginary
1421subtract
1422</pre>
1423
1424<p>Optionally specify the <code>divide</code> operator SNR with <code><a href="command-line-options.html#define">-define</a> complex:snr=float</code>.</p>
1425
1426<div style="margin: auto;">
1427 <h3 class="magick-header"><a id="compose"></a>-compose <var>operator</var></h3>
1428</div>
1429
1430<p class="magick-description">Set the type of image composition.</p>
1431
Cristy6549abb2016-11-10 08:25:55 -05001432<p>See <a href="http://www.imagemagick.org/www/compose.html">Alpha Compositing</a> for
Cristy882d9f42015-10-29 16:48:39 -04001433a detailed discussion of alpha compositing.</p>
1434
1435<p>This setting effects image processing operators that merge two (or more)
1436images together in some way. This includes the operators,
1437<a href="command-line-options.html#composite">-compare</a>,
1438<a href="command-line-options.html#composite">-composite</a>,
1439<a href="command-line-options.html#layers">-layers</a> composite,
1440<a href="command-line-options.html#flatten">-flatten</a>,
1441<a href="command-line-options.html#mosaic">-mosaic</a>,
1442<a href="command-line-options.html#layers">-layers</a> merge,
1443<a href="command-line-options.html#border">-border</a>,
1444<a href="command-line-options.html#frame">-frame</a>,
1445and <a href="command-line-options.html#extent">-extent</a>. </p>
1446
1447<p>It is also one of the primary options for the "<code>composite</code>"
1448command. </p>
1449
1450
1451<div style="margin: auto;">
1452 <h3 class="magick-header"><a id="composite"></a>-composite</h3>
1453</div>
1454
1455<p class="magick-description">Perform alpha composition on two images and an optional mask</p>
1456
1457<p>Take the first image 'destination' and overlay the second 'source' image
1458according to the current <a href="command-line-options.html#compose">-compose</a> setting. The location
Cristy594d2772015-11-15 10:47:42 -05001459of the 'source' or 'overlay' image is controlled according to <a
Cristye93be682015-11-26 09:07:51 -05001460href="command-line-options.html#gravity" >-gravity</a>, and <a href="command-line-options.html#geometry" >-geometry</a>
Cristy882d9f42015-10-29 16:48:39 -04001461settings. </p>
1462
Cristy769d8892016-01-19 18:11:14 -05001463<p>If a third image is given this is treated as a grayscale blending 'mask' image
Cristy882d9f42015-10-29 16:48:39 -04001464relative to the first 'destination' image. This mask is blended with the
1465source image. However for the '<code>displace</code>' compose method, the
1466mask is used to provide a separate Y-displacement image instead. </p>
1467
1468<p>If a <a href="command-line-options.html#compose">-compose</a> method requires extra numerical
Cristy594d2772015-11-15 10:47:42 -05001469arguments or flags these can be provided by setting the <a
1470href="command-line-options.html#set">-set</a> '<code>option:compose:args</code>'
Cristy882d9f42015-10-29 16:48:39 -04001471appropriately for the compose method. </p>
1472
1473<p>Some <a href="command-line-options.html#compose">-compose</a> methods can modify the 'destination'
Cristy594d2772015-11-15 10:47:42 -05001474image outside the overlay area. You can disable this by setting the special <a
1475href="command-line-options.html#set">-set</a> '<code>option:compose:outside-overlay</code>'
Cristy882d9f42015-10-29 16:48:39 -04001476to '<code>false</code>'. </p>
1477
1478<p>The SVG compositing specification requires that color and opacity values range between zero and QuantumRange inclusive. You can permit values outside this range with this option: <a href="command-line-options.html#set">-set</a> '<code>option:compose:clamp=false</code></p>
1479
1480
1481<div style="margin: auto;">
1482 <h3 class="magick-header"><a id="compress"></a>-compress <var>type</var></h3>
1483</div>
1484
1485<p class="magick-description">Use pixel compression specified by <var>type</var> when writing the image.</p>
1486
Cristy594d2772015-11-15 10:47:42 -05001487<p>Choices are: <code>None</code>, <code>BZip</code>, <code
1488>Fax</code>, <code>Group4</code>, <code
1489>JPEG</code>, <code>JPEG2000</code>, <code
1490>Lossless</code>, <code>LZW</code>, <code
1491>RLE</code> or <code>Zip</code>.</p>
Cristy882d9f42015-10-29 16:48:39 -04001492
1493<p>To print a complete list of compression types, use <a href="command-line-options.html#list">-list
1494compress</a>.</p>
1495
1496<p>Specify <a href="command-line-options.html#compress">+compress</a> to store the binary image in an
1497uncompressed format. The default is the compression type of the specified
1498image file.</p>
1499
1500<p>If <code>LZW</code> compression is specified but LZW compression has not been
1501enabled, the image data is written in an uncompressed LZW format that can be
1502read by LZW decoders. This may result in larger-than-expected GIF files.</p>
1503
1504<p><code>Lossless</code> refers to lossless JPEG, which is only available if the
1505JPEG library has been patched to support it. Use of lossless JPEG is generally
1506not recommended.</p>
1507
1508<p>
1509When writing an ICO file, you may request that the images be encoded in
1510PNG format, by specifying <code>Zip</code> compression.</p>
1511
1512<p>
1513When writing a JNG file, specify <code>Zip</code> compression to request that
1514the alpha channel be encoded in PNG "IDAT" format, or <code>JPEG</code>
1515to request that it be encoded in JPG "JDAA" format.</p>
1516
1517<p>Use the <a href="command-line-options.html#quality">-quality</a> option to set the compression level
1518to be used by JPEG, PNG, MIFF, and MPEG encoders.
1519Use the <a href="command-line-options.html#sampling-factor">-sampling-factor</a> option to set the
1520sampling factor to be used by JPEG, MPEG, and YUV encoders for down-sampling
1521the chroma channels.</p>
1522
1523<div style="margin: auto;">
1524 <h3 class="magick-header"><a id="connected-components"></a>-connected-components <var>connectivity</var></h3>
1525</div>
1526
Cristyce4a3552015-12-14 13:53:35 -05001527<p class="magick-description"><a href="connected-components.html">connected-components</a> labeling detects connected regions in an image, choose from 4 or 8 way connectivity.</p>
Cristy882d9f42015-10-29 16:48:39 -04001528
Cristy594d2772015-11-15 10:47:42 -05001529<p>Use <code><a href="command-line-options.html#define" >-define</a> connected-components:verbose=true</code> to output statistics associated with each unique label.</p>
Cristy882d9f42015-10-29 16:48:39 -04001530
1531<div style="margin: auto;">
1532 <h3 class="magick-header"><a id="contrast"></a>-contrast</h3>
1533</div>
1534
1535<p class="magick-description">Enhance or reduce the image contrast.</p>
1536
1537<p>This option enhances the intensity differences between the lighter and
1538darker elements of the image. Use <a href="command-line-options.html#contrast">-contrast</a> to enhance
1539the image or <a href="command-line-options.html#contrast">+contrast</a> to reduce the image
1540contrast.</p>
1541
1542<p>For a more pronounced effect you can repeat the option:</p>
1543
1544<pre>
1545convert rose: -contrast -contrast rose_c2.png
1546</pre>
1547
1548<div style="margin: auto;">
Cristy769d8892016-01-19 18:11:14 -05001549 <h3 class="magick-header"><a id="contrast-stretch"></a>-contrast-stretch <var>black-point</var><br />-contrast-stretch <var>black-point</var>{x<var>white-point</var>}{<var>%</var>}</h3>
Cristy882d9f42015-10-29 16:48:39 -04001550</div>
1551
1552<p class="magick-description">Increase the contrast in an image by <var>stretching</var> the range of intensity values.</p>
1553
1554<p>While performing the stretch, black-out at most <var>black-point</var> pixels and white-out at most <var>white-point</var> pixels. Or, if percent is used, black-out at most
Cristy594d2772015-11-15 10:47:42 -05001555<var >black-point %</var> pixels and white-out at most <var>white-point %</var> pixels.</p>
Cristy882d9f42015-10-29 16:48:39 -04001556
Cristy594d2772015-11-15 10:47:42 -05001557<p>Prior to ImageMagick 6.4.7-0, <a href="command-line-options.html#contrast-stretch"
1558>-contrast-stretch</a> will black-out at most <var>black-point</var> pixels and white-out at most <var >total pixels
Cristy882d9f42015-10-29 16:48:39 -04001559minus white-point</var> pixels. Or, if percent is used, black-out at most <var>black-point %</var> pixels and white-out at most <var>100% minus white-point %</var> pixels.</p>
1560
1561<p>Note that <code>-contrast-stretch 0</code> will modify the image such that
1562the image's min and max values are stretched to 0 and <var>QuantumRange</var>, respectively, without any loss of data due to burn-out or
Cristy594d2772015-11-15 10:47:42 -05001563clipping at either end. This is not the same as <a href="command-line-options.html#normalize"
1564>-normalize</a>, which is equivalent to <code>-contrast-stretch 0.15x0.05%</code> (or
Cristy882d9f42015-10-29 16:48:39 -04001565prior to ImageMagick 6.4.7-0, <code>-contrast-stretch 2%x99%</code>).</p>
1566
1567<p>Internally operator works by creating a histogram bin, and then uses that
1568bin to modify the image. As such some colors may be merged together when they
1569originally fell into the same 'bin'. </p>
1570
Cristy769d8892016-01-19 18:11:14 -05001571<p>All the channels are normalized in concert by the same amount so as to
Cristy594d2772015-11-15 10:47:42 -05001572preserve color integrity, when the default <a href="command-line-options.html#channel" >+channel</a>
1573setting is in use. Specifying any other <a href="command-line-options.html#channel" >-channel</a>
Cristy882d9f42015-10-29 16:48:39 -04001574setting will normalize the RGB channels independently.</p>
1575
Cristy594d2772015-11-15 10:47:42 -05001576<p>See also <a href="command-line-options.html#auto-level" >-auto-level</a> for a 'perfect'
Cristy882d9f42015-10-29 16:48:39 -04001577normalization of mathematical images. </p>
1578
1579<p>This operator is under review for re-development. </p>
1580
1581
1582<div style="margin: auto;">
1583 <h3 class="magick-header"><a id="convolve"></a>-convolve <var>kernel</var></h3>
1584</div>
1585
1586<p class="magick-description">Convolve an image with a user-supplied convolution kernel.</p>
1587
1588<p>The <var>kernel</var> is a matrix specified as
1589a comma-separated list of integers (with no spaces), ordered left-to right,
1590starting with the top row. Presently, only odd-dimensioned kernels are
1591supported, and therefore the number of entries in the specified <var>kernel</var> must be 3<sup>2</sup>=9, 5<sup>2</sup>=25,
15927<sup>2</sup>=49, etc. </p>
1593
Cristy594d2772015-11-15 10:47:42 -05001594<p>Note that the <a href="command-line-options.html#convolve">&#x2011;convolve</a> operator supports the <a href="command-line-options.html#bias">&#x2011;bias</a> setting. This option shifts the convolution so that
Cristy882d9f42015-10-29 16:48:39 -04001595positive and negative results are relative to a user-specified bias value.
1596This is important for non-HDRI compilations of ImageMagick when dealing with
1597convolutions that contain negative as well as positive values. This is
1598especially the case with convolutions involving high pass filters or edge
1599detection. Without an output bias, the negative values is clipped at zero.
1600</p>
1601
Cristy594d2772015-11-15 10:47:42 -05001602<p>When using an ImageMagick with the HDRI compile-time setting, <a href="command-line-options.html#bias">&#x2011;bias</a> is not needed, as ImageMagick is able to store/handle any
Cristy882d9f42015-10-29 16:48:39 -04001603negative results without clipping to the color value range (0..QuantumRange).
Cristy594d2772015-11-15 10:47:42 -05001604See the discussion on HDRI implementations of ImageMagick on the page <a
1605href="high-dynamic-range.html">High
1606Dynamic-Range Images</a>. For more about HDRI go the ImageMagick <a
Cristy364a72f2016-11-04 22:38:41 -04001607href="https://www.imagemagick.org/Usage/basics/#hdri">Usage</a> pages or this
Cristy882d9f42015-10-29 16:48:39 -04001608<a href="http://en.wikipedia.org/wiki/High_dynamic_range_imaging">Wikipedia</a>
1609entry. </p>
1610
1611
1612<div style="margin: auto;">
1613 <h3 class="magick-header"><a id="copy"></a>-copy <var>geometry</var> <var>offset</var></h3>
1614</div>
1615
1616<p class="magick-description">copy pixels from one area of an image to another.</p>
1617
1618<div style="margin: auto;">
1619 <h3 class="magick-header"><a id="crop"></a>-crop <var>geometry</var>{<var>@</var>}{<var>!</var>}</h3>
1620</div>
1621
1622<p class="magick-description">Cut out one or more rectangular regions of the image.</p>
1623
1624<p>See <a href="command-line-processing.html#geometry">Image Geometry</a> for complete details about the <em class="arg">geometry</em> argument.</p>
1625
1626<p>The <var>width</var> and <var>height</var> of the <var>geometry</var> argument give the size of the image that remains
1627after cropping, and <var>x</var> and <var>y</var> in the
1628<var>offset</var> (if present) gives the location of the top left
1629corner of the cropped image with respect to the original image. To specify the
1630amount to be removed, use <a href="command-line-options.html#shave">-shave</a> instead.</p>
1631
1632<p>If the <var>x</var> and <var>y</var> offsets are
1633present, a single image is generated, consisting of the pixels from the
1634cropping region. The offsets specify the location of the upper left corner of
1635the cropping region measured downward and rightward with respect to the upper
1636left corner of the image. If the <a href="command-line-options.html#gravity">-gravity</a> option is
1637present with <code>NorthEast</code>, <code>East</code>, or <code>SouthEast</code>
1638gravity, it gives the distance leftward from the right edge of the image to
Cristy594d2772015-11-15 10:47:42 -05001639the right edge of the cropping region. Similarly, if the <a
1640href="command-line-options.html#gravity">-gravity</a> option is present with <code>SouthWest</code>,
Cristy882d9f42015-10-29 16:48:39 -04001641<code>South</code>, or <code>SouthEast</code> gravity, the distance is measured
1642upward between the bottom edges.</p>
1643
1644<p>If the <var>x</var> and <var>y</var> offsets are
1645omitted, a set of tiles of the specified geometry, covering the entire input
1646image, is generated. The rightmost tiles and the bottom tiles are smaller if
1647the specified geometry extends beyond the dimensions of the input image.</p>
1648
1649<p>You can add the <var>@</var> to the geometry argument to equally divide the image into the number of tiles generated.</p>
1650
1651<p>By adding a exclamation character flag to the geometry argument, the
1652cropped images virtual canvas page size and offset is set as if the
1653geometry argument was a viewport or window. This means the canvas page size
1654is set to exactly the same size you specified, the image offset set
1655relative top left corner of the region cropped. </p>
1656
1657<p>If the cropped image 'missed' the actual image on its virtual canvas, a
1658special single pixel transparent 'missed' image is returned, and a 'crop
1659missed' warning given. </p>
1660
Cristy594d2772015-11-15 10:47:42 -05001661<p>It might be necessary to <a href="command-line-options.html#repage" >+repage</a> the image prior to
Cristy882d9f42015-10-29 16:48:39 -04001662cropping the image to ensure the crop coordinate frame is relocated to the
1663upper-left corner of the visible image.
1664
Cristy594d2772015-11-15 10:47:42 -05001665Similarly you may want to use <a href="command-line-options.html#repage" >+repage</a> after cropping to
Cristy882d9f42015-10-29 16:48:39 -04001666remove the page offset that will be left behind. This is especially true when
1667you are going to write to an image format such as PNG that supports an image
1668offset.</p>
1669
1670<div style="margin: auto;">
1671 <h3 class="magick-header"><a id="cycle"></a>-cycle <var>amount</var></h3>
1672</div>
1673
1674<p class="magick-description">displace image colormap by amount.</p>
1675
1676<p><var>Amount</var> defines the number of positions each
1677colormap entry is shifted.</p>
1678
1679
1680<div style="margin: auto;">
1681 <h3 class="magick-header"><a id="debug"></a>-debug <var>events</var></h3>
1682</div>
1683
1684<p class="magick-description">enable debug printout.</p>
1685
1686<p>The <code>events</code> parameter specifies which events are to be logged. It
1687can be either <code>None</code>, <code>All</code>, <code>Trace</code>, or
1688a comma-separated list consisting of one or more of the following domains:
1689<code>Accelerate</code>, <code>Annotate</code>, <code>Blob</code>, <code>Cache</code>,
1690<code>Coder</code>, <code>Configure</code>, <code>Deprecate</code>,
1691<code>Exception</code>, <code>Locale</code>, <code>Render</code>,
1692<code>Resource</code>, <code>Security</code>, <code>TemporaryFile</code>,
1693<code>Transform</code>, <code>X11</code>, or <code>User</code>. </p>
1694
1695
1696<p>For example, to log cache and blob events, use.</p>
1697
1698<pre>
1699convert -debug "Cache,Blob" rose: rose.png
1700</pre>
1701
1702<p>The <code>User</code> domain is normally empty, but developers can log user
1703events in their private copy of ImageMagick.</p>
1704
1705<p>To print the complete list of debug methods, use <a href="command-line-options.html#list">-list
1706debug</a>.</p>
1707
1708<p>Use the <a href="command-line-options.html#log">-log</a> option to specify the format for debugging
1709output.</p>
1710
1711<p>Use <a href="command-line-options.html#debug">+debug</a> to turn off all logging.</p>
1712
Cristy594d2772015-11-15 10:47:42 -05001713<p>Debugging may also be set using the <code>MAGICK_DEBUG</code> <a href="resources.html#environment"
1714>environment variable</a>. The allowed values for the <code>MAGICK_DEBUG</code>
Cristy882d9f42015-10-29 16:48:39 -04001715environment variable are the same as for the <a href="command-line-options.html#debug">-debug</a>
1716option.</p>
1717
1718
1719<div style="margin: auto;">
1720 <h3 class="magick-header"><a id="decipher"></a>-decipher <var>filename</var></h3>
1721</div>
1722
1723<p class="magick-description">Decipher and restore pixels that were previously transformed by <a href="command-line-options.html#encipher">-encipher</a>.</p>
1724
1725<p>Get the passphrase from the file specified by <var>filename</var>.</p>
1726
Cristy594d2772015-11-15 10:47:42 -05001727<p>For more information, see the webpage, <a
Cristy6549abb2016-11-10 08:25:55 -05001728href="https://www.imagemagick.org/script/cipher.html">ImageMagick: Encipher or
Cristy882d9f42015-10-29 16:48:39 -04001729Decipher an Image</a>.</p>
1730
1731
1732<div style="margin: auto;">
1733 <h3 class="magick-header"><a id="deconstruct"></a>-deconstruct</h3>
1734</div>
1735
1736<p class="magick-description">find areas that has changed between images </p>
1737
Cristy594d2772015-11-15 10:47:42 -05001738<p>Given a sequence of images all the same size, such as produced by <a
1739href="command-line-options.html#coalesce">-coalesce</a>, replace the second and later images, with
Cristy882d9f42015-10-29 16:48:39 -04001740a smaller image of just the area that changed relative to the previous image.
1741</p>
1742
1743<p>The resulting sequence of images can be used to optimize an animation
1744sequence, though will not work correctly for GIF animations when parts of the
1745animation can go from opaque to transparent. </p>
1746
1747<p>This option is actually equivalent to the <a href="command-line-options.html#layers">-layers</a>
1748method '<code>compare-any</code>'. </p>
1749
1750
1751<div style="margin: auto;">
1752 <h3 class="magick-header"><a id="define"></a>-define <var>key</var>{<var>=value</var>}<var>...</var></h3>
1753</div>
1754
1755<p class="magick-description">add specific global settings generally used to control coders and image processing operations.</p>
1756
1757<p>This option creates one or more definitions for coders and decoders to use
1758while reading and writing image data. Definitions are generally used to
1759control image file format coder modules, and image processing operations,
Cristy594d2772015-11-15 10:47:42 -05001760beyond what is provided by normal means. Defined settings are listed in <a
1761href="command-line-options.html#verbose" >-verbose</a> information ("<code>info:</code>" output format)
Cristy882d9f42015-10-29 16:48:39 -04001762as "Artifacts". </p>
1763
1764<p>If <var>value</var> is missing for a definition, an empty-valued
1765definition of a flag is created with that name. This used to control on/off
1766options. Use <a href="command-line-options.html#define">+define key</a> to remove definitions
1767previously created. Use <a href="command-line-options.html#define">+define "*"</a> to remove all
1768existing definitions.</p>
1769
Cristy594d2772015-11-15 10:47:42 -05001770<p>The same 'artifact' settings can also be defined using the <a
1771href="command-line-options.html#set" >-set "option:<var>key</var>" "<var>value</var>"</a> option, which also allows the use of <a href="escape.html" >Format and Print Image
Cristy882d9f42015-10-29 16:48:39 -04001772Properties</a> in the defined value. </p>
1773
1774<p>The <var>option</var> and <var>key</var> are case-independent (they are
1775converted to lowercase for use within the decoders) while the <var>value</var>
1776is case-dependent.</p>
1777
1778<p>Such settings are global in scope, and affect all images and operations. </p>
1779
1780<p>The following definitions are just some of the artifacts that are
1781available:</p>
1782
1783<table class="table table-condensed table-striped">
1784 <tr>
Cristye0779712016-07-30 17:25:22 -04001785 <td>bmp:alpha=<var>true|false</var></td>
1786 <td>include any alpha channel when writing in the BMP image format.</td>
1787 </tr>
1788
1789 <tr>
Cristy882d9f42015-10-29 16:48:39 -04001790 <td>bmp:format=<var>value</var></td>
1791 <td> valid values are <var>bmp2</var>, <var>bmp3</var>,
1792 and <var>bmp4</var>. This option can be useful when the
1793 method of prepending "BMP2:" to the output filename is inconvenient or
1794 is not available, such as when using the <a href="mogrify.html">mogrify</a> utility.</td>
1795 </tr>
1796
1797 <tr>
1798 <td>colorspace:auto-grayscale=<var>on|off</var></td>
Cristyd474b372017-02-14 12:19:13 -05001799 <td>prevent automatic conversion to grayscale inside coders that support
1800 grayscale. This should be accompanied by -type truecolor. PNG and TIF do
1801 not need this define. With PNG, just use PNG24:image. With TIF, just use
1802 -type truecolor. JPG and PSD will need this define.</td>
Cristy882d9f42015-10-29 16:48:39 -04001803 </tr>
1804
1805 <tr>
1806 <td>complex:snr=<var>value</var></td>
1807 <td>Set the divide SNR constant<a href="command-line-options.html#complex">-complex</a></td>
1808 </tr>
1809
1810 <tr>
1811 <td>compose:args=<var>arguments</var></td>
1812 <td>Sets certain compose argument values when using convert ... -compose ...
Cristy1f1f3a02016-06-01 07:25:42 -04001813 -composite. See <a href="compose.html"
Cristy594d2772015-11-15 10:47:42 -05001814 >Image Composition</a></td>
Cristy882d9f42015-10-29 16:48:39 -04001815 </tr>
1816
1817 <tr>
1818 <td>compose:clamp=<var>on|off</var></td>
Cristyd474b372017-02-14 12:19:13 -05001819 <td>set each pixel whose value is below zero to zero and any the pixel
1820 whose value is above the quantum range to the quantum range (e.g. 65535)
1821 otherwise the pixel value remains unchanged. Define supported in
Cristybc232422016-11-22 07:46:18 -05001822 ImageMagick 6.9.1-3 and above.</td>
Cristy882d9f42015-10-29 16:48:39 -04001823 </tr>
1824
1825 <tr>
Cristyde27d762016-01-02 12:56:44 -05001826 <td>connected-components:area-threshold=<var>value</var></td>
1827 <td>Merges any region with area smaller than <var>value</var> into its surrounding region or largest neighbor.</td>
1828 </tr>
1829
1830 <tr>
1831 <td>connected-components:keep=<var>list-of-ids</var></td>
Cristybc232422016-11-22 07:46:18 -05001832 <td>Comma and/or hyphenated list of id values to keep in the output.
1833 Supported in Imagemagick 6.9.3-0.</td>
Cristyde27d762016-01-02 12:56:44 -05001834 </tr>
1835
1836 <tr>
1837 <td>connected-components:mean-color=<var>true</var></td>
Cristybc232422016-11-22 07:46:18 -05001838 <td>Changes the output image from id values to mean color values. Supported
1839 in Imagemagick 6.9.2-8.</td>
Cristyde27d762016-01-02 12:56:44 -05001840 </tr>
1841
1842 <tr>
1843 <td>connected-components:remove=<var>list-of-ids</var></td>
Cristybc232422016-11-22 07:46:18 -05001844 <td>Comma and/or hyphenated list of id values to remove from the output.
1845 Supported in Imagemagick 6.9.2-9.</td>
Cristyde27d762016-01-02 12:56:44 -05001846 </tr>
1847
1848 <tr>
1849 <td>connected-components:verbose=<var>true</var></td>
1850 <td>Lists id, bounding box, centroid, area, mean color for each region.</td>
1851 </tr>
1852
1853 <tr>
Cristy882d9f42015-10-29 16:48:39 -04001854 <td>convolve:scale=<var>{kernel_scale}[!^] [,{origin_addition}] [%]</var></td>
1855 <td>Defines the kernel scaling. The special flag ! automatically scales to
1856 full dynamic range. The ! flag can be used in combination with a factor or
1857 percent. The factor or percent is then applied after the automatic scaling.
1858 An example is 50%!. This produces a result 50% darker than full dynamic
1859 range scaling. The ^ flag assures the kernel is 'zero-summing', for
1860 example when some values are positive and some are negative as in edge
1861 detection kernels. The origin addition adds that value to the center
1862 pixel of the kernel. This produces and effect that is like adding the image
1863 that many times to the result of the filtered image. The typical value
1864 is 1 so that the original image is added to the result of the convolution.
1865 The default is 0.</td>
1866 </tr>
1867
1868 <tr>
1869 <td>convolve:showkernel=<var>1</var></td>
Cristy594d2772015-11-15 10:47:42 -05001870 <td>Outputs (to 'standard error') all the information about a specified <a
1871 href="command-line-options.html#morphology" >-morphology convolve</a> kernel.</td>
Cristy882d9f42015-10-29 16:48:39 -04001872 </tr>
1873
1874 <tr>
1875 <td>dcm:display-range=<var>reset</var></td>
1876 <td>Sets the display range to the minimum and maximum pixel values for the
1877 DCM image format.</td>
1878 </tr>
1879
1880 <tr>
1881 <td>dds:cluster-fit=<var>true|false</var></td>
1882 <td>Enables the dds cluster-fit.</td>
1883 </tr>
1884
1885 <tr>
1886 <td>dds:compression=<var>dxt1|dxt5|none</var></td>
1887 <td>Sets the dds compression.</td>
1888 </tr>
1889
1890 <tr>
1891 <td>dds:mipmaps=<var>value</var></td>
1892 <td>Sets the dds number of mipmaps.</td>
1893 </tr>
1894
1895 <tr>
Cristy3b0b58d2016-11-06 07:40:23 -05001896 <td>dds:weight-by-alpha=<var>true|false</var></td>
Cristy882d9f42015-10-29 16:48:39 -04001897 <td>Enables the dds alpha weighting.</td>
1898 </tr>
1899
1900 <tr>
Cristy3b0b58d2016-11-06 07:40:23 -05001901 <td>deskew:auto-crop=<var>true</var></td>
1902 <td>auto crop the image after deskewing.</td>
1903 </tr>
1904
1905 <tr>
Cristy882d9f42015-10-29 16:48:39 -04001906 <td>delegate:bimodal=<var>true</var></td>
1907 <td>Specifies direct conversion from Postscript to PDF.</td>
1908 </tr>
1909
1910 <tr>
1911 <td>distort:scale=<var>value</var></td>
Cristy594d2772015-11-15 10:47:42 -05001912 <td>Sets the output scaling factor for use with <a href="command-line-options.html#distort"
1913 >-distort</a></td>
Cristy882d9f42015-10-29 16:48:39 -04001914 </tr>
1915
1916 <tr>
1917 <td>distort:viewport=<var>WxH+X+Y</var></td>
1918 <td>Sets the viewport for use with <a href="command-line-options.html#distort">-distort</a></td>
1919 </tr>
1920
1921 <tr>
1922 <td>dot:layout-engine=<var>value</var></td>
1923 <td>Specifies the layout engine for the DOT image format (e.g.
1924 <code>neato</code>).</td>
1925 </tr>
1926
1927 <tr>
Cristyf41bcd12017-03-28 05:59:57 -04001928 <td>exr:color-type=<var>value</var></td>
1929 <td>Specifies the color type for the EXR format: RGB, RGBA, YC, YCA, Y, YA, R, G, B, A).</td>
1930 </tr>
1931
1932 <tr>
Cristy882d9f42015-10-29 16:48:39 -04001933 <td>filter:option=<var>value</var></td>
1934 <td>Set a filter option for use with <a href="command-line-options.html#resize">-resize</a>.
1935 See <a href="command-line-options.html#filter">-filter</a> for details.</td>
1936 </tr>
1937
1938 <tr>
1939 <td>fourier:normalize=<var>inverse</var></td>
1940 <td>Sets the location for the FFT/IFT normalization as use by
1941 <a href="command-line-options.html#fft">+-fft</a> and <a href="command-line-options.html#ift">+-ift</a>. The default is
1942 <var>forward</var>.</td>
1943 </tr>
1944
1945 <tr>
1946 <td>h:format=<var>value</var></td>
1947 <td>Set the image encoding format use when writing a C-style header.
1948 <var>format</var> can be any output format supported by ImageMagick
Cristy579a0cb2016-11-26 12:27:17 -05001949 except for <var>h</var> and <var>magick</var>. If this
Cristy882d9f42015-10-29 16:48:39 -04001950 option is omitted, the default is <var>GIF</var> for PseudoClass
1951 images and <var>PNM</var> for DirectClass images.
Cristy579a0cb2016-11-26 12:27:17 -05001952 </td>
Cristy882d9f42015-10-29 16:48:39 -04001953 </tr>
1954
1955 <tr>
1956 <td>icon:auto-resize</td>
1957 <td>Automatically stores multiple sizes when writing an ico image
1958 (requires a 256x256 input image).</td>
1959 </tr>
1960
1961 <tr>
Cristyf41bcd12017-03-28 05:59:57 -04001962 <td>identify:locate=<var>minimum|maximum</var></td>
1963 <td>Locates the coordinates of one or more image minimum or maximum</td>
1964 </tr>
1965
1966 <tr>
1967 <td>identify:limit=<var>number</var></td>
1968 <td>Locates the coordinates for the number of minima or maxima specified</td>
1969 </tr>
1970
1971 <tr>
Cristy882d9f42015-10-29 16:48:39 -04001972 <td>jp2:layer-number=<var>value</var></td>
1973 <td>Sets the maximum number of quality layers to decode. Same for JPT, JC2,
1974 and J2K</td>
1975 </tr>
1976
1977 <tr>
1978 <td>jp2:number-resolutions=<var>value</var></td>
Cristybc232422016-11-22 07:46:18 -05001979 <td>Sets the number of resolutions to encode.Same for JPT, JC2, and
1980 J2K</td>
Cristy882d9f42015-10-29 16:48:39 -04001981 </tr>
1982
1983 <tr>
1984 <td>jp2:progression-order=<var>value</var></td>
1985 <td>choose from LRCP, RLCP, RPCL, PCRL or CPRL. Same for JPT, JC2, and
1986 J2K</td>
1987 </tr>
1988
1989 <tr>
1990 <td>jp2:quality=<var>value,value...</var></td>
1991 <td>Sets the quality layer PSNR, given in dB. The order is from left to
1992 right in ascending order. The default is a single lossless quality layer.
1993 Same for JPT, JC2, and J2K</td>
1994 </tr>
1995
1996 <tr>
1997 <td>jp2:rate=<var>value</var></td>
Cristybc232422016-11-22 07:46:18 -05001998 <td>Specify the compression factor to use while writing JPEG-2000 files.
1999 The compression factor is the reciprocal of the compression ratio. The
2000 valid range is 0.0 to 1.0, with 1.0 indicating lossless compression. If
2001 defined, this value overrides the -quality setting. A quality setting
2002 of 75 results in a rate value of 0.06641. Same for JPT, JC2, and J2K</td>
Cristy882d9f42015-10-29 16:48:39 -04002003 </tr>
2004
2005 <tr>
2006 <td>jp2:reduce-factor=<var>value</var></td>
2007 <td>Sets the number of highest resolution levels to be discarded.Same for
2008 JPT, JC2, and J2K</td>
2009 </tr>
2010
2011 <tr>
2012 <td>jpeg:block-smoothing=<var>on|off</var></td>
Cristybc232422016-11-22 07:46:18 -05002013 <td> </td>
Cristy882d9f42015-10-29 16:48:39 -04002014 </tr>
2015
2016 <tr>
2017 <td>jpeg:colors=<var>value</var></td>
2018 <td>Set the desired number of colors and let the JPEG encoder do the
2019 quantizing.</td>
2020 </tr>
2021
2022 <tr>
2023 <td>jpeg:dct-method=<var>value</var></td>
2024 <td>Choose from <code>default</code>, <code>fastest</code>,
2025 <code>float</code>, <code>ifast</code>, and <code>islow</code>.</td>
2026 </tr>
2027
2028 <tr>
2029 <td>jpeg:extent=<var>value</var></td>
2030 <td>Restrict the maximum JPEG file size, for example <code>-define
2031 jpeg:extent=400KB</code>. The JPEG encoder will search for the highest
2032 compression quality level that results in an output file that does not
Cristye93be682015-11-26 09:07:51 -05002033 exceed the value. The <code>-quality</code> option also will be respected
2034 starting with version 6.9.2-5. Between 6.9.1-0 and 6.9.2-4, add -quality
2035 100 in order for the jpeg:extent to work properly. Prior to 6.9.1-0, the
2036 -quality setting was ignored.</td>
Cristy882d9f42015-10-29 16:48:39 -04002037 </tr>
2038
2039 <tr>
2040 <td>jpeg:fancy-upsampling=<var>on|off</var></td>
Cristybc232422016-11-22 07:46:18 -05002041 <td> </td>
Cristy882d9f42015-10-29 16:48:39 -04002042 </tr>
2043
2044 <tr>
2045 <td>jpeg:optimize-coding=<var>on|off</var></td>
Cristybc232422016-11-22 07:46:18 -05002046 <td> </td>
Cristy882d9f42015-10-29 16:48:39 -04002047 </tr>
2048
2049 <tr>
2050 <td>jpeg:q-table=<var>table</var></td>
Cristybc232422016-11-22 07:46:18 -05002051 <td> </td>
Cristy882d9f42015-10-29 16:48:39 -04002052 </tr>
2053
2054 <tr>
2055 <td>jpeg:sampling-factor=<var>sampling-factor-string</var></td>
Cristybc232422016-11-22 07:46:18 -05002056 <td> </td>
Cristy882d9f42015-10-29 16:48:39 -04002057 </tr>
2058
2059 <tr>
2060 <td>jpeg:size=<var>geometry</var></td>
2061 <td>Set the size hint of a JPEG image, for
2062 example, <code>-define jpeg:size=128x128</code>.
2063 It is most useful for increasing performance and reducing the memory
2064 requirements when reducing the size of a large JPEG image.</td>
2065 </tr>
2066
2067 <tr>
2068 <td>json:features</td>
2069 <td>includes features in verbose information</td>
2070 </tr>
2071
2072 <tr>
2073 <td>json:limit</td>
Cristybc232422016-11-22 07:46:18 -05002074 <td> </td>
Cristy882d9f42015-10-29 16:48:39 -04002075 </tr>
2076
2077 <tr>
2078 <td>json:locate</td>
Cristybc232422016-11-22 07:46:18 -05002079 <td> </td>
Cristy882d9f42015-10-29 16:48:39 -04002080 </tr>
2081
2082 <tr>
2083 <td>json:moments</td>
2084 <td>includes image moments in verbose information</td>
2085 </tr>
2086
2087 <tr>
2088 <td>magick:format=<var>value</var></td>
2089 <td>Set the image encoding format use when writing a C-style header.
Cristy579a0cb2016-11-26 12:27:17 -05002090 This is the same as "h:format=format" described above.</td>
Cristy882d9f42015-10-29 16:48:39 -04002091 </tr>
2092
2093 <tr>
2094 <td>mng:need-cacheoff</td>
2095 <td>turn playback caching off for streaming MNG.</td>
2096 </tr>
2097
2098 <tr>
2099 <td>morphology:compose=<var>compose-method</var></td>
Cristy594d2772015-11-15 10:47:42 -05002100 <td>Specifies how to merge results generated by multiple<a
2101 href="command-line-options.html#morphology" >-morphology</a> kernel. The default is none. One
Cristy882d9f42015-10-29 16:48:39 -04002102 typical value is 'lighten' as used, for example, with the sobel edge
2103 kernels. </td>
2104 </tr>
2105
2106 <tr>
2107 <td>morphology:showkernel=<var>1</var></td>
Cristy594d2772015-11-15 10:47:42 -05002108 <td>Outputs (to 'standard error') all the information about a generated <a
2109 href="command-line-options.html#morphology" >-morphology</a> kernel.</td>
Cristy882d9f42015-10-29 16:48:39 -04002110 </tr>
2111
2112 <tr>
2113 <td>pcl:fit-to-page=<var>true</var></td>
Cristy579a0cb2016-11-26 12:27:17 -05002114 </tr>
Cristy882d9f42015-10-29 16:48:39 -04002115
Cristy594d2772015-11-15 10:47:42 -05002116 <tr>
Cristy882d9f42015-10-29 16:48:39 -04002117 <td>pdf:fit-page=<var>geometry</var></td>
2118 <td> geometry specifies the scaling dimensions for resizing when the PDF is
2119 being read. The geometry is either WxH{%} or page size. No offsets are
2120 allowed. (introduced in IM 6.8.8-8)</td>
2121 </tr>
2122
2123 <tr>
2124 <td>pdf:fit-to-page=<var>true</var></td>
Cristybc232422016-11-22 07:46:18 -05002125 <td> </td>
Cristy882d9f42015-10-29 16:48:39 -04002126 </tr>
2127
2128 <tr>
2129 <td>pdf:use-cropbox=<var>true</var></td>
Cristybc232422016-11-22 07:46:18 -05002130 <td> </td>
Cristy882d9f42015-10-29 16:48:39 -04002131 </tr>
2132
2133 <tr>
2134 <td>pdf:use-trimbox=<var>true</var></td>
Cristybc232422016-11-22 07:46:18 -05002135 <td> </td>
Cristy882d9f42015-10-29 16:48:39 -04002136 </tr>
2137
2138 <tr>
Cristyf41bcd12017-03-28 05:59:57 -04002139 <td>pdf:stop-on-error=<var>true</var></td>
2140 <td> </td>
2141 </tr>
2142
2143 <tr>
2144 <td>pdf:pdf:page-direction=<var>right-to-left</var></td>
2145 <td> </td>
2146 </tr>
2147
2148 <tr>
Cristy3b0b58d2016-11-06 07:40:23 -05002149 <td>phash:colorspaces=<var>colorspace,colorspace,...</var></td>
Cristybc232422016-11-22 07:46:18 -05002150 <td>the perceptual hash defaults to the sRGB and HCLp colorspaces. When
2151 using this define, you can specify up to six alternative colorspaces. (as
2152 of IM 7.0.3-8)</td>
2153 </tr>
2154
2155 <tr>
2156 <td>phash:normalize=<var>true</var></td>
2157 <td>normalizes the phash metric by dividing by the number of channels
2158 specified by <code>-define phash:colorspaces</code> when using compare
2159 -metric phash. (as of IM 7.0.3-8)</td>
Cristy3b0b58d2016-11-06 07:40:23 -05002160 </tr>
2161
2162 <tr>
Cristy882d9f42015-10-29 16:48:39 -04002163 <td>png:bit-depth=<var>value</var></td>
Cristybc232422016-11-22 07:46:18 -05002164 <td> </td>
Cristy882d9f42015-10-29 16:48:39 -04002165 </tr>
Cristy3b0b58d2016-11-06 07:40:23 -05002166
Cristy882d9f42015-10-29 16:48:39 -04002167 <tr>
2168 <td>png:color-type=<var>value</var></td>
2169 <td>desired bit-depth and color-type for PNG output. You can force the PNG
2170 encoder to use a different bit-depth and color-type than it would have
2171 normally selected, but only if this does not cause any loss of image
2172 quality. Any attempt to reduce image quality is treated as an error and no
2173 PNG file is written. E.g., if you have a 1-bit black-and-white image, you
2174 can use these "defines" to cause it to be written as an 8-bit grayscale,
2175 indexed, or even a 64-bit RGBA. But if you have a 16-million color image,
2176 you cannot force it to be written as a grayscale or indexed PNG. If you
2177 wish to do this, you must use the appropriate <a href="command-line-options.html#depth">-depth</a>,
2178 <a href="command-line-options.html#colors">-colors</a>, or <a href="command-line-options.html#type">-type</a> directives to
2179 reduce the image quality prior to using the PNG encoder. Note that in
2180 indexed PNG files, "bit-depth" refers to the number of bits per index,
2181 which can be 1, 2, 4, or 8. In such files, the color samples always have
2182 8-bit depth.</td>
2183 </tr>
2184
2185 <tr>
2186 <td>png:compression-filter=<var>value</var></td>
2187 <td> valid values are 0 through 9. 0-4 are the corresponding PNG filters,
2188 5 means adaptive filtering except for images with a colormap, 6 means
2189 adaptive filtering for all images, 7 means MNG "loco" compression, 8 means
2190 Z_RLE strategy with adaptive filtering, and 9 means Z_RLE strategy with no
2191 filtering.</td>
2192 </tr>
2193
2194 <tr>
2195 <td>png:compression-level=<var>value</var></td>
2196 <td> valid values are 0 through 9, with 0 providing the least but fastest
2197 compression and 9 usually providing the best and always the slowest.</td>
2198 </tr>
2199
2200 <tr>
2201 <td>png:compression-strategy=<var>value</var></td>
2202 <td> valid values are 0 through 4, meaning default, filtered, huffman_only,
2203 rle, and fixed ZLIB compression strategy. If you are using an old zlib
2204 that does not support Z_RLE (before 1.2.0) or Z_FIXED (before 1.2.2.2),
2205 values 3 and 4, respectively, will use the zlib default strategy
2206 instead.</td>
2207 </tr>
2208
2209 <tr>
2210 <td>png:format=<var>value</var></td>
2211 <td> valid values are <var>png8</var>, <var>png24</var>,
2212 <var>png32</var>, <var>png48</var>,
2213 <var>png64</var>, and <var>png00</var>.
2214 This property can be useful for specifying
2215 the specific PNG format to be used, when the usual method of prepending the
2216 format name to the output filename is inconvenient, such as when writing
2217 a PNG-encoded ICO file or when using <a href="mogrify.html">mogrify</a>.
2218 Value = <var>png8</var> reduces the number of colors to 256,
2219 only one of which may be fully transparent, if necessary. The other
2220 values do not force any reduction of quality; it is an error to request
2221 a format that cannot represent the image data without loss (except that
2222 it is allowed to reduce the bit-depth from 16 to 8 for all formats).
2223 Value = <var>png24</var> and <var>png48</var>
2224 allow transparency, only if a single color is fully transparent and that
2225 color does not also appear in an opaque pixel; such transparency is
2226 written in a PNG <code>tRNS</code> chunk.
2227 Value = <var>png00</var> causes the image to inherit its
2228 color-type and bit-depth from the input image, if the input was also
2229 a PNG.</td>
2230 </tr>
2231
2232 <tr>
2233 <td>png:exclude-chunk=<var>value</var></td>
2234
Cristy594d2772015-11-15 10:47:42 -05002235 <tr>
Cristy882d9f42015-10-29 16:48:39 -04002236 <td>png:include-chunk=<var>value</var></td>
2237 <td>ancillary chunks to be excluded from or included in PNG output.
2238
2239 <p>The <var>value</var> can be the name of a PNG chunk-type such
2240 as <var>bKGD</var>, a comma-separated list of chunk-names
2241 (which can include the word <var>date</var>, the word
2242 <var>all</var>, or the word <var>none</var>).
2243 Although PNG chunk-names are case-dependent, you can use all lowercase
2244 names if you prefer.</p>
2245
2246 <p>The "include-chunk" and "exclude-chunk" lists only affect the behavior
2247 of the PNG encoder and have no effect on the PNG decoder.</p>
2248
2249 <p>As a special case, if the <code>sRGB</code> chunk is excluded and
2250 the <code>gAMA</code> chunk is included, the <code>gAMA</code> chunk will
2251 only be written if gamma is not 1/2.2, since most decoders assume
2252 sRGB and gamma=1/2.2 when no colorspace information is included in
2253 the PNG file. Because the list is processed from left to right, you
2254 can achieve this with a single define:</p>
2255
2256<pre>
2257-define png:include-chunk=none,gAMA
2258</pre>
2259
2260 <p>As a special case, if the <code>sRGB</code> chunk is not excluded and
2261 the PNG encoder recognizes that the image contains the sRGB ICC profile,
2262 the PNG encoder will write the <code>sRGB</code> chunk instead of the
2263 entire ICC profile. To force the PNG encoder to write the sRGB
2264 profile as an <code>iCCP</code> chunk in the output PNG instead of the
2265 <code>sRGB</code> chunk, exclude the <code>sRGB</code> chunk.</p>
2266
2267 <p>The critical PNG chunks <code>IHDR</code>, <code>PLTE</code>,
2268 <code>IDAT</code>, and <code>IEND</code> cannot be excluded. Any such
2269 entries appearing in the list will be ignored.</p>
2270
2271 <p>If the ancillary PNG <code>tRNS</code> chunk is excluded and the
2272 image has transparency, the PNG colortype is forced to be 4 or 6
2273 (GRAY_ALPHA or RGBA). If the image is not transparent, then the
2274 <code>tRNS</code> chunk isn't written anyhow, and there is no effect
2275 on the PNG colortype of the output image.</p>
2276
2277 <p>The <a href="command-line-options.html#strip">-strip</a> option does the equivalent of the
2278 following for PNG output:</p>
2279
2280<pre>
2281-define png:exclude-chunk=EXIF,iCCP,iTXt,sRGB,tEXt,zCCP,zTXt,date
2282</pre>
2283
2284 <p>The default behavior is to include all known PNG ancillary chunks
2285 plus ImageMagick's private <code>vpAg</code> ("virtual page") chunk,
2286 and to exclude all PNG chunks that are unknown to ImageMagick,
2287 regardless of their PNG "copy-safe" status as described in the
2288 PNG specification.</p>
2289
2290 <p>Any chunk names that are not known to ImageMagick are ignored
2291 if they appear in either the "include-chunk" or "exclude-chunk" list.
2292 The ancillary chunks currently known to ImageMagick are
2293 <code>bKGD</code>, <code>cHRM</code>, <code>gAMA</code>, <code>iCCP</code>,
2294 <code>oFFs</code>, <code>pHYs</code>, <code>sRGB</code>, <code>tEXt</code>,
2295 <code>tRNS</code>, <code>vpAg</code>, and <code>zTXt</code>.</p>
2296
2297 <p>You can also put <code>date</code> in the list to include or exclude
2298 the "Date:create" and "Date:modify" text chunks that ImageMagick normally
2299 inserts in the output PNG.</p></td>
2300 </tr>
2301
2302 <tr>
2303 <td>png:preserve-colormap[=<var>true</var>]</td>
Cristy594d2772015-11-15 10:47:42 -05002304 <td>Use the existing image->colormap. Normally the PNG encoder will
Cristy882d9f42015-10-29 16:48:39 -04002305 try to optimize the palette, eliminating unused entries and putting
2306 the transparent colors first. If this flag is set, that behavior
2307 is suppressed.</td>
2308 </tr>
2309
2310 <tr>
2311 <td>png:preserve-iCCP[=<var>true</var>]</td>
2312 <td>By default, the PNG decoder and encoder examine any ICC profile
2313 that is present, either from an <code>iCCP</code> chunk in the PNG
2314 input or supplied via an option, and if the profile is recognized
2315 to be the sRGB profile, converts it to the <code>sRGB</code> chunk.
2316 You can use <code>-define png:preserve-iCCP</code> to prevent
2317 this from happening; in such cases the <code>iCCP</code> chunk
2318 will be read or written and no <code>sRGB</code> chunk will be
2319 written. There are some ICC profiles that claim to be sRGB but
2320 have various errors that cause them to be rejected by libpng16; such
2321 profiles are recognized anyhow and converted to the <code>sRGB</code>
2322 chunk, but are rejected if the <code>-define png:preserve-iCCP</code>
2323 is present. Note that not all "sRGB" ICC profiles are recognized
2324 yet; we will add them to the list as we encounter them.</td>
2325 </tr>
2326
2327 <tr>
2328 <td>png:swap-bytes[=<var>true</var>]</td>
2329 <td>The PNG specification requires that any multi-byte integers be stored in
2330 network byte order (MSB-LSB endian). This option allows you to
2331 fix any invalid PNG files that have 16-bit samples stored incorrectly
2332 in little-endian order (LSB-MSB). The "-define png:swap-bytes" option
2333 must appear before the input filename on the commandline. The swapping
2334 is done during the libpng decoding operation.</td>
2335 </tr>
2336
2337 <tr>
2338 <td>profile:skip=<var>name1,name2,...</var></td>
2339 <td>Skip the named profile[s] when reading the image. Use skip="*" to
2340 skip all named profiles in the image. Many named profiles exist,
2341 including ICC, EXIF, APP1, IPTC, XMP, and others.</td>
2342 </tr>
2343
2344 <tr>
2345 <td>ps:imagemask</td>
2346 <td>If the ps:imagemask flag is defined, the PS3 and EPS3 coders will
2347 create Postscript files that render bilevel images with the Postscript
2348 imagemask operator instead of the image operator.</td>
2349 </tr>
2350
2351 <tr>
Cristy3b0b58d2016-11-06 07:40:23 -05002352 <td>psd:additional-info=all|selective</td>
Cristybc232422016-11-22 07:46:18 -05002353 <td>This option should only be used when converting from a PSD file to
2354 another PSD file. This should be placed after the image is read. The two
2355 options are 'all' and 'selective'. The 'selective' option will preserve
2356 all additional information that is not related to the geometry of the
2357 image. The 'all' option should only be used when the geometry of the
2358 image has not been changed. This option is helpful when transferring
2359 non-simple layers, such as adjustment layers from the input PSD file to
2360 the output PSD file. If this option is not used, the additional
2361 information will not be preserved. This define is available as of
2362 Imagemagick version 6.9.5-8.
Cristy3b0b58d2016-11-06 07:40:23 -05002363</td>
2364 </tr>
2365
2366 <tr>
Cristy882d9f42015-10-29 16:48:39 -04002367 <td>psd:alpha-unblend=off</td>
2368 <td>Disables new automatic un-blending of transparency with the base image
2369 for the flattened layer 0 before adding the alpha channel to the output
2370 image. This define must be placed before the input psd image. (Available
2371 as of IM 6.9.2.5). The automatic un-blending is new to IM 6.9.2.5 and
2372 prevents the transparency from being applied twice in the output
Cristy3b0b58d2016-11-06 07:40:23 -05002373 image. This option should be set before reading the image.</td>
2374 </tr>
2375
2376 <tr>
2377 <td>psd:preserve-opacity-mask=true</td>
Cristybc232422016-11-22 07:46:18 -05002378 <td>This option should only be used when converting from a PSD file to
2379 another PSD file. It will preserve the opacity mask of a layer and add it
2380 back to the layer when the image is saved. Setting this to 'true' will
2381 enable this feature. This define is available as of Imagemagick version
2382 6.9.5-10.
Cristy3b0b58d2016-11-06 07:40:23 -05002383</td>
Cristy882d9f42015-10-29 16:48:39 -04002384 </tr>
2385
2386 <tr>
Cristy1f1f3a02016-06-01 07:25:42 -04002387 <td>preserve-timestamp=<var>{True, False}</var></td>
2388 <td>Preserve file timestamp (<code>mogrify</code> only).</td>
2389 </tr>
2390
2391 <tr>
Cristy882d9f42015-10-29 16:48:39 -04002392 <td>quantum:format=<var>type</var></td>
2393 <td>Set the type to <code>floating-point</code> to specify a floating-point
2394 format for raw files (e.g. GRAY:) or for MIFF and TIFF images in HDRI mode
2395 to preserve negative values. If <a href="command-line-options.html#depth">-depth</a> 16 is
2396 included, the result is a single precision floating point format.
2397 If <a href="command-line-options.html#depth">-depth</a> 32 is included, the result is
2398 double precision floating point format.</td>
2399 </tr>
2400
2401 <tr>
2402 <td>quantum:polarity=<var>photometric-interpretation</var></td>
Cristybc232422016-11-22 07:46:18 -05002403 <td>Set the photometric-interpretation of an image (typically for TIFF
2404 image file format) to either <code>min-is-black</code> (default) or
Cristy882d9f42015-10-29 16:48:39 -04002405 <code>min-is-white</code>.</td>
2406 </tr>
2407
2408 <tr>
2409 <td>sample:offset=<var>geometry</var></td>
2410 <td>Location of the sampling point within the sub-region being sampled,
Cristy594d2772015-11-15 10:47:42 -05002411 expressed as percentages (see <a href="command-line-options.html#sample" >-sample</a>).</td>
Cristy882d9f42015-10-29 16:48:39 -04002412 </tr>
2413
2414 <tr>
2415 <td>showkernel=<var>1</var></td>
Cristy594d2772015-11-15 10:47:42 -05002416 <td>Outputs (to 'standard error') all the information about a generated <a
2417 href="command-line-options.html#morphology" >-morphology</a> kernel.</td>
Cristy882d9f42015-10-29 16:48:39 -04002418 </tr>
2419
2420 <tr>
2421 <td>stream:buffer-size=<var>value</var></td>
2422 <td>Set the stream buffer size. Select 0 for unbuffered I/O.</td>
2423 </tr>
2424
2425 <tr>
2426 <td>tiff:alpha=<var>associated|unassociated|unspecified</var></td>
Cristybc232422016-11-22 07:46:18 -05002427 <td>Specify the alpha extra samples as associated, unassociated or
2428 unspecified </td>
Cristy882d9f42015-10-29 16:48:39 -04002429 </tr>
2430
2431 <tr>
2432 <td>tiff:endian=<var>msb|lsb</var></td>
Cristybc232422016-11-22 07:46:18 -05002433 <td> </td>
Cristy882d9f42015-10-29 16:48:39 -04002434 </tr>
2435
2436 <tr>
Cristyf41bcd12017-03-28 05:59:57 -04002437 <td>tiff:exif-properties=<var>true</var></td>
2438 <td>Enables reading the EXIF properties.</td>
Cristy882d9f42015-10-29 16:48:39 -04002439 </tr>
2440
2441 <tr>
2442 <td>tiff:fill-order=<var>msb|lsb</var></td>
Cristybc232422016-11-22 07:46:18 -05002443 <td> </td>
Cristy882d9f42015-10-29 16:48:39 -04002444 </tr>
2445
2446 <tr>
2447 <td>tiff:ignore-layers=<var>true</var></td>
2448 <td>Ignores the photoshop layers.</td>
2449 </tr>
2450
2451 <tr>
2452 <td>tiff:ignore-tags=<var>comma-separate-list-of-tag-IDs</var></td>
2453 <td>Allows one or more tag ID values to be ignored.</td>
2454 </tr>
2455
2456 <tr>
2457 <td>tiff:rows-per-strip=<var>value</var></td>
2458 <td>Sets the number of rows per strip</td>
2459 </tr>
2460
2461 <tr>
2462 <td>tiff:tile-geometry=<var>WxH</var></td>
2463 <td>Sets the tile size for pyramid tiffs. Requires the suffix
2464 PTIF: before the outputname</td>
2465 </tr>
Cristye09ed312016-03-06 08:07:39 -05002466
2467 <tr>
2468 <td>type:features=<var>string</var></td>
Cristybc232422016-11-22 07:46:18 -05002469 <td> </td>
Cristye09ed312016-03-06 08:07:39 -05002470 </tr>
2471
2472 <tr>
2473 <td>type:hinting=<var>off</var></td>
Cristybc232422016-11-22 07:46:18 -05002474 <td> </td>
Cristye09ed312016-03-06 08:07:39 -05002475 </tr>
Cristyf41bcd12017-03-28 05:59:57 -04002476
2477 <tr>
2478 <td>txt:compliance=<var>css</var></td>
2479 <td> </td>
2480 </tr>
2481
2482 <tr>
2483 <td>x:screen=<var>true</var></td>
2484 <td>Obtains the image from the root window </td>
2485 </tr>
2486
2487 <tr>
2488 <td>x:silent=<var>true</var></td>
2489 <td>Turns off the beep when importing an image </td>
2490 </tr>
Cristy882d9f42015-10-29 16:48:39 -04002491</table>
2492
2493<p>For example, to create a postscript file that will render only the black
2494pixels of a bilevel image, use:</p>
2495
2496<pre>
2497convert bilevel.tif -define ps:imagemask eps3:stencil.ps
2498</pre>
2499
2500<p>Set attributes of the image registry by prefixing the value with
2501<code>registry:</code>. For example, to set a temporary path to put work files,
2502use:</p>
2503
2504<pre>
2505-define registry:temporary-path=/data/tmp
2506</pre>
2507
2508<div style="margin: auto;">
Cristy594d2772015-11-15 10:47:42 -05002509 <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 -04002510</div>
2511
2512<p class="magick-description">display the next image after pausing.</p>
2513
2514<p>This option is useful for regulating the animation of image sequences
2515<var>ticks/ticks-per-second</var> seconds must expire before the display of the
2516next image. The default is no delay between each showing of the image
2517sequence. The default ticks-per-second is 100.</p>
2518
2519<p>Use <code>&gt;</code> to change the image delay <var>only</var> if its current
2520value exceeds the given delay. <code>&lt;</code> changes the image delay
2521<var>only</var> if current value is less than the given delay. For example, if
2522you specify <code>30&gt;</code> and the image delay is 20, the image delay does
2523not change. However, if the image delay is 40 or 50, the delay it is changed
2524to 30. Enclose the given delay in quotation marks to prevent the
2525<code>&lt;</code> or <code>&gt;</code> from being interpreted by your shell as
2526a file redirection.</p>
2527
2528
2529<div style="margin: auto;">
2530 <h3 class="magick-header"><a id="delete"></a>-delete <var>indexes</var></h3>
2531</div>
2532
2533<p class="magick-description">delete the images specified by index, from the image sequence.</p>
2534
2535<p>Specify the image by its index in the sequence. The first image is index
25360. Negative indexes are relative to the end of the sequence, for example, -1
2537represents the last image of the sequence. Specify a range of images with
2538a dash (e.g. 0-4). Separate indexes with a comma (e.g. 0,2). Use
Cristy912a9222016-06-17 15:37:28 -04002539<code>+delete</code> to delete the last image in the current image sequence. Use <code>-delete 0--1</code> to delete the entire image sequence.</p>
Cristy882d9f42015-10-29 16:48:39 -04002540
2541
2542<div style="margin: auto;">
Cristy594d2772015-11-15 10:47:42 -05002543 <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 -04002544</div>
2545
2546<p class="magick-description">Set the horizontal and vertical resolution of an image for rendering to devices.</p>
2547
2548<p>This option specifies the image resolution to store while encoding a raster
2549image or the canvas resolution while rendering (reading) vector formats such
2550as Postscript, PDF, WMF, and SVG into a raster image. Image resolution
2551provides the unit of measure to apply when rendering to an output device or
Cristy594d2772015-11-15 10:47:42 -05002552raster image. The default unit of measure is in dots per inch (DPI). The <a
2553href="command-line-options.html#units">-units</a> option may be used to select dots per centimeter
Cristy882d9f42015-10-29 16:48:39 -04002554instead.</p>
2555
2556<p>The default resolution is 72 dots per inch, which is equivalent to one
2557point per pixel (Macintosh and Postscript standard). Computer screens are
2558normally 72 or 96 dots per inch, while printers typically support 150, 300,
2559600, or 1200 dots per inch. To determine the resolution of your display, use
2560a ruler to measure the width of your screen in inches, and divide by the
2561number of horizontal pixels (1024 on a 1024x768 display).</p>
2562
2563<p>If the file format supports it, this option may be used to update the
2564stored image resolution. Note that Photoshop stores and obtains image
2565resolution from a proprietary embedded profile. If this profile is not
2566stripped from the image, then Photoshop will continue to treat the image using
2567its former resolution, ignoring the image resolution specified in the standard
2568file header.</p>
2569
2570<p>The <a href="command-line-options.html#density">-density</a> option sets an <var>attribute</var> and
2571does not alter the underlying raster image. It may be used to adjust the
2572rendered size for desktop publishing purposes by adjusting the scale applied
2573to the pixels. To resize the image so that it is the same size at a different
2574resolution, use the <a href="command-line-options.html#resample">-resample</a> option.</p>
2575
2576<div style="margin: auto;">
2577 <h3 class="magick-header"><a id="depth"></a>-depth <var>value</var></h3>
2578</div>
2579
2580<p class="magick-description">depth of the image.</p>
2581
2582<p>This the number of bits in a color sample within a pixel. Use this option
2583to specify the depth of raw images whose depth is unknown such as GRAY, RGB,
2584or CMYK, or to change the depth of any image after it has been read.</p>
2585
2586<div style="margin: auto;">
2587 <h3 class="magick-header"><a id="descend"></a>-descend</h3>
2588</div>
2589
2590<p class="magick-description">obtain image by descending window hierarchy.</p>
2591
2592<div style="margin: auto;">
Cristy769d8892016-01-19 18:11:14 -05002593 <h3 class="magick-header"><a id="deskew"></a>-deskew <var>threshold{%}</var></h3>
Cristy882d9f42015-10-29 16:48:39 -04002594</div>
2595
2596<p class="magick-description">straighten an image. A threshold of 40% works for most images.</p>
2597
2598<p>Use <a href="command-line-options.html#set">-set</a> <code>option:deskew:auto-crop
Cristy3b0b58d2016-11-06 07:40:23 -05002599<var>true | false</var></code> to auto crop the image.</p>
Cristy882d9f42015-10-29 16:48:39 -04002600
2601<div style="margin: auto;">
2602 <h3 class="magick-header"><a id="despeckle"></a>-despeckle</h3>
2603</div>
2604
2605<p class="magick-description">reduce the speckles within an image.</p>
2606
2607<div style="margin: auto;">
2608 <h3 class="magick-header"><a id="direction"></a>-direction <var>type</var></h3>
2609</div>
2610
2611<p class="magick-description">render text right-to-left or left-to-right.</p>
2612
2613<div style="margin: auto;">
Cristy769d8892016-01-19 18:11:14 -05002614 <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 -04002615</div>
2616
2617<p class="magick-description">shift image pixels as defined by a displacement map.</p>
2618
2619<p>With this option, the 'overlay' image, and optionally the 'mask' image,
2620is used as a displacement map, which is used to displace the lookup of
2621what part of the 'background' image is seen at each point of the overlaid
2622area. Much like the displacement map is a 'lens' that redirects light shining
2623through it so as to present a distorted view the original 'background' image
2624behind it. </p>
2625
2626<p>Any perfect grey areas of the displacement map produce a zero
2627displacement of the image. Black areas produce the given maximum negative
2628displacement of the lookup point, while white produce a maximum positive
2629displacement of the lookup. </p>
2630
2631<p>Note that it is the lookup of the 'background' that is displaced, not a
2632displacement of the image itself. As such an area of the displacement map
2633containing 'white' will have the lookup point 'shifted' by a positive amount,
2634and thus generating a copy of the destination image to the right/downward from
2635the correct position. That is the image will look like it may have been
2636'shifted' in a negative left/upward direction. Understanding this is a very
2637important in understanding how displacement maps work. </p>
2638
2639<p>The given arguments define the maximum amount of displacement in pixels
2640that a particular map can produce. If the displacement scale is large enough
2641it is also possible to lookup parts of the 'background' image that lie well
2642outside the bounds of the displacement map itself. That is you could very
2643easily copy a section of the original image from outside the overlay area
2644into the overlay area. </p>
2645
2646<p>The '%' flag makes the displacement scale relative to the size of the
2647overlay image (100% = half width/height of image). Using '!' switches
2648percentage arguments to refer to the destination image size instead.
2649these flags were added as of IM v6.5.3-5.</p>
2650
2651<p>Normally a single grayscale displacement map is provided, which with the
2652given scaling values will determine a single direction (vector) in which
2653displacements can occur (positively or negatively). However, if you also
2654specify a third image which is normally used as a <var>mask</var>,
2655the <var>composite image</var> is used for horizontal X
2656displacement, while the <var>mask image</var> is used for vertical Y
2657displacement. This allows you to define completely different displacement
2658values for the X and Y directions, and allowing you to lookup any point within
2659the <var>scale</var> bounds. In other words each pixel can lookup
2660any other nearby pixel, producing complex 2 dimensional displacements, rather
2661than a simple 1 dimensional vector displacements. </p>
2662
2663<p>Alternatively rather than supplying two separate images, as of IM v6.4.4-0,
2664you can use the 'red' channel of the overlay image to specify the horizontal
2665or X displacement, and the 'green' channel for the vertical or Y displacement.
2666</p>
2667
2668<p>As of IM v6.5.3-5 any alpha channel in the overlay image is used as a
2669mask the transparency of the destination image. However areas outside the
2670overlaid areas will not be effected. </p>
2671
2672
2673<div style="margin: auto;">
2674 <h3 class="magick-header"><a id="display"></a>-display <var>host:display[.screen]</var></h3>
2675</div>
2676
2677<p class="magick-description">Specifies the X server to contact.</p>
2678
2679<p>This option is used with convert for obtaining image or font from this
2680X server. See <var>X(1)</var>.</p>
2681
2682<div style="margin: auto;">
2683 <h3 class="magick-header"><a id="dispose"></a>-dispose <var>method</var></h3>
2684</div>
2685
2686<p class="magick-description">define the GIF disposal image setting for images that are being created or read in. </p>
2687
2688<p>The layer disposal method defines the way each the displayed image is to be
2689modified after the current 'frame' of an animation has finished being
2690displayed (after its 'delay' period), but before the next frame on an
2691animation is to be overlaid onto the display. </p>
2692
2693<p>Here are the valid methods:</p>
2694
2695<dl class="dl-horizontal">
2696<dt>Undefined</dt><dd>0: No disposal specified (equivalent to '<code>none</code>').</dd>
2697<dt>None</dt><dd>1: Do not dispose, just overlay next frame image.</dd>
2698<dt>Background</dt><dd>2: Clear the frame area with the background color.</dd>
2699<dt>Previous</dt><dd>3: Clear to the image prior to this frames overlay.</dd>
2700</dl>
2701
2702<p>You can also use the numbers given above, which is what the GIF format
2703uses internally to represent the above settings. </p>
2704
2705<p>To print a complete list of dispose methods, use <a href="command-line-options.html#list">-list dispose</a>.</p>
2706
Cristy594d2772015-11-15 10:47:42 -05002707<p>Use <a href="command-line-options.html#dispose" >+dispose</a>, turn off the setting and prevent
Cristy882d9f42015-10-29 16:48:39 -04002708resetting the layer disposal methods of images being read in. </p>
2709
2710<p>Use <a href="command-line-options.html#set">-set</a> '<code>dispose</code>' method to set the image
2711disposal method for images already in memory.</p>
2712
2713<div style="margin: auto;">
2714 <h3 class="magick-header"><a id="dissimilarity-threshold"></a>-dissimilarity-threshold <var>value</var></h3>
2715</div>
2716
2717<p class="magick-description">maximum RMSE for subimage match (default 0.2).</p>
2718
2719
2720<div style="margin: auto;">
2721 <h3 class="magick-header"><a id="dissolve"></a>-dissolve <var>src_percent</var>[x<var>dst_percent</var>]</h3>
2722</div>
2723
2724<p class="magick-description">dissolve an image into another by the given percent.</p>
2725
2726<p>The opacity of the composite image is multiplied by the given percent, then
2727it is composited 'over' the main image. If <var>src_percent</var>
2728is greater than 100, start dissolving the main image so it becomes
2729transparent at a value of '<code>200</code>'. If both percentages
2730are given, each image are dissolved to the percentages given. </p>
2731
2732<p>Note that dissolve percentages do not add, two opaque images dissolved
2733'50,50', produce a 75% transparency. For a 50% + 50% blending of the two
2734images, you would need to use dissolve values of '50,100'. </p>
2735
2736<div style="margin: auto;">
2737 <h3 class="magick-header"><a id="distort"></a>-distort <var>method arguments</var></h3>
2738</div>
2739
2740<p class="magick-description">distort an image, using the given <var>method</var> and its required <var>arguments</var>.</p>
2741
2742<p>The <var>arguments</var> is a single string containing a list
2743of floating point numbers separated by commas or spaces. The number of
2744and meaning of the floating point values depends on the distortion <var>method</var> being used. </p>
2745
2746<p>Choose from these distortion types:</p>
2747
2748<table class="table table-condensed table-striped">
2749 <tr>
2750 <th style="width: 8%">Method</th>
2751 <th>Description</th>
2752 </tr>
2753
2754 <tr>
Cristy594d2772015-11-15 10:47:42 -05002755 <td>ScaleRotateTranslate <br/> SRT</td>
Cristy882d9f42015-10-29 16:48:39 -04002756 <td>
2757 Distort image by first scaling and rotating about a given 'center',
2758 before translating that 'center' to the new location, in that order. It
2759 is an alternative method of specifying a 'Affine' type of
2760 distortion, but without shearing effects. It also provides a good way
2761 of rotating and displacing a smaller image for tiling onto a larger
Cristy594d2772015-11-15 10:47:42 -05002762 background (IE 2-dimensional animations). <br/>
Cristy882d9f42015-10-29 16:48:39 -04002763
2764 The number of arguments determine the specific meaning of each
Cristy594d2772015-11-15 10:47:42 -05002765 argument for the scales, rotation, and translation operations. <br/>
Cristy882d9f42015-10-29 16:48:39 -04002766
2767 <dl class="dl-horizontal">
2768 <dt>2:</dt><dd><var>Scale Angle</var></dd>
2769 <dt>3:</dt><dd><var>X,Y Angle</var></dd>
2770 <dt>4:</dt><dd><var>X,Y Scale Angle</var></dd>
2771 <dt>5:</dt> <dd><var>X,Y ScaleX,ScaleY Angle</var></dd>
2772 <dt>6:</dt> <dd><var>X,Y Scale Angle NewX,NewY</var></dd>
2773 <dt>7:</dt> <dd><var>X,Y ScaleX,ScaleY Angle NewX,NewY</var></dd>
2774 </dl>
2775
2776 This is actually an alternative way of specifying a 2 dimensional linear
2777 'Affine' or 'AffineProjection' distortion. </td> </tr>
2778
2779 <tr>
2780 <td>Affine</td>
2781 <td>
2782 Distort the image linearly by moving a list of at least 3 or more sets
2783 of control points (as defined below). Ideally 3 sets or 12 floating
2784 point values are given allowing the image to be linearly scaled,
2785 rotated, sheared, and translated, according to those three points. See
2786 also the related 'AffineProjection' and 'SRT'
Cristy594d2772015-11-15 10:47:42 -05002787 distortions. <br/>
Cristy882d9f42015-10-29 16:48:39 -04002788
2789 More than 3 sets given control point pairs (12 numbers) is least
2790 squares fitted to best match a linear affine distortion. If only 2
2791 control point pairs (8 numbers) are given a two point image translation
2792 rotation and scaling is performed, without any possible shearing,
2793 flipping or changes in aspect ratio to the resulting image. If only one
2794 control point pair is provides the image is only translated, (which may
Cristy594d2772015-11-15 10:47:42 -05002795 be a floating point non-integer translation). <br/>
Cristy882d9f42015-10-29 16:48:39 -04002796
2797 This distortion does not include any form of perspective distortion.
2798 </td>
2799
2800 </tr>
2801
2802 <tr>
2803 <td>AffineProjection</td>
2804 <td>
2805 Linearly distort an image using the given Affine Matrix of 6
2806 pre-calculated coefficients forming a set of Affine Equations to map
2807 the source image to the destination image.
2808
2809 <p class="text-center"><var>
2810 s<sub>x</sub>, r<sub>x</sub>,
2811 r<sub>y</sub>, s<sub>y</sub>,
2812 t<sub>x</sub>, t<sub>y</sub>
2813 </var></p>
2814
Cristy594d2772015-11-15 10:47:42 -05002815 See <a href="command-line-options.html#affine" >-affine</a> setting for more detail, and
2816 meanings of these coefficients. <br/>
Cristy882d9f42015-10-29 16:48:39 -04002817
2818 The distortions 'Affine' and 'SRT' provide
2819 alternative methods of defining this distortion, with ImageMagick doing
2820 the calculations needed to generate the required coefficients. You can
Cristy594d2772015-11-15 10:47:42 -05002821 see the internally generated coefficients, by using a <a
2822 href="command-line-options.html#verbose" >-verbose</a> setting with those other variants. </td>
Cristy882d9f42015-10-29 16:48:39 -04002823
2824 </tr>
2825
2826 <tr>
Cristy594d2772015-11-15 10:47:42 -05002827 <td>BilinearForward<br/>
Cristy882d9f42015-10-29 16:48:39 -04002828 BilinearReverse</td>
2829 <td>
2830 Bilinear Distortion, given a minimum of 4 sets of coordinate pairs, or
2831 16 values (see below). Not that lines may not appear straight after
2832 distortion, though the distance between coordinates will remain
Cristy594d2772015-11-15 10:47:42 -05002833 consistent. <br/>
Cristy882d9f42015-10-29 16:48:39 -04002834
2835 The 'BilinearForward' is used to map rectangles to any
2836 quadrilateral, while the 'BilinearReverse' form maps any
2837 quadrilateral to a rectangle, while preserving the straight line edges
Cristy594d2772015-11-15 10:47:42 -05002838 in each case. <br/>
Cristy882d9f42015-10-29 16:48:39 -04002839
2840 Note that 'BilinearForward' can generate invalid pixels
Cristyb7f455a2017-03-03 19:30:34 -05002841 which will be colored using the <a href="command-line-options.html#mattecolor" >-mattecolor</a>
Cristy882d9f42015-10-29 16:48:39 -04002842 color setting. Also if the quadrilateral becomes 'flipped' the image
Cristy594d2772015-11-15 10:47:42 -05002843 may disappear. <br/>
Cristy882d9f42015-10-29 16:48:39 -04002844
2845 There are future plans to produce a true Bilinear distortion that will
2846 attempt to map any quadrilateral to any other quadrilateral, while
2847 preserving edges (and edge distance ratios).
2848
2849 </td>
2850 </tr>
2851
2852 <tr>
2853 <td>Perspective</td>
2854 <td>
2855 Perspective distort the images, using a list of 4 or more sets of
2856 control points (as defined below). More that 4 sets (16 numbers) of
2857 control points provide least squares fitting for more accurate
2858 distortions (for the purposes of image registration and panorama
2859 effects). Less than 4 sets will fall back to a 'Affine'
Cristy594d2772015-11-15 10:47:42 -05002860 linear distortion. <br/>
Cristy882d9f42015-10-29 16:48:39 -04002861
2862 Perspective Distorted images ensures that straight lines remain
2863 straight, but the scale of the distorted image will vary. The horizon
2864 is anti-aliased, and the 'sky' color may be set using the
Cristyb7f455a2017-03-03 19:30:34 -05002865 <a href="command-line-options.html#mattecolor" >-mattecolor</a> setting. </td>
Cristy882d9f42015-10-29 16:48:39 -04002866 </tr>
2867
2868 <tr>
2869 <td>PerspectiveProjection </td>
2870 <td>
2871 Do a 'Perspective' distortion biased on a set of 8
2872 pre-calculated coefficients. You can get these coefficients by looking
Cristy594d2772015-11-15 10:47:42 -05002873 at the <a href="command-line-options.html#verbose" >-verbose</a> output of a
Cristy882d9f42015-10-29 16:48:39 -04002874 'Perspective' distortion, or by calculating them yourself.
2875 If the last two perspective scaling coefficients are zero, the
2876 remaining 6 represents a transposed 'Affine Matrix'. </td>
2877
2878 </tr>
2879
2880 <tr>
2881 <td>Arc</td>
2882 <td>
2883 Arc the image (variation of polar mapping) over the angle given around
2884 a circle.
2885
Cristy579a0cb2016-11-26 12:27:17 -05002886 <dl class="dl-horizontal">
Cristy882d9f42015-10-29 16:48:39 -04002887 <dt>arc_angle</dt>
2888 <dd>The angle over which to arc the image side-to-side</dd>
2889 <dt>rotate_angle</dt>
2890 <dd>Angle to rotate resulting image from vertical center</dd>
2891 <dt>top_radius</dt>
2892 <dd>Set top edge of source image at this radius</dd>
2893 <dt>bottom_radius </dt>
2894 <dd>Set bottom edge to this radius (radial scaling)</dd>
Cristy579a0cb2016-11-26 12:27:17 -05002895 </dl>
Cristy882d9f42015-10-29 16:48:39 -04002896
2897 The resulting image is always resized to best fit the resulting image,
Cristy594d2772015-11-15 10:47:42 -05002898 (as if using <a href="command-line-options.html#distort" >+distort</a>) while attempting to
Cristy882d9f42015-10-29 16:48:39 -04002899 preserve scale and aspect ratio of the original image as much as
2900 possible with the arguments given by the user. All four arguments will
Cristy594d2772015-11-15 10:47:42 -05002901 be needed to change the overall aspect ratio of an 'Arc'ed image. <br/>
Cristy882d9f42015-10-29 16:48:39 -04002902
2903 This a variation of a polar distortion designed to try to preserve the
2904 aspect ratio of the image rather than direct Cartesian to Polar
2905 conversion. </td>
2906 </tr>
2907
2908 <tr>
2909 <td>Polar</td>
2910 <td>
2911 Like 'Arc' but do a complete Cartesian to Polar mapping of
2912 the image. that is the height of the input image is mapped to the
2913 radius limits, while the width is wrapped around between the
Cristy594d2772015-11-15 10:47:42 -05002914 angle limits. <br/>
Cristy882d9f42015-10-29 16:48:39 -04002915
Cristy594d2772015-11-15 10:47:42 -05002916 Arguments: <var>Rmax,Rmin CenterX,CenterY, start,end_angle</var> <br/>
Cristy882d9f42015-10-29 16:48:39 -04002917
2918 All arguments are optional. With <var>Rmin</var> defaulting to zero, the
2919 center to the center of the image, and the angles going from -180 (top)
2920 to +180 (top). If <var>Rmax</var> is given the special value of
2921 '0', the the distance from the center to the nearest edge
2922 is used for the radius of the output image, which will ensure the whole
2923 image is visible (though scaled smaller). However a special value of
2924 '-1' will use the distance from the center to the furthest
2925 corner, This may 'clip' the corners from the input rectangular image,
2926 but will generate the exact reverse of a 'DePolar' with
Cristy594d2772015-11-15 10:47:42 -05002927 the same arguments. <br/>
Cristy882d9f42015-10-29 16:48:39 -04002928
Cristy594d2772015-11-15 10:47:42 -05002929 If the plus form of distort (<a href="command-line-options.html#distort" >+distort</a>) is used
Cristy882d9f42015-10-29 16:48:39 -04002930 output image center will default to 0,0 of the virtual
2931 canvas, and the image size adjusted to ensure the whole input image is
2932 made visible in the output image on the virtual canvas. </td>
2933
2934 </tr>
2935
2936 <tr>
2937 <td>DePolar</td>
2938 <td>
2939 Uses the same arguments and meanings as a 'Polar' distortion
Cristy594d2772015-11-15 10:47:42 -05002940 but generates the reverse Polar to Cartesian distortion. <br/>
Cristy882d9f42015-10-29 16:48:39 -04002941
2942 The special <var>Rmax</var> setting of '0' may however clip
2943 the corners of the input image. However using the special
2944 <var>Rmax</var> setting of '-1' (maximum center to corner
2945 distance) will ensure the whole distorted image is preserved in the
2946 generated result, so that the same argument to 'Polar' will
2947 reverse the distortion re-producing the original.
2948
2949 Note that as this distortion requires the area resampling of a circular
2950 arc, which can not be handled by the builtin EWA resampling function.
2951 As such the normal EWA filters are turned off. It is recommended some
2952 form of 'super-sampling' image processing technique be used to produce
2953 a high quality result. </td>
2954
2955 </tr>
2956
2957 <tr>
2958 <td>Barrel</td>
2959 <td>
Cristy594d2772015-11-15 10:47:42 -05002960 Given the four coefficients (A,B,C,D) as defined by <a
2961 href="http://wiki.panotools.org/Lens_correction_model" >Helmut
Cristy882d9f42015-10-29 16:48:39 -04002962 Dersch</a>, perform a barrel or pin-cushion distortion appropriate to
2963 correct radial lens distortions. That is in photographs, make straight
Cristy594d2772015-11-15 10:47:42 -05002964 lines straight again. <br/>
Cristy882d9f42015-10-29 16:48:39 -04002965
2966 <p class="text-center">Arguments: <var>A B C</var> [ <var>D</var> [
Cristy594d2772015-11-15 10:47:42 -05002967 <var>X</var> , <var>Y</var> ] ] <br/>
Cristy882d9f42015-10-29 16:48:39 -04002968 or <var>A<sub>x</sub> B<sub>x</sub> C<sub>x</sub> D<sub>x</sub>
2969 A<sub>y</sub> B<sub>y</sub> C<sub>y</sub> D<sub>y</sub></var>
2970 [ <var>X</var> , <var>Y</var> ] </p>
2971 So that it forms the function
2972 <p class="text-center">Rsrc = r * ( <var>A</var>*r<sup>3</sup> + <var>B</var>*r<sup>2</sup> +
2973 <var>C</var>*r + <var>D</var> )</p>
2974
2975 Where <var>X</var>,<var>Y</var> is the optional center of the distortion
Cristy594d2772015-11-15 10:47:42 -05002976 (defaulting to the center of the image). <br/>
Cristy882d9f42015-10-29 16:48:39 -04002977 The second form is typically used to distort images, rather than
Cristy594d2772015-11-15 10:47:42 -05002978 correct lens distortions. <br/>
Cristy882d9f42015-10-29 16:48:39 -04002979 </td>
2980
2981 </tr>
2982
2983 <tr>
2984 <td>BarrelInverse</td>
2985 <td>
2986 This is very similar to 'Barrel' with the same set of
2987 arguments, and argument handling. However it uses the inverse
2988 of the radial polynomial,
2989 so that it forms the function
2990 <p class="text-center">Rsrc = r / ( <var>A</var>*r<sup>3</sup> + <var>B</var>*r<sup>2</sup> +
2991 <var>C</var>*r + <var>D</var> )</p>
2992 Note that this is not the reverse of the 'Barrel'
2993 distortion, just a different barrel-like radial distortion method.
2994
2995 </td>
2996 </tr>
2997
2998 <tr>
2999 <td>Shepards</td>
3000 <td>
3001 Distort the given list control points (any number) using an Inverse
Cristy594d2772015-11-15 10:47:42 -05003002 Squared Distance Interpolation Method (<a
3003 href="http://en.wikipedia.org/wiki/Shepard%27s_method" >Shepards
Cristy882d9f42015-10-29 16:48:39 -04003004 Method</a>). The control points in effect do 'localized' displacement
3005 of the image around the given control point (preserving the look and
3006 the rotation of the area near the control points. For best results
3007 extra control points should be added to 'lock' the positions of the
3008 corners, edges and other unchanging parts of the image, to prevent
Cristy594d2772015-11-15 10:47:42 -05003009 their movement. <br/>
Cristy882d9f42015-10-29 16:48:39 -04003010
3011 The distortion has been likened to 'taffy pulling' using nails, or
3012 pins' stuck in a block of 'jelly' which is then moved to the new
Cristy594d2772015-11-15 10:47:42 -05003013 position, distorting the surface of the jelly. <br/>
Cristy882d9f42015-10-29 16:48:39 -04003014
Cristy594d2772015-11-15 10:47:42 -05003015 Internally it is equivalent to generating a displacement map (see <a
3016 href="command-line-options.html#displace" >-displace</a>) for source image color look-up using
3017 the <a href="command-line-options.html#sparse-color" >-sparse-color</a> method of the same name.
Cristy882d9f42015-10-29 16:48:39 -04003018
3019 </td>
3020 </tr>
3021
3022</table>
3023
3024<p>To print a complete list of distortion methods, use <a href="command-line-options.html#list">-list
3025distort</a>.</p>
3026
3027<p>Many of the above distortion methods such as '<code>Affine</code>',
3028'<code>Perspective</code>', and '<code>Shepards</code>' use a list control points
3029defining how these points in the given image should be distorted in the
3030destination image. Each set of four floating point values represent a source
3031image coordinate, followed immediately by the destination image coordinate.
3032This produces a list of values such as...</p>
3033<p class="text-center"><var>
3034 U<sub>1</sub>,V<sub>1</sub> X<sub>1</sub>,Y<sub>1</sub>
3035 U<sub>2</sub>,V<sub>2</sub> X<sub>2</sub>,Y<sub>2</sub>
3036 U<sub>3</sub>,V<sub>3</sub> X<sub>3</sub>,Y<sub>3</sub>
3037 ...
3038 U<sub>n</sub>,V<sub>n</sub> X<sub>n</sub>,Y<sub>n</sub>
3039</var></p>
3040<p>where <var>U,V</var> on the source image is mapped to <var>X,Y</var> on the
3041destination image. </p>
3042
3043<p>For example, to warp an image using '<code>perspective</code>' distortion,
3044needs a list of at least 4 sets of coordinates, or 16 numbers. Here is the
3045perspective distortion of the built-in "rose:" image. Note how spaces were
3046used to group the 4 sets of coordinate pairs, to make it easier to read and
3047understand.</p>
3048
3049<pre>
3050convert rose: -virtual-pixel black \
3051 -distort Perspective '0,0,0,0 0,45,0,45 69,0,60,10 69,45,60,35' \
3052 rose_3d_rotated.gif"
3053</pre>
3054
3055<p>If more that the required number of coordinate pairs are given for
3056a distortion, the distortion method is 'least squares' fitted to produce the
3057best result for all the coordinate pairs given. If less than the ideal number
3058of points are given, the distort will generally fall back to a simpler form of
3059distortion that can handles the smaller number of coordinates (usually a linear
3060'<code>Affine</code>' distortion). </p>
3061
3062<p>By using more coordinates you can make use of image registration tool to
3063find matching coordinate pairs in overlapping images, so as to improve the
3064'fit' of the distortion. Of course a bad coordinate pair can also make the
3065'fit' worse. Caution is always advised. </p>
3066
3067<p>Colors are acquired from the source image according to a cylindrical
Cristy594d2772015-11-15 10:47:42 -05003068resampling <a href="command-line-options.html#filter" >-filter</a>, using a special technique known as
Cristy882d9f42015-10-29 16:48:39 -04003069EWA resampling. This produces very high quality results, especially when
3070images become smaller (minified) in the output, which is very common when
3071using '<code>perspective</code>' distortion. For example here we view
3072a infinitely tiled 'plane' all the way to the horizon. </p>
3073
3074<pre>
3075convert -size 90x90 pattern:checkerboard -normalize -virtual-pixel tile \
3076 -distort perspective '0,0,5,45 89,0,45,46 0,89,0,89 89,89,89,89' \
3077 checks_tiled.jpg
3078</pre>
3079
3080<p>Note that a infinitely tiled perspective images involving the horizon can
3081be very slow, because of the number of pixels that are compressed to generate
3082each individual pixel close to the 'horizon'. You can turn off EWA
Cristy594d2772015-11-15 10:47:42 -05003083resampling, by specifying the special <a href="command-line-options.html#filter" >-filter</a> setting of
Cristy882d9f42015-10-29 16:48:39 -04003084'<code>point</code>' (recommended if you plan to use super-sampling instead).
3085</p>
3086
3087<p>If an image generates <i>invalid pixels</i>, such as the 'sky' in the last
Cristy594d2772015-11-15 10:47:42 -05003088example, <a href="command-line-options.html#distort" >-distort</a> will use the current <a
Cristyb7f455a2017-03-03 19:30:34 -05003089href="command-line-options.html#mattecolor" >-mattecolor</a> setting for these pixels. If you do not
Cristy882d9f42015-10-29 16:48:39 -04003090what these pixels to be visible, set the color to match the rest of the
3091ground. </p>
3092
3093<p>The output image size will by default be the same as the input image. This
3094means that if the part of the distorted image falls outside the viewed area of
3095the 'distorted space', those parts is clipped and lost. However if you use
Cristy594d2772015-11-15 10:47:42 -05003096the plus form of the operator (<a href="command-line-options.html#distort" >+distort</a>) the operator
Cristy882d9f42015-10-29 16:48:39 -04003097will attempt (if possible) to show the whole of the distorted image, while
3098retaining a correct 'virtual canvas' offset, for image layering. This offset
Cristy594d2772015-11-15 10:47:42 -05003099may need to be removed using <a href="command-line-options.html#repage" >+repage</a>, to remove if it
Cristy882d9f42015-10-29 16:48:39 -04003100is unwanted. </p>
3101
Cristy594d2772015-11-15 10:47:42 -05003102<p>Setting <a href="command-line-options.html#verbose" >-verbose</a> setting, will cause <a
3103href="command-line-options.html#distort" >-distort</a> to attempt to output the internal coefficients,
3104and the <a href="command-line-options.html#fx" >-fx</a> equivalent to the distortion, for expert study,
Cristy882d9f42015-10-29 16:48:39 -04003105and debugging purposes. This many not be available for all distorts. </p>
3106
Cristy594d2772015-11-15 10:47:42 -05003107<p>You can alternatively specify a special "<code><a href="command-line-options.html#define"
3108>-define</a> distort:viewport={geometry_string}</code>" setting which will
Cristy882d9f42015-10-29 16:48:39 -04003109specify the size and the offset of the generated 'viewport' image of the
3110distorted image space.</p>
3111
Cristy594d2772015-11-15 10:47:42 -05003112<p>Setting a "<code><a href="command-line-options.html#define" >-define</a>
Cristy769d8892016-01-19 18:11:14 -05003113distort:scale=<var>scale_factor</var></code>" will scale the output image (viewport or
Cristy882d9f42015-10-29 16:48:39 -04003114otherwise) by that factor without changing the viewed contents of the
3115distorted image. This can be used either for 'super-sampling' the image for
3116a higher quality result, or for panning and zooming around the image (with
3117appropriate viewport changes, or post-distort cropping and resizing). </p>
3118
Cristy594d2772015-11-15 10:47:42 -05003119<p>Setting "<code><a href="command-line-options.html#define" >-define</a> resample:verbose=1</code>"
Cristy882d9f42015-10-29 16:48:39 -04003120will output the cylindrical filter lookup table created by the EWA (Elliptical
3121Weighted Average) resampling algorithm. Note this table uses a squared radius
3122lookup value. This is typically only used for debugging EWA resampling. </p>
3123
3124
3125<div style="margin: auto;">
3126 <h3 class="magick-header"><a id="distribute-cache"></a>-distribute-cache <var>port</var></h3>
3127</div>
3128
3129<p class="magick-description">launch a distributed pixel cache server. </p>
3130
3131<div style="margin: auto;">
3132 <h3 class="magick-header"><a id="dither"></a>-dither <var>method</var></h3>
3133</div>
3134
3135<p class="magick-description">Apply a Riemersma or Floyd-Steinberg error diffusion dither to
3136images when general color reduction is applied via an option, or automagically
3137when saving to specific formats. This enabled by default.</p>
3138
3139<p>Dithering places two or more colors in neighboring pixels so that to the
3140eye a closer approximation of the images original color is reproduced. This
3141reduces the number of colors needed to reproduce the image but at the cost of
3142a lower level pattern of colors. Error diffusion dithers can use any set of
3143colors (generated or user defined) to an image. </p>
3144
3145<p>Dithering is turned on by default, to turn it off use the plus form of the
3146setting, <a href="command-line-options.html#dither">+dither</a>. This will also also render PostScript
3147without text or graphic aliasing. Disabling dithering often (but not always)
3148leads to faster process, a smaller number of colors, but more cartoon like
3149image coloring. Generally resulting in 'color banding' effects in areas with
3150color gradients. </p>
3151
Cristy594d2772015-11-15 10:47:42 -05003152<p>The color reduction operators <a href="command-line-options.html#colors">-colors</a>, <a
3153href="command-line-options.html#monochrome">-monochrome</a>, <a href="command-line-options.html#remap ">-remap</a>, and <a
3154href="command-line-options.html#posterize">-posterize</a>, apply dithering to images using the reduced
Cristy882d9f42015-10-29 16:48:39 -04003155color set they created. These operators are also used as part of automatic
3156color reduction when saving images to formats with limited color support, such
3157as <code>GIF:</code>, <code>XBM:</code>, and others, so dithering may also be used
3158in these cases. </p>
3159
3160<p>Alternatively you can use <a href="command-line-options.html#random-threshold">-random-threshold</a>
Cristy594d2772015-11-15 10:47:42 -05003161to generate purely random dither. Or use <a
3162href="command-line-options.html#ordered-dither">-ordered-dither</a> to apply threshold mapped dither
Cristy882d9f42015-10-29 16:48:39 -04003163patterns, using uniform color maps, rather than specific color maps. </p>
3164
3165
3166<div style="margin: auto;">
3167 <h3 class="magick-header"><a id="draw"></a>-draw <var>string</var></h3>
3168</div>
3169
3170<p class="magick-description">Annotate an image with one or more graphic primitives.</p>
3171
3172<p>Use this option to annotate or decorate an image with one or more graphic
3173primitives. The primitives include shapes, text, transformations, and pixel
3174operations.</p>
3175
3176<p>The shape primitives:</p>
3177
3178<dl class="dl-horizontal">
3179<dt>point</dt><dd> x,y</dd>
3180<dt>line</dt><dd> x0,y0 x1,y1</dd>
3181<dt>rectangle</dt><dd> x0,y0 x1,y1</dd>
3182<dt>roundRectangle</dt><dd> x0,y0 x1,y1 wc,hc</dd>
3183<dt>arc</dt><dd> x0,y0 x1,y1 a0,a1</dd>
3184<dt>ellipse</dt><dd> x0,y0 rx,ry a0,a1</dd>
3185<dt>circle</dt><dd> x0,y0 x1,y1</dd>
3186<dt>polyline</dt><dd> x0,y0 ... xn,yn</dd>
3187<dt>polygon</dt><dd> x0,y0 ... xn,yn</dd>
3188<dt>bezier</dt><dd> x0,y0 ... xn,yn</dd>
3189<dt>path</dt><dd>specification </dd>
3190<dt>image</dt><dd> operator x0,y0 w,h filename</dd>
3191</dl>
3192
3193<p>The text primitive:</p>
3194
3195<dl class="dl-horizontal">
3196<dt>text</dt><dd>x0,y0 string</dd>
3197</dl>
3198<p>The text gravity primitive:</p>
3199
3200<dl class="dl-horizontal">
3201<dt>gravity</dt><dd>NorthWest, North, NorthEast, West, Center, East, SouthWest, South, or SouthEast</dd>
3202</dl>
3203
3204<p>The text gravity primitive only affects the placement of text and does not
Cristy594d2772015-11-15 10:47:42 -05003205interact with the other primitives. It is equivalent to using the <a
3206href="command-line-options.html#gravity">-gravity</a> command-line option, except that it is limited in
Cristy882d9f42015-10-29 16:48:39 -04003207scope to the <a href="command-line-options.html#draw">-draw</a> option in which it appears.</p>
3208
3209<p>The transformation primitives:</p>
3210
3211<dl class="dl-horizontal">
3212<dt>rotate</dt><dd>degrees</dd>
3213<dt>translate</dt><dd>dx,dy</dd>
3214<dt>scale</dt><dd>sx,sy</dd>
3215<dt>skewX</dt><dd>degrees</dd>
3216<dt>skewY</dt><dd>degrees</dd>
3217</dl>
3218
3219<p>The pixel operation primitives:</p>
3220
3221<dl class="dl-horizontal">
3222<dt>color</dt><dd>x0,y0 method</dd>
3223<dt>matte</dt><dd>x0,y0 method</dd>
3224</dl>
3225
Cristy594d2772015-11-15 10:47:42 -05003226<p>The shape primitives are drawn in the color specified by the preceding <a
3227href="command-line-options.html#fill">-fill</a> setting. For unfilled shapes, use <a
3228href="command-line-options.html#fill">-fill none</a>. You can optionally control the stroke (the
3229"outline" of a shape) with the <a href="command-line-options.html#stroke">-stroke</a> and <a
3230href="command-line-options.html#strokewidth">-strokewidth</a> settings.</p>
Cristy882d9f42015-10-29 16:48:39 -04003231
3232<p>A <code>point</code> primitive is specified by a single <var>point</var> in the
3233pixel plane, that is, by an ordered pair of integer coordinates,
3234<var>x</var>,<var>y</var>. (As it involves only a single pixel, a <code>point</code>
Cristy594d2772015-11-15 10:47:42 -05003235primitive is not affected by <a href="command-line-options.html#stroke">-stroke</a> or <a
3236href="command-line-options.html#strokewidth">-strokewidth</a>.)</p>
Cristy882d9f42015-10-29 16:48:39 -04003237
3238<p>A <code>line</code> primitive requires a start point and end point.</p>
3239
3240<p>A <code>rectangle</code> primitive is specified by the pair of points at the
3241upper left and lower right corners.</p>
3242
3243<p>A <code>roundRectangle</code> primitive takes the same corner points as
3244a <code>rectangle</code> followed by the width and height of the rounded corners
3245to be removed.</p>
3246
3247<p>The <code>circle</code> primitive makes a disk (filled) or circle (unfilled).
3248Give the center and any point on the perimeter (boundary).</p>
3249
3250<p>The <code>arc</code> primitive is used to inscribe an elliptical segment in
3251to a given rectangle. An <code>arc</code> requires the two corners used for
3252<code>rectangle</code> (see above) followed by the start and end angles of the
3253arc of the segment segment (e.g. 130,30 200,100 45,90). The start and end
3254points produced are then joined with a line segment and the resulting segment
3255of an ellipse is filled.</p>
3256
3257<p>Use <code>ellipse</code> to draw a partial (or whole) ellipse. Give the
3258center point, the horizontal and vertical "radii" (the <var>semi-axes</var> of
3259the ellipse) and start and end angles in degrees (e.g. 100,100 100,150
32600,360).</p>
3261
3262<p>The <code>polyline</code> and <code>polygon</code> primitives require three or
3263more points to define their perimeters. A <code>polyline</code> is simply
3264a <code>polygon</code> in which the final point is not stroked to the start
Cristy594d2772015-11-15 10:47:42 -05003265point. When unfilled, this is a <var>polygonal line</var>. If the <a
3266href="command-line-options.html#stroke">-stroke</a> setting is <code>none</code> (the default), then
Cristy882d9f42015-10-29 16:48:39 -04003267a <code>polyline</code> is identical to a <code>polygon</code>. </p>
3268
3269<p>A <var>coordinate</var> is a pair of integers separated by a space or
3270optional comma. </p>
3271
3272<p>As an example, to define a circle centered at 100,100 that extends to
3273150,150 use:</p>
3274
3275<pre>
3276-draw 'circle 100,100 150,150'
3277</pre>
3278
3279<p>The <code>Bezier</code> primitive creates a spline curve and requires three
3280or points to define its shape. The first and last points are the
3281<var>knots</var> and these points are attained by the curve, while any
3282intermediate coordinates are <var>control points</var>. If two control points
3283are specified, the line between each end knot and its sequentially respective
3284control point determines the tangent direction of the curve at that end. If
3285one control point is specified, the lines from the end knots to the one
3286control point determines the tangent directions of the curve at each end. If
3287more than two control points are specified, then the additional control points
3288act in combination to determine the intermediate shape of the curve. In order
3289to draw complex curves, it is highly recommended either to use the
3290<code>path</code> primitive or to draw multiple four-point bezier segments with
3291the start and end knots of each successive segment repeated. For example:</p>
3292
3293<pre>
3294-draw 'bezier 20,50 45,100 45,0 70,50'
3295-draw 'bezier 70,50 95,100 95,0 120,50'
3296</pre>
3297
3298<p>A <code>path</code> represents an outline of an object, defined in terms of
3299moveto (set a new current point), lineto (draw a straight line), curveto (draw
3300a Bezier curve), arc (elliptical or circular arc) and closepath (close the
3301current shape by drawing a line to the last moveto) elements. Compound paths
3302(i.e., a path with subpaths, each consisting of a single moveto followed by
3303one or more line or curve operations) are possible to allow effects such as
Cristy594d2772015-11-15 10:47:42 -05003304<var>donut holes</var> in objects. (See <a
3305href="http://www.w3.org/TR/SVG/paths.html">Paths</a>.)</p>
Cristy882d9f42015-10-29 16:48:39 -04003306
3307<p>Use <code>image</code> to composite an image with another image. Follow the
3308image keyword with the composite operator, image location, image size, and
3309filename:</p>
3310
3311<pre>
3312-draw 'image SrcOver 100,100 225,225 image.jpg'
3313</pre>
3314
3315<p>You can use 0,0 for the image size, which means to use the actual
3316dimensions found in the image header. Otherwise, it is scaled to the given
Cristy6549abb2016-11-10 08:25:55 -05003317dimensions. See <a href="http://www.imagemagick.org/www/compose.html">Alpha Compositing</a> for
Cristy882d9f42015-10-29 16:48:39 -04003318a detailed discussion of alpha composition methods that are available. </p>
3319
3320<p>The "special augmented compose operators" such as "dissolve" that require
3321arguments cannot be used at present with the <code>-draw image</code> option.
3322 </p>
3323
3324<p>Use <code>text</code> to annotate an image with text. Follow the text
3325coordinates with a string. If the string has embedded spaces, enclose it in
3326single or double quotes.</p>
3327
3328<p>For example, the following annotates the image with <code>Works like
3329magick!</code> for an image titled <code>bird.miff</code>. </p>
3330
3331<pre>
3332-draw "text 100,100 'Works like magick!' "
3333</pre>
3334
3335<p>See the <a href="command-line-options.html#annotate">-annotate</a> option for another convenient way
3336to annotate an image with text.</p>
3337
3338<p>The <code>rotate</code> primitive rotates subsequent shape primitives and
Cristy594d2772015-11-15 10:47:42 -05003339text primitives about the origin of the main image. If the <a
3340href="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 -04003341option, the origin for transformations is the upper left corner of the
3342region.</p>
3343
3344<p>The <code>translate</code> primitive translates subsequent shape and text
3345primitives.</p>
3346
3347<p>The <code>scale</code> primitive scales them.</p>
3348
3349<p>The <code>skewX</code> and <code>skewY</code> primitives skew them with respect
3350to the origin of the main image or the region.</p>
3351
3352<p>The transformations modify the current affine matrix, which is initialized
3353from the initial affine matrix defined by the <a href="command-line-options.html#affine">-affine</a>
3354option. Transformations are cumulative within the <a href="command-line-options.html#draw">-draw</a>
3355option. The initial affine matrix is not affected; that matrix is only changed
3356by the appearance of another <a href="command-line-options.html#affine">-affine</a> option. If another
3357<a href="command-line-options.html#draw">-draw</a> option appears, the current affine matrix is
3358reinitialized from the initial affine matrix.</p>
3359
3360<p>Use the <code>color</code> primitive to change the color of a pixel to the
3361fill color (see <a href="command-line-options.html#fill">-fill</a>). Follow the pixel coordinate with
3362a method:</p>
3363
3364<pre>
3365point
3366replace
3367floodfill
3368filltoborder
3369reset
3370</pre>
3371
3372<p>Consider the target pixel as that specified by your coordinate. The
3373<code>point</code> method recolors the target pixel. The <code>replace</code>
3374method recolors any pixel that matches the color of the target pixel.
3375<code>Floodfill</code> recolors any pixel that matches the color of the target
3376pixel and is a neighbor, whereas <code>filltoborder</code> recolors any neighbor
3377pixel that is not the border color. Finally, <code>reset</code> recolors all
3378pixels.</p>
3379
3380<p>Use <code>matte</code> to the change the pixel matte value to transparent.
3381Follow the pixel coordinate with a method (see the <code>color</code> primitive
3382for a description of methods). The <code>point</code> method changes the matte
3383value of the target pixel. The <code>replace</code> method changes the matte
3384value of any pixel that matches the color of the target pixel.
3385<code>Floodfill</code> changes the matte value of any pixel that matches the
3386color of the target pixel and is a neighbor, whereas <code>filltoborder</code>
Cristy594d2772015-11-15 10:47:42 -05003387changes the matte value of any neighbor pixel that is not the border color (<a
3388href="command-line-options.html#bordercolor">-bordercolor</a>). Finally <code>reset</code> changes the
Cristy882d9f42015-10-29 16:48:39 -04003389matte value of all pixels.</p>
3390
Cristy594d2772015-11-15 10:47:42 -05003391<p>You can set the primitive color, font, and font bounding box color with <a
3392href="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 -04003393respectively. Options are processed in command line order so be sure to use
3394these options <var>before</var> the <a href="command-line-options.html#draw">-draw</a> option.</p>
3395
3396<p>Strings that begin with a number must be quoted (e.g. use '1.png' rather
3397than 1.png).</p>
3398
Cristy594d2772015-11-15 10:47:42 -05003399<p>Drawing primitives conform to the <a href="magick-vector-graphics.html" >Magick
Cristy882d9f42015-10-29 16:48:39 -04003400Vector Graphics</a> format.</p>
3401
3402
3403<div style="margin: auto;">
3404 <h3 class="magick-header"><a id="duplicate"></a>-duplicate <var>count,indexes</var></h3>
3405</div>
3406
3407<p class="magick-description">duplicate an image one or more times.</p>
3408
3409<p>Specify the count and the image to duplicate by its index in the sequence.
3410The first image is index 0. Negative indexes are relative to the end of the
3411sequence, for example, -1 represents the last image of the sequence. Specify
3412a range of images with a dash (e.g. 0-4). Separate indexes with a comma (e.g.
34130,2). Use <code>+duplicate</code> to duplicate the last image in the current
3414image sequence.</p>
3415
3416<div style="margin: auto;">
3417 <h3 class="magick-header"><a id="edge"></a>-edge <var>radius</var></h3>
3418</div>
3419
3420<p class="magick-description">detect edges within an image.</p>
3421
3422<div style="margin: auto;">
3423 <h3 class="magick-header"><a id="emboss"></a>-emboss <var>radius</var></h3>
3424</div>
3425
3426<p class="magick-description">emboss an image.</p>
3427
3428<div style="margin: auto;">
3429 <h3 class="magick-header"><a id="encipher"></a>-encipher <var>filename</var></h3>
3430</div>
3431
3432<p class="magick-description">Encipher pixels for later deciphering by <a href="command-line-options.html#decipher">-decipher</a>.</p>
3433
3434<p>Get the passphrase from the file specified by <var>filename</var>.</p>
3435
Cristy594d2772015-11-15 10:47:42 -05003436<p>For more information, see the webpage, <a
Cristy6549abb2016-11-10 08:25:55 -05003437href="https://www.imagemagick.org/script/cipher.html">ImageMagick: Encipher or
Cristy882d9f42015-10-29 16:48:39 -04003438Decipher an Image</a>.</p>
3439
3440
3441
3442<div style="margin: auto;">
3443 <h3 class="magick-header"><a id="encoding"></a>-encoding <var>type</var></h3>
3444</div>
3445
3446<p class="magick-description">specify the text encoding.</p>
3447
3448<p>Choose from</p>
3449
3450<pre>
3451AdobeCustom AdobeExpert
3452AdobeStandard AppleRoman
3453BIG5 GB2312
3454Latin 2 None
3455SJIScode Symbol
3456Unicode Wansung
3457</pre>
3458
3459<div style="margin: auto;">
3460 <h3 class="magick-header"><a id="endian"></a>-endian <var>type</var></h3>
3461</div>
3462
3463<p class="magick-description">Specify endianness (<code>MSB</code> or <code>LSB</code>) of the image.</p>
3464
3465<p>To print a complete list of endian types, use the <a href="command-line-options.html#list">-list endian</a> option.</p>
3466
3467<p>Use <a href="command-line-options.html#endian">+endian</a> to revert to unspecified endianness.</p>
3468
3469
3470<div style="margin: auto;">
3471 <h3 class="magick-header"><a id="enhance"></a>-enhance</h3>
3472</div>
3473
3474<p class="magick-description">Apply a digital filter to enhance a noisy image.</p>
3475
3476
3477<div style="margin: auto;">
3478 <h3 class="magick-header"><a id="equalize"></a>-equalize</h3>
3479</div>
3480
3481<p class="magick-description">perform histogram equalization on the image channel-by-channel.</p>
3482
3483<p>To perform histogram equalization on all channels in concert, transform the
3484image into some other color space, such as HSL, OHTA, YIQ or YUV, then
3485equalize the appropriate intensity-like channel, then convert back to RGB.</p>
3486
3487<p>For example using HSL, we have: ... <code>-colorspace HSL -channel lightness
3488-equalize -colorspace RGB</code> ...</p>
3489
3490<p>For YIQ, YUV and OHTA use the red channel. For example, OHTA is a principal
3491components transformation that puts most of the information in the first
3492channel. Here we have ... <code>-colorspace OHTA -channel red -equalize
3493-colorspace RGB</code> ...</p>
3494
3495<div style="margin: auto;">
3496 <h3 class="magick-header"><a id="evaluate"></a>-evaluate <var>operator value</var></h3>
3497</div>
3498
3499<p class="magick-description">Alter channel pixels by evaluating an arithmetic, relational, or logical expression.</p>
3500
Cristy594d2772015-11-15 10:47:42 -05003501<p>(See the <a href="command-line-options.html#function" >-function</a> operator for some
3502multi-parameter functions. See the <a href="command-line-options.html#fx" >-fx</a> operator if more
Cristy882d9f42015-10-29 16:48:39 -04003503elaborate calculations are needed.)</p>
3504
3505<p>The behaviors of each <var>operator</var> are summarized in the
3506following list. For brevity, the numerical value of a "pixel" referred to
3507below is the value of the corresponding channel of that pixel, while
3508a "normalized pixel" is that number divided by the maximum
3509(installation-dependent) value <var>QuantumRange</var>. (If
3510normalized pixels are used, they are restored, following the other
3511calculations, to the full range by multiplying by <var>QuantumRange</var>.)</p>
3512
3513<table class="table table-condensed table-striped">
Cristy594d2772015-11-15 10:47:42 -05003514 <col width="25%" />
3515 <col width="75%" />
Cristy882d9f42015-10-29 16:48:39 -04003516 <thead>
3517 <tr>
3518 <th><var>operator</var></th>
3519 <th>Summary (see further below for details)</th>
3520 </tr>
3521 </thead>
3522 <tbody>
3523
3524 <tr><td>Abs </td> <td>Add <var>value</var> to pixels and return absolute value. </td></tr>
3525 <tr><td>Add </td> <td>Add <var>value</var> to pixels. </td></tr>
3526 <tr><td>AddModulus </td> <td>Add <var>value</var> to pixels modulo <var>QuantumRange</var>.</td></tr>
3527 <tr><td>And </td> <td>Binary AND of pixels with <var>value</var>.</td></tr>
3528 <tr><td>Cos, Cosine </td> <td>Apply cosine to pixels with frequency <var>value</var> with 50% bias added.</td></tr>
3529 <tr><td>Divide </td> <td>Divide pixels by <var>value</var>.</td></tr>
3530 <tr><td>Exp </td> <td>base-e exponential function</td></tr>
3531 <tr><td>Exponential </td> <td>base-e exponential function</td></tr>
3532 <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>
3533 <tr><td>Log </td> <td>Apply scaled logarithm to normalized pixels.</td></tr>
3534 <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>
3535 <tr><td>Mean </td> <td>Add the <var>value</var> and divide by 2.</td></tr>
3536 <tr><td>Median </td> <td>Choose the median value from an image sequence.</td></tr>
3537 <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>
3538 <tr><td>Multiply </td> <td>Multiply pixels by <var>value</var>.</td></tr>
3539 <tr><td>Or </td> <td>Binary OR of pixels with <var>value</var>.</td></tr>
3540 <tr><td>Pow </td> <td>Raise normalized pixels to the power <var>value</var>.</td></tr>
3541 <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>
3542 <tr><td>RMS</td> <td>Square the pixel and add the <var>value</var>.</td></tr>
3543 <tr><td>RootMeanSquare</td> <td>Square the pixel and add the <var>value</var>.</td></tr>
3544 <tr><td>Set </td> <td>Set pixel equal to <var>value</var>.</td></tr>
3545 <tr><td>Sin, Sine </td> <td>Apply sine to pixels with frequency <var>value</var> with 50% bias added.</td></tr>
3546 <tr><td>Subtract </td> <td>Subtract <var>value</var> from pixels.</td></tr>
3547 <tr><td>Xor </td> <td>Binary XOR of pixels with <var>value.</var></td></tr>
3548
3549 <tr><td> </td><td> </td></tr>
3550
3551 <tr><td>Gaussian-noise</td><td> </td></tr>
3552 <tr><td>Impulse-noise</td><td> </td></tr>
3553 <tr><td>Laplacian-noise</td><td> </td></tr>
Cristy594d2772015-11-15 10:47:42 -05003554 <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 -04003555 <tr><td>PoissonNoise</td><td> </td></tr>
3556 <tr><td>Uniform-noise</td><td> </td></tr>
3557
3558 <tr><td> </td><td> </td></tr>
3559
3560 <tr><td>Threshold </td> <td>Threshold pixels larger than <var>value</var>.</td></tr>
3561 <tr><td>ThresholdBlack </td> <td>Threshold pixels to zero values equal to or below <var>value</var>.</td></tr>
3562 <tr><td>ThresholdWhite </td> <td>Threshold pixels to maximum values above <var>value</var>. </td></tr>
3563 </tbody>
3564 </table>
3565
Cristy594d2772015-11-15 10:47:42 -05003566<p>The specified functions are applied only to each previously set <a
3567href="command-line-options.html#channel" >-channel</a> in the image. If necessary, the results of the
Cristy882d9f42015-10-29 16:48:39 -04003568calculations are truncated (clipped) to fit in the interval [0, <var>QuantumRange</var>]. The transparency channel of the image is
3569represented as a 'alpha' values (0 = fully transparent), so, for example, a
3570<code>Divide</code> by 2 of the alpha channel will make the image
3571semi-transparent. Append the percent symbol '<code>%</code>' to specify a value
3572as a percentage of the <var>QuantumRange</var>.</p>
3573
3574<p>To print a complete list of <a href="command-line-options.html#evaluate">-evaluate</a> operators, use
3575<a href="command-line-options.html#list">-list evaluate</a>.</p>
3576
3577<p>The results of the <code>Add</code>, <code>Subtract</code> and
Cristy594d2772015-11-15 10:47:42 -05003578<code>Multiply</code> methods can also be achieved using either the <a
3579href="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 -04003580appropriate argument, to linearly modify the overall range of color values.
Cristy594d2772015-11-15 10:47:42 -05003581Please note, however, that <a href="command-line-options.html#level" >-level</a> treats transparency as
3582'matte' values (0 = opaque), while <a href="command-line-options.html#level" >-evaluate</a> works with
Cristy882d9f42015-10-29 16:48:39 -04003583'alpha' values.</p>
3584
3585<p><code>AddModulus</code> has been added as of ImageMagick 6.4.8-4 and provides
3586addition modulo the <var>QuantumRange</var>. It is therefore
3587equivalent to <code>Add</code> unless the resulting pixel value is outside the
3588interval [0, <var>QuantumRange</var>]. </p>
3589
3590<p><code>Exp or Exponential</code> has been added as of ImageMagick 6.6.5-1 and
3591works on normalized pixel values. The <var>value</var> used with
3592<code>Exp</code> should be negative so as to produce a decaying exponential
3593function. Non-negative values will always produce results larger unity and
3594thus outside the interval [0, <var>QuantumRange</var>]. The
3595formula is expressed below. </p>
3596
3597<p class="text-center">
3598exp(<var>value</var> × <b><var>u</var></b>)
3599</p>
3600
Cristy594d2772015-11-15 10:47:42 -05003601<p> If the input image is squared, for example, using <a href="command-line-options.html#-function"
3602>-function polynomial "2 0 0"</a>, then a decaying Gaussian function will be
Cristy882d9f42015-10-29 16:48:39 -04003603the result.</p>
3604
3605<p><code>Log</code> has been added as of ImageMagick 6.4.2-1 and works on
3606normalized pixel values. This a <var>scaled</var> log function. The <var>value</var> used with <code>Log</code> provides a <var>scaling
3607factor</var> that adjusts the curvature in the graph of the log function. The
3608formula applied to a normalized value <b><var>u</var></b> is below. </p>
3609
3610<p class="text-center">
3611log(<var>value</var> × <b><var>u</var></b> + 1) / log(<var>value</var> + 1)
3612</p>
3613
3614<p><code>Pow</code> has been added as of ImageMagick 6.4.1-9, and works on
Cristy594d2772015-11-15 10:47:42 -05003615normalized pixel values. Note that <code>Pow</code> is related to the <a
3616href="command-line-options.html#gamma" >-gamma</a> operator. For example, <b>-gamma 2</b> is equivalent
Cristy882d9f42015-10-29 16:48:39 -04003617to <b>-evaluate pow 0.5</b>, i.e., a 'square root' function. The value used
Cristy594d2772015-11-15 10:47:42 -05003618with <a href="command-line-options.html#gamma" >-gamma</a> is simply the reciprocal of the value used
Cristy882d9f42015-10-29 16:48:39 -04003619with <code>Pow</code>.</p>
3620
3621<p><code>Cosine</code> and <code>Sine</code> was added as of IM v6.4.8-8 and
3622converts the image values into a value according to a (co)sine wave function.
3623The synonyms <code>Cos</code> and <code>Sin</code> may also be used. The output
3624is biased 50% and normalized by 50% so as to fit in the respective color value
3625range. The <var>value</var> scaling of the <var>period</var> of the
3626function (its frequency), and thus determines the number of 'waves' that will
3627be 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,
3628then the effective period is the <var>half</var> the <var>QuantumRange</var>.</p>
3629
3630<p class="text-center">
36310.5 + 0.5 × cos(2 π <b><var>u</var></b> × <var>value</var>).
3632</p>
3633
Cristy594d2772015-11-15 10:47:42 -05003634<p>See also the <a href="command-line-options.html#function" >-function</a> operator, which is a
Cristy882d9f42015-10-29 16:48:39 -04003635multi-value version of evaluate. </p>
3636
3637<div style="margin: auto;">
3638 <h3 class="magick-header"><a id="evaluate-sequence"></a>-evaluate-sequence <var>operator</var></h3>
3639</div>
3640
3641<p class="magick-description">Alter channel pixels by evaluating an arithmetic, relational, or
3642logical expression over a sequence of images.</p>
3643
Cristy594d2772015-11-15 10:47:42 -05003644<p>To print a complete list of <a
3645href="command-line-options.html#evaluate-sequence">-evaluate-sequence</a> operators, use <a
3646href="command-line-options.html#list">-list evaluate</a>.</p>
Cristy882d9f42015-10-29 16:48:39 -04003647
3648<div style="margin: auto;">
3649 <h3 class="magick-header"><a id="extent"></a>-extent <var>geometry</var></h3>
3650</div>
3651
3652<p class="magick-description">Set the image size and offset.</p>
3653
3654<p>If the image is enlarged, unfilled areas are set to the background color.
3655To position the image, use offsets in the <var>geometry</var>
3656specification or precede with a <a href="command-line-options.html#gravity">-gravity</a> setting. To
Cristy594d2772015-11-15 10:47:42 -05003657specify how to compose the image with the background, use <a href="command-line-options.html#compose"
3658>-compose</a>.</p>
Cristy882d9f42015-10-29 16:48:39 -04003659
3660<p>This command reduces or expands a JPEG image to fit on an 800x600
3661display. If the aspect ratio of the input image isn't exactly 4:3, then the
3662image is centered on an 800x600 black canvas: </p>
3663
3664<pre>
3665convert input.jpg -resize 800x600 -background black -compose Copy \
3666 -gravity center -extent 800x600 -quality 92 output.jpg
3667</pre>
3668
3669<p>See <a href="command-line-processing.html#geometry">Image Geometry</a> for complete details about the <em class="arg">geometry</em> argument.</p>
3670
3671<div style="margin: auto;">
3672 <h3 class="magick-header"><a id="extract"></a>-extract <var>geometry</var></h3>
3673</div>
3674
3675<p class="magick-description">Extract the specified area from image.</p>
3676
3677<p>This option is most useful for extracting a subregion of a very large raw
3678image. Note that these two commands are equivalent:</p>
3679
3680<pre>
3681convert -size 16000x16000 -depth 8 -extract 640x480+1280+960 \
3682 image.rgb image.png",
3683convert -size 16000x16000 -depth 8 'image.rgb[640x480+1280+960]' \
3684 image.rgb image.png"
3685</pre>
3686
3687<p>If you omit the offsets, as in</p>
3688
3689<pre>
3690convert -size 16000x16000 -depth 8 -extract 640x480 \
3691 image.rgb image.png
3692</pre>
3693
3694<p>the image is <var>resized</var> to the specified dimensions instead,
3695equivalent to:</p>
3696
3697<pre>
3698convert -size 16000x16000 -depth 8 -resize 640x480 image.rgb image.png
3699</pre>
3700
3701<p>See <a href="command-line-processing.html#geometry">Image Geometry</a> for complete details about the <em class="arg">geometry</em> argument.</p>
3702
3703<div style="margin: auto;">
3704 <h3 class="magick-header"><a id="family"></a>-family <var>fontFamily</var></h3>
3705</div>
3706
3707<p class="magick-description">Set a font family for text.</p>
3708
3709<p>This setting suggests a font family that ImageMagick should try to use for
3710rendering text. If the family can be found it is used; if not, a default font
3711(e.g., "Arial") or a family known to be similar is substituted (e.g.,
3712"Courier" might be used if "System" is requested but not found). </p>
3713
Cristy594d2772015-11-15 10:47:42 -05003714<p>For other settings that affect fonts, see the options <a
3715href="command-line-options.html#font">-font</a>, <a href="command-line-options.html#stretch">-stretch</a>, <a
3716href="command-line-options.html#style">-style</a>, and <a href="command-line-options.html#weight">-weight</a>. </p>
Cristy882d9f42015-10-29 16:48:39 -04003717
3718<div style="margin: auto;">
3719 <h3 class="magick-header"><a id="features"></a>-features <var>distance</var></h3>
3720</div>
3721
3722<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>
3723
3724<pre>
3725Angular Second Moment Sum Entropy
3726Contrast Entropy
3727Correlation Difference Variance
3728Sum of Squares Variance Difference Entropy
3729Inverse Difference Moment Information Measure of Correlation 1
3730Sum Average Information Measure of Correlation 2
3731Sum Variance Maximum Correlation Coefficient
3732</pre>
3733
3734<div style="margin: auto;">
3735 <h3 class="magick-header"><a id="fft"></a>-fft</h3>
3736</div>
3737
3738<p class="magick-description">implements the forward discrete Fourier transform (DFT).</p>
3739
3740<p>This option is new as of ImageMagick 6.5.4-3 (and now working for Windows
3741users in ImageMagick 6.6.0-9). It transforms an image from the normal
3742(spatial) domain to the frequency domain. In the frequency domain, an image is
3743represented as a superposition of complex sinusoidal waves of varying
3744amplitudes. The image x and y coordinates are the possible frequencies along
3745the x and y directions, respectively, and the pixel intensity values are
3746complex numbers that correspond to the sinusoidal wave amplitudes. See for
3747example, <a href="http://en.wikipedia.org/wiki/Fourier_transform">Fourier
3748Transform</a>, <a href="http://en.wikipedia.org/wiki/DFT">Discrete Fourier
3749Transform</a> and <a href="http://en.wikipedia.org/wiki/FFT">Fast Fourier
3750Transform</a>.</p>
3751
3752<p>A single image name is provided as output for this option. However, the
3753output result will have two components. It is either a two-frame image or two
3754separate images, depending upon whether the image format specified supports
3755multi-frame images. The reason that we get a dual output result is because the
3756frequency domain represents an image using complex numbers, which cannot be
3757visualized directly. Therefore, the complex values are automagically separated
3758into a two-component image representation. The first component is the
3759magnitude of the complex number and the second is the phase of the complex
Cristy594d2772015-11-15 10:47:42 -05003760number. See for example, <a
3761href="http://en.wikipedia.org/wiki/Complex_numbers">Complex Numbers</a>.</p>
Cristy882d9f42015-10-29 16:48:39 -04003762
3763<p>The magnitude and phase component images must be specified using image
3764formats that do not limit the color or compress the image. Thus, MIFF, TIF,
3765PFM, EXR and PNG are the recommended image formats to use. All of these
3766formats, except PNG support multi-frame images. So for example,</p>
3767
3768<pre>
3769convert image.png -fft fft_image.miff
3770</pre>
3771
3772<p>generates a magnitude image as <code>fft_image.miff[0]</code> and a phase
3773image as <code>fft_image.miff[1]</code>. Similarly,</p>
3774
3775<pre>
3776convert image.png -fft fft_image.png
3777</pre>
3778
3779<p>generates a magnitude image as <code>fft_image-0.png</code> and a phase image
3780as <code>fft_image-1.png</code>. If you prefer this representation, then you can
Cristy594d2772015-11-15 10:47:42 -05003781force any of the other formats to produce two output images by including <a
3782href="command-line-options.html#adjoin">+adjoin</a> following -fft in the command line.</p>
Cristy882d9f42015-10-29 16:48:39 -04003783
3784<p>The input image can be any size, but if not square and even-dimensioned, it
3785is padded automagically to the larger of the width or height of the input
3786image and to an even number of pixels. The padding will occur at the bottom
3787and/or right sides of the input image. The resulting output magnitude and
Cristy594d2772015-11-15 10:47:42 -05003788phase images is square at this size. The kind of padding relies on the <a
3789href="command-line-options.html#virtual-pixel">-virtual-pixel</a> setting.</p>
Cristy882d9f42015-10-29 16:48:39 -04003790
3791<p>Both output components will have dynamic ranges that fit within
3792[0, <var>QuantumRange</var>], so that HDRI need not be enabled.
3793Phase values nominally range from 0 to 2*π, but is scaled to span the full
3794dynamic range. (The first few releases had non-HDRI scaled but HDRI not
3795scaled). The magnitude image is not scaled and thus generally will contain
3796very small values. As such, the image normally will appear totally black. In
3797order to view any detail, the magnitude image typically is enhanced with a log
3798function into what is usually called the spectrum. A log function is used to
3799enhance the darker values more in comparison to the lighter values. This can
3800be done, for example, as follows:</p>
3801
3802<pre>
3803convert fft_image.miff[0] -contrast-stretch 0 \
3804 -evaluate log 1000 fft_image_spectrum.png"
3805</pre>
3806
Cristy594d2772015-11-15 10:47:42 -05003807<p>where either <a href="command-line-options.html#contrast-stretch">-contrast-stretch</a> 0 or <a
3808href="command-line-options.html#auto-level">-auto-level</a> is used to scale the image to full dynamic
Cristy882d9f42015-10-29 16:48:39 -04003809range, first. The argument to the <a href="command-line-options.html#evaluate">-evaluate</a> log
3810typically is specified between 100 and 10,000, depending upon the amount of
3811detail that one wants to bring out in the spectrum. Larger values produce more
3812visible detail. Too much detail, however, may hide the important features.</p>
3813
3814<p>The <a href="http://www.fftw.org/">FFTW</a> delegate library is required to
3815use <a href="command-line-options.html#fft">-fft</a>.</p>
3816
3817<p>Use <a href="command-line-options.html#fft">+fft</a> to produce two output images that are the real
3818and imaginary components of the complex valued Fourier transform.</p>
3819
3820<p>However, as the real and imaginary components can contain negative values,
3821this requires that IM be configured with HDRI enabled. In this case, you must
3822use either MIFF, TIF, PFM or MPC formats for the real and imaginary component
3823results, since they are formats that preserve both negative and fractional
3824values without clipping them or truncating the fractional part. With either
3825MIFF or TIF, one should add -define quantum:format=32, to allow those image
3826types to work properly in HDRI mode without clipping.</p>
3827
Cristy594d2772015-11-15 10:47:42 -05003828<p>The real and imaginary component images resulting from <a
3829href="command-line-options.html#fft">+fft</a> are also square, even dimensioned images due to the same
Cristy882d9f42015-10-29 16:48:39 -04003830padding that was discussed above for the magnitude and phase component
3831images.</p>
3832
Cristy594d2772015-11-15 10:47:42 -05003833<p>See the discussion on HDRI implementations of ImageMagick on the page <a
3834href="high-dynamic-range.html" >High Dynamic-Range Images</a>. For more
3835about HDRI go the ImageMagick <a
Cristy364a72f2016-11-04 22:38:41 -04003836href="https://www.imagemagick.org/Usage/basics/#hdri" >Usage</a> pages, <a
Cristy594d2772015-11-15 10:47:42 -05003837href="http://www.fmwconcepts.com/imagemagick/fourier_transforms/fourier.html"
3838>Fred's Fourier Processing With ImageMagick page</a> or this <a
3839 href="http://en.wikipedia.org/wiki/High_dynamic_range_imaging" >Wikipedia</a>
Cristy882d9f42015-10-29 16:48:39 -04003840 entry. </p>
3841
Cristy594d2772015-11-15 10:47:42 -05003842<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 -04003843
3844
3845<div style="margin: auto;">
3846 <h3 class="magick-header"><a id="fill"></a>-fill <var>color</var></h3>
3847</div>
3848
3849<p class="magick-description">color to use when filling a graphic primitive.</p>
3850
3851<p>This option accepts a color name, a hex color, or a numerical RGB, RGBA,
Cristy594d2772015-11-15 10:47:42 -05003852HSL, HSLA, CMYK, or CMYKA specification. See <a href="color.html" >Color Names</a> for
Cristy882d9f42015-10-29 16:48:39 -04003853a description of how to properly specify the color argument.</p>
3854
3855<p>Enclose the color specification in quotation marks to prevent the "#" or
3856the parentheses from being interpreted by your shell.</p>
3857
3858<p>For example,</p>
3859
3860<pre>
3861-fill blue
3862-fill "#ddddff"
3863-fill "rgb(255,255,255)"
3864</pre>
3865
3866<p>See <a href="command-line-options.html#draw">-draw</a> for further details.</p>
3867
3868<p>To print a complete list of color names, use the <a href="command-line-options.html#list">-list color</a> option.</p>
3869
3870<div style="margin: auto;">
3871 <h3 class="magick-header"><a id="filter"></a>-filter <var>type</var></h3>
3872</div>
3873
3874<p class="magick-description">Use this <var>type</var> of filter when resizing or distorting an image.</p>
3875
3876<p>Use this option to affect the resizing operation of an image during
Cristy594d2772015-11-15 10:47:42 -05003877operations such as <a href="command-line-options.html#resize">-resize</a> and <a href="command-line-options.html#distort"
3878>-distort</a>. For example you can use a simple resize filter such as:</p>
Cristy882d9f42015-10-29 16:48:39 -04003879
3880<pre>
3881Point Hermite Cubic
3882Box Gaussian Catrom
3883Triangle Quadratic Mitchell
3884</pre>
3885
3886<p>The <code>Bessel</code> and <code>Sinc</code> filter is also provided (as well
3887as a faster <code>SincFast</code> equivalent form). However these filters are
3888generally useless on their own as they are infinite filters that are being
3889clipped to the filters support size. Their direct use is not recommended
3890except via expert settings (see below). </p>
3891
3892<p>Instead these special filter functions are typically windowed by a windowing
Cristy594d2772015-11-15 10:47:42 -05003893function that the <a href="command-line-options.html#filter" >-filter</a> setting defines. That is
Cristy882d9f42015-10-29 16:48:39 -04003894using these functions will define a 'Windowed' filter, appropriate to the
3895operator involved. Windowed filters include: </p>
3896
3897<pre>
3898Lanczos Hamming Parzen
3899Blackman Kaiser Welsh
3900Hanning Bartlett Bohman
3901</pre>
3902
3903<p>Also one special self-windowing filter is also provided
3904<code>Lagrange</code>, which will automagically re-adjust its function depending
3905on the current 'support' or 'lobes' expert settings (see below).</p>
3906
3907<p>If you do not select a filter with this option, the filter defaults to
3908<code>Mitchell</code> for a colormapped image, an image with a matte channel, or
3909if the image is enlarged. Otherwise the filter default to
3910<code>Lanczos</code>.</p>
3911
3912<p>To print a complete list of resize filters, use the <a href="command-line-options.html#list">-list
3913filter</a> option.</p>
3914
3915<p>You can modify how the filter behaves as it scales your image through the
Cristy594d2772015-11-15 10:47:42 -05003916use of these expert settings (see also <a href="command-line-options.html#define" >-define</a> and <a
3917href="command-line-options.html#set" >-set</a>):-</p>
Cristy882d9f42015-10-29 16:48:39 -04003918
3919<table class="table table-condensed table-striped">
3920 <tr>
3921 <td>-define filter:blur=<var>factor</var></td>
3922 <td>Scale the X axis of the filter (and its window). Use &gt; 1.0 for
3923 blurry or &lt; 1.0 for sharp. This should only be used with Gaussian and
3924 Gaussian-like filters simple filters, or you may not get the expected
3925 results. </td>
3926 </tr>
3927
3928 <tr>
3929 <td>-define filter:support=<var>radius</var></td>
3930 <td>Set the filter support radius. Defines how large the filter should be and
3931 thus directly defines how slow the filtered resampling process is. All
3932 filters have a default 'preferred' support size. Some filters like
3933 <code>Lagrange</code> and windowed filters adjust themselves depending on
3934 this value. With simple filters this value either does nothing (but slow
3935 the resampling), or will clip the filter function in a detrimental way.
3936 </td>
3937 </tr>
3938
3939 <tr>
3940 <td>-define filter:lobes=<var>count</var></td>
3941 <td>Set the number of lobes to use for the Sinc/Bessel filter. This an
3942 alternative way of specifying the 'support' range of the filter, that is
3943 designed to be more suited to windowed filters, especially when used for
3944 image distorts.</td>
3945 </tr>
3946
3947 <tr>
3948 <td>-define filter:sigma=<var>value</var></td>
3949 <td>The 'sigma' value used to define the <code>Gaussian</code> filter. Default
3950 sigma value is '<code>0.5</code>'. It only effects <code>Gaussian</code> but
3951 does not shrink (but may enlarge) the filter's 'support'. It can be used
3952 to generate very small blurs but without the filter 'missing' pixels due
3953 to using a small support setting. A larger value of '<code>0.707</code>'
3954 (a value of '1/sqrt(2)') is another common setting. </td>
3955 </tr>
3956
3957 <tr>
3958 <td>-define filter:b=<var>b-spline_factor</var></td>
Cristy579a0cb2016-11-26 12:27:17 -05003959 </tr>
3960
Cristy594d2772015-11-15 10:47:42 -05003961 <tr>
Cristy882d9f42015-10-29 16:48:39 -04003962 <td>-define filter:c=<var>keys_alpha_factor</var></td>
3963 <td>Redefine the values used for cubic filters such as <code>Cubic</code>,
3964 <code>Catrom</code>, <code>Mitchel</code>, and <code>Hermite</code>, as well as
3965 the <code>Parzen</code> cubic windowing function. If only one of the values
3966 are defined, the other is set so as to generate a 'Cubic-Keys' filter.
3967 The values meaning was defined by a research paper by
3968 Mitchell-Netravali.</td>
3969 </tr>
3970
3971 <tr>
3972 <td>-define filter:kaiser-beta=<var>value</var></td>
3973 <td>The 'alpha' value used to as part of the Kaiser Windowing function.
3974 Default value is '6.5'. It only effects Kaiser windowing function, and
3975 does not effect any other attributes.
3976 Before ImageMagick v6.7.6-10, this option was known as "filter:alpha", (an
3977 inheritance from the very old "zoom" program). It was changed to bring the
3978 function in line with more modern academic research usage, and better
3979 assign it be more definitive. </td>
3980 </tr>
3981
3982 <tr>
3983 <td>-define filter:kaiser-alpha=<var>value</var></td>
3984 <td>This value when multiplied by 'PI' is equivalent to "kaiser-beta", and
3985 will override that setting. It only effects Kaiser windowing function,
3986 and does not effect any other attributes. </td>
3987 </tr>
3988
3989 <tr>
3990 <td>-define filter:filter=<var>filter_function</var></td>
3991 <td>Use this function directly as the weighting filter. This will allow
3992 you to directly use a windowing function such as <code>Blackman</code>,
3993 as a resampling filter, rather than as its normal usage as a windowing
3994 function. If defined, no windowing function also defined, the window function is set
3995 to <code>Box</code>). Directly specifying <code>Sinc</code> or <code>Jinc</code>
3996 as a filter will also do this. </td>
3997 </tr>
3998
3999 <tr>
4000 <td>-define filter:window=<var>filter_function</var></td>
4001 <td>The IIR (infinite impulse response) filters <code>Sinc</code> and
4002 <code>Jinc</code> are windowed (brought down to zero over the defined
4003 support range) with the given filter. This allows you to specify a filter
4004 function to be used as a windowing function for these IIR filters.
4005 Many of the defined filters are actually windowing functions for these IIR
4006 filters. A typical choices is <code>Box</code>, (which effectively turns
4007 off the windowing function). </td>
4008 </tr>
4009
4010 <tr>
4011 <td>-define filter:win-support=<var>radius</var></td>
4012 <td>Scale windowing function to this size instead. This causes the windowing
4013 (or self-windowing Lagrange filter) to act is if the support window is
4014 larger than what is actually supplied to the calling operator. The filter
4015 however is still clipped to the real support size given. If unset this
4016 will equal the normal filter support size. </td>
4017 </tr>
4018
4019 <tr>
4020 <td>-define filter:verbose=<var>1</var></td>
4021 <td>This causes IM to print information on the final internal filter
4022 selection to standard output. This includes a commented header on the
4023 filter settings being used, and data allowing the filter weights to be
4024 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
4025 a <code>SincFast</code> windowed <code>SincFast</code> filter, while
4026 <code>Mitchell</code> is defined as a general <code>Cubic</code> family filter
4027 with specific 'B' and 'C' settings. </td>
4028 </tr>
4029
4030</table>
4031
4032<p>For example, to get a 8 lobe jinc windowed sinc filter (Genseng filter?):</p>
4033
4034<pre>
4035convert image.png \
4036 -filter sinc \
4037 -set filter:window=jinc \
4038 -set filter:lobes=8 \
4039 -resize 150% image.jpg"
4040</pre>
4041
4042<p>Or a raw un-windowed Sinc filter with 4 lobes:</p>
4043
4044<pre>
4045convert image.png \
4046 -set filter:filter=sinc \
4047 -set filter:lobes=4 \
4048 -resize 150% image.jpg"
4049</pre>
4050
4051<p>To extract the data for a raw windowing function, combine it with
4052a '<code>Box</code>' filter. For example the '<code>Welch</code> parabolic
4053windowing function. </p>
4054
4055<pre>
4056convert null: -define filter:filter=Box \
4057 -define filter:window=Welch \
4058 -define filter:support=1.0 \
4059 -define filter:verbose=1 \
Cristy594d2772015-11-15 10:47:42 -05004060 -resize 2 null: > window_welch.dat
Cristy882d9f42015-10-29 16:48:39 -04004061gnuplot
4062 set grid
4063 plot \"window_welch.dat\" with lines
4064</pre>
4065
4066<p>Note that the use of expert options is provided for image processing experts
4067who have studied and understand how resize filters work. Without this
4068knowledge, and an understanding of the definition of the actual filters
4069involved, using expert settings are more likely to be detrimental to your image
4070resizing.</p>
4071
4072
4073<div style="margin: auto;">
4074 <h3 class="magick-header"><a id="flatten"></a>-flatten</h3>
4075</div>
4076
Cristy594d2772015-11-15 10:47:42 -05004077<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 -04004078
4079
4080<div style="margin: auto;">
4081 <h3 class="magick-header"><a id="flip"></a>-flip</h3>
4082</div>
4083
4084<p class="magick-description">create a <var>mirror image</var></p>
4085
4086<p>reflect the scanlines in the vertical direction. The image will be mirrored
4087upside-down. </p>
4088
4089
4090<div style="margin: auto;">
4091 <h3 class="magick-header"><a id="floodfill"></a>-floodfill {<var>+-</var>}<var>x</var>{<var>+-</var>}<var>y</var> <var>color</var></h3>
4092</div>
4093
4094<p class="magick-description">floodfill the image with color at the specified offset.</p>
4095
4096<p>Flood fill starts from the given 'seed point' which is not gravity effected.
Cristy594d2772015-11-15 10:47:42 -05004097Any color that matches within <a href="command-line-options.html#fuzz" >-fuzz</a> color distance of the
Cristy882d9f42015-10-29 16:48:39 -04004098given <var>color</var> argument, connected to that 'seed point'
Cristy594d2772015-11-15 10:47:42 -05004099will be replaced with the current <a href="command-line-options.html#fill" >-fill</a> color. </p>
Cristy882d9f42015-10-29 16:48:39 -04004100
4101<p>Note that if the pixel at the 'seed point' does not itself match the given
Cristy594d2772015-11-15 10:47:42 -05004102<var>color</var> (according to <a href="command-line-options.html#fuzz" >-fuzz</a>), then no
Cristy882d9f42015-10-29 16:48:39 -04004103action will be taken. </p>
4104
Cristy594d2772015-11-15 10:47:42 -05004105<p>This operator works more like the <a href="command-line-options.html#opaque" >-opaque</a> option, than
Cristy882d9f42015-10-29 16:48:39 -04004106a more general flood fill that reads the matching color directly at the 'seed
Cristy594d2772015-11-15 10:47:42 -05004107point'. For this form of flood fill, look at <a href="command-line-options.html#draw" >-draw</a> and
Cristy882d9f42015-10-29 16:48:39 -04004108its 'color floodfill' drawing method. </p>
4109
4110
4111<div style="margin: auto;">
4112 <h3 class="magick-header"><a id="flop"></a>-flop</h3>
4113</div>
4114
4115<p class="magick-description">create a <var>mirror image</var>.</p>
4116
4117<p>Reflect the scanlines in the horizontal direction, just like the image in
4118a vertical mirror. </p>
4119
4120
4121<div style="margin: auto;">
4122 <h3 class="magick-header"><a id="font"></a>-font <var>name</var></h3>
4123</div>
4124
4125<p class="magick-description">set the font to use when annotating images with text, or creating labels.</p>
4126
4127<p>To print a complete list of fonts, use the <a href="command-line-options.html#list">-list font</a>
4128option (for versions prior to 6.3.6, use 'type' instead of 'font').</p>
4129
4130<p>In addition to the fonts specified by the above pre-defined list, you can
4131also specify a font from a specific source. For example <code>Arial.ttf</code>
4132is a TrueType font file, <code>ps:helvetica</code> is PostScript font, and
4133<code>x:fixed</code> is X11 font.</p>
4134
Cristy594d2772015-11-15 10:47:42 -05004135<p>For other settings that affect fonts, see the options <a
4136href="command-line-options.html#family">-family</a>, <a href="command-line-options.html#stretch">-stretch</a>, <a
4137href="command-line-options.html#style">-style</a>, and <a href="command-line-options.html#weight">-weight</a>. </p>
Cristy882d9f42015-10-29 16:48:39 -04004138
4139
4140<div style="margin: auto;">
4141 <h3 class="magick-header"><a id="foreground"></a>-foreground <var>color</var></h3>
4142</div>
4143
4144<p class="magick-description">Define the foreground color for menus.", "display</p>
4145
Cristy594d2772015-11-15 10:47:42 -05004146<p>The color is specified using the format described under the <a
4147href="command-line-options.html#fill">-fill</a> option.</p>
Cristy882d9f42015-10-29 16:48:39 -04004148
4149<p>The default foreground color is black.</p>
4150
4151<div style="margin: auto;">
4152 <h3 class="magick-header"><a id="format"></a>-format <var>type</var></h3>
4153</div>
4154
4155<p class="magick-description">the image format type.</p>
4156
4157<p>When used with the <code>mogrify</code> utility, this option converts any
4158image to the image <a href="formats.html">format</a> you specify.
Cristy594d2772015-11-15 10:47:42 -05004159For a list of image format types supported by ImageMagick, use <a
4160href="command-line-options.html#list">-list format</a>.</p>
Cristy882d9f42015-10-29 16:48:39 -04004161
4162<p>By default the file is written to its original name. However, if the
4163filename extension matches a supported format, the extension is replaced with
4164the image format type specified with <a href="command-line-options.html#format">-format</a>. For
4165example, if you specify <var>tiff</var> as the format type and the
4166input image filename is <var>image.gif</var>, the output image
4167filename becomes <var>image.tiff</var>.</p>
4168
4169<div style="margin: auto;">
4170 <h3 class="magick-header"><a id="format_identify_"></a>-format <var>string</var></h3>
4171</div>
4172
4173<p class="magick-description">output formatted image characteristics.</p>
4174
4175<p>See <a href="escape.html">Format and Print Image
4176Properties</a> for an explanation on how to specify the argument to this
4177option.</p>
4178
4179<div style="margin: auto;">
4180 <h3 class="magick-header"><a id="frame"></a>-frame <var>geometry</var></h3>
4181</div>
4182
4183<p class="magick-description">Surround the image with a border or beveled frame.</p>
4184
Cristyb7f455a2017-03-03 19:30:34 -05004185<p>The color of the border is specified with the <a href="command-line-options.html#mattecolor"
4186>-mattecolor</a> command line option. </p>
Cristy882d9f42015-10-29 16:48:39 -04004187
4188<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
4189height that is added to the dimensions of the image. If no offsets are given
4190in the <var>geometry</var> argument, then the border added is
4191a solid color. Offsets <var>x</var> and <var>y</var>, if present, specify that
4192the width and height of the border is partitioned to form an outer bevel of
4193thickness <var>x</var> pixels and an inner bevel of thickness
4194<var>y</var> pixels. Negative offsets make no sense as frame arguments.
4195</p>
4196
Cristy594d2772015-11-15 10:47:42 -05004197<p>The <a href="command-line-options.html#frame">-frame</a> option is affected by the current <a
4198href="command-line-options.html#compose">-compose</a> setting and assumes that this is using the default
Cristy882d9f42015-10-29 16:48:39 -04004199'<code>Over</code>' composition method. It generates an image of the appropriate
4200size with the current <a href="command-line-options.html#bordercolor">-bordercolor</a> setting, and then
Cristy594d2772015-11-15 10:47:42 -05004201draws the frame of four distinct colors close to the current <a
Cristyb7f455a2017-03-03 19:30:34 -05004202href="command-line-options.html#mattecolor">-mattecolor</a>. The original image is then overlaid onto
Cristy882d9f42015-10-29 16:48:39 -04004203center of this image. This means that with the default compose method of
Cristy594d2772015-11-15 10:47:42 -05004204'<code>Over</code>' any transparent parts may be replaced by the current <a
4205href="command-line-options.html#bordercolor">-bordercolor</a> setting.</p>
Cristy882d9f42015-10-29 16:48:39 -04004206
4207<p>The image composition is not
4208affected by the <a href="command-line-options.html#gravity">-gravity</a> option.</p>
4209
4210
4211<div style="margin: auto;">
4212 <h3 class="magick-header"><a id="frame_import_"></a>-frame</h3>
4213</div>
4214
4215<p class="magick-description">include the X window frame in the imported image. </p>
4216<div style="margin: auto;">
4217 <h3 class="magick-header"><a id="function"></a>-function <var>function</var> <var>parameters</var></h3>
4218</div>
4219
4220<p class="magick-description">Apply a function to channel values.</p>
4221
4222<p>This operator performs calculations based on the given arguments to modify
Cristy594d2772015-11-15 10:47:42 -05004223each of the color values for each previously set <a
4224href="command-line-options.html#channel">-channel</a> in the image. See <a
4225href="command-line-options.html#evaluate">-evaluate</a> for details concerning how the results of the
Cristy882d9f42015-10-29 16:48:39 -04004226calculations are handled.</p>
4227
Cristy594d2772015-11-15 10:47:42 -05004228<p>This is can be considered a multi-argument version of the <a
4229href="command-line-options.html#evaluate">-evaluate</a> operator. (Added in
Cristy882d9f42015-10-29 16:48:39 -04004230ImageMagick 6.4.8−8.)</p>
4231
4232<p>Here, <var>parameters</var> is a comma-separated list of
4233numerical values. The number of values varies depending on which <var>function</var> is selected. Choose the <var>function</var> from:</p>
4234
4235<pre>
4236Polynomial
4237Sinusoid
4238Arcsin
4239Arctan
4240</pre>
4241
4242<p>To print a complete list of <a href="command-line-options.html#function">-function</a> operators,
4243use <a href="command-line-options.html#list">-list function</a>. Descriptions follow.</p>
4244
4245<dl class="dl-horizontal">
4246 <dt>Polynomial</dt>
4247 <dd><p>The <code>Polynomial</code> function takes an arbitrary number of parameters,
4248these being the coefficients of a polynomial, in decreasing order of degree.
4249That is, entering</p>
4250
4251<pre>
4252-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>
4253</pre>
4254
4255<p>will invoke a polynomial function given by</p>
4256
4257<pre>
4258<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>,
4259</pre>
4260
4261<p>where <b><var>u</var></b> is pixel's original normalized channel value.</p>
4262
4263<p>The <code>Polynomial</code> function can be used in place of <code>Set</code>
4264(the <var>constant</var> polynomial) and <code>Add</code>, <code>Divide</code>,
4265<code>Multiply</code>, and <code>Subtract</code> (some <var>linear</var>
Cristy594d2772015-11-15 10:47:42 -05004266polynomials) of the <a href="command-line-options.html#evaluate">-evaluate</a> operator. The <a
4267href="command-line-options.html#level">-level</a> operator also affects channels linearly. Some
Cristy882d9f42015-10-29 16:48:39 -04004268correspondences follow.</p>
4269
4270<table class="table table-condensed table-striped">
4271 <tr>
4272 <td>-evaluate Set <var>value</var> </td>
4273 <td>-function Polynomial <var>value</var></td>
4274 <td>(Constant functions; set <var>value</var>×100% gray when channels are RGB.)</td>
4275 </tr>
4276 <tr>
4277 <td>-evaluate Add <var>value</var> </td>
4278 <td>-function Polynomial 1,<var>value</var></td>
4279 </tr>
4280 <tr>
4281 <td>-evaluate Subtract <var>value</var> </td>
4282 <td>-function Polynomial 1,−<var>value</var></td>
4283 </tr>
4284 <tr>
4285 <td>-evaluate Multiply <var>value</var> </td>
4286 <td>-function Polynomial <var>value</var>,0</td>
4287 </tr>
4288 <tr>
4289 <td>+level black% x white%</td>
4290 <td>-function Polynomial A,B</td>
4291 <td>(Reduce contrast. Here, A=(white-black)/100 and B=black/100.)</td>
4292 </tr>
4293</table>
4294
4295<p>The <code>Polynomial</code> function gives great versatility, since
4296polynomials can be used to fit any continuous curve to any degree of accuracy
4297desired.</p>
4298
4299</dd>
4300<dt>Sinusoid</dt>
4301<dd>
4302<p>The <code>Sinusoid</code> function can be used to vary the channel values
4303sinusoidally by setting frequency, phase shift, amplitude, and a bias. These
4304values are given as one to four parameters, as follows,</p>
4305
4306<pre>
4307-function <code>Sinusoid</code> <var>freq</var>,[<var>phase</var>,[<var>amp</var>,[<var>bias</var>]]]
4308</pre>
4309
4310<p>where <var>phase</var> is in degrees. (The domain [0,1] of the function
4311corresponds to 0 through <var>freq</var>×360 degrees.)
4312The result is that if a pixel's normalized channel value is originally
4313<b><var>u</var></b>, its resulting normalized value is given by </p>
4314
4315<pre>
4316<var>amp</var> * sin(2*π* (<var>freq</var> * <b><var>u</var></b> + <var>phase</var> / 360)) + <var>bias</var>
4317</pre>
4318
4319<p> For example, the following generates a curve that starts and ends at 0.9
4320(when <b><var>u</var></b>=0 and 1, resp.), oscillating three times between
4321.7−.2=.5 and .7+.2=.9. </p>
4322
4323<pre>
4324-function Sinusoid 3,-90,.2,.7
4325</pre>
4326
4327<p>The default values of <var>amp</var> and <var>bias</var> are both .5. The default for <var>phase</var>
4328is 0.</p>
4329
4330<p>The <code>Sinusoid</code> function generalizes <code>Sin</code> and
4331<code>Cos</code> of the <a href="command-line-options.html#evaluate">-evaluate</a> operator by allowing
4332varying amplitude, phase and bias. The correspondence is as follows.</p>
4333
4334<table class="table table-condensed table-striped">
4335 <tr>
4336 <td>-evaluate Sin <var>freq</var> </td>
4337 <td>-function Sinusoid <var>freq</var>,0 </td>
4338 </tr>
4339 <tr>
4340 <td>-evaluate Cos <var>freq</var> </td>
4341 <td>-function Sinusoid <var>freq</var>,90 </td>
4342 </tr>
4343</table>
4344 </dd>
4345<dt>ArcSin</dt>
4346<dd>
4347<p>The <code>ArcSin</code> function generates the inverse curve of a Sinusoid,
4348and can be used to generate cylindrical distortion and displacement maps.
4349The curve can be adjusted relative to both the input values and output range
4350of values.</p>
4351
4352<pre>
4353-function <code>ArcSin</code> <var>width</var>,[<var>center</var>,[<var>range</var>,[<var>bias</var>]]]
4354</pre>
4355
4356<p>with all values given in terms of normalized color values (0.0 for black,
43571.0 for white). Defaulting to values covering the full range from 0.0 to 1.0
4358for bout input (<var>width</var>), and output (<var>width</var>) values. '<code>1.0,0.5,1.0,0.5</code>' </p>
4359
4360<pre>
4361<var>range</var>/π * asin( 2/<var>width</var> * ( <b><var>u</var></b> - <var>center</var> ) ) + <var>bias</var>
4362</pre>
4363
4364</dd>
4365<dt>ArcTan</dt>
4366<dd>
4367<p>The <code>ArcTan</code> function generates a curve that smooth crosses from
4368limit values at infinities, though a center using the given slope value.
4369All these values can be adjusted via the arguments.</p>
4370
4371<pre>
4372-function <code>ArcTan</code> <var>slope</var>,[<var>center</var>,[<var>range</var>,[<var>bias</var>]]]
4373</pre>
4374
4375<p>Defaulting to '<code>1.0,0.5,1.0,0.5</code>'.
4376</p>
4377
4378<pre>
4379<var>range</var>/π * atan( <var>slope</var>*π * ( <b><var>u</var></b> - <var>center</var> ) ) + <var>bias</var>
4380</pre>
4381 </dd>
Cristy882d9f42015-10-29 16:48:39 -04004382</dl>
4383
4384
4385
4386<div style="margin: auto;">
4387 <h3 class="magick-header"><a id="fuzz"></a>-fuzz <var>distance</var>{<var>%</var>}</h3>
4388</div>
4389
4390<p class="magick-description">Colors within this <var>distance</var> are considered equal.</p>
4391
4392<p>A number of algorithms search for a target color. By default the color must
4393be exact. Use this option to match colors that are close to the target color
4394in RGB space. For example, if you want to automagically trim the edges of an
4395image with <a href="command-line-options.html#trim">-trim</a> but the image was scanned and the target
4396background color may differ by a small amount. This option can account for
4397these differences.</p>
4398
4399<p>The <var>distance</var> can be in absolute intensity units or, by
4400appending <code>%</code> as a percentage of the maximum possible intensity (255,
440165535, or 4294967295).</p>
4402
Cristy594d2772015-11-15 10:47:42 -05004403<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 -04004404
4405
4406<div style="margin: auto;">
4407 <h3 class="magick-header"><a id="fx"></a>-fx <var>expression</var></h3>
4408</div>
4409
4410<p class="magick-description">apply a mathematical expression to an image or image channels.</p>
4411
4412<p>If the first character of <var>expression</var> is <code>@</code>,
4413the expression is read from a file titled by the remaining characters in the
4414string.</p>
4415
4416<p>See <a href="fx.html">FX,
4417The Special Effects Image Operator</a> for a detailed discussion of this
4418option.</p>
4419
4420
4421<div style="margin: auto;">
4422 <h3 class="magick-header"><a id="gamma"></a>-gamma <var>value</var></h3>
4423</div>
4424
4425<p class="magick-description">level of gamma correction.</p>
4426
4427<p>The same color image displayed on two different workstations may look
4428different due to differences in the display monitor. Use gamma correction to
4429adjust for this color difference. Reasonable values extend from
4430<code>0.8</code> to <code>2.3</code>. Gamma less than 1.0 darkens the image and
4431gamma greater than 1.0 lightens it. Large adjustments to image gamma may
4432result in the loss of some image information if the pixel quantum size is only
4433eight bits (quantum range 0 to 255).</p>
4434
4435<p>Gamma adjusts the image's channel values pixel-by-pixel according to
4436a power law, namely, pow(pixel,1/gamma) or pixel^(1/gamma), where pixel is the
4437normalized or 0 to 1 color value. For example, using a value of gamma=2 is the
4438same as taking the square root of the image.</p>
4439
4440<p>You can apply separate gamma values to the red, green, and blue channels of
4441the image with a gamma value list delimited with commas (e.g.,
4442<code>1.7,2.3,1.2</code>).</p>
4443
4444<p>Use <a href="command-line-options.html#gamma">+gamma <var>value</var></a> to set the
4445image gamma level without actually adjusting the image pixels. This option
4446is useful if the image is of a known gamma but not set as an image attribute
4447(e.g. PNG images). Write the "file gamma" which is the reciprocal of the
4448display gamma; e.g., if your image is sRGB and you want to write a PNG gAMA
4449chunk, use</p>
4450
4451<pre>
4452convert input.png +gamma .45455 output.png
4453</pre>
4454
4455<p>(0.45455 is 1/2.2)</p>
4456
4457<p>Note that gamma adjustments are also available via the <a href="command-line-options.html#level">-level</a> operator.</p>
4458
4459<div style="margin: auto;">
Cristy594d2772015-11-15 10:47:42 -05004460 <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 -04004461</div>
4462
4463<p class="magick-description">Blur the image with a Gaussian operator.</p>
4464
4465<p>Convolve the image with a Gaussian or normal distribution using the given
Cristy594d2772015-11-15 10:47:42 -05004466<var >Sigma</var> value. The formula is:</p>
Cristy882d9f42015-10-29 16:48:39 -04004467
Cristy594d2772015-11-15 10:47:42 -05004468<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 -04004469
Cristy594d2772015-11-15 10:47:42 -05004470<p>The <var >Sigma</var> value is the important argument, and
Cristy882d9f42015-10-29 16:48:39 -04004471determines the actual amount of blurring that will take place. </p>
4472
Cristy594d2772015-11-15 10:47:42 -05004473<p>The <var >Radius</var> is only used to determine the size of the
Cristy882d9f42015-10-29 16:48:39 -04004474array which will hold the calculated Gaussian distribution. It should be an
4475integer. If not given, or set to zero, IM will calculate the largest possible
4476radius that will provide meaningful results for the Gaussian distribution.
4477</p>
4478
Cristy594d2772015-11-15 10:47:42 -05004479<p>The larger the <var >Radius</var> the radius the slower the
4480operation is. However too small a <var >Radius</var>, and sever
4481aliasing effects may result. As a guideline, <var >Radius</var>
4482should be at least twice the <var >Sigma</var> value, though three
Cristy882d9f42015-10-29 16:48:39 -04004483times will produce a more accurate result. </p>
4484
4485<p>This differs from the faster <a href="command-line-options.html#blur">-blur</a> operator in that a
4486full 2-dimensional convolution is used to generate the weighted average of the
4487neighboring pixels. </p>
4488
4489<p>The <a href="command-line-options.html#virtual-pixel">-virtual-pixel</a> setting will determine how
4490pixels which are outside the image proper are blurred into the final result.
4491</p>
4492
4493
4494<div style="margin: auto;">
4495 <h3 class="magick-header"><a id="geometry"></a>-geometry <var>geometry</var></h3>
4496</div>
4497
4498<p class="magick-description">Set the preferred size and location of the image.</p>
4499
4500<p>See <a href="command-line-processing.html#geometry">Image Geometry</a> for complete details about the <em class="arg">geometry</em> argument.</p>
4501
4502<div style="margin: auto;">
4503 <h3 class="magick-header"><a id="gravity"></a>-gravity <var>type</var></h3>
4504</div>
4505
4506<p class="magick-description">Sets the current gravity suggestion for various other settings and options.</p>
4507
4508<p>Choices include: <code>NorthWest</code>, <code>North</code>,
4509<code>NorthEast</code>, <code>West</code>, <code>Center</code>, <code>East</code>,
Cristy594d2772015-11-15 10:47:42 -05004510<code>SouthWest</code>, <code>South</code>, <code>SouthEast</code>. Use <a
4511href="command-line-options.html#list">-list gravity</a> to get a complete list of <a
4512href="command-line-options.html#gravity">-gravity</a> settings available in your ImageMagick
Cristy882d9f42015-10-29 16:48:39 -04004513installation.</p>
4514
4515<p>The direction you choose specifies where to position text or subimages. For
4516example, a gravity of <code>Center</code> forces the text to be centered within
Cristy776113a2016-04-29 12:01:19 -04004517the image. By default, the image gravity is <code>undefined</code>. See <a
Cristy594d2772015-11-15 10:47:42 -05004518href="command-line-options.html#draw">-draw</a> for more details about graphic primitives. Only the
4519text primitive of <a href="command-line-options.html#draw">-draw</a> is affected by the <a
4520href="command-line-options.html#gravity">-gravity</a> option.</p>
Cristy882d9f42015-10-29 16:48:39 -04004521
4522<p>The <a href="command-line-options.html#gravity">-gravity</a> option is also used in concert with the
4523<a href="command-line-options.html#geometry">-geometry</a> setting and other settings or options that
Cristy594d2772015-11-15 10:47:42 -05004524take <var>geometry</var> as an argument, such as the <a
4525href="command-line-options.html#crop">-crop</a> option. </p>
Cristy882d9f42015-10-29 16:48:39 -04004526
4527<p>If a <a href="command-line-options.html#gravity">-gravity</a> setting occurs before another option
4528or setting having a <var>geometry</var> argument that specifies an
4529offset, the offset is usually applied to the point within the image suggested
4530by the <a href="command-line-options.html#gravity">-gravity</a> argument. Thus, in the following
4531command, for example, suppose the file <code>image.png</code> has dimensions
4532200x100. The offset specified by the argument to <a href="command-line-options.html#region">-region</a>
4533is (−40,+20). The argument to <a href="command-line-options.html#gravity">-gravity</a> is
4534<code>Center</code>, which suggests the midpoint of the image, at the point
4535(100,50). The offset (−40,20) is applied to that point, giving
4536(100−40,50+20)=(60,70), so the specified 10x10 region is located at
4537that point. (In addition, the <a href="command-line-options.html#gravity">-gravity</a> affects the
4538region itself, which is <var>centered</var> at the pixel
4539coordinate (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>
4540
4541<pre>
4542convert image.png -gravity Center -region 10x10-40+20 \
4543 -negate output.png
4544</pre>
4545
Cristy594d2772015-11-15 10:47:42 -05004546<p>When used as an option to <a href="composite.html">composite</a>, <a
4547href="command-line-options.html#gravity">-gravity</a> gives the direction that the image gravitates
Cristy882d9f42015-10-29 16:48:39 -04004548within the composite.</p>
4549
Cristy594d2772015-11-15 10:47:42 -05004550<p>When used as an option to <a href="montage.html">montage</a>, <a
4551href="command-line-options.html#gravity">-gravity</a> gives the direction that an image gravitates
Cristy882d9f42015-10-29 16:48:39 -04004552within a tile. The default gravity is <code>Center</code> for this purpose.</p>
4553
4554
4555<div style="margin: auto;">
4556 <h3 class="magick-header"><a id="grayscale"></a>-grayscale <var>method</var></h3>
4557</div>
4558
4559<p class="magick-description">convert image to grayscale.</p>
4560
Cristy594d2772015-11-15 10:47:42 -05004561<p>This will use one of the <a href="command-line-options.html#intensity" >-intensity</a> methods to
Cristy882d9f42015-10-29 16:48:39 -04004562convert the given image into a linear-grayscale image. </p>
4563
4564<p>For example, to convert an image to (linear) Rec709Luminance grayscale, type:</p>
4565
4566<pre>
4567convert in.png -grayscale Rec709Luminance out.png
4568</pre>
4569
4570<p>which is equivalent to:</p>
4571
4572<pre>
4573convert in.png -colorspace gray out.png
4574</pre>
4575
4576<p>Similarly, to convert an image to (non-linear) Rec709Luma grayscale, type:</p>
4577
4578<pre>
4579convert in.png -grayscale Rec709Luma out.png
4580</pre>
4581
4582<p>which is equivalent to:</p>
4583
4584<pre>
4585convert in.png -set colorspace RGB -colorspace gray out.png
4586</pre>
4587
4588<p>Note that a 'colorspace' intensity method will produce the same result
4589regardless of the current colorpsace of the image. But a 'mathematical'
4590intensity method will depend on the current colorspace the image is currently
4591using. </p>
4592
Cristy594d2772015-11-15 10:47:42 -05004593<p>While this operation uses an <a href="command-line-options.html#intensity" >-intensity</a> method,
4594it does not use or set the <a href="command-line-options.html#intensity" >-intensity</a> setting, so
Cristy882d9f42015-10-29 16:48:39 -04004595will not effect other operations that may use that setting.</p>
4596
4597
4598<div style="margin: auto;">
4599 <h3 class="magick-header"><a id="green-primary"></a>-green-primary <var>x,y</var></h3>
4600</div>
4601
4602<p class="magick-description">green chromaticity primary point.</p>
4603
4604
4605<div style="margin: auto;">
4606 <h3 class="magick-header"><a id="hald-clut"></a>-hald-clut</h3>
4607</div>
4608
4609<p class="magick-description">apply a Hald color lookup table to the image.</p>
4610
4611<p>A Hald color lookup table is a 3-dimensional color cube mapped to 2
4612dimensions. Create it with the <code>HALD:</code> prefix (e.g. HALD:8). You
4613can apply any color transformation to the Hald image and then use this option
4614to apply the transform to the image. </p>
4615
4616<pre>
4617convert image.png hald.png -hald-clut transform.png
4618</pre>
4619
4620<p>This option provides a convenient method for you to use Gimp or Photoshop
4621to make color corrections to the Hald CLUT image and subsequently apply them
4622to multiple images using an ImageMagick script. </p>
4623
4624<p>Note that the representation is only of the normal RGB color space and that
4625the whole color value triplet is used for the interpolated lookup of the
Cristy594d2772015-11-15 10:47:42 -05004626represented Hald color cube image. Because of this the operation is not <a
4627href="command-line-options.html#channel" >-channel</a> setting effected, nor can it adjust or modify an
Cristy882d9f42015-10-29 16:48:39 -04004628images transparency or alpha/matte channel.</p>
4629
Cristy594d2772015-11-15 10:47:42 -05004630<p>See also <a href="command-line-options.html#clut" >-clut</a> which provides color value replacement
Cristy769d8892016-01-19 18:11:14 -05004631of the individual color channels, usually involving a simpler grayscale
4632image. E.g: grayscale to color replacement, or modification by a histogram
Cristy882d9f42015-10-29 16:48:39 -04004633mapping. </p>
4634
4635
4636<div style="margin: auto;">
4637 <h3 class="magick-header"><a id="help"></a>-help</h3>
4638</div>
4639
4640<p class="magick-description">print usage instructions.</p>
4641
4642<div style="margin: auto;">
4643 <h3 class="magick-header"><a id="highlight-color"></a>-highlight-color <var>color</var></h3>
4644</div>
4645
4646<p class="magick-description">when comparing images, emphasize pixel differences with this color.</p>
4647
4648<div style="margin: auto;">
4649 <h3 class="magick-header"><a id="hough-lines"></a>-hough-lines <var>width</var>x<var>height</var>{<var>+threshold</var>}</h3>
4650</div>
4651
4652<p class="magick-description">identify straight lines in the image (e.g. -hough-lines 9x9+195).</p>
4653
4654<p>Use the Hough line detector with any binary edge extracted image to locate and draw any straight lines that it finds.</p>
4655
4656<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>.
4657
4658<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>
4659
Cristy594d2772015-11-15 10:47:42 -05004660<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 -04004661
Cristy594d2772015-11-15 10:47:42 -05004662<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 -04004663
Cristy594d2772015-11-15 10:47:42 -05004664<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 -04004665
4666<p>A text file listing the endpoints and counts may be created by using the suffix, .mvg, for the output image.</p>
4667
Cristy594d2772015-11-15 10:47:42 -05004668<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 -04004669
4670<div style="margin: auto;">
4671 <h3 class="magick-header"><a id="iconGeometry"></a>-iconGeometry <var>geometry</var></h3>
4672</div>
4673
4674<p class="magick-description">specify the icon geometry.</p>
4675
4676<p>Offsets, if present in the geometry specification, are handled in the same
4677manner as the <a href="command-line-options.html#geometry">-geometry</a> option, using X11 style to
4678handle negative offsets.</p>
4679
4680<p>See <a href="command-line-processing.html#geometry">Image Geometry</a> for complete details about the <em class="arg">geometry</em> argument.</p>
4681
4682<div style="margin: auto;">
4683 <h3 class="magick-header"><a id="iconic"></a>-iconic</h3>
4684</div>
4685
4686<p class="magick-description">start in icon mode in X Windows", 'animate', 'display</p>
4687
4688<div style="margin: auto;">
4689 <h3 class="magick-header"><a id="identify"></a>-identify</h3>
4690</div>
4691
4692<p class="magick-description">identify the format and characteristics of the image.</p>
4693
4694<p>This information is printed: image scene number; image name; image size;
4695the image class (<var>DirectClass</var> or <var>PseudoClass</var>); the total number of unique colors; and the
4696number of seconds to read and transform the image. Refer to <a href="miff.html">MIFF</a> for
4697a description of the image class.</p>
4698
4699<p>If <a href="command-line-options.html#colors">-colors</a> is also specified, the total unique colors
Cristy594d2772015-11-15 10:47:42 -05004700in the image and color reduction error values are printed. Refer to <a
Cristy6549abb2016-11-10 08:25:55 -05004701href="http://www.imagemagick.org/www/quantize.html">color
Cristy882d9f42015-10-29 16:48:39 -04004702reduction algorithm</a> for a description of these values.</p>
4703
4704<p>If <a href="command-line-options.html#verbose">-verbose</a> precedes this option, copious
4705amounts of image properties are displayed including image statistics, profiles,
4706image histogram, and others.</p>
4707
4708<div style="margin: auto;">
4709 <h3 class="magick-header"><a id="ift"></a>-ift</h3>
4710</div>
4711
4712<p class="magick-description">implements the inverse discrete Fourier transform (DFT).</p>
4713
4714<p>This option is new as of ImageMagick 6.5.4-3 (and now working for Windows
4715users in ImageMagick 6.6.0-9). It transforms a pair of magnitude and phase
4716images from the frequency domain to a single image in the normal or spatial
Cristy594d2772015-11-15 10:47:42 -05004717domain. See for example, <a
4718href="http://en.wikipedia.org/wiki/Fourier_transform">Fourier Transform</a>,
Cristy882d9f42015-10-29 16:48:39 -04004719<a href="http://en.wikipedia.org/wiki/DFT">Discrete Fourier Transform</a> and
4720<a href="http://en.wikipedia.org/wiki/FFT">Fast Fourier Transform</a>.</p>
4721
4722<p>For example, depending upon the image format used to store the result of
4723the <a href="command-line-options.html#fft">-fft</a>, one would use either</p>
4724
4725<pre>
4726convert fft_image.miff -ift fft_image_ift.png
4727</pre>
4728
4729<p>or</p>
4730
4731<pre>
4732convert fft_image-0.png fft_image-1.png -ift fft_image_ift.png
4733</pre>
4734
4735<p>The resulting image may need to be cropped due to padding introduced when
Cristy594d2772015-11-15 10:47:42 -05004736the original image, prior to the <a href="command-line-options.html#fft">-fft</a> or <a
4737href="command-line-options.html#fft">+fft</a>, was not square or even dimensioned. Any padding is at
Cristy882d9f42015-10-29 16:48:39 -04004738the right and/or bottom sides of the image.</p>
4739
4740<p>The <a href="http://www.fftw.org/">FFTW</a> delegate library is required to
4741use <a href="command-line-options.html#ift">-ift</a>.</p>
4742
4743<p>Use <a href="command-line-options.html#ift">+ift</a> (with HDRI enabled) to transform a pair of real
4744and imaginary images from the frequency domain to a single image in the normal
4745(spatial) domain.</p>
4746
Cristy594d2772015-11-15 10:47:42 -05004747<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 -04004748
4749<div style="margin: auto;">
4750 <h3 class="magick-header"><a id="immutable"></a>-immutable</h3>
4751</div>
4752
4753<p class="magick-description">make image immutable.</p>
4754
4755<div style="margin: auto;">
4756 <h3 class="magick-header"><a id="implode"></a>-implode <var>factor</var></h3>
4757</div>
4758
4759<p class="magick-description">implode image pixels about the center.</p>
4760
4761<div style="margin: auto;">
4762 <h3 class="magick-header"><a id="insert"></a>-insert <var>index</var></h3>
4763</div>
4764
4765<p class="magick-description">insert the last image into the image sequence.</p>
4766
4767<p>This option takes last image in the current image sequence and inserts it
4768at the given index. If a negative index is used, the insert position is
4769calculated before the last image is removed from the sequence. As such
4770<code>-insert -1</code> will result in no change to the image sequence.</p>
4771
4772<p>The <code>+insert</code> option is equivalent to <code>-insert -1</code>. In
4773other words, insert the last image, at the end of the current image sequence.
4774Consequently this has no effect on the image sequence order.</p>
4775
4776<div style="margin: auto;">
4777 <h3 class="magick-header"><a id="intensity"></a>-intensity <var>method</var></h3>
4778</div>
4779
4780<p class="magick-description">method to generate intensity value from pixel.</p>
4781
4782<p>ImageMagick provides a number of methods used in situations where an
4783operator needs to determine a single grayscale value for some purpose, from
4784an image with red, green, and blue pixel components. Typically the linear
4785<code>Rec709Luminance</code> formula is used, which is the same formula used when
4786converting images to <code>-colorspace gray</code>. </p>
4787
4788<p>The following formulas are currently provided, and will first convert
4789the pixel values to linear-RGB or non-linear sRGB colorspace before
4790being applied to calculate the final greyscale value. </p>
4791
4792<dl class="dl-horizontal">
4793<dt>Rec601Luma</dt><dd> 0.298839R' + 0.586811G'+ 0.114350B'</dd>
4794<dt>Rec601Luminance</dt><dd> 0.298839R + 0.586811G + 0.114350B</dd>
4795<dt>Rec709Luma</dt><dd> 0.212656R' + 0.715158G' + 0.072186B'</dd>
4796<dt>Rec709Luminance</dt><dd> 0.212656R + 0.715158G + 0.072186B</dd>
4797<dt>Brightness</dt><dd> max(R', G', B')</dd>
4798<dt>Lightness</dt><dd> (min(R', G', B') + max(R', G', B')) / 2.0</dd>
4799</dl>
4800
4801<p>Note that the above R,G,B values is the image's linear-RGB values, while
4802R',G',B' are sRGB non-linear values. </p>
4803
4804<p>These intensity methods are mathematical in nature and will use the
4805current value in the images respective R,G,B channel regardless of
4806what that is, or what colorspace the image is currently using.</p>
4807
4808<dl class="dl-horizontal">
4809<dt>Average</dt><dd>(R + G + B) / 3.0</dd>
4810<dt>MS</dt><dd>(R^2 + G^2 + B^2) / 3.0</dd>
4811<dt>RMS</dt><dd>sqrt( (R^2 + G^2 + B^2) / 3.0 )</dd>
4812</dl>
4813
4814<p>These methods are often used for other purposes, such as generating a
Cristy594d2772015-11-15 10:47:42 -05004815grayscale difference image between two color images (using <a href="command-line-options.html#compose"
4816>-compose</a> '<code>Difference</code>' composition. </p>
Cristy882d9f42015-10-29 16:48:39 -04004817
4818<p> For example The 'MS' (Mean Squared) setting is good for minimizing color
4819error comparisions. While... The method 'RMS' (Root Mean Squared) for
4820example is appropriate for calculating color vector distance, from a color
Cristy594d2772015-11-15 10:47:42 -05004821difference image. This is equivalent to the color only component of the <a
4822href="command-line-options.html#fuzz" >-fuzz</a> factor color compare setting. </p>
Cristy882d9f42015-10-29 16:48:39 -04004823
Cristy594d2772015-11-15 10:47:42 -05004824<p>See also <a href="command-line-options.html#grayscale" >-grayscale</a> which applies one of the above
4825grayscaling formula directly to an image without setting the <a
4826href="command-line-options.html#intensity" >-intensity</a> setting.</p>
Cristy882d9f42015-10-29 16:48:39 -04004827
Cristy594d2772015-11-15 10:47:42 -05004828<p>The <a href="command-line-options.html#colorspace" >-colorspace gray</a> image conversion also uses
Cristy882d9f42015-10-29 16:48:39 -04004829the current intensity setting, but will always convert the image to the
4830appropriate sRGB or linear-RGB colorspace before appling the above
4831function.</p>
4832
4833<p>To print a complete list of possible pixel intensity setting methods, use <a href="command-line-options.html#list">-list intensity</a>.</p>
4834
Cristy594d2772015-11-15 10:47:42 -05004835<p>Operators affected by the <a href="command-line-options.html#intensity" >-intensity</a> setting include:</p>
Cristy882d9f42015-10-29 16:48:39 -04004836
4837<pre>
4838-adaptive-blur
4839-adaptive-sharpen
4840-black-threshold
4841-clut (when mapping greyscale CLUT image to alpha channel if set by -channels)
4842-colors for gray colorspace
4843-compose {LightenIntensity, DarkenIntensity, CopyOpacity, CopyBlack}
4844-contrast-stretch
4845-distort {ErodeIntensity, DilateIntensity}
4846-normalize
4847-random-threshold
4848-selective-blur
4849-shade
4850-threshold
4851-tint
4852-white-threshold
4853</pre>
4854
4855<div style="margin: auto;">
4856 <h3 class="magick-header"><a id="intent"></a>-intent <var>type</var></h3>
4857</div>
4858
4859<p class="magick-description">use this type of rendering intent when managing the image color.</p>
4860
4861<p>Use this option to affect the color management operation of an image (see
4862<a href="command-line-options.html#profile">-profile</a>). Choose from these intents: <code>Absolute,
4863Perceptual, Relative, Saturation</code>.</p>
4864
4865<p>The default intent is Perceptual for the sRGB colorspace and undefined for the RGB and gray colorspaces.</p>
4866
4867<p>To print a complete list of rendering intents, use <a href="command-line-options.html#list">-list intent</a>.</p>
4868
4869<div style="margin: auto;">
4870 <h3 class="magick-header"><a id="interlace"></a>-interlace <var>type</var></h3>
4871</div>
4872
4873<p class="magick-description">the type of interlacing scheme.</p>
4874
4875<p>Choose from:</p>
4876
4877<pre>
4878none
4879line
4880plane
4881partition
4882JPEG
4883GIF
4884PNG
4885</pre>
4886
4887<p>This option is used to specify the type of interlacing scheme for raw image
4888formats such as <code>RGB</code> or <code>YUV</code>.</p>
4889
4890<p><code>None</code> means do not interlace (RGBRGBRGBRGBRGBRGB...),</p>
4891
4892<p><code>Line</code> uses scanline interlacing (RRR...GGG...BBB...RRR...GGG...BBB...), and.</p>
4893
4894<p><code>Plane</code> uses plane interlacing (RRRRRR...GGGGGG...BBBBBB...).</p>
4895
4896<p><code>Partition</code> is like plane except the different planes are saved to
4897individual files (e.g. image.R, image.G, and image.B).</p>
4898
4899<p>Use <code>Line</code> or <code>Plane</code> to create an <code>interlaced
4900PNG</code> or <code>GIF</code> or <code>progressive JPEG</code> image.</p>
4901
4902<p>To print a complete list of interlacing schemes, use <a href="command-line-options.html#list">-list
4903interlace</a>.</p>
4904
4905<div style="margin: auto;">
4906 <h3 class="magick-header"><a id="interpolate"></a>-interpolate <var>type</var></h3>
4907</div>
4908
4909<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>
4910
4911<p>When looking up the color of a pixel using a non-integer floating point
4912value, you typically fall in between the pixel colors defined by the source
4913image. This setting determines how the color is determined from the colors of
4914the pixels surrounding that point. That is how to determine the color of a
4915point that falls between two, or even four different colored pixels. </p>
4916
4917<dl class="dl-horizontal">
4918 <dt>integer</dt>
4919 <dd>The color of the top-left pixel (floor function)</dd>
4920 <dt>nearest-neighbor</dt>
4921 <dd>The nearest pixel to the lookup point (rounded function)</dd>
4922 <dt>average</dt>
4923 <dd>The average color of the surrounding four pixels</dd>
4924 <dt>bilinear</dt>
4925 <dd>A double linear interpolation of pixels (the default)</dd>
4926 <dt>mesh</dt>
4927 <dd>Divide area into two flat triangular interpolations</dd>
4928 <dt>bicubic</dt>
4929 <dd>Fitted bicubic-spines of surrounding 16 pixels</dd>
4930 <dt>spline</dt>
4931 <dd>Direct spline curves (colors are blurred)</dd>
4932 <dt>filter</dt>
4933 <dd>Use resize <a href="command-line-options.html#filter">-filter</a> settings</dd>
4934</dl>
4935
Cristy594d2772015-11-15 10:47:42 -05004936<p>This most important for distortion operators such as <a href="command-line-options.html#distort"
4937>-distort</a>, <a href="command-line-options.html#implode" >-implode</a>, <a href="command-line-options.html#transform"
4938>-transform</a> and <a href="command-line-options.html#fx" >-fx</a>. </p>
Cristy882d9f42015-10-29 16:48:39 -04004939
4940<p>To print a complete list of interpolation methods, use <a href="command-line-options.html#list">-list interpolate</a>.</p>
4941
Cristy594d2772015-11-15 10:47:42 -05004942<p>See also <a href="command-line-options.html#virtual-pixel" >-virtual-pixel</a>, for control of the
Cristy882d9f42015-10-29 16:48:39 -04004943lookup for positions outside the boundaries of the image. </p>
4944
4945
4946<div style="margin: auto;">
4947 <h3 class="magick-header"><a id="interline-spacing"></a>-interline-spacing <var>value</var></h3>
4948</div>
4949
4950<p class="magick-description">the space between two text lines.</p>
4951
4952<div style="margin: auto;">
4953 <h3 class="magick-header"><a id="interword-spacing"></a>-interword-spacing <var>value</var></h3>
4954</div>
4955
4956<p class="magick-description">the space between two words.</p>
4957
4958<div style="margin: auto;">
4959 <h3 class="magick-header"><a id="kerning"></a>-kerning <var>value</var></h3>
4960</div>
4961
4962<p class="magick-description">the space between two letters.</p>
4963
4964<div style="margin: auto;">
Cristy594d2772015-11-15 10:47:42 -05004965 <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 -04004966</div>
4967
4968<p class="magick-description">edge preserving noise reduction filter.</p>
4969
Cristy594d2772015-11-15 10:47:42 -05004970<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 -04004971
4972
4973<div style="margin: auto;">
4974 <h3 class="magick-header"><a id="label"></a>-label <var>name</var></h3>
4975</div>
4976
4977<p class="magick-description">assign a label to an image.</p>
4978
4979<p>Use this option to assign a specific label to the image, as it is read in
Cristy594d2772015-11-15 10:47:42 -05004980or created. You can use the <a href="command-line-options.html#set" >-set</a> operation to re-assign
Cristy882d9f42015-10-29 16:48:39 -04004981a the labels of images already read in. Image formats such as TIFF, PNG,
4982MIFF, supports saving the label information with the image.</p>
4983
4984<p>When saving an image to a <var>PostScript</var> file, any label
4985assigned to an image is used as a header string to print above the postscript
4986image. </p>
4987
4988<p>You can include the image filename, type, width, height, or other image
4989attribute by embedding special format character. See <a href="escape.html">Format and Print Image
4990Properties</a> for details of the percent escape codes.</p>
4991
4992<p>For example,</p>
4993
4994<pre>
4995-label "%m:%f %wx%h" bird.miff
4996</pre>
4997
4998<p>assigns an image label of <code>MIFF:bird.miff 512x480</code> to the
4999"<code>bird.miff</code>" image and whose width is 512 and height is 480, as it
5000is read in. If a <a href="command-line-options.html#label">+label</a> option was used instead, any
5001existing label present in the image would be used. You can remove all labels
5002from an image by assigning the empty string. </p>
5003
5004<p>A label is not drawn on the image, but is embedded in the image datastream
5005via <var>Label</var> tag or similar mechanism. If you want the label to be
5006visible on the image itself, use the <a href="command-line-options.html#draw">-draw</a> option, or
5007during the final processing in the creation of an image montage.</p>
5008
5009<p>If the first character of <var>string</var> is <var>@</var>, the image label is read from a file titled by the
5010remaining characters in the string. Labels in a file are literal, no embedded
5011formatting characters are recognized.</p>
5012
5013
5014<div style="margin: auto;">
Cristy594d2772015-11-15 10:47:42 -05005015 <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 -04005016</div>
5017
5018<p class="magick-description">perform local adaptive threshold.</p>
5019
5020<p>Adaptively threshold each pixel based on the value of pixels in a
5021surrounding window. If the current pixel is lighter than this average plus
5022the optional <code>offset</code>, then it is made white, otherwise it is made
5023black. Small variations in pixel values such as found in scanned documents
5024can be ignored if offset is positive. A negative offset will make it more
5025sensitive to those small variations. </p>
5026
5027<p>This is commonly used to threshold images with an uneven background. It is
5028based on the assumption that average color of the small window is the
5029the local background color, from which to separate the foreground color. </p>
5030
5031
5032<div style="margin: auto;">
5033 <h3 class="magick-header"><a id="layers"></a>-layers <var>method</var></h3>
5034</div>
5035
5036<p class="magick-description">handle multiple images forming a set of image layers or animation frames.</p>
5037
5038<p>Perform various image operation methods to a ordered sequence of images
5039which may represent either a set of overlaid 'image layers', a GIF disposal
5040animation, or a fully-'coalesced' animation sequence. </p>
5041
5042<table class="table table-condensed table-striped">
5043 <tbody>
5044 <tr>
5045 <th style="width: 8%">Method</th>
5046 <th>Description</th>
5047 </tr>
5048
5049 <tr>
5050 <td>compare-any</td>
5051 <td>Crop the second and later frames to the smallest rectangle
Cristy594d2772015-11-15 10:47:42 -05005052 that contains all the differences between the two images. No GIF <a
5053 href="command-line-options.html#dispose" >-dispose</a> methods are taken into account. </td>
Cristy882d9f42015-10-29 16:48:39 -04005054 </tr>
5055
Cristy594d2772015-11-15 10:47:42 -05005056 <tr><td></td><td>This exactly the same as the <a href="command-line-options.html#deconstruct"
5057 >-deconstruct</a> operator, and does not preserve animations normal
Cristy882d9f42015-10-29 16:48:39 -04005058 working, especially when animation used layer disposal methods such as
5059 '<code>Previous</code>' or '<code>Background</code>'. </td>
5060 </tr>
5061
5062 <tr>
5063 <td>compare-clear</td>
5064 <td>As '<code>compare-any</code>' but crop to the bounds of any
5065 opaque pixels which become transparent in the second frame. That is the
5066 smallest image needed to mask or erase pixels for the next frame. </td>
5067 </tr>
5068
5069 <tr>
5070 <td>compare-overlay</td>
5071 <td>As '<code>compare-any</code>' but crop to pixels that add
5072 extra color to the next image, as a result of overlaying color pixels.
5073 That is the smallest single overlaid image to add or change colors. </td>
5074 </tr>
5075
Cristy594d2772015-11-15 10:47:42 -05005076 <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 -04005077 composition method '<code>change-mask</code>', to reduce the image to
5078 just the pixels that need to be overlaid. </td>
5079 </tr>
5080
5081 <tr>
5082 <td>coalesce</td>
Cristy594d2772015-11-15 10:47:42 -05005083 <td>Equivalent to a call to the <a href="command-line-options.html#coalesce"
5084 >-coalesce</a> operator. Apply the layer disposal methods set in the
Cristy882d9f42015-10-29 16:48:39 -04005085 current image sequence to form a fully defined animation sequence, as
5086 it should be displayed. Effectively converting a GIF animation into a
5087 'film strip'-like animation. </td>
5088 </tr>
5089
5090 <tr>
5091 <td>composite</td>
5092 <td>Alpha Composition of two image lists, separated by a
5093 "<code>null:</code>" image, with the destination image list first, and
5094 the source images last. An image from each list are composited
5095 together until one list is finished. The separator image and source
5096 image lists are removed. </td>
5097 </tr>
5098
5099
5100 <tr><td></td>
Cristy594d2772015-11-15 10:47:42 -05005101 <td>The <a href="command-line-options.html#geometry" >-geometry</a> offset is adjusted according
5102 to <a href="command-line-options.html#gravity" >-gravity</a> in accordance of the virtual
5103 canvas size of the first image in each list. Unlike a normal <a
5104 href="command-line-options.html#composite" >-composite</a> operation, the canvas offset is also
Cristy882d9f42015-10-29 16:48:39 -04005105 added to the final composite positioning of each image. </td> </tr>
5106
5107 <tr><td></td>
5108 <td>If one of the image lists only contains one image, that image is
5109 applied to all the images in the other image list, regardless of which
5110 list it is. In this case it is the image meta-data of the list which
5111 preserved. </td>
5112 </tr>
5113
5114
5115 <tr>
5116 <td>dispose</td>
5117 <td>This like '<code>coalesce</code>' but shows the look of
5118 the animation after the layer disposal method has been applied, before
5119 the next sub-frame image is overlaid. That is the 'dispose' image that
Cristy594d2772015-11-15 10:47:42 -05005120 results from the application of the GIF <a href="command-line-options.html#dispose"
5121 >-dispose</a> method. This allows you to check what
Cristy882d9f42015-10-29 16:48:39 -04005122 is going wrong with a particular animation you may be developing.
5123 </td>
5124 </tr>
5125
5126 <tr>
5127 <td>flatten</td>
5128 <td>Create a canvas the size of the first images virtual
Cristy594d2772015-11-15 10:47:42 -05005129 canvas using the current <a href="command-line-options.html#background" >-background</a> color,
5130 and <a href="command-line-options.html#compose" >-compose</a> each image in turn onto that
Cristy882d9f42015-10-29 16:48:39 -04005131 canvas. Images falling outside that canvas is clipped. Final
5132 image will have a zero virtual canvas offset. </td>
5133 </tr>
5134
5135 <tr><td></td>
5136 <td>This usually used as one of the final 'image layering' operations
5137 overlaying all the prepared image layers into a final image. </td>
5138 </tr>
5139
5140 <tr><td></td>
5141 <td>For a single image this method can also be used to fillout a virtual
5142 canvas with real pixels, or to underlay an opaque color to remove
5143 transparency from an image.</td>
5144 </tr>
5145
5146
5147 <tr>
5148 <td>merge</td>
5149 <td>As 'flatten' method but merging all the given image
5150 layers to create a new layer image just large enough to hold all the
5151 image without clipping or extra space. The new images virtual offset
5152 will preserve the position of the new layer, even if this offset is
5153 negative. The virtual canvas size of the first image is preserved.
5154 </td>
5155 </tr>
5156
5157 <tr><td></td><td>Caution is advised when handling image layers with
5158 negative offsets as few image file formats handle them correctly.
Cristy594d2772015-11-15 10:47:42 -05005159 Following this operation method with <a href="command-line-options.html#repage" >+repage</a>
Cristy882d9f42015-10-29 16:48:39 -04005160 will remove the layer offset, and create an image in which all the
5161 overlaid image positions relative to each other is preserved, though
5162 not necessarily exactly where you specified them.
5163 </td>
5164 </tr>
5165
5166 <tr><td></td><td>See also 'trim-bounds' below which is closely related but
5167 without doing the'flatten' to merge the images together. </td>
5168 </tr>
5169
5170 <tr>
5171 <td>mosaic</td>
5172 <td>As 'flatten' method but expanding the initial canvas size
5173 of the first image in a positive direction only so as to hold all the
5174 image layers. However as a virtual canvas is 'locked' to the origin,
5175 by its own definition, image layers with a negative offsets will still
5176 become clipped by the top and left edges. See 'merge' or 'trim-bounds'
5177 if this could be a problem. </td>
5178
5179 </tr>
5180
5181 <tr><td></td><td>This method is commonly used to layout individual image
5182 using various offset but without knowing the final canvas size. The
5183 resulting image will, like 'flatten' not have any virtual offset, so
5184 can be saved to any image file format. </td>
5185 </tr>
5186
5187
5188 <tr>
5189 <td>optimize</td>
5190 <td>Optimize a coalesced animation, into GIF animation using
5191 a number of general techniques. This currently a short cut to
5192 apply both the '<code>optimize-frame</code>', and
5193 '<code>optimize-transparency</code>' methods but may be expanded to
5194 include other optimization methods as they are developed. </td>
5195 </tr>
5196
5197 <tr>
5198 <td>optimize-frame</td>
5199 <td>Optimize a coalesced animation, into GIF animation by
5200 reducing the number of pixels per frame as much as possible by
5201 attempting to pick the best layer disposal method to use, while ensuring
5202 the result will continue to animate properly. </td>
5203 </tr>
5204
5205 <tr><td></td><td> There is no guarantee that the best optimization is found.
5206 But then no reasonably fast GIF optimization algorithm can do this.
5207 However this does seem to do better than most other GIF frame
5208 optimizers seen. </td>
5209 </tr>
5210
5211 <tr>
5212 <td>optimize-plus</td>
5213 <td>As '<code>optimize-frame</code>' but attempt to improve the
5214 overall optimization by adding extra frames to the animation, without
5215 changing the final look or timing of the animation. The frames are
5216 added to attempt to separate the clearing of pixels from the
5217 overlaying of new additional pixels from one animation frame to the
5218 next. If this does not improve the optimization (for the next frame
5219 only), it will fall back to the results of the previous normal
5220 '<code>optimize-frame</code>' technique. </td>
5221 </tr>
5222
5223 <tr><td></td><td>There is the possibility that the change in the disposal
5224 style will result in a worsening in the optimization of later frames,
5225 though this is unlikely. In other words there no guarantee that it is
5226 better than the normal '<code>optimize-frame</code>' technique. For some
5227 animations however you can get a vast improvement in the final
5228 animation size. </td>
5229 </tr>
5230
5231 <tr>
5232 <td>optimize-transparency</td>
5233 <td>Given a GIF animation, replace any pixel in the sub-frame
5234 overlay images with transparency, if it does not change the resulting
Cristy594d2772015-11-15 10:47:42 -05005235 animation by more than the current <a href="command-line-options.html#fuzz" >-fuzz</a> factor.
Cristy882d9f42015-10-29 16:48:39 -04005236 </td>
5237 </tr>
5238
5239 <tr><td></td><td>This should allow a existing frame optimized GIF animation
5240 to compress into a smaller file size due to larger areas of one
5241 (transparent) color rather than a pattern of multiple colors repeating
5242 the current disposed image of the last frame. </td>
5243 </tr>
5244
5245 <tr>
5246 <td>remove-dups</td>
5247 <td>Remove (and merge time delays) of duplicate consecutive
5248 images, so as to simplify layer overlays of coalesced animations.
5249 </td>
5250 </tr>
5251
5252 <tr><td></td><td>Usually this a result of using a constant time delay
5253 across the whole animation, or after a larger animation was split into
5254 smaller sub-animations. The duplicate frames could also have been
5255 used as part of some frame optimization methods. </td>
5256 </tr>
5257
5258 <tr>
5259 <td>remove-zero</td>
5260 <td>Remove any image with a zero time delay, unless ALL the
5261 images have a zero time delay (and is not a proper timed animation, a
5262 warning is then issued). </td>
5263 </tr>
5264
5265 <tr><td></td><td>In a GIF animation, such images are usually frames which
5266 provide partial intermediary updates between the frames that are
5267 actually displayed to users. These frames are usually added for
5268 improved frame optimization in GIF animations. </td>
5269 </tr>
5270
5271 <tr>
5272 <td>trim-bounds</td>
5273 <td>Find the bounds of all the images in the current
5274 image sequence, then adjust the offsets so all images are contained on
5275 a minimal positive canvas. None of the image data is modified or
5276 merged, only the individual image virtual canvas size and offset.
5277 All the images is given the same canvas size, and and will have
5278 a positive offset, but will remain in the same position relative to
5279 each other. As a result of the minimal canvas size at least one image
5280 will touch every edge of that canvas. The image data touching those
5281 edges however may be transparent. </td>
5282 </tr>
5283
5284 <tr><td></td><td>The result is much like if you used 'merge' followed by a
Cristy594d2772015-11-15 10:47:42 -05005285 <a href="command-line-options.html#repage" >+repage</a> option, except that all the images
Cristy882d9f42015-10-29 16:48:39 -04005286 have been kept separate. If 'flatten' is used after using
5287 'trim-bounds' you will get the same result. </td>
5288 </tr>
5289
5290 </tbody>
5291</table>
5292
5293<p>To print a complete list of layer types, use <a href="command-line-options.html#list">-list layers</a>.</p>
5294
Cristy594d2772015-11-15 10:47:42 -05005295<p>The operators <a href="command-line-options.html#coalesce" >-coalesce</a>, <a href="command-line-options.html#deconstruct"
5296>-deconstruct</a>, <a href="command-line-options.html#flatten" >-flatten</a>, and <a href="command-line-options.html#mosaic"
5297>-mosaic</a> are only aliases for the above methods and may be depreciated in
5298the future. Also see <a href="command-line-options.html#page" >-page</a>, <a href="command-line-options.html#repage"
5299>-repage</a> operators, the <a href="command-line-options.html#compose" >-compose</a> setting, and the
5300GIF <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 -04005301settings. </p>
5302
5303
5304<div style="margin: auto;">
5305 <h3 class="magick-header"><a id="level"></a>-level <var>black_point</var>{,<var>white_point</var>}{<var>%</var>}{,<var>gamma</var>}</h3>
5306</div>
5307
5308<p class="magick-description">adjust the level of image channels.</p>
5309
5310<p>Given one, two or three values delimited with commas: black-point,
5311white-point, gamma (for example: 10,250,1.0 or 2%,98%,0.5). The black and
5312white points range from 0 to <var>QuantumRange</var>, or from 0 to
5313100%; if the white point is omitted it is set to (<var>QuantumRange</var> - black_point), so as to center contrast changes.
5314If a <code>%</code> sign is present anywhere in the string, both black and white
Cristy594d2772015-11-15 10:47:42 -05005315points are percentages of the full color range. Gamma will do a <a
5316href="command-line-options.html#gamma">-gamma</a> adjustment of the values. If it is omitted, the
Cristy882d9f42015-10-29 16:48:39 -04005317default of 1.0 (no gamma correction) is assumed.</p>
5318
5319<p>In normal usage (<code>-level</code>) the image values are stretched so that
5320the given '<code>black_point</code>' value in the original image is set to zero
5321(or black), while the given '<code>white_point</code>' value is set to <var>QuantumRange</var> (or white). This provides you with direct
5322contrast adjustments to the image. The '<code>gamma</code>' of the resulting
5323image will then be adjusted. </p>
5324
5325<p>From ImageMagick v6.4.1-9 using the plus form of the operator
5326(<code>+level</code>) or adding the special '!' flag anywhere in the argument
5327list, will cause the operator to do the reverse of the level adjustment. That
5328is a zero, or <var>QuantumRange</var> value (black, and white, resp.)
5329in the original image, is adjusted to the given level values, allowing you to
5330de-contrast, or compress the channel values within the image. The
5331'<code>gamma</code>' is adjusted before the level adjustment to de-contrast the
5332image is made. </p>
5333
5334<p>Only the channels defined by the current <a href="command-line-options.html#channel">-channel</a>
5335setting are adjusted (defaults to RGB color channels only), allowing you to
5336limit the effect of this operator. </p>
5337
5338<p>Please note that the transparency channel is treated as 'matte'
5339values (0 is opaque) and not as 'alpha' values (0 is transparent).</p>
5340
5341
5342<div style="margin: auto;">
5343 <h3 class="magick-header"><a id="level-colors"></a>-level-colors {<var>black_color</var>}{,}{<var>white_color</var>}</h3>
5344</div>
5345
5346<p class="magick-description">adjust the level of an image using the provided dash separated colors.</p>
5347
5348<p>This function is exactly like <a href="command-line-options.html#level">-level</a>, except that the
5349value value for each color channel is determined by the
5350'<code>black_color</code>' and '<code>white_color</code>' colors given (as
5351described under the <a href="command-line-options.html#fill">-fill</a> option). </p>
5352
5353<p>This effectually means the colors provided to <code>-level-colors</code>
5354is mapped to become 'black' and 'white' respectively, with all the other
5355colors linearly adjusted (or clipped) to match that change. Each channel is
5356adjusted separately using the channel values of the colors specified. </p>
5357
5358<p>On the other hand the plus form of the operator (<code>+level-colors</code>)
5359will map the image color 'black' and 'white' to the given colors
5360respectively, resulting in a gradient (de-contrasting) tint of the image to
Cristy769d8892016-01-19 18:11:14 -05005361those colors. This can also be used to convert a plain grayscale image into a
Cristy882d9f42015-10-29 16:48:39 -04005362one using the gradient of colors specified. </p>
5363
5364<p>By supplying a single color with a comma separator either before or after
5365that color, will just replace the respective 'black' or 'white' point
5366respectively. But if no comma separator is provided, the given color is
5367used for both the black and white color points, making the operator either
5368threshold the images around that color (- form) or set all colors to that
5369color (+ form). </p>
5370
5371
5372<div style="margin: auto;">
5373 <h3 class="magick-header"><a id="limit"></a>-limit <var>type value</var></h3>
5374</div>
5375
5376<p class="magick-description">Set the pixel cache resource limit.</p>
5377
Cristye09ed312016-03-06 08:07:39 -05005378<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 -04005379
5380<p>The value for <code>file</code> is in number of files. The other limits are
5381in bytes. Define arguments for the memory, map, area, and disk resource limits
5382with SI prefixes (.e.g 100MB).</p>
5383
5384<p>By default the limits are 768 files, 3GB of image area, 1.5GiB memory, 3GiB
5385memory map, and 18.45EB of disk. These limits are adjusted relative to the
5386available resources on your computer if this information is available. When
5387any limit is reached, ImageMagick fails in some fashion but attempts to take
5388compensating actions, if possible. For example, the following limits
5389memory:</p>
5390
5391<pre>
5392-limit memory 32MiB -limit map 64MiB
5393</pre>
5394
5395<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>
5396
5397<pre>
Cristy594d2772015-11-15 10:47:42 -05005398-> identify -list resource
Cristy882d9f42015-10-29 16:48:39 -04005399Resource limits:
5400 Width: 100MP
5401 Height: 100MP
5402 Area: 25.181GB
5403 Memory: 11.726GiB
5404 Map: 23.452GiB
5405 Disk: unlimited
5406 File: 768
5407 Thread: 12
5408 Throttle: 0
5409 Time: unlimited
5410</pre>
5411
5412<p>Requests for pixel storage to keep intermediate images are satisfied by one
5413of three resource categories: in-memory pool, memory-mapped files pool, and
Cristy594d2772015-11-15 10:47:42 -05005414disk pool (in that order) depending on the <a href="command-line-options.html#limit">&#x2011;limit</a> settings
Cristy882d9f42015-10-29 16:48:39 -04005415and whether the system honors a resource request. If the total size of
5416allocated pixel storage in the given pool reaches the corresponding limit, the
5417request is passed to the next pool. Additionally, requests that exceed the
5418<code>area</code> limit automagically are allocated on disk.</p>
5419
5420<p>To illustrate how ImageMagick utilizes resource limits, consider a typical
5421image resource request. First, ImageMagick tries to allocate the pixels in
5422memory. The request might be denied if the resource request exceeds the
5423<code>memory</code> limit or if the system does not honor the request. If
5424a memory request is not honored, the pixels are allocated to disk and the file
5425is memory-mapped. However, if the allocation request exceeds the
5426<code>map</code> limit, the resource allocation goes to disk. In all cases, if
5427the resource request exceeds the <code>area</code> limit, the pixels are
5428automagically cached to disk. If the disk has a hard limit, the program
5429fails.</p>
5430
5431<p>In most cases you simply do not need to concern yourself with resource
5432limits. ImageMagick chooses reasonable defaults and most images do not tax
5433your computer resources. Where limits do come in handy is when you process
5434images that are large or on shared systems where ImageMagick can consume all
5435or most of the available memory. In this case, the ImageMagick workflow slows
5436other processes or, in extreme cases, brings the system to a halt. Under
5437these circumstances, setting limits give some assurances that the ImageMagick
5438workflow will not interfere with other concurrent uses of the computer. For
5439example, assume you have a web interface that processes images uploaded from
5440the Internet. To assure ImageMagick does not exceed 10MiB of memory you can
5441simply set the area limit to 10MiB:</p>
5442
5443<pre>
5444-limit area 10MB
5445</pre>
5446
5447<p>Now whenever a large image is processed, the pixels are automagically
5448cached to disk instead of memory. This of course implies that large images
5449typically process very slowly, simply because pixel processing in memory can
5450be an order of magnitude faster than on disk. Because your web site users
5451might inadvertently upload a huge image to process, you should set a disk
5452limit as well:</p>
5453
5454<pre>
5455-limit area 10MB -limit disk 500MB
5456</pre>
5457
5458<p>Here ImageMagick stops processing if an image requires more than 500MB of disk storage.</p>
5459
5460<p>In addition to command-line resource limit option, resources can be set
Cristy594d2772015-11-15 10:47:42 -05005461with <a href="resources.html#environment" >environment variables</a>. Set the
Cristy882d9f42015-10-29 16:48:39 -04005462environment variables <code>MAGICK_AREA_LIMIT</code>,
5463<code>MAGICK_DISK_LIMIT</code>, <code>MAGICK_FILE_LIMIT</code>,
5464<code>MAGICK_MEMORY_LIMIT</code>, <code>MAGICK_MAP_LIMIT</code>,
5465<code>MAGICK_THREAD_LIMIT</code>, <code>MAGICK_TIME_LIMIT</code> for limits of
5466image area, disk space, open files, heap memory, memory map, number of threads
5467of execution, and maximum elapsed time in seconds respectively.</p>
5468
5469<p> Inquisitive users can try adding <a href="command-line-options.html#debug">-debug cache</a> to
5470their commands and then scouring the generated output for references to the
5471pixel cache, in order to determine how the pixel cache was allocated and how
5472resources were consumed. Advanced Unix/Linux users can pipe that output
5473through <code>grep memory|open|destroy|disk</code> for more readable sifting.
5474</p>
5475
5476<p>For more about ImageMagick's use of resources, see the section <b>Cache
Cristy594d2772015-11-15 10:47:42 -05005477Storage and Resource Requirements</b> on the <a href="architecture.html#cache
5478">Architecture</a> page. </p>
Cristy882d9f42015-10-29 16:48:39 -04005479
5480<div style="margin: auto;">
Cristy769d8892016-01-19 18:11:14 -05005481 <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 -04005482</div>
5483
5484<p class="magick-description">Linear with saturation stretch.</p>
5485
Cristy594d2772015-11-15 10:47:42 -05005486<p>This is very similar to <a href="command-line-options.html#contrast-stretch" >-contrast-stretch</a>,
Cristy882d9f42015-10-29 16:48:39 -04005487and uses a 'histogram bin' to determine the range of color values that needs to
Cristy594d2772015-11-15 10:47:42 -05005488be stretched. However it then stretches those colors using the <a
5489href="command-line-options.html#level" >-level</a> operator.</p>
Cristy882d9f42015-10-29 16:48:39 -04005490
5491<p>As such while the initial determination may have 'binning' round off
5492effects, the image colors are stretched mathematically, rather than using the
5493histogram bins. This makes the operator more accurate. </p>
5494
Cristy594d2772015-11-15 10:47:42 -05005495<p>note however that a <a href="command-line-options.html#linear-stretch" >-linear-stretch</a> of
Cristy882d9f42015-10-29 16:48:39 -04005496'<code>0</code>' does nothing, while a value of '<code>1</code>' does a near
5497perfect stretch of the color range. </p>
5498
Cristy594d2772015-11-15 10:47:42 -05005499<p>See also <a href="command-line-options.html#auto-level" >-auto-level</a> for a 'perfect'
Cristy882d9f42015-10-29 16:48:39 -04005500normalization of mathematical images. </p>
5501
5502<p>This operator is under review for re-development. </p>
5503
5504
5505<div style="margin: auto;">
5506 <h3 class="magick-header"><a id="linewidth"></a>-linewidth</h3>
5507</div>
5508
5509<p class="magick-description">the line width for subsequent draw operations.</p>
5510
5511<div style="margin: auto;">
5512 <h3 class="magick-header"><a id="liquid-rescale"></a>-liquid-rescale <var>geometry</var></h3>
5513</div>
5514
5515<p class="magick-description">rescale image with seam-carving.</p>
5516
5517<p>See <a href="command-line-processing.html#geometry">Image Geometry</a> for complete details about the <em class="arg">geometry</em> argument.</p>
5518
5519<div style="margin: auto;">
5520 <h3 class="magick-header"><a id="list"></a>-list <var>type</var></h3>
5521</div>
5522
5523<p class="magick-description">Print a list of supported arguments for various options or settings. Choose from these list types:</p>
5524
5525<pre class="pre-scrollable">
5526Align
5527Alpha
5528Boolean
5529Cache
5530Channel
5531Class
5532ClipPath
5533Coder
5534Color
5535Colorspace
5536Command
5537Complex
5538Compose
5539Compress
5540Configure
5541DataType
5542Debug
5543Decoration
5544Delegate
5545Direction
5546Dispose
5547Distort
5548Dither
5549Endian
5550Evaluate
5551FillRule
5552Filter
5553Font
5554Format
5555Function
5556Gravity
5557Intensity
5558Intent
5559Interlace
5560Interpolate
5561Kernel
5562Layers
5563LineCap
5564LineJoin
5565List
5566Locale
5567LogEvent
5568Log
5569Magic
5570Method
5571Metric
5572Mime
5573Mode
5574Morphology
5575Module
5576Noise
5577Orientation
5578PixelIntensity
5579Policy
5580PolicyDomain
5581PolicyRights
5582Preview
5583Primitive
5584QuantumFormat
5585Resource
5586SparseColor
5587Statistic
5588Storage
5589Stretch
5590Style
5591Threshold
5592Type
5593Units
5594Validate
5595VirtualPixel
5596</pre>
5597
5598<p>These lists vary depending on your version of ImageMagick. Use "<code>-list
5599list</code>" to get a complete listing of all the "<code>-list</code>" arguments
5600available:</p>
5601
5602<pre>
5603identify -list list
5604</pre>
5605
5606<div style="margin: auto;">
5607 <h3 class="magick-header"><a id="log"></a>-log <var>string</var></h3>
5608</div>
5609
5610<p class="magick-description">Specify format for debug log.</p>
5611
Cristy594d2772015-11-15 10:47:42 -05005612<p>This option specifies the format for the log printed when the <a
5613href="command-line-options.html#debug">-debug</a> option is active.</p>
Cristy882d9f42015-10-29 16:48:39 -04005614
5615<p>You can display the following components by embedding special format
5616characters:</p>
5617
5618<dl class="dl-horizontal">
5619<dt>%d</dt><dd>domain</dd>
5620<dt>%e</dt><dd>event</dd>
5621<dt>%f</dt><dd>function</dd>
5622<dt>%l</dt><dd>line</dd>
5623<dt>%m</dt><dd>module</dd>
5624<dt>%p</dt><dd>process ID</dd>
5625<dt>%r</dt><dd>real CPU time</dd>
5626<dt>%t</dt><dd>wall clock time</dd>
5627<dt>%u</dt><dd>user CPU time</dd>
5628<dt>%%</dt><dd>percent sign</dd>
5629<dt>\n</dt><dd>newline</dd>
5630<dt>\r</dt><dd>carriage return</dd>
5631</dl>
5632
5633<p>For example:</p>
5634
5635<pre>
5636convert -debug coders -log "%u %m:%l %e" in.gif out.png
5637</pre>
5638
5639<p>The default behavior is to print all of the components.</p>
5640
5641<div style="margin: auto;">
5642 <h3 class="magick-header"><a id="loop"></a>-loop <var>iterations</var></h3>
5643</div>
5644
5645<p class="magick-description">add Netscape loop extension to your GIF animation.</p>
5646
5647<p>Set iterations to zero to repeat the animation an infinite number of times,
5648otherwise the animation repeats itself up to <var>iterations</var>
5649times.</p>
5650
5651<div style="margin: auto;">
5652 <h3 class="magick-header"><a id="lowlight-color"></a>-lowlight-color <var>color</var></h3>
5653</div>
5654
5655<p class="magick-description">when comparing images, de-emphasize pixel differences with this color.</p>
5656
5657<div style="margin: auto;">
5658 <h3 class="magick-header"><a id="magnify"></a>-magnify</h3>
5659</div>
5660
5661<p class="magick-description">double the size of the image with pixel art scaling.</p>
5662
5663
5664<div style="margin: auto;">
5665 <h3 class="magick-header"><a id="map"></a>-map <var>type</var></h3>
5666</div>
5667
5668<p class="magick-description">Display image using this <var>type</var>.</p>
5669
5670<p>Choose from these <var>Standard Colormap</var> types:</p>
5671
5672<pre>
5673best
5674default
5675gray
5676red
5677green
5678blue
5679</pre>
5680
5681<p>The <var>X server</var> must support the <var>Standard
5682Colormap</var> you choose, otherwise an error occurs. Use <code>list</code> as
5683the type and <code>display</code> searches the list of colormap types in
5684<code>top-to-bottom</code> order until one is located. See <var>xstdcmap(1)</var> for one way of creating Standard Colormaps.</p>
5685
5686
5687<div style="margin: auto;">
5688 <h3 class="magick-header"><a id="map_stream_"></a>-map <var>components</var></h3>
5689</div>
5690
5691<p class="magick-description">pixel map.</p>
5692
5693<p>Here are the valid components of a map:</p>
5694
5695<dl class="dl-horizontal">
5696<dt>r</dt><dd> red pixel component</dd>
5697<dt>g</dt><dd> green pixel component</dd>
5698<dt>b</dt><dd> blue pixel component</dd>
5699<dt>a</dt><dd> alpha pixel component (0 is transparent)</dd>
5700<dt>o</dt><dd> opacity pixel component (0 is opaque)</dd>
5701<dt>i</dt><dd> grayscale intensity pixel component</dd>
5702<dt>c</dt><dd> cyan pixel component</dd>
5703<dt>m</dt><dd> magenta pixel component</dd>
5704<dt>y</dt><dd> yellow pixel component</dd>
5705<dt>k</dt><dd> black pixel component</dd>
5706<dt>p</dt><dd> pad component (always 0)</dd>
5707</dl>
5708
5709<p>You can specify as many of these components as needed in any order (e.g.
5710bgr). The components can repeat as well (e.g. rgbr).</p>
5711
5712
5713<div style="margin: auto;">
Cristy882d9f42015-10-29 16:48:39 -04005714 <h3 class="magick-header"><a id="mattecolor"></a>-mattecolor <var>color</var></h3>
5715</div>
5716
5717<p class="magick-description">Specify the color to be used with the <a href="command-line-options.html#frame">-frame</a> option.</p>
5718
5719<p>The color is specified using the format described under the <a href="command-line-options.html#fill">-fill</a> option.</p>
5720
Cristy594d2772015-11-15 10:47:42 -05005721<p>The default matte color is <code>#BDBDBD</code>, <span
5722style="background-color: #bdbdbd;">this shade of gray</span>.</p>
Cristy882d9f42015-10-29 16:48:39 -04005723
5724<div style="margin: auto;">
5725 <h3 class="magick-header"><a id="maximum"></a>-maximum</h3>
5726</div>
5727
5728<p class="magick-description">return the maximum intensity of an image sequence.</p>
5729
5730<p>Select the 'maximum' value from all the surrounding pixels. </p>
5731
Cristy594d2772015-11-15 10:47:42 -05005732<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 -04005733name. </p>
5734
5735<div style="margin: auto;">
5736 <h3 class="magick-header"><a id="median"></a>-median <var>geometry</var></h3>
5737</div>
5738
5739<p class="magick-description">apply a median filter to the image.</p>
5740
5741<p>Select the 'middle' value from all the surrounding pixels. </p>
5742
Cristy594d2772015-11-15 10:47:42 -05005743<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 -04005744name. </p>
5745
5746<div style="margin: auto;">
Cristy769d8892016-01-19 18:11:14 -05005747 <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 -04005748</div>
5749
5750<p class="magick-description">image noise removal and color reduction/segmentation (e.g. -mean-shift 7x7+10%).</p>
5751
5752<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>
5753
5754<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>
5755
5756<div style="margin: auto;">
5757 <h3 class="magick-header"><a id="metric"></a>-metric <var>type</var></h3>
5758</div>
5759
5760<p class="magick-description">Output to STDERR a measure of the differences between images according to the <var>type</var> given metric.</p>
5761
5762<p>Choose from:</p>
5763
5764<dl class="dl-horizontal">
5765<dt>AE</dt><dd> absolute error count, number of different pixels (-fuzz effected)</dd>
5766<dt>FUZZ</dt><dd> mean color distance</dd>
5767<dt>MAE</dt><dd> mean absolute error (normalized), average channel error distance</dd>
5768<dt>MEPP</dt><dd> mean error per pixel (normalized mean error, normalized peak error)</dd>
5769<dt>MSE</dt><dd> mean error squared, average of the channel error squared</dd>
5770<dt>NCC</dt><dd> normalized cross correlation</dd>
5771<dt>PAE</dt><dd> peak absolute (normalized peak absolute)</dd>
Cristy3b0b58d2016-11-06 07:40:23 -05005772<dt>PHASH</dt><dd> perceptual hash for the sRGB and HCLp colorspaces. Specify an alternative colorspace with <code>-define phash:colorspaces=<var>colorspace,colorspace,...</var></code></dd>
Cristy882d9f42015-10-29 16:48:39 -04005773<dt>PSNR</dt><dd> peak signal to noise ratio</dd>
5774<dt>RMSE</dt><dd> root mean squared (normalized root mean squared)</dd>
5775</dl>
5776
5777<p>Control the '<code>AE</code>', or absolute count of pixels that are different,
Cristy594d2772015-11-15 10:47:42 -05005778with the <a href="command-line-options.html#fuzz" >-fuzz</a> factor (ignore pixels which
Cristy882d9f42015-10-29 16:48:39 -04005779only changed by a small amount). Use '<code>PAE</code>' to find the
Cristy594d2772015-11-15 10:47:42 -05005780size of the <a href="command-line-options.html#fuzz" >-fuzz</a> factor needed to make all pixels
Cristy882d9f42015-10-29 16:48:39 -04005781'similar', while '<code>MAE</code>' determines the factor needed
5782for about half the pixels to be similar. </p>
5783
5784<p>The '<code>MEPP</code>' metric returns three different metrics
5785('<code>MAE</code>', '<code>MAE</code>' normalized, and '<code>PAE</code>'
5786normalized) from a single comparison run. </p>
5787
5788<p>To print a complete list of metrics, use the <a href="command-line-options.html#list">-list
5789metric</a> option.</p>
5790
5791
5792<div style="margin: auto;">
5793 <h3 class="magick-header"><a id="minimum"></a>-minimum</h3>
5794</div>
5795
5796<p class="magick-description">return the minimum intensity of an image sequence.</p>
5797
5798<p>Select the 'minimal' value from all the surrounding pixels. </p>
5799
Cristy594d2772015-11-15 10:47:42 -05005800<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 -04005801name. </p>
5802
5803
5804
5805<div style="margin: auto;">
5806 <h3 class="magick-header"><a id="mode"></a>-mode <var>geometry</var></h3>
5807</div>
5808
5809<p class="magick-description">make each pixel the \'predominant color\' of the neighborhood.'</p>
5810
5811<div style="margin: auto;">
5812 <h3 class="magick-header">-mode <var>value</var></h3>
5813</div>
5814
5815<p class="magick-description">Mode of operation.</p>
5816
5817<p>Choose the <var>value</var> from these styles: <code>Frame,
5818Unframe, or Concatenate</code></p>
5819
Cristy594d2772015-11-15 10:47:42 -05005820<p>Use the <a href="command-line-options.html#list" >-list</a> option with a '<code>Mode</code>' argument
5821for a list of <a href="command-line-options.html#mode" >-mode</a> arguments available in your
Cristy882d9f42015-10-29 16:48:39 -04005822ImageMagick installation.</p>
5823
5824
5825<div style="margin: auto;">
5826 <h3 class="magick-header"><a id="modulate"></a>-modulate <var>brightness</var>[,<var>saturation</var>,<var>hue</var>]</h3>
5827</div>
5828
5829<p class="magick-description">Vary the <var>brightness</var>, <var>saturation</var>, and <var>hue</var> of an image.</p>
5830
5831<p>The arguments are given as a percentages of variation. A value of 100 means
5832no change, and any missing values are taken to mean 100.</p>
5833
5834<p>The <var>brightness</var> is a multiplier of the overall
5835brightness of the image, so 0 means pure black, 50 is half as bright, 200 is
5836twice as bright. To invert its meaning <a href="command-line-options.html#negate">-negate</a> the image
5837before and after. </p>
5838
5839<p>The <var>saturation</var> controls the amount of color in an
5840image. For example, 0 produce a grayscale image, while a large value such as
5841200 produce a very colorful, 'cartoonish' color.</p>
5842
5843<p>The <var>hue</var> argument causes a "rotation" of the colors
5844within the image by the amount specified. For example, 50 results in
5845a counter-clockwise rotation of 90, mapping red shades to purple, and so on.
5846A value of either 0 or 200 results in a complete 180 degree rotation of the
5847image. Using a value of 300 is a 360 degree rotation resulting in no change to
5848the original image. </p>
5849
5850<p>For example, to increase the color brightness by 20% and decrease the color
Cristy594d2772015-11-15 10:47:42 -05005851saturation by 10% and leave the hue unchanged, use <a
5852href="command-line-options.html#modulate">-modulate 120,90</a>.</p>
Cristy882d9f42015-10-29 16:48:39 -04005853
Cristy594d2772015-11-15 10:47:42 -05005854<p>Use <a href="command-line-options.html#set">-set</a> attribute of '<code
5855>option:modulate:colorspace</code>' to specify which colorspace to
Cristy882d9f42015-10-29 16:48:39 -04005856modulate. 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>
5857
5858<pre>
5859convert image.png -set option:modulate:colorspace hsb -modulate 120,90 modulate.png
5860</pre>
5861
5862<div style="margin: auto;">
5863 <h3 class="magick-header"><a id="moments"></a>-moments</h3>
5864</div>
5865
5866<p class="magick-description">report image moments and perceptual hash.</p>
5867
5868
5869<div style="margin: auto;">
5870 <h3 class="magick-header"><a id="monitor"></a>-monitor</h3>
5871</div>
5872
5873<p class="magick-description">monitor progress.</p>
5874
5875
5876<div style="margin: auto;">
5877 <h3 class="magick-header"><a id="monochrome"></a>-monochrome</h3>
5878</div>
5879
5880<p class="magick-description">transform the image to black and white.</p>
5881
5882<div style="margin: auto;">
5883 <h3 class="magick-header"><a id="morph"></a>-morph <var>frames</var></h3>
5884</div>
5885
5886<p class="magick-description">morphs an image sequence.</p>
5887
5888<p>Both the image pixels and size are linearly interpolated to give the
5889appearance of a metamorphosis from one image to the next, over all the images
Cristy594d2772015-11-15 10:47:42 -05005890in the current image list. The added images are the equivalent of a <a
5891href="command-line-options.html#blend">-blend</a> composition. The <var>frames</var>
Cristy882d9f42015-10-29 16:48:39 -04005892argument determine how many images to interpolate between each image. </p>
5893
5894
5895<div style="margin: auto;">
5896 <h3 class="magick-header"><a id="morphology"></a>-morphology</h3>
5897 <h3 class="magick-header">-morphology <var>method</var> <var>kernel</var></h3>
5898</div>
5899
5900<p class="magick-description">apply a morphology method to the image.</p>
5901
Cristy594d2772015-11-15 10:47:42 -05005902<p>Until I get around to writing an option summary for this, see <a
Cristy364a72f2016-11-04 22:38:41 -04005903href="https://www.imagemagick.org/Usage/morphology/" >IM Usage Examples,
Cristy882d9f42015-10-29 16:48:39 -04005904Morphology</a>. </p>
5905
5906
5907<div style="margin: auto;">
5908 <h3 class="magick-header"><a id="mosaic"></a>-mosaic</h3>
5909</div>
5910
Cristy594d2772015-11-15 10:47:42 -05005911<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 -04005912
5913
5914<div style="margin: auto;">
Cristy594d2772015-11-15 10:47:42 -05005915 <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 -04005916</div>
5917
5918<p class="magick-description">simulate motion blur.</p>
5919
5920<p>Blur with the given radius, standard deviation (sigma), and angle. The
5921angle given is the angle toward which the image is blurred. That is the
5922direction people would consider the object is coming from. </p>
5923
5924<p>Note that the blur is not uniform distribution, giving the motion a
5925definite sense of direction of movement. </p>
5926
5927<p>The <a href="command-line-options.html#virtual-pixel">-virtual-pixel</a> setting will determine how
5928pixels which are outside the image proper are blurred into the final result.
5929</p>
5930
5931<div style="margin: auto;">
5932 <h3 class="magick-header"><a id="name"></a>-name</h3>
5933</div>
5934
5935<p class="magick-description">name an image.</p>
5936<div style="margin: auto;">
5937 <h3 class="magick-header"><a id="negate"></a>-negate</h3>
5938</div>
5939
5940<p class="magick-description">replace each pixel with its complementary color.</p>
5941
5942<p>The red, green, and blue intensities of an image are negated. White becomes
5943black, yellow becomes blue, etc. Use <a href="command-line-options.html#negate">+negate</a> to only
5944negate the grayscale pixels of the image.</p>
5945
5946<div style="margin: auto;">
Cristy594d2772015-11-15 10:47:42 -05005947 <h3 class="magick-header"><a id="noise"></a>-noise <var>geometry</var><br/>
Cristy882d9f42015-10-29 16:48:39 -04005948 +noise <var>type</var></h3>
5949</div>
5950
5951<p class="magick-description">Add or reduce noise in an image.</p>
5952
5953<p>The principal function of noise peak elimination filter is to smooth the
5954objects within an image without losing edge information and without creating
5955undesired structures. The central idea of the algorithm is to replace a pixel
5956with its next neighbor in value within a pixel window, if this pixel has been
5957found to be noise. A pixel is defined as noise if and only if this pixel is
5958a maximum or minimum within the pixel window.</p>
5959
5960<p>Use <code><a href="command-line-options.html#noise">-noise</a> <var>radius</var></code> to
5961specify the width of the neighborhood when reducing noise. This is equivalent
Cristy594d2772015-11-15 10:47:42 -05005962to using a <code><a href="command-line-options.html#statistic" >-statistic</a> NonPeak</code> operation,
Cristy882d9f42015-10-29 16:48:39 -04005963which should be used in preference.</p>
5964
5965<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
5966types:</p>
5967
5968<pre>
5969Gaussian
5970Impulse
5971Laplacian
5972Multiplicative
5973Poisson
5974Random
5975Uniform
5976</pre>
5977
Cristy594d2772015-11-15 10:47:42 -05005978<p>The amount of noise added can be controlled by the <code><a
5979href="command-line-options.html#attenuate" >-attenuate</a></code> setting. If unset the value is
Cristy882d9f42015-10-29 16:48:39 -04005980equivalent to 1.0, or a maximum noise addition.</p>
5981
5982<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>
5983
5984<p>To print a complete list of noises, use the <a href="command-line-options.html#list">-list noise</a> option.</p>
5985
5986<p>Also see the <a href="command-line-options.html#evaluate">-evaluate</a> noise functions that allows
5987the use of a controlling value to specify the amount of noise that should be
5988added to an image. </p>
5989
5990
5991<div style="margin: auto;">
5992 <h3 class="magick-header"><a id="normalize"></a>-normalize</h3>
5993</div>
5994
5995<p class="magick-description">Increase the contrast in an image by <var>stretching</var> the range of intensity values.</p>
5996
5997<p>The intensity values are stretched to cover the entire range of possible
5998values. While doing so, black-out at most <var>2%</var> of the pixels and
5999white-out at most <var>1%</var> of the pixels.</p>
6000
Cristy594d2772015-11-15 10:47:42 -05006001<p>Note that as of ImageMagick 6.4.7-0, <a href="command-line-options.html#normalize" >-normalize</a>
6002is equivalent to <a href="command-line-options.html#contrast-stretch" >-contrast-stretch 2%x1%</a>.
6003(Before this version, it was equivalent to <a href="command-line-options.html#contrast-stretch"
6004>-contrast-stretch 2%x99%</a>).</p>
Cristy882d9f42015-10-29 16:48:39 -04006005
Cristy769d8892016-01-19 18:11:14 -05006006<p>All the channels are normalized in concert by the same amount so as to
Cristy594d2772015-11-15 10:47:42 -05006007preserve color integrity, when the default <a href="command-line-options.html#channel" >+channel</a>
6008setting is in use. Specifying any other <a href="command-line-options.html#channel" >-channel</a>
Cristy882d9f42015-10-29 16:48:39 -04006009setting will normalize the RGB channels independently.</p>
6010
Cristy594d2772015-11-15 10:47:42 -05006011<p>See <a href="command-line-options.html#contrast-stretch" >-contrast-stretch</a> for more details.
6012Also see <a href="command-line-options.html#auto-level" >-auto-level</a> for a 'perfect' normalization
Cristy882d9f42015-10-29 16:48:39 -04006013that is better suited to mathematically generated images. </p>
6014
6015<p>This operator is under review for re-development. </p>
6016
6017
6018<div style="margin: auto;">
6019 <h3 class="magick-header"><a id="opaque"></a>-opaque <var>color</var></h3>
6020</div>
6021
6022<p class="magick-description">change this color to the fill color within the image.</p>
6023
6024<p>The <var>color</var> argument is defined using the format
Cristy594d2772015-11-15 10:47:42 -05006025described under the <a href="command-line-options.html#fill" >-fill</a> option. The <a href="command-line-options.html#fuzz"
6026>-fuzz</a> setting can be used to match and replace colors similar to the one
Cristy882d9f42015-10-29 16:48:39 -04006027given.</p>
6028
6029<p>Use <a href="command-line-options.html#opaque">+opaque</a> to paint any pixel that does not match
6030the target color. </p>
6031
6032<p>The <a href="command-line-options.html#transparent">-transparent</a> operator is exactly the same
Cristy594d2772015-11-15 10:47:42 -05006033as <a href="command-line-options.html#opaque" >-opaque</a> but replaces the matching color with
Cristy882d9f42015-10-29 16:48:39 -04006034transparency rather than the current <a href="command-line-options.html#fill">-fill</a> color setting.
6035To ensure that it can do this it also ensures that the image has an alpha
Cristy594d2772015-11-15 10:47:42 -05006036channel enabled, as per "<code><a href="command-line-options.html#alpha" >-alpha</a> set</code>", for
6037the new transparent colors, and does not require you to modify the <a
6038href="command-line-options.html#channel">-channel</a> to enable alpha channel handling. </p>
Cristy882d9f42015-10-29 16:48:39 -04006039
6040
6041<div style="margin: auto;">
6042 <h3 class="magick-header"><a id="ordered-dither"></a>-ordered-dither <var>threshold_map</var>{,<var>level</var>...}</h3>
6043</div>
6044
6045<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
6046given number of <var>levels</var> per color channel.</p>
6047
6048<p>You can choose from these standard threshold maps:</p>
6049
6050<pre class="pre-scrollable">
6051threshold 1x1 Threshold 1x1 (non-dither)
6052checks 2x1 Checkerboard 2x1 (dither)
6053o2x2 2x2 Ordered 2x2 (dispersed)
6054o3x3 3x3 Ordered 3x3 (dispersed)
6055o4x4 4x4 Ordered 4x4 (dispersed)
6056o8x8 8x8 Ordered 8x8 (dispersed)
6057h3x4a 4x1 Halftone 4x4 (angled)
6058h6x6a 6x1 Halftone 6x6 (angled)
6059h8x8a 8x1 Halftone 8x8 (angled)
6060h3x4o Halftone 4x4 (orthogonal)
6061h6x6o Halftone 6x6 (orthogonal)
6062h8x8o Halftone 8x8 (orthogonal)
6063h36x16o Halftone 16x16 (orthogonal)
6064c5x5b c5x5 Circles 5x5 (black)
6065c5x5w Circles 5x5 (white)
6066c6x6b c6x6 Circles 6x6 (black)
6067c6x6w Circles 6x6 (white)
6068c7x7b c7x7 Circles 7x7 (black)
6069c7x7w Circles 7x7 (white)
6070</pre>
6071
6072<p> The <code>threshold</code> generated a simple 50% threshold of the image.
Cristy594d2772015-11-15 10:47:42 -05006073This could be used with <var >level</var> to do the equivalent of <a
6074href="command-line-options.html#posterize" >-posterize</a> to reduce an image to basic primary colors.
Cristy882d9f42015-10-29 16:48:39 -04006075</p>
6076
6077<p>The <code>checks</code> pattern produces a 3 level checkerboard dither
6078pattern. That is a grayscale will become a pattern of solid black, solid
6079white, and mid-tone colors into a checkerboard pattern of black and white.
6080</p>
6081
Cristy594d2772015-11-15 10:47:42 -05006082<p>You can define your own <var >threshold map</var> for ordered
Cristy882d9f42015-10-29 16:48:39 -04006083dithering and halftoning your images, in either personal or system
Cristy594d2772015-11-15 10:47:42 -05006084<code>thresholds.xml</code> XML file. See <a href="resources.html" >Resources</a>
Cristy882d9f42015-10-29 16:48:39 -04006085for more details of configuration files. </p>
6086
6087<p>To print a complete list of the thresholds that have been defined, use the
Cristy594d2772015-11-15 10:47:42 -05006088<a href="command-line-options.html#list" >-list threshold</a> option.</p>
Cristy882d9f42015-10-29 16:48:39 -04006089
6090<p>Note that at this time the same threshold dithering map is used for all
6091color channels, no attempt is made to offset or rotate the map for different
6092channels is made, to create an offset printing effect. Also as the maps are
6093simple threshold levels, the halftone and circle maps will create incomplete
6094circles along the edges of a colored area. Also all the effects are purely
6095on/off boolean effects, without anti-aliasing to make the circles smooth
6096looking. Large dots can be made to look better with a small amount of blurring
6097after being created. </p>
6098
6099
6100<div style="margin: auto;">
6101 <h3 class="magick-header"><a id="orient"></a>-orient <var>image orientation</var></h3>
6102</div>
6103
6104<p class="magick-description">specify orientation of a digital camera image.</p>
6105
6106<p>Choose from these orientations:</p>
6107
6108<pre>
6109bottom-left right-top
6110bottom-right top-left
6111left-bottom top-right
6112left-top undefined
6113right-bottom
6114</pre>
6115
Cristy594d2772015-11-15 10:47:42 -05006116<p>To print a complete list of orientations, use the <a href="command-line-options.html#list" >-list
Cristy882d9f42015-10-29 16:48:39 -04006117orientation</a> option.</p>
6118
6119
6120<div style="margin: auto;">
Cristy594d2772015-11-15 10:47:42 -05006121 <h3 class="magick-header"><a id="page"></a>-page <var>geometry</var><br/>
6122 -page <var>media</var>[<var>offset</var>][{<var>^!&lt;&gt;</var>}]<br/>
Cristy882d9f42015-10-29 16:48:39 -04006123 +page
6124 </h3>
6125</div>
6126
6127<p class="magick-description">Set the size and location of an image on the larger virtual canvas.</p>
6128
6129<p>See <a href="command-line-processing.html#geometry">Image Geometry</a> for complete details about the <em class="arg">geometry</em> argument.</p>
6130
6131<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 -05006132<var>geometry</var> arguments (e.g. <a
6133href="command-line-options.html#page">-page</a> <code>Letter+43+43</code>).</p>
Cristy882d9f42015-10-29 16:48:39 -04006134
6135<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.
6136The choices for a PostScript page are:</p>
6137
6138<dl class="dl-horizontal">
6139<dt> 11x17 </dt> <dd> 792 x 1224</dd>
6140<dt> Ledger </dt> <dd> 1224 x 792</dd>
6141<dt> Legal </dt> <dd> 612 x 1008</dd>
6142<dt> Letter </dt> <dd> 612 x 792</dd>
6143<dt> LetterSmall</dt> <dd> 612 x 792</dd>
6144<dt> ArchE </dt> <dd> 2592 x 3456</dd>
6145<dt> ArchD </dt> <dd> 1728 x 2592</dd>
6146<dt> ArchC </dt> <dd> 1296 x 1728</dd>
6147<dt> ArchB </dt> <dd> 864 x 1296</dd>
6148<dt> ArchA </dt> <dd> 648 x 864</dd>
6149<dt> A0 </dt> <dd> 2380 x 3368</dd>
6150<dt> A1 </dt> <dd> 1684 x 2380</dd>
6151<dt> A2 </dt> <dd> 1190 x 1684</dd>
6152<dt> A3 </dt> <dd> 842 x 1190</dd>
6153<dt> A4 </dt> <dd> 595 x 842</dd>
6154<dt> A4Small </dt> <dd> 595 x 842</dd>
6155<dt> A5 </dt> <dd> 421 x 595</dd>
6156<dt> A6 </dt> <dd> 297 x 421</dd>
6157<dt> A7 </dt> <dd> 210 x 297</dd>
6158<dt> A8 </dt> <dd> 148 x 210</dd>
6159<dt> A9 </dt> <dd> 105 x 148</dd>
6160<dt> A10 </dt> <dd> 74 x 105</dd>
6161<dt> B0 </dt> <dd> 2836 x 4008</dd>
6162<dt> B1 </dt> <dd> 2004 x 2836</dd>
6163<dt> B2 </dt> <dd> 1418 x 2004</dd>
6164<dt> B3 </dt> <dd> 1002 x 1418</dd>
6165<dt> B4 </dt> <dd> 709 x 1002</dd>
6166<dt> B5 </dt> <dd> 501 x 709</dd>
6167<dt> C0 </dt> <dd> 2600 x 3677</dd>
6168<dt> C1 </dt> <dd> 1837 x 2600</dd>
6169<dt> C2 </dt> <dd> 1298 x 1837</dd>
6170<dt> C3 </dt> <dd> 918 x 1298</dd>
6171<dt> C4 </dt> <dd> 649 x 918</dd>
6172<dt> C5 </dt> <dd> 459 x 649</dd>
6173<dt> C6 </dt> <dd> 323 x 459</dd>
6174<dt> Flsa </dt> <dd> 612 x 936</dd>
6175<dt> Flse </dt> <dd> 612 x 936</dd>
6176<dt> HalfLetter </dt> <dd> 396 x 612</dd>
6177</dl>
6178
6179<p>This option is also used to place subimages when writing to a multi-image
6180format that supports offsets, such as GIF89 and MNG. When used for this
6181purpose the offsets are always measured from the top left corner of the canvas
6182and are not affected by the <a href="command-line-options.html#gravity">-gravity</a> option. To
6183position 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
6184file, a <a href="command-line-options.html#page">-page</a> option appearing ahead of the first image in
6185the sequence with nonzero width and height defines the width and height values
6186that are written in the <code>MHDR</code> chunk. Otherwise, the MNG width and
6187height are computed from the bounding box that contains all images in the
6188sequence. When writing a GIF89 file, only the bounding box method is used to
6189determine its dimensions.</p>
6190
Cristy594d2772015-11-15 10:47:42 -05006191<p>For a PostScript page, the image is sized as in <a
6192href="command-line-options.html#geometry">-geometry</a> but positioned relative to the <var>lower
6193left-hand corner</var> of the page by {+-}<code>x</code><var>offset</var>{+-}<code>y</code> <var>offset</var>. Use <a
6194href="command-line-options.html#page">-page 612x792</a>, for example, to center the image within the
Cristy882d9f42015-10-29 16:48:39 -04006195page. If the image size exceeds the PostScript page, it is reduced to fit the
6196page. 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
6197corner of the page, unless the <a href="command-line-options.html#gravity">-gravity</a> option is
6198present with a value other than <var>NorthWest</var>.</p>
6199
6200<p>The default page dimensions for a TEXT image is 612x792.</p>
6201
6202<p>This option is used in concert with <a href="command-line-options.html#density">-density</a>.</p>
6203
6204<p>Use <a href="command-line-options.html#page">+page</a> to remove the page settings for an image.</p>
6205
6206<div style="margin: auto;">
6207 <h3 class="magick-header"><a id="paint"></a>-paint <var>radius</var></h3>
6208</div>
6209
6210<p class="magick-description">simulate an oil painting.</p>
6211
6212<p>Each pixel is replaced by the most frequent color in a circular
6213neighborhood whose width is specified with <var>radius</var>.</p>
6214
6215<div style="margin: auto;">
6216 <h3 class="magick-header"><a id="path"></a>-path <var>path</var></h3></div>
6217
6218<p class="magick-description">write images to this path on disk.</p>
6219
6220<div style="margin: auto;">
6221 <h3 class="magick-header"><a id="pause_animate_"></a>-pause <var>seconds</var></h3>
6222</div>
6223
6224<p class="magick-description">Pause between animation loops</p>
6225
6226<p>Pause for the specified number of seconds before repeating the animation.</p>
6227
6228<div style="margin: auto;">
6229 <h3 class="magick-header"><a id="pause_import_"></a>-pause <var>seconds</var></h3>
6230</div>
6231
6232<p class="magick-description">Pause between snapshots.</p>
6233
6234<p>Pause for the specified number of seconds before taking the next snapshot.</p>
6235
6236<div style="margin: auto;">
6237 <h3 class="magick-header"><a id="perceptible"></a>-perceptible <var>epsilon</var></h3>
6238</div>
6239
6240<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>
6241
6242<div style="margin: auto;">
6243 <h3 class="magick-header"><a id="ping"></a>-ping</h3>
6244</div>
6245
6246<p class="magick-description">efficiently determine image characteristics.</p>
6247
6248<div style="margin: auto;">
6249 <h3 class="magick-header"><a id="pointsize"></a>-pointsize <var>value</var></h3>
6250</div>
6251
6252<p class="magick-description">pointsize of the PostScript, OPTION1, or TrueType font.</p>
6253
6254<div style="margin: auto;">
6255 <h3 class="magick-header"><a id="polaroid"></a>-polaroid <var>angle</var></h3>
6256</div>
6257
6258<p class="magick-description">simulate a Polaroid picture.</p>
6259
6260<p>Use <code>+polaroid</code> to rotate the image at a random angle between -15 and +15 degrees.</p>
6261
6262<div style="margin: auto;">
6263 <h3 class="magick-header"><a id="poly"></a>-poly <var>"wt,exp ..."</var></h3>
6264</div>
6265
6266<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>
6267
6268<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>
6269
6270<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>
6271
6272<p>The format is: <var>output = wt1*image1^exp1 + wt2*image2^exp2 </var>...</p>
6273
6274<p>Some simple uses are:</p>
6275<ul>
6276<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>
6277<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>
6278</ul>
6279
6280<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>
6281
6282<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>
6283
6284
6285<div style="margin: auto;">
6286 <h3 class="magick-header"><a id="posterize"></a>-posterize <var>levels</var></h3>
6287</div>
6288
6289<p class="magick-description">reduce the image to a limited number of color levels per channel.</p>
6290
6291<p>Very low values of <var>levels</var>, e.g., 2, 3, 4, have the most
6292visible effect.</p>
6293
6294<div style="margin: auto;">
6295 <h3 class="magick-header"><a id="precision"></a>-precision <var>value</var></h3>
6296</div>
6297
6298<p class="magick-description">set the maximum number of significant digits to be printed.</p>
6299
6300<div style="margin: auto;">
6301 <h3 class="magick-header"><a id="preview"></a>-preview <var>type</var></h3>
6302</div>
6303
6304<p class="magick-description">image preview type.</p>
6305
6306<p>Use this option to affect the preview operation of an image (e.g.
6307<code>convert file.png -preview Gamma Preview:gamma.png</code>). Choose from
6308these previews:</p>
6309
6310<pre class="pre-scrollable">
6311AddNoise
6312Blur
6313Brightness
6314Charcoal
6315Despeckle
6316Dull
6317EdgeDetect
6318Gamma
6319Grayscale
6320Hue
6321Implode
6322JPEG
6323OilPaint
6324Quantize
6325Raise
6326ReduceNoise
6327Roll
6328Rotate
6329Saturation
6330Segment
6331Shade
6332Sharpen
6333Shear
6334Solarize
6335Spiff
6336Spread
6337Swirl
6338Threshold
6339Wave
6340</pre>
6341
6342<p>To print a complete list of previews, use the <a href="command-line-options.html#list">-list preview</a> option.</p>
6343
6344<p>The default preview is <code>JPEG</code>.</p>
6345
6346<div style="margin: auto;">
6347 <h3 class="magick-header"><a id="print"></a>-print <var>string</var></h3>
6348</div>
6349
6350<p class="magick-description">interpret string and print to console.</p>
6351
6352<div style="margin: auto;">
6353 <h3 class="magick-header"><a id="process"></a>-process <var>command</var></h3>
6354</div>
6355
6356<p class="magick-description">process the image with a custom image filter.</p>
6357
6358<p>The command arguments has the form <code>"module arg1 arg2 arg3 ...
6359argN"</code> where <code>module</code> is the name of the module to invoke (e.g.
6360"Analyze") and arg1 arg2 arg3 ... argN are an arbitrary number of arguments to
6361pass to the process module.</p>
6362
6363<div style="margin: auto;">
Cristy594d2772015-11-15 10:47:42 -05006364 <h3 class="magick-header"><a id="profile"></a>-profile <var>filename</var><br/>
Cristy882d9f42015-10-29 16:48:39 -04006365 +profile <var>profile_name</var></h3>
6366</div>
6367
6368<p class="magick-description">Manage ICM, IPTC, or generic profiles in an image.</p>
6369
6370<p>Using <a href="command-line-options.html#profile">-profile</a> <var>filename</var> adds an
6371ICM (ICC color management), IPTC (newswire information), or a generic profile
6372to the image.</p>
6373
6374<p>Use <a href="command-line-options.html#profile">+profile <var>profile_name</var></a> to
6375remove the indicated profile. ImageMagick uses standard filename globbing, so
6376wildcard expressions may be used to remove more than one profile. Here we
6377remove all profiles from the image except for the XMP profile: <code>+profile
6378"!xmp,*"</code>. </p>
6379
6380<p>Use <code>identify -verbose</code> to find out which profiles are in the
6381image file. Use <a href="command-line-options.html#strip">-strip</a> to remove all profiles (and
6382comments).</p>
6383
6384<p>To extract a profile, the <a href="command-line-options.html#profile">-profile</a> option is not
6385used. Instead, simply write the file to an image format such as <var>APP1, 8BIM, ICM,</var> or <var>IPTC</var>.</p>
6386
6387<p>For example, to extract the Exif data (which is stored in JPEG files in the
6388<var>APP1</var> profile), use.</p>
6389
6390<pre>
6391convert cockatoo.jpg profile.exif
6392</pre>
6393
6394<p>It is important to note that results may depend on whether or not the
Cristy594d2772015-11-15 10:47:42 -05006395original image already has an included profile. Also, keep in mind that <a
6396href="command-line-options.html#profile">-profile</a> is an "operator" (as opposed to a "setting") and
Cristy882d9f42015-10-29 16:48:39 -04006397therefore a conversion is made each time it is encountered, in order, in the
6398command-line. For instance, in the following example, if the original image is
6399CMYK with profile, a CMYK-CMYK-RGB conversion results.</p>
6400
6401<pre>
6402convert CMYK.tif -profile "CMYK.icc" -profile "RGB.icc" RGB.tiff
6403</pre>
6404
6405<p>Furthermore, since ICC profiles are not necessarily symmetric, extra
6406conversion steps can yield unwanted results. CMYK profiles are often very
6407asymmetric since they involve 3−&gt;4 and 4−&gt;3 channel mapping.
6408</p>
6409
6410<div style="margin: auto;">
6411 <h3 class="magick-header"><a id="quality"></a>-quality <var>value</var></h3>
6412</div>
6413
6414<p class="magick-description">JPEG/MIFF/PNG compression level.</p>
6415
6416<p>For the JPEG and MPEG image formats, quality is 1 (lowest image quality and
6417highest compression) to 100 (best quality but least effective compression).
6418The default is to use the estimated quality of your input image if it can
6419be determined, otherwise 92. When the quality is greater than 90, then the
6420chroma channels are not downsampled.
6421Use the <a href="command-line-options.html#sampling-factor">-sampling-factor</a> option to specify the
6422factors for chroma downsampling.</p>
6423
6424<p>For the JPEG-2000 image format, quality is mapped using a non-linear
6425equation to the compression ratio required by the Jasper library. This
6426non-linear equation is intended to loosely approximate the quality provided by
6427the JPEG v1 format. The default quality value 100, a request for non-lossy
6428compression. A quality of 75 results in a request for 16:1 compression.</p>
6429
6430<p>For the MNG and PNG image formats, the quality value sets the zlib
6431compression level (quality / 10) and filter-type (quality % 10). The default
6432PNG "quality" is 75, which means compression level 7 with adaptive PNG
6433filtering, unless the image has a color map, in which case it means
6434compression level 7 with no PNG filtering.</p>
6435
6436<p>For compression level 0 (quality value less than 10), the Huffman-only
6437strategy is used, which is fastest but not necessarily the worst
6438compression.</p>
6439
6440<p>If filter-type is 4 or less, the specified PNG filter-type is used for
6441all scanlines:</p>
6442
6443<dl class="dl-horizontal">
6444<dt>0</dt><dd>none</dd>
6445<dt>1</dt><dd>sub</dd>
6446<dt>2</dt><dd>up</dd>
6447<dt>3</dt><dd>average</dd>
6448<dt>4</dt><dd>Paeth</dd>
6449</dl>
6450
6451<p>If filter-type is 5, adaptive filtering is used when quality is greater
6452than 50 and the image does not have a color map, otherwise no filtering is
6453used.</p>
6454
6455<p>If filter-type is 6, adaptive filtering
6456with <var>minimum-sum-of-absolute-values</var> is used.</p>
6457
6458<p>Only if the output is MNG, if filter-type is 7, the LOCO color
6459transformation (intrapixel differencing) and adaptive filtering
6460with <var>minimum-sum-of-absolute-values</var> are used.</p>
6461
6462<p>If the filter-type is 8 the zlib Z_RLE compression strategy (or the
6463Z_HUFFMAN_ONLY strategy, when compression level is 0) is used with
6464adaptive PNG filtering.</p>
6465
6466<p>If the filter-type is 9 the zlib Z_RLE compression strategy (or the
6467Z_HUFFMAN_ONLY strategy, when compression level is 0) is used with
6468no PNG filtering.</p>
6469
6470<p>The quality setting has no effect on the appearance or signature of PNG
6471and MNG images, since the compression is always lossless.</p>
6472
6473<p>Not all combinations of compression level, strategy, and PNG filter type
6474can be obtained using the -quality option. For more precise control,
6475you can use the PNG:compression-level=N, PNG:compression-strategy=N, and
6476PNG:compression-filter=N defines, respectively, instead.
6477See <a href="command-line-options.html#define">-define</a>. Values from the defines take precedence
6478over values from the -quality option.</p>
6479
6480<p>For further information, see
6481the <a href="http://www.w3.org/pub/WWW/TR">PNG</a> specification.</p>
6482
6483<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>
6484
6485<p>For the BPG image format, quality/2 is the actual BPG compression level (range from 0 to 51).</p>
6486
6487<div style="margin: auto;">
6488 <h3 class="magick-header"><a id="quantize"></a>-quantize <var>colorspace</var></h3>
6489</div>
6490
6491<p class="magick-description">reduce colors using this colorspace.</p>
6492
6493<p>This setting defines the colorspace used to sort out and reduce the number
Cristy594d2772015-11-15 10:47:42 -05006494of colors needed by an image (for later dithering) by operators such as <a
6495href="command-line-options.html#colors" >-colors</a>, Note that color reduction also happens
Cristy882d9f42015-10-29 16:48:39 -04006496automatically when saving images to color-limited image file formats, such as
6497GIF, and PNG8.</p>
6498
6499
6500<div style="margin: auto;">
6501 <h3 class="magick-header"><a id="quiet"></a>-quiet</h3>
6502</div>
6503
6504<p class="magick-description">suppress all warning messages. Error messages are still reported.</p>
6505
6506<div style="margin: auto;">
6507 <h3 class="magick-header"><a id="radial-blur"></a>-radial-blur <var>angle</var></h3>
6508</div>
6509
6510<p class="magick-description">Blur around the center of the image.</p>
6511
6512<p>Note that this is actually a rotational blur rather than a radial and as
6513such actually mis-named. </p>
6514
6515<p>The <a href="command-line-options.html#virtual-pixel">-virtual-pixel</a> setting will determine how
6516pixels which are outside the image proper are blurred into the final result.
6517</p>
6518
6519
6520<div style="margin: auto;">
6521 <h3 class="magick-header"><a id="raise"></a>-raise <var>thickness</var></h3>
6522</div>
6523
6524<p class="magick-description">Lighten or darken image edges.</p>
6525
6526<p>This will create a 3-D effect. Use <a href="command-line-options.html#raise">-raise</a> to create
6527a raised effect, otherwise use <a href="command-line-options.html#raise">+raise</a>. </p>
6528
Cristy594d2772015-11-15 10:47:42 -05006529<p>Unlike the similar <a href="command-line-options.html#frame">-frame</a> option, <a
6530href="command-line-options.html#raise">-raise</a> does not alter the dimensions of the image.</p>
Cristy882d9f42015-10-29 16:48:39 -04006531
6532<div style="margin: auto;">
6533 <h3 class="magick-header"><a id="random-threshold"></a>-random-threshold <var>low</var>x<var>high</var></h3>
6534</div>
6535
6536<p class="magick-description">Apply a random threshold to the image.</p>
6537
6538<div style="margin: auto;">
Cristye0779712016-07-30 17:25:22 -04006539 <h3 class="magick-header"><a id="read-mask"></a>-read-mask
6540<var>filename</var></h3>
6541</div>
6542
6543<p class="magick-description">Prevent updates to image pixels specified by the mask.</p>
6544
6545<p>This the same as using a mask used for composite masking operations, with
6546grayscale values causing blended updates of the image the mask is attached to.
6547</p>
6548
6549<p>Use <a href="command-line-options.html#read-mask">+read-mask</a> to remove the mask from images.</p>
6550
6551<p>Also see <a href="command-line-options.html#clip-mask">-clip-mask</a> which work in the same way,
6552but with strict boolean masking. </p>
6553
6554<div style="margin: auto;">
Cristy882d9f42015-10-29 16:48:39 -04006555 <h3 class="magick-header"><a id="red-primary"></a>-red-primary <var>x,y</var></h3>
6556</div>
6557
6558<p class="magick-description">Set the red chromaticity primary point.</p>
6559
6560<div style="margin: auto;">
6561 <h3 class="magick-header"><a id="regard-warnings"></a>-regard-warnings</h3>
6562</div>
6563
6564<p class="magick-description">Pay attention to warning messages.</p>
6565
6566<p>This option causes some warnings in some image formats to be treated
6567as errors. </p>
6568
6569<div style="margin: auto;">
6570 <h3 class="magick-header"><a id="remap"></a>-remap <var>filename</var></h3>
6571</div>
6572
6573<p class="magick-description">Reduce the number of colors in an image to the colors used by this image.</p>
6574
6575<p>If the <a href="command-line-options.html#dither">-dither</a> setting is enabled (the default) then
6576the given colors are dithered over the image as necessary, otherwise the closest
6577color (in RGB colorspace) is selected to replace that pixel in the image. </p>
6578
6579<p>As a side effect of applying a <a href="command-line-options.html#remap">-remap</a> of colors across all
6580images in the current image sequence, all the images will have the same color
6581table. That means that when saved to a file format such as GIF, it will use
6582that color table as a single common or global color table, for all the images,
6583without requiring extra local color tables. </p>
6584
6585<p>Use <a href="command-line-options.html#remap">+remap</a> to reduce all images in the current image
6586sequence to use a common color map over all the images. This equivalent to
6587appending all the images together (without extra background colors) and color
6588reducing those images using <a href="command-line-options.html#colors">-colors</a> with a 256 color
6589limit, then <a href="command-line-options.html#remap">-remap</a> those colors over the original list of
6590images. This ensures all the images follow a single color map. </p>
6591
Cristy594d2772015-11-15 10:47:42 -05006592<p>If the number of colors over all the images is less than 256, then <a
6593href="command-line-options.html#remap">+remap</a> should not perform any color reduction or dithering, as
Cristy882d9f42015-10-29 16:48:39 -04006594no color changes are needed. In that case, its only effect is to force the use
Cristy594d2772015-11-15 10:47:42 -05006595of a global color table. This recommended after using either <a
6596href="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 -04006597reduce the number of colors in an animated image sequence. </p>
6598
6599<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>
6600
6601<div style="margin: auto;">
6602 <h3 class="magick-header"><a id="region"></a>-region <var>geometry</var></h3>
6603</div>
6604
6605<p class="magick-description">Set a region in which subsequent operations apply.</p>
6606
6607<p>The <var>x</var> and <var>y</var> offsets are treated
6608in the same manner as in <a href="command-line-options.html#crop">-crop</a>.</p>
6609
6610<p>See <a href="command-line-processing.html#geometry">Image Geometry</a> for complete details about the <em class="arg">geometry</em> argument.</p>
6611
6612<p>Use <code>+region</code> to remove any previously set regions.</p>
6613
Cristy882d9f42015-10-29 16:48:39 -04006614<div style="margin: auto;">
6615 <h3 class="magick-header"><a id="remote"></a>-remote</h3>
6616</div>
6617
6618<p class="magick-description">perform a remote operation.</p>
6619
6620<p>The only command recognized is the name of an image file to load.</p>
6621
6622<p>If you have more than one <a href="display.html">display</a> application
6623running simultaneously, use the <a href="command-line-options.html#window"> window</a> option to
6624specify which application to control.</p>
6625
6626<div style="margin: auto;">
6627 <h3 class="magick-header"><a id="render"></a>-render</h3>
6628</div>
6629
6630<p class="magick-description">render vector operations.</p>
6631
6632<p>Use <a href="command-line-options.html#render">+render</a> to turn off rendering vector operations.
6633This useful when saving the result to vector formats such as MVG or SVG.</p>
6634
6635<div style="margin: auto;">
6636<h3 class="magick-header"><a id="repage"></a>-repage <var>geometry</var></h3>
6637</div>
6638
6639<p class="magick-description">Adjust the canvas and offset information of the image.</p>
6640
6641<p>This option is like <a href="command-line-options.html#page">-page</a> but acts as an image operator
6642rather than a setting. You can separately set the canvas size or the offset
6643of the image on that canvas by only providing those components. </p>
6644
6645<p>See <a href="command-line-processing.html#geometry">Image Geometry</a> for complete details about the <em class="arg">geometry</em> argument.</p>
6646
6647<p>If a <code>!</code> flag is given the offset given is added to the existing
6648offset to move the image relative to its previous position. This useful for
6649animation sequences. </p>
6650
6651<p>A given a canvas size of zero such as '<code>0x0</code>' forces it to
6652recalculate the canvas size so the image (at its current offset) will appear
6653completely on that canvas (unless it has a negative offset).</p>
6654
6655<p>Use <a href="command-line-options.html#repage">+repage</a> to completely remove/reset the virtual
6656canvas meta-data from the images. </p>
6657
6658<p>The <a href="command-line-options.html#set">-set</a> '<code>page</code>' option can be used to
6659directly assign virtual canvas meta-data. </p>
6660
6661
6662<div style="margin: auto;">
6663 <h3 class="magick-header"><a id="resample"></a>-resample <var>horizontal</var>x<var>vertical</var></h3>
6664</div>
6665
6666<p class="magick-description">Resample image to specified horizontal and vertical resolution.</p>
6667
6668<p>Resize the image so that its rendered size remains the same as the original
6669at the specified target resolution. For example, if a 300 DPI image renders at
66703 inches by 2 inches on a 300 DPI device, when the image has been resampled to
667172 DPI, it will render at 3 inches by 2 inches on a 72 DPI device. Note that
6672only a small number of image formats (e.g. JPEG, PNG, and TIFF) are capable of
6673storing the image resolution. For formats which do not support an image
Cristy594d2772015-11-15 10:47:42 -05006674resolution, the original resolution of the image must be specified via <a
6675href="command-line-options.html#density">-density</a> on the command line prior to specifying the
Cristy882d9f42015-10-29 16:48:39 -04006676resample resolution.</p>
6677
6678<p>Note that Photoshop stores and obtains image resolution from a proprietary
6679embedded profile. If this profile exists in the image, then Photoshop will
6680continue to treat the image using its former resolution, ignoring the image
6681resolution specified in the standard file header.</p>
6682
6683<div style="margin: auto;">
6684 <h3 class="magick-header"><a id="resize"></a>-resize <var>geometry</var></h3>
6685</div>
6686
6687<p class="magick-description">Resize an image.</p>
6688
6689<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
6690ignored, and the <a href="command-line-options.html#gravity">-gravity</a> option has no effect.</p>
6691
6692<p>If the <a href="command-line-options.html#filter">-filter</a> option
Cristy594d2772015-11-15 10:47:42 -05006693or <code>-define filter:option=value</code> precedes the <a
6694href="command-line-options.html#resize">-resize</a> option, the image is resized with the specified
Cristy882d9f42015-10-29 16:48:39 -04006695filter.</p>
6696
6697<p>Many image processing algorithms assume your image is in a linear-light
6698coding. If your image is gamma-corrected, you can remove the nonlinear gamma
6699correction, apply the transform, then restore it like this:</p>
6700
6701<pre>
6702convert portrait.jpg -gamma .45455 -resize 25% -gamma 2.2 \
6703 -quality 92 passport.jpg
6704</pre>
6705
6706<div style="margin: auto;">
6707 <h3 class="magick-header"><a id="respect-parentheses"></a>-respect-parentheses</h3>
6708</div>
6709
6710<p class="magick-description">settings remain in effect until parenthesis boundary.</p>
6711
6712<div style="margin: auto;">
6713 <h3 class="magick-header"><a id="reverse"></a>-reverse</h3>
6714</div>
6715
6716<p class="magick-description">Reverse the order of images in the current image list.</p>
6717
6718
6719<div style="margin: auto;">
6720 <h3 class="magick-header"><a id="roll"></a>-roll {<var>+-</var>}<var>x</var>{<var>+-</var>}<var>y</var></h3>
6721</div>
6722
6723<p class="magick-description">roll an image vertically or horizontally by the amount given.</p>
6724
6725<p>A negative <var>x</var> offset rolls the image right-to-left.
6726A negative <var>y</var> offset rolls the image bottom-to-top.</p>
6727
6728
6729<div style="margin: auto;">
6730 <h3 class="magick-header"><a id="rotate"></a>-rotate <var>degrees</var>{<var>&lt;</var>}{<var>&gt;</var>}</h3>
6731</div>
6732
6733<p class="magick-description">Apply Paeth image rotation (using shear operations) to the image.</p>
6734
6735<p>Use <code>&gt;</code> to rotate the image only if its width exceeds the
6736height. <code>&lt;</code> rotates the image <var>only</var> if its width is less
6737than the height. For example, if you specify <code>-rotate "-90&gt;"</code> and
6738the image size is 480x640, the image is not rotated. However, if the image is
6739640x480, it is rotated by -90 degrees. If you use <code>&gt;</code> or
6740<code>&lt;</code>, enclose it in quotation marks to prevent it from being
6741misinterpreted as a file redirection.</p>
6742
6743<p>Empty triangles in the corners, left over from rotating the image, are
6744filled with the <code>background</code> color. </p>
6745
6746<p>See also the <a href="command-line-options.html#distort">-distort</a> operator and specifically the
6747'<code>ScaleRotateTranslate</code>' distort method. </p>
6748
6749
6750<div style="margin: auto;">
6751 <h3 class="magick-header"><a id="sample"></a>-sample <var>geometry</var></h3>
6752</div>
6753
6754<p class="magick-description">minify / magnify the image with pixel subsampling and pixel replication, respectively.</p>
6755
6756<p>Change the image size simply by directly sampling the pixels original
6757from the image. When magnifying, pixels are replicated in blocks. When
6758minifying, pixels are sub-sampled (i.e., some rows and columns are skipped
6759over). </p>
6760
6761<p>The results are thus equivalent to using <a href="command-line-options.html#resize">-resize</a> with
6762a <a href="command-line-options.html#filter">-filter</a> setting of <code>point</code> (nearest
6763neighbor), though <a href="command-line-options.html#sample">-sample</a> is a lot faster, as it
6764avoids all the filter processing of the image. As such it completely ignores
6765the current <a href="command-line-options.html#filter">-filter</a> setting. </p>
6766
6767<p>The key feature of the <a href="command-line-options.html#sample">-sample</a> is that no new colors
6768will be added to the resulting image, though some colors may disappear. </p>
6769
6770<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
6771ignored, unlike <a href="command-line-options.html#resize">-resize</a>. </p>
6772
6773
6774<p>The actual sampling point is the middle of the sub-region being sampled.
6775As such a single pixel sampling of an image will take the middle pixel, (or
Cristy594d2772015-11-15 10:47:42 -05006776top-left-middle if image has even dimensions). However the <a
6777href="command-line-options.html#define">-define</a> '<code>sample:offset</code>' can be set to modify
Cristy882d9f42015-10-29 16:48:39 -04006778this position some other location within each sub-region being sampled, as
6779a percentage offset.</p>
6780
6781<p>By default this value is '<code>50</code>' for the midpoint, but could be set
6782to '<code>0</code>' for top-left, '<code>100</code>' for bottom-right, or with
6783separate X and Y offsets such as '<code>0x50</code>' for left-middle edge of
6784sampling sub-region.</p>
6785
6786
6787<div style="margin: auto;">
6788 <h3 class="magick-header"><a id="sampling-factor"></a>-sampling-factor <var>horizontal-factor</var>x<var>vertical-factor</var></h3>
6789</div>
6790
6791<p class="magick-description">sampling factors used by JPEG or MPEG-2 encoder and YUV decoder/encoder.</p>
6792
6793<p>This option specifies the sampling factors to be used by the JPEG encoder
6794for chroma downsampling. If this option is omitted, the JPEG library will use
6795its own default values. When reading or writing the YUV format and when
Cristy594d2772015-11-15 10:47:42 -05006796writing the M2V (MPEG-2) format, use <a
6797href="command-line-options.html#sampling-factor">-sampling-factor 2x1</a> or <a
6798href="command-line-options.html#sampling-factor">-sampling-factor 4:2:2</a> to specify the 4:2:2
Cristy882d9f42015-10-29 16:48:39 -04006799downsampling method.</p>
6800
6801<div style="margin: auto;">
6802 <h3 class="magick-header"><a id="scale"></a>-scale <var>geometry</var></h3>
6803</div>
6804
6805<p class="magick-description">minify / magnify the image with pixel block averaging and pixel replication, respectively.</p>
6806
6807<p>Change the image size simply by replacing pixels by averaging pixels
6808together when minifying, or replacing pixels when magnifying. </p>
6809
6810<p>The results are thus equivalent to using <a href="command-line-options.html#resize">-resize</a> with
6811a <a href="command-line-options.html#filter">-filter</a> setting of <code>box</code>. Though it is a lot
6812faster, as it avoids all the filter processing of the image. As such it
6813completely ignores the current <a href="command-line-options.html#filter">-filter</a> setting. </p>
6814
6815<p>If when shrinking (minifying) images the original image is some integer
6816multiple of the new image size, the number of pixels averaged together to
6817produce the new pixel color is the same across the whole image. This is
6818a special case known as 'binning' and is often used as a method of reducing
6819noise in image such as those generated by digital cameras, especially in low
6820light conditions. </p>
6821
6822
6823<div style="margin: auto;">
6824 <h3 class="magick-header"><a id="scene"></a>-scene <var>value</var></h3>
6825</div>
6826
6827<p class="magick-description">set scene number.</p>
6828
6829<p>This option sets the scene number of an image or the first image in an image sequence.</p>
6830
6831<div style="margin: auto;">
6832 <h3 class="magick-header"><a id="screen"></a>-screen</h3>
6833</div>
6834
6835<p class="magick-description">specify the screen to capture.</p>
6836
6837<p>This option indicates that the GetImage request used to obtain the image
6838should be done on the root window, rather than directly on the specified
6839window. In this way, you can obtain pieces of other windows that overlap the
6840specified window, and more importantly, you can capture menus or other popups
6841that are independent windows but appear over the specified window.</p>
6842
6843<div style="margin: auto;">
6844 <h3 class="magick-header"><a id="seed"></a>-seed</h3>
6845</div>
6846
6847<p class="magick-description">seed a new sequence of pseudo-random numbers</p>
6848
6849<div style="margin: auto;">
6850 <h3 class="magick-header"><a id="segment"></a>-segment <var>cluster-threshold</var>x<var>smoothing-threshold</var></h3>
6851</div>
6852
6853<p class="magick-description">segment the colors of an image.</p>
6854
6855<p>Segment an image by analyzing the histograms of the color components and
6856identifying units that are homogeneous with the fuzzy c-means technique. This
6857is part of the ImageMagick color quantization routines. </p>
6858
6859<p>Specify <var>cluster threshold</var> as the number of pixels in
6860each cluster that must exceed the cluster threshold to be considered valid.
6861<var>Smoothing threshold</var> eliminates noise in the second
6862derivative of the histogram. As the value is increased, you can expect
6863a smoother second derivative. The default is 1.5.</p>
6864
6865<p>If the <a href="command-line-options.html#verbose">-verbose</a> setting is defined, a detailed report
6866of the color clusters is returned.</p>
6867
6868
6869<div style="margin: auto;">
Cristy594d2772015-11-15 10:47:42 -05006870 <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 -04006871</div>
6872
6873<p class="magick-description">Selectively blur pixels within a contrast threshold.</p>
6874
6875<p>Blurs those pixels that are less than or equal to the threshold in
6876contrast. The threshold may be expressed as a fraction of <var>QuantumRange</var> or as a percentage.</p>
6877
6878<div style="margin: auto;">
6879 <h3 class="magick-header"><a id="separate"></a>-separate</h3>
6880</div>
6881
6882<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>
6883
6884<div style="margin: auto;">
Cristy769d8892016-01-19 18:11:14 -05006885 <h3 class="magick-header"><a id="sepia-tone"></a>-sepia-tone <var>percent-threshold</var></h3>
Cristy882d9f42015-10-29 16:48:39 -04006886</div>
6887
6888<p class="magick-description">simulate a sepia-toned photo.</p>
6889
6890<p>Specify <var>threshold</var> as the percent threshold of the intensity (0 - 99.9%).</p>
6891
6892<p>This option applies a special effect to the image, similar to the effect
6893achieved 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
6894toning. A threshold of 80% is a good starting point for a reasonable
6895tone.</p>
6896
6897
6898
6899<div style="margin: auto;">
6900 <h3 class="magick-header"><a id="set"></a>-set <var>key value</var></h3>
6901 <h3 class="magick-header">+set <var>key</var></h3>
6902</div>
6903
6904<p class="magick-description">sets image attributes and properties for images in the current image sequence.</p>
6905
6906<p>This will assign (or modify) specific settings attached to all the images
6907in the current image sequence. Using the <a href="command-line-options.html#set">+set</a> form of the
6908option will either remove, or reset that setting to a default state, as
6909appropriate. </p>
6910
6911<p>For example, it will modify specific well known image meta-data
Cristy594d2772015-11-15 10:47:42 -05006912'attributes' such as those normally overridden by: the options <a
6913href="command-line-options.html#delay" >-delay</a>, <a href="command-line-options.html#dispose" >-dispose</a>, and <a
6914href="command-line-options.html#page" >-page</a>, <a href="command-line-options.html#colorspace" >-colorspace</a>; generally
Cristy882d9f42015-10-29 16:48:39 -04006915assigned before the image is read in, by using a <var>key</var> of
6916the same name. </p>
6917
6918<p>If the given <var>key</var> does not match a specific known
6919'attribute ', such as shown above, the setting is stored as a a free form
Cristy594d2772015-11-15 10:47:42 -05006920'property' string. Such settings are listed in <a href="command-line-options.html#verbose"
6921>-verbose</a> information ("<code>info:</code>" output format) as "Properties".
Cristy882d9f42015-10-29 16:48:39 -04006922</p>
6923
6924<p>This includes string 'properties' that are set by and assigned to images
Cristy594d2772015-11-15 10:47:42 -05006925using the options <a href="command-line-options.html#comment" >-comment</a>, <a href="command-line-options.html#label"
6926>-label</a>, <a href="command-line-options.html#caption" >-caption</a>. These options actually assign
6927a global 'artifact' which are automatically assigned (and any <a href="escape.html" >Format Percent
Cristy882d9f42015-10-29 16:48:39 -04006928Escapes</a> expanded) to images as they are read in. For example:</p>
6929
6930<pre>
Cristy594d2772015-11-15 10:47:42 -05006931-> convert rose: -set comment 'Rose is a rose is a rose is a rose' rose.png
Cristy882d9f42015-10-29 16:48:39 -04006932identify -format %c rose.png
6933Rose is a rose is a rose is a rose
6934</pre>
6935
Cristy594d2772015-11-15 10:47:42 -05006936<p>The set value can also make use of <a href="escape.html" >Format and Print Image
Cristy882d9f42015-10-29 16:48:39 -04006937Properties</a> in the defined value. For example:</p>
6938
6939<pre>
Cristy594d2772015-11-15 10:47:42 -05006940-> convert rose: -set origsize '%wx%h' -resize 50% \
Cristy882d9f42015-10-29 16:48:39 -04006941 -format 'Old size = %[origsize] New size = %wx%h' info:
6942Old size = 70x46 New size = 35x23
6943</pre>
6944
6945<p>Other well known 'properties' that are available include:
6946'<code>date:create</code>' and '<code>date:modify</code>' and
6947'<code>signature</code>'. </p>
6948
6949<p>The <a href="command-line-options.html#repage">-repage</a> operator will also allow you to modify
6950the '<code>page</code>' attribute of an image for images already in memory (also
6951see <a href="command-line-options.html#repage">-page</a>). However it is designed to provide a finer
6952control of the sub-parts of this 'attribute'. The <a href="command-line-options.html#set">-set page</a>
6953option will only provide a direct, unmodified assignment of '<code>page</code>'
6954attribute. </p>
6955
6956<p>This option can also associate a colorspace or profile with your image.
6957For example,</p>
6958
6959<pre>
6960convert image.psd -set profile ISOcoated_v2_eci.icc image-icc.psd
6961</pre>
6962
6963<p>Some 'properties' must be defined in a specific way to be used. For
6964example only 'properties' prefixed with "<code>filename:</code>" can be used to
6965modify the output filename of an image. For example</p>
6966
6967<pre>
6968convert rose: -set filename:mysize '%wx%h' 'rose_%[filename:mysize].png'
6969</pre>
6970
6971<p>If the setting value is prefixed with "<code>option:</code>" the setting will
Cristy594d2772015-11-15 10:47:42 -05006972be saved as a global "Artifact" exactly as if it was set using the <a
6973href="command-line-options.html#define" >-define</a> option. As such settings are global in scope, they
Cristy882d9f42015-10-29 16:48:39 -04006974can be used to pass 'attributes' and 'properties' of one specific image,
6975in a way that allows you to use them in a completely different image, even if
6976the original image has long since been modified or destroyed. For example: </p>
6977
6978<pre>
6979convert rose: -set option:rosesize '%wx%h' -delete 0 \
6980 label:'%[rosesize]' label_size_of_rose.gif"
6981</pre>
6982
Cristy594d2772015-11-15 10:47:42 -05006983<p>Note that <a href="escape.html" >Format Percent Escapes</a> will only match
Cristy882d9f42015-10-29 16:48:39 -04006984a 'artifact' if the given <var>key</var> does not match an existing
6985'attribute' or 'property'. </p>
6986
6987<p>You can set the attributes of the image registry by prefixing the value
6988with <code>registry:</code>.</p>
6989
6990<p>The <a href="command-line-options.html#set">-set profile</a> option can also be used to inject
6991previously-formatted ancillary chunks into the output PNG file, using
6992the commandline option as shown below or by setting the profile via a
6993programming interface:</p>
6994
6995<pre>
6996convert in.png -set profile PNG-chunk-x:&lt;filename&gt; out.png
6997</pre>
6998
6999<p>where <var>x</var> is a location flag and
7000<var>filename</var> is a file containing the chunk
7001name in the first 4 bytes, then a colon (":"), followed by the chunk data.
7002This encoder will compute the chunk length and CRC, so those must not
7003be included in the file.</p>
7004
7005<p>"x" can be "b" (before PLTE), "m" (middle, i.e., between PLTE and IDAT),
7006or "e" (end, i.e., after IDAT). If you want to write multiple chunks
7007of the same type, then add a short unique string after the "x" to prevent
7008subsequent profiles from overwriting the preceding ones, e.g.,</p>
7009
7010
7011<pre>
7012convert in.png -set profile PNG-chunk-b01:file01 \
7013 -profile PNG-chunk-b02:file02 out.png
7014</pre>
7015
7016<div style="margin: auto;">
7017 <h3 class="magick-header"><a id="shade"></a>-shade <var>azimuth</var>x<var>elevation</var></h3>
7018</div>
7019
7020<p class="magick-description">shade the image using a distant light source.</p>
7021
7022<p>Specify <var>azimuth</var> and <var>elevation</var> as
7023the position of the light source. Use <a href="command-line-options.html#shade">+shade</a> to return
7024the shading results as a grayscale image.</p>
7025
7026<div style="margin: auto;">
7027 <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>
7028</div>
7029
7030<p class="magick-description">simulate an image shadow.</p>
7031
7032<div style="margin: auto;">
Cristy594d2772015-11-15 10:47:42 -05007033 <h3 class="magick-header"><a
7034id="shared-memory"></a>-shared-memory</h3>
Cristy882d9f42015-10-29 16:48:39 -04007035</div>
7036
7037<p class="magick-description">use shared memory.</p>
7038
7039<p>This option specifies whether the utility should attempt to use shared
7040memory for pixmaps. ImageMagick must be compiled with shared memory support,
7041and the display must support the <var>MIT-SHM</var> extension.
7042Otherwise, this option is ignored. The default is <code>True</code>.</p>
7043
7044<div style="margin: auto;">
Cristy594d2772015-11-15 10:47:42 -05007045 <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 -04007046</div>
7047
7048<p class="magick-description">sharpen the image.</p>
7049
7050<p>Use a Gaussian operator of the given radius and standard deviation (sigma).</p>
7051
7052<div style="margin: auto;">
7053 <h3 class="magick-header"><a id="shave"></a>-shave <var>geometry</var></h3>
7054</div>
7055
7056<p class="magick-description">Shave pixels from the image edges.</p>
7057
7058<p>The <var>size</var> portion of the <var>geometry</var>
7059argument specifies the width of the region to be removed from both sides of
7060the image and the height of the regions to be removed from top and bottom.
7061Offsets are ignored.</p>
7062
7063<p>See <a href="command-line-processing.html#geometry">Image Geometry</a> for complete details about the <em class="arg">geometry</em> argument.</p>
7064
7065<div style="margin: auto;">
7066 <h3 class="magick-header"><a id="shear"></a>-shear <var>Xdegrees</var>[x<var>Ydegrees</var>]</h3>
7067</div>
7068
7069<p class="magick-description">Shear the image along the x-axis and/or y-axis.</p>
7070
7071<p>The shear angles may be positive, negative, or zero. When <var>Ydegrees</var> is omitted it defaults to 0. When both angles are
7072given, the horizontal component of the shear is performed before the vertical
7073component.</p>
7074
7075<p>Shearing slides one edge of an image along the x-axis or y-axis (i.e.,
7076horizontally or vertically, respectively),creating a parallelogram. The amount
7077of each is controlled by the respective shear angle. For horizontal shears,
7078<var>Xdegrees</var> is measured clockwise relative to "up" (the
7079negative 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
7080positive 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>
7081
7082<p>Empty triangles left over from shearing the image are filled with the color
7083defined by the <a href="command-line-options.html#fill">-background</a> option. The color is specified
7084using the format described under the <a href="command-line-options.html#fill">-fill</a> option.</p>
7085
7086<p>The horizontal shear is performed before the vertical part. This is
7087important to note, since horizontal and vertical shears do not
7088<var>commute</var>, i.e., the order matters in a sequence of shears. For
7089example, the following two commands are not equivalent.</p>
7090
7091<pre>
7092convert logo: -shear 20x0 -shear 0x60 logo-sheared.png
7093convert logo: -shear 0x60 -shear 20x0 logo-sheared.png
7094</pre>
7095
7096<p>The first of the two commands above is equivalent to the following, except
7097for the amount of empty space created; the command that follows generates
7098a smaller image, and so is a better choice in terms of time and space.</p>
7099
7100<pre>
7101convert logo: -shear 20x60 logo-sheared.png
7102</pre>
7103
7104<div style="margin: auto;">
7105 <h3 class="magick-header"><a id="sigmoidal-contrast"></a>-sigmoidal-contrast <var>contrast</var>x<var>mid-point</var></h3>
7106</div>
7107
7108<p class="magick-description">increase the contrast without saturating highlights or shadows.</p>
7109
7110<p>Increase the contrast of the image using a sigmoidal transfer function
7111without saturating highlights or shadows. <var>Contrast</var>
7112indicates how much to increase the contrast. For example, 0 is none, 3 is
7113typical and 20 is a lot.
7114</p>
7115
7116<p>The <var>mid-point</var> indicates where the maximum change
7117'slope' in contrast should fall in the resultant image (0 is white; 50% is
7118middle-gray; 100% is black). </p>
7119
7120<p>By default the image contrast is increased, use <var>+sigmoidal-contrast</var> to decrease the contrast.</p>
7121
7122<p>To achieve the equivalent of a sigmoidal brightness change (similar to
7123a gamma adjustment), you would use <var>-sigmoidal-contrast
7124{brightness}x0%</var> to increase brightness and <var>+sigmoidal-contrast {brightness}x0%</var> to decrease brightness.
7125Note the use of '0' fo rthe mid-point of the sigmoidal curve. </p>
7126
7127<p>Using a very high <var>contrast</var> will produce a sort of
7128'smoothed thresholding' of the image. Not as sharp (with high aliasing
7129effects) of a true threshold, but with tapered gray-levels around the threshold
7130<var>mid-point</var>. </p>
7131
7132<div style="margin: auto;">
7133 <h3 class="magick-header"><a id="silent"></a>-silent</h3>
Cristyf650f4f2016-04-01 10:53:07 -04007134
7135
Cristy882d9f42015-10-29 16:48:39 -04007136</div>
7137
Cristyf650f4f2016-04-01 10:53:07 -04007138<p class="magick-description">operate silently. This option is only used
7139by the <a href="import.html">import</a> tool.</p>
Cristy882d9f42015-10-29 16:48:39 -04007140
7141<div style="margin: auto;">
7142 <h3 class="magick-header"><a id="similarity-threshold"></a>-similarity-threshold <var>value</var></h3>
7143</div>
7144
7145<p class="magick-description">minimum RMSE for subimage match.</p>
7146
7147<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>
7148
7149<div style="margin: auto;">
7150 <h3 class="magick-header"><a id="size"></a>-size <var>width</var>[x<var>height</var>][<var>+offset</var>]</h3>
7151</div>
7152
7153<p class="magick-description">set the width and height of the image.</p>
7154
7155<p>Use this option to specify the width and height of raw images whose
7156dimensions are unknown such as <code>GRAY</code>, <code>RGB</code>, or
Cristy594d2772015-11-15 10:47:42 -05007157<code>CMYK</code>. In addition to width and height, use <a
7158href="command-line-options.html#size">-size</a> with an offset to skip any header information in the
Cristy882d9f42015-10-29 16:48:39 -04007159image or tell the number of colors in a <code>MAP</code> image file, (e.g. -size
7160640x512+256).</p>
7161
7162<p>For Photo CD images, choose from these sizes:</p>
7163
7164<pre>
7165192x128
7166384x256
7167768x512
71681536x1024
71693072x2048
7170</pre>
7171
7172<div style="margin: auto;">
Cristy594d2772015-11-15 10:47:42 -05007173 <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 -04007174</div>
7175
7176<p class="magick-description">simulate a pencil sketch.</p>
7177
7178<p>Sketch with the given radius, standard deviation (sigma), and angle. The
7179angle given is the angle toward which the image is sketched. That is the
7180direction people would consider the object is coming from. </p>
7181
7182<div style="margin: auto;">
7183 <h3 class="magick-header"><a id="smush"></a>-smush <var>offset</var></h3>
7184</div>
7185
Cristybc232422016-11-22 07:46:18 -05007186<p class="magick-description">appends an image sequence together ignoring transparency.</p>
7187
7188<p>Smush is a more flexible version of <a href="command-line-options.html#append">-append</a>, joining the images in the sequence top-to-bottom (<a href="command-line-options.html#smush">-smush</a>) or left-to-right (<a href="command-line-options.html#smush">+smush</a>), with a gap between images according to the specified offset.</p>
7189
7190<p>If the offset is negative, images will overlap by that amount.</p>
7191
7192<p><a href="command-line-options.html#smush">-smush</a> respects <a href="command-line-options.html#gravity">-gravity</a>. Any empty space will be filled with the <a href="command-line-options.html#background">-background</a> color.</p>
7193
7194<p>For zero offset and transparent images, the non-transparent parts of the two images will be aligned as close as possible without overlapping.</p>
Cristy882d9f42015-10-29 16:48:39 -04007195
7196<div style="margin: auto;">
7197 <h3 class="magick-header"><a id="snaps"></a>-snaps <var>value</var></h3>
7198</div>
7199
7200<p class="magick-description">Set the number of screen snapshots.</p>
7201
7202<p>Use this option to grab more than one image from the X server screen, to create an animation sequence.</p>
7203
7204<div style="margin: auto;">
Cristy769d8892016-01-19 18:11:14 -05007205 <h3 class="magick-header"><a id="solarize"></a>-solarize <var>percent-threshold</var></h3>
Cristy882d9f42015-10-29 16:48:39 -04007206</div>
7207
7208<p class="magick-description">negate all pixels above the threshold level.</p>
7209
7210<p>Specify <var>factor</var> as the percent threshold of the intensity (0 - 99.9%).</p>
7211
7212<p>This option produces a <var>solarization</var> effect seen when
7213exposing a photographic film to light during the development process.</p>
7214
7215<div style="margin: auto;">
7216 <h3 class="magick-header"><a id="sparse-color"></a>-sparse-color <var>method</var> '<var>x</var>,<var>y</var> <var>color</var> ...'</h3>
7217</div>
7218
7219<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>
7220
7221
7222<dl class="dl-horizontal">
7223 <dt>barycentric</dt>
7224 <dd>three point triangle of color given 3 points.
7225 Giving only 2 points will form a linear gradient between those points.
7226 The gradient generated extends beyond the triangle created by those
7227 3 points. </dd>
7228 <dt>bilinear</dt>
7229 <dd>Like barycentric but for 4 points. Less than 4 points
7230 fall back to barycentric. </dd>
7231 <dt>voronoi</dt>
7232 <dd>Simply map each pixel to the to nearest color point
7233 given. The result are polygonal 'cells' of solid color. </dd>
7234 <dt>manhatten</dt>
7235 <dd>Like voronoi, but resulting polygonal 'cells' are mapped to a fixed coordinate system.</dd>
7236 <dt>shepards</dt>
7237 <dd>Colors points biased on the ratio of inverse distance
7238 squared. Generating spots of color in a sea of the average of
7239 colors. </dd>
7240 <dt>inverse</dt>
7241 <dd>Colors points biased on the ratio of inverse distance.
7242 This generates sharper points of color rather than rounded spots of
7243 '<code>shepards</code>' Generating spots of color in a sea of the
7244 average of colors. </dd>
7245</dl>
7246
7247<p>The points are placed according to the images location on the virtual
Cristy594d2772015-11-15 10:47:42 -05007248canvas (<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 -04007249offset), and do not actually have to exist on the given image, but may be
7250some point beyond the edge of the image. All points are floating point values.
7251</p>
7252
Cristy594d2772015-11-15 10:47:42 -05007253<p>Only the color channels defined by the <a href="command-line-options.html#channel" >-channel</a> are
Cristy882d9f42015-10-29 16:48:39 -04007254modified, which means that by default matte/alpha transparency channel is not
7255effected. Typically transparency channel is turned off either before or after
7256the operation. </p>
7257
7258<p>Of course if some color points are transparent to generate a transparent
7259gradient, then the image also requires transparency enabled to store the
7260values. </p>
7261
7262<p>All the above methods when given a single point of color will replace all
7263the colors in the image with the color given, regardless of the point. This is
7264logical, and provides an alternative technique to recolor an image to some
7265default value. </p>
7266
7267
7268<div style="margin: auto;">
7269 <h3 class="magick-header"><a id="splice"></a>-splice <var>geometry</var></h3>
7270</div>
7271
7272<p class="magick-description">Splice the current background color into the image.</p>
7273
Cristy594d2772015-11-15 10:47:42 -05007274<p>This will add rows and columns of the current <a
7275href="command-line-options.html#background">-background</a> color into the given image according to the
Cristy882d9f42015-10-29 16:48:39 -04007276given <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
7277image into four quadrants, separating them by the inserted rows and columns.
7278</p>
7279
7280<p>If a dimension of geometry is zero no rows or columns will be added for that
Cristy594d2772015-11-15 10:47:42 -05007281dimension. Similarly using a zero offset with the appropriate <a
7282href="command-line-options.html#gravity">-gravity</a> setting will add rows and columns to the edges of
7283the image, padding the image only along that one edge. Edge padding is what <a
7284href="command-line-options.html#splice">-splice</a> is most commonly used for. </p>
Cristy882d9f42015-10-29 16:48:39 -04007285
Cristy594d2772015-11-15 10:47:42 -05007286<p>If the exact same <var>geometry</var> and <a
7287href="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 -04007288added added all splices removed. </p>
7289
7290<div style="margin: auto;">
7291 <h3 class="magick-header"><a id="spread"></a>-spread <var>amount</var></h3>
7292</div>
7293
7294<p class="magick-description">displace image pixels by a random amount.</p>
7295
7296<p>The argument <var>amount</var> defines the size of the
7297neighborhood around each pixel from which to choose a candidate pixel to
7298blend.</p>
7299
7300<p>The lookup is controlled by the <a href="command-line-options.html#interpolate">-interpolate</a> setting.</p>
7301
7302<div style="margin: auto;">
7303 <h3 class="magick-header"><a id="statistic"></a>-statistic <var>type</var> <var>geometry</var></h3>
7304</div>
7305
7306<p class="magick-description">replace each pixel with corresponding statistic from the neighborhood.</p>
7307
7308<p>Choose from these statistic types:</p>
7309<dl class="dl-horizontal">
7310<dt>Gradient</dt><dd>maximum difference (max - min) value in neighborhood</dd>
7311<dt>Maximum</dt><dd>maximum value per channel in neighborhood</dd>
7312<dt>Minimum</dt><dd>minimum value per channel in neighborhood</dd>
7313<dt>Mean</dt><dd>average value per channel in neighborhood</dd>
7314<dt>Median</dt><dd>median value per channel in neighborhood</dd>
7315<dt>Mode</dt><dd>mode (most frequent) value per channel in neighborhood</dd>
7316<dt>Nonpeak</dt><dd>value just before or after the median value per channel in neighborhood</dd>
7317<dt>RMS</dt><dd>root mean square value per channel in neighborhood</dd>
7318<dt>StandardDeviation</dt><dd> standard deviation value per channel in neighborhood</dd>
7319</dl>
7320
7321<div style="margin: auto;">
7322 <h3 class="magick-header"><a id="stegano"></a>-stegano <var>offset</var></h3>
7323</div>
7324
7325<p class="magick-description">hide watermark within an image.</p>
7326
7327<p>Use an offset to start the image hiding some number of pixels from the
7328beginning of the image. Note this offset and the image size. You will need
7329this information to recover the steganographic image (e.g. display -size
7330320x256+35 stegano:image.png).</p>
7331
7332<div style="margin: auto;">
7333 <h3 class="magick-header"><a id="stereo"></a>-stereo <var>+x</var>{<var>+y</var>}</h3>
7334</div>
7335
7336<p class="magick-description">composite two images to create a red / cyan stereo anaglyph.</p>
7337
7338<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>
7339
7340<div style="margin: auto;">
7341 <h3 class="magick-header"><a id="storage-type"></a>-storage-type <var>type</var></h3>
7342</div>
7343
7344<p class="magick-description">pixel storage type. Here are the valid types:</p>
7345
7346<dl class="dl-horizontal">
7347<dt>char</dt><dd>unsigned characters</dd>
7348<dt>double</dt><dd>doubles</dd>
7349<dt>float</dt><dd>floats</dd>
7350<dt>integer</dt><dd>integers</dd>
7351<dt>long</dt><dd>longs</dd>
7352<dt>quantum</dt><dd>pixels in the native depth of your ImageMagick distribution</dd>
7353<dt>short</dt><dd>unsigned shorts</dd>
7354</dl>
7355
7356<p>Float and double types are normalized from 0.0 to 1.0 otherwise the pixels
7357values range from 0 to the maximum value the storage type can support.</p>
7358
7359<div style="margin: auto;">
7360 <h3 class="magick-header"><a id="stretch"></a>-stretch <var>fontStretch</var></h3>
7361</div>
7362
7363<p class="magick-description">Set a type of stretch style for fonts.</p>
7364
7365<p>This setting suggests a type of stretch that ImageMagick should try to
7366apply to the currently selected font family. Select <var>fontStretch</var> from the following.</p>
7367
7368<pre>
7369Any
7370Condensed
7371Expanded
7372ExtraCondensed
7373ExtraExpanded
7374Normal
7375SemiCondensed
7376SemiExpanded
7377UltraCondensed
7378UltraExpanded
7379</pre>
7380
7381<p>To print a complete list of stretch types, use <a href="command-line-options.html#list">-list
7382stretch</a>.</p>
7383
Cristy594d2772015-11-15 10:47:42 -05007384<p>For other settings that affect fonts, see the options <a
7385href="command-line-options.html#font">-font</a>, <a href="command-line-options.html#family">-family</a>, <a
7386href="command-line-options.html#style">-style</a>, and <a href="command-line-options.html#weight">-weight</a>. </p>
Cristy882d9f42015-10-29 16:48:39 -04007387
7388<div style="margin: auto;">
7389 <h3 class="magick-header"><a id="strip"></a>-strip</h3>
7390</div>
7391
Cristy776113a2016-04-29 12:01:19 -04007392<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 -04007393
7394<div style="margin: auto;">
7395 <h3 class="magick-header"><a id="stroke"></a>-stroke <var>color</var></h3>
7396</div>
7397
7398<p class="magick-description">color to use when stroking a graphic primitive.</p>
7399
7400<p>The color is specified using the format described under the <a href="command-line-options.html#fill">-fill</a> option.</p>
7401
7402<p>See <a href="command-line-options.html#draw">-draw</a> for further details.</p>
7403
7404<div style="margin: auto;">
7405 <h3 class="magick-header"><a id="strokewidth"></a>-strokewidth <var>value</var></h3>
7406</div>
7407
7408<p class="magick-description">set the stroke width.</p>
7409
7410<p>See <a href="command-line-options.html#draw">-draw</a> for further details.</p>
7411
7412<div style="margin: auto;">
7413 <h3 class="magick-header"><a id="style"></a>-style <var>fontStyle</var></h3>
7414</div>
7415
7416<p class="magick-description">Set a font style for text.</p>
7417
7418<p>This setting suggests a font style that ImageMagick should try to apply to
7419the currently selected font family. Select <var>fontStyle</var> from
7420the following.</p>
7421
7422<pre>
7423Any
7424Italic
7425Normal
7426Oblique
7427</pre>
7428
Cristy594d2772015-11-15 10:47:42 -05007429<p>For other settings that affect fonts, see the options <a
7430href="command-line-options.html#font">-font</a>, <a href="command-line-options.html#family">-family</a>, <a
7431href="command-line-options.html#stretch">-stretch</a>, and <a href="command-line-options.html#weight">-weight</a>. </p>
Cristy882d9f42015-10-29 16:48:39 -04007432
7433<div style="margin: auto;">
7434 <h3 class="magick-header"><a id="subimage-search"></a>-subimage-search</h3>
7435</div>
7436
7437<p class="magick-description">search for subimage.</p>
7438
7439<p>This option is required to have compare search for the best match location
7440of a small image within a larger image. This search will produce two images
7441(or two frames). The first is the "difference" image and the second will
7442be the "match score" image.</p>
7443
7444<p>The "match-score" image is smaller containing a pixel for ever possible
7445position of the top-left corner of the given sub-image. that is its size will
7446be the size of the larger_image - sub_image + 1. The brightest location in
7447this image is the location s the locate on the best match that is also
7448reported. Note that this may or may not be a perfect match, and the actual
7449brightness will reflect this. Other bright 'peaks' can be used to locate other
7450possible matching locations. </p>
7451
7452<p>Note that the search will try to compare the sub-image at every possible
7453location in the larger image, as such it can be very slow. The smaller the
7454sub-image the faster this search is. </p>
7455
7456
7457<div style="margin: auto;">
7458 <h3 class="magick-header"><a id="swap"></a>-swap <var>index,index</var></h3>
7459</div>
7460
7461<p class="magick-description">Swap the positions of two images in the image sequence.</p>
7462
7463<p>For example, <a href="command-line-options.html#swap">-swap 0,2</a> swaps the first and the third
7464images in the current image sequence. Use <a href="command-line-options.html#swap">+swap</a> to switch
7465the last two images in the sequence.</p>
7466
7467<div style="margin: auto;">
7468 <h3 class="magick-header"><a id="swirl"></a>-swirl <var>degrees</var></h3>
7469</div>
7470
7471<p class="magick-description">swirl image pixels about the center.</p>
7472
7473<p><var>Degrees</var> defines the tightness of the swirl.</p>
7474
7475<div style="margin: auto;">
7476 <h3 class="magick-header"><a id="synchronize"></a>-synchronize</h3>
7477</div>
7478
7479<p class="magick-description">synchronize image to storage device.</p>
7480
7481<p>Set to "true" to ensure all image data is fully flushed and synchronized
7482to disk. There is a performance penalty, but the benefits include ensuring a
7483valid image file in the event of a system crash and early reporting if there
7484is not enough disk space for the image pixel cache.</p>
7485
7486<div style="margin: auto;">
7487 <h3 class="magick-header"><a id="taint"></a>-taint</h3>
7488</div>
7489
7490<p class="magick-description">Mark the image as modified.</p>
7491
7492<div style="margin: auto;">
7493 <h3 class="magick-header"><a id="text-font"></a>-text-font <var>name</var></h3>
7494</div>
7495
7496<p class="magick-description">font for writing fixed-width text.</p>
7497
7498<p>Specifies the name of the preferred font to use in fixed (typewriter style)
7499formatted text. The default is 14 point <var>Courier</var>.</p>
7500
7501<p>You can tag a font to specify whether it is a PostScript, TrueType, or
7502OPTION1 font. For example, <code>Courier.ttf</code> is a TrueType font and
7503<code>x:fixed</code> is OPTION1.</p>
7504
7505<div style="margin: auto;">
7506 <h3 class="magick-header"><a id="texture"></a>-texture <var>filename</var></h3>
7507</div>
7508
7509<p class="magick-description">name of texture to tile onto the image background.</p>
7510
7511<div style="margin: auto;">
7512 <h3 class="magick-header"><a id="threshold"></a>-threshold <var>value</var>{<var>%</var>}</h3>
7513</div>
7514
7515<!-- {<var>green,blue,opacity</var>}
7516<p>If the green or blue value is omitted, these channels use the same value as
7517the first one provided. If all three color values are the same, the result is
7518a bi-level image. If the opacity threshold is omitted, OpaqueOpacity is used
7519and any partially transparent pixel becomes fully transparent.</p>
7520-->
7521
7522<p class="magick-description">Apply simultaneous black/white threshold to the image.</p>
7523
Cristy594d2772015-11-15 10:47:42 -05007524<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 -04007525maximum channel value, while all other values are assigned the minimum.</p>
7526
7527<p> The threshold value can be given as a percentage or as an absolute integer
7528value corresponding to the desired channel value. When given as an integer,
7529the minimum attainable value is 0 (corresponding to black when all channels
7530are affected), but the maximum value (corresponding to white) is that of the
7531<code>quantum depth</code> of the particular build of ImageMagick, and is
7532therefore dependent on the installation. For that reason, a reasonable
7533recommendation for most applications is to specify the threshold values as
7534a percentage. </p>
7535
7536<p> The following would force pixels with red values above 50% to have 100%
7537red values, while those at or below 50% red would be set to 0 in the red
7538channel. The green, blue, and alpha channels (if present) would be unchanged.
7539</p>
7540
7541<pre>
7542convert in.png -channel red -threshold 50% out.png
7543</pre>
7544
7545<p>As (possibly) impractical but instructive examples, the following would
7546generate an all-black and an all-white image with the same dimensions as the
7547input image.</p>
7548
7549
7550<pre>
7551convert in.png -threshold 100% black.png
7552convert in.png -threshold -1 white.png
7553</pre>
7554
7555<p>Note that the values of the transparency channel is treated as 'matte'
7556values (0 is opaque) and not as 'alpha' values (0 is transparent).</p>
7557
Cristy594d2772015-11-15 10:47:42 -05007558<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 -04007559</p>
7560
7561<div style="margin: auto;">
7562 <h3 class="magick-header"><a id="thumbnail"></a>-thumbnail <var>geometry</var></h3>
7563</div>
7564
7565<p class="magick-description">Create a thumbnail of the image.</p>
7566
7567<p>This is similar to <a href="command-line-options.html#resize">-resize</a>, except it is optimized
7568for speed and any image profile, other than a color profile, is removed to
Cristy594d2772015-11-15 10:47:42 -05007569reduce the thumbnail size. To strip the color profiles as well, add <a
7570href="command-line-options.html#strip">-strip</a> just before of after this option.</p>
Cristy882d9f42015-10-29 16:48:39 -04007571
7572<p>See <a href="command-line-processing.html#geometry">Image Geometry</a> for complete details about the <em class="arg">geometry</em> argument.</p>
7573
7574<div style="margin: auto;">
7575 <h3 class="magick-header"><a id="tile"></a>-tile <var>filename</var></h3>
7576</div>
7577
7578<p class="magick-description">Set the tile image used for filling a subsequent graphic primitive.</p>
7579
7580<div style="margin: auto;">
7581 <h3 class="magick-header">-tile <var>geometry</var></h3>
7582</div>
7583
7584<p class="magick-description">Specify the layout of images.</p>
7585
7586<p>See <a href="command-line-processing.html#geometry">Image Geometry</a> for complete details about the <em class="arg">geometry</em> argument.</p>
7587
7588<div style="margin: auto;">
7589 <h3 class="magick-header">-tile</h3>
7590</div>
7591
7592<p class="magick-description">Specifies that a subsequent composite operation is repeated across and down image.</p>
7593
7594<div style="margin: auto;">
7595 <h3 class="magick-header"><a id="tile-offset"></a>-tile-offset {<var>+-</var>}<var>x</var>{<var>+-</var>}<var>y</var></h3>
7596</div>
7597
7598<p class="magick-description">Specify the offset for tile images, relative to the background image it is tiled on.</p>
7599
Cristy594d2772015-11-15 10:47:42 -05007600<p>This should be set before the tiling image is set by <a href="command-line-options.html#tile"
7601>-tile</a> or <a href="command-line-options.html#texture" >-texture</a>, or directly applied for
Cristy882d9f42015-10-29 16:48:39 -04007602creating a tiled canvas using <code>TILE:</code> or <code>PATTERN:</code> input
7603formats. </p>
7604
Cristy594d2772015-11-15 10:47:42 -05007605<p>Internally ImageMagick does a <a href="command-line-options.html#roll" >-roll</a> of the tile image
Cristy882d9f42015-10-29 16:48:39 -04007606by the arguments given when the tile image is set. </p>
7607
7608<div style="margin: auto;">
7609 <h3 class="magick-header"><a id="tint"></a>-tint <var>value</var></h3>
7610</div>
7611
7612<p class="magick-description">Tint the image with the fill color.</p>
7613
7614<p>Tint the image with the fill color.</p>
7615
7616<p>Specify the amount of tinting as a percentage. Pure colors like black,
7617white red, yellow, will not be affected by -tint. Only mid-range colors such
7618as the various shades of grey.</p>
7619
7620<div style="margin: auto;">
7621 <h3 class="magick-header"><a id="title"></a>-title <var>string</var></h3>
7622</div>
7623
7624<p class="magick-description">Assign a title to displayed image.", "animate", "display", "montage</p>
7625
7626<p>Use this option to assign a specific title to the image. This assigned to
7627the image window and is typically displayed in the window title bar.
7628Optionally you can include the image filename, type, width, height, Exif data,
7629or other image attribute by embedding special format characters described
7630under the <a href="command-line-options.html#format">-format</a> option.</p>
7631
7632<p>For example,</p>
7633
7634<pre>
7635-title "%m:%f %wx%h"
7636</pre>
7637
7638<p>produces an image title of <code>MIFF:bird.miff 512x480</code> for an image
7639titled <code>bird.miff</code> and whose width is 512 and height is 480.</p>
7640
7641
7642<div style="margin: auto;">
7643 <h3 class="magick-header"><a id="transform"></a>-transform</h3>
7644</div>
7645
7646<p class="magick-description">transform the image.</p>
7647
7648<p>This option applies the transformation matrix from a previous <a href="command-line-options.html#affine">-affine</a> option.</p>
7649
7650<pre>
7651convert -affine 2,2,-2,2,0,0 -transform bird.ppm bird.jpg
7652</pre>
7653
7654
Cristy594d2772015-11-15 10:47:42 -05007655<p>This operator has been now been superseded by the <a
7656href="command-line-options.html#distort">-distort</a> '<code>AffineProjection</code>' method. </p>
Cristy882d9f42015-10-29 16:48:39 -04007657
7658
7659<div style="margin: auto;">
7660 <h3 class="magick-header"><a id="transparent"></a>-transparent <var>color</var></h3>
7661</div>
7662
7663<p class="magick-description">Make this color transparent within the image.</p>
7664
7665<p>The <var>color</var> argument is defined using the format
Cristy594d2772015-11-15 10:47:42 -05007666described under the <a href="command-line-options.html#fill">-fill</a> option. The <a href="command-line-options.html#fuzz"
7667>-fuzz</a> setting can be used to match and replace colors similar to the one
Cristy882d9f42015-10-29 16:48:39 -04007668given. </p>
7669
Cristy594d2772015-11-15 10:47:42 -05007670<p>Use <a href="command-line-options.html#transparent" >+transparent</a> to invert the pixels matched.
Cristy882d9f42015-10-29 16:48:39 -04007671that is make all non-matching colors transparent. </p>
7672
Cristy594d2772015-11-15 10:47:42 -05007673<p>The <a href="command-line-options.html#opaque">-opaque</a> operator is exactly the same as <a
7674href="command-line-options.html#transparent" >-transparent</a> but replaces the matching color with the
Cristy882d9f42015-10-29 16:48:39 -04007675current <a href="command-line-options.html#fill">-fill</a> color setting, rather than transparent.
Cristy594d2772015-11-15 10:47:42 -05007676However the <a href="command-line-options.html#transparent" >-transparent</a> operator also ensures
7677that the image has an alpha channel enabled, as per "<code><a href="command-line-options.html#alpha"
7678>-alpha</a> set</code>", and does not require you to modify the <a
7679href="command-line-options.html#channel">-channel</a> to enable alpha channel handling. </p>
Cristy882d9f42015-10-29 16:48:39 -04007680
7681<p>Note that this does not define the color as being the 'transparency color'
Cristy594d2772015-11-15 10:47:42 -05007682used for color-mapped image formats, such as GIF. For that use <a
7683href="command-line-options.html#transparent-color" >-transparent-color</a> </p>
Cristy882d9f42015-10-29 16:48:39 -04007684
7685
7686<div style="margin: auto;">
7687 <h3 class="magick-header"><a id="transparent-color"></a>-transparent-color <var>color</var></h3>
7688</div>
7689
7690<p class="magick-description">Set the transparent color.</p>
7691
7692<p>Sometimes this is used for saving to image formats such as
7693GIF and PNG8 which uses this color to represent boolean transparency. This
7694does not make a color transparent, it only defines what color the transparent
Cristy594d2772015-11-15 10:47:42 -05007695color is in the color palette of the saved image. Use <a
7696href="command-line-options.html#transparent">-transparent</a> to make an opaque color transparent.</p>
Cristy882d9f42015-10-29 16:48:39 -04007697
7698<p>This option allows you to have both an opaque visible color, as well as a
7699transparent color of the same color value without conflict. That is, you can
7700use the same color for both the transparent and opaque color areas within an
7701image. This, in turn, frees to you to select a transparent color that is
7702appropriate when an image is displayed by an application that does not handle a
7703transparent color index, while allowing ImageMagick to correctly handle images of this
7704type. </p>
7705
7706<p>The default transparent color is <code>#00000000</code>, which is fully transparent black.</p>
7707
7708<div style="margin: auto;">
7709 <h3 class="magick-header"><a id="transpose"></a>-transpose</h3>
7710</div>
7711
7712<p class="magick-description">Mirror the image along the top-left to bottom-right diagonal.</p>
7713
7714<p> This option mathematically transposes the pixel array. It is equivalent to the sequence <code>-flip -rotate 90</code>.
7715</p>
7716
7717<div style="margin: auto;">
7718 <h3 class="magick-header"><a id="transverse"></a>-transverse</h3>
7719</div>
7720
7721<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>
7722
7723
7724<div style="margin: auto;">
7725 <h3 class="magick-header"><a id="treedepth"></a>-treedepth <var>value</var></h3>
7726</div>
7727
7728<p class="magick-description">tree depth for the color reduction algorithm.</p>
7729
7730<p>Normally, this integer value is zero or one. A value of zero or one causes
7731the use of an optimal tree depth for the color reduction algorithm.</p>
7732
7733<p>An optimal depth generally allows the best representation of the source
7734image with the fastest computational speed and the least amount of memory.
7735However, the default depth is inappropriate for some images. To assure the
7736best representation, try values between 2 and 8 for this parameter. Refer to
Cristy6549abb2016-11-10 08:25:55 -05007737the <a href="http://www.imagemagick.org/www/quantize.html"
Cristy594d2772015-11-15 10:47:42 -05007738>color reduction algorithm</a> for more details.</p>
Cristy882d9f42015-10-29 16:48:39 -04007739
7740<p>The <a href="command-line-options.html#colors">-colors</a> or <a href="command-line-options.html#monochrome">-monochrome</a>
7741option, or writing to an image format which requires color reduction, is
7742required for this option to take effect.</p>
7743
7744<div style="margin: auto;">
7745 <h3 class="magick-header"><a id="trim"></a>-trim</h3>
7746</div>
7747
7748<p class="magick-description">trim an image.</p>
7749
7750<p>This option removes any edges that are exactly the same color as the corner
7751pixels. Use <a href="command-line-options.html#fuzz">-fuzz</a> to make <a href="command-line-options.html#trim">-trim</a> remove
7752edges that are nearly the same color as the corner pixels.</p>
7753
7754<p>The page or virtual canvas information of the image is preserved allowing
7755you to extract the result of the <a href="command-line-options.html#trim">-trim</a> operation from the
7756image. Use a <a href="command-line-options.html#repage">+repage</a> to remove the virtual canvas page
7757information if it is unwanted.</p>
7758
7759<p>If the trimmed image 'disappears' an warning is produced, and a special
7760single pixel transparent 'missed' image is returned, in the same way as when a
7761<a href="command-line-options.html#crop">-crop</a> operation 'misses' the image proper. </p>
7762
7763
7764<div style="margin: auto;">
7765 <h3 class="magick-header"><a id="type"></a>-type <var>type</var></h3>
7766</div>
7767
7768<p class="magick-description">the image type.</p> <p>Choose from: <code>Bilevel</code>,
7769<code>Grayscale</code>, <code>GrayscaleMatte</code>, <code>Palette</code>,
7770<code>PaletteMatte</code>, <code>TrueColor</code>, <code>TrueColorMatte</code>,
7771<code>ColorSeparation</code>, or <code>ColorSeparationMatte</code>.</p>
7772
7773<p>Normally, when a format supports different subformats such as grayscale and
Cristy594d2772015-11-15 10:47:42 -05007774truecolor, the encoder will try to choose an efficient subformat. The <a
7775href="command-line-options.html#type">-type</a> option can be used to override this behavior. For
Cristy882d9f42015-10-29 16:48:39 -04007776example, to prevent a JPEG from being written in grayscale format even though
7777only gray pixels are present, use.</p>
7778
7779<pre>
7780convert bird.png -type TrueColor bird.jpg
7781</pre>
7782
7783<p>Similarly, use <a href="command-line-options.html#type">-type TrueColorMatte</a> to force the
7784encoder to write an alpha channel even though the image is opaque, if the
7785output format supports transparency.</p>
7786
7787<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>
7788
7789<div style="margin: auto;">
7790 <h3 class="magick-header"><a id="undercolor"></a>-undercolor <var>color</var></h3>
7791</div>
7792
7793<p class="magick-description">set the color of the annotation bounding box.</p>
7794
7795<p>The color is specified using the format described under the <a href="command-line-options.html#fill">-fill</a> option.</p>
7796
7797<p>See <a href="command-line-options.html#draw">-draw</a> for further details.</p>
7798
7799
7800<div style="margin: auto;">
7801 <h3 class="magick-header"><a id="update"></a>-update <var>seconds</var></h3>
7802</div>
7803
7804<p class="magick-description">detect when image file is modified and redisplay.</p>
7805
7806<p>Suppose that while you are displaying an image the file that is currently
7807displayed is over-written. <code>display</code> will automagically detect that
7808the input file has been changed and update the displayed image
7809accordingly.</p>
7810
7811
7812<div style="margin: auto;">
7813 <h3 class="magick-header"><a id="unique-colors"></a>-unique-colors</h3>
7814</div>
7815
7816<p class="magick-description">discard all but one of any pixel color.</p>
7817
7818
7819<div style="margin: auto;">
7820 <h3 class="magick-header"><a id="units"></a>-units <var>type</var></h3>
7821</div>
7822
7823<p class="magick-description">the units of image resolution.</p>
7824
7825<p>Choose from: <code>Undefined</code>, <code>PixelsPerInch</code>, or
7826<code>PixelsPerCentimeter</code>. This option is normally used in conjunction
7827with the <a href="command-line-options.html#density">-density</a> option.</p>
7828
7829
7830<div style="margin: auto;">
Cristy594d2772015-11-15 10:47:42 -05007831 <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 -04007832</div>
7833
7834<p class="magick-description">sharpen the image with an unsharp mask operator.</p>
7835
7836<p>The <a href="command-line-options.html#unsharp">-unsharp</a> option sharpens an image. The image is
7837convolved with a Gaussian operator of the given radius and standard deviation
7838(sigma). For reasonable results, radius should be larger than sigma. Use
7839a radius of 0 to have the method select a suitable radius.</p>
7840
7841<p>The parameters are:</p>
7842
7843<dl class="dl-horizontal">
7844<dt>radius</dt>
7845<dd>The radius of the Gaussian, in pixels, not counting the center pixel (default 0).</dd>
7846<dt>sigma</dt>
7847<dd>The standard deviation of the Gaussian, in pixels (default 1.0).</dd>
7848<dt>gain</dt>
7849<dd>The fraction of the difference between the original and the blur image that is added back into the original (default 1.0).</dd>
7850<dt>threshold</dt>
7851<dd>The threshold, as a fraction of <var>QuantumRange</var>, needed to apply the difference amount (default 0.05).</dd>
7852</dl>
7853
7854<div style="margin: auto;">
7855 <h3 class="magick-header"><a id="verbose"></a>-verbose</h3>
7856</div>
7857
7858<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>
7859
7860
7861<div style="margin: auto;">
7862 <h3 class="magick-header"><a id="version"></a>-version</h3>
7863</div>
7864
7865<p class="magick-description">print ImageMagick version string and exit.</p>
7866
7867
7868<div style="margin: auto;">
7869 <h3 class="magick-header"><a id="view"></a>-view <var>string</var></h3>
7870</div>
7871
7872<p class="magick-description">FlashPix viewing parameters.</p>
7873
7874
7875<div style="margin: auto;">
7876 <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>
7877</div>
7878
7879<p class="magick-description">soften the edges of the image in vignette style.</p>
7880
7881<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>
7882
7883<div style="margin: auto;">
7884 <h3 class="magick-header"><a id="virtual-pixel"></a>-virtual-pixel <var>method</var></h3>
7885</div>
7886
7887<p class="magick-description">Specify contents of <var>virtual pixels</var>.</p>
7888
7889<p>This option defines what color source should be used if and when a color
7890lookup completely 'misses' the source image. The color(s) that appear to
7891surround the source image. Generally this color is derived from the source
7892image, but could also be set to a specify background color. </p>
7893
7894<p>Choose from these methods:</p>
7895
7896<dl class="dl-horizontal">
7897<dt>background</dt><dd>the area surrounding the image is the background color</dd>
7898<dt>black</dt><dd>the area surrounding the image is black</dd>
7899<dt>checker-tile</dt><dd>alternate squares with image and background color</dd>
7900<dt>dither</dt><dd>non-random 32x32 dithered pattern</dd>
7901<dt>edge</dt><dd>extend the edge pixel toward infinity</dd>
7902<dt>gray</dt><dd>the area surrounding the image is gray</dd>
7903<dt>horizontal-tile</dt><dd>horizontally tile the image, background color above/below</dd>
7904<dt>horizontal-tile-edge</dt><dd>horizontally tile the image and replicate the side edge pixels</dd>
7905<dt>mirror</dt><dd>mirror tile the image</dd>
7906<dt>random</dt><dd>choose a random pixel from the image</dd>
7907<dt>tile</dt><dd>tile the image (default)</dd>
7908<dt>transparent</dt><dd>the area surrounding the image is transparent blackness</dd>
7909<dt>vertical-tile</dt><dd>vertically tile the image, sides are background color</dd>
7910<dt>vertical-tile-edge</dt><dd>vertically tile the image and replicate the side edge pixels</dd>
7911<dt>white</dt><dd>the area surrounding the image is white</dd>
7912</dl>
7913
7914<p>The default value is "edge".</p>
7915
Cristy594d2772015-11-15 10:47:42 -05007916<p>This most important for distortion operators such as <a href="command-line-options.html#distort"
7917>-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 -04007918However it also effects operations that may access pixels just outside the
Cristy594d2772015-11-15 10:47:42 -05007919image proper, such as <a href="command-line-options.html#convolve">-convolve</a>, <a
7920href="command-line-options.html#blur">-blur</a>, and <a href="command-line-options.html#sharpen">-sharpen</a>. </p>
Cristy882d9f42015-10-29 16:48:39 -04007921
Cristy594d2772015-11-15 10:47:42 -05007922<p>To print a complete list of virtual pixel types, use the <a
7923href="command-line-options.html#list">-list virtual-pixel</a> option.</p>
Cristy882d9f42015-10-29 16:48:39 -04007924
7925
7926<div style="margin: auto;">
7927 <h3 class="magick-header"><a id="visual"></a>-visual <var>type</var></h3>
7928</div>
7929
7930<p class="magick-description">Animate images using this X visual type.", 'animate', 'display'</p>
7931
7932<p>Choose from these visual classes:</p>
7933
7934<pre>
7935StaticGray TrueColor
7936GrayScale DirectColor
7937StaticColor default
7938PseudoColor visual id
7939</pre>
7940
7941<p>The X server must support the visual you choose, otherwise an error occurs.
7942If a visual is not specified, the visual class that can display the most
7943simultaneous colors on the default screen is chosen.</p>
7944
7945
7946<div style="margin: auto;">
7947 <h3 class="magick-header"><a id="watermark"></a>-watermark <var>brightness</var>x<var>saturation</var></h3>
7948</div>
7949
7950<p class="magick-description">Watermark an image using the given percentages of brightness and saturation.</p>
7951
7952<p>Take a grayscale image (with alpha mask) and modify the destination image's
7953brightness according to watermark image's grayscale value and the
7954<var>brightness</var> percentage. The destinations color saturation
7955attribute is just direct modified by the <var>saturation</var>
7956percentage, which defaults to 100 percent (no color change). </p>
7957
7958
7959<div style="margin: auto;">
Cristy594d2772015-11-15 10:47:42 -05007960 <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 -04007961</div>
7962
7963<p class="magick-description">Shear the columns of an image into a sine wave.</p>
7964
Cristye09ed312016-03-06 08:07:39 -05007965<div style="margin: auto;">
7966 <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>
7967</div>
7968
7969<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 -04007970
7971<div style="margin: auto;">
7972 <h3 class="magick-header"><a id="weight"></a>-weight <var>fontWeight</var></h3>
7973</div>
7974
7975<p class="magick-description">Set a font weight for text.</p>
7976
7977<p>This setting suggests a font weight that ImageMagick should try to apply to
7978the currently selected font family. Use a positive integer for
7979<var>fontWeight</var> or select from the following.</p>
7980
7981<dl class="dl-horizontal">
7982<dt>Thin </dt>
7983<dd>Same as <var>fontWeight</var> = 100.</dd>
7984<dt>ExtraLight </dt>
7985<dd>Same as <var>fontWeight</var> = 200.</dd>
7986<dt>Light </dt>
7987<dd>Same as <var>fontWeight</var> = 300.</dd>
7988<dt>Normal </dt>
7989<dd>Same as <var>fontWeight</var> = 400.</dd>
7990<dt>Medium </dt>
7991<dd>Same as <var>fontWeight</var> = 500.</dd>
7992<dt>DemiBold </dt>
7993<dd>Same as <var>fontWeight</var> = 600.</dd>
7994<dt>Bold </dt>
7995<dd>Same as <var>fontWeight</var> = 700.</dd>
7996<dt>ExtraBold </dt>
7997<dd>Same as <var>fontWeight</var> = 800.</dd>
7998<dt>Heavy </dt>
7999<dd>Same as <var>fontWeight</var> = 900.</dd>
8000</dl>
Cristy594d2772015-11-15 10:47:42 -05008001<br/>
Cristy882d9f42015-10-29 16:48:39 -04008002
8003<p>To print a complete list of weight types, use <a href="command-line-options.html#list">-list weight</a>.</p>
8004
Cristy594d2772015-11-15 10:47:42 -05008005<p>For other settings that affect fonts, see the options <a
8006href="command-line-options.html#font">-font</a>, <a href="command-line-options.html#family">-family</a>, <a
8007href="command-line-options.html#stretch">-stretch</a>, and <a href="command-line-options.html#style">-style</a>. </p>
Cristy882d9f42015-10-29 16:48:39 -04008008
8009<div style="margin: auto;">
8010 <h3 class="magick-header"><a id="white-point"></a>-white-point <var>x,y</var></h3>
8011</div>
8012
8013<p class="magick-description">chromaticity white point.</p>
8014
8015<div style="margin: auto;">
8016 <h3 class="magick-header"><a id="white-threshold"></a>-white-threshold <var>value</var>{<var>%</var>}</h3>
8017</div>
8018
8019<p class="magick-description">Force to white all pixels above the threshold while leaving all pixels at or below the threshold unchanged.</p>
8020
8021<p> The threshold value can be given as a percentage or as an absolute integer
8022value within [0, <var>QuantumRange</var>] corresponding to the
Cristy594d2772015-11-15 10:47:42 -05008023desired <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 -04008024
8025<div style="margin: auto;">
8026 <h3 class="magick-header"><a id="window"></a>-window <var>id</var></h3>
8027</div>
8028
8029<p class="magick-description">Make the image the background of a window.", 'animate', 'display'</p>
8030
8031<p><var>id</var> can be a window id or name. Specify <code>root</code>
8032to select X's root window as the target window.</p>
8033
8034<p>By default the image is tiled onto the background of the target window. If
8035<code>backdrop</code> or <a href="command-line-options.html#geometry">-resize</a> are specified, the
8036image is surrounded by the background color. Refer to <code>X RESOURCES</code>
8037for details.</p>
8038
8039<p>The image will not display on the root window if the image has more unique
Cristy594d2772015-11-15 10:47:42 -05008040colors than the target window colormap allows. Use <a
8041href="command-line-options.html#colors">-colors</a> to reduce the number of colors.</p>
Cristy882d9f42015-10-29 16:48:39 -04008042
8043<div style="margin: auto;">
8044 <h3 class="magick-header"><a id="window-group"></a>-window-group</h3>
8045</div>
8046
8047<p class="magick-description">specify the window group.</p>
8048
8049<div style="margin: auto;">
8050 <h3 class="magick-header"><a id="write"></a>-write <var>filename</var></h3>
8051</div>
8052
8053<p class="magick-description">write an image sequence.</p>
8054
8055<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>
8056
8057<p>Use <a href="command-line-options.html#compress">-compress</a> to specify the type of image compression.</p>
Cristye0779712016-07-30 17:25:22 -04008058
8059<div style="margin: auto;">
8060 <h3 class="magick-header"><a id="write-mask"></a>-write-mask <var>filename</var></h3>
8061</div>
8062
8063<p class="magick-description">Prevent updates to image pixels specified by the mask.</p>
8064
8065<p>This the same as using a mask used for composite masking operations, with
8066grayscale values causing blended updates of the image the mask is attached to.
8067</p>
8068
8069<p>Use <a href="command-line-options.html#write-mask">+write-mask</a> to remove the mask from images.</p>
8070
8071<p>Also see <a href="command-line-options.html#clip-mask">-clip-mask</a> which work in the same way,
8072but with strict boolean masking. </p>
Cristy882d9f42015-10-29 16:48:39 -04008073</div>
8074</div>
8075
8076
Cristye93be682015-11-26 09:07:51 -05008077
Cristy882d9f42015-10-29 16:48:39 -04008078 <footer class="magick-footer">
cristy29f2c972015-07-28 13:37:46 +00008079 <p><a href="support.html">Donate</a>
8080 <a href="sitemap.html">Sitemap</a>
cristyd2432012015-05-04 23:15:15 +00008081 <a href="links.html">Related</a>
Cristye0779712016-07-30 17:25:22 -04008082 <a href="security-policy.html">Security</a>
cristy29f2c972015-07-28 13:37:46 +00008083 <a href="architecture.html">Architecture</a>
cristyd2432012015-05-04 23:15:15 +00008084</p>
8085 <p><a href="command-line-options.html#">Back to top</a>
cristyea2793e2015-05-31 16:52:26 +00008086 <a href="http://pgp.mit.edu:11371/pks/lookup?op=get&amp;search=0x89AB63D48277377A">Public Key</a>
Cristy6549abb2016-11-10 08:25:55 -05008087 <a href="https://www.imagemagick.org/script/contact.php">Contact Us</a></p>
Cristyfe36f992016-12-29 20:24:13 -05008088 <p><small>© 1999-2017 ImageMagick Studio LLC</small></p>
cristyd2432012015-05-04 23:15:15 +00008089 </footer>
8090</div><!-- /.container -->
8091
Cristyb7f455a2017-03-03 19:30:34 -05008092 <script src="https://localhost/ajax/libs/jquery/1.12.4/jquery.min.js"></script>
Cristy1f1f3a02016-06-01 07:25:42 -04008093 <script src="../js/magick.html"></script>
cristyd2432012015-05-04 23:15:15 +00008094</div>
cristyad41c0c2012-10-31 00:49:28 +00008095</body>
cristy5a367e42015-05-05 12:39:18 +00008096</html>
Cristyf41bcd12017-03-28 05:59:57 -04008097<!-- Magick Cache 26th March 2017 15:32 -->