blob: b145c78d09098c8e7fac15019a43820f87f2ac9a [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"/>
Cristy912a9222016-06-17 15:37:28 -040024 <meta name="copyright" content="Copyright (c) 1999-2016 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" />
Cristy6549abb2016-11-10 08:25:55 -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>
cristyea2793e2015-05-31 16:52:26 +000048 <a class="magick-nav-item " href="binary-releases.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>
52 <a class="magick-nav-item " href="api.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">
Cristye0779712016-07-30 17:25:22 -040060<p class="text-center"><a href="command-line-options.html#adaptive-blur">&#x2011;adaptive&#x2011;blur</a><a href="command-line-options.html#adaptive-resize">&#x2011;adaptive&#x2011;resize</a><a href="command-line-options.html#adaptive-sharpen">&#x2011;adaptive&#x2011;sharpen</a><a href="command-line-options.html#adjoin">&#x2011;adjoin</a><a href="command-line-options.html#affine">&#x2011;affine</a><a href="command-line-options.html#alpha">&#x2011;alpha</a><a href="command-line-options.html#alpha-color">&#x2011;alpha&#x2011;color</a><a href="command-line-options.html#annotate">&#x2011;annotate</a><a href="command-line-options.html#antialias">&#x2011;antialias</a><a href="command-line-options.html#append">&#x2011;append</a><a href="command-line-options.html#attenuate">&#x2011;attenuate</a><a href="command-line-options.html#authenticate">&#x2011;authenticate</a><a href="command-line-options.html#auto-gamma">&#x2011;auto&#x2011;gamma</a><a href="command-line-options.html#auto-level">&#x2011;auto&#x2011;level</a><a href="command-line-options.html#auto-orient">&#x2011;auto&#x2011;orient</a><a href="command-line-options.html#backdrop">&#x2011;backdrop</a><a href="command-line-options.html#background">&#x2011;background</a><a href="command-line-options.html#bench">&#x2011;bench</a><a href="command-line-options.html#bias">&#x2011;bias</a><a href="command-line-options.html#black-point-compensation">&#x2011;black&#x2011;point&#x2011;compensation</a><a href="command-line-options.html#black-threshold">&#x2011;black&#x2011;threshold</a><a href="command-line-options.html#blend">&#x2011;blend</a><a href="command-line-options.html#blue-primary">&#x2011;blue&#x2011;primary</a><a href="command-line-options.html#blue-shift">&#x2011;blue&#x2011;shift</a><a href="command-line-options.html#blur">&#x2011;blur</a><a href="command-line-options.html#border">&#x2011;border</a><a href="command-line-options.html#bordercolor">&#x2011;bordercolor</a><a href="command-line-options.html#borderwidth">&#x2011;borderwidth</a><a href="command-line-options.html#brightness-contrast">&#x2011;brightness&#x2011;contrast</a><a href="command-line-options.html#cache">&#x2011;cache</a><a href="command-line-options.html#canny">&#x2011;canny</a><a href="command-line-options.html#caption">&#x2011;caption</a><a href="command-line-options.html#cdl">&#x2011;cdl</a><a href="command-line-options.html#channel">&#x2011;channel</a><a href="command-line-options.html#charcoal">&#x2011;charcoal</a><a href="command-line-options.html#chop">&#x2011;chop</a><a href="command-line-options.html#clamp">&#x2011;clamp</a><a href="command-line-options.html#clip">&#x2011;clip</a><a href="command-line-options.html#clip-mask">&#x2011;clip&#x2011;mask</a><a href="command-line-options.html#clip-path">&#x2011;clip&#x2011;path</a><a href="command-line-options.html#clone">&#x2011;clone</a><a href="command-line-options.html#clut">&#x2011;clut</a><a href="command-line-options.html#coalesce">&#x2011;coalesce</a><a href="command-line-options.html#colorize">&#x2011;colorize</a><a href="command-line-options.html#colormap">&#x2011;colormap</a><a href="command-line-options.html#color-matrix">&#x2011;color&#x2011;matrix</a><a href="command-line-options.html#colors">&#x2011;colors</a><a href="command-line-options.html#colorspace">&#x2011;colorspace</a><a href="command-line-options.html#combine">&#x2011;combine</a><a href="command-line-options.html#comment">&#x2011;comment</a><a href="command-line-options.html#compare">&#x2011;compare</a><a href="command-line-options.html#complex">&#x2011;complex</a><a href="command-line-options.html#compose">&#x2011;compose</a><a href="command-line-options.html#composite">&#x2011;composite</a><a href="command-line-options.html#compress">&#x2011;compress</a><a href="command-line-options.html#connected-components">&#x2011;connected&#x2011;components</a><a href="command-line-options.html#contrast">&#x2011;contrast</a><a href="command-line-options.html#contrast-stretch">&#x2011;contrast&#x2011;stretch</a><a href="command-line-options.html#convolve">&#x2011;convolve</a><a href="command-line-options.html#copy">&#x2011;copy</a><a href="command-line-options.html#crop">&#x2011;crop</a><a href="command-line-options.html#cycle">&#x2011;cycle</a><a href="command-line-options.html#debug">&#x2011;debug</a><a href="command-line-options.html#decipher">&#x2011;decipher</a><a href="command-line-options.html#deconstruct">&#x2011;deconstruct</a><a href="command-line-options.html#define">&#x2011;define</a><a href="command-line-options.html#delay">&#x2011;delay</a><a href="command-line-options.html#delete">&#x2011;delete</a><a href="command-line-options.html#density">&#x2011;density</a><a href="command-line-options.html#depth">&#x2011;depth</a><a href="command-line-options.html#descend">&#x2011;descend</a><a href="command-line-options.html#deskew">&#x2011;deskew</a><a href="command-line-options.html#despeckle">&#x2011;despeckle</a><a href="command-line-options.html#direction">&#x2011;direction</a><a href="command-line-options.html#displace">&#x2011;displace</a><a href="command-line-options.html#display">&#x2011;display</a><a href="command-line-options.html#dispose">&#x2011;dispose</a><a href="command-line-options.html#dissimilarity-threshold">&#x2011;dissimilarity&#x2011;threshold</a><a href="command-line-options.html#dissolve">&#x2011;dissolve</a><a href="command-line-options.html#distort">&#x2011;distort</a><a href="command-line-options.html#distribute-cache">&#x2011;distribute&#x2011;cache</a><a href="command-line-options.html#dither">&#x2011;dither</a><a href="command-line-options.html#draw">&#x2011;draw</a><a href="command-line-options.html#duplicate">&#x2011;duplicate</a><a href="command-line-options.html#edge">&#x2011;edge</a><a href="command-line-options.html#emboss">&#x2011;emboss</a><a href="command-line-options.html#encipher">&#x2011;encipher</a><a href="command-line-options.html#encoding">&#x2011;encoding</a><a href="command-line-options.html#endian">&#x2011;endian</a><a href="command-line-options.html#enhance">&#x2011;enhance</a><a href="command-line-options.html#equalize">&#x2011;equalize</a><a href="command-line-options.html#evaluate">&#x2011;evaluate</a><a href="command-line-options.html#evaluate-sequence">&#x2011;evaluate&#x2011;sequence</a><a href="command-line-options.html#extent">&#x2011;extent</a><a href="command-line-options.html#extract">&#x2011;extract</a><a href="command-line-options.html#family">&#x2011;family</a><a href="command-line-options.html#features">&#x2011;features</a><a href="command-line-options.html#fft">&#x2011;fft</a><a href="command-line-options.html#fill">&#x2011;fill</a><a href="command-line-options.html#filter">&#x2011;filter</a><a href="command-line-options.html#flatten">&#x2011;flatten</a><a href="command-line-options.html#flip">&#x2011;flip</a><a href="command-line-options.html#floodfill">&#x2011;floodfill</a><a href="command-line-options.html#flop">&#x2011;flop</a><a href="command-line-options.html#font">&#x2011;font</a><a href="command-line-options.html#foreground">&#x2011;foreground</a><a href="command-line-options.html#format">&#x2011;format</a><a href="command-line-options.html#format_identify_">&#x2011;format[identify]</a><a href="command-line-options.html#frame">&#x2011;frame</a><a href="command-line-options.html#frame_import_">&#x2011;frame[import]</a><a href="command-line-options.html#function">&#x2011;function</a><a href="command-line-options.html#fuzz">&#x2011;fuzz</a><a href="command-line-options.html#fx">&#x2011;fx</a><a href="command-line-options.html#gamma">&#x2011;gamma</a><a href="command-line-options.html#gaussian-blur">&#x2011;gaussian&#x2011;blur</a><a href="command-line-options.html#geometry">&#x2011;geometry</a><a href="command-line-options.html#gravity">&#x2011;gravity</a><a href="command-line-options.html#grayscale">&#x2011;grayscale</a><a href="command-line-options.html#green-primary">&#x2011;green&#x2011;primary</a><a href="command-line-options.html#hald-clut">&#x2011;hald&#x2011;clut</a><a href="command-line-options.html#help">&#x2011;help</a><a href="command-line-options.html#highlight-color">&#x2011;highlight&#x2011;color</a><a href="command-line-options.html#hough-lines">&#x2011;hough&#x2011;lines</a><a href="command-line-options.html#iconGeometry">&#x2011;iconGeometry</a><a href="command-line-options.html#iconic">&#x2011;iconic</a><a href="command-line-options.html#identify">&#x2011;identify</a><a href="command-line-options.html#ift">&#x2011;ift</a><a href="command-line-options.html#immutable">&#x2011;immutable</a><a href="command-line-options.html#implode">&#x2011;implode</a><a href="command-line-options.html#insert">&#x2011;insert</a><a href="command-line-options.html#intensity">&#x2011;intensity</a><a href="command-line-options.html#intent">&#x2011;intent</a><a href="command-line-options.html#interlace">&#x2011;interlace</a><a href="command-line-options.html#interpolate">&#x2011;interpolate</a><a href="command-line-options.html#interline-spacing">&#x2011;interline&#x2011;spacing</a><a href="command-line-options.html#interword-spacing">&#x2011;interword&#x2011;spacing</a><a href="command-line-options.html#kerning">&#x2011;kerning</a><a href="command-line-options.html#kuwahara">&#x2011;kuwahara</a><a href="command-line-options.html#label">&#x2011;label</a><a href="command-line-options.html#lat">&#x2011;lat</a><a href="command-line-options.html#layers">&#x2011;layers</a><a href="command-line-options.html#level">&#x2011;level</a><a href="command-line-options.html#level-colors">&#x2011;level&#x2011;colors</a><a href="command-line-options.html#limit">&#x2011;limit</a><a href="command-line-options.html#linear-stretch">&#x2011;linear&#x2011;stretch</a><a href="command-line-options.html#linewidth">&#x2011;linewidth</a><a href="command-line-options.html#liquid-rescale">&#x2011;liquid&#x2011;rescale</a><a href="command-line-options.html#list">&#x2011;list</a><a href="command-line-options.html#log">&#x2011;log</a><a href="command-line-options.html#loop">&#x2011;loop</a><a href="command-line-options.html#lowlight-color">&#x2011;lowlight&#x2011;color</a><a href="command-line-options.html#magnify">&#x2011;magnify</a><a href="command-line-options.html#map">&#x2011;map</a><a href="command-line-options.html#map_stream_">&#x2011;map[stream]</a><a href="command-line-options.html#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
62<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>
63
64<div style="margin: auto;">
65 <h3 class="magick-header"><a id="adaptive-blur"></a>-adaptive-blur <var>radius</var>[x<var>sigma</var>]</h3>
66</div>
67
68<p class="magick-description">Adaptively blur pixels, with decreasing effect near edges.</p>
69
70<p>A Gaussian operator of the given radius and standard deviation (<var>sigma</var>) is used. If <var>sigma</var> is not given it
71defaults to 1.</p>
72
73<div style="margin: auto;">
74 <h3 class="magick-header"><a id="adaptive-resize"></a>-adaptive-resize <var>geometry</var></h3>
75</div>
76
77<p class="magick-description">Resize the image using data-dependent triangulation.</p>
78
79<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 -050080option defaults to data-dependent triangulation. Use the <a
81href="command-line-options.html#filter">-filter</a> to choose a different resampling algorithm.
82Offsets, if present in the geometry string, are ignored, and the <a
83href="command-line-options.html#gravity">-gravity</a> option has no effect.</p>
Cristy882d9f42015-10-29 16:48:39 -040084
85<div style="margin: auto;">
86 <h3 class="magick-header"><a id="adaptive-sharpen"></a>-adaptive-sharpen <var>radius</var>[x<var>sigma</var>]</h3>
87</div>
88
89<p class="magick-description">Adaptively sharpen pixels, with increasing effect near edges.</p>
90
91<p>A Gaussian operator of the given radius and standard deviation
92(<var>sigma</var>) is used. If <var>sigma</var> is not given it
93defaults to 1.</p>
94
95<div style="margin: auto;">
96 <h3 class="magick-header"><a id="adjoin"></a>-adjoin</h3>
97</div>
98
99<p class="magick-description">Join images into a single multi-image file.</p>
100
101<p>This option is enabled by default. An attempt is made to save all images of
102an image sequence into the given output file. However, some formats, such as
103JPEG and PNG, do not support more than one image per file, and in that case
104ImageMagick is forced to write each image as a separate file. As such, if
105more than one image needs to be written, the filename given is modified by
106adding a <a href="command-line-options.html#scene">-scene</a> number before the suffix, in order to
107make distinct names for each image. </p>
108
109<p>Use <a href="command-line-options.html#adjoin">+adjoin</a> to force each image to be written to
110separate files, whether or not the file format allows multiple images per file
111(for example, GIF, MIFF, and TIFF). </p>
112
113<p>Including a C-style integer format string in the output filename will
114automagically enable <a href="command-line-options.html#adjoin">+adjoin</a> and are used to specify
115where the <a href="command-line-options.html#scene">-scene</a> number is placed in the filenames. These
116strings, such as '<code>%d</code>' or '<code>%03d</code>', are familiar to those
117who have used the standard <code>printf()</code>' C-library function. As an
118example, the command</p>
119
120<pre>
121convert logo: rose: -morph 15 my%02dmorph.jpg
122</pre>
123
124<p>will create a sequence of 17 images (the two given plus 15 more created by
125<a href="command-line-options.html#morph">-morph</a>), named: my00morph.jpg, my01morph.jpg,
126my02morph.jpg, ..., my16morph.jpg. </p>
127
128<p>In summary, ImageMagick tries to write all images to one file, but will
129save to multiple files, if any of the following conditions exist...</p>
130<ol>
131<li>the output image's file format does not allow multi-image files,</li>
132<li>the <a href="command-line-options.html#adjoin">+adjoin</a> option is given, or</li>
133<li>a printf() integer format string (eg: "%d") is present in the output
134 filename.</li>
135</ol>
136
137
138<div style="margin: auto;">
139 <h3 class="magick-header"><a id="affine"></a>-affine
140 <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>
141</div>
142
143<p class="magick-description">Set the drawing transformation matrix for combined rotating and scaling.</p>
144
Cristy594d2772015-11-15 10:47:42 -0500145<p>This option sets a transformation matrix, for use by subsequent <a
146href="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 -0400147
148<p>The matrix entries are entered as comma-separated numeric values either in
149quotes or without spaces. </p>
150
151<p>Internally, the transformation matrix has 3x3 elements, but three of them
152are omitted from the input because they are constant. The new (transformed)
153coordinates (<var>x'</var>, <var>y'</var>) of a pixel at
154position (<var>x</var>, <var>y</var>) in the original
155image are calculated using the following matrix equation.</p>
156
Cristy594d2772015-11-15 10:47:42 -0500157<p class="text-center"><img class="img-thumbnail" alt="affine transformation" src="../images/affine.png"/> </p>
Cristy882d9f42015-10-29 16:48:39 -0400158
159<p> The size of the resulting image is that of the smallest rectangle that
160contains the transformed source image. The parameters
161<var>t<sub>x</sub></var> and <var>t<sub>y</sub></var>
162subsequently shift the image pixels so that those that are moved out of the
163image area are cut off.</p>
164
165<p>The transformation matrix complies with the left-handed pixel coordinate
166system: positive <var>x</var> and <var>y</var> directions
167are rightward and downward, resp.; positive rotation is clockwise.</p>
168
169<p> If the translation coefficients <var>t<sub>x</sub></var> and
170<var>t<sub>y</sub></var> are omitted they default to 0,0. Therefore,
171four parameters suffice for rotation and scaling without translation.</p>
172
173<p>Scaling by the factors <var>s<sub>x</sub></var> and
174<var>s<sub>y</sub></var> in the <var>x</var> and <var>y</var> directions,
175respectively, is accomplished with the following.</p>
176
Cristy594d2772015-11-15 10:47:42 -0500177<p>See <a href="command-line-options.html#transform">-transform</a>, and the <a
178href="command-line-options.html#distort">-distort</a> method '<code>Affineprojection</code> for more
Cristy882d9f42015-10-29 16:48:39 -0400179information </p>
180
181
182<pre>
183-affine <var>s<sub>x</sub></var>,0,0,<var>s<sub>y</sub></var>
184</pre>
185
186<p>Translation by a displacement (<var>t<sub>x</sub></var>, <var>t<sub>y</sub></var>) is accomplished like so:</p>
187
188<pre>
189-affine 1,0,0,1,<var>t<sub>x</sub></var>,<var>t<sub>y</sub></var>
190</pre>
191
192<p>Rotate clockwise about the origin (the upper left-hand corner) by an angle
193<var>a</var> by letting <var>c</var> = cos(<var>a</var>), <var>s</var>
194= sin(<var>a</var>), and using the following.</p>
195
196<pre>
197-affine <var>c</var>,<var>s</var>,-<var>s</var>,<var>c</var>
198</pre>
199
Cristy594d2772015-11-15 10:47:42 -0500200<p>The cumulative effect of a sequence of <a href="command-line-options.html#affine" >-affine</a>
201transformations can be accomplished by instead by a single <a href="command-line-options.html#affine"
202>-affine</a> operation using the matrix equal to the product of the matrices
Cristy882d9f42015-10-29 16:48:39 -0400203of the individual transformations.</p>
204
205<p>An attempt is made to detect near-singular transformation matrices. If the
206matrix determinant has a sufficiently small absolute value it is rejected.</p>
207
208<div style="margin: auto;">
209 <h3 class="magick-header"><a id="alpha"></a>-alpha <var>type</var></h3>
210</div>
211
212<p class="magick-description">Gives control of the alpha/matte channel of an image.</p>
213
214<p>Used to set a flag on an image indicating whether or not to use existing alpha
215channel 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>
216
217<dl class="dl-horizontal">
218 <dt>Activate</dt>
219 <dd>
220 Enable the image's transparency channel. Note normally Set
221 should be used instead of this, unless you specifically need to
222 preserve existing (but specifically turned Off) transparency
223 channel. </dd>
224
225 <dt>Associate</dt>
226 <dd>
227 associate the alpha channel with the image.</dd>
228
229 <dt>Deactivate</dt>
230 <dd>
231 Disables the image's transparency channel. Does not delete or change the
232 existing data, just turns off the use of that data.</dd>
233
234 <dt>Disassociate</dt>
235 <dd>
236 disassociate the alpha channel from the image.</dd>
237
238 <dt>Set</dt>
239 <dd>
240 Activates the alpha/matte channel. If it was previously turned off
241 then it also resets the channel to opaque. If the image already had
242 the alpha channel turned on, it will have no effect.</dd>
243
244 <dt>Opaque</dt>
245 <dd>
246 Enables the alpha/matte channel and forces it to be fully opaque.
247 </dd>
248
249 <dt>Transparent</dt>
250 <dd>
251 Activates the alpha/matte channel and forces it to be fully
252 transparent. This effectively creates a fully transparent image the
253 same size as the original and with all its original RGB data still
254 intact, but fully transparent. </dd>
255
256 <dt>Extract</dt>
257 <dd>
258 Copies the alpha channel values into all the color channels and turns
259 'Off' the the image's transparency, so as to generate
Cristy769d8892016-01-19 18:11:14 -0500260 a grayscale mask of the image's shape. The alpha channel data is left
Cristy882d9f42015-10-29 16:48:39 -0400261 intact just deactivated. This is the inverse of 'Copy'.
262 </dd>
263
264 <dt>Copy</dt>
265 <dd>
266 Turns 'On' the alpha/matte channel, then copies the
Cristy769d8892016-01-19 18:11:14 -0500267 grayscale intensity of the image, into the alpha channel, converting
268 a grayscale mask into a transparent shaped mask ready to be colored
Cristy882d9f42015-10-29 16:48:39 -0400269 appropriately. The color channels are not modified. </dd>
270
271 <dt>Shape</dt>
272 <dd>
273 As per 'Copy' but also colors the resulting shape mask with
274 the current background color. That is the RGB color channels is
275 replaced, with appropriate alpha shape.
276 </dd>
277
278 <dt>Remove</dt>
279 <dd>
280 Composite the image over the background color.
281 </dd>
282
283 <dt>Background</dt>
284 <dd>
285 Set any fully-transparent pixel to the background color, while leaving
286 it fully-transparent. This can make some image file formats, such as
287 PNG, smaller as the RGB values of transparent pixels are more uniform,
288 and thus can compress better.
289 </dd>
290</dl>
291
292<p>Note that while the obsolete <code>+matte</code> operation was the
Cristy594d2772015-11-15 10:47:42 -0500293same as "<code><a href="command-line-options.html#alpha" >-alpha</a> Off</code>", the <code>
294>-matte</code> operation was the same as "<code><a href="command-line-options.html#alpha" >-alpha</a>
295Set</code>" and not "<code><a href="command-line-options.html#alpha" >-alpha</a> On</code>". </p>
Cristy882d9f42015-10-29 16:48:39 -0400296
Cristyf650f4f2016-04-01 10:53:07 -0400297<div style="margin: auto;">
298 <h3 class="magick-header"><a id="alpha-color"></a>-alpha-color <var>color</var></h3>
299</div>
300
301<p class="magick-description">Specify the color to be used with the <a href="command-line-options.html#frame">-frame</a> option.</p>
302
303<p>The color is specified using the format described under the <a href="command-line-options.html#fill">-fill</a> option.</p>
304
305<p>The default matte color is <code>#BDBDBD</code>, <span
306style="background-color: #bdbdbd;">this shade of gray</span>.</p>
307
308<p>This is an IMv7 option, use <a href="command-line-options.html#mattecolor">mattecolor</a> with IMv6.</p>
309
Cristy882d9f42015-10-29 16:48:39 -0400310
311<div style="margin: auto;">
312 <h3 class="magick-header"><a id="annotate"></a>
Cristy594d2772015-11-15 10:47:42 -0500313 -annotate <var>degrees</var> <var>text</var><br />
314 -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 -0400315</div>
316
317<p class="magick-description">Annotate an image with text</p>
318
319<p>This is a convenience for annotating an image with text. For more precise
320control over text annotations, use <a href="command-line-options.html#draw">-draw</a>.</p>
321
322
323<p>The values <var>Xdegrees</var> and <var>Ydegrees</var>
Cristy594d2772015-11-15 10:47:42 -0500324control 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 -0400325
326<p>Using <a href="command-line-options.html#annotate">-annotate</a> <var>degrees</var>
327or <a href="command-line-options.html#annotate">-annotate</a> <var>degrees</var>x<var>degrees</var> produces an unsheared rotation of the text. The
328direction of the rotation is positive, which means a clockwise rotation if <var>degrees</var> is positive. (This conforms to the usual mathematical
329convention once it is realized that the positive <var>y</var>–direction is
330conventionally considered to be <var>downward</var> for images.)</p>
331
332<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
333equation.</p>
334
Cristy594d2772015-11-15 10:47:42 -0500335<p class="text-center"><img class="img-thumbnail" alt="annotate transformation" src="../images/annotate.png"/></p>
Cristy882d9f42015-10-29 16:48:39 -0400336
337<p>If <var>t<sub>x</sub></var> and <var>t<sub>y</sub></var> are omitted, they default to 0. This makes the
338bottom-left of the text becomes the upper-left corner of the image, which is
Cristy594d2772015-11-15 10:47:42 -0500339probably undesirable. Adding a <a href="command-line-options.html#gravity" >-gravity</a> option in this
Cristy882d9f42015-10-29 16:48:39 -0400340case leads to nice results.</p>
341
342<p>Text is any UTF-8 encoded character sequence. If <var>text</var>
343is of the form '@mytext.txt', the text is read from the file
344<code>mytext.txt</code>. Text in a file is taken literally; no embedded
345formatting characters are recognized.</p>
346
347<div style="margin: auto;">
348 <h3 class="magick-header"><a id="antialias"></a>-antialias</h3>
349</div>
350
351<p class="magick-description">Enable/Disable of the rendering of anti-aliasing pixels when drawing fonts and lines.</p>
352
353<p>By default, objects (e.g. text, lines, polygons, etc.) are antialiased when
354drawn. Use <a href="command-line-options.html#antialias">+antialias</a> to disable the addition of
355antialiasing edge pixels. This will then reduce the number of colors added to
356an image to just the colors being directly drawn. That is, no mixed colors
357are added when drawing such objects. </p>
358
359<div style="margin: auto;">
360 <h3 class="magick-header"><a id="append"></a>-append</h3>
361</div>
362
363<p class="magick-description">Join current images vertically or horizontally.</p>
364
365<p>This option creates a single longer image, by joining all the current
366images in sequence top-to-bottom. Use <a href="command-line-options.html#append">+append</a> to
367stack images left-to-right. </p>
368
369<p>If they are not of the same width, narrower images are padded with the
370current <a href="command-line-options.html#background">-background</a> color setting, and their
Cristy594d2772015-11-15 10:47:42 -0500371position relative to each other can be controlled by the current <a
372href="command-line-options.html#gravity">-gravity</a> setting. </p>
Cristy882d9f42015-10-29 16:48:39 -0400373
374
375<div style="margin: auto;">
376 <h3 class="magick-header"><a id="attenuate"></a>-attenuate <var>value</var></h3>
377</div>
378
379<p class="magick-description">Lessen (or intensify) when adding noise to an image.</p>
380
381<p>If unset the value is equivalent to 1.0, or a maximum noise addition</p>
382
383<div style="margin: auto;">
384 <h3 class="magick-header"><a id="authenticate"></a>-authenticate <var>password</var></h3>
385</div>
386
387<p class="magick-description">Decrypt a PDF with a password.</p>
388
389<p>Use this option to supply a <var>password</var> for decrypting
390a PDF that has been encrypted using Microsoft Crypto API (MSC API). The
391encrypting using the MSC API is not supported.</p>
392
393<p>For a different encryption method, see <a href="command-line-options.html#encipher">-encipher</a>
394and <a href="command-line-options.html#decipher">-decipher</a>. </p>
395
396
397<div style="margin: auto;">
398 <h3 class="magick-header"><a id="auto-gamma"></a>-auto-gamma</h3>
399</div>
400
401<p class="magick-description">Automagically adjust gamma level of image.</p>
402
Cristy594d2772015-11-15 10:47:42 -0500403<p>This calculates the mean values of an image, then applies a calculated <a
404href="command-line-options.html#gamma" >-gamma</a> adjustment so that is the mean color exists in the
Cristy882d9f42015-10-29 16:48:39 -0400405image it will get a have a value of 50%. </p>
406
407<p>This means that any solid 'gray' image becomes 50% gray. </p>
408
409<p>This works well for real-life images with little or no extreme dark and
410light areas, but tend to fail for images with large amounts of bright sky or
411dark shadows. It also does not work well for diagrams or cartoon like images.
412</p>
413
Cristy594d2772015-11-15 10:47:42 -0500414<p>It uses the <a href="command-line-options.html#channel" >-channel</a> setting, (including the
Cristy882d9f42015-10-29 16:48:39 -0400415'<var>sync</var>' flag for channel synchronization), to determine which color
Cristy594d2772015-11-15 10:47:42 -0500416values is used and modified. As the default <a href="command-line-options.html#channel"
417>-channel</a> setting is '<var>RGB,sync</var>', channels are modified
Cristy882d9f42015-10-29 16:48:39 -0400418together by the same gamma value, preserving colors. </p>
419
420
421
422<div style="margin: auto;">
423 <h3 class="magick-header"><a id="auto-level"></a>-auto-level</h3>
424</div>
425
426<p class="magick-description">Automagically adjust color levels of image.</p>
427
428<p>This is a 'perfect' image normalization operator. It finds the exact
Cristy594d2772015-11-15 10:47:42 -0500429minimum and maximum color values in the image and then applies a <a
430href="command-line-options.html#level" >-level</a> operator to stretch the values to the full range of
Cristy882d9f42015-10-29 16:48:39 -0400431values. </p>
432
433<p>The operator is not typically used for real-life images, image scans, or
434JPEG format images, as a single 'out-rider' pixel can set a bad min/max values
Cristy594d2772015-11-15 10:47:42 -0500435for the <a href="command-line-options.html#level" >-level</a> operation. On the other hand it is the
Cristy882d9f42015-10-29 16:48:39 -0400436right operator to use for color stretching gradient images being used to
437generate Color lookup tables, distortion maps, or other 'mathematically'
438defined images. </p>
439
Cristy594d2772015-11-15 10:47:42 -0500440<p>The operator is very similar to the <a href="command-line-options.html#normalize">-normalize</a>, <a
441href="command-line-options.html#contrast-stretch" >-contrast-stretch</a>, and <a href="command-line-options.html#linear-stretch"
442>-linear-stretch</a> operators, but without 'histogram binning' or 'clipping'
443problems that these operators may have. That is <a href="command-line-options.html#auto-level"
444>-auto-level</a> is the perfect or ideal version these operators. </p>
Cristy882d9f42015-10-29 16:48:39 -0400445
Cristy594d2772015-11-15 10:47:42 -0500446<p>It uses the <a href="command-line-options.html#channel" >-channel</a> setting, (including the
Cristy882d9f42015-10-29 16:48:39 -0400447special '<var>sync</var>' flag for channel synchronization), to determine
Cristy594d2772015-11-15 10:47:42 -0500448which color values are used and modified. As the default <a
449href="command-line-options.html#channel" >+channel</a> setting is '<var>RGB,sync</var>', the
Cristy882d9f42015-10-29 16:48:39 -0400450'<var>sync</var>' ensures that the color channels will are modified
451together by the same gamma value, preserving colors, and ignoring
452transparency. </p>
453
454
455<div style="margin: auto;">
456 <h3 class="magick-header"><a id="auto-orient"></a>-auto-orient</h3>
457</div>
458
459<p class="magick-description">adjusts an image so that its orientation is suitable for viewing (i.e. top-left orientation).</p>
460
461<p>This operator reads and resets the EXIF image profile setting 'Orientation'
462and then performs the appropriate 90 degree rotation on the image to orient
463the image, for correct viewing. </p>
464
465<p>This EXIF profile setting is usually set using a gravity sensor in digital
466camera, however photos taken directly downward or upward may not have an
467appropriate value. Also images that have been orientation 'corrected' without
468reseting this setting, may be 'corrected' again resulting in a incorrect
Cristy594d2772015-11-15 10:47:42 -0500469result. If the EXIF profile was previously stripped, the <a
470href="command-line-options.html#auto-orient" >-auto-orient</a> operator will do nothing. </p>
Cristy882d9f42015-10-29 16:48:39 -0400471
472
473<div style="margin: auto;">
474 <h3 class="magick-header"><a id="average"></a>-average</h3>
475</div>
476
477<p class="magick-description">Average a set of images.</p>
478
479<p>An error results if the images are not identically sized.</p>
480
481
482<div style="margin: auto;">
483 <h3 class="magick-header"><a id="backdrop"></a>-backdrop</h3>
484</div>
485
486<p class="magick-description">Display the image centered on a backdrop.</p>
487
488<p>This backdrop covers the entire workstation screen and is useful for hiding
489other X window activity while viewing the image. The color of the backdrop is
490specified as the background color. The color is specified using the format
491described under the <a href="command-line-options.html#fill">-fill</a> option.</p>
492
493<div style="margin: auto;">
494 <h3 class="magick-header"><a id="background"></a>-background <var>color</var></h3>
495</div>
496
497<p class="magick-description">Set the background color.</p>
498
Cristy594d2772015-11-15 10:47:42 -0500499<p>The color is specified using the format described under the <a
500href="command-line-options.html#fill">-fill</a> option. The default background color (if none is
Cristy882d9f42015-10-29 16:48:39 -0400501specified or found in the image) is white.</p>
502
503<div style="margin: auto;">
504 <h3 class="magick-header"><a id="bench"></a>-bench <var>iterations</var></h3>
505</div>
506
507<p class="magick-description">Measure performance.</p>
508
509<p>Repeat the entire command for the given number of <var>iterations</var> and report the user-time and elapsed time. For instance,
510consider the following command and its output. Modify the benchmark with the
511-duration to run the benchmark for a fixed number of seconds and -concurrent
512to run the benchmark in parallel (requires the OpenMP feature).</p>
513
514<pre>
Cristye09ed312016-03-06 08:07:39 -0500515-> convert logo: -resize 200% -bench 5 logo.png
516Performance[1]: 5i 1.344ips 1.000e 3.710u 0:03.720
517Performance[2]: 5i 1.634ips 0.549e 3.890u 0:03.060
518Performance[3]: 5i 2.174ips 0.618e 3.190u 0:02.300
519Performance[4]: 5i 1.678ips 0.555e 3.810u 0:02.980
Cristy882d9f42015-10-29 16:48:39 -0400520Performance[4]: 5i 0.875657ips 6.880u 0:05.710
521</pre>
522
Cristye09ed312016-03-06 08:07:39 -0500523<p>In this example, 5 iterations were completed at 2.174 iterations per
524second, using 3 threads and 3.190 seconds of the user allotted time, for
525a total elapsed time of 2.300 seconds.</p>
Cristy882d9f42015-10-29 16:48:39 -0400526
527<div style="margin: auto;">
528 <h3 class="magick-header"><a id="bias"></a>-bias <var>value</var>{<var>%</var>}</h3>
529</div>
530
531<p class="magick-description">Add bias when convolving an image.</p>
532
Cristy594d2772015-11-15 10:47:42 -0500533<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 -0400534positive and negative results are relative to the specified bias value. </p>
535
536<p>This is important for non-HDRI compilations of ImageMagick when dealing
537with convolutions that contain negative as well as positive values. This is
538especially the case with convolutions involving high pass filters or edge
539detection. Without an output bias, the negative values are clipped at
540zero.</p>
541
Cristy594d2772015-11-15 10:47:42 -0500542<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 -0400543negative results without clipping to the color value range
544(0..QuantumRange).</p>
545
Cristy594d2772015-11-15 10:47:42 -0500546<p>See the discussion on HDRI implementations of ImageMagick on the page <a
547href="high-dynamic-range.html" >High Dynamic-Range Images</a>. For more
548about HDRI go the ImageMagick <a
Cristy364a72f2016-11-04 22:38:41 -0400549href="https://www.imagemagick.org/Usage/basics/#hdri" >Usage</a> pages or this
Cristy594d2772015-11-15 10:47:42 -0500550<a
551href="http://en.wikipedia.org/wiki/High_dynamic_range_imaging">Wikipedia</a>
Cristy882d9f42015-10-29 16:48:39 -0400552entry. </p>
553
554<div style="margin: auto;">
555 <h3 class="magick-header"><a id="black-point-compensation"></a>-black-point-compensation</h3>
556</div>
557
558<p class="magick-description">Use black point compensation.</p>
559
560<div style="margin: auto;">
561 <h3 class="magick-header"><a id="black-threshold"></a>-black-threshold <var>value</var>{<var>%</var>}</h3>
562</div>
563
564<p class="magick-description">Force to black all pixels below the threshold while leaving all pixels at or above the threshold unchanged.</p>
565
566<p> The threshold value can be given as a percentage or as an absolute integer
567value within [0, <var>QuantumRange</var>] corresponding to the
Cristy594d2772015-11-15 10:47:42 -0500568desired <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 -0400569
570
571<div style="margin: auto;">
572 <h3 class="magick-header"><a id="blend"></a>-blend <var>geometry</var></h3>
573</div>
574
575<p class="magick-description">blend an image into another by the given absolute value or percent.</p>
576
577<p>Blend will average the images together ('plus') according to the
578percentages given and each pixels transparency. If only a single percentage
579value is given it sets the weight of the composite or 'source' image, while
580the background image is weighted by the exact opposite amount. That is a
581<code>-blend 30%</code> merges 30% of the 'source' image with 70% of the
582'destination' image. Thus it is equivalent to <code>-blend 30x70%</code>.</p>
583
584
585<div style="margin: auto;">
586 <h3 class="magick-header"><a id="blue-primary"></a>-blue-primary <var>x</var>,<var>y</var></h3>
587</div>
588
589<p class="magick-description">Set the blue chromaticity primary point.</p>
590
591<div style="margin: auto;">
592 <h3 class="magick-header"><a id="blue-shift"></a>-blue-shift <var>factor</var></h3>
593</div>
594
595<p class="magick-description">simulate a scene at nighttime in the moonlight. Start with a factor of 1.5</p>
596
597<div style="margin: auto;">
598
599<div style="margin: auto;">
Cristy594d2772015-11-15 10:47:42 -0500600 <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 -0400601</div>
602
603<p class="magick-description">Reduce image noise and reduce detail levels.</p>
604
605<p>Convolve the image with a Gaussian or normal distribution using the given
Cristy594d2772015-11-15 10:47:42 -0500606<var >Sigma</var> value. The formula is:</p>
Cristy882d9f42015-10-29 16:48:39 -0400607
Cristy594d2772015-11-15 10:47:42 -0500608<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 -0400609
Cristy594d2772015-11-15 10:47:42 -0500610<p>The <var >Sigma</var> value is the important argument, and
Cristy882d9f42015-10-29 16:48:39 -0400611determines the actual amount of blurring that will take place. </p>
612
Cristy594d2772015-11-15 10:47:42 -0500613<p>The <var >Radius</var> is only used to determine the size of the
Cristy882d9f42015-10-29 16:48:39 -0400614array which will hold the calculated Gaussian distribution. It should be an
615integer. If not given, or set to zero, IM will calculate the largest possible
616radius that will provide meaningful results for the Gaussian distribution.
617</p>
618
Cristy594d2772015-11-15 10:47:42 -0500619<p>The larger the <var >Radius</var> the slower the
620operation is. However too small a <var >Radius</var>, and sever
621aliasing effects may result. As a guideline, <var >Radius</var>
622should be at least twice the <var >Sigma</var> value, though three
Cristy882d9f42015-10-29 16:48:39 -0400623times will produce a more accurate result. </p>
624
625<p>This option differs from <a href="command-line-options.html#gaussian-blur">-gaussian-blur</a> simply
626by taking advantage of the separability properties of the distribution. Here
627we apply a single-dimensional Gaussian matrix in the horizontal direction,
628then repeat the process in the vertical direction.</p>
629
630<p>The <a href="command-line-options.html#virtual-pixel">-virtual-pixel</a> setting will determine how
631pixels which are outside the image proper are blurred into the final result.
632</p>
633
634
635<div style="margin: auto;">
Cristy882d9f42015-10-29 16:48:39 -0400636 <h3 class="magick-header"><a id="border"></a>-border <var>geometry</var></h3>
637</div>
638
639<p class="magick-description">Surround the image with a border of color. </p>
640
641<p>Set the width and height using the <var>size</var> portion of the
642<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
643ignored. </p>
644
645<p>As of IM 6.7.8-8, the <var>geometry</var> arguments behave as follows:</p>
646
647<dl class="dl-horizontal">
648<dt><var>value</var></dt>
649<dd>value is added to both left/right and top/bottom</dd>
650<dt><var>value-x</var><kbd>x</kbd></dt>
651<dd>value-x is added only to left/right and top/bottom are unchanged</dd>
652<dt><kbd>x</kbd><var>value-y</var></dt>
653<dd>value-y is added only to top/bottom and left/right are unchanged</dd>
654<dt><var>value-x</var><kbd>x</kbd><var>value-y</var></dt>
655<dd>value-x is added to left/right and value-y added to top/bottom</dd>
656<dt><var>value-x</var><kbd>x</kbd>0</dt>
657<dd>value-x is added only to left/right and top/bottom are unchanged</dd>
658<dt>0<kbd>x</kbd><var>value-y</var></dt>
659<dd>value-y is added only to top/bottom and left/right are unchanged</dd>
660<dt><var>value</var>%</dt>
661<dd>value % of width is added to left/right and value % of height is added to top/bottom</dd>
662<dt><var>value-x</var><kbd>x</kbd>%</dt>
663<dd>value-x % of width is added to left/right and to top/bottom</dd>
664<dt>x<var>value-y</var>%</dt>
665<dd>value-y % of height is added to top/bottom and to left/right</dd>
666<dt><var>value-x</var>%<kbd>x</kbd><var>value-y</var>%</dt>
667<dd>value-x % of width is added to left/right and value-y % of height is added to top/bottom</dd>
668<dt><var>value-x</var>%<kbd>x</kbd>0%</dt>
669<dd>value-x % of width is added to left/right and top/bottom are unchanged</dd>
670<dt>0%<kbd>x</kbd><var>value-y</var>%</dt>
671<dd>value-y % of height is added to top/bottom and left/right are unchanged</dd>
672</dl>
673
Cristy594d2772015-11-15 10:47:42 -0500674<p>Set the border color by preceding with the <a
675href="command-line-options.html#bordercolor">-bordercolor</a> setting.</p>
Cristy882d9f42015-10-29 16:48:39 -0400676
Cristy594d2772015-11-15 10:47:42 -0500677<p>The <a href="command-line-options.html#border">-border</a> operation is affected by the current <a
678href="command-line-options.html#compose">-compose</a> setting and assumes that this is using the default
Cristy882d9f42015-10-29 16:48:39 -0400679'<code>Over</code>' composition method. It generates an image of the appropriate
680size colors by the current <a href="command-line-options.html#bordercolor">-bordercolor</a> before
681overlaying the original image in the center of this net image. This means that
682with the default compose method of '<code>Over</code>' any transparent parts may
683be replaced by the current <a href="command-line-options.html#bordercolor">-bordercolor</a> setting.</p>
684<p>See also the <a href="command-line-options.html#frame">-frame</a> option, which has more
685functionality.</p>
686
687<div style="margin: auto;">
688 <h3 class="magick-header"><a id="bordercolor"></a>-bordercolor <var>color</var></h3>
689</div>
690
691<p class="magick-description">Set the border color.</p>
692
693<p>The color is specified using the format described under the <a href="command-line-options.html#fill">-fill</a> option.</p>
694
695<p>The default border color is <code>#DFDFDF</code>, <span style="background-color: #dfdfdf;">this shade of gray</span>.</p>
696
697<div style="margin: auto;">
698 <h3 class="magick-header"><a id="borderwidth"></a>-borderwidth <var>geometry</var> </h3>
699</div>
700
701<p class="magick-description">Set the border width.</p>
702
703<div style="margin: auto;">
Cristy769d8892016-01-19 18:11:14 -0500704 <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 -0400705</div>
706
707<p class="magick-description">Adjust the brightness and/or contrast of the image.</p>
708
709<p>Brightness and Contrast values apply changes to the input image. They are
710not absolute settings. A brightness or contrast value of zero means no change.
711The range of values is -100 to +100 on each. Positive values increase the
712brightness or contrast and negative values decrease the brightness or contrast.
713To control only contrast, set the brightness=0. To control only brightness,
714set contrast=0 or just leave it off.</p>
715
716<p>You may also use <a href="command-line-options.html#fill">-channel</a> to control which channels to
717apply the brightness and/or contrast change. The default is to apply the same
718transformation to all channels.</p>
719
720<p>Brightness and Contrast arguments are converted to offset and slope of a
721linear transform and applied
722using <a href="command-line-options.html#fill">-function polynomial "slope,offset"</a>.</p>
723
724<p>The slope varies from 0 at contrast=-100 to almost vertical at
725contrast=+100. For brightness=0 and contrast=-100, the result are totally
726midgray. For brightness=0 and contrast=+100, the result will approach but
727not quite reach a threshold at midgray; that is the linear transformation
728is a very steep vertical line at mid gray.</p>
729
730<p>Negative slopes, i.e. negating the image, are not possible with this
731function. All achievable slopes are zero or positive.</p>
732
733<p>The offset varies from -0.5 at brightness=-100 to 0 at brightness=0 to +0.5
734at brightness=+100. Thus, when contrast=0 and brightness=100, the result is
735totally white. Similarly, when contrast=0 and brightness=-100, the result is
736totally black.</p>
737
738<p>As the range of values for the arguments are -100 to +100, adding the '%'
739symbol is no different than leaving it off.</p>
740
741<div style="margin: auto;">
742 <h3 class="magick-header"><a id="cache"></a>-cache <var>threshold</var></h3>
743</div>
744
Cristy594d2772015-11-15 10:47:42 -0500745<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 -0400746
747<div style="margin: auto;">
Cristy594d2772015-11-15 10:47:42 -0500748 <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 -0400749</div>
750
751<p class="magick-description">Canny edge detector uses a multi-stage algorithm to detect a wide range of edges in the image.</p>
752
753<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>
754
755<div style="margin: auto;">
756 <h3 class="magick-header"><a id="caption"></a>-caption <var>string</var></h3>
757</div>
758
759<p class="magick-description">Assign a caption to an image.</p>
760
761<p>This option sets the caption meta-data of an image read in after this
762option has been given. To modify a caption of images already in memory use
763"<code><a href="command-line-options.html#set">-set</a> caption</code>". </p>
764
Cristy594d2772015-11-15 10:47:42 -0500765<p>The caption can contain special format characters listed in the <a
766href="escape.html">Format and
Cristy882d9f42015-10-29 16:48:39 -0400767Print Image Properties</a>. These attributes are expanded when the caption
768is finally assigned to the individual images. </p>
769
770<p>If the first character of <var>string</var> is <var>@</var>, the image caption is read from a file titled by the
771remaining characters in the string. Comments read in from a file are literal;
772no embedded formatting characters are recognized.</p>
773
774<p>Caption meta-data is not visible on the image itself. To do that use the
775<a href="command-line-options.html#annotate">-annotate</a> or <a href="command-line-options.html#draw">-draw</a> options
776instead.</p>
777
778<p>For example,</p>
779
780<pre>
781-caption "%m:%f %wx%h" bird.miff
782</pre>
783
784<p>produces an image caption of <code>MIFF:bird.miff 512x480</code> (assuming
785that the image <code>bird.miff</code> has a width of 512 and a height of
786480.</p>
787
788
789<div style="margin: auto;">
790 <h3 class="magick-header"><a id="cdl"></a>-cdl <var>filename</var></h3>
791</div>
792
793<p class="magick-description">color correct with a color decision list.</p>
794
795<p>Here is an example color correction collection:</p>
796
797<pre>
798&lt;?xml version="1.0" encoding="UTF-8"?&gt;
799&lt;ColorCorrectionCollection xmlns="urn:ASC:CDL:v1.2"&gt;
800 &lt;ColorCorrection id="cc06668"&gt;
801 &lt;SOPNode&gt;
802 &lt;Slope&gt; 0.9 1.2 0.5 &lt;/Slope&gt;
803 &lt;Offset&gt; 0.4 -0.5 0.6 &lt;/Offset&gt;
804 &lt;Power&gt; 1.0 0.8 1.5 &lt;/Power&gt;
805 &lt;/SOPNode&gt;
806 &lt;SATNode&gt;
807 &lt;Saturation&gt; 0.85 &lt;/Saturation&gt;
808 &lt;/SATNode&gt;
809 &lt;/ColorCorrection&gt;
810&lt;/ColorCorrectionCollection&gt;
811</pre>
812
813<div style="margin: auto;">
814 <h3 class="magick-header"><a id="channel"></a>-channel <var>type</var></h3>
815</div>
816
817<p class="magick-description">Specify those image color channels to which subsequent operators are limited.</p>
818
819<p>Choose from: <code>Red</code>, <code>Green</code>, <code>Blue</code>,
820<code>Alpha</code>, <code>Gray</code>, <code>Cyan</code>, <code>Magenta</code>,
821<code>Yellow</code>, <code>Black</code>, <code>Opacity</code>,
822<code>Index</code>, <code>RGB</code>, <code>RGBA</code>, <code>CMYK</code>, or
823<code>CMYKA</code>.</p>
824
825<p>The channels above can also be specified as a comma-separated list or can be
826abbreviated as a concatenation of the letters '<code>R</code>', '<code>G</code>',
827'<code>B</code>', '<code>A</code>', '<code>O</code>', '<code>C</code>',
828'<code>M</code>', '<code>Y</code>', '<code>K</code>'.
829
830For example, to only select the <code>Red</code> and <code>Blue</code> channels
831you can either use </p>
832<pre>
833-channel Red,Blue
834</pre>
835<p>or you can use the short hand form</p>
836<pre>
837-channel RB
838</pre>
839
840<p>All the channels that are present in an image can be specified using the
841special channel type <code>All</code>. Not all operators are 'channel capable',
842but generally any operators that are generally 'grey-scale' image operators,
843will understand this setting. See individual operator documentation. </p>
844
Cristy594d2772015-11-15 10:47:42 -0500845<br/>
Cristy882d9f42015-10-29 16:48:39 -0400846
847<p>On top of the normal channel selection an extra flag can be specified,
848'<code>Sync</code>'. This is turned on by default and if set means that
849operators that understand this flag should perform: cross-channel
850synchronization of the channels. If not specified, then most grey-scale
851operators will apply their image processing operations to each individual
852channel (as specified by the rest of the <a href="command-line-options.html#channel">-channel</a>
853setting) completely independently from each other. </p>
854
855<p>For example for operators such as <a href="command-line-options.html#auto-level">-auto-level</a> and
856<a href="command-line-options.html#auto-gamma">-auto-gamma</a> the color channels are modified
857together in exactly the same way so that colors will remain in-sync. Without
858it being set, then each channel is modified separately and
859independently, which may produce color distortion. </p>
860
861<p>The <a href="command-line-options.html#morphology">-morphology</a> '<code>Convolve</code>' method
862and the <a href="command-line-options.html#compose">-compose</a> mathematical methods, also understands
863the '<code>Sync</code>' flag to modify the behavior of pixel colors according
864to the alpha channel (if present). That is to say it will modify the image
865processing with the understanding that fully-transparent colors should not
866contribute to the final result. </p>
867
868<p>Basically, by default, operators work with color channels in synchronous, and
869treats transparency as special, unless the <a href="command-line-options.html#channel">-channel</a>
870setting is modified so as to remove the effect of the '<code>Sync</code>' flag.
871How each operator does this depends on that operators current implementation.
872Not all operators understands this flag at this time, but that is changing.
873</p>
874
875<p>To print a complete list of channel types, use <a href="command-line-options.html#list">-list
876channel</a>.</p>
877
878<p>By default, ImageMagick sets <a href="command-line-options.html#channel">-channel</a> to the value
879'<code>RGBK,sync</code>', which specifies that operators act on all color
880channels except the transparency channel, and that all the color channels are
881to be modified in exactly the same way, with an understanding of transparency
Cristy594d2772015-11-15 10:47:42 -0500882(depending on the operation being applied). The 'plus' form <a
883href="command-line-options.html#channel" >+channel</a> will reset the value back to this default. </p>
Cristy882d9f42015-10-29 16:48:39 -0400884
Cristy594d2772015-11-15 10:47:42 -0500885<p>Options that are affected by the <a href="command-line-options.html#channel" >-channel</a> setting
Cristy882d9f42015-10-29 16:48:39 -0400886include the following.
887
888<a href="command-line-options.html#auto-gamma">-auto-gamma</a>,
889<a href="command-line-options.html#auto-level">-auto-level</a>,
890<a href="command-line-options.html#black-threshold">-black-threshold</a>,
891<a href="command-line-options.html#blur">-blur</a>,
892<a href="command-line-options.html#clamp">-clamp</a>,
893<a href="command-line-options.html#clut">-clut</a>,
894<a href="command-line-options.html#combine">-combine</a>,
895<a href="command-line-options.html#composite">-composite</a> (Mathematical compose methods only),
896<a href="command-line-options.html#convolve">-convolve</a>,
897<a href="command-line-options.html#contrast-stretch">-contrast-stretch</a>,
898<a href="command-line-options.html#evaluate">-evaluate</a>,
899<a href="command-line-options.html#function">-function</a>,
900<a href="command-line-options.html#fx">-fx</a>,
901<a href="command-line-options.html#gaussian-blur">-gaussian-blur</a>,
902<a href="command-line-options.html#hald-clut">-hald-clut</a>,
903<a href="command-line-options.html#motion-blur">-motion-blur</a>,
904<a href="command-line-options.html#morphology">-morphology</a>,
905<a href="command-line-options.html#negate">-negate</a>,
906<a href="command-line-options.html#normalize">-normalize</a>,
907<a href="command-line-options.html#ordered-dither">-ordered-dither</a>,
908<a href="command-line-options.html#radial-blur">-radial-blur</a>,
909<a href="command-line-options.html#random-threshold">-random-threshold</a>,
910<a href="command-line-options.html#separate">-separate</a>,
911<a href="command-line-options.html#threshold">-threshold</a>, and
912<a href="command-line-options.html#white-threshold">-white-threshold</a>.
913</p>
914
Cristy594d2772015-11-15 10:47:42 -0500915<p>Warning, some operators behave differently when the <a href="command-line-options.html#channel"
916>+channel</a> default setting is in effect, verses ANY user defined <a
917href="command-line-options.html#channel" >-channel</a> setting (including the equivalent of the
Cristy882d9f42015-10-29 16:48:39 -0400918default). These operators have yet to be made to understand the newer 'Sync'
919flag. </p>
920
Cristy769d8892016-01-19 18:11:14 -0500921<p>For example <a href="command-line-options.html#threshold">-threshold</a> will by default grayscale
Cristy594d2772015-11-15 10:47:42 -0500922the image before thresholding, if no <a href="command-line-options.html#channel" >-channel</a> setting
Cristy882d9f42015-10-29 16:48:39 -0400923has been defined. This is not 'Sync flag controlled, yet. </p>
924
Cristy594d2772015-11-15 10:47:42 -0500925<p>Also some operators such as <a href="command-line-options.html#blur">-blur</a>, <a
926href="command-line-options.html#gaussian-blur">-gaussian-blur</a>, will modify their handling of the
927color channels if the '<code>alpha</code>' channel is also enabled by <a
928href="command-line-options.html#channel" >-channel</a>. Generally this done to ensure that
Cristy882d9f42015-10-29 16:48:39 -0400929fully-transparent colors are treated as being fully-transparent, and thus any
930underlying 'hidden' color has no effect on the final results. Typically
931resulting in 'halo' effects. The newer <a href="command-line-options.html#morphology">-morphology</a>
932convolution equivalents however does have a understanding of the 'Sync' flag
933and will thus handle transparency correctly by default. </p>
934
935<p>As a alpha channel is optional within images, some operators will read the
936color channels of an image as a greyscale alpha mask, when the image has no
Cristy594d2772015-11-15 10:47:42 -0500937alpha channel present, and the <a href="command-line-options.html#channel" >-channel</a> setting tells
938the operator to apply the operation using alpha channels. The <a
939href="command-line-options.html#clut">-clut</a> operator is a good example of this. </p>
Cristy882d9f42015-10-29 16:48:39 -0400940
941
942
943<div style="margin: auto;">
944 <h3 class="magick-header"><a id="charcoal"></a>-charcoal <var>factor</var></h3>
945</div>
946
947<p class="magick-description">Simulate a charcoal drawing.</p>
948
949<div style="margin: auto;">
950 <h3 class="magick-header"><a id="chop"></a>-chop <var>geometry</var></h3>
951</div>
952
953<p class="magick-description">Remove pixels from the interior of an image.</p>
954
955<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>
956and <var>height</var> given in the of the <var>size</var>
957portion of the <var>geometry</var> argument give the number of
958columns and rows to remove. The <var>offset</var> portion of
959the <var>geometry</var> argument is influenced by
960a <a href="command-line-options.html#gravity">-gravity</a> setting, if present.</p>
961
962<p>The <a href="command-line-options.html#chop">-chop</a> option removes entire rows and columns,
963and moves the remaining corner blocks leftward and upward to close the gaps.</p>
964
965<p>While it can remove internal rows and columns of pixels, it is more
966typically used with as <a href="command-line-options.html#gravity">-gravity</a> setting and zero
Cristy594d2772015-11-15 10:47:42 -0500967offsets so as to remove a single edge from an image. Compare this to <a
968href="command-line-options.html#shave" >-shave</a> which removes equal numbers of pixels from opposite
Cristy882d9f42015-10-29 16:48:39 -0400969sides of the image. </p>
970
Cristy594d2772015-11-15 10:47:42 -0500971<p>Using <a href="command-line-options.html#chop">-chop</a> effectively undoes the results of a <a
972href="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 -0400973
974<div style="margin: auto;">
975 <h3 class="magick-header"><a id="clamp"></a>-clamp</h3>
976</div>
977
978<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>
979
980<div style="margin: auto;">
981 <h3 class="magick-header"><a id="clip"></a>-clip</h3>
982</div>
983
984<p class="magick-description">Apply the clipping path if one is present.</p>
985
986<p>If a clipping path is present, it is applied to subsequent operations.</p>
987
988<p>For example, in the command</p>
989
990<pre>
991convert cockatoo.tif -clip -negate negated.tif
992</pre>
993
994<p>only the pixels within the clipping path are negated.</p>
995
996<p>The <a href="command-line-options.html#clip">-clip</a> feature requires SVG support. If the SVG
997delegate library is not present, the option is ignored.</p>
998
999<p>Use <a href="command-line-options.html#clip">+clip</a> to disable clipping for subsequent operations.</p>
1000
1001<div style="margin: auto;">
1002 <h3 class="magick-header"><a id="clip-mask"></a>-clip-mask</h3>
1003</div>
1004
1005<p class="magick-description">Clip the image as defined by this mask.</p>
1006
1007<p>Use the alpha channel of the current image as a mask. Any areas that is
1008white is not modified by any of the 'image processing operators' that follow,
1009until the mask is removed. Pixels in the black areas of the clip mask are
1010modified per the requirements of the operator. </p>
1011
1012<p>In some ways this is similar to (though not the same) as defining
Cristy594d2772015-11-15 10:47:42 -05001013a rectangular <a href="command-line-options.html#region" >-region</a>, or using the negative of the
1014mask (third) image in a three image <a href="command-line-options.html#composite" >-composite</a>,
Cristy882d9f42015-10-29 16:48:39 -04001015operation. </p>
1016
1017<p>Use <a href="command-line-options.html#clip-mask">+clip-mask</a> to disable clipping for subsequent operations.</p>
1018
1019<div style="margin: auto;">
1020 <h3 class="magick-header"><a id="clip-path"></a>-clip-path <var>id</var></h3>
1021</div>
1022
1023<p class="magick-description">Clip along a named path from the 8BIM profile.</p>
1024
1025<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>
1026
1027<p>Use <a href="command-line-options.html#clip-path">+clip-path</a> to disable clipping for subsequent operations.</p>
1028
1029<div style="margin: auto;">
1030 <h3 class="magick-header"><a id="clone"></a>-clone <var>index(s)</var></h3>
1031</div>
1032
1033<p class="magick-description">make a clone of an image (or images).</p>
1034
1035<p>Inside parenthesis (where the operator is normally used) it will make a
1036clone of the images from the last 'pushed' image sequence, and adds them to
1037the end of the current image sequence. Outside parenthesis
1038(not recommended) it clones the images from the current image sequence. </p>
1039
1040<p>Specify the image by its index in the sequence. The first image is index
10410. Negative indexes are relative to the end of the sequence; for
1042example, <code>−1</code>
1043represents the last image of the sequence. Specify a range of images with a
1044dash (e.g. <code>0−4</code>). Separate multiple indexes with commas but no
1045spaces (e.g. <code>0,2,5</code>). A value of '<code>0−−1</code> will
1046effectively clone all the images. </p>
1047
1048<p>The <a href="command-line-options.html#clone">+clone</a> will simply make a copy of the last image
1049in the image sequence, and is thus equivalent to using a argument of
1050'<code>−1</code>'. </p>
1051
1052<div style="margin: auto;">
1053 <h3 class="magick-header"><a id="clut"></a>-clut</h3>
1054</div>
1055
1056<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>
1057
1058<p>The second (LUT) image is ordinarily a gradient image containing the
1059histogram mapping of how each channel should be modified. Typically it is a
1060either a single row or column image of replacement color values. If larger
1061than a single row or column, values are taken from a diagonal line from
1062top-left to bottom-right corners.</p>
1063
Cristy594d2772015-11-15 10:47:42 -05001064<p>The lookup is further controlled by the <a
1065href="command-line-options.html#interpolate">-interpolate</a> setting, which is especially handy for an
Cristy882d9f42015-10-29 16:48:39 -04001066LUT which is not the full length needed by the ImageMagick installed Quality
1067(Q) level. Good settings for this are the '<code>bilinear</code>' and
1068'<code>bicubic</code>' interpolation settings, which give smooth color
1069gradients, and the '<code>integer</code>' setting for a direct, unsmoothed
1070lookup of color values. </p>
1071
1072<p>This operator is especially suited to replacing a grayscale image with a
1073specific color gradient from the CLUT image. </p>
1074
1075<p>Only the channel values defined by the <a href="command-line-options.html#channel">-channel</a>
Cristy594d2772015-11-15 10:47:42 -05001076setting will have their values replaced. In particular, since the default <a
1077href="command-line-options.html#channel">-channel</a> setting is <code>RGB</code>, this means that
1078transparency (alpha/matte channel) is not affected, unless the <a
1079href="command-line-options.html#channel">-channel</a> setting is modified. When the alpha channel is
1080set, 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 -04001081as the other channels, implying that alpha/matte values are replaced using the
1082alpha/matte values of the original image. </p>
1083
1084<p>If either the image being modified, or the lookup image, contains no
Cristy594d2772015-11-15 10:47:42 -05001085transparency (i.e. <a href="command-line-options.html#alpha" >-alpha</a> is turned 'off') but the <a
1086href="command-line-options.html#channel">-channel</a> setting includes alpha replacement, then it is
Cristy769d8892016-01-19 18:11:14 -05001087assumed that image represents a grayscale gradient which is used for the
1088replacement alpha values. That is you can use a grayscale CLUT image to
1089adjust a existing images alpha channel, or you can color a grayscale image
Cristy882d9f42015-10-29 16:48:39 -04001090using colors form CLUT containing the desired colors, including transparency.
1091</p>
1092
Cristy594d2772015-11-15 10:47:42 -05001093<p>See also <a href="command-line-options.html#hald-clut" >-hald-clut</a> which replaces colors
Cristy882d9f42015-10-29 16:48:39 -04001094according to the lookup of the full color RGB value from a 2D representation
1095of a 3D color cube. </p>
1096
1097
1098<div style="margin: auto;">
1099 <h3 class="magick-header"><a id="coalesce"></a>-coalesce</h3>
1100</div>
1101
1102<p class="magick-description">Fully define the look of each frame of an GIF animation sequence, to form a 'film strip' animation.</p>
1103
1104<p>Overlay each image in an image sequence according to
1105its <a href="command-line-options.html#dispose">-dispose</a> meta-data, to reproduce the look of
1106an animation at each point in the animation sequence. All images should be
1107the same size, and are assigned appropriate GIF disposal settings for the
1108animation to continue working as expected as a GIF animation. Such frames
1109are more easily viewed and processed than the highly optimized GIF overlay
1110images. </p>
1111
1112<p>The animation can be re-optimized after processing using
1113the <a href="command-line-options.html#layers">-layers</a> method '<code>optimize</code>', although
1114there is no guarantee that the restored GIF animation optimization is
1115better than the original. </p>
1116
1117
1118<div style="margin: auto;">
1119 <h3 class="magick-header"><a id="colorize"></a>-colorize <var>value</var></h3>
1120</div>
1121
Cristy594d2772015-11-15 10:47:42 -05001122<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 -04001123
1124<p>Specify the amount of colorization as a percentage. Separate colorization
1125values can be applied to the red, green, and blue channels of the image with
1126a comma-delimited list of colorization
1127values (e.g., <code>-colorize 0,0,50</code>).</p>
1128
1129<div style="margin: auto;">
1130 <h3 class="magick-header"><a id="colormap"></a>-colormap <var>type</var></h3>
1131</div>
1132
1133<p class="magick-description">Define the colormap type.</p>
1134
1135<p>The <var>type</var> can be <code>shared</code> or <code>private</code>.</p>
1136
1137<p>This option only applies when the default X server visual
1138is <code>PseudoColor</code> or <code>GrayScale</code>. Refer
1139to <a href="command-line-options.html#visual">-visual</a> for more details. By default,
1140a shared colormap is allocated. The image shares colors with
1141other X clients. Some image colors could be approximated,
1142therefore your image may look very different than intended.
1143If <code>private</code> is chosen, the image colors appear exactly
1144as they are defined. However, other clients may go <var>technicolor</var>
1145when the image colormap is installed.</p>
1146
1147<div style="margin: auto;">
1148 <h3 class="magick-header"><a id="colors"></a>-colors <var>value</var></h3>
1149</div>
1150
1151<p class="magick-description">Set the preferred number of colors in the image.</p>
1152
1153<p>The actual number of colors in the image may be less than your request,
1154but never more. Note that this a color reduction option. Images with fewer
1155unique colors than specified by <var>value</var> will have any
1156duplicate or unused colors removed. The ordering of an existing color
1157palette may be altered. When converting an image from color to grayscale,
1158it is more efficient to convert the image to the gray colorspace before
1159reducing the number of colors. Refer to
Cristy6549abb2016-11-10 08:25:55 -05001160the <a href="http://www.imagemagick.org/www/quantize.html">
Cristy882d9f42015-10-29 16:48:39 -04001161color reduction algorithm</a> for more details.</p>
1162
1163<div style="margin: auto;">
1164 <h3 class="magick-header"><a id="color-matrix"></a>-color-matrix <var>matrix</var></h3>
1165</div>
1166
1167<p class="magick-description">apply color correction to the image.</p>
1168
1169<p>This option permits saturation changes, hue rotation, luminance to alpha,
1170and various other effects. Although variable-sized transformation matrices
1171can be used, typically one uses a 5x5 matrix for an RGBA image and a 6x6
1172for CMYKA (or RGBA with offsets). The matrix is similar to those used by
1173Adobe Flash except offsets are in column 6 rather than 5 (in support of
1174CMYKA images) and offsets are normalized (divide Flash offset by 255).</p>
1175
1176<p>As an example, to add contrast to an image with offsets, try this command:</p>
1177
1178<pre>
1179convert kittens.jpg -color-matrix \
1180 " 1.5 0.0 0.0 0.0, 0.0, -0.157 \
1181 0.0 1.5 0.0 0.0, 0.0, -0.157 \
1182 0.0 0.0 1.5 0.0, 0.0, -0.157 \
1183 0.0 0.0 0.0 1.0, 0.0, 0.0 \
1184 0.0 0.0 0.0 0.0, 1.0, 0.0 \
1185 0.0 0.0 0.0 0.0, 0.0, 1.0" kittens.png
1186</pre>
1187<div style="margin: auto;">
1188 <h3 class="magick-header"><a id="colorspace"></a>-colorspace <var>value</var></h3>
1189</div>
1190
1191<p class="magick-description">Set the image colorspace.</p>
1192
1193<p>Choices are:</p>
1194
1195<pre>
1196CMY CMYK Gray HCL
1197HCLp HSB HSI HSL
1198HSV HWB Lab LCHab
1199LCHuv LMS Log Luv
1200OHTA Rec601YCbCr Rec709YCbCr RGB
1201scRGB sRGB Transparent xyY
1202XYZ YCbCr YCC YDbDr
1203YIQ YPbPr YUV
1204</pre>
1205
1206<p>To print a complete list of colorspaces, use <a href="command-line-options.html#list">-list colorspace</a>.</p>
1207
1208<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>
1209
1210<table class="table table-condensed table-striped">
1211 <caption>Conversion of RGB to Other Color Spaces</caption>
1212 <tr><th valign="middle">CMY</th></tr>
1213 <tr><td valign="middle">C=<var>QuantumRange</var>−R</td></tr>
1214 <tr><td valign="middle">M=<var>QuantumRange</var>−G</td></tr>
1215 <tr><td valign="middle">Y=<var>QuantumRange</var>−B</td></tr>
1216 <tr><th valign="middle">CMYK — starts with CMY from above</th></tr>
1217 <tr><td valign="middle">K=min(C,Y,M)</td></tr>
1218 <tr><td valign="middle">C=<var>QuantumRange</var>*(C−K)/(<var>QuantumRange</var>−K)</td></tr>
1219 <tr><td valign="middle">M=<var>QuantumRange</var>*(M−K)/(<var>QuantumRange</var>−K)</td></tr>
1220 <tr><td valign="middle">Y=<var>QuantumRange</var>*(Y−K)/(<var>QuantumRange</var>−K)</td></tr>
1221
1222 <tr><th valign="middle">Gray</th></tr>
1223 <tr><td valign="middle">Gray = 0.298839*R+0.586811*G+0.114350*B</td></tr>
1224
1225 <tr><th valign="middle">HSB — Hue, Saturation, Brightness; like a cone peak downward</th></tr>
1226 <tr><td valign="middle">H=angle around perimeter (0 to 360 deg); H=0 is red; increasing angles toward green</td></tr>
1227 <tr><td valign="middle">S=distance from axis outward</td></tr>
1228 <tr><td valign="middle">B=distance along axis from bottom upward; B=max(R,G,B); <var>intensity-like</var></td></tr>
1229
1230 <tr><th valign="middle">HSL — Hue, Saturation, Lightness; like a double cone end-to-end with peaks at very top and bottom</th></tr>
1231 <tr><td valign="middle">H=angle around perimeter (0 to 360 deg); H=0 is red; increasing angles toward green</td></tr>
1232 <tr><td valign="middle">S=distance from axis outward</td></tr>
1233 <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>
1234
1235 <tr><th valign="middle">HWB — Hue, Whiteness, Blackness</th></tr>
1236 <tr><td valign="middle">Hue (complicated equation)</td></tr>
1237 <tr><td valign="middle">Whiteness (complicated equation)</td></tr>
1238 <tr><td valign="middle">Blackness (complicated equation)</td></tr>
1239
1240 <tr><th valign="middle">LAB</th></tr>
1241 <tr><td valign="middle">L (complicated equation relating X,Y,Z)</td></tr>
1242 <tr><td valign="middle">A (complicated equation relating X,Y,Z)</td></tr>
1243 <tr><td valign="middle">B (complicated equation relating X,Y,Z)</td></tr>
1244
1245 <tr><th valign="middle">LOG</th></tr>
1246 <tr><td valign="middle">I1 (complicated equation involving logarithm of R)</td></tr>
1247 <tr><td valign="middle">I2 (complicated equation involving logarithm of G)</td></tr>
1248 <tr><td valign="middle">I3 (complicated equation involving logarithm of B)</td></tr>
1249
1250 <tr><th valign="middle">OHTA — approximates principal components transformation</th></tr>
1251 <tr><td valign="middle">I1=0.33333*R+0.33334*G+0.33333*B; <var>intensity-like</var></td></tr>
1252 <tr><td valign="middle">I2=(0.50000*R+0.00000*G−0.50000*B)*(<var>QuantumRange</var>+1)/2</td></tr>
1253 <tr><td valign="middle">I3=(−0.25000*R+0.50000*G−0.25000*B)*(<var>QuantumRange</var>+1)/2</td></tr>
1254
1255 <tr><th valign="middle">Rec601Luma</th></tr>
1256 <tr><td valign="middle">Gray = 0.298839*R+0.586811*G+0.114350*B</td></tr>
1257
1258 <tr><th valign="middle">Rec601YCbCr</th></tr>
1259 <tr><td valign="middle">Y=0.2988390*R+0.5868110*G+0.1143500*B; <var>intensity-like</var></td></tr>
1260 <tr><td valign="middle">Cb=(−0.168736*R-0.331264*G+0.500000*B)*(<var>QuantumRange</var>+1)/2</td></tr>
1261 <tr><td valign="middle">Cr=(0.500000*R−0.418688*G−0.081312*B)*(<var>QuantumRange</var>+1)/2</td></tr>
1262
1263 <tr><th valign="middle">Rec709Luma</th></tr>
1264 <tr><td valign="middle">Gray=0.212656*R+0.715158*G+0.072186*B</td></tr>
1265
1266 <tr><th valign="middle">Rec709YCbCr</th></tr>
1267 <tr><td valign="middle">Y=0.212656*R+0.715158*G+0.072186*B; <var>intensity-like</var></td></tr>
1268 <tr><td valign="middle">Cb=(−0.114572*R−0.385428*G+0.500000*B)+(<var>QuantumRange</var>+1)/2</td></tr>
1269 <tr><td valign="middle">Cr=(0.500000*R−0.454153*G−0.045847*B)+(<var>QuantumRange</var>+1)/2</td></tr>
1270
1271 <tr><th valign="middle">sRGB</th></tr>
1272 <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>
1273 <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>
1274 <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>
1275
1276 <tr><th valign="middle">XYZ</th></tr>
1277 <tr><td valign="middle">X=0.4124564*R+0.3575761*G+0.1804375*B</td></tr>
1278 <tr><td valign="middle">Y=0.2126729*R+0.7151522*G+0.0721750*B</td></tr>
1279 <tr><td valign="middle">Z=0.0193339*R+0.1191920*G+0.9503041*B</td></tr>
1280
1281 <tr><th valign="middle">YCC</th></tr>
1282 <tr><td valign="middle">Y=(0.298839*R+0.586811*G+0.114350*B) (with complicated scaling); <var>intensity-like</var></td></tr>
1283 <tr><td valign="middle">C1=(−0.298839*R−0.586811*G+0.88600*B) (with complicated scaling)</td></tr>
1284 <tr><td valign="middle">C2=(0.70100*R−0.586811*G−0.114350*B) (with complicated scaling)</td></tr>
1285
1286 <tr><th valign="middle">YCbCr</th></tr>
1287 <tr><td valign="middle">Y=0.2988390*R+0.5868110*G+0.1143500*B; <var>intensity-like</var></td></tr>
1288 <tr><td valign="middle">Cb=(−0.168736*R−0.331264*G+0.500000*B)*(<var>QuantumRange</var>+1)/2</td></tr>
1289 <tr><td valign="middle">Cr=(0.500000*R−0.418688*G−0.081312*B)*(<var>QuantumRange</var>+1)/2</td></tr>
1290
1291 <tr><th valign="middle">YIQ</th></tr>
1292 <tr><td valign="middle">Y=0.298839*R+0.586811*G+0.114350*B; <var>intensity-like</var></td></tr>
1293 <tr><td valign="middle">I=(0.59600*R−0.27400*G−0.32200*B)*(<var>QuantumRange</var>+1)/2</td></tr>
1294 <tr><td valign="middle">Q=(0.21100*R−0.52300*G+0.31200*B)*(<var>QuantumRange</var>+1)/2</td></tr>
1295
1296 <tr><th valign="middle">YPbPr</th></tr>
1297 <tr><td valign="middle">Y=0.2988390*R+0.5868110*G+0.1143500*B; <var>intensity-like</var></td></tr>
1298 <tr><td valign="middle">Pb=(−0.168736*R−0.331264*G+0.500000*B)*(<var>QuantumRange</var>+1)/2</td></tr>
1299 <tr><td valign="middle">Pr=(0.500000*R−0.418688*G−0.081312*B)*(<var>QuantumRange</var>+1)/2</td></tr>
1300
1301 <tr><th valign="middle">YUV</th></tr>
1302 <tr><td valign="middle">Y=0.298839*R+0.586811*G+0.114350*B; <var>intensity-like</var></td></tr>
1303 <tr><td valign="middle">U=(−0.14740*R−0.28950*G+0.43690*B)*(<var>QuantumRange</var>+1)/2</td></tr>
1304 <tr><td valign="middle">V=(0.61500*R−0.51500*G−0.10000*B)*(<var>QuantumRange</var>+1)/2</td></tr>
1305</table>
1306
1307<p>Note the scRGB colorspace requires HDRI support otherwise it behaves just like linear RGB.</p>
1308
1309<div style="margin: auto;">
1310 <h3 class="magick-header"><a id="combine"></a>-combine</h3>
1311</div>
1312
1313<p class="magick-description">Combine one or more images into a single image.</p>
1314
1315<p>The channels (previously set by <a href="command-line-options.html#channel">-channel</a>) of the
1316combined image are taken from the grayscale values of each image in the
1317sequence, in order. For the default -channel setting of <code>RGB</code>, this
1318means the first image is assigned to the <code>Red</code> channel, the second
1319to the <code>Green</code> channel, the third to the <code>Blue</code>.</p>
1320
Cristy594d2772015-11-15 10:47:42 -05001321<p>This option can be thought of as the inverse to <a
1322href="command-line-options.html#separate">-separate</a>, so long as the channel settings are the same.
Cristy882d9f42015-10-29 16:48:39 -04001323Thus, in the following example, the final image should be a copy of the
1324original. </p>
1325
1326<pre>
1327convert original.png -channel RGB -separate sepimage.png
1328convert sepimage-0.png sepimage-1.png sepimage-2.png -channel RGB \
1329 -combine imagecopy.png
1330</pre>
1331
1332<div style="margin: auto;">
1333 <h3 class="magick-header"><a id="comment"></a>-comment <var>string</var></h3>
1334</div>
1335
1336<p class="magick-description">Embed a comment in an image.</p>
1337
1338<p>This option sets the comment meta-data of an image read in after this
1339option has been given. To modify a comment of images already in memory use
1340"<code><a href="command-line-options.html#set">-set</a> comment</code>". </p>
1341
Cristy594d2772015-11-15 10:47:42 -05001342<p>The comment can contain special format characters listed in the <a
1343href="escape.html">Format and
Cristy882d9f42015-10-29 16:48:39 -04001344Print Image Properties</a>. These attributes are expanded when the comment
1345is finally assigned to the individual images. </p>
1346
1347<p>If the first character of <var>string</var> is <var>@</var>, the image comment is read from a file titled by the
1348remaining characters in the string. Comments read in from a file are literal;
1349no embedded formatting characters are recognized.</p>
1350
1351<p>Comment meta-data are not visible on the image itself. To do that use the
1352<a href="command-line-options.html#annotate">-annotate</a> or <a href="command-line-options.html#draw">-draw</a> options
1353instead.</p>
1354
1355<p>For example,</p>
1356
1357<pre>
1358-comment "%m:%f %wx%h" bird.miff
1359</pre>
1360
1361<p>produces an image comment of <code>MIFF:bird.miff 512x480</code> (assuming
1362that the image <code>bird.miff</code> has a width of 512 and a height of
1363480.</p>
1364
1365<div style="margin: auto;">
1366 <h3 class="magick-header"><a id="compare"></a>-compare</h3>
1367</div>
1368
1369<p class="magick-description">mathematically and visually annotate the difference between an image and its reconstruction</p>
1370
1371<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>
1372
1373<pre>
Cristy594d2772015-11-15 10:47:42 -05001374convert image.png reference.png -metric RMSE -compare \ <br/> difference.png
Cristy882d9f42015-10-29 16:48:39 -04001375</pre>
1376
1377<p>To get the metric value use the string format "%[distortion]".</p>
1378
1379<pre>
1380convert image.png reference.png -metric RMSE -compare -format \
1381 "%[distortion]" info:
1382</pre>
1383
1384<div style="margin: auto;">
1385 <h3 class="magick-header"><a id="complex"></a>-complex <var>operator</var></h3>
1386</div>
1387
1388<p class="magick-description">perform complex mathematics on an image sequence</p>
1389
1390Choose from these operators:
1391
1392<pre>
1393add
1394conjugate
1395divide
1396magnitude-phase
1397multiply
1398real-imaginary
1399subtract
1400</pre>
1401
1402<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>
1403
1404<div style="margin: auto;">
1405 <h3 class="magick-header"><a id="compose"></a>-compose <var>operator</var></h3>
1406</div>
1407
1408<p class="magick-description">Set the type of image composition.</p>
1409
Cristy6549abb2016-11-10 08:25:55 -05001410<p>See <a href="http://www.imagemagick.org/www/compose.html">Alpha Compositing</a> for
Cristy882d9f42015-10-29 16:48:39 -04001411a detailed discussion of alpha compositing.</p>
1412
1413<p>This setting effects image processing operators that merge two (or more)
1414images together in some way. This includes the operators,
1415<a href="command-line-options.html#composite">-compare</a>,
1416<a href="command-line-options.html#composite">-composite</a>,
1417<a href="command-line-options.html#layers">-layers</a> composite,
1418<a href="command-line-options.html#flatten">-flatten</a>,
1419<a href="command-line-options.html#mosaic">-mosaic</a>,
1420<a href="command-line-options.html#layers">-layers</a> merge,
1421<a href="command-line-options.html#border">-border</a>,
1422<a href="command-line-options.html#frame">-frame</a>,
1423and <a href="command-line-options.html#extent">-extent</a>. </p>
1424
1425<p>It is also one of the primary options for the "<code>composite</code>"
1426command. </p>
1427
1428
1429<div style="margin: auto;">
1430 <h3 class="magick-header"><a id="composite"></a>-composite</h3>
1431</div>
1432
1433<p class="magick-description">Perform alpha composition on two images and an optional mask</p>
1434
1435<p>Take the first image 'destination' and overlay the second 'source' image
1436according to the current <a href="command-line-options.html#compose">-compose</a> setting. The location
Cristy594d2772015-11-15 10:47:42 -05001437of the 'source' or 'overlay' image is controlled according to <a
Cristye93be682015-11-26 09:07:51 -05001438href="command-line-options.html#gravity" >-gravity</a>, and <a href="command-line-options.html#geometry" >-geometry</a>
Cristy882d9f42015-10-29 16:48:39 -04001439settings. </p>
1440
Cristy769d8892016-01-19 18:11:14 -05001441<p>If a third image is given this is treated as a grayscale blending 'mask' image
Cristy882d9f42015-10-29 16:48:39 -04001442relative to the first 'destination' image. This mask is blended with the
1443source image. However for the '<code>displace</code>' compose method, the
1444mask is used to provide a separate Y-displacement image instead. </p>
1445
1446<p>If a <a href="command-line-options.html#compose">-compose</a> method requires extra numerical
Cristy594d2772015-11-15 10:47:42 -05001447arguments or flags these can be provided by setting the <a
1448href="command-line-options.html#set">-set</a> '<code>option:compose:args</code>'
Cristy882d9f42015-10-29 16:48:39 -04001449appropriately for the compose method. </p>
1450
1451<p>Some <a href="command-line-options.html#compose">-compose</a> methods can modify the 'destination'
Cristy594d2772015-11-15 10:47:42 -05001452image outside the overlay area. You can disable this by setting the special <a
1453href="command-line-options.html#set">-set</a> '<code>option:compose:outside-overlay</code>'
Cristy882d9f42015-10-29 16:48:39 -04001454to '<code>false</code>'. </p>
1455
1456<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>
1457
1458
1459<div style="margin: auto;">
1460 <h3 class="magick-header"><a id="compress"></a>-compress <var>type</var></h3>
1461</div>
1462
1463<p class="magick-description">Use pixel compression specified by <var>type</var> when writing the image.</p>
1464
Cristy594d2772015-11-15 10:47:42 -05001465<p>Choices are: <code>None</code>, <code>BZip</code>, <code
1466>Fax</code>, <code>Group4</code>, <code
1467>JPEG</code>, <code>JPEG2000</code>, <code
1468>Lossless</code>, <code>LZW</code>, <code
1469>RLE</code> or <code>Zip</code>.</p>
Cristy882d9f42015-10-29 16:48:39 -04001470
1471<p>To print a complete list of compression types, use <a href="command-line-options.html#list">-list
1472compress</a>.</p>
1473
1474<p>Specify <a href="command-line-options.html#compress">+compress</a> to store the binary image in an
1475uncompressed format. The default is the compression type of the specified
1476image file.</p>
1477
1478<p>If <code>LZW</code> compression is specified but LZW compression has not been
1479enabled, the image data is written in an uncompressed LZW format that can be
1480read by LZW decoders. This may result in larger-than-expected GIF files.</p>
1481
1482<p><code>Lossless</code> refers to lossless JPEG, which is only available if the
1483JPEG library has been patched to support it. Use of lossless JPEG is generally
1484not recommended.</p>
1485
1486<p>
1487When writing an ICO file, you may request that the images be encoded in
1488PNG format, by specifying <code>Zip</code> compression.</p>
1489
1490<p>
1491When writing a JNG file, specify <code>Zip</code> compression to request that
1492the alpha channel be encoded in PNG "IDAT" format, or <code>JPEG</code>
1493to request that it be encoded in JPG "JDAA" format.</p>
1494
1495<p>Use the <a href="command-line-options.html#quality">-quality</a> option to set the compression level
1496to be used by JPEG, PNG, MIFF, and MPEG encoders.
1497Use the <a href="command-line-options.html#sampling-factor">-sampling-factor</a> option to set the
1498sampling factor to be used by JPEG, MPEG, and YUV encoders for down-sampling
1499the chroma channels.</p>
1500
1501<div style="margin: auto;">
1502 <h3 class="magick-header"><a id="connected-components"></a>-connected-components <var>connectivity</var></h3>
1503</div>
1504
Cristyce4a3552015-12-14 13:53:35 -05001505<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 -04001506
Cristy594d2772015-11-15 10:47:42 -05001507<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 -04001508
1509<div style="margin: auto;">
1510 <h3 class="magick-header"><a id="contrast"></a>-contrast</h3>
1511</div>
1512
1513<p class="magick-description">Enhance or reduce the image contrast.</p>
1514
1515<p>This option enhances the intensity differences between the lighter and
1516darker elements of the image. Use <a href="command-line-options.html#contrast">-contrast</a> to enhance
1517the image or <a href="command-line-options.html#contrast">+contrast</a> to reduce the image
1518contrast.</p>
1519
1520<p>For a more pronounced effect you can repeat the option:</p>
1521
1522<pre>
1523convert rose: -contrast -contrast rose_c2.png
1524</pre>
1525
1526<div style="margin: auto;">
Cristy769d8892016-01-19 18:11:14 -05001527 <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 -04001528</div>
1529
1530<p class="magick-description">Increase the contrast in an image by <var>stretching</var> the range of intensity values.</p>
1531
1532<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 -05001533<var >black-point %</var> pixels and white-out at most <var>white-point %</var> pixels.</p>
Cristy882d9f42015-10-29 16:48:39 -04001534
Cristy594d2772015-11-15 10:47:42 -05001535<p>Prior to ImageMagick 6.4.7-0, <a href="command-line-options.html#contrast-stretch"
1536>-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 -04001537minus 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>
1538
1539<p>Note that <code>-contrast-stretch 0</code> will modify the image such that
1540the 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 -05001541clipping at either end. This is not the same as <a href="command-line-options.html#normalize"
1542>-normalize</a>, which is equivalent to <code>-contrast-stretch 0.15x0.05%</code> (or
Cristy882d9f42015-10-29 16:48:39 -04001543prior to ImageMagick 6.4.7-0, <code>-contrast-stretch 2%x99%</code>).</p>
1544
1545<p>Internally operator works by creating a histogram bin, and then uses that
1546bin to modify the image. As such some colors may be merged together when they
1547originally fell into the same 'bin'. </p>
1548
Cristy769d8892016-01-19 18:11:14 -05001549<p>All the channels are normalized in concert by the same amount so as to
Cristy594d2772015-11-15 10:47:42 -05001550preserve color integrity, when the default <a href="command-line-options.html#channel" >+channel</a>
1551setting is in use. Specifying any other <a href="command-line-options.html#channel" >-channel</a>
Cristy882d9f42015-10-29 16:48:39 -04001552setting will normalize the RGB channels independently.</p>
1553
Cristy594d2772015-11-15 10:47:42 -05001554<p>See also <a href="command-line-options.html#auto-level" >-auto-level</a> for a 'perfect'
Cristy882d9f42015-10-29 16:48:39 -04001555normalization of mathematical images. </p>
1556
1557<p>This operator is under review for re-development. </p>
1558
1559
1560<div style="margin: auto;">
1561 <h3 class="magick-header"><a id="convolve"></a>-convolve <var>kernel</var></h3>
1562</div>
1563
1564<p class="magick-description">Convolve an image with a user-supplied convolution kernel.</p>
1565
1566<p>The <var>kernel</var> is a matrix specified as
1567a comma-separated list of integers (with no spaces), ordered left-to right,
1568starting with the top row. Presently, only odd-dimensioned kernels are
1569supported, and therefore the number of entries in the specified <var>kernel</var> must be 3<sup>2</sup>=9, 5<sup>2</sup>=25,
15707<sup>2</sup>=49, etc. </p>
1571
Cristy594d2772015-11-15 10:47:42 -05001572<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 -04001573positive and negative results are relative to a user-specified bias value.
1574This is important for non-HDRI compilations of ImageMagick when dealing with
1575convolutions that contain negative as well as positive values. This is
1576especially the case with convolutions involving high pass filters or edge
1577detection. Without an output bias, the negative values is clipped at zero.
1578</p>
1579
Cristy594d2772015-11-15 10:47:42 -05001580<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 -04001581negative results without clipping to the color value range (0..QuantumRange).
Cristy594d2772015-11-15 10:47:42 -05001582See the discussion on HDRI implementations of ImageMagick on the page <a
1583href="high-dynamic-range.html">High
1584Dynamic-Range Images</a>. For more about HDRI go the ImageMagick <a
Cristy364a72f2016-11-04 22:38:41 -04001585href="https://www.imagemagick.org/Usage/basics/#hdri">Usage</a> pages or this
Cristy882d9f42015-10-29 16:48:39 -04001586<a href="http://en.wikipedia.org/wiki/High_dynamic_range_imaging">Wikipedia</a>
1587entry. </p>
1588
1589
1590<div style="margin: auto;">
1591 <h3 class="magick-header"><a id="copy"></a>-copy <var>geometry</var> <var>offset</var></h3>
1592</div>
1593
1594<p class="magick-description">copy pixels from one area of an image to another.</p>
1595
1596<div style="margin: auto;">
1597 <h3 class="magick-header"><a id="crop"></a>-crop <var>geometry</var>{<var>@</var>}{<var>!</var>}</h3>
1598</div>
1599
1600<p class="magick-description">Cut out one or more rectangular regions of the image.</p>
1601
1602<p>See <a href="command-line-processing.html#geometry">Image Geometry</a> for complete details about the <em class="arg">geometry</em> argument.</p>
1603
1604<p>The <var>width</var> and <var>height</var> of the <var>geometry</var> argument give the size of the image that remains
1605after cropping, and <var>x</var> and <var>y</var> in the
1606<var>offset</var> (if present) gives the location of the top left
1607corner of the cropped image with respect to the original image. To specify the
1608amount to be removed, use <a href="command-line-options.html#shave">-shave</a> instead.</p>
1609
1610<p>If the <var>x</var> and <var>y</var> offsets are
1611present, a single image is generated, consisting of the pixels from the
1612cropping region. The offsets specify the location of the upper left corner of
1613the cropping region measured downward and rightward with respect to the upper
1614left corner of the image. If the <a href="command-line-options.html#gravity">-gravity</a> option is
1615present with <code>NorthEast</code>, <code>East</code>, or <code>SouthEast</code>
1616gravity, it gives the distance leftward from the right edge of the image to
Cristy594d2772015-11-15 10:47:42 -05001617the right edge of the cropping region. Similarly, if the <a
1618href="command-line-options.html#gravity">-gravity</a> option is present with <code>SouthWest</code>,
Cristy882d9f42015-10-29 16:48:39 -04001619<code>South</code>, or <code>SouthEast</code> gravity, the distance is measured
1620upward between the bottom edges.</p>
1621
1622<p>If the <var>x</var> and <var>y</var> offsets are
1623omitted, a set of tiles of the specified geometry, covering the entire input
1624image, is generated. The rightmost tiles and the bottom tiles are smaller if
1625the specified geometry extends beyond the dimensions of the input image.</p>
1626
1627<p>You can add the <var>@</var> to the geometry argument to equally divide the image into the number of tiles generated.</p>
1628
1629<p>By adding a exclamation character flag to the geometry argument, the
1630cropped images virtual canvas page size and offset is set as if the
1631geometry argument was a viewport or window. This means the canvas page size
1632is set to exactly the same size you specified, the image offset set
1633relative top left corner of the region cropped. </p>
1634
1635<p>If the cropped image 'missed' the actual image on its virtual canvas, a
1636special single pixel transparent 'missed' image is returned, and a 'crop
1637missed' warning given. </p>
1638
Cristy594d2772015-11-15 10:47:42 -05001639<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 -04001640cropping the image to ensure the crop coordinate frame is relocated to the
1641upper-left corner of the visible image.
1642
Cristy594d2772015-11-15 10:47:42 -05001643Similarly you may want to use <a href="command-line-options.html#repage" >+repage</a> after cropping to
Cristy882d9f42015-10-29 16:48:39 -04001644remove the page offset that will be left behind. This is especially true when
1645you are going to write to an image format such as PNG that supports an image
1646offset.</p>
1647
1648<div style="margin: auto;">
1649 <h3 class="magick-header"><a id="cycle"></a>-cycle <var>amount</var></h3>
1650</div>
1651
1652<p class="magick-description">displace image colormap by amount.</p>
1653
1654<p><var>Amount</var> defines the number of positions each
1655colormap entry is shifted.</p>
1656
1657
1658<div style="margin: auto;">
1659 <h3 class="magick-header"><a id="debug"></a>-debug <var>events</var></h3>
1660</div>
1661
1662<p class="magick-description">enable debug printout.</p>
1663
1664<p>The <code>events</code> parameter specifies which events are to be logged. It
1665can be either <code>None</code>, <code>All</code>, <code>Trace</code>, or
1666a comma-separated list consisting of one or more of the following domains:
1667<code>Accelerate</code>, <code>Annotate</code>, <code>Blob</code>, <code>Cache</code>,
1668<code>Coder</code>, <code>Configure</code>, <code>Deprecate</code>,
1669<code>Exception</code>, <code>Locale</code>, <code>Render</code>,
1670<code>Resource</code>, <code>Security</code>, <code>TemporaryFile</code>,
1671<code>Transform</code>, <code>X11</code>, or <code>User</code>. </p>
1672
1673
1674<p>For example, to log cache and blob events, use.</p>
1675
1676<pre>
1677convert -debug "Cache,Blob" rose: rose.png
1678</pre>
1679
1680<p>The <code>User</code> domain is normally empty, but developers can log user
1681events in their private copy of ImageMagick.</p>
1682
1683<p>To print the complete list of debug methods, use <a href="command-line-options.html#list">-list
1684debug</a>.</p>
1685
1686<p>Use the <a href="command-line-options.html#log">-log</a> option to specify the format for debugging
1687output.</p>
1688
1689<p>Use <a href="command-line-options.html#debug">+debug</a> to turn off all logging.</p>
1690
Cristy594d2772015-11-15 10:47:42 -05001691<p>Debugging may also be set using the <code>MAGICK_DEBUG</code> <a href="resources.html#environment"
1692>environment variable</a>. The allowed values for the <code>MAGICK_DEBUG</code>
Cristy882d9f42015-10-29 16:48:39 -04001693environment variable are the same as for the <a href="command-line-options.html#debug">-debug</a>
1694option.</p>
1695
1696
1697<div style="margin: auto;">
1698 <h3 class="magick-header"><a id="decipher"></a>-decipher <var>filename</var></h3>
1699</div>
1700
1701<p class="magick-description">Decipher and restore pixels that were previously transformed by <a href="command-line-options.html#encipher">-encipher</a>.</p>
1702
1703<p>Get the passphrase from the file specified by <var>filename</var>.</p>
1704
Cristy594d2772015-11-15 10:47:42 -05001705<p>For more information, see the webpage, <a
Cristy6549abb2016-11-10 08:25:55 -05001706href="https://www.imagemagick.org/script/cipher.html">ImageMagick: Encipher or
Cristy882d9f42015-10-29 16:48:39 -04001707Decipher an Image</a>.</p>
1708
1709
1710<div style="margin: auto;">
1711 <h3 class="magick-header"><a id="deconstruct"></a>-deconstruct</h3>
1712</div>
1713
1714<p class="magick-description">find areas that has changed between images </p>
1715
Cristy594d2772015-11-15 10:47:42 -05001716<p>Given a sequence of images all the same size, such as produced by <a
1717href="command-line-options.html#coalesce">-coalesce</a>, replace the second and later images, with
Cristy882d9f42015-10-29 16:48:39 -04001718a smaller image of just the area that changed relative to the previous image.
1719</p>
1720
1721<p>The resulting sequence of images can be used to optimize an animation
1722sequence, though will not work correctly for GIF animations when parts of the
1723animation can go from opaque to transparent. </p>
1724
1725<p>This option is actually equivalent to the <a href="command-line-options.html#layers">-layers</a>
1726method '<code>compare-any</code>'. </p>
1727
1728
1729<div style="margin: auto;">
1730 <h3 class="magick-header"><a id="define"></a>-define <var>key</var>{<var>=value</var>}<var>...</var></h3>
1731</div>
1732
1733<p class="magick-description">add specific global settings generally used to control coders and image processing operations.</p>
1734
1735<p>This option creates one or more definitions for coders and decoders to use
1736while reading and writing image data. Definitions are generally used to
1737control image file format coder modules, and image processing operations,
Cristy594d2772015-11-15 10:47:42 -05001738beyond what is provided by normal means. Defined settings are listed in <a
1739href="command-line-options.html#verbose" >-verbose</a> information ("<code>info:</code>" output format)
Cristy882d9f42015-10-29 16:48:39 -04001740as "Artifacts". </p>
1741
1742<p>If <var>value</var> is missing for a definition, an empty-valued
1743definition of a flag is created with that name. This used to control on/off
1744options. Use <a href="command-line-options.html#define">+define key</a> to remove definitions
1745previously created. Use <a href="command-line-options.html#define">+define "*"</a> to remove all
1746existing definitions.</p>
1747
Cristy594d2772015-11-15 10:47:42 -05001748<p>The same 'artifact' settings can also be defined using the <a
1749href="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 -04001750Properties</a> in the defined value. </p>
1751
1752<p>The <var>option</var> and <var>key</var> are case-independent (they are
1753converted to lowercase for use within the decoders) while the <var>value</var>
1754is case-dependent.</p>
1755
1756<p>Such settings are global in scope, and affect all images and operations. </p>
1757
1758<p>The following definitions are just some of the artifacts that are
1759available:</p>
1760
1761<table class="table table-condensed table-striped">
1762 <tr>
Cristye0779712016-07-30 17:25:22 -04001763 <td>bmp:alpha=<var>true|false</var></td>
1764 <td>include any alpha channel when writing in the BMP image format.</td>
1765 </tr>
1766
1767 <tr>
Cristy882d9f42015-10-29 16:48:39 -04001768 <td>bmp:format=<var>value</var></td>
1769 <td> valid values are <var>bmp2</var>, <var>bmp3</var>,
1770 and <var>bmp4</var>. This option can be useful when the
1771 method of prepending "BMP2:" to the output filename is inconvenient or
1772 is not available, such as when using the <a href="mogrify.html">mogrify</a> utility.</td>
1773 </tr>
1774
1775 <tr>
1776 <td>colorspace:auto-grayscale=<var>on|off</var></td>
1777 <td>prevent automatic conversion to grayscale inside coders that support
1778 grayscale. This should be accompanied by -type truecolor. PNG and TIF do
1779 not need this define. With PNG, just use PNG24:image. With TIF, just use
1780 -type truecolor. JPG and PSD will need this define.</td>
1781 </tr>
1782
1783 <tr>
1784 <td>complex:snr=<var>value</var></td>
1785 <td>Set the divide SNR constant<a href="command-line-options.html#complex">-complex</a></td>
1786 </tr>
1787
1788 <tr>
1789 <td>compose:args=<var>arguments</var></td>
1790 <td>Sets certain compose argument values when using convert ... -compose ...
Cristy1f1f3a02016-06-01 07:25:42 -04001791 -composite. See <a href="compose.html"
Cristy594d2772015-11-15 10:47:42 -05001792 >Image Composition</a></td>
Cristy882d9f42015-10-29 16:48:39 -04001793 </tr>
1794
1795 <tr>
1796 <td>compose:clamp=<var>on|off</var></td>
Cristybc232422016-11-22 07:46:18 -05001797 <td>set each pixel whose value is below zero to zero and any the pixel
1798 whose value is above the quantum range to the quantum range (e.g. 65535)
1799 otherwise the pixel value remains unchanged. Define supported in
1800 ImageMagick 6.9.1-3 and above.</td>
Cristy882d9f42015-10-29 16:48:39 -04001801 </tr>
1802
1803 <tr>
Cristyde27d762016-01-02 12:56:44 -05001804 <td>connected-components:area-threshold=<var>value</var></td>
1805 <td>Merges any region with area smaller than <var>value</var> into its surrounding region or largest neighbor.</td>
1806 </tr>
1807
1808 <tr>
1809 <td>connected-components:keep=<var>list-of-ids</var></td>
Cristybc232422016-11-22 07:46:18 -05001810 <td>Comma and/or hyphenated list of id values to keep in the output.
1811 Supported in Imagemagick 6.9.3-0.</td>
Cristyde27d762016-01-02 12:56:44 -05001812 </tr>
1813
1814 <tr>
1815 <td>connected-components:mean-color=<var>true</var></td>
Cristybc232422016-11-22 07:46:18 -05001816 <td>Changes the output image from id values to mean color values. Supported
1817 in Imagemagick 6.9.2-8.</td>
Cristyde27d762016-01-02 12:56:44 -05001818 </tr>
1819
1820 <tr>
1821 <td>connected-components:remove=<var>list-of-ids</var></td>
Cristybc232422016-11-22 07:46:18 -05001822 <td>Comma and/or hyphenated list of id values to remove from the output.
1823 Supported in Imagemagick 6.9.2-9.</td>
Cristyde27d762016-01-02 12:56:44 -05001824 </tr>
1825
1826 <tr>
1827 <td>connected-components:verbose=<var>true</var></td>
1828 <td>Lists id, bounding box, centroid, area, mean color for each region.</td>
1829 </tr>
1830
1831 <tr>
Cristy882d9f42015-10-29 16:48:39 -04001832 <td>convolve:scale=<var>{kernel_scale}[!^] [,{origin_addition}] [%]</var></td>
1833 <td>Defines the kernel scaling. The special flag ! automatically scales to
1834 full dynamic range. The ! flag can be used in combination with a factor or
1835 percent. The factor or percent is then applied after the automatic scaling.
1836 An example is 50%!. This produces a result 50% darker than full dynamic
1837 range scaling. The ^ flag assures the kernel is 'zero-summing', for
1838 example when some values are positive and some are negative as in edge
1839 detection kernels. The origin addition adds that value to the center
1840 pixel of the kernel. This produces and effect that is like adding the image
1841 that many times to the result of the filtered image. The typical value
1842 is 1 so that the original image is added to the result of the convolution.
1843 The default is 0.</td>
1844 </tr>
1845
1846 <tr>
1847 <td>convolve:showkernel=<var>1</var></td>
Cristy594d2772015-11-15 10:47:42 -05001848 <td>Outputs (to 'standard error') all the information about a specified <a
1849 href="command-line-options.html#morphology" >-morphology convolve</a> kernel.</td>
Cristy882d9f42015-10-29 16:48:39 -04001850 </tr>
1851
1852 <tr>
1853 <td>dcm:display-range=<var>reset</var></td>
1854 <td>Sets the display range to the minimum and maximum pixel values for the
1855 DCM image format.</td>
1856 </tr>
1857
1858 <tr>
1859 <td>dds:cluster-fit=<var>true|false</var></td>
1860 <td>Enables the dds cluster-fit.</td>
1861 </tr>
1862
1863 <tr>
1864 <td>dds:compression=<var>dxt1|dxt5|none</var></td>
1865 <td>Sets the dds compression.</td>
1866 </tr>
1867
1868 <tr>
1869 <td>dds:mipmaps=<var>value</var></td>
1870 <td>Sets the dds number of mipmaps.</td>
1871 </tr>
1872
1873 <tr>
Cristy3b0b58d2016-11-06 07:40:23 -05001874 <td>dds:weight-by-alpha=<var>true|false</var></td>
Cristy882d9f42015-10-29 16:48:39 -04001875 <td>Enables the dds alpha weighting.</td>
1876 </tr>
1877
1878 <tr>
Cristy3b0b58d2016-11-06 07:40:23 -05001879 <td>deskew:auto-crop=<var>true</var></td>
1880 <td>auto crop the image after deskewing.</td>
1881 </tr>
1882
1883 <tr>
Cristy882d9f42015-10-29 16:48:39 -04001884 <td>delegate:bimodal=<var>true</var></td>
1885 <td>Specifies direct conversion from Postscript to PDF.</td>
1886 </tr>
1887
1888 <tr>
1889 <td>distort:scale=<var>value</var></td>
Cristy594d2772015-11-15 10:47:42 -05001890 <td>Sets the output scaling factor for use with <a href="command-line-options.html#distort"
1891 >-distort</a></td>
Cristy882d9f42015-10-29 16:48:39 -04001892 </tr>
1893
1894 <tr>
1895 <td>distort:viewport=<var>WxH+X+Y</var></td>
1896 <td>Sets the viewport for use with <a href="command-line-options.html#distort">-distort</a></td>
1897 </tr>
1898
1899 <tr>
1900 <td>dot:layout-engine=<var>value</var></td>
1901 <td>Specifies the layout engine for the DOT image format (e.g.
1902 <code>neato</code>).</td>
1903 </tr>
1904
1905 <tr>
1906 <td>filter:option=<var>value</var></td>
1907 <td>Set a filter option for use with <a href="command-line-options.html#resize">-resize</a>.
1908 See <a href="command-line-options.html#filter">-filter</a> for details.</td>
1909 </tr>
1910
1911 <tr>
1912 <td>fourier:normalize=<var>inverse</var></td>
1913 <td>Sets the location for the FFT/IFT normalization as use by
1914 <a href="command-line-options.html#fft">+-fft</a> and <a href="command-line-options.html#ift">+-ift</a>. The default is
1915 <var>forward</var>.</td>
1916 </tr>
1917
1918 <tr>
1919 <td>h:format=<var>value</var></td>
1920 <td>Set the image encoding format use when writing a C-style header.
1921 <var>format</var> can be any output format supported by ImageMagick
1922 except for <var>h</var> and <var>magick</var></td>. If this
1923 option is omitted, the default is <var>GIF</var> for PseudoClass
1924 images and <var>PNM</var> for DirectClass images.
1925 </tr>
1926
1927 <tr>
1928 <td>icon:auto-resize</td>
1929 <td>Automatically stores multiple sizes when writing an ico image
1930 (requires a 256x256 input image).</td>
1931 </tr>
1932
1933 <tr>
1934 <td>jp2:layer-number=<var>value</var></td>
1935 <td>Sets the maximum number of quality layers to decode. Same for JPT, JC2,
1936 and J2K</td>
1937 </tr>
1938
1939 <tr>
1940 <td>jp2:number-resolutions=<var>value</var></td>
Cristybc232422016-11-22 07:46:18 -05001941 <td>Sets the number of resolutions to encode.Same for JPT, JC2, and
1942 J2K</td>
Cristy882d9f42015-10-29 16:48:39 -04001943 </tr>
1944
1945 <tr>
1946 <td>jp2:progression-order=<var>value</var></td>
1947 <td>choose from LRCP, RLCP, RPCL, PCRL or CPRL. Same for JPT, JC2, and
1948 J2K</td>
1949 </tr>
1950
1951 <tr>
1952 <td>jp2:quality=<var>value,value...</var></td>
1953 <td>Sets the quality layer PSNR, given in dB. The order is from left to
1954 right in ascending order. The default is a single lossless quality layer.
1955 Same for JPT, JC2, and J2K</td>
1956 </tr>
1957
1958 <tr>
1959 <td>jp2:rate=<var>value</var></td>
Cristybc232422016-11-22 07:46:18 -05001960 <td>Specify the compression factor to use while writing JPEG-2000 files.
1961 The compression factor is the reciprocal of the compression ratio. The
1962 valid range is 0.0 to 1.0, with 1.0 indicating lossless compression. If
1963 defined, this value overrides the -quality setting. A quality setting
1964 of 75 results in a rate value of 0.06641. Same for JPT, JC2, and J2K</td>
Cristy882d9f42015-10-29 16:48:39 -04001965 </tr>
1966
1967 <tr>
1968 <td>jp2:reduce-factor=<var>value</var></td>
1969 <td>Sets the number of highest resolution levels to be discarded.Same for
1970 JPT, JC2, and J2K</td>
1971 </tr>
1972
1973 <tr>
1974 <td>jpeg:block-smoothing=<var>on|off</var></td>
Cristybc232422016-11-22 07:46:18 -05001975 <td> </td>
Cristy882d9f42015-10-29 16:48:39 -04001976 </tr>
1977
1978 <tr>
1979 <td>jpeg:colors=<var>value</var></td>
1980 <td>Set the desired number of colors and let the JPEG encoder do the
1981 quantizing.</td>
1982 </tr>
1983
1984 <tr>
1985 <td>jpeg:dct-method=<var>value</var></td>
1986 <td>Choose from <code>default</code>, <code>fastest</code>,
1987 <code>float</code>, <code>ifast</code>, and <code>islow</code>.</td>
1988 </tr>
1989
1990 <tr>
1991 <td>jpeg:extent=<var>value</var></td>
1992 <td>Restrict the maximum JPEG file size, for example <code>-define
1993 jpeg:extent=400KB</code>. The JPEG encoder will search for the highest
1994 compression quality level that results in an output file that does not
Cristye93be682015-11-26 09:07:51 -05001995 exceed the value. The <code>-quality</code> option also will be respected
1996 starting with version 6.9.2-5. Between 6.9.1-0 and 6.9.2-4, add -quality
1997 100 in order for the jpeg:extent to work properly. Prior to 6.9.1-0, the
1998 -quality setting was ignored.</td>
Cristy882d9f42015-10-29 16:48:39 -04001999 </tr>
2000
2001 <tr>
2002 <td>jpeg:fancy-upsampling=<var>on|off</var></td>
Cristybc232422016-11-22 07:46:18 -05002003 <td> </td>
Cristy882d9f42015-10-29 16:48:39 -04002004 </tr>
2005
2006 <tr>
2007 <td>jpeg:optimize-coding=<var>on|off</var></td>
Cristybc232422016-11-22 07:46:18 -05002008 <td> </td>
Cristy882d9f42015-10-29 16:48:39 -04002009 </tr>
2010
2011 <tr>
2012 <td>jpeg:q-table=<var>table</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:sampling-factor=<var>sampling-factor-string</var></td>
Cristybc232422016-11-22 07:46:18 -05002018 <td> </td>
Cristy882d9f42015-10-29 16:48:39 -04002019 </tr>
2020
2021 <tr>
2022 <td>jpeg:size=<var>geometry</var></td>
2023 <td>Set the size hint of a JPEG image, for
2024 example, <code>-define jpeg:size=128x128</code>.
2025 It is most useful for increasing performance and reducing the memory
2026 requirements when reducing the size of a large JPEG image.</td>
2027 </tr>
2028
2029 <tr>
2030 <td>json:features</td>
2031 <td>includes features in verbose information</td>
2032 </tr>
2033
2034 <tr>
2035 <td>json:limit</td>
Cristybc232422016-11-22 07:46:18 -05002036 <td> </td>
Cristy882d9f42015-10-29 16:48:39 -04002037 </tr>
2038
2039 <tr>
2040 <td>json:locate</td>
Cristybc232422016-11-22 07:46:18 -05002041 <td> </td>
Cristy882d9f42015-10-29 16:48:39 -04002042 </tr>
2043
2044 <tr>
2045 <td>json:moments</td>
2046 <td>includes image moments in verbose information</td>
2047 </tr>
2048
2049 <tr>
2050 <td>magick:format=<var>value</var></td>
2051 <td>Set the image encoding format use when writing a C-style header.
2052 This is the same as "h:format=format" described above.</td>.
2053 </tr>
2054
2055 <tr>
2056 <td>mng:need-cacheoff</td>
2057 <td>turn playback caching off for streaming MNG.</td>
2058 </tr>
2059
2060 <tr>
2061 <td>morphology:compose=<var>compose-method</var></td>
Cristy594d2772015-11-15 10:47:42 -05002062 <td>Specifies how to merge results generated by multiple<a
2063 href="command-line-options.html#morphology" >-morphology</a> kernel. The default is none. One
Cristy882d9f42015-10-29 16:48:39 -04002064 typical value is 'lighten' as used, for example, with the sobel edge
2065 kernels. </td>
2066 </tr>
2067
2068 <tr>
2069 <td>morphology:showkernel=<var>1</var></td>
Cristy594d2772015-11-15 10:47:42 -05002070 <td>Outputs (to 'standard error') all the information about a generated <a
2071 href="command-line-options.html#morphology" >-morphology</a> kernel.</td>
Cristy882d9f42015-10-29 16:48:39 -04002072 </tr>
2073
2074 <tr>
2075 <td>pcl:fit-to-page=<var>true</var></td>
2076
Cristy594d2772015-11-15 10:47:42 -05002077 <tr>
Cristy882d9f42015-10-29 16:48:39 -04002078 <td>pdf:fit-page=<var>geometry</var></td>
2079 <td> geometry specifies the scaling dimensions for resizing when the PDF is
2080 being read. The geometry is either WxH{%} or page size. No offsets are
2081 allowed. (introduced in IM 6.8.8-8)</td>
2082 </tr>
2083
2084 <tr>
2085 <td>pdf:fit-to-page=<var>true</var></td>
Cristybc232422016-11-22 07:46:18 -05002086 <td> </td>
Cristy882d9f42015-10-29 16:48:39 -04002087 </tr>
2088
2089 <tr>
2090 <td>pdf:use-cropbox=<var>true</var></td>
Cristybc232422016-11-22 07:46:18 -05002091 <td> </td>
Cristy882d9f42015-10-29 16:48:39 -04002092 </tr>
2093
2094 <tr>
2095 <td>pdf:use-trimbox=<var>true</var></td>
Cristybc232422016-11-22 07:46:18 -05002096 <td> </td>
Cristy882d9f42015-10-29 16:48:39 -04002097 </tr>
2098
2099 <tr>
Cristy3b0b58d2016-11-06 07:40:23 -05002100 <td>phash:colorspaces=<var>colorspace,colorspace,...</var></td>
Cristybc232422016-11-22 07:46:18 -05002101 <td>the perceptual hash defaults to the sRGB and HCLp colorspaces. When
2102 using this define, you can specify up to six alternative colorspaces. (as
2103 of IM 7.0.3-8)</td>
2104 </tr>
2105
2106 <tr>
2107 <td>phash:normalize=<var>true</var></td>
2108 <td>normalizes the phash metric by dividing by the number of channels
2109 specified by <code>-define phash:colorspaces</code> when using compare
2110 -metric phash. (as of IM 7.0.3-8)</td>
Cristy3b0b58d2016-11-06 07:40:23 -05002111 </tr>
2112
2113 <tr>
Cristy882d9f42015-10-29 16:48:39 -04002114 <td>png:bit-depth=<var>value</var></td>
Cristybc232422016-11-22 07:46:18 -05002115 <td> </td>
Cristy882d9f42015-10-29 16:48:39 -04002116 </tr>
Cristy3b0b58d2016-11-06 07:40:23 -05002117
Cristy882d9f42015-10-29 16:48:39 -04002118 <tr>
2119 <td>png:color-type=<var>value</var></td>
2120 <td>desired bit-depth and color-type for PNG output. You can force the PNG
2121 encoder to use a different bit-depth and color-type than it would have
2122 normally selected, but only if this does not cause any loss of image
2123 quality. Any attempt to reduce image quality is treated as an error and no
2124 PNG file is written. E.g., if you have a 1-bit black-and-white image, you
2125 can use these "defines" to cause it to be written as an 8-bit grayscale,
2126 indexed, or even a 64-bit RGBA. But if you have a 16-million color image,
2127 you cannot force it to be written as a grayscale or indexed PNG. If you
2128 wish to do this, you must use the appropriate <a href="command-line-options.html#depth">-depth</a>,
2129 <a href="command-line-options.html#colors">-colors</a>, or <a href="command-line-options.html#type">-type</a> directives to
2130 reduce the image quality prior to using the PNG encoder. Note that in
2131 indexed PNG files, "bit-depth" refers to the number of bits per index,
2132 which can be 1, 2, 4, or 8. In such files, the color samples always have
2133 8-bit depth.</td>
2134 </tr>
2135
2136 <tr>
2137 <td>png:compression-filter=<var>value</var></td>
2138 <td> valid values are 0 through 9. 0-4 are the corresponding PNG filters,
2139 5 means adaptive filtering except for images with a colormap, 6 means
2140 adaptive filtering for all images, 7 means MNG "loco" compression, 8 means
2141 Z_RLE strategy with adaptive filtering, and 9 means Z_RLE strategy with no
2142 filtering.</td>
2143 </tr>
2144
2145 <tr>
2146 <td>png:compression-level=<var>value</var></td>
2147 <td> valid values are 0 through 9, with 0 providing the least but fastest
2148 compression and 9 usually providing the best and always the slowest.</td>
2149 </tr>
2150
2151 <tr>
2152 <td>png:compression-strategy=<var>value</var></td>
2153 <td> valid values are 0 through 4, meaning default, filtered, huffman_only,
2154 rle, and fixed ZLIB compression strategy. If you are using an old zlib
2155 that does not support Z_RLE (before 1.2.0) or Z_FIXED (before 1.2.2.2),
2156 values 3 and 4, respectively, will use the zlib default strategy
2157 instead.</td>
2158 </tr>
2159
2160 <tr>
2161 <td>png:format=<var>value</var></td>
2162 <td> valid values are <var>png8</var>, <var>png24</var>,
2163 <var>png32</var>, <var>png48</var>,
2164 <var>png64</var>, and <var>png00</var>.
2165 This property can be useful for specifying
2166 the specific PNG format to be used, when the usual method of prepending the
2167 format name to the output filename is inconvenient, such as when writing
2168 a PNG-encoded ICO file or when using <a href="mogrify.html">mogrify</a>.
2169 Value = <var>png8</var> reduces the number of colors to 256,
2170 only one of which may be fully transparent, if necessary. The other
2171 values do not force any reduction of quality; it is an error to request
2172 a format that cannot represent the image data without loss (except that
2173 it is allowed to reduce the bit-depth from 16 to 8 for all formats).
2174 Value = <var>png24</var> and <var>png48</var>
2175 allow transparency, only if a single color is fully transparent and that
2176 color does not also appear in an opaque pixel; such transparency is
2177 written in a PNG <code>tRNS</code> chunk.
2178 Value = <var>png00</var> causes the image to inherit its
2179 color-type and bit-depth from the input image, if the input was also
2180 a PNG.</td>
2181 </tr>
2182
2183 <tr>
2184 <td>png:exclude-chunk=<var>value</var></td>
2185
Cristy594d2772015-11-15 10:47:42 -05002186 <tr>
Cristy882d9f42015-10-29 16:48:39 -04002187 <td>png:include-chunk=<var>value</var></td>
2188 <td>ancillary chunks to be excluded from or included in PNG output.
2189
2190 <p>The <var>value</var> can be the name of a PNG chunk-type such
2191 as <var>bKGD</var>, a comma-separated list of chunk-names
2192 (which can include the word <var>date</var>, the word
2193 <var>all</var>, or the word <var>none</var>).
2194 Although PNG chunk-names are case-dependent, you can use all lowercase
2195 names if you prefer.</p>
2196
2197 <p>The "include-chunk" and "exclude-chunk" lists only affect the behavior
2198 of the PNG encoder and have no effect on the PNG decoder.</p>
2199
2200 <p>As a special case, if the <code>sRGB</code> chunk is excluded and
2201 the <code>gAMA</code> chunk is included, the <code>gAMA</code> chunk will
2202 only be written if gamma is not 1/2.2, since most decoders assume
2203 sRGB and gamma=1/2.2 when no colorspace information is included in
2204 the PNG file. Because the list is processed from left to right, you
2205 can achieve this with a single define:</p>
2206
2207<pre>
2208-define png:include-chunk=none,gAMA
2209</pre>
2210
2211 <p>As a special case, if the <code>sRGB</code> chunk is not excluded and
2212 the PNG encoder recognizes that the image contains the sRGB ICC profile,
2213 the PNG encoder will write the <code>sRGB</code> chunk instead of the
2214 entire ICC profile. To force the PNG encoder to write the sRGB
2215 profile as an <code>iCCP</code> chunk in the output PNG instead of the
2216 <code>sRGB</code> chunk, exclude the <code>sRGB</code> chunk.</p>
2217
2218 <p>The critical PNG chunks <code>IHDR</code>, <code>PLTE</code>,
2219 <code>IDAT</code>, and <code>IEND</code> cannot be excluded. Any such
2220 entries appearing in the list will be ignored.</p>
2221
2222 <p>If the ancillary PNG <code>tRNS</code> chunk is excluded and the
2223 image has transparency, the PNG colortype is forced to be 4 or 6
2224 (GRAY_ALPHA or RGBA). If the image is not transparent, then the
2225 <code>tRNS</code> chunk isn't written anyhow, and there is no effect
2226 on the PNG colortype of the output image.</p>
2227
2228 <p>The <a href="command-line-options.html#strip">-strip</a> option does the equivalent of the
2229 following for PNG output:</p>
2230
2231<pre>
2232-define png:exclude-chunk=EXIF,iCCP,iTXt,sRGB,tEXt,zCCP,zTXt,date
2233</pre>
2234
2235 <p>The default behavior is to include all known PNG ancillary chunks
2236 plus ImageMagick's private <code>vpAg</code> ("virtual page") chunk,
2237 and to exclude all PNG chunks that are unknown to ImageMagick,
2238 regardless of their PNG "copy-safe" status as described in the
2239 PNG specification.</p>
2240
2241 <p>Any chunk names that are not known to ImageMagick are ignored
2242 if they appear in either the "include-chunk" or "exclude-chunk" list.
2243 The ancillary chunks currently known to ImageMagick are
2244 <code>bKGD</code>, <code>cHRM</code>, <code>gAMA</code>, <code>iCCP</code>,
2245 <code>oFFs</code>, <code>pHYs</code>, <code>sRGB</code>, <code>tEXt</code>,
2246 <code>tRNS</code>, <code>vpAg</code>, and <code>zTXt</code>.</p>
2247
2248 <p>You can also put <code>date</code> in the list to include or exclude
2249 the "Date:create" and "Date:modify" text chunks that ImageMagick normally
2250 inserts in the output PNG.</p></td>
2251 </tr>
2252
2253 <tr>
2254 <td>png:preserve-colormap[=<var>true</var>]</td>
Cristy594d2772015-11-15 10:47:42 -05002255 <td>Use the existing image->colormap. Normally the PNG encoder will
Cristy882d9f42015-10-29 16:48:39 -04002256 try to optimize the palette, eliminating unused entries and putting
2257 the transparent colors first. If this flag is set, that behavior
2258 is suppressed.</td>
2259 </tr>
2260
2261 <tr>
2262 <td>png:preserve-iCCP[=<var>true</var>]</td>
2263 <td>By default, the PNG decoder and encoder examine any ICC profile
2264 that is present, either from an <code>iCCP</code> chunk in the PNG
2265 input or supplied via an option, and if the profile is recognized
2266 to be the sRGB profile, converts it to the <code>sRGB</code> chunk.
2267 You can use <code>-define png:preserve-iCCP</code> to prevent
2268 this from happening; in such cases the <code>iCCP</code> chunk
2269 will be read or written and no <code>sRGB</code> chunk will be
2270 written. There are some ICC profiles that claim to be sRGB but
2271 have various errors that cause them to be rejected by libpng16; such
2272 profiles are recognized anyhow and converted to the <code>sRGB</code>
2273 chunk, but are rejected if the <code>-define png:preserve-iCCP</code>
2274 is present. Note that not all "sRGB" ICC profiles are recognized
2275 yet; we will add them to the list as we encounter them.</td>
2276 </tr>
2277
2278 <tr>
2279 <td>png:swap-bytes[=<var>true</var>]</td>
2280 <td>The PNG specification requires that any multi-byte integers be stored in
2281 network byte order (MSB-LSB endian). This option allows you to
2282 fix any invalid PNG files that have 16-bit samples stored incorrectly
2283 in little-endian order (LSB-MSB). The "-define png:swap-bytes" option
2284 must appear before the input filename on the commandline. The swapping
2285 is done during the libpng decoding operation.</td>
2286 </tr>
2287
2288 <tr>
2289 <td>profile:skip=<var>name1,name2,...</var></td>
2290 <td>Skip the named profile[s] when reading the image. Use skip="*" to
2291 skip all named profiles in the image. Many named profiles exist,
2292 including ICC, EXIF, APP1, IPTC, XMP, and others.</td>
2293 </tr>
2294
2295 <tr>
2296 <td>ps:imagemask</td>
2297 <td>If the ps:imagemask flag is defined, the PS3 and EPS3 coders will
2298 create Postscript files that render bilevel images with the Postscript
2299 imagemask operator instead of the image operator.</td>
2300 </tr>
2301
2302 <tr>
Cristy3b0b58d2016-11-06 07:40:23 -05002303 <td>psd:additional-info=all|selective</td>
Cristybc232422016-11-22 07:46:18 -05002304 <td>This option should only be used when converting from a PSD file to
2305 another PSD file. This should be placed after the image is read. The two
2306 options are 'all' and 'selective'. The 'selective' option will preserve
2307 all additional information that is not related to the geometry of the
2308 image. The 'all' option should only be used when the geometry of the
2309 image has not been changed. This option is helpful when transferring
2310 non-simple layers, such as adjustment layers from the input PSD file to
2311 the output PSD file. If this option is not used, the additional
2312 information will not be preserved. This define is available as of
2313 Imagemagick version 6.9.5-8.
Cristy3b0b58d2016-11-06 07:40:23 -05002314</td>
2315 </tr>
2316
2317 <tr>
Cristy882d9f42015-10-29 16:48:39 -04002318 <td>psd:alpha-unblend=off</td>
2319 <td>Disables new automatic un-blending of transparency with the base image
2320 for the flattened layer 0 before adding the alpha channel to the output
2321 image. This define must be placed before the input psd image. (Available
2322 as of IM 6.9.2.5). The automatic un-blending is new to IM 6.9.2.5 and
2323 prevents the transparency from being applied twice in the output
Cristy3b0b58d2016-11-06 07:40:23 -05002324 image. This option should be set before reading the image.</td>
2325 </tr>
2326
2327 <tr>
2328 <td>psd:preserve-opacity-mask=true</td>
Cristybc232422016-11-22 07:46:18 -05002329 <td>This option should only be used when converting from a PSD file to
2330 another PSD file. It will preserve the opacity mask of a layer and add it
2331 back to the layer when the image is saved. Setting this to 'true' will
2332 enable this feature. This define is available as of Imagemagick version
2333 6.9.5-10.
Cristy3b0b58d2016-11-06 07:40:23 -05002334</td>
Cristy882d9f42015-10-29 16:48:39 -04002335 </tr>
2336
2337 <tr>
Cristy1f1f3a02016-06-01 07:25:42 -04002338 <td>preserve-timestamp=<var>{True, False}</var></td>
2339 <td>Preserve file timestamp (<code>mogrify</code> only).</td>
2340 </tr>
2341
2342 <tr>
Cristy882d9f42015-10-29 16:48:39 -04002343 <td>quantum:format=<var>type</var></td>
2344 <td>Set the type to <code>floating-point</code> to specify a floating-point
2345 format for raw files (e.g. GRAY:) or for MIFF and TIFF images in HDRI mode
2346 to preserve negative values. If <a href="command-line-options.html#depth">-depth</a> 16 is
2347 included, the result is a single precision floating point format.
2348 If <a href="command-line-options.html#depth">-depth</a> 32 is included, the result is
2349 double precision floating point format.</td>
2350 </tr>
2351
2352 <tr>
2353 <td>quantum:polarity=<var>photometric-interpretation</var></td>
Cristybc232422016-11-22 07:46:18 -05002354 <td>Set the photometric-interpretation of an image (typically for TIFF
2355 image file format) to either <code>min-is-black</code> (default) or
Cristy882d9f42015-10-29 16:48:39 -04002356 <code>min-is-white</code>.</td>
2357 </tr>
2358
2359 <tr>
2360 <td>sample:offset=<var>geometry</var></td>
2361 <td>Location of the sampling point within the sub-region being sampled,
Cristy594d2772015-11-15 10:47:42 -05002362 expressed as percentages (see <a href="command-line-options.html#sample" >-sample</a>).</td>
Cristy882d9f42015-10-29 16:48:39 -04002363 </tr>
2364
2365 <tr>
2366 <td>showkernel=<var>1</var></td>
Cristy594d2772015-11-15 10:47:42 -05002367 <td>Outputs (to 'standard error') all the information about a generated <a
2368 href="command-line-options.html#morphology" >-morphology</a> kernel.</td>
Cristy882d9f42015-10-29 16:48:39 -04002369 </tr>
2370
2371 <tr>
2372 <td>stream:buffer-size=<var>value</var></td>
2373 <td>Set the stream buffer size. Select 0 for unbuffered I/O.</td>
2374 </tr>
2375
2376 <tr>
2377 <td>tiff:alpha=<var>associated|unassociated|unspecified</var></td>
Cristybc232422016-11-22 07:46:18 -05002378 <td>Specify the alpha extra samples as associated, unassociated or
2379 unspecified </td>
Cristy882d9f42015-10-29 16:48:39 -04002380 </tr>
2381
2382 <tr>
2383 <td>tiff:endian=<var>msb|lsb</var></td>
Cristybc232422016-11-22 07:46:18 -05002384 <td> </td>
Cristy882d9f42015-10-29 16:48:39 -04002385 </tr>
2386
2387 <tr>
2388 <td>tiff:exif-properties=<var>false</var></td>
2389 <td>Skips reading the EXIF properties.</td>
2390 </tr>
2391
2392 <tr>
2393 <td>tiff:fill-order=<var>msb|lsb</var></td>
Cristybc232422016-11-22 07:46:18 -05002394 <td> </td>
Cristy882d9f42015-10-29 16:48:39 -04002395 </tr>
2396
2397 <tr>
2398 <td>tiff:ignore-layers=<var>true</var></td>
2399 <td>Ignores the photoshop layers.</td>
2400 </tr>
2401
2402 <tr>
2403 <td>tiff:ignore-tags=<var>comma-separate-list-of-tag-IDs</var></td>
2404 <td>Allows one or more tag ID values to be ignored.</td>
2405 </tr>
2406
2407 <tr>
2408 <td>tiff:rows-per-strip=<var>value</var></td>
2409 <td>Sets the number of rows per strip</td>
2410 </tr>
2411
2412 <tr>
2413 <td>tiff:tile-geometry=<var>WxH</var></td>
2414 <td>Sets the tile size for pyramid tiffs. Requires the suffix
2415 PTIF: before the outputname</td>
2416 </tr>
Cristye09ed312016-03-06 08:07:39 -05002417
2418 <tr>
2419 <td>type:features=<var>string</var></td>
Cristybc232422016-11-22 07:46:18 -05002420 <td> </td>
Cristye09ed312016-03-06 08:07:39 -05002421 </tr>
2422
2423 <tr>
2424 <td>type:hinting=<var>off</var></td>
Cristybc232422016-11-22 07:46:18 -05002425 <td> </td>
Cristye09ed312016-03-06 08:07:39 -05002426 </tr>
Cristy882d9f42015-10-29 16:48:39 -04002427</table>
2428
2429<p>For example, to create a postscript file that will render only the black
2430pixels of a bilevel image, use:</p>
2431
2432<pre>
2433convert bilevel.tif -define ps:imagemask eps3:stencil.ps
2434</pre>
2435
2436<p>Set attributes of the image registry by prefixing the value with
2437<code>registry:</code>. For example, to set a temporary path to put work files,
2438use:</p>
2439
2440<pre>
2441-define registry:temporary-path=/data/tmp
2442</pre>
2443
2444<div style="margin: auto;">
Cristy594d2772015-11-15 10:47:42 -05002445 <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 -04002446</div>
2447
2448<p class="magick-description">display the next image after pausing.</p>
2449
2450<p>This option is useful for regulating the animation of image sequences
2451<var>ticks/ticks-per-second</var> seconds must expire before the display of the
2452next image. The default is no delay between each showing of the image
2453sequence. The default ticks-per-second is 100.</p>
2454
2455<p>Use <code>&gt;</code> to change the image delay <var>only</var> if its current
2456value exceeds the given delay. <code>&lt;</code> changes the image delay
2457<var>only</var> if current value is less than the given delay. For example, if
2458you specify <code>30&gt;</code> and the image delay is 20, the image delay does
2459not change. However, if the image delay is 40 or 50, the delay it is changed
2460to 30. Enclose the given delay in quotation marks to prevent the
2461<code>&lt;</code> or <code>&gt;</code> from being interpreted by your shell as
2462a file redirection.</p>
2463
2464
2465<div style="margin: auto;">
2466 <h3 class="magick-header"><a id="delete"></a>-delete <var>indexes</var></h3>
2467</div>
2468
2469<p class="magick-description">delete the images specified by index, from the image sequence.</p>
2470
2471<p>Specify the image by its index in the sequence. The first image is index
24720. Negative indexes are relative to the end of the sequence, for example, -1
2473represents the last image of the sequence. Specify a range of images with
2474a dash (e.g. 0-4). Separate indexes with a comma (e.g. 0,2). Use
Cristy912a9222016-06-17 15:37:28 -04002475<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 -04002476
2477
2478<div style="margin: auto;">
Cristy594d2772015-11-15 10:47:42 -05002479 <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 -04002480</div>
2481
2482<p class="magick-description">Set the horizontal and vertical resolution of an image for rendering to devices.</p>
2483
2484<p>This option specifies the image resolution to store while encoding a raster
2485image or the canvas resolution while rendering (reading) vector formats such
2486as Postscript, PDF, WMF, and SVG into a raster image. Image resolution
2487provides the unit of measure to apply when rendering to an output device or
Cristy594d2772015-11-15 10:47:42 -05002488raster image. The default unit of measure is in dots per inch (DPI). The <a
2489href="command-line-options.html#units">-units</a> option may be used to select dots per centimeter
Cristy882d9f42015-10-29 16:48:39 -04002490instead.</p>
2491
2492<p>The default resolution is 72 dots per inch, which is equivalent to one
2493point per pixel (Macintosh and Postscript standard). Computer screens are
2494normally 72 or 96 dots per inch, while printers typically support 150, 300,
2495600, or 1200 dots per inch. To determine the resolution of your display, use
2496a ruler to measure the width of your screen in inches, and divide by the
2497number of horizontal pixels (1024 on a 1024x768 display).</p>
2498
2499<p>If the file format supports it, this option may be used to update the
2500stored image resolution. Note that Photoshop stores and obtains image
2501resolution from a proprietary embedded profile. If this profile is not
2502stripped from the image, then Photoshop will continue to treat the image using
2503its former resolution, ignoring the image resolution specified in the standard
2504file header.</p>
2505
2506<p>The <a href="command-line-options.html#density">-density</a> option sets an <var>attribute</var> and
2507does not alter the underlying raster image. It may be used to adjust the
2508rendered size for desktop publishing purposes by adjusting the scale applied
2509to the pixels. To resize the image so that it is the same size at a different
2510resolution, use the <a href="command-line-options.html#resample">-resample</a> option.</p>
2511
2512<div style="margin: auto;">
2513 <h3 class="magick-header"><a id="depth"></a>-depth <var>value</var></h3>
2514</div>
2515
2516<p class="magick-description">depth of the image.</p>
2517
2518<p>This the number of bits in a color sample within a pixel. Use this option
2519to specify the depth of raw images whose depth is unknown such as GRAY, RGB,
2520or CMYK, or to change the depth of any image after it has been read.</p>
2521
2522<div style="margin: auto;">
2523 <h3 class="magick-header"><a id="descend"></a>-descend</h3>
2524</div>
2525
2526<p class="magick-description">obtain image by descending window hierarchy.</p>
2527
2528<div style="margin: auto;">
Cristy769d8892016-01-19 18:11:14 -05002529 <h3 class="magick-header"><a id="deskew"></a>-deskew <var>threshold{%}</var></h3>
Cristy882d9f42015-10-29 16:48:39 -04002530</div>
2531
2532<p class="magick-description">straighten an image. A threshold of 40% works for most images.</p>
2533
2534<p>Use <a href="command-line-options.html#set">-set</a> <code>option:deskew:auto-crop
Cristy3b0b58d2016-11-06 07:40:23 -05002535<var>true | false</var></code> to auto crop the image.</p>
Cristy882d9f42015-10-29 16:48:39 -04002536
2537<div style="margin: auto;">
2538 <h3 class="magick-header"><a id="despeckle"></a>-despeckle</h3>
2539</div>
2540
2541<p class="magick-description">reduce the speckles within an image.</p>
2542
2543<div style="margin: auto;">
2544 <h3 class="magick-header"><a id="direction"></a>-direction <var>type</var></h3>
2545</div>
2546
2547<p class="magick-description">render text right-to-left or left-to-right.</p>
2548
2549<div style="margin: auto;">
Cristy769d8892016-01-19 18:11:14 -05002550 <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 -04002551</div>
2552
2553<p class="magick-description">shift image pixels as defined by a displacement map.</p>
2554
2555<p>With this option, the 'overlay' image, and optionally the 'mask' image,
2556is used as a displacement map, which is used to displace the lookup of
2557what part of the 'background' image is seen at each point of the overlaid
2558area. Much like the displacement map is a 'lens' that redirects light shining
2559through it so as to present a distorted view the original 'background' image
2560behind it. </p>
2561
2562<p>Any perfect grey areas of the displacement map produce a zero
2563displacement of the image. Black areas produce the given maximum negative
2564displacement of the lookup point, while white produce a maximum positive
2565displacement of the lookup. </p>
2566
2567<p>Note that it is the lookup of the 'background' that is displaced, not a
2568displacement of the image itself. As such an area of the displacement map
2569containing 'white' will have the lookup point 'shifted' by a positive amount,
2570and thus generating a copy of the destination image to the right/downward from
2571the correct position. That is the image will look like it may have been
2572'shifted' in a negative left/upward direction. Understanding this is a very
2573important in understanding how displacement maps work. </p>
2574
2575<p>The given arguments define the maximum amount of displacement in pixels
2576that a particular map can produce. If the displacement scale is large enough
2577it is also possible to lookup parts of the 'background' image that lie well
2578outside the bounds of the displacement map itself. That is you could very
2579easily copy a section of the original image from outside the overlay area
2580into the overlay area. </p>
2581
2582<p>The '%' flag makes the displacement scale relative to the size of the
2583overlay image (100% = half width/height of image). Using '!' switches
2584percentage arguments to refer to the destination image size instead.
2585these flags were added as of IM v6.5.3-5.</p>
2586
2587<p>Normally a single grayscale displacement map is provided, which with the
2588given scaling values will determine a single direction (vector) in which
2589displacements can occur (positively or negatively). However, if you also
2590specify a third image which is normally used as a <var>mask</var>,
2591the <var>composite image</var> is used for horizontal X
2592displacement, while the <var>mask image</var> is used for vertical Y
2593displacement. This allows you to define completely different displacement
2594values for the X and Y directions, and allowing you to lookup any point within
2595the <var>scale</var> bounds. In other words each pixel can lookup
2596any other nearby pixel, producing complex 2 dimensional displacements, rather
2597than a simple 1 dimensional vector displacements. </p>
2598
2599<p>Alternatively rather than supplying two separate images, as of IM v6.4.4-0,
2600you can use the 'red' channel of the overlay image to specify the horizontal
2601or X displacement, and the 'green' channel for the vertical or Y displacement.
2602</p>
2603
2604<p>As of IM v6.5.3-5 any alpha channel in the overlay image is used as a
2605mask the transparency of the destination image. However areas outside the
2606overlaid areas will not be effected. </p>
2607
2608
2609<div style="margin: auto;">
2610 <h3 class="magick-header"><a id="display"></a>-display <var>host:display[.screen]</var></h3>
2611</div>
2612
2613<p class="magick-description">Specifies the X server to contact.</p>
2614
2615<p>This option is used with convert for obtaining image or font from this
2616X server. See <var>X(1)</var>.</p>
2617
2618<div style="margin: auto;">
2619 <h3 class="magick-header"><a id="dispose"></a>-dispose <var>method</var></h3>
2620</div>
2621
2622<p class="magick-description">define the GIF disposal image setting for images that are being created or read in. </p>
2623
2624<p>The layer disposal method defines the way each the displayed image is to be
2625modified after the current 'frame' of an animation has finished being
2626displayed (after its 'delay' period), but before the next frame on an
2627animation is to be overlaid onto the display. </p>
2628
2629<p>Here are the valid methods:</p>
2630
2631<dl class="dl-horizontal">
2632<dt>Undefined</dt><dd>0: No disposal specified (equivalent to '<code>none</code>').</dd>
2633<dt>None</dt><dd>1: Do not dispose, just overlay next frame image.</dd>
2634<dt>Background</dt><dd>2: Clear the frame area with the background color.</dd>
2635<dt>Previous</dt><dd>3: Clear to the image prior to this frames overlay.</dd>
2636</dl>
2637
2638<p>You can also use the numbers given above, which is what the GIF format
2639uses internally to represent the above settings. </p>
2640
2641<p>To print a complete list of dispose methods, use <a href="command-line-options.html#list">-list dispose</a>.</p>
2642
Cristy594d2772015-11-15 10:47:42 -05002643<p>Use <a href="command-line-options.html#dispose" >+dispose</a>, turn off the setting and prevent
Cristy882d9f42015-10-29 16:48:39 -04002644resetting the layer disposal methods of images being read in. </p>
2645
2646<p>Use <a href="command-line-options.html#set">-set</a> '<code>dispose</code>' method to set the image
2647disposal method for images already in memory.</p>
2648
2649<div style="margin: auto;">
2650 <h3 class="magick-header"><a id="dissimilarity-threshold"></a>-dissimilarity-threshold <var>value</var></h3>
2651</div>
2652
2653<p class="magick-description">maximum RMSE for subimage match (default 0.2).</p>
2654
2655
2656<div style="margin: auto;">
2657 <h3 class="magick-header"><a id="dissolve"></a>-dissolve <var>src_percent</var>[x<var>dst_percent</var>]</h3>
2658</div>
2659
2660<p class="magick-description">dissolve an image into another by the given percent.</p>
2661
2662<p>The opacity of the composite image is multiplied by the given percent, then
2663it is composited 'over' the main image. If <var>src_percent</var>
2664is greater than 100, start dissolving the main image so it becomes
2665transparent at a value of '<code>200</code>'. If both percentages
2666are given, each image are dissolved to the percentages given. </p>
2667
2668<p>Note that dissolve percentages do not add, two opaque images dissolved
2669'50,50', produce a 75% transparency. For a 50% + 50% blending of the two
2670images, you would need to use dissolve values of '50,100'. </p>
2671
2672<div style="margin: auto;">
2673 <h3 class="magick-header"><a id="distort"></a>-distort <var>method arguments</var></h3>
2674</div>
2675
2676<p class="magick-description">distort an image, using the given <var>method</var> and its required <var>arguments</var>.</p>
2677
2678<p>The <var>arguments</var> is a single string containing a list
2679of floating point numbers separated by commas or spaces. The number of
2680and meaning of the floating point values depends on the distortion <var>method</var> being used. </p>
2681
2682<p>Choose from these distortion types:</p>
2683
2684<table class="table table-condensed table-striped">
2685 <tr>
2686 <th style="width: 8%">Method</th>
2687 <th>Description</th>
2688 </tr>
2689
2690 <tr>
Cristy594d2772015-11-15 10:47:42 -05002691 <td>ScaleRotateTranslate <br/> SRT</td>
Cristy882d9f42015-10-29 16:48:39 -04002692 <td>
2693 Distort image by first scaling and rotating about a given 'center',
2694 before translating that 'center' to the new location, in that order. It
2695 is an alternative method of specifying a 'Affine' type of
2696 distortion, but without shearing effects. It also provides a good way
2697 of rotating and displacing a smaller image for tiling onto a larger
Cristy594d2772015-11-15 10:47:42 -05002698 background (IE 2-dimensional animations). <br/>
Cristy882d9f42015-10-29 16:48:39 -04002699
2700 The number of arguments determine the specific meaning of each
Cristy594d2772015-11-15 10:47:42 -05002701 argument for the scales, rotation, and translation operations. <br/>
Cristy882d9f42015-10-29 16:48:39 -04002702
2703 <dl class="dl-horizontal">
2704 <dt>2:</dt><dd><var>Scale Angle</var></dd>
2705 <dt>3:</dt><dd><var>X,Y Angle</var></dd>
2706 <dt>4:</dt><dd><var>X,Y Scale Angle</var></dd>
2707 <dt>5:</dt> <dd><var>X,Y ScaleX,ScaleY Angle</var></dd>
2708 <dt>6:</dt> <dd><var>X,Y Scale Angle NewX,NewY</var></dd>
2709 <dt>7:</dt> <dd><var>X,Y ScaleX,ScaleY Angle NewX,NewY</var></dd>
2710 </dl>
2711
2712 This is actually an alternative way of specifying a 2 dimensional linear
2713 'Affine' or 'AffineProjection' distortion. </td> </tr>
2714
2715 <tr>
2716 <td>Affine</td>
2717 <td>
2718 Distort the image linearly by moving a list of at least 3 or more sets
2719 of control points (as defined below). Ideally 3 sets or 12 floating
2720 point values are given allowing the image to be linearly scaled,
2721 rotated, sheared, and translated, according to those three points. See
2722 also the related 'AffineProjection' and 'SRT'
Cristy594d2772015-11-15 10:47:42 -05002723 distortions. <br/>
Cristy882d9f42015-10-29 16:48:39 -04002724
2725 More than 3 sets given control point pairs (12 numbers) is least
2726 squares fitted to best match a linear affine distortion. If only 2
2727 control point pairs (8 numbers) are given a two point image translation
2728 rotation and scaling is performed, without any possible shearing,
2729 flipping or changes in aspect ratio to the resulting image. If only one
2730 control point pair is provides the image is only translated, (which may
Cristy594d2772015-11-15 10:47:42 -05002731 be a floating point non-integer translation). <br/>
Cristy882d9f42015-10-29 16:48:39 -04002732
2733 This distortion does not include any form of perspective distortion.
2734 </td>
2735
2736 </tr>
2737
2738 <tr>
2739 <td>AffineProjection</td>
2740 <td>
2741 Linearly distort an image using the given Affine Matrix of 6
2742 pre-calculated coefficients forming a set of Affine Equations to map
2743 the source image to the destination image.
2744
2745 <p class="text-center"><var>
2746 s<sub>x</sub>, r<sub>x</sub>,
2747 r<sub>y</sub>, s<sub>y</sub>,
2748 t<sub>x</sub>, t<sub>y</sub>
2749 </var></p>
2750
Cristy594d2772015-11-15 10:47:42 -05002751 See <a href="command-line-options.html#affine" >-affine</a> setting for more detail, and
2752 meanings of these coefficients. <br/>
Cristy882d9f42015-10-29 16:48:39 -04002753
2754 The distortions 'Affine' and 'SRT' provide
2755 alternative methods of defining this distortion, with ImageMagick doing
2756 the calculations needed to generate the required coefficients. You can
Cristy594d2772015-11-15 10:47:42 -05002757 see the internally generated coefficients, by using a <a
2758 href="command-line-options.html#verbose" >-verbose</a> setting with those other variants. </td>
Cristy882d9f42015-10-29 16:48:39 -04002759
2760 </tr>
2761
2762 <tr>
Cristy594d2772015-11-15 10:47:42 -05002763 <td>BilinearForward<br/>
Cristy882d9f42015-10-29 16:48:39 -04002764 BilinearReverse</td>
2765 <td>
2766 Bilinear Distortion, given a minimum of 4 sets of coordinate pairs, or
2767 16 values (see below). Not that lines may not appear straight after
2768 distortion, though the distance between coordinates will remain
Cristy594d2772015-11-15 10:47:42 -05002769 consistent. <br/>
Cristy882d9f42015-10-29 16:48:39 -04002770
2771 The 'BilinearForward' is used to map rectangles to any
2772 quadrilateral, while the 'BilinearReverse' form maps any
2773 quadrilateral to a rectangle, while preserving the straight line edges
Cristy594d2772015-11-15 10:47:42 -05002774 in each case. <br/>
Cristy882d9f42015-10-29 16:48:39 -04002775
2776 Note that 'BilinearForward' can generate invalid pixels
Cristyf650f4f2016-04-01 10:53:07 -04002777 which will be colored using the <a href="command-line-options.html#alpha-color" >-alpha-color</a>
Cristy882d9f42015-10-29 16:48:39 -04002778 color setting. Also if the quadrilateral becomes 'flipped' the image
Cristy594d2772015-11-15 10:47:42 -05002779 may disappear. <br/>
Cristy882d9f42015-10-29 16:48:39 -04002780
2781 There are future plans to produce a true Bilinear distortion that will
2782 attempt to map any quadrilateral to any other quadrilateral, while
2783 preserving edges (and edge distance ratios).
2784
2785 </td>
2786 </tr>
2787
2788 <tr>
2789 <td>Perspective</td>
2790 <td>
2791 Perspective distort the images, using a list of 4 or more sets of
2792 control points (as defined below). More that 4 sets (16 numbers) of
2793 control points provide least squares fitting for more accurate
2794 distortions (for the purposes of image registration and panorama
2795 effects). Less than 4 sets will fall back to a 'Affine'
Cristy594d2772015-11-15 10:47:42 -05002796 linear distortion. <br/>
Cristy882d9f42015-10-29 16:48:39 -04002797
2798 Perspective Distorted images ensures that straight lines remain
2799 straight, but the scale of the distorted image will vary. The horizon
2800 is anti-aliased, and the 'sky' color may be set using the
Cristyf650f4f2016-04-01 10:53:07 -04002801 <a href="command-line-options.html#alpha-color" >-alpha-color</a> setting. </td>
Cristy882d9f42015-10-29 16:48:39 -04002802 </tr>
2803
2804 <tr>
2805 <td>PerspectiveProjection </td>
2806 <td>
2807 Do a 'Perspective' distortion biased on a set of 8
2808 pre-calculated coefficients. You can get these coefficients by looking
Cristy594d2772015-11-15 10:47:42 -05002809 at the <a href="command-line-options.html#verbose" >-verbose</a> output of a
Cristy882d9f42015-10-29 16:48:39 -04002810 'Perspective' distortion, or by calculating them yourself.
2811 If the last two perspective scaling coefficients are zero, the
2812 remaining 6 represents a transposed 'Affine Matrix'. </td>
2813
2814 </tr>
2815
2816 <tr>
2817 <td>Arc</td>
2818 <td>
2819 Arc the image (variation of polar mapping) over the angle given around
2820 a circle.
2821
Cristy594d2772015-11-15 10:47:42 -05002822 <p><dl class="dl-horizontal">
Cristy882d9f42015-10-29 16:48:39 -04002823 <dt>arc_angle</dt>
2824 <dd>The angle over which to arc the image side-to-side</dd>
2825 <dt>rotate_angle</dt>
2826 <dd>Angle to rotate resulting image from vertical center</dd>
2827 <dt>top_radius</dt>
2828 <dd>Set top edge of source image at this radius</dd>
2829 <dt>bottom_radius </dt>
2830 <dd>Set bottom edge to this radius (radial scaling)</dd>
Cristy594d2772015-11-15 10:47:42 -05002831 </dl></p>
Cristy882d9f42015-10-29 16:48:39 -04002832
2833 The resulting image is always resized to best fit the resulting image,
Cristy594d2772015-11-15 10:47:42 -05002834 (as if using <a href="command-line-options.html#distort" >+distort</a>) while attempting to
Cristy882d9f42015-10-29 16:48:39 -04002835 preserve scale and aspect ratio of the original image as much as
2836 possible with the arguments given by the user. All four arguments will
Cristy594d2772015-11-15 10:47:42 -05002837 be needed to change the overall aspect ratio of an 'Arc'ed image. <br/>
Cristy882d9f42015-10-29 16:48:39 -04002838
2839 This a variation of a polar distortion designed to try to preserve the
2840 aspect ratio of the image rather than direct Cartesian to Polar
2841 conversion. </td>
2842 </tr>
2843
2844 <tr>
2845 <td>Polar</td>
2846 <td>
2847 Like 'Arc' but do a complete Cartesian to Polar mapping of
2848 the image. that is the height of the input image is mapped to the
2849 radius limits, while the width is wrapped around between the
Cristy594d2772015-11-15 10:47:42 -05002850 angle limits. <br/>
Cristy882d9f42015-10-29 16:48:39 -04002851
Cristy594d2772015-11-15 10:47:42 -05002852 Arguments: <var>Rmax,Rmin CenterX,CenterY, start,end_angle</var> <br/>
Cristy882d9f42015-10-29 16:48:39 -04002853
2854 All arguments are optional. With <var>Rmin</var> defaulting to zero, the
2855 center to the center of the image, and the angles going from -180 (top)
2856 to +180 (top). If <var>Rmax</var> is given the special value of
2857 '0', the the distance from the center to the nearest edge
2858 is used for the radius of the output image, which will ensure the whole
2859 image is visible (though scaled smaller). However a special value of
2860 '-1' will use the distance from the center to the furthest
2861 corner, This may 'clip' the corners from the input rectangular image,
2862 but will generate the exact reverse of a 'DePolar' with
Cristy594d2772015-11-15 10:47:42 -05002863 the same arguments. <br/>
Cristy882d9f42015-10-29 16:48:39 -04002864
Cristy594d2772015-11-15 10:47:42 -05002865 If the plus form of distort (<a href="command-line-options.html#distort" >+distort</a>) is used
Cristy882d9f42015-10-29 16:48:39 -04002866 output image center will default to 0,0 of the virtual
2867 canvas, and the image size adjusted to ensure the whole input image is
2868 made visible in the output image on the virtual canvas. </td>
2869
2870 </tr>
2871
2872 <tr>
2873 <td>DePolar</td>
2874 <td>
2875 Uses the same arguments and meanings as a 'Polar' distortion
Cristy594d2772015-11-15 10:47:42 -05002876 but generates the reverse Polar to Cartesian distortion. <br/>
Cristy882d9f42015-10-29 16:48:39 -04002877
2878 The special <var>Rmax</var> setting of '0' may however clip
2879 the corners of the input image. However using the special
2880 <var>Rmax</var> setting of '-1' (maximum center to corner
2881 distance) will ensure the whole distorted image is preserved in the
2882 generated result, so that the same argument to 'Polar' will
2883 reverse the distortion re-producing the original.
2884
2885 Note that as this distortion requires the area resampling of a circular
2886 arc, which can not be handled by the builtin EWA resampling function.
2887 As such the normal EWA filters are turned off. It is recommended some
2888 form of 'super-sampling' image processing technique be used to produce
2889 a high quality result. </td>
2890
2891 </tr>
2892
2893 <tr>
2894 <td>Barrel</td>
2895 <td>
Cristy594d2772015-11-15 10:47:42 -05002896 Given the four coefficients (A,B,C,D) as defined by <a
2897 href="http://wiki.panotools.org/Lens_correction_model" >Helmut
Cristy882d9f42015-10-29 16:48:39 -04002898 Dersch</a>, perform a barrel or pin-cushion distortion appropriate to
2899 correct radial lens distortions. That is in photographs, make straight
Cristy594d2772015-11-15 10:47:42 -05002900 lines straight again. <br/>
Cristy882d9f42015-10-29 16:48:39 -04002901
2902 <p class="text-center">Arguments: <var>A B C</var> [ <var>D</var> [
Cristy594d2772015-11-15 10:47:42 -05002903 <var>X</var> , <var>Y</var> ] ] <br/>
Cristy882d9f42015-10-29 16:48:39 -04002904 or <var>A<sub>x</sub> B<sub>x</sub> C<sub>x</sub> D<sub>x</sub>
2905 A<sub>y</sub> B<sub>y</sub> C<sub>y</sub> D<sub>y</sub></var>
2906 [ <var>X</var> , <var>Y</var> ] </p>
2907 So that it forms the function
2908 <p class="text-center">Rsrc = r * ( <var>A</var>*r<sup>3</sup> + <var>B</var>*r<sup>2</sup> +
2909 <var>C</var>*r + <var>D</var> )</p>
2910
2911 Where <var>X</var>,<var>Y</var> is the optional center of the distortion
Cristy594d2772015-11-15 10:47:42 -05002912 (defaulting to the center of the image). <br/>
Cristy882d9f42015-10-29 16:48:39 -04002913 The second form is typically used to distort images, rather than
Cristy594d2772015-11-15 10:47:42 -05002914 correct lens distortions. <br/>
Cristy882d9f42015-10-29 16:48:39 -04002915 </td>
2916
2917 </tr>
2918
2919 <tr>
2920 <td>BarrelInverse</td>
2921 <td>
2922 This is very similar to 'Barrel' with the same set of
2923 arguments, and argument handling. However it uses the inverse
2924 of the radial polynomial,
2925 so that it forms the function
2926 <p class="text-center">Rsrc = r / ( <var>A</var>*r<sup>3</sup> + <var>B</var>*r<sup>2</sup> +
2927 <var>C</var>*r + <var>D</var> )</p>
2928 Note that this is not the reverse of the 'Barrel'
2929 distortion, just a different barrel-like radial distortion method.
2930
2931 </td>
2932 </tr>
2933
2934 <tr>
2935 <td>Shepards</td>
2936 <td>
2937 Distort the given list control points (any number) using an Inverse
Cristy594d2772015-11-15 10:47:42 -05002938 Squared Distance Interpolation Method (<a
2939 href="http://en.wikipedia.org/wiki/Shepard%27s_method" >Shepards
Cristy882d9f42015-10-29 16:48:39 -04002940 Method</a>). The control points in effect do 'localized' displacement
2941 of the image around the given control point (preserving the look and
2942 the rotation of the area near the control points. For best results
2943 extra control points should be added to 'lock' the positions of the
2944 corners, edges and other unchanging parts of the image, to prevent
Cristy594d2772015-11-15 10:47:42 -05002945 their movement. <br/>
Cristy882d9f42015-10-29 16:48:39 -04002946
2947 The distortion has been likened to 'taffy pulling' using nails, or
2948 pins' stuck in a block of 'jelly' which is then moved to the new
Cristy594d2772015-11-15 10:47:42 -05002949 position, distorting the surface of the jelly. <br/>
Cristy882d9f42015-10-29 16:48:39 -04002950
Cristy594d2772015-11-15 10:47:42 -05002951 Internally it is equivalent to generating a displacement map (see <a
2952 href="command-line-options.html#displace" >-displace</a>) for source image color look-up using
2953 the <a href="command-line-options.html#sparse-color" >-sparse-color</a> method of the same name.
Cristy882d9f42015-10-29 16:48:39 -04002954
2955 </td>
2956 </tr>
2957
2958</table>
2959
2960<p>To print a complete list of distortion methods, use <a href="command-line-options.html#list">-list
2961distort</a>.</p>
2962
2963<p>Many of the above distortion methods such as '<code>Affine</code>',
2964'<code>Perspective</code>', and '<code>Shepards</code>' use a list control points
2965defining how these points in the given image should be distorted in the
2966destination image. Each set of four floating point values represent a source
2967image coordinate, followed immediately by the destination image coordinate.
2968This produces a list of values such as...</p>
2969<p class="text-center"><var>
2970 U<sub>1</sub>,V<sub>1</sub> X<sub>1</sub>,Y<sub>1</sub>
2971 U<sub>2</sub>,V<sub>2</sub> X<sub>2</sub>,Y<sub>2</sub>
2972 U<sub>3</sub>,V<sub>3</sub> X<sub>3</sub>,Y<sub>3</sub>
2973 ...
2974 U<sub>n</sub>,V<sub>n</sub> X<sub>n</sub>,Y<sub>n</sub>
2975</var></p>
2976<p>where <var>U,V</var> on the source image is mapped to <var>X,Y</var> on the
2977destination image. </p>
2978
2979<p>For example, to warp an image using '<code>perspective</code>' distortion,
2980needs a list of at least 4 sets of coordinates, or 16 numbers. Here is the
2981perspective distortion of the built-in "rose:" image. Note how spaces were
2982used to group the 4 sets of coordinate pairs, to make it easier to read and
2983understand.</p>
2984
2985<pre>
2986convert rose: -virtual-pixel black \
2987 -distort Perspective '0,0,0,0 0,45,0,45 69,0,60,10 69,45,60,35' \
2988 rose_3d_rotated.gif"
2989</pre>
2990
2991<p>If more that the required number of coordinate pairs are given for
2992a distortion, the distortion method is 'least squares' fitted to produce the
2993best result for all the coordinate pairs given. If less than the ideal number
2994of points are given, the distort will generally fall back to a simpler form of
2995distortion that can handles the smaller number of coordinates (usually a linear
2996'<code>Affine</code>' distortion). </p>
2997
2998<p>By using more coordinates you can make use of image registration tool to
2999find matching coordinate pairs in overlapping images, so as to improve the
3000'fit' of the distortion. Of course a bad coordinate pair can also make the
3001'fit' worse. Caution is always advised. </p>
3002
3003<p>Colors are acquired from the source image according to a cylindrical
Cristy594d2772015-11-15 10:47:42 -05003004resampling <a href="command-line-options.html#filter" >-filter</a>, using a special technique known as
Cristy882d9f42015-10-29 16:48:39 -04003005EWA resampling. This produces very high quality results, especially when
3006images become smaller (minified) in the output, which is very common when
3007using '<code>perspective</code>' distortion. For example here we view
3008a infinitely tiled 'plane' all the way to the horizon. </p>
3009
3010<pre>
3011convert -size 90x90 pattern:checkerboard -normalize -virtual-pixel tile \
3012 -distort perspective '0,0,5,45 89,0,45,46 0,89,0,89 89,89,89,89' \
3013 checks_tiled.jpg
3014</pre>
3015
3016<p>Note that a infinitely tiled perspective images involving the horizon can
3017be very slow, because of the number of pixels that are compressed to generate
3018each individual pixel close to the 'horizon'. You can turn off EWA
Cristy594d2772015-11-15 10:47:42 -05003019resampling, by specifying the special <a href="command-line-options.html#filter" >-filter</a> setting of
Cristy882d9f42015-10-29 16:48:39 -04003020'<code>point</code>' (recommended if you plan to use super-sampling instead).
3021</p>
3022
3023<p>If an image generates <i>invalid pixels</i>, such as the 'sky' in the last
Cristy594d2772015-11-15 10:47:42 -05003024example, <a href="command-line-options.html#distort" >-distort</a> will use the current <a
Cristyf650f4f2016-04-01 10:53:07 -04003025href="command-line-options.html#alpha-color" >-alpha-color</a> setting for these pixels. If you do not
Cristy882d9f42015-10-29 16:48:39 -04003026what these pixels to be visible, set the color to match the rest of the
3027ground. </p>
3028
3029<p>The output image size will by default be the same as the input image. This
3030means that if the part of the distorted image falls outside the viewed area of
3031the 'distorted space', those parts is clipped and lost. However if you use
Cristy594d2772015-11-15 10:47:42 -05003032the plus form of the operator (<a href="command-line-options.html#distort" >+distort</a>) the operator
Cristy882d9f42015-10-29 16:48:39 -04003033will attempt (if possible) to show the whole of the distorted image, while
3034retaining a correct 'virtual canvas' offset, for image layering. This offset
Cristy594d2772015-11-15 10:47:42 -05003035may need to be removed using <a href="command-line-options.html#repage" >+repage</a>, to remove if it
Cristy882d9f42015-10-29 16:48:39 -04003036is unwanted. </p>
3037
Cristy594d2772015-11-15 10:47:42 -05003038<p>Setting <a href="command-line-options.html#verbose" >-verbose</a> setting, will cause <a
3039href="command-line-options.html#distort" >-distort</a> to attempt to output the internal coefficients,
3040and the <a href="command-line-options.html#fx" >-fx</a> equivalent to the distortion, for expert study,
Cristy882d9f42015-10-29 16:48:39 -04003041and debugging purposes. This many not be available for all distorts. </p>
3042
Cristy594d2772015-11-15 10:47:42 -05003043<p>You can alternatively specify a special "<code><a href="command-line-options.html#define"
3044>-define</a> distort:viewport={geometry_string}</code>" setting which will
Cristy882d9f42015-10-29 16:48:39 -04003045specify the size and the offset of the generated 'viewport' image of the
3046distorted image space.</p>
3047
Cristy594d2772015-11-15 10:47:42 -05003048<p>Setting a "<code><a href="command-line-options.html#define" >-define</a>
Cristy769d8892016-01-19 18:11:14 -05003049distort:scale=<var>scale_factor</var></code>" will scale the output image (viewport or
Cristy882d9f42015-10-29 16:48:39 -04003050otherwise) by that factor without changing the viewed contents of the
3051distorted image. This can be used either for 'super-sampling' the image for
3052a higher quality result, or for panning and zooming around the image (with
3053appropriate viewport changes, or post-distort cropping and resizing). </p>
3054
Cristy594d2772015-11-15 10:47:42 -05003055<p>Setting "<code><a href="command-line-options.html#define" >-define</a> resample:verbose=1</code>"
Cristy882d9f42015-10-29 16:48:39 -04003056will output the cylindrical filter lookup table created by the EWA (Elliptical
3057Weighted Average) resampling algorithm. Note this table uses a squared radius
3058lookup value. This is typically only used for debugging EWA resampling. </p>
3059
3060
3061<div style="margin: auto;">
3062 <h3 class="magick-header"><a id="distribute-cache"></a>-distribute-cache <var>port</var></h3>
3063</div>
3064
3065<p class="magick-description">launch a distributed pixel cache server. </p>
3066
3067<div style="margin: auto;">
3068 <h3 class="magick-header"><a id="dither"></a>-dither <var>method</var></h3>
3069</div>
3070
3071<p class="magick-description">Apply a Riemersma or Floyd-Steinberg error diffusion dither to
3072images when general color reduction is applied via an option, or automagically
3073when saving to specific formats. This enabled by default.</p>
3074
3075<p>Dithering places two or more colors in neighboring pixels so that to the
3076eye a closer approximation of the images original color is reproduced. This
3077reduces the number of colors needed to reproduce the image but at the cost of
3078a lower level pattern of colors. Error diffusion dithers can use any set of
3079colors (generated or user defined) to an image. </p>
3080
3081<p>Dithering is turned on by default, to turn it off use the plus form of the
3082setting, <a href="command-line-options.html#dither">+dither</a>. This will also also render PostScript
3083without text or graphic aliasing. Disabling dithering often (but not always)
3084leads to faster process, a smaller number of colors, but more cartoon like
3085image coloring. Generally resulting in 'color banding' effects in areas with
3086color gradients. </p>
3087
Cristy594d2772015-11-15 10:47:42 -05003088<p>The color reduction operators <a href="command-line-options.html#colors">-colors</a>, <a
3089href="command-line-options.html#monochrome">-monochrome</a>, <a href="command-line-options.html#remap ">-remap</a>, and <a
3090href="command-line-options.html#posterize">-posterize</a>, apply dithering to images using the reduced
Cristy882d9f42015-10-29 16:48:39 -04003091color set they created. These operators are also used as part of automatic
3092color reduction when saving images to formats with limited color support, such
3093as <code>GIF:</code>, <code>XBM:</code>, and others, so dithering may also be used
3094in these cases. </p>
3095
3096<p>Alternatively you can use <a href="command-line-options.html#random-threshold">-random-threshold</a>
Cristy594d2772015-11-15 10:47:42 -05003097to generate purely random dither. Or use <a
3098href="command-line-options.html#ordered-dither">-ordered-dither</a> to apply threshold mapped dither
Cristy882d9f42015-10-29 16:48:39 -04003099patterns, using uniform color maps, rather than specific color maps. </p>
3100
3101
3102<div style="margin: auto;">
3103 <h3 class="magick-header"><a id="draw"></a>-draw <var>string</var></h3>
3104</div>
3105
3106<p class="magick-description">Annotate an image with one or more graphic primitives.</p>
3107
3108<p>Use this option to annotate or decorate an image with one or more graphic
3109primitives. The primitives include shapes, text, transformations, and pixel
3110operations.</p>
3111
3112<p>The shape primitives:</p>
3113
3114<dl class="dl-horizontal">
3115<dt>point</dt><dd> x,y</dd>
3116<dt>line</dt><dd> x0,y0 x1,y1</dd>
3117<dt>rectangle</dt><dd> x0,y0 x1,y1</dd>
3118<dt>roundRectangle</dt><dd> x0,y0 x1,y1 wc,hc</dd>
3119<dt>arc</dt><dd> x0,y0 x1,y1 a0,a1</dd>
3120<dt>ellipse</dt><dd> x0,y0 rx,ry a0,a1</dd>
3121<dt>circle</dt><dd> x0,y0 x1,y1</dd>
3122<dt>polyline</dt><dd> x0,y0 ... xn,yn</dd>
3123<dt>polygon</dt><dd> x0,y0 ... xn,yn</dd>
3124<dt>bezier</dt><dd> x0,y0 ... xn,yn</dd>
3125<dt>path</dt><dd>specification </dd>
3126<dt>image</dt><dd> operator x0,y0 w,h filename</dd>
3127</dl>
3128
3129<p>The text primitive:</p>
3130
3131<dl class="dl-horizontal">
3132<dt>text</dt><dd>x0,y0 string</dd>
3133</dl>
3134<p>The text gravity primitive:</p>
3135
3136<dl class="dl-horizontal">
3137<dt>gravity</dt><dd>NorthWest, North, NorthEast, West, Center, East, SouthWest, South, or SouthEast</dd>
3138</dl>
3139
3140<p>The text gravity primitive only affects the placement of text and does not
Cristy594d2772015-11-15 10:47:42 -05003141interact with the other primitives. It is equivalent to using the <a
3142href="command-line-options.html#gravity">-gravity</a> command-line option, except that it is limited in
Cristy882d9f42015-10-29 16:48:39 -04003143scope to the <a href="command-line-options.html#draw">-draw</a> option in which it appears.</p>
3144
3145<p>The transformation primitives:</p>
3146
3147<dl class="dl-horizontal">
3148<dt>rotate</dt><dd>degrees</dd>
3149<dt>translate</dt><dd>dx,dy</dd>
3150<dt>scale</dt><dd>sx,sy</dd>
3151<dt>skewX</dt><dd>degrees</dd>
3152<dt>skewY</dt><dd>degrees</dd>
3153</dl>
3154
3155<p>The pixel operation primitives:</p>
3156
3157<dl class="dl-horizontal">
3158<dt>color</dt><dd>x0,y0 method</dd>
3159<dt>matte</dt><dd>x0,y0 method</dd>
3160</dl>
3161
Cristy594d2772015-11-15 10:47:42 -05003162<p>The shape primitives are drawn in the color specified by the preceding <a
3163href="command-line-options.html#fill">-fill</a> setting. For unfilled shapes, use <a
3164href="command-line-options.html#fill">-fill none</a>. You can optionally control the stroke (the
3165"outline" of a shape) with the <a href="command-line-options.html#stroke">-stroke</a> and <a
3166href="command-line-options.html#strokewidth">-strokewidth</a> settings.</p>
Cristy882d9f42015-10-29 16:48:39 -04003167
3168<p>A <code>point</code> primitive is specified by a single <var>point</var> in the
3169pixel plane, that is, by an ordered pair of integer coordinates,
3170<var>x</var>,<var>y</var>. (As it involves only a single pixel, a <code>point</code>
Cristy594d2772015-11-15 10:47:42 -05003171primitive is not affected by <a href="command-line-options.html#stroke">-stroke</a> or <a
3172href="command-line-options.html#strokewidth">-strokewidth</a>.)</p>
Cristy882d9f42015-10-29 16:48:39 -04003173
3174<p>A <code>line</code> primitive requires a start point and end point.</p>
3175
3176<p>A <code>rectangle</code> primitive is specified by the pair of points at the
3177upper left and lower right corners.</p>
3178
3179<p>A <code>roundRectangle</code> primitive takes the same corner points as
3180a <code>rectangle</code> followed by the width and height of the rounded corners
3181to be removed.</p>
3182
3183<p>The <code>circle</code> primitive makes a disk (filled) or circle (unfilled).
3184Give the center and any point on the perimeter (boundary).</p>
3185
3186<p>The <code>arc</code> primitive is used to inscribe an elliptical segment in
3187to a given rectangle. An <code>arc</code> requires the two corners used for
3188<code>rectangle</code> (see above) followed by the start and end angles of the
3189arc of the segment segment (e.g. 130,30 200,100 45,90). The start and end
3190points produced are then joined with a line segment and the resulting segment
3191of an ellipse is filled.</p>
3192
3193<p>Use <code>ellipse</code> to draw a partial (or whole) ellipse. Give the
3194center point, the horizontal and vertical "radii" (the <var>semi-axes</var> of
3195the ellipse) and start and end angles in degrees (e.g. 100,100 100,150
31960,360).</p>
3197
3198<p>The <code>polyline</code> and <code>polygon</code> primitives require three or
3199more points to define their perimeters. A <code>polyline</code> is simply
3200a <code>polygon</code> in which the final point is not stroked to the start
Cristy594d2772015-11-15 10:47:42 -05003201point. When unfilled, this is a <var>polygonal line</var>. If the <a
3202href="command-line-options.html#stroke">-stroke</a> setting is <code>none</code> (the default), then
Cristy882d9f42015-10-29 16:48:39 -04003203a <code>polyline</code> is identical to a <code>polygon</code>. </p>
3204
3205<p>A <var>coordinate</var> is a pair of integers separated by a space or
3206optional comma. </p>
3207
3208<p>As an example, to define a circle centered at 100,100 that extends to
3209150,150 use:</p>
3210
3211<pre>
3212-draw 'circle 100,100 150,150'
3213</pre>
3214
3215<p>The <code>Bezier</code> primitive creates a spline curve and requires three
3216or points to define its shape. The first and last points are the
3217<var>knots</var> and these points are attained by the curve, while any
3218intermediate coordinates are <var>control points</var>. If two control points
3219are specified, the line between each end knot and its sequentially respective
3220control point determines the tangent direction of the curve at that end. If
3221one control point is specified, the lines from the end knots to the one
3222control point determines the tangent directions of the curve at each end. If
3223more than two control points are specified, then the additional control points
3224act in combination to determine the intermediate shape of the curve. In order
3225to draw complex curves, it is highly recommended either to use the
3226<code>path</code> primitive or to draw multiple four-point bezier segments with
3227the start and end knots of each successive segment repeated. For example:</p>
3228
3229<pre>
3230-draw 'bezier 20,50 45,100 45,0 70,50'
3231-draw 'bezier 70,50 95,100 95,0 120,50'
3232</pre>
3233
3234<p>A <code>path</code> represents an outline of an object, defined in terms of
3235moveto (set a new current point), lineto (draw a straight line), curveto (draw
3236a Bezier curve), arc (elliptical or circular arc) and closepath (close the
3237current shape by drawing a line to the last moveto) elements. Compound paths
3238(i.e., a path with subpaths, each consisting of a single moveto followed by
3239one or more line or curve operations) are possible to allow effects such as
Cristy594d2772015-11-15 10:47:42 -05003240<var>donut holes</var> in objects. (See <a
3241href="http://www.w3.org/TR/SVG/paths.html">Paths</a>.)</p>
Cristy882d9f42015-10-29 16:48:39 -04003242
3243<p>Use <code>image</code> to composite an image with another image. Follow the
3244image keyword with the composite operator, image location, image size, and
3245filename:</p>
3246
3247<pre>
3248-draw 'image SrcOver 100,100 225,225 image.jpg'
3249</pre>
3250
3251<p>You can use 0,0 for the image size, which means to use the actual
3252dimensions found in the image header. Otherwise, it is scaled to the given
Cristy6549abb2016-11-10 08:25:55 -05003253dimensions. See <a href="http://www.imagemagick.org/www/compose.html">Alpha Compositing</a> for
Cristy882d9f42015-10-29 16:48:39 -04003254a detailed discussion of alpha composition methods that are available. </p>
3255
3256<p>The "special augmented compose operators" such as "dissolve" that require
3257arguments cannot be used at present with the <code>-draw image</code> option.
3258 </p>
3259
3260<p>Use <code>text</code> to annotate an image with text. Follow the text
3261coordinates with a string. If the string has embedded spaces, enclose it in
3262single or double quotes.</p>
3263
3264<p>For example, the following annotates the image with <code>Works like
3265magick!</code> for an image titled <code>bird.miff</code>. </p>
3266
3267<pre>
3268-draw "text 100,100 'Works like magick!' "
3269</pre>
3270
3271<p>See the <a href="command-line-options.html#annotate">-annotate</a> option for another convenient way
3272to annotate an image with text.</p>
3273
3274<p>The <code>rotate</code> primitive rotates subsequent shape primitives and
Cristy594d2772015-11-15 10:47:42 -05003275text primitives about the origin of the main image. If the <a
3276href="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 -04003277option, the origin for transformations is the upper left corner of the
3278region.</p>
3279
3280<p>The <code>translate</code> primitive translates subsequent shape and text
3281primitives.</p>
3282
3283<p>The <code>scale</code> primitive scales them.</p>
3284
3285<p>The <code>skewX</code> and <code>skewY</code> primitives skew them with respect
3286to the origin of the main image or the region.</p>
3287
3288<p>The transformations modify the current affine matrix, which is initialized
3289from the initial affine matrix defined by the <a href="command-line-options.html#affine">-affine</a>
3290option. Transformations are cumulative within the <a href="command-line-options.html#draw">-draw</a>
3291option. The initial affine matrix is not affected; that matrix is only changed
3292by the appearance of another <a href="command-line-options.html#affine">-affine</a> option. If another
3293<a href="command-line-options.html#draw">-draw</a> option appears, the current affine matrix is
3294reinitialized from the initial affine matrix.</p>
3295
3296<p>Use the <code>color</code> primitive to change the color of a pixel to the
3297fill color (see <a href="command-line-options.html#fill">-fill</a>). Follow the pixel coordinate with
3298a method:</p>
3299
3300<pre>
3301point
3302replace
3303floodfill
3304filltoborder
3305reset
3306</pre>
3307
3308<p>Consider the target pixel as that specified by your coordinate. The
3309<code>point</code> method recolors the target pixel. The <code>replace</code>
3310method recolors any pixel that matches the color of the target pixel.
3311<code>Floodfill</code> recolors any pixel that matches the color of the target
3312pixel and is a neighbor, whereas <code>filltoborder</code> recolors any neighbor
3313pixel that is not the border color. Finally, <code>reset</code> recolors all
3314pixels.</p>
3315
3316<p>Use <code>matte</code> to the change the pixel matte value to transparent.
3317Follow the pixel coordinate with a method (see the <code>color</code> primitive
3318for a description of methods). The <code>point</code> method changes the matte
3319value of the target pixel. The <code>replace</code> method changes the matte
3320value of any pixel that matches the color of the target pixel.
3321<code>Floodfill</code> changes the matte value of any pixel that matches the
3322color of the target pixel and is a neighbor, whereas <code>filltoborder</code>
Cristy594d2772015-11-15 10:47:42 -05003323changes the matte value of any neighbor pixel that is not the border color (<a
3324href="command-line-options.html#bordercolor">-bordercolor</a>). Finally <code>reset</code> changes the
Cristy882d9f42015-10-29 16:48:39 -04003325matte value of all pixels.</p>
3326
Cristy594d2772015-11-15 10:47:42 -05003327<p>You can set the primitive color, font, and font bounding box color with <a
3328href="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 -04003329respectively. Options are processed in command line order so be sure to use
3330these options <var>before</var> the <a href="command-line-options.html#draw">-draw</a> option.</p>
3331
3332<p>Strings that begin with a number must be quoted (e.g. use '1.png' rather
3333than 1.png).</p>
3334
Cristy594d2772015-11-15 10:47:42 -05003335<p>Drawing primitives conform to the <a href="magick-vector-graphics.html" >Magick
Cristy882d9f42015-10-29 16:48:39 -04003336Vector Graphics</a> format.</p>
3337
3338
3339<div style="margin: auto;">
3340 <h3 class="magick-header"><a id="duplicate"></a>-duplicate <var>count,indexes</var></h3>
3341</div>
3342
3343<p class="magick-description">duplicate an image one or more times.</p>
3344
3345<p>Specify the count and the image to duplicate by its index in the sequence.
3346The first image is index 0. Negative indexes are relative to the end of the
3347sequence, for example, -1 represents the last image of the sequence. Specify
3348a range of images with a dash (e.g. 0-4). Separate indexes with a comma (e.g.
33490,2). Use <code>+duplicate</code> to duplicate the last image in the current
3350image sequence.</p>
3351
3352<div style="margin: auto;">
3353 <h3 class="magick-header"><a id="edge"></a>-edge <var>radius</var></h3>
3354</div>
3355
3356<p class="magick-description">detect edges within an image.</p>
3357
3358<div style="margin: auto;">
3359 <h3 class="magick-header"><a id="emboss"></a>-emboss <var>radius</var></h3>
3360</div>
3361
3362<p class="magick-description">emboss an image.</p>
3363
3364<div style="margin: auto;">
3365 <h3 class="magick-header"><a id="encipher"></a>-encipher <var>filename</var></h3>
3366</div>
3367
3368<p class="magick-description">Encipher pixels for later deciphering by <a href="command-line-options.html#decipher">-decipher</a>.</p>
3369
3370<p>Get the passphrase from the file specified by <var>filename</var>.</p>
3371
Cristy594d2772015-11-15 10:47:42 -05003372<p>For more information, see the webpage, <a
Cristy6549abb2016-11-10 08:25:55 -05003373href="https://www.imagemagick.org/script/cipher.html">ImageMagick: Encipher or
Cristy882d9f42015-10-29 16:48:39 -04003374Decipher an Image</a>.</p>
3375
3376
3377
3378<div style="margin: auto;">
3379 <h3 class="magick-header"><a id="encoding"></a>-encoding <var>type</var></h3>
3380</div>
3381
3382<p class="magick-description">specify the text encoding.</p>
3383
3384<p>Choose from</p>
3385
3386<pre>
3387AdobeCustom AdobeExpert
3388AdobeStandard AppleRoman
3389BIG5 GB2312
3390Latin 2 None
3391SJIScode Symbol
3392Unicode Wansung
3393</pre>
3394
3395<div style="margin: auto;">
3396 <h3 class="magick-header"><a id="endian"></a>-endian <var>type</var></h3>
3397</div>
3398
3399<p class="magick-description">Specify endianness (<code>MSB</code> or <code>LSB</code>) of the image.</p>
3400
3401<p>To print a complete list of endian types, use the <a href="command-line-options.html#list">-list endian</a> option.</p>
3402
3403<p>Use <a href="command-line-options.html#endian">+endian</a> to revert to unspecified endianness.</p>
3404
3405
3406<div style="margin: auto;">
3407 <h3 class="magick-header"><a id="enhance"></a>-enhance</h3>
3408</div>
3409
3410<p class="magick-description">Apply a digital filter to enhance a noisy image.</p>
3411
3412
3413<div style="margin: auto;">
3414 <h3 class="magick-header"><a id="equalize"></a>-equalize</h3>
3415</div>
3416
3417<p class="magick-description">perform histogram equalization on the image channel-by-channel.</p>
3418
3419<p>To perform histogram equalization on all channels in concert, transform the
3420image into some other color space, such as HSL, OHTA, YIQ or YUV, then
3421equalize the appropriate intensity-like channel, then convert back to RGB.</p>
3422
3423<p>For example using HSL, we have: ... <code>-colorspace HSL -channel lightness
3424-equalize -colorspace RGB</code> ...</p>
3425
3426<p>For YIQ, YUV and OHTA use the red channel. For example, OHTA is a principal
3427components transformation that puts most of the information in the first
3428channel. Here we have ... <code>-colorspace OHTA -channel red -equalize
3429-colorspace RGB</code> ...</p>
3430
3431<div style="margin: auto;">
3432 <h3 class="magick-header"><a id="evaluate"></a>-evaluate <var>operator value</var></h3>
3433</div>
3434
3435<p class="magick-description">Alter channel pixels by evaluating an arithmetic, relational, or logical expression.</p>
3436
Cristy594d2772015-11-15 10:47:42 -05003437<p>(See the <a href="command-line-options.html#function" >-function</a> operator for some
3438multi-parameter functions. See the <a href="command-line-options.html#fx" >-fx</a> operator if more
Cristy882d9f42015-10-29 16:48:39 -04003439elaborate calculations are needed.)</p>
3440
3441<p>The behaviors of each <var>operator</var> are summarized in the
3442following list. For brevity, the numerical value of a "pixel" referred to
3443below is the value of the corresponding channel of that pixel, while
3444a "normalized pixel" is that number divided by the maximum
3445(installation-dependent) value <var>QuantumRange</var>. (If
3446normalized pixels are used, they are restored, following the other
3447calculations, to the full range by multiplying by <var>QuantumRange</var>.)</p>
3448
3449<table class="table table-condensed table-striped">
Cristy594d2772015-11-15 10:47:42 -05003450 <col width="25%" />
3451 <col width="75%" />
Cristy882d9f42015-10-29 16:48:39 -04003452 <thead>
3453 <tr>
3454 <th><var>operator</var></th>
3455 <th>Summary (see further below for details)</th>
3456 </tr>
3457 </thead>
3458 <tbody>
3459
3460 <tr><td>Abs </td> <td>Add <var>value</var> to pixels and return absolute value. </td></tr>
3461 <tr><td>Add </td> <td>Add <var>value</var> to pixels. </td></tr>
3462 <tr><td>AddModulus </td> <td>Add <var>value</var> to pixels modulo <var>QuantumRange</var>.</td></tr>
3463 <tr><td>And </td> <td>Binary AND of pixels with <var>value</var>.</td></tr>
3464 <tr><td>Cos, Cosine </td> <td>Apply cosine to pixels with frequency <var>value</var> with 50% bias added.</td></tr>
3465 <tr><td>Divide </td> <td>Divide pixels by <var>value</var>.</td></tr>
3466 <tr><td>Exp </td> <td>base-e exponential function</td></tr>
3467 <tr><td>Exponential </td> <td>base-e exponential function</td></tr>
3468 <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>
3469 <tr><td>Log </td> <td>Apply scaled logarithm to normalized pixels.</td></tr>
3470 <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>
3471 <tr><td>Mean </td> <td>Add the <var>value</var> and divide by 2.</td></tr>
3472 <tr><td>Median </td> <td>Choose the median value from an image sequence.</td></tr>
3473 <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>
3474 <tr><td>Multiply </td> <td>Multiply pixels by <var>value</var>.</td></tr>
3475 <tr><td>Or </td> <td>Binary OR of pixels with <var>value</var>.</td></tr>
3476 <tr><td>Pow </td> <td>Raise normalized pixels to the power <var>value</var>.</td></tr>
3477 <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>
3478 <tr><td>RMS</td> <td>Square the pixel and add the <var>value</var>.</td></tr>
3479 <tr><td>RootMeanSquare</td> <td>Square the pixel and add the <var>value</var>.</td></tr>
3480 <tr><td>Set </td> <td>Set pixel equal to <var>value</var>.</td></tr>
3481 <tr><td>Sin, Sine </td> <td>Apply sine to pixels with frequency <var>value</var> with 50% bias added.</td></tr>
3482 <tr><td>Subtract </td> <td>Subtract <var>value</var> from pixels.</td></tr>
3483 <tr><td>Xor </td> <td>Binary XOR of pixels with <var>value.</var></td></tr>
3484
3485 <tr><td> </td><td> </td></tr>
3486
3487 <tr><td>Gaussian-noise</td><td> </td></tr>
3488 <tr><td>Impulse-noise</td><td> </td></tr>
3489 <tr><td>Laplacian-noise</td><td> </td></tr>
Cristy594d2772015-11-15 10:47:42 -05003490 <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 -04003491 <tr><td>PoissonNoise</td><td> </td></tr>
3492 <tr><td>Uniform-noise</td><td> </td></tr>
3493
3494 <tr><td> </td><td> </td></tr>
3495
3496 <tr><td>Threshold </td> <td>Threshold pixels larger than <var>value</var>.</td></tr>
3497 <tr><td>ThresholdBlack </td> <td>Threshold pixels to zero values equal to or below <var>value</var>.</td></tr>
3498 <tr><td>ThresholdWhite </td> <td>Threshold pixels to maximum values above <var>value</var>. </td></tr>
3499 </tbody>
3500 </table>
3501
Cristy594d2772015-11-15 10:47:42 -05003502<p>The specified functions are applied only to each previously set <a
3503href="command-line-options.html#channel" >-channel</a> in the image. If necessary, the results of the
Cristy882d9f42015-10-29 16:48:39 -04003504calculations are truncated (clipped) to fit in the interval [0, <var>QuantumRange</var>]. The transparency channel of the image is
3505represented as a 'alpha' values (0 = fully transparent), so, for example, a
3506<code>Divide</code> by 2 of the alpha channel will make the image
3507semi-transparent. Append the percent symbol '<code>%</code>' to specify a value
3508as a percentage of the <var>QuantumRange</var>.</p>
3509
3510<p>To print a complete list of <a href="command-line-options.html#evaluate">-evaluate</a> operators, use
3511<a href="command-line-options.html#list">-list evaluate</a>.</p>
3512
3513<p>The results of the <code>Add</code>, <code>Subtract</code> and
Cristy594d2772015-11-15 10:47:42 -05003514<code>Multiply</code> methods can also be achieved using either the <a
3515href="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 -04003516appropriate argument, to linearly modify the overall range of color values.
Cristy594d2772015-11-15 10:47:42 -05003517Please note, however, that <a href="command-line-options.html#level" >-level</a> treats transparency as
3518'matte' values (0 = opaque), while <a href="command-line-options.html#level" >-evaluate</a> works with
Cristy882d9f42015-10-29 16:48:39 -04003519'alpha' values.</p>
3520
3521<p><code>AddModulus</code> has been added as of ImageMagick 6.4.8-4 and provides
3522addition modulo the <var>QuantumRange</var>. It is therefore
3523equivalent to <code>Add</code> unless the resulting pixel value is outside the
3524interval [0, <var>QuantumRange</var>]. </p>
3525
3526<p><code>Exp or Exponential</code> has been added as of ImageMagick 6.6.5-1 and
3527works on normalized pixel values. The <var>value</var> used with
3528<code>Exp</code> should be negative so as to produce a decaying exponential
3529function. Non-negative values will always produce results larger unity and
3530thus outside the interval [0, <var>QuantumRange</var>]. The
3531formula is expressed below. </p>
3532
3533<p class="text-center">
3534exp(<var>value</var> × <b><var>u</var></b>)
3535</p>
3536
Cristy594d2772015-11-15 10:47:42 -05003537<p> If the input image is squared, for example, using <a href="command-line-options.html#-function"
3538>-function polynomial "2 0 0"</a>, then a decaying Gaussian function will be
Cristy882d9f42015-10-29 16:48:39 -04003539the result.</p>
3540
3541<p><code>Log</code> has been added as of ImageMagick 6.4.2-1 and works on
3542normalized pixel values. This a <var>scaled</var> log function. The <var>value</var> used with <code>Log</code> provides a <var>scaling
3543factor</var> that adjusts the curvature in the graph of the log function. The
3544formula applied to a normalized value <b><var>u</var></b> is below. </p>
3545
3546<p class="text-center">
3547log(<var>value</var> × <b><var>u</var></b> + 1) / log(<var>value</var> + 1)
3548</p>
3549
3550<p><code>Pow</code> has been added as of ImageMagick 6.4.1-9, and works on
Cristy594d2772015-11-15 10:47:42 -05003551normalized pixel values. Note that <code>Pow</code> is related to the <a
3552href="command-line-options.html#gamma" >-gamma</a> operator. For example, <b>-gamma 2</b> is equivalent
Cristy882d9f42015-10-29 16:48:39 -04003553to <b>-evaluate pow 0.5</b>, i.e., a 'square root' function. The value used
Cristy594d2772015-11-15 10:47:42 -05003554with <a href="command-line-options.html#gamma" >-gamma</a> is simply the reciprocal of the value used
Cristy882d9f42015-10-29 16:48:39 -04003555with <code>Pow</code>.</p>
3556
3557<p><code>Cosine</code> and <code>Sine</code> was added as of IM v6.4.8-8 and
3558converts the image values into a value according to a (co)sine wave function.
3559The synonyms <code>Cos</code> and <code>Sin</code> may also be used. The output
3560is biased 50% and normalized by 50% so as to fit in the respective color value
3561range. The <var>value</var> scaling of the <var>period</var> of the
3562function (its frequency), and thus determines the number of 'waves' that will
3563be 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,
3564then the effective period is the <var>half</var> the <var>QuantumRange</var>.</p>
3565
3566<p class="text-center">
35670.5 + 0.5 × cos(2 π <b><var>u</var></b> × <var>value</var>).
3568</p>
3569
Cristy594d2772015-11-15 10:47:42 -05003570<p>See also the <a href="command-line-options.html#function" >-function</a> operator, which is a
Cristy882d9f42015-10-29 16:48:39 -04003571multi-value version of evaluate. </p>
3572
3573<div style="margin: auto;">
3574 <h3 class="magick-header"><a id="evaluate-sequence"></a>-evaluate-sequence <var>operator</var></h3>
3575</div>
3576
3577<p class="magick-description">Alter channel pixels by evaluating an arithmetic, relational, or
3578logical expression over a sequence of images.</p>
3579
Cristy594d2772015-11-15 10:47:42 -05003580<p>To print a complete list of <a
3581href="command-line-options.html#evaluate-sequence">-evaluate-sequence</a> operators, use <a
3582href="command-line-options.html#list">-list evaluate</a>.</p>
Cristy882d9f42015-10-29 16:48:39 -04003583
3584<div style="margin: auto;">
3585 <h3 class="magick-header"><a id="extent"></a>-extent <var>geometry</var></h3>
3586</div>
3587
3588<p class="magick-description">Set the image size and offset.</p>
3589
3590<p>If the image is enlarged, unfilled areas are set to the background color.
3591To position the image, use offsets in the <var>geometry</var>
3592specification or precede with a <a href="command-line-options.html#gravity">-gravity</a> setting. To
Cristy594d2772015-11-15 10:47:42 -05003593specify how to compose the image with the background, use <a href="command-line-options.html#compose"
3594>-compose</a>.</p>
Cristy882d9f42015-10-29 16:48:39 -04003595
3596<p>This command reduces or expands a JPEG image to fit on an 800x600
3597display. If the aspect ratio of the input image isn't exactly 4:3, then the
3598image is centered on an 800x600 black canvas: </p>
3599
3600<pre>
3601convert input.jpg -resize 800x600 -background black -compose Copy \
3602 -gravity center -extent 800x600 -quality 92 output.jpg
3603</pre>
3604
3605<p>See <a href="command-line-processing.html#geometry">Image Geometry</a> for complete details about the <em class="arg">geometry</em> argument.</p>
3606
3607<div style="margin: auto;">
3608 <h3 class="magick-header"><a id="extract"></a>-extract <var>geometry</var></h3>
3609</div>
3610
3611<p class="magick-description">Extract the specified area from image.</p>
3612
3613<p>This option is most useful for extracting a subregion of a very large raw
3614image. Note that these two commands are equivalent:</p>
3615
3616<pre>
3617convert -size 16000x16000 -depth 8 -extract 640x480+1280+960 \
3618 image.rgb image.png",
3619convert -size 16000x16000 -depth 8 'image.rgb[640x480+1280+960]' \
3620 image.rgb image.png"
3621</pre>
3622
3623<p>If you omit the offsets, as in</p>
3624
3625<pre>
3626convert -size 16000x16000 -depth 8 -extract 640x480 \
3627 image.rgb image.png
3628</pre>
3629
3630<p>the image is <var>resized</var> to the specified dimensions instead,
3631equivalent to:</p>
3632
3633<pre>
3634convert -size 16000x16000 -depth 8 -resize 640x480 image.rgb image.png
3635</pre>
3636
3637<p>See <a href="command-line-processing.html#geometry">Image Geometry</a> for complete details about the <em class="arg">geometry</em> argument.</p>
3638
3639<div style="margin: auto;">
3640 <h3 class="magick-header"><a id="family"></a>-family <var>fontFamily</var></h3>
3641</div>
3642
3643<p class="magick-description">Set a font family for text.</p>
3644
3645<p>This setting suggests a font family that ImageMagick should try to use for
3646rendering text. If the family can be found it is used; if not, a default font
3647(e.g., "Arial") or a family known to be similar is substituted (e.g.,
3648"Courier" might be used if "System" is requested but not found). </p>
3649
Cristy594d2772015-11-15 10:47:42 -05003650<p>For other settings that affect fonts, see the options <a
3651href="command-line-options.html#font">-font</a>, <a href="command-line-options.html#stretch">-stretch</a>, <a
3652href="command-line-options.html#style">-style</a>, and <a href="command-line-options.html#weight">-weight</a>. </p>
Cristy882d9f42015-10-29 16:48:39 -04003653
3654<div style="margin: auto;">
3655 <h3 class="magick-header"><a id="features"></a>-features <var>distance</var></h3>
3656</div>
3657
3658<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>
3659
3660<pre>
3661Angular Second Moment Sum Entropy
3662Contrast Entropy
3663Correlation Difference Variance
3664Sum of Squares Variance Difference Entropy
3665Inverse Difference Moment Information Measure of Correlation 1
3666Sum Average Information Measure of Correlation 2
3667Sum Variance Maximum Correlation Coefficient
3668</pre>
3669
3670<div style="margin: auto;">
3671 <h3 class="magick-header"><a id="fft"></a>-fft</h3>
3672</div>
3673
3674<p class="magick-description">implements the forward discrete Fourier transform (DFT).</p>
3675
3676<p>This option is new as of ImageMagick 6.5.4-3 (and now working for Windows
3677users in ImageMagick 6.6.0-9). It transforms an image from the normal
3678(spatial) domain to the frequency domain. In the frequency domain, an image is
3679represented as a superposition of complex sinusoidal waves of varying
3680amplitudes. The image x and y coordinates are the possible frequencies along
3681the x and y directions, respectively, and the pixel intensity values are
3682complex numbers that correspond to the sinusoidal wave amplitudes. See for
3683example, <a href="http://en.wikipedia.org/wiki/Fourier_transform">Fourier
3684Transform</a>, <a href="http://en.wikipedia.org/wiki/DFT">Discrete Fourier
3685Transform</a> and <a href="http://en.wikipedia.org/wiki/FFT">Fast Fourier
3686Transform</a>.</p>
3687
3688<p>A single image name is provided as output for this option. However, the
3689output result will have two components. It is either a two-frame image or two
3690separate images, depending upon whether the image format specified supports
3691multi-frame images. The reason that we get a dual output result is because the
3692frequency domain represents an image using complex numbers, which cannot be
3693visualized directly. Therefore, the complex values are automagically separated
3694into a two-component image representation. The first component is the
3695magnitude of the complex number and the second is the phase of the complex
Cristy594d2772015-11-15 10:47:42 -05003696number. See for example, <a
3697href="http://en.wikipedia.org/wiki/Complex_numbers">Complex Numbers</a>.</p>
Cristy882d9f42015-10-29 16:48:39 -04003698
3699<p>The magnitude and phase component images must be specified using image
3700formats that do not limit the color or compress the image. Thus, MIFF, TIF,
3701PFM, EXR and PNG are the recommended image formats to use. All of these
3702formats, except PNG support multi-frame images. So for example,</p>
3703
3704<pre>
3705convert image.png -fft fft_image.miff
3706</pre>
3707
3708<p>generates a magnitude image as <code>fft_image.miff[0]</code> and a phase
3709image as <code>fft_image.miff[1]</code>. Similarly,</p>
3710
3711<pre>
3712convert image.png -fft fft_image.png
3713</pre>
3714
3715<p>generates a magnitude image as <code>fft_image-0.png</code> and a phase image
3716as <code>fft_image-1.png</code>. If you prefer this representation, then you can
Cristy594d2772015-11-15 10:47:42 -05003717force any of the other formats to produce two output images by including <a
3718href="command-line-options.html#adjoin">+adjoin</a> following -fft in the command line.</p>
Cristy882d9f42015-10-29 16:48:39 -04003719
3720<p>The input image can be any size, but if not square and even-dimensioned, it
3721is padded automagically to the larger of the width or height of the input
3722image and to an even number of pixels. The padding will occur at the bottom
3723and/or right sides of the input image. The resulting output magnitude and
Cristy594d2772015-11-15 10:47:42 -05003724phase images is square at this size. The kind of padding relies on the <a
3725href="command-line-options.html#virtual-pixel">-virtual-pixel</a> setting.</p>
Cristy882d9f42015-10-29 16:48:39 -04003726
3727<p>Both output components will have dynamic ranges that fit within
3728[0, <var>QuantumRange</var>], so that HDRI need not be enabled.
3729Phase values nominally range from 0 to 2*π, but is scaled to span the full
3730dynamic range. (The first few releases had non-HDRI scaled but HDRI not
3731scaled). The magnitude image is not scaled and thus generally will contain
3732very small values. As such, the image normally will appear totally black. In
3733order to view any detail, the magnitude image typically is enhanced with a log
3734function into what is usually called the spectrum. A log function is used to
3735enhance the darker values more in comparison to the lighter values. This can
3736be done, for example, as follows:</p>
3737
3738<pre>
3739convert fft_image.miff[0] -contrast-stretch 0 \
3740 -evaluate log 1000 fft_image_spectrum.png"
3741</pre>
3742
Cristy594d2772015-11-15 10:47:42 -05003743<p>where either <a href="command-line-options.html#contrast-stretch">-contrast-stretch</a> 0 or <a
3744href="command-line-options.html#auto-level">-auto-level</a> is used to scale the image to full dynamic
Cristy882d9f42015-10-29 16:48:39 -04003745range, first. The argument to the <a href="command-line-options.html#evaluate">-evaluate</a> log
3746typically is specified between 100 and 10,000, depending upon the amount of
3747detail that one wants to bring out in the spectrum. Larger values produce more
3748visible detail. Too much detail, however, may hide the important features.</p>
3749
3750<p>The <a href="http://www.fftw.org/">FFTW</a> delegate library is required to
3751use <a href="command-line-options.html#fft">-fft</a>.</p>
3752
3753<p>Use <a href="command-line-options.html#fft">+fft</a> to produce two output images that are the real
3754and imaginary components of the complex valued Fourier transform.</p>
3755
3756<p>However, as the real and imaginary components can contain negative values,
3757this requires that IM be configured with HDRI enabled. In this case, you must
3758use either MIFF, TIF, PFM or MPC formats for the real and imaginary component
3759results, since they are formats that preserve both negative and fractional
3760values without clipping them or truncating the fractional part. With either
3761MIFF or TIF, one should add -define quantum:format=32, to allow those image
3762types to work properly in HDRI mode without clipping.</p>
3763
Cristy594d2772015-11-15 10:47:42 -05003764<p>The real and imaginary component images resulting from <a
3765href="command-line-options.html#fft">+fft</a> are also square, even dimensioned images due to the same
Cristy882d9f42015-10-29 16:48:39 -04003766padding that was discussed above for the magnitude and phase component
3767images.</p>
3768
Cristy594d2772015-11-15 10:47:42 -05003769<p>See the discussion on HDRI implementations of ImageMagick on the page <a
3770href="high-dynamic-range.html" >High Dynamic-Range Images</a>. For more
3771about HDRI go the ImageMagick <a
Cristy364a72f2016-11-04 22:38:41 -04003772href="https://www.imagemagick.org/Usage/basics/#hdri" >Usage</a> pages, <a
Cristy594d2772015-11-15 10:47:42 -05003773href="http://www.fmwconcepts.com/imagemagick/fourier_transforms/fourier.html"
3774>Fred's Fourier Processing With ImageMagick page</a> or this <a
3775 href="http://en.wikipedia.org/wiki/High_dynamic_range_imaging" >Wikipedia</a>
Cristy882d9f42015-10-29 16:48:39 -04003776 entry. </p>
3777
Cristy594d2772015-11-15 10:47:42 -05003778<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 -04003779
3780
3781<div style="margin: auto;">
3782 <h3 class="magick-header"><a id="fill"></a>-fill <var>color</var></h3>
3783</div>
3784
3785<p class="magick-description">color to use when filling a graphic primitive.</p>
3786
3787<p>This option accepts a color name, a hex color, or a numerical RGB, RGBA,
Cristy594d2772015-11-15 10:47:42 -05003788HSL, HSLA, CMYK, or CMYKA specification. See <a href="color.html" >Color Names</a> for
Cristy882d9f42015-10-29 16:48:39 -04003789a description of how to properly specify the color argument.</p>
3790
3791<p>Enclose the color specification in quotation marks to prevent the "#" or
3792the parentheses from being interpreted by your shell.</p>
3793
3794<p>For example,</p>
3795
3796<pre>
3797-fill blue
3798-fill "#ddddff"
3799-fill "rgb(255,255,255)"
3800</pre>
3801
3802<p>See <a href="command-line-options.html#draw">-draw</a> for further details.</p>
3803
3804<p>To print a complete list of color names, use the <a href="command-line-options.html#list">-list color</a> option.</p>
3805
3806<div style="margin: auto;">
3807 <h3 class="magick-header"><a id="filter"></a>-filter <var>type</var></h3>
3808</div>
3809
3810<p class="magick-description">Use this <var>type</var> of filter when resizing or distorting an image.</p>
3811
3812<p>Use this option to affect the resizing operation of an image during
Cristy594d2772015-11-15 10:47:42 -05003813operations such as <a href="command-line-options.html#resize">-resize</a> and <a href="command-line-options.html#distort"
3814>-distort</a>. For example you can use a simple resize filter such as:</p>
Cristy882d9f42015-10-29 16:48:39 -04003815
3816<pre>
3817Point Hermite Cubic
3818Box Gaussian Catrom
3819Triangle Quadratic Mitchell
3820</pre>
3821
3822<p>The <code>Bessel</code> and <code>Sinc</code> filter is also provided (as well
3823as a faster <code>SincFast</code> equivalent form). However these filters are
3824generally useless on their own as they are infinite filters that are being
3825clipped to the filters support size. Their direct use is not recommended
3826except via expert settings (see below). </p>
3827
3828<p>Instead these special filter functions are typically windowed by a windowing
Cristy594d2772015-11-15 10:47:42 -05003829function that the <a href="command-line-options.html#filter" >-filter</a> setting defines. That is
Cristy882d9f42015-10-29 16:48:39 -04003830using these functions will define a 'Windowed' filter, appropriate to the
3831operator involved. Windowed filters include: </p>
3832
3833<pre>
3834Lanczos Hamming Parzen
3835Blackman Kaiser Welsh
3836Hanning Bartlett Bohman
3837</pre>
3838
3839<p>Also one special self-windowing filter is also provided
3840<code>Lagrange</code>, which will automagically re-adjust its function depending
3841on the current 'support' or 'lobes' expert settings (see below).</p>
3842
3843<p>If you do not select a filter with this option, the filter defaults to
3844<code>Mitchell</code> for a colormapped image, an image with a matte channel, or
3845if the image is enlarged. Otherwise the filter default to
3846<code>Lanczos</code>.</p>
3847
3848<p>To print a complete list of resize filters, use the <a href="command-line-options.html#list">-list
3849filter</a> option.</p>
3850
3851<p>You can modify how the filter behaves as it scales your image through the
Cristy594d2772015-11-15 10:47:42 -05003852use of these expert settings (see also <a href="command-line-options.html#define" >-define</a> and <a
3853href="command-line-options.html#set" >-set</a>):-</p>
Cristy882d9f42015-10-29 16:48:39 -04003854
3855<table class="table table-condensed table-striped">
3856 <tr>
3857 <td>-define filter:blur=<var>factor</var></td>
3858 <td>Scale the X axis of the filter (and its window). Use &gt; 1.0 for
3859 blurry or &lt; 1.0 for sharp. This should only be used with Gaussian and
3860 Gaussian-like filters simple filters, or you may not get the expected
3861 results. </td>
3862 </tr>
3863
3864 <tr>
3865 <td>-define filter:support=<var>radius</var></td>
3866 <td>Set the filter support radius. Defines how large the filter should be and
3867 thus directly defines how slow the filtered resampling process is. All
3868 filters have a default 'preferred' support size. Some filters like
3869 <code>Lagrange</code> and windowed filters adjust themselves depending on
3870 this value. With simple filters this value either does nothing (but slow
3871 the resampling), or will clip the filter function in a detrimental way.
3872 </td>
3873 </tr>
3874
3875 <tr>
3876 <td>-define filter:lobes=<var>count</var></td>
3877 <td>Set the number of lobes to use for the Sinc/Bessel filter. This an
3878 alternative way of specifying the 'support' range of the filter, that is
3879 designed to be more suited to windowed filters, especially when used for
3880 image distorts.</td>
3881 </tr>
3882
3883 <tr>
3884 <td>-define filter:sigma=<var>value</var></td>
3885 <td>The 'sigma' value used to define the <code>Gaussian</code> filter. Default
3886 sigma value is '<code>0.5</code>'. It only effects <code>Gaussian</code> but
3887 does not shrink (but may enlarge) the filter's 'support'. It can be used
3888 to generate very small blurs but without the filter 'missing' pixels due
3889 to using a small support setting. A larger value of '<code>0.707</code>'
3890 (a value of '1/sqrt(2)') is another common setting. </td>
3891 </tr>
3892
3893 <tr>
3894 <td>-define filter:b=<var>b-spline_factor</var></td>
Cristy594d2772015-11-15 10:47:42 -05003895 <tr>
Cristy882d9f42015-10-29 16:48:39 -04003896 <td>-define filter:c=<var>keys_alpha_factor</var></td>
3897 <td>Redefine the values used for cubic filters such as <code>Cubic</code>,
3898 <code>Catrom</code>, <code>Mitchel</code>, and <code>Hermite</code>, as well as
3899 the <code>Parzen</code> cubic windowing function. If only one of the values
3900 are defined, the other is set so as to generate a 'Cubic-Keys' filter.
3901 The values meaning was defined by a research paper by
3902 Mitchell-Netravali.</td>
3903 </tr>
3904
3905 <tr>
3906 <td>-define filter:kaiser-beta=<var>value</var></td>
3907 <td>The 'alpha' value used to as part of the Kaiser Windowing function.
3908 Default value is '6.5'. It only effects Kaiser windowing function, and
3909 does not effect any other attributes.
3910 Before ImageMagick v6.7.6-10, this option was known as "filter:alpha", (an
3911 inheritance from the very old "zoom" program). It was changed to bring the
3912 function in line with more modern academic research usage, and better
3913 assign it be more definitive. </td>
3914 </tr>
3915
3916 <tr>
3917 <td>-define filter:kaiser-alpha=<var>value</var></td>
3918 <td>This value when multiplied by 'PI' is equivalent to "kaiser-beta", and
3919 will override that setting. It only effects Kaiser windowing function,
3920 and does not effect any other attributes. </td>
3921 </tr>
3922
3923 <tr>
3924 <td>-define filter:filter=<var>filter_function</var></td>
3925 <td>Use this function directly as the weighting filter. This will allow
3926 you to directly use a windowing function such as <code>Blackman</code>,
3927 as a resampling filter, rather than as its normal usage as a windowing
3928 function. If defined, no windowing function also defined, the window function is set
3929 to <code>Box</code>). Directly specifying <code>Sinc</code> or <code>Jinc</code>
3930 as a filter will also do this. </td>
3931 </tr>
3932
3933 <tr>
3934 <td>-define filter:window=<var>filter_function</var></td>
3935 <td>The IIR (infinite impulse response) filters <code>Sinc</code> and
3936 <code>Jinc</code> are windowed (brought down to zero over the defined
3937 support range) with the given filter. This allows you to specify a filter
3938 function to be used as a windowing function for these IIR filters.
3939 Many of the defined filters are actually windowing functions for these IIR
3940 filters. A typical choices is <code>Box</code>, (which effectively turns
3941 off the windowing function). </td>
3942 </tr>
3943
3944 <tr>
3945 <td>-define filter:win-support=<var>radius</var></td>
3946 <td>Scale windowing function to this size instead. This causes the windowing
3947 (or self-windowing Lagrange filter) to act is if the support window is
3948 larger than what is actually supplied to the calling operator. The filter
3949 however is still clipped to the real support size given. If unset this
3950 will equal the normal filter support size. </td>
3951 </tr>
3952
3953 <tr>
3954 <td>-define filter:verbose=<var>1</var></td>
3955 <td>This causes IM to print information on the final internal filter
3956 selection to standard output. This includes a commented header on the
3957 filter settings being used, and data allowing the filter weights to be
3958 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
3959 a <code>SincFast</code> windowed <code>SincFast</code> filter, while
3960 <code>Mitchell</code> is defined as a general <code>Cubic</code> family filter
3961 with specific 'B' and 'C' settings. </td>
3962 </tr>
3963
3964</table>
3965
3966<p>For example, to get a 8 lobe jinc windowed sinc filter (Genseng filter?):</p>
3967
3968<pre>
3969convert image.png \
3970 -filter sinc \
3971 -set filter:window=jinc \
3972 -set filter:lobes=8 \
3973 -resize 150% image.jpg"
3974</pre>
3975
3976<p>Or a raw un-windowed Sinc filter with 4 lobes:</p>
3977
3978<pre>
3979convert image.png \
3980 -set filter:filter=sinc \
3981 -set filter:lobes=4 \
3982 -resize 150% image.jpg"
3983</pre>
3984
3985<p>To extract the data for a raw windowing function, combine it with
3986a '<code>Box</code>' filter. For example the '<code>Welch</code> parabolic
3987windowing function. </p>
3988
3989<pre>
3990convert null: -define filter:filter=Box \
3991 -define filter:window=Welch \
3992 -define filter:support=1.0 \
3993 -define filter:verbose=1 \
Cristy594d2772015-11-15 10:47:42 -05003994 -resize 2 null: > window_welch.dat
Cristy882d9f42015-10-29 16:48:39 -04003995gnuplot
3996 set grid
3997 plot \"window_welch.dat\" with lines
3998</pre>
3999
4000<p>Note that the use of expert options is provided for image processing experts
4001who have studied and understand how resize filters work. Without this
4002knowledge, and an understanding of the definition of the actual filters
4003involved, using expert settings are more likely to be detrimental to your image
4004resizing.</p>
4005
4006
4007<div style="margin: auto;">
4008 <h3 class="magick-header"><a id="flatten"></a>-flatten</h3>
4009</div>
4010
Cristy594d2772015-11-15 10:47:42 -05004011<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 -04004012
4013
4014<div style="margin: auto;">
4015 <h3 class="magick-header"><a id="flip"></a>-flip</h3>
4016</div>
4017
4018<p class="magick-description">create a <var>mirror image</var></p>
4019
4020<p>reflect the scanlines in the vertical direction. The image will be mirrored
4021upside-down. </p>
4022
4023
4024<div style="margin: auto;">
4025 <h3 class="magick-header"><a id="floodfill"></a>-floodfill {<var>+-</var>}<var>x</var>{<var>+-</var>}<var>y</var> <var>color</var></h3>
4026</div>
4027
4028<p class="magick-description">floodfill the image with color at the specified offset.</p>
4029
4030<p>Flood fill starts from the given 'seed point' which is not gravity effected.
Cristy594d2772015-11-15 10:47:42 -05004031Any color that matches within <a href="command-line-options.html#fuzz" >-fuzz</a> color distance of the
Cristy882d9f42015-10-29 16:48:39 -04004032given <var>color</var> argument, connected to that 'seed point'
Cristy594d2772015-11-15 10:47:42 -05004033will be replaced with the current <a href="command-line-options.html#fill" >-fill</a> color. </p>
Cristy882d9f42015-10-29 16:48:39 -04004034
4035<p>Note that if the pixel at the 'seed point' does not itself match the given
Cristy594d2772015-11-15 10:47:42 -05004036<var>color</var> (according to <a href="command-line-options.html#fuzz" >-fuzz</a>), then no
Cristy882d9f42015-10-29 16:48:39 -04004037action will be taken. </p>
4038
Cristy594d2772015-11-15 10:47:42 -05004039<p>This operator works more like the <a href="command-line-options.html#opaque" >-opaque</a> option, than
Cristy882d9f42015-10-29 16:48:39 -04004040a more general flood fill that reads the matching color directly at the 'seed
Cristy594d2772015-11-15 10:47:42 -05004041point'. For this form of flood fill, look at <a href="command-line-options.html#draw" >-draw</a> and
Cristy882d9f42015-10-29 16:48:39 -04004042its 'color floodfill' drawing method. </p>
4043
4044
4045<div style="margin: auto;">
4046 <h3 class="magick-header"><a id="flop"></a>-flop</h3>
4047</div>
4048
4049<p class="magick-description">create a <var>mirror image</var>.</p>
4050
4051<p>Reflect the scanlines in the horizontal direction, just like the image in
4052a vertical mirror. </p>
4053
4054
4055<div style="margin: auto;">
4056 <h3 class="magick-header"><a id="font"></a>-font <var>name</var></h3>
4057</div>
4058
4059<p class="magick-description">set the font to use when annotating images with text, or creating labels.</p>
4060
4061<p>To print a complete list of fonts, use the <a href="command-line-options.html#list">-list font</a>
4062option (for versions prior to 6.3.6, use 'type' instead of 'font').</p>
4063
4064<p>In addition to the fonts specified by the above pre-defined list, you can
4065also specify a font from a specific source. For example <code>Arial.ttf</code>
4066is a TrueType font file, <code>ps:helvetica</code> is PostScript font, and
4067<code>x:fixed</code> is X11 font.</p>
4068
Cristy594d2772015-11-15 10:47:42 -05004069<p>For other settings that affect fonts, see the options <a
4070href="command-line-options.html#family">-family</a>, <a href="command-line-options.html#stretch">-stretch</a>, <a
4071href="command-line-options.html#style">-style</a>, and <a href="command-line-options.html#weight">-weight</a>. </p>
Cristy882d9f42015-10-29 16:48:39 -04004072
4073
4074<div style="margin: auto;">
4075 <h3 class="magick-header"><a id="foreground"></a>-foreground <var>color</var></h3>
4076</div>
4077
4078<p class="magick-description">Define the foreground color for menus.", "display</p>
4079
Cristy594d2772015-11-15 10:47:42 -05004080<p>The color is specified using the format described under the <a
4081href="command-line-options.html#fill">-fill</a> option.</p>
Cristy882d9f42015-10-29 16:48:39 -04004082
4083<p>The default foreground color is black.</p>
4084
4085<div style="margin: auto;">
4086 <h3 class="magick-header"><a id="format"></a>-format <var>type</var></h3>
4087</div>
4088
4089<p class="magick-description">the image format type.</p>
4090
4091<p>When used with the <code>mogrify</code> utility, this option converts any
4092image to the image <a href="formats.html">format</a> you specify.
Cristy594d2772015-11-15 10:47:42 -05004093For a list of image format types supported by ImageMagick, use <a
4094href="command-line-options.html#list">-list format</a>.</p>
Cristy882d9f42015-10-29 16:48:39 -04004095
4096<p>By default the file is written to its original name. However, if the
4097filename extension matches a supported format, the extension is replaced with
4098the image format type specified with <a href="command-line-options.html#format">-format</a>. For
4099example, if you specify <var>tiff</var> as the format type and the
4100input image filename is <var>image.gif</var>, the output image
4101filename becomes <var>image.tiff</var>.</p>
4102
4103<div style="margin: auto;">
4104 <h3 class="magick-header"><a id="format_identify_"></a>-format <var>string</var></h3>
4105</div>
4106
4107<p class="magick-description">output formatted image characteristics.</p>
4108
4109<p>See <a href="escape.html">Format and Print Image
4110Properties</a> for an explanation on how to specify the argument to this
4111option.</p>
4112
4113<div style="margin: auto;">
4114 <h3 class="magick-header"><a id="frame"></a>-frame <var>geometry</var></h3>
4115</div>
4116
4117<p class="magick-description">Surround the image with a border or beveled frame.</p>
4118
Cristyf650f4f2016-04-01 10:53:07 -04004119<p>The color of the border is specified with the <a href="command-line-options.html#alpha-color"
4120>-alpha-color</a> command line option. </p>
Cristy882d9f42015-10-29 16:48:39 -04004121
4122<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
4123height that is added to the dimensions of the image. If no offsets are given
4124in the <var>geometry</var> argument, then the border added is
4125a solid color. Offsets <var>x</var> and <var>y</var>, if present, specify that
4126the width and height of the border is partitioned to form an outer bevel of
4127thickness <var>x</var> pixels and an inner bevel of thickness
4128<var>y</var> pixels. Negative offsets make no sense as frame arguments.
4129</p>
4130
Cristy594d2772015-11-15 10:47:42 -05004131<p>The <a href="command-line-options.html#frame">-frame</a> option is affected by the current <a
4132href="command-line-options.html#compose">-compose</a> setting and assumes that this is using the default
Cristy882d9f42015-10-29 16:48:39 -04004133'<code>Over</code>' composition method. It generates an image of the appropriate
4134size with the current <a href="command-line-options.html#bordercolor">-bordercolor</a> setting, and then
Cristy594d2772015-11-15 10:47:42 -05004135draws the frame of four distinct colors close to the current <a
Cristyf650f4f2016-04-01 10:53:07 -04004136href="command-line-options.html#alpha-color">-alpha-color</a>. The original image is then overlaid onto
Cristy882d9f42015-10-29 16:48:39 -04004137center of this image. This means that with the default compose method of
Cristy594d2772015-11-15 10:47:42 -05004138'<code>Over</code>' any transparent parts may be replaced by the current <a
4139href="command-line-options.html#bordercolor">-bordercolor</a> setting.</p>
Cristy882d9f42015-10-29 16:48:39 -04004140
4141<p>The image composition is not
4142affected by the <a href="command-line-options.html#gravity">-gravity</a> option.</p>
4143
4144
4145<div style="margin: auto;">
4146 <h3 class="magick-header"><a id="frame_import_"></a>-frame</h3>
4147</div>
4148
4149<p class="magick-description">include the X window frame in the imported image. </p>
4150<div style="margin: auto;">
4151 <h3 class="magick-header"><a id="function"></a>-function <var>function</var> <var>parameters</var></h3>
4152</div>
4153
4154<p class="magick-description">Apply a function to channel values.</p>
4155
4156<p>This operator performs calculations based on the given arguments to modify
Cristy594d2772015-11-15 10:47:42 -05004157each of the color values for each previously set <a
4158href="command-line-options.html#channel">-channel</a> in the image. See <a
4159href="command-line-options.html#evaluate">-evaluate</a> for details concerning how the results of the
Cristy882d9f42015-10-29 16:48:39 -04004160calculations are handled.</p>
4161
Cristy594d2772015-11-15 10:47:42 -05004162<p>This is can be considered a multi-argument version of the <a
4163href="command-line-options.html#evaluate">-evaluate</a> operator. (Added in
Cristy882d9f42015-10-29 16:48:39 -04004164ImageMagick 6.4.8−8.)</p>
4165
4166<p>Here, <var>parameters</var> is a comma-separated list of
4167numerical values. The number of values varies depending on which <var>function</var> is selected. Choose the <var>function</var> from:</p>
4168
4169<pre>
4170Polynomial
4171Sinusoid
4172Arcsin
4173Arctan
4174</pre>
4175
4176<p>To print a complete list of <a href="command-line-options.html#function">-function</a> operators,
4177use <a href="command-line-options.html#list">-list function</a>. Descriptions follow.</p>
4178
4179<dl class="dl-horizontal">
4180 <dt>Polynomial</dt>
4181 <dd><p>The <code>Polynomial</code> function takes an arbitrary number of parameters,
4182these being the coefficients of a polynomial, in decreasing order of degree.
4183That is, entering</p>
4184
4185<pre>
4186-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>
4187</pre>
4188
4189<p>will invoke a polynomial function given by</p>
4190
4191<pre>
4192<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>,
4193</pre>
4194
4195<p>where <b><var>u</var></b> is pixel's original normalized channel value.</p>
4196
4197<p>The <code>Polynomial</code> function can be used in place of <code>Set</code>
4198(the <var>constant</var> polynomial) and <code>Add</code>, <code>Divide</code>,
4199<code>Multiply</code>, and <code>Subtract</code> (some <var>linear</var>
Cristy594d2772015-11-15 10:47:42 -05004200polynomials) of the <a href="command-line-options.html#evaluate">-evaluate</a> operator. The <a
4201href="command-line-options.html#level">-level</a> operator also affects channels linearly. Some
Cristy882d9f42015-10-29 16:48:39 -04004202correspondences follow.</p>
4203
4204<table class="table table-condensed table-striped">
4205 <tr>
4206 <td>-evaluate Set <var>value</var> </td>
4207 <td>-function Polynomial <var>value</var></td>
4208 <td>(Constant functions; set <var>value</var>×100% gray when channels are RGB.)</td>
4209 </tr>
4210 <tr>
4211 <td>-evaluate Add <var>value</var> </td>
4212 <td>-function Polynomial 1,<var>value</var></td>
4213 </tr>
4214 <tr>
4215 <td>-evaluate Subtract <var>value</var> </td>
4216 <td>-function Polynomial 1,−<var>value</var></td>
4217 </tr>
4218 <tr>
4219 <td>-evaluate Multiply <var>value</var> </td>
4220 <td>-function Polynomial <var>value</var>,0</td>
4221 </tr>
4222 <tr>
4223 <td>+level black% x white%</td>
4224 <td>-function Polynomial A,B</td>
4225 <td>(Reduce contrast. Here, A=(white-black)/100 and B=black/100.)</td>
4226 </tr>
4227</table>
4228
4229<p>The <code>Polynomial</code> function gives great versatility, since
4230polynomials can be used to fit any continuous curve to any degree of accuracy
4231desired.</p>
4232
4233</dd>
4234<dt>Sinusoid</dt>
4235<dd>
4236<p>The <code>Sinusoid</code> function can be used to vary the channel values
4237sinusoidally by setting frequency, phase shift, amplitude, and a bias. These
4238values are given as one to four parameters, as follows,</p>
4239
4240<pre>
4241-function <code>Sinusoid</code> <var>freq</var>,[<var>phase</var>,[<var>amp</var>,[<var>bias</var>]]]
4242</pre>
4243
4244<p>where <var>phase</var> is in degrees. (The domain [0,1] of the function
4245corresponds to 0 through <var>freq</var>×360 degrees.)
4246The result is that if a pixel's normalized channel value is originally
4247<b><var>u</var></b>, its resulting normalized value is given by </p>
4248
4249<pre>
4250<var>amp</var> * sin(2*π* (<var>freq</var> * <b><var>u</var></b> + <var>phase</var> / 360)) + <var>bias</var>
4251</pre>
4252
4253<p> For example, the following generates a curve that starts and ends at 0.9
4254(when <b><var>u</var></b>=0 and 1, resp.), oscillating three times between
4255.7−.2=.5 and .7+.2=.9. </p>
4256
4257<pre>
4258-function Sinusoid 3,-90,.2,.7
4259</pre>
4260
4261<p>The default values of <var>amp</var> and <var>bias</var> are both .5. The default for <var>phase</var>
4262is 0.</p>
4263
4264<p>The <code>Sinusoid</code> function generalizes <code>Sin</code> and
4265<code>Cos</code> of the <a href="command-line-options.html#evaluate">-evaluate</a> operator by allowing
4266varying amplitude, phase and bias. The correspondence is as follows.</p>
4267
4268<table class="table table-condensed table-striped">
4269 <tr>
4270 <td>-evaluate Sin <var>freq</var> </td>
4271 <td>-function Sinusoid <var>freq</var>,0 </td>
4272 </tr>
4273 <tr>
4274 <td>-evaluate Cos <var>freq</var> </td>
4275 <td>-function Sinusoid <var>freq</var>,90 </td>
4276 </tr>
4277</table>
4278 </dd>
4279<dt>ArcSin</dt>
4280<dd>
4281<p>The <code>ArcSin</code> function generates the inverse curve of a Sinusoid,
4282and can be used to generate cylindrical distortion and displacement maps.
4283The curve can be adjusted relative to both the input values and output range
4284of values.</p>
4285
4286<pre>
4287-function <code>ArcSin</code> <var>width</var>,[<var>center</var>,[<var>range</var>,[<var>bias</var>]]]
4288</pre>
4289
4290<p>with all values given in terms of normalized color values (0.0 for black,
42911.0 for white). Defaulting to values covering the full range from 0.0 to 1.0
4292for bout input (<var>width</var>), and output (<var>width</var>) values. '<code>1.0,0.5,1.0,0.5</code>' </p>
4293
4294<pre>
4295<var>range</var>/π * asin( 2/<var>width</var> * ( <b><var>u</var></b> - <var>center</var> ) ) + <var>bias</var>
4296</pre>
4297
4298</dd>
4299<dt>ArcTan</dt>
4300<dd>
4301<p>The <code>ArcTan</code> function generates a curve that smooth crosses from
4302limit values at infinities, though a center using the given slope value.
4303All these values can be adjusted via the arguments.</p>
4304
4305<pre>
4306-function <code>ArcTan</code> <var>slope</var>,[<var>center</var>,[<var>range</var>,[<var>bias</var>]]]
4307</pre>
4308
4309<p>Defaulting to '<code>1.0,0.5,1.0,0.5</code>'.
4310</p>
4311
4312<pre>
4313<var>range</var>/π * atan( <var>slope</var>*π * ( <b><var>u</var></b> - <var>center</var> ) ) + <var>bias</var>
4314</pre>
4315 </dd>
Cristy594d2772015-11-15 10:47:42 -05004316 </tr>
Cristy882d9f42015-10-29 16:48:39 -04004317</dl>
4318
4319
4320
4321<div style="margin: auto;">
4322 <h3 class="magick-header"><a id="fuzz"></a>-fuzz <var>distance</var>{<var>%</var>}</h3>
4323</div>
4324
4325<p class="magick-description">Colors within this <var>distance</var> are considered equal.</p>
4326
4327<p>A number of algorithms search for a target color. By default the color must
4328be exact. Use this option to match colors that are close to the target color
4329in RGB space. For example, if you want to automagically trim the edges of an
4330image with <a href="command-line-options.html#trim">-trim</a> but the image was scanned and the target
4331background color may differ by a small amount. This option can account for
4332these differences.</p>
4333
4334<p>The <var>distance</var> can be in absolute intensity units or, by
4335appending <code>%</code> as a percentage of the maximum possible intensity (255,
433665535, or 4294967295).</p>
4337
Cristy594d2772015-11-15 10:47:42 -05004338<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 -04004339
4340
4341<div style="margin: auto;">
4342 <h3 class="magick-header"><a id="fx"></a>-fx <var>expression</var></h3>
4343</div>
4344
4345<p class="magick-description">apply a mathematical expression to an image or image channels.</p>
4346
4347<p>If the first character of <var>expression</var> is <code>@</code>,
4348the expression is read from a file titled by the remaining characters in the
4349string.</p>
4350
4351<p>See <a href="fx.html">FX,
4352The Special Effects Image Operator</a> for a detailed discussion of this
4353option.</p>
4354
4355
4356<div style="margin: auto;">
4357 <h3 class="magick-header"><a id="gamma"></a>-gamma <var>value</var></h3>
4358</div>
4359
4360<p class="magick-description">level of gamma correction.</p>
4361
4362<p>The same color image displayed on two different workstations may look
4363different due to differences in the display monitor. Use gamma correction to
4364adjust for this color difference. Reasonable values extend from
4365<code>0.8</code> to <code>2.3</code>. Gamma less than 1.0 darkens the image and
4366gamma greater than 1.0 lightens it. Large adjustments to image gamma may
4367result in the loss of some image information if the pixel quantum size is only
4368eight bits (quantum range 0 to 255).</p>
4369
4370<p>Gamma adjusts the image's channel values pixel-by-pixel according to
4371a power law, namely, pow(pixel,1/gamma) or pixel^(1/gamma), where pixel is the
4372normalized or 0 to 1 color value. For example, using a value of gamma=2 is the
4373same as taking the square root of the image.</p>
4374
4375<p>You can apply separate gamma values to the red, green, and blue channels of
4376the image with a gamma value list delimited with commas (e.g.,
4377<code>1.7,2.3,1.2</code>).</p>
4378
4379<p>Use <a href="command-line-options.html#gamma">+gamma <var>value</var></a> to set the
4380image gamma level without actually adjusting the image pixels. This option
4381is useful if the image is of a known gamma but not set as an image attribute
4382(e.g. PNG images). Write the "file gamma" which is the reciprocal of the
4383display gamma; e.g., if your image is sRGB and you want to write a PNG gAMA
4384chunk, use</p>
4385
4386<pre>
4387convert input.png +gamma .45455 output.png
4388</pre>
4389
4390<p>(0.45455 is 1/2.2)</p>
4391
4392<p>Note that gamma adjustments are also available via the <a href="command-line-options.html#level">-level</a> operator.</p>
4393
4394<div style="margin: auto;">
Cristy594d2772015-11-15 10:47:42 -05004395 <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 -04004396</div>
4397
4398<p class="magick-description">Blur the image with a Gaussian operator.</p>
4399
4400<p>Convolve the image with a Gaussian or normal distribution using the given
Cristy594d2772015-11-15 10:47:42 -05004401<var >Sigma</var> value. The formula is:</p>
Cristy882d9f42015-10-29 16:48:39 -04004402
Cristy594d2772015-11-15 10:47:42 -05004403<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 -04004404
Cristy594d2772015-11-15 10:47:42 -05004405<p>The <var >Sigma</var> value is the important argument, and
Cristy882d9f42015-10-29 16:48:39 -04004406determines the actual amount of blurring that will take place. </p>
4407
Cristy594d2772015-11-15 10:47:42 -05004408<p>The <var >Radius</var> is only used to determine the size of the
Cristy882d9f42015-10-29 16:48:39 -04004409array which will hold the calculated Gaussian distribution. It should be an
4410integer. If not given, or set to zero, IM will calculate the largest possible
4411radius that will provide meaningful results for the Gaussian distribution.
4412</p>
4413
Cristy594d2772015-11-15 10:47:42 -05004414<p>The larger the <var >Radius</var> the radius the slower the
4415operation is. However too small a <var >Radius</var>, and sever
4416aliasing effects may result. As a guideline, <var >Radius</var>
4417should be at least twice the <var >Sigma</var> value, though three
Cristy882d9f42015-10-29 16:48:39 -04004418times will produce a more accurate result. </p>
4419
4420<p>This differs from the faster <a href="command-line-options.html#blur">-blur</a> operator in that a
4421full 2-dimensional convolution is used to generate the weighted average of the
4422neighboring pixels. </p>
4423
4424<p>The <a href="command-line-options.html#virtual-pixel">-virtual-pixel</a> setting will determine how
4425pixels which are outside the image proper are blurred into the final result.
4426</p>
4427
4428
4429<div style="margin: auto;">
4430 <h3 class="magick-header"><a id="geometry"></a>-geometry <var>geometry</var></h3>
4431</div>
4432
4433<p class="magick-description">Set the preferred size and location of the image.</p>
4434
4435<p>See <a href="command-line-processing.html#geometry">Image Geometry</a> for complete details about the <em class="arg">geometry</em> argument.</p>
4436
4437<div style="margin: auto;">
4438 <h3 class="magick-header"><a id="gravity"></a>-gravity <var>type</var></h3>
4439</div>
4440
4441<p class="magick-description">Sets the current gravity suggestion for various other settings and options.</p>
4442
4443<p>Choices include: <code>NorthWest</code>, <code>North</code>,
4444<code>NorthEast</code>, <code>West</code>, <code>Center</code>, <code>East</code>,
Cristy594d2772015-11-15 10:47:42 -05004445<code>SouthWest</code>, <code>South</code>, <code>SouthEast</code>. Use <a
4446href="command-line-options.html#list">-list gravity</a> to get a complete list of <a
4447href="command-line-options.html#gravity">-gravity</a> settings available in your ImageMagick
Cristy882d9f42015-10-29 16:48:39 -04004448installation.</p>
4449
4450<p>The direction you choose specifies where to position text or subimages. For
4451example, a gravity of <code>Center</code> forces the text to be centered within
Cristy776113a2016-04-29 12:01:19 -04004452the image. By default, the image gravity is <code>undefined</code>. See <a
Cristy594d2772015-11-15 10:47:42 -05004453href="command-line-options.html#draw">-draw</a> for more details about graphic primitives. Only the
4454text primitive of <a href="command-line-options.html#draw">-draw</a> is affected by the <a
4455href="command-line-options.html#gravity">-gravity</a> option.</p>
Cristy882d9f42015-10-29 16:48:39 -04004456
4457<p>The <a href="command-line-options.html#gravity">-gravity</a> option is also used in concert with the
4458<a href="command-line-options.html#geometry">-geometry</a> setting and other settings or options that
Cristy594d2772015-11-15 10:47:42 -05004459take <var>geometry</var> as an argument, such as the <a
4460href="command-line-options.html#crop">-crop</a> option. </p>
Cristy882d9f42015-10-29 16:48:39 -04004461
4462<p>If a <a href="command-line-options.html#gravity">-gravity</a> setting occurs before another option
4463or setting having a <var>geometry</var> argument that specifies an
4464offset, the offset is usually applied to the point within the image suggested
4465by the <a href="command-line-options.html#gravity">-gravity</a> argument. Thus, in the following
4466command, for example, suppose the file <code>image.png</code> has dimensions
4467200x100. The offset specified by the argument to <a href="command-line-options.html#region">-region</a>
4468is (−40,+20). The argument to <a href="command-line-options.html#gravity">-gravity</a> is
4469<code>Center</code>, which suggests the midpoint of the image, at the point
4470(100,50). The offset (−40,20) is applied to that point, giving
4471(100−40,50+20)=(60,70), so the specified 10x10 region is located at
4472that point. (In addition, the <a href="command-line-options.html#gravity">-gravity</a> affects the
4473region itself, which is <var>centered</var> at the pixel
4474coordinate (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>
4475
4476<pre>
4477convert image.png -gravity Center -region 10x10-40+20 \
4478 -negate output.png
4479</pre>
4480
Cristy594d2772015-11-15 10:47:42 -05004481<p>When used as an option to <a href="composite.html">composite</a>, <a
4482href="command-line-options.html#gravity">-gravity</a> gives the direction that the image gravitates
Cristy882d9f42015-10-29 16:48:39 -04004483within the composite.</p>
4484
Cristy594d2772015-11-15 10:47:42 -05004485<p>When used as an option to <a href="montage.html">montage</a>, <a
4486href="command-line-options.html#gravity">-gravity</a> gives the direction that an image gravitates
Cristy882d9f42015-10-29 16:48:39 -04004487within a tile. The default gravity is <code>Center</code> for this purpose.</p>
4488
4489
4490<div style="margin: auto;">
4491 <h3 class="magick-header"><a id="grayscale"></a>-grayscale <var>method</var></h3>
4492</div>
4493
4494<p class="magick-description">convert image to grayscale.</p>
4495
Cristy594d2772015-11-15 10:47:42 -05004496<p>This will use one of the <a href="command-line-options.html#intensity" >-intensity</a> methods to
Cristy882d9f42015-10-29 16:48:39 -04004497convert the given image into a linear-grayscale image. </p>
4498
4499<p>For example, to convert an image to (linear) Rec709Luminance grayscale, type:</p>
4500
4501<pre>
4502convert in.png -grayscale Rec709Luminance out.png
4503</pre>
4504
4505<p>which is equivalent to:</p>
4506
4507<pre>
4508convert in.png -colorspace gray out.png
4509</pre>
4510
4511<p>Similarly, to convert an image to (non-linear) Rec709Luma grayscale, type:</p>
4512
4513<pre>
4514convert in.png -grayscale Rec709Luma out.png
4515</pre>
4516
4517<p>which is equivalent to:</p>
4518
4519<pre>
4520convert in.png -set colorspace RGB -colorspace gray out.png
4521</pre>
4522
4523<p>Note that a 'colorspace' intensity method will produce the same result
4524regardless of the current colorpsace of the image. But a 'mathematical'
4525intensity method will depend on the current colorspace the image is currently
4526using. </p>
4527
Cristy594d2772015-11-15 10:47:42 -05004528<p>While this operation uses an <a href="command-line-options.html#intensity" >-intensity</a> method,
4529it does not use or set the <a href="command-line-options.html#intensity" >-intensity</a> setting, so
Cristy882d9f42015-10-29 16:48:39 -04004530will not effect other operations that may use that setting.</p>
4531
4532
4533<div style="margin: auto;">
4534 <h3 class="magick-header"><a id="green-primary"></a>-green-primary <var>x,y</var></h3>
4535</div>
4536
4537<p class="magick-description">green chromaticity primary point.</p>
4538
4539
4540<div style="margin: auto;">
4541 <h3 class="magick-header"><a id="hald-clut"></a>-hald-clut</h3>
4542</div>
4543
4544<p class="magick-description">apply a Hald color lookup table to the image.</p>
4545
4546<p>A Hald color lookup table is a 3-dimensional color cube mapped to 2
4547dimensions. Create it with the <code>HALD:</code> prefix (e.g. HALD:8). You
4548can apply any color transformation to the Hald image and then use this option
4549to apply the transform to the image. </p>
4550
4551<pre>
4552convert image.png hald.png -hald-clut transform.png
4553</pre>
4554
4555<p>This option provides a convenient method for you to use Gimp or Photoshop
4556to make color corrections to the Hald CLUT image and subsequently apply them
4557to multiple images using an ImageMagick script. </p>
4558
4559<p>Note that the representation is only of the normal RGB color space and that
4560the whole color value triplet is used for the interpolated lookup of the
Cristy594d2772015-11-15 10:47:42 -05004561represented Hald color cube image. Because of this the operation is not <a
4562href="command-line-options.html#channel" >-channel</a> setting effected, nor can it adjust or modify an
Cristy882d9f42015-10-29 16:48:39 -04004563images transparency or alpha/matte channel.</p>
4564
Cristy594d2772015-11-15 10:47:42 -05004565<p>See also <a href="command-line-options.html#clut" >-clut</a> which provides color value replacement
Cristy769d8892016-01-19 18:11:14 -05004566of the individual color channels, usually involving a simpler grayscale
4567image. E.g: grayscale to color replacement, or modification by a histogram
Cristy882d9f42015-10-29 16:48:39 -04004568mapping. </p>
4569
4570
4571<div style="margin: auto;">
4572 <h3 class="magick-header"><a id="help"></a>-help</h3>
4573</div>
4574
4575<p class="magick-description">print usage instructions.</p>
4576
4577<div style="margin: auto;">
4578 <h3 class="magick-header"><a id="highlight-color"></a>-highlight-color <var>color</var></h3>
4579</div>
4580
4581<p class="magick-description">when comparing images, emphasize pixel differences with this color.</p>
4582
4583<div style="margin: auto;">
4584 <h3 class="magick-header"><a id="hough-lines"></a>-hough-lines <var>width</var>x<var>height</var>{<var>+threshold</var>}</h3>
4585</div>
4586
4587<p class="magick-description">identify straight lines in the image (e.g. -hough-lines 9x9+195).</p>
4588
4589<p>Use the Hough line detector with any binary edge extracted image to locate and draw any straight lines that it finds.</p>
4590
4591<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>.
4592
4593<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>
4594
Cristy594d2772015-11-15 10:47:42 -05004595<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 -04004596
Cristy594d2772015-11-15 10:47:42 -05004597<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 -04004598
Cristy594d2772015-11-15 10:47:42 -05004599<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 -04004600
4601<p>A text file listing the endpoints and counts may be created by using the suffix, .mvg, for the output image.</p>
4602
Cristy594d2772015-11-15 10:47:42 -05004603<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 -04004604
4605<div style="margin: auto;">
4606 <h3 class="magick-header"><a id="iconGeometry"></a>-iconGeometry <var>geometry</var></h3>
4607</div>
4608
4609<p class="magick-description">specify the icon geometry.</p>
4610
4611<p>Offsets, if present in the geometry specification, are handled in the same
4612manner as the <a href="command-line-options.html#geometry">-geometry</a> option, using X11 style to
4613handle negative offsets.</p>
4614
4615<p>See <a href="command-line-processing.html#geometry">Image Geometry</a> for complete details about the <em class="arg">geometry</em> argument.</p>
4616
4617<div style="margin: auto;">
4618 <h3 class="magick-header"><a id="iconic"></a>-iconic</h3>
4619</div>
4620
4621<p class="magick-description">start in icon mode in X Windows", 'animate', 'display</p>
4622
4623<div style="margin: auto;">
4624 <h3 class="magick-header"><a id="identify"></a>-identify</h3>
4625</div>
4626
4627<p class="magick-description">identify the format and characteristics of the image.</p>
4628
4629<p>This information is printed: image scene number; image name; image size;
4630the image class (<var>DirectClass</var> or <var>PseudoClass</var>); the total number of unique colors; and the
4631number of seconds to read and transform the image. Refer to <a href="miff.html">MIFF</a> for
4632a description of the image class.</p>
4633
4634<p>If <a href="command-line-options.html#colors">-colors</a> is also specified, the total unique colors
Cristy594d2772015-11-15 10:47:42 -05004635in the image and color reduction error values are printed. Refer to <a
Cristy6549abb2016-11-10 08:25:55 -05004636href="http://www.imagemagick.org/www/quantize.html">color
Cristy882d9f42015-10-29 16:48:39 -04004637reduction algorithm</a> for a description of these values.</p>
4638
4639<p>If <a href="command-line-options.html#verbose">-verbose</a> precedes this option, copious
4640amounts of image properties are displayed including image statistics, profiles,
4641image histogram, and others.</p>
4642
4643<div style="margin: auto;">
4644 <h3 class="magick-header"><a id="ift"></a>-ift</h3>
4645</div>
4646
4647<p class="magick-description">implements the inverse discrete Fourier transform (DFT).</p>
4648
4649<p>This option is new as of ImageMagick 6.5.4-3 (and now working for Windows
4650users in ImageMagick 6.6.0-9). It transforms a pair of magnitude and phase
4651images from the frequency domain to a single image in the normal or spatial
Cristy594d2772015-11-15 10:47:42 -05004652domain. See for example, <a
4653href="http://en.wikipedia.org/wiki/Fourier_transform">Fourier Transform</a>,
Cristy882d9f42015-10-29 16:48:39 -04004654<a href="http://en.wikipedia.org/wiki/DFT">Discrete Fourier Transform</a> and
4655<a href="http://en.wikipedia.org/wiki/FFT">Fast Fourier Transform</a>.</p>
4656
4657<p>For example, depending upon the image format used to store the result of
4658the <a href="command-line-options.html#fft">-fft</a>, one would use either</p>
4659
4660<pre>
4661convert fft_image.miff -ift fft_image_ift.png
4662</pre>
4663
4664<p>or</p>
4665
4666<pre>
4667convert fft_image-0.png fft_image-1.png -ift fft_image_ift.png
4668</pre>
4669
4670<p>The resulting image may need to be cropped due to padding introduced when
Cristy594d2772015-11-15 10:47:42 -05004671the original image, prior to the <a href="command-line-options.html#fft">-fft</a> or <a
4672href="command-line-options.html#fft">+fft</a>, was not square or even dimensioned. Any padding is at
Cristy882d9f42015-10-29 16:48:39 -04004673the right and/or bottom sides of the image.</p>
4674
4675<p>The <a href="http://www.fftw.org/">FFTW</a> delegate library is required to
4676use <a href="command-line-options.html#ift">-ift</a>.</p>
4677
4678<p>Use <a href="command-line-options.html#ift">+ift</a> (with HDRI enabled) to transform a pair of real
4679and imaginary images from the frequency domain to a single image in the normal
4680(spatial) domain.</p>
4681
Cristy594d2772015-11-15 10:47:42 -05004682<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 -04004683
4684<div style="margin: auto;">
4685 <h3 class="magick-header"><a id="immutable"></a>-immutable</h3>
4686</div>
4687
4688<p class="magick-description">make image immutable.</p>
4689
4690<div style="margin: auto;">
4691 <h3 class="magick-header"><a id="implode"></a>-implode <var>factor</var></h3>
4692</div>
4693
4694<p class="magick-description">implode image pixels about the center.</p>
4695
4696<div style="margin: auto;">
4697 <h3 class="magick-header"><a id="insert"></a>-insert <var>index</var></h3>
4698</div>
4699
4700<p class="magick-description">insert the last image into the image sequence.</p>
4701
4702<p>This option takes last image in the current image sequence and inserts it
4703at the given index. If a negative index is used, the insert position is
4704calculated before the last image is removed from the sequence. As such
4705<code>-insert -1</code> will result in no change to the image sequence.</p>
4706
4707<p>The <code>+insert</code> option is equivalent to <code>-insert -1</code>. In
4708other words, insert the last image, at the end of the current image sequence.
4709Consequently this has no effect on the image sequence order.</p>
4710
4711<div style="margin: auto;">
4712 <h3 class="magick-header"><a id="intensity"></a>-intensity <var>method</var></h3>
4713</div>
4714
4715<p class="magick-description">method to generate intensity value from pixel.</p>
4716
4717<p>ImageMagick provides a number of methods used in situations where an
4718operator needs to determine a single grayscale value for some purpose, from
4719an image with red, green, and blue pixel components. Typically the linear
4720<code>Rec709Luminance</code> formula is used, which is the same formula used when
4721converting images to <code>-colorspace gray</code>. </p>
4722
4723<p>The following formulas are currently provided, and will first convert
4724the pixel values to linear-RGB or non-linear sRGB colorspace before
4725being applied to calculate the final greyscale value. </p>
4726
4727<dl class="dl-horizontal">
4728<dt>Rec601Luma</dt><dd> 0.298839R' + 0.586811G'+ 0.114350B'</dd>
4729<dt>Rec601Luminance</dt><dd> 0.298839R + 0.586811G + 0.114350B</dd>
4730<dt>Rec709Luma</dt><dd> 0.212656R' + 0.715158G' + 0.072186B'</dd>
4731<dt>Rec709Luminance</dt><dd> 0.212656R + 0.715158G + 0.072186B</dd>
4732<dt>Brightness</dt><dd> max(R', G', B')</dd>
4733<dt>Lightness</dt><dd> (min(R', G', B') + max(R', G', B')) / 2.0</dd>
4734</dl>
4735
4736<p>Note that the above R,G,B values is the image's linear-RGB values, while
4737R',G',B' are sRGB non-linear values. </p>
4738
4739<p>These intensity methods are mathematical in nature and will use the
4740current value in the images respective R,G,B channel regardless of
4741what that is, or what colorspace the image is currently using.</p>
4742
4743<dl class="dl-horizontal">
4744<dt>Average</dt><dd>(R + G + B) / 3.0</dd>
4745<dt>MS</dt><dd>(R^2 + G^2 + B^2) / 3.0</dd>
4746<dt>RMS</dt><dd>sqrt( (R^2 + G^2 + B^2) / 3.0 )</dd>
4747</dl>
4748
4749<p>These methods are often used for other purposes, such as generating a
Cristy594d2772015-11-15 10:47:42 -05004750grayscale difference image between two color images (using <a href="command-line-options.html#compose"
4751>-compose</a> '<code>Difference</code>' composition. </p>
Cristy882d9f42015-10-29 16:48:39 -04004752
4753<p> For example The 'MS' (Mean Squared) setting is good for minimizing color
4754error comparisions. While... The method 'RMS' (Root Mean Squared) for
4755example is appropriate for calculating color vector distance, from a color
Cristy594d2772015-11-15 10:47:42 -05004756difference image. This is equivalent to the color only component of the <a
4757href="command-line-options.html#fuzz" >-fuzz</a> factor color compare setting. </p>
Cristy882d9f42015-10-29 16:48:39 -04004758
Cristy594d2772015-11-15 10:47:42 -05004759<p>See also <a href="command-line-options.html#grayscale" >-grayscale</a> which applies one of the above
4760grayscaling formula directly to an image without setting the <a
4761href="command-line-options.html#intensity" >-intensity</a> setting.</p>
Cristy882d9f42015-10-29 16:48:39 -04004762
Cristy594d2772015-11-15 10:47:42 -05004763<p>The <a href="command-line-options.html#colorspace" >-colorspace gray</a> image conversion also uses
Cristy882d9f42015-10-29 16:48:39 -04004764the current intensity setting, but will always convert the image to the
4765appropriate sRGB or linear-RGB colorspace before appling the above
4766function.</p>
4767
4768<p>To print a complete list of possible pixel intensity setting methods, use <a href="command-line-options.html#list">-list intensity</a>.</p>
4769
Cristy594d2772015-11-15 10:47:42 -05004770<p>Operators affected by the <a href="command-line-options.html#intensity" >-intensity</a> setting include:</p>
Cristy882d9f42015-10-29 16:48:39 -04004771
4772<pre>
4773-adaptive-blur
4774-adaptive-sharpen
4775-black-threshold
4776-clut (when mapping greyscale CLUT image to alpha channel if set by -channels)
4777-colors for gray colorspace
4778-compose {LightenIntensity, DarkenIntensity, CopyOpacity, CopyBlack}
4779-contrast-stretch
4780-distort {ErodeIntensity, DilateIntensity}
4781-normalize
4782-random-threshold
4783-selective-blur
4784-shade
4785-threshold
4786-tint
4787-white-threshold
4788</pre>
4789
4790<div style="margin: auto;">
4791 <h3 class="magick-header"><a id="intent"></a>-intent <var>type</var></h3>
4792</div>
4793
4794<p class="magick-description">use this type of rendering intent when managing the image color.</p>
4795
4796<p>Use this option to affect the color management operation of an image (see
4797<a href="command-line-options.html#profile">-profile</a>). Choose from these intents: <code>Absolute,
4798Perceptual, Relative, Saturation</code>.</p>
4799
4800<p>The default intent is Perceptual for the sRGB colorspace and undefined for the RGB and gray colorspaces.</p>
4801
4802<p>To print a complete list of rendering intents, use <a href="command-line-options.html#list">-list intent</a>.</p>
4803
4804<div style="margin: auto;">
4805 <h3 class="magick-header"><a id="interlace"></a>-interlace <var>type</var></h3>
4806</div>
4807
4808<p class="magick-description">the type of interlacing scheme.</p>
4809
4810<p>Choose from:</p>
4811
4812<pre>
4813none
4814line
4815plane
4816partition
4817JPEG
4818GIF
4819PNG
4820</pre>
4821
4822<p>This option is used to specify the type of interlacing scheme for raw image
4823formats such as <code>RGB</code> or <code>YUV</code>.</p>
4824
4825<p><code>None</code> means do not interlace (RGBRGBRGBRGBRGBRGB...),</p>
4826
4827<p><code>Line</code> uses scanline interlacing (RRR...GGG...BBB...RRR...GGG...BBB...), and.</p>
4828
4829<p><code>Plane</code> uses plane interlacing (RRRRRR...GGGGGG...BBBBBB...).</p>
4830
4831<p><code>Partition</code> is like plane except the different planes are saved to
4832individual files (e.g. image.R, image.G, and image.B).</p>
4833
4834<p>Use <code>Line</code> or <code>Plane</code> to create an <code>interlaced
4835PNG</code> or <code>GIF</code> or <code>progressive JPEG</code> image.</p>
4836
4837<p>To print a complete list of interlacing schemes, use <a href="command-line-options.html#list">-list
4838interlace</a>.</p>
4839
4840<div style="margin: auto;">
4841 <h3 class="magick-header"><a id="interpolate"></a>-interpolate <var>type</var></h3>
4842</div>
4843
4844<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>
4845
4846<p>When looking up the color of a pixel using a non-integer floating point
4847value, you typically fall in between the pixel colors defined by the source
4848image. This setting determines how the color is determined from the colors of
4849the pixels surrounding that point. That is how to determine the color of a
4850point that falls between two, or even four different colored pixels. </p>
4851
4852<dl class="dl-horizontal">
4853 <dt>integer</dt>
4854 <dd>The color of the top-left pixel (floor function)</dd>
4855 <dt>nearest-neighbor</dt>
4856 <dd>The nearest pixel to the lookup point (rounded function)</dd>
4857 <dt>average</dt>
4858 <dd>The average color of the surrounding four pixels</dd>
4859 <dt>bilinear</dt>
4860 <dd>A double linear interpolation of pixels (the default)</dd>
4861 <dt>mesh</dt>
4862 <dd>Divide area into two flat triangular interpolations</dd>
4863 <dt>bicubic</dt>
4864 <dd>Fitted bicubic-spines of surrounding 16 pixels</dd>
4865 <dt>spline</dt>
4866 <dd>Direct spline curves (colors are blurred)</dd>
4867 <dt>filter</dt>
4868 <dd>Use resize <a href="command-line-options.html#filter">-filter</a> settings</dd>
4869</dl>
4870
Cristy594d2772015-11-15 10:47:42 -05004871<p>This most important for distortion operators such as <a href="command-line-options.html#distort"
4872>-distort</a>, <a href="command-line-options.html#implode" >-implode</a>, <a href="command-line-options.html#transform"
4873>-transform</a> and <a href="command-line-options.html#fx" >-fx</a>. </p>
Cristy882d9f42015-10-29 16:48:39 -04004874
4875<p>To print a complete list of interpolation methods, use <a href="command-line-options.html#list">-list interpolate</a>.</p>
4876
Cristy594d2772015-11-15 10:47:42 -05004877<p>See also <a href="command-line-options.html#virtual-pixel" >-virtual-pixel</a>, for control of the
Cristy882d9f42015-10-29 16:48:39 -04004878lookup for positions outside the boundaries of the image. </p>
4879
4880
4881<div style="margin: auto;">
4882 <h3 class="magick-header"><a id="interline-spacing"></a>-interline-spacing <var>value</var></h3>
4883</div>
4884
4885<p class="magick-description">the space between two text lines.</p>
4886
4887<div style="margin: auto;">
4888 <h3 class="magick-header"><a id="interword-spacing"></a>-interword-spacing <var>value</var></h3>
4889</div>
4890
4891<p class="magick-description">the space between two words.</p>
4892
4893<div style="margin: auto;">
4894 <h3 class="magick-header"><a id="kerning"></a>-kerning <var>value</var></h3>
4895</div>
4896
4897<p class="magick-description">the space between two letters.</p>
4898
4899<div style="margin: auto;">
Cristy594d2772015-11-15 10:47:42 -05004900 <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 -04004901</div>
4902
4903<p class="magick-description">edge preserving noise reduction filter.</p>
4904
Cristy594d2772015-11-15 10:47:42 -05004905<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 -04004906
4907
4908<div style="margin: auto;">
4909 <h3 class="magick-header"><a id="label"></a>-label <var>name</var></h3>
4910</div>
4911
4912<p class="magick-description">assign a label to an image.</p>
4913
4914<p>Use this option to assign a specific label to the image, as it is read in
Cristy594d2772015-11-15 10:47:42 -05004915or created. You can use the <a href="command-line-options.html#set" >-set</a> operation to re-assign
Cristy882d9f42015-10-29 16:48:39 -04004916a the labels of images already read in. Image formats such as TIFF, PNG,
4917MIFF, supports saving the label information with the image.</p>
4918
4919<p>When saving an image to a <var>PostScript</var> file, any label
4920assigned to an image is used as a header string to print above the postscript
4921image. </p>
4922
4923<p>You can include the image filename, type, width, height, or other image
4924attribute by embedding special format character. See <a href="escape.html">Format and Print Image
4925Properties</a> for details of the percent escape codes.</p>
4926
4927<p>For example,</p>
4928
4929<pre>
4930-label "%m:%f %wx%h" bird.miff
4931</pre>
4932
4933<p>assigns an image label of <code>MIFF:bird.miff 512x480</code> to the
4934"<code>bird.miff</code>" image and whose width is 512 and height is 480, as it
4935is read in. If a <a href="command-line-options.html#label">+label</a> option was used instead, any
4936existing label present in the image would be used. You can remove all labels
4937from an image by assigning the empty string. </p>
4938
4939<p>A label is not drawn on the image, but is embedded in the image datastream
4940via <var>Label</var> tag or similar mechanism. If you want the label to be
4941visible on the image itself, use the <a href="command-line-options.html#draw">-draw</a> option, or
4942during the final processing in the creation of an image montage.</p>
4943
4944<p>If the first character of <var>string</var> is <var>@</var>, the image label is read from a file titled by the
4945remaining characters in the string. Labels in a file are literal, no embedded
4946formatting characters are recognized.</p>
4947
4948
4949<div style="margin: auto;">
Cristy594d2772015-11-15 10:47:42 -05004950 <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 -04004951</div>
4952
4953<p class="magick-description">perform local adaptive threshold.</p>
4954
4955<p>Adaptively threshold each pixel based on the value of pixels in a
4956surrounding window. If the current pixel is lighter than this average plus
4957the optional <code>offset</code>, then it is made white, otherwise it is made
4958black. Small variations in pixel values such as found in scanned documents
4959can be ignored if offset is positive. A negative offset will make it more
4960sensitive to those small variations. </p>
4961
4962<p>This is commonly used to threshold images with an uneven background. It is
4963based on the assumption that average color of the small window is the
4964the local background color, from which to separate the foreground color. </p>
4965
4966
4967<div style="margin: auto;">
4968 <h3 class="magick-header"><a id="layers"></a>-layers <var>method</var></h3>
4969</div>
4970
4971<p class="magick-description">handle multiple images forming a set of image layers or animation frames.</p>
4972
4973<p>Perform various image operation methods to a ordered sequence of images
4974which may represent either a set of overlaid 'image layers', a GIF disposal
4975animation, or a fully-'coalesced' animation sequence. </p>
4976
4977<table class="table table-condensed table-striped">
4978 <tbody>
4979 <tr>
4980 <th style="width: 8%">Method</th>
4981 <th>Description</th>
4982 </tr>
4983
4984 <tr>
4985 <td>compare-any</td>
4986 <td>Crop the second and later frames to the smallest rectangle
Cristy594d2772015-11-15 10:47:42 -05004987 that contains all the differences between the two images. No GIF <a
4988 href="command-line-options.html#dispose" >-dispose</a> methods are taken into account. </td>
Cristy882d9f42015-10-29 16:48:39 -04004989 </tr>
4990
Cristy594d2772015-11-15 10:47:42 -05004991 <tr><td></td><td>This exactly the same as the <a href="command-line-options.html#deconstruct"
4992 >-deconstruct</a> operator, and does not preserve animations normal
Cristy882d9f42015-10-29 16:48:39 -04004993 working, especially when animation used layer disposal methods such as
4994 '<code>Previous</code>' or '<code>Background</code>'. </td>
4995 </tr>
4996
4997 <tr>
4998 <td>compare-clear</td>
4999 <td>As '<code>compare-any</code>' but crop to the bounds of any
5000 opaque pixels which become transparent in the second frame. That is the
5001 smallest image needed to mask or erase pixels for the next frame. </td>
5002 </tr>
5003
5004 <tr>
5005 <td>compare-overlay</td>
5006 <td>As '<code>compare-any</code>' but crop to pixels that add
5007 extra color to the next image, as a result of overlaying color pixels.
5008 That is the smallest single overlaid image to add or change colors. </td>
5009 </tr>
5010
Cristy594d2772015-11-15 10:47:42 -05005011 <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 -04005012 composition method '<code>change-mask</code>', to reduce the image to
5013 just the pixels that need to be overlaid. </td>
5014 </tr>
5015
5016 <tr>
5017 <td>coalesce</td>
Cristy594d2772015-11-15 10:47:42 -05005018 <td>Equivalent to a call to the <a href="command-line-options.html#coalesce"
5019 >-coalesce</a> operator. Apply the layer disposal methods set in the
Cristy882d9f42015-10-29 16:48:39 -04005020 current image sequence to form a fully defined animation sequence, as
5021 it should be displayed. Effectively converting a GIF animation into a
5022 'film strip'-like animation. </td>
5023 </tr>
5024
5025 <tr>
5026 <td>composite</td>
5027 <td>Alpha Composition of two image lists, separated by a
5028 "<code>null:</code>" image, with the destination image list first, and
5029 the source images last. An image from each list are composited
5030 together until one list is finished. The separator image and source
5031 image lists are removed. </td>
5032 </tr>
5033
5034
5035 <tr><td></td>
Cristy594d2772015-11-15 10:47:42 -05005036 <td>The <a href="command-line-options.html#geometry" >-geometry</a> offset is adjusted according
5037 to <a href="command-line-options.html#gravity" >-gravity</a> in accordance of the virtual
5038 canvas size of the first image in each list. Unlike a normal <a
5039 href="command-line-options.html#composite" >-composite</a> operation, the canvas offset is also
Cristy882d9f42015-10-29 16:48:39 -04005040 added to the final composite positioning of each image. </td> </tr>
5041
5042 <tr><td></td>
5043 <td>If one of the image lists only contains one image, that image is
5044 applied to all the images in the other image list, regardless of which
5045 list it is. In this case it is the image meta-data of the list which
5046 preserved. </td>
5047 </tr>
5048
5049
5050 <tr>
5051 <td>dispose</td>
5052 <td>This like '<code>coalesce</code>' but shows the look of
5053 the animation after the layer disposal method has been applied, before
5054 the next sub-frame image is overlaid. That is the 'dispose' image that
Cristy594d2772015-11-15 10:47:42 -05005055 results from the application of the GIF <a href="command-line-options.html#dispose"
5056 >-dispose</a> method. This allows you to check what
Cristy882d9f42015-10-29 16:48:39 -04005057 is going wrong with a particular animation you may be developing.
5058 </td>
5059 </tr>
5060
5061 <tr>
5062 <td>flatten</td>
5063 <td>Create a canvas the size of the first images virtual
Cristy594d2772015-11-15 10:47:42 -05005064 canvas using the current <a href="command-line-options.html#background" >-background</a> color,
5065 and <a href="command-line-options.html#compose" >-compose</a> each image in turn onto that
Cristy882d9f42015-10-29 16:48:39 -04005066 canvas. Images falling outside that canvas is clipped. Final
5067 image will have a zero virtual canvas offset. </td>
5068 </tr>
5069
5070 <tr><td></td>
5071 <td>This usually used as one of the final 'image layering' operations
5072 overlaying all the prepared image layers into a final image. </td>
5073 </tr>
5074
5075 <tr><td></td>
5076 <td>For a single image this method can also be used to fillout a virtual
5077 canvas with real pixels, or to underlay an opaque color to remove
5078 transparency from an image.</td>
5079 </tr>
5080
5081
5082 <tr>
5083 <td>merge</td>
5084 <td>As 'flatten' method but merging all the given image
5085 layers to create a new layer image just large enough to hold all the
5086 image without clipping or extra space. The new images virtual offset
5087 will preserve the position of the new layer, even if this offset is
5088 negative. The virtual canvas size of the first image is preserved.
5089 </td>
5090 </tr>
5091
5092 <tr><td></td><td>Caution is advised when handling image layers with
5093 negative offsets as few image file formats handle them correctly.
Cristy594d2772015-11-15 10:47:42 -05005094 Following this operation method with <a href="command-line-options.html#repage" >+repage</a>
Cristy882d9f42015-10-29 16:48:39 -04005095 will remove the layer offset, and create an image in which all the
5096 overlaid image positions relative to each other is preserved, though
5097 not necessarily exactly where you specified them.
5098 </td>
5099 </tr>
5100
5101 <tr><td></td><td>See also 'trim-bounds' below which is closely related but
5102 without doing the'flatten' to merge the images together. </td>
5103 </tr>
5104
5105 <tr>
5106 <td>mosaic</td>
5107 <td>As 'flatten' method but expanding the initial canvas size
5108 of the first image in a positive direction only so as to hold all the
5109 image layers. However as a virtual canvas is 'locked' to the origin,
5110 by its own definition, image layers with a negative offsets will still
5111 become clipped by the top and left edges. See 'merge' or 'trim-bounds'
5112 if this could be a problem. </td>
5113
5114 </tr>
5115
5116 <tr><td></td><td>This method is commonly used to layout individual image
5117 using various offset but without knowing the final canvas size. The
5118 resulting image will, like 'flatten' not have any virtual offset, so
5119 can be saved to any image file format. </td>
5120 </tr>
5121
5122
5123 <tr>
5124 <td>optimize</td>
5125 <td>Optimize a coalesced animation, into GIF animation using
5126 a number of general techniques. This currently a short cut to
5127 apply both the '<code>optimize-frame</code>', and
5128 '<code>optimize-transparency</code>' methods but may be expanded to
5129 include other optimization methods as they are developed. </td>
5130 </tr>
5131
5132 <tr>
5133 <td>optimize-frame</td>
5134 <td>Optimize a coalesced animation, into GIF animation by
5135 reducing the number of pixels per frame as much as possible by
5136 attempting to pick the best layer disposal method to use, while ensuring
5137 the result will continue to animate properly. </td>
5138 </tr>
5139
5140 <tr><td></td><td> There is no guarantee that the best optimization is found.
5141 But then no reasonably fast GIF optimization algorithm can do this.
5142 However this does seem to do better than most other GIF frame
5143 optimizers seen. </td>
5144 </tr>
5145
5146 <tr>
5147 <td>optimize-plus</td>
5148 <td>As '<code>optimize-frame</code>' but attempt to improve the
5149 overall optimization by adding extra frames to the animation, without
5150 changing the final look or timing of the animation. The frames are
5151 added to attempt to separate the clearing of pixels from the
5152 overlaying of new additional pixels from one animation frame to the
5153 next. If this does not improve the optimization (for the next frame
5154 only), it will fall back to the results of the previous normal
5155 '<code>optimize-frame</code>' technique. </td>
5156 </tr>
5157
5158 <tr><td></td><td>There is the possibility that the change in the disposal
5159 style will result in a worsening in the optimization of later frames,
5160 though this is unlikely. In other words there no guarantee that it is
5161 better than the normal '<code>optimize-frame</code>' technique. For some
5162 animations however you can get a vast improvement in the final
5163 animation size. </td>
5164 </tr>
5165
5166 <tr>
5167 <td>optimize-transparency</td>
5168 <td>Given a GIF animation, replace any pixel in the sub-frame
5169 overlay images with transparency, if it does not change the resulting
Cristy594d2772015-11-15 10:47:42 -05005170 animation by more than the current <a href="command-line-options.html#fuzz" >-fuzz</a> factor.
Cristy882d9f42015-10-29 16:48:39 -04005171 </td>
5172 </tr>
5173
5174 <tr><td></td><td>This should allow a existing frame optimized GIF animation
5175 to compress into a smaller file size due to larger areas of one
5176 (transparent) color rather than a pattern of multiple colors repeating
5177 the current disposed image of the last frame. </td>
5178 </tr>
5179
5180 <tr>
5181 <td>remove-dups</td>
5182 <td>Remove (and merge time delays) of duplicate consecutive
5183 images, so as to simplify layer overlays of coalesced animations.
5184 </td>
5185 </tr>
5186
5187 <tr><td></td><td>Usually this a result of using a constant time delay
5188 across the whole animation, or after a larger animation was split into
5189 smaller sub-animations. The duplicate frames could also have been
5190 used as part of some frame optimization methods. </td>
5191 </tr>
5192
5193 <tr>
5194 <td>remove-zero</td>
5195 <td>Remove any image with a zero time delay, unless ALL the
5196 images have a zero time delay (and is not a proper timed animation, a
5197 warning is then issued). </td>
5198 </tr>
5199
5200 <tr><td></td><td>In a GIF animation, such images are usually frames which
5201 provide partial intermediary updates between the frames that are
5202 actually displayed to users. These frames are usually added for
5203 improved frame optimization in GIF animations. </td>
5204 </tr>
5205
5206 <tr>
5207 <td>trim-bounds</td>
5208 <td>Find the bounds of all the images in the current
5209 image sequence, then adjust the offsets so all images are contained on
5210 a minimal positive canvas. None of the image data is modified or
5211 merged, only the individual image virtual canvas size and offset.
5212 All the images is given the same canvas size, and and will have
5213 a positive offset, but will remain in the same position relative to
5214 each other. As a result of the minimal canvas size at least one image
5215 will touch every edge of that canvas. The image data touching those
5216 edges however may be transparent. </td>
5217 </tr>
5218
5219 <tr><td></td><td>The result is much like if you used 'merge' followed by a
Cristy594d2772015-11-15 10:47:42 -05005220 <a href="command-line-options.html#repage" >+repage</a> option, except that all the images
Cristy882d9f42015-10-29 16:48:39 -04005221 have been kept separate. If 'flatten' is used after using
5222 'trim-bounds' you will get the same result. </td>
5223 </tr>
5224
5225 </tbody>
5226</table>
5227
5228<p>To print a complete list of layer types, use <a href="command-line-options.html#list">-list layers</a>.</p>
5229
Cristy594d2772015-11-15 10:47:42 -05005230<p>The operators <a href="command-line-options.html#coalesce" >-coalesce</a>, <a href="command-line-options.html#deconstruct"
5231>-deconstruct</a>, <a href="command-line-options.html#flatten" >-flatten</a>, and <a href="command-line-options.html#mosaic"
5232>-mosaic</a> are only aliases for the above methods and may be depreciated in
5233the future. Also see <a href="command-line-options.html#page" >-page</a>, <a href="command-line-options.html#repage"
5234>-repage</a> operators, the <a href="command-line-options.html#compose" >-compose</a> setting, and the
5235GIF <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 -04005236settings. </p>
5237
5238
5239<div style="margin: auto;">
5240 <h3 class="magick-header"><a id="level"></a>-level <var>black_point</var>{,<var>white_point</var>}{<var>%</var>}{,<var>gamma</var>}</h3>
5241</div>
5242
5243<p class="magick-description">adjust the level of image channels.</p>
5244
5245<p>Given one, two or three values delimited with commas: black-point,
5246white-point, gamma (for example: 10,250,1.0 or 2%,98%,0.5). The black and
5247white points range from 0 to <var>QuantumRange</var>, or from 0 to
5248100%; if the white point is omitted it is set to (<var>QuantumRange</var> - black_point), so as to center contrast changes.
5249If a <code>%</code> sign is present anywhere in the string, both black and white
Cristy594d2772015-11-15 10:47:42 -05005250points are percentages of the full color range. Gamma will do a <a
5251href="command-line-options.html#gamma">-gamma</a> adjustment of the values. If it is omitted, the
Cristy882d9f42015-10-29 16:48:39 -04005252default of 1.0 (no gamma correction) is assumed.</p>
5253
5254<p>In normal usage (<code>-level</code>) the image values are stretched so that
5255the given '<code>black_point</code>' value in the original image is set to zero
5256(or black), while the given '<code>white_point</code>' value is set to <var>QuantumRange</var> (or white). This provides you with direct
5257contrast adjustments to the image. The '<code>gamma</code>' of the resulting
5258image will then be adjusted. </p>
5259
5260<p>From ImageMagick v6.4.1-9 using the plus form of the operator
5261(<code>+level</code>) or adding the special '!' flag anywhere in the argument
5262list, will cause the operator to do the reverse of the level adjustment. That
5263is a zero, or <var>QuantumRange</var> value (black, and white, resp.)
5264in the original image, is adjusted to the given level values, allowing you to
5265de-contrast, or compress the channel values within the image. The
5266'<code>gamma</code>' is adjusted before the level adjustment to de-contrast the
5267image is made. </p>
5268
5269<p>Only the channels defined by the current <a href="command-line-options.html#channel">-channel</a>
5270setting are adjusted (defaults to RGB color channels only), allowing you to
5271limit the effect of this operator. </p>
5272
5273<p>Please note that the transparency channel is treated as 'matte'
5274values (0 is opaque) and not as 'alpha' values (0 is transparent).</p>
5275
5276
5277<div style="margin: auto;">
5278 <h3 class="magick-header"><a id="level-colors"></a>-level-colors {<var>black_color</var>}{,}{<var>white_color</var>}</h3>
5279</div>
5280
5281<p class="magick-description">adjust the level of an image using the provided dash separated colors.</p>
5282
5283<p>This function is exactly like <a href="command-line-options.html#level">-level</a>, except that the
5284value value for each color channel is determined by the
5285'<code>black_color</code>' and '<code>white_color</code>' colors given (as
5286described under the <a href="command-line-options.html#fill">-fill</a> option). </p>
5287
5288<p>This effectually means the colors provided to <code>-level-colors</code>
5289is mapped to become 'black' and 'white' respectively, with all the other
5290colors linearly adjusted (or clipped) to match that change. Each channel is
5291adjusted separately using the channel values of the colors specified. </p>
5292
5293<p>On the other hand the plus form of the operator (<code>+level-colors</code>)
5294will map the image color 'black' and 'white' to the given colors
5295respectively, resulting in a gradient (de-contrasting) tint of the image to
Cristy769d8892016-01-19 18:11:14 -05005296those colors. This can also be used to convert a plain grayscale image into a
Cristy882d9f42015-10-29 16:48:39 -04005297one using the gradient of colors specified. </p>
5298
5299<p>By supplying a single color with a comma separator either before or after
5300that color, will just replace the respective 'black' or 'white' point
5301respectively. But if no comma separator is provided, the given color is
5302used for both the black and white color points, making the operator either
5303threshold the images around that color (- form) or set all colors to that
5304color (+ form). </p>
5305
5306
5307<div style="margin: auto;">
5308 <h3 class="magick-header"><a id="limit"></a>-limit <var>type value</var></h3>
5309</div>
5310
5311<p class="magick-description">Set the pixel cache resource limit.</p>
5312
Cristye09ed312016-03-06 08:07:39 -05005313<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 -04005314
5315<p>The value for <code>file</code> is in number of files. The other limits are
5316in bytes. Define arguments for the memory, map, area, and disk resource limits
5317with SI prefixes (.e.g 100MB).</p>
5318
5319<p>By default the limits are 768 files, 3GB of image area, 1.5GiB memory, 3GiB
5320memory map, and 18.45EB of disk. These limits are adjusted relative to the
5321available resources on your computer if this information is available. When
5322any limit is reached, ImageMagick fails in some fashion but attempts to take
5323compensating actions, if possible. For example, the following limits
5324memory:</p>
5325
5326<pre>
5327-limit memory 32MiB -limit map 64MiB
5328</pre>
5329
5330<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>
5331
5332<pre>
Cristy594d2772015-11-15 10:47:42 -05005333-> identify -list resource
Cristy882d9f42015-10-29 16:48:39 -04005334Resource limits:
5335 Width: 100MP
5336 Height: 100MP
5337 Area: 25.181GB
5338 Memory: 11.726GiB
5339 Map: 23.452GiB
5340 Disk: unlimited
5341 File: 768
5342 Thread: 12
5343 Throttle: 0
5344 Time: unlimited
5345</pre>
5346
5347<p>Requests for pixel storage to keep intermediate images are satisfied by one
5348of three resource categories: in-memory pool, memory-mapped files pool, and
Cristy594d2772015-11-15 10:47:42 -05005349disk pool (in that order) depending on the <a href="command-line-options.html#limit">&#x2011;limit</a> settings
Cristy882d9f42015-10-29 16:48:39 -04005350and whether the system honors a resource request. If the total size of
5351allocated pixel storage in the given pool reaches the corresponding limit, the
5352request is passed to the next pool. Additionally, requests that exceed the
5353<code>area</code> limit automagically are allocated on disk.</p>
5354
5355<p>To illustrate how ImageMagick utilizes resource limits, consider a typical
5356image resource request. First, ImageMagick tries to allocate the pixels in
5357memory. The request might be denied if the resource request exceeds the
5358<code>memory</code> limit or if the system does not honor the request. If
5359a memory request is not honored, the pixels are allocated to disk and the file
5360is memory-mapped. However, if the allocation request exceeds the
5361<code>map</code> limit, the resource allocation goes to disk. In all cases, if
5362the resource request exceeds the <code>area</code> limit, the pixels are
5363automagically cached to disk. If the disk has a hard limit, the program
5364fails.</p>
5365
5366<p>In most cases you simply do not need to concern yourself with resource
5367limits. ImageMagick chooses reasonable defaults and most images do not tax
5368your computer resources. Where limits do come in handy is when you process
5369images that are large or on shared systems where ImageMagick can consume all
5370or most of the available memory. In this case, the ImageMagick workflow slows
5371other processes or, in extreme cases, brings the system to a halt. Under
5372these circumstances, setting limits give some assurances that the ImageMagick
5373workflow will not interfere with other concurrent uses of the computer. For
5374example, assume you have a web interface that processes images uploaded from
5375the Internet. To assure ImageMagick does not exceed 10MiB of memory you can
5376simply set the area limit to 10MiB:</p>
5377
5378<pre>
5379-limit area 10MB
5380</pre>
5381
5382<p>Now whenever a large image is processed, the pixels are automagically
5383cached to disk instead of memory. This of course implies that large images
5384typically process very slowly, simply because pixel processing in memory can
5385be an order of magnitude faster than on disk. Because your web site users
5386might inadvertently upload a huge image to process, you should set a disk
5387limit as well:</p>
5388
5389<pre>
5390-limit area 10MB -limit disk 500MB
5391</pre>
5392
5393<p>Here ImageMagick stops processing if an image requires more than 500MB of disk storage.</p>
5394
5395<p>In addition to command-line resource limit option, resources can be set
Cristy594d2772015-11-15 10:47:42 -05005396with <a href="resources.html#environment" >environment variables</a>. Set the
Cristy882d9f42015-10-29 16:48:39 -04005397environment variables <code>MAGICK_AREA_LIMIT</code>,
5398<code>MAGICK_DISK_LIMIT</code>, <code>MAGICK_FILE_LIMIT</code>,
5399<code>MAGICK_MEMORY_LIMIT</code>, <code>MAGICK_MAP_LIMIT</code>,
5400<code>MAGICK_THREAD_LIMIT</code>, <code>MAGICK_TIME_LIMIT</code> for limits of
5401image area, disk space, open files, heap memory, memory map, number of threads
5402of execution, and maximum elapsed time in seconds respectively.</p>
5403
5404<p> Inquisitive users can try adding <a href="command-line-options.html#debug">-debug cache</a> to
5405their commands and then scouring the generated output for references to the
5406pixel cache, in order to determine how the pixel cache was allocated and how
5407resources were consumed. Advanced Unix/Linux users can pipe that output
5408through <code>grep memory|open|destroy|disk</code> for more readable sifting.
5409</p>
5410
5411<p>For more about ImageMagick's use of resources, see the section <b>Cache
Cristy594d2772015-11-15 10:47:42 -05005412Storage and Resource Requirements</b> on the <a href="architecture.html#cache
5413">Architecture</a> page. </p>
Cristy882d9f42015-10-29 16:48:39 -04005414
5415<div style="margin: auto;">
Cristy769d8892016-01-19 18:11:14 -05005416 <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 -04005417</div>
5418
5419<p class="magick-description">Linear with saturation stretch.</p>
5420
Cristy594d2772015-11-15 10:47:42 -05005421<p>This is very similar to <a href="command-line-options.html#contrast-stretch" >-contrast-stretch</a>,
Cristy882d9f42015-10-29 16:48:39 -04005422and uses a 'histogram bin' to determine the range of color values that needs to
Cristy594d2772015-11-15 10:47:42 -05005423be stretched. However it then stretches those colors using the <a
5424href="command-line-options.html#level" >-level</a> operator.</p>
Cristy882d9f42015-10-29 16:48:39 -04005425
5426<p>As such while the initial determination may have 'binning' round off
5427effects, the image colors are stretched mathematically, rather than using the
5428histogram bins. This makes the operator more accurate. </p>
5429
Cristy594d2772015-11-15 10:47:42 -05005430<p>note however that a <a href="command-line-options.html#linear-stretch" >-linear-stretch</a> of
Cristy882d9f42015-10-29 16:48:39 -04005431'<code>0</code>' does nothing, while a value of '<code>1</code>' does a near
5432perfect stretch of the color range. </p>
5433
Cristy594d2772015-11-15 10:47:42 -05005434<p>See also <a href="command-line-options.html#auto-level" >-auto-level</a> for a 'perfect'
Cristy882d9f42015-10-29 16:48:39 -04005435normalization of mathematical images. </p>
5436
5437<p>This operator is under review for re-development. </p>
5438
5439
5440<div style="margin: auto;">
5441 <h3 class="magick-header"><a id="linewidth"></a>-linewidth</h3>
5442</div>
5443
5444<p class="magick-description">the line width for subsequent draw operations.</p>
5445
5446<div style="margin: auto;">
5447 <h3 class="magick-header"><a id="liquid-rescale"></a>-liquid-rescale <var>geometry</var></h3>
5448</div>
5449
5450<p class="magick-description">rescale image with seam-carving.</p>
5451
5452<p>See <a href="command-line-processing.html#geometry">Image Geometry</a> for complete details about the <em class="arg">geometry</em> argument.</p>
5453
5454<div style="margin: auto;">
5455 <h3 class="magick-header"><a id="list"></a>-list <var>type</var></h3>
5456</div>
5457
5458<p class="magick-description">Print a list of supported arguments for various options or settings. Choose from these list types:</p>
5459
5460<pre class="pre-scrollable">
5461Align
5462Alpha
5463Boolean
5464Cache
5465Channel
5466Class
5467ClipPath
5468Coder
5469Color
5470Colorspace
5471Command
5472Complex
5473Compose
5474Compress
5475Configure
5476DataType
5477Debug
5478Decoration
5479Delegate
5480Direction
5481Dispose
5482Distort
5483Dither
5484Endian
5485Evaluate
5486FillRule
5487Filter
5488Font
5489Format
5490Function
5491Gravity
5492Intensity
5493Intent
5494Interlace
5495Interpolate
5496Kernel
5497Layers
5498LineCap
5499LineJoin
5500List
5501Locale
5502LogEvent
5503Log
5504Magic
5505Method
5506Metric
5507Mime
5508Mode
5509Morphology
5510Module
5511Noise
5512Orientation
5513PixelIntensity
5514Policy
5515PolicyDomain
5516PolicyRights
5517Preview
5518Primitive
5519QuantumFormat
5520Resource
5521SparseColor
5522Statistic
5523Storage
5524Stretch
5525Style
5526Threshold
5527Type
5528Units
5529Validate
5530VirtualPixel
5531</pre>
5532
5533<p>These lists vary depending on your version of ImageMagick. Use "<code>-list
5534list</code>" to get a complete listing of all the "<code>-list</code>" arguments
5535available:</p>
5536
5537<pre>
5538identify -list list
5539</pre>
5540
5541<div style="margin: auto;">
5542 <h3 class="magick-header"><a id="log"></a>-log <var>string</var></h3>
5543</div>
5544
5545<p class="magick-description">Specify format for debug log.</p>
5546
Cristy594d2772015-11-15 10:47:42 -05005547<p>This option specifies the format for the log printed when the <a
5548href="command-line-options.html#debug">-debug</a> option is active.</p>
Cristy882d9f42015-10-29 16:48:39 -04005549
5550<p>You can display the following components by embedding special format
5551characters:</p>
5552
5553<dl class="dl-horizontal">
5554<dt>%d</dt><dd>domain</dd>
5555<dt>%e</dt><dd>event</dd>
5556<dt>%f</dt><dd>function</dd>
5557<dt>%l</dt><dd>line</dd>
5558<dt>%m</dt><dd>module</dd>
5559<dt>%p</dt><dd>process ID</dd>
5560<dt>%r</dt><dd>real CPU time</dd>
5561<dt>%t</dt><dd>wall clock time</dd>
5562<dt>%u</dt><dd>user CPU time</dd>
5563<dt>%%</dt><dd>percent sign</dd>
5564<dt>\n</dt><dd>newline</dd>
5565<dt>\r</dt><dd>carriage return</dd>
5566</dl>
5567
5568<p>For example:</p>
5569
5570<pre>
5571convert -debug coders -log "%u %m:%l %e" in.gif out.png
5572</pre>
5573
5574<p>The default behavior is to print all of the components.</p>
5575
5576<div style="margin: auto;">
5577 <h3 class="magick-header"><a id="loop"></a>-loop <var>iterations</var></h3>
5578</div>
5579
5580<p class="magick-description">add Netscape loop extension to your GIF animation.</p>
5581
5582<p>Set iterations to zero to repeat the animation an infinite number of times,
5583otherwise the animation repeats itself up to <var>iterations</var>
5584times.</p>
5585
5586<div style="margin: auto;">
5587 <h3 class="magick-header"><a id="lowlight-color"></a>-lowlight-color <var>color</var></h3>
5588</div>
5589
5590<p class="magick-description">when comparing images, de-emphasize pixel differences with this color.</p>
5591
5592<div style="margin: auto;">
5593 <h3 class="magick-header"><a id="magnify"></a>-magnify</h3>
5594</div>
5595
5596<p class="magick-description">double the size of the image with pixel art scaling.</p>
5597
5598
5599<div style="margin: auto;">
5600 <h3 class="magick-header"><a id="map"></a>-map <var>type</var></h3>
5601</div>
5602
5603<p class="magick-description">Display image using this <var>type</var>.</p>
5604
5605<p>Choose from these <var>Standard Colormap</var> types:</p>
5606
5607<pre>
5608best
5609default
5610gray
5611red
5612green
5613blue
5614</pre>
5615
5616<p>The <var>X server</var> must support the <var>Standard
5617Colormap</var> you choose, otherwise an error occurs. Use <code>list</code> as
5618the type and <code>display</code> searches the list of colormap types in
5619<code>top-to-bottom</code> order until one is located. See <var>xstdcmap(1)</var> for one way of creating Standard Colormaps.</p>
5620
5621
5622<div style="margin: auto;">
5623 <h3 class="magick-header"><a id="map_stream_"></a>-map <var>components</var></h3>
5624</div>
5625
5626<p class="magick-description">pixel map.</p>
5627
5628<p>Here are the valid components of a map:</p>
5629
5630<dl class="dl-horizontal">
5631<dt>r</dt><dd> red pixel component</dd>
5632<dt>g</dt><dd> green pixel component</dd>
5633<dt>b</dt><dd> blue pixel component</dd>
5634<dt>a</dt><dd> alpha pixel component (0 is transparent)</dd>
5635<dt>o</dt><dd> opacity pixel component (0 is opaque)</dd>
5636<dt>i</dt><dd> grayscale intensity pixel component</dd>
5637<dt>c</dt><dd> cyan pixel component</dd>
5638<dt>m</dt><dd> magenta pixel component</dd>
5639<dt>y</dt><dd> yellow pixel component</dd>
5640<dt>k</dt><dd> black pixel component</dd>
5641<dt>p</dt><dd> pad component (always 0)</dd>
5642</dl>
5643
5644<p>You can specify as many of these components as needed in any order (e.g.
5645bgr). The components can repeat as well (e.g. rgbr).</p>
5646
5647
5648<div style="margin: auto;">
Cristy882d9f42015-10-29 16:48:39 -04005649 <h3 class="magick-header"><a id="mattecolor"></a>-mattecolor <var>color</var></h3>
5650</div>
5651
5652<p class="magick-description">Specify the color to be used with the <a href="command-line-options.html#frame">-frame</a> option.</p>
5653
5654<p>The color is specified using the format described under the <a href="command-line-options.html#fill">-fill</a> option.</p>
5655
Cristy594d2772015-11-15 10:47:42 -05005656<p>The default matte color is <code>#BDBDBD</code>, <span
5657style="background-color: #bdbdbd;">this shade of gray</span>.</p>
Cristy882d9f42015-10-29 16:48:39 -04005658
Cristyf650f4f2016-04-01 10:53:07 -04005659<p>This is an IMv6 option, use <a href="command-line-options.html#alpha-color">-alpha-color</a> with IMv7.</p>
5660
Cristy882d9f42015-10-29 16:48:39 -04005661<div style="margin: auto;">
5662 <h3 class="magick-header"><a id="maximum"></a>-maximum</h3>
5663</div>
5664
5665<p class="magick-description">return the maximum intensity of an image sequence.</p>
5666
5667<p>Select the 'maximum' value from all the surrounding pixels. </p>
5668
Cristy594d2772015-11-15 10:47:42 -05005669<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 -04005670name. </p>
5671
5672<div style="margin: auto;">
5673 <h3 class="magick-header"><a id="median"></a>-median <var>geometry</var></h3>
5674</div>
5675
5676<p class="magick-description">apply a median filter to the image.</p>
5677
5678<p>Select the 'middle' value from all the surrounding pixels. </p>
5679
Cristy594d2772015-11-15 10:47:42 -05005680<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 -04005681name. </p>
5682
5683<div style="margin: auto;">
Cristy769d8892016-01-19 18:11:14 -05005684 <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 -04005685</div>
5686
5687<p class="magick-description">image noise removal and color reduction/segmentation (e.g. -mean-shift 7x7+10%).</p>
5688
5689<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>
5690
5691<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>
5692
5693<div style="margin: auto;">
5694 <h3 class="magick-header"><a id="metric"></a>-metric <var>type</var></h3>
5695</div>
5696
5697<p class="magick-description">Output to STDERR a measure of the differences between images according to the <var>type</var> given metric.</p>
5698
5699<p>Choose from:</p>
5700
5701<dl class="dl-horizontal">
5702<dt>AE</dt><dd> absolute error count, number of different pixels (-fuzz effected)</dd>
5703<dt>FUZZ</dt><dd> mean color distance</dd>
5704<dt>MAE</dt><dd> mean absolute error (normalized), average channel error distance</dd>
5705<dt>MEPP</dt><dd> mean error per pixel (normalized mean error, normalized peak error)</dd>
5706<dt>MSE</dt><dd> mean error squared, average of the channel error squared</dd>
5707<dt>NCC</dt><dd> normalized cross correlation</dd>
5708<dt>PAE</dt><dd> peak absolute (normalized peak absolute)</dd>
Cristy3b0b58d2016-11-06 07:40:23 -05005709<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 -04005710<dt>PSNR</dt><dd> peak signal to noise ratio</dd>
5711<dt>RMSE</dt><dd> root mean squared (normalized root mean squared)</dd>
5712</dl>
5713
5714<p>Control the '<code>AE</code>', or absolute count of pixels that are different,
Cristy594d2772015-11-15 10:47:42 -05005715with the <a href="command-line-options.html#fuzz" >-fuzz</a> factor (ignore pixels which
Cristy882d9f42015-10-29 16:48:39 -04005716only changed by a small amount). Use '<code>PAE</code>' to find the
Cristy594d2772015-11-15 10:47:42 -05005717size of the <a href="command-line-options.html#fuzz" >-fuzz</a> factor needed to make all pixels
Cristy882d9f42015-10-29 16:48:39 -04005718'similar', while '<code>MAE</code>' determines the factor needed
5719for about half the pixels to be similar. </p>
5720
5721<p>The '<code>MEPP</code>' metric returns three different metrics
5722('<code>MAE</code>', '<code>MAE</code>' normalized, and '<code>PAE</code>'
5723normalized) from a single comparison run. </p>
5724
5725<p>To print a complete list of metrics, use the <a href="command-line-options.html#list">-list
5726metric</a> option.</p>
5727
5728
5729<div style="margin: auto;">
5730 <h3 class="magick-header"><a id="minimum"></a>-minimum</h3>
5731</div>
5732
5733<p class="magick-description">return the minimum intensity of an image sequence.</p>
5734
5735<p>Select the 'minimal' value from all the surrounding pixels. </p>
5736
Cristy594d2772015-11-15 10:47:42 -05005737<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 -04005738name. </p>
5739
5740
5741
5742<div style="margin: auto;">
5743 <h3 class="magick-header"><a id="mode"></a>-mode <var>geometry</var></h3>
5744</div>
5745
5746<p class="magick-description">make each pixel the \'predominant color\' of the neighborhood.'</p>
5747
5748<div style="margin: auto;">
5749 <h3 class="magick-header">-mode <var>value</var></h3>
5750</div>
5751
5752<p class="magick-description">Mode of operation.</p>
5753
5754<p>Choose the <var>value</var> from these styles: <code>Frame,
5755Unframe, or Concatenate</code></p>
5756
Cristy594d2772015-11-15 10:47:42 -05005757<p>Use the <a href="command-line-options.html#list" >-list</a> option with a '<code>Mode</code>' argument
5758for a list of <a href="command-line-options.html#mode" >-mode</a> arguments available in your
Cristy882d9f42015-10-29 16:48:39 -04005759ImageMagick installation.</p>
5760
5761
5762<div style="margin: auto;">
5763 <h3 class="magick-header"><a id="modulate"></a>-modulate <var>brightness</var>[,<var>saturation</var>,<var>hue</var>]</h3>
5764</div>
5765
5766<p class="magick-description">Vary the <var>brightness</var>, <var>saturation</var>, and <var>hue</var> of an image.</p>
5767
5768<p>The arguments are given as a percentages of variation. A value of 100 means
5769no change, and any missing values are taken to mean 100.</p>
5770
5771<p>The <var>brightness</var> is a multiplier of the overall
5772brightness of the image, so 0 means pure black, 50 is half as bright, 200 is
5773twice as bright. To invert its meaning <a href="command-line-options.html#negate">-negate</a> the image
5774before and after. </p>
5775
5776<p>The <var>saturation</var> controls the amount of color in an
5777image. For example, 0 produce a grayscale image, while a large value such as
5778200 produce a very colorful, 'cartoonish' color.</p>
5779
5780<p>The <var>hue</var> argument causes a "rotation" of the colors
5781within the image by the amount specified. For example, 50 results in
5782a counter-clockwise rotation of 90, mapping red shades to purple, and so on.
5783A value of either 0 or 200 results in a complete 180 degree rotation of the
5784image. Using a value of 300 is a 360 degree rotation resulting in no change to
5785the original image. </p>
5786
5787<p>For example, to increase the color brightness by 20% and decrease the color
Cristy594d2772015-11-15 10:47:42 -05005788saturation by 10% and leave the hue unchanged, use <a
5789href="command-line-options.html#modulate">-modulate 120,90</a>.</p>
Cristy882d9f42015-10-29 16:48:39 -04005790
Cristy594d2772015-11-15 10:47:42 -05005791<p>Use <a href="command-line-options.html#set">-set</a> attribute of '<code
5792>option:modulate:colorspace</code>' to specify which colorspace to
Cristy882d9f42015-10-29 16:48:39 -04005793modulate. 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>
5794
5795<pre>
5796convert image.png -set option:modulate:colorspace hsb -modulate 120,90 modulate.png
5797</pre>
5798
5799<div style="margin: auto;">
5800 <h3 class="magick-header"><a id="moments"></a>-moments</h3>
5801</div>
5802
5803<p class="magick-description">report image moments and perceptual hash.</p>
5804
5805
5806<div style="margin: auto;">
5807 <h3 class="magick-header"><a id="monitor"></a>-monitor</h3>
5808</div>
5809
5810<p class="magick-description">monitor progress.</p>
5811
5812
5813<div style="margin: auto;">
5814 <h3 class="magick-header"><a id="monochrome"></a>-monochrome</h3>
5815</div>
5816
5817<p class="magick-description">transform the image to black and white.</p>
5818
5819<div style="margin: auto;">
5820 <h3 class="magick-header"><a id="morph"></a>-morph <var>frames</var></h3>
5821</div>
5822
5823<p class="magick-description">morphs an image sequence.</p>
5824
5825<p>Both the image pixels and size are linearly interpolated to give the
5826appearance of a metamorphosis from one image to the next, over all the images
Cristy594d2772015-11-15 10:47:42 -05005827in the current image list. The added images are the equivalent of a <a
5828href="command-line-options.html#blend">-blend</a> composition. The <var>frames</var>
Cristy882d9f42015-10-29 16:48:39 -04005829argument determine how many images to interpolate between each image. </p>
5830
5831
5832<div style="margin: auto;">
5833 <h3 class="magick-header"><a id="morphology"></a>-morphology</h3>
5834 <h3 class="magick-header">-morphology <var>method</var> <var>kernel</var></h3>
5835</div>
5836
5837<p class="magick-description">apply a morphology method to the image.</p>
5838
Cristy594d2772015-11-15 10:47:42 -05005839<p>Until I get around to writing an option summary for this, see <a
Cristy364a72f2016-11-04 22:38:41 -04005840href="https://www.imagemagick.org/Usage/morphology/" >IM Usage Examples,
Cristy882d9f42015-10-29 16:48:39 -04005841Morphology</a>. </p>
5842
5843
5844<div style="margin: auto;">
5845 <h3 class="magick-header"><a id="mosaic"></a>-mosaic</h3>
5846</div>
5847
Cristy594d2772015-11-15 10:47:42 -05005848<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 -04005849
5850
5851<div style="margin: auto;">
Cristy594d2772015-11-15 10:47:42 -05005852 <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 -04005853</div>
5854
5855<p class="magick-description">simulate motion blur.</p>
5856
5857<p>Blur with the given radius, standard deviation (sigma), and angle. The
5858angle given is the angle toward which the image is blurred. That is the
5859direction people would consider the object is coming from. </p>
5860
5861<p>Note that the blur is not uniform distribution, giving the motion a
5862definite sense of direction of movement. </p>
5863
5864<p>The <a href="command-line-options.html#virtual-pixel">-virtual-pixel</a> setting will determine how
5865pixels which are outside the image proper are blurred into the final result.
5866</p>
5867
5868<div style="margin: auto;">
5869 <h3 class="magick-header"><a id="name"></a>-name</h3>
5870</div>
5871
5872<p class="magick-description">name an image.</p>
5873<div style="margin: auto;">
5874 <h3 class="magick-header"><a id="negate"></a>-negate</h3>
5875</div>
5876
5877<p class="magick-description">replace each pixel with its complementary color.</p>
5878
5879<p>The red, green, and blue intensities of an image are negated. White becomes
5880black, yellow becomes blue, etc. Use <a href="command-line-options.html#negate">+negate</a> to only
5881negate the grayscale pixels of the image.</p>
5882
5883<div style="margin: auto;">
Cristy594d2772015-11-15 10:47:42 -05005884 <h3 class="magick-header"><a id="noise"></a>-noise <var>geometry</var><br/>
Cristy882d9f42015-10-29 16:48:39 -04005885 +noise <var>type</var></h3>
5886</div>
5887
5888<p class="magick-description">Add or reduce noise in an image.</p>
5889
5890<p>The principal function of noise peak elimination filter is to smooth the
5891objects within an image without losing edge information and without creating
5892undesired structures. The central idea of the algorithm is to replace a pixel
5893with its next neighbor in value within a pixel window, if this pixel has been
5894found to be noise. A pixel is defined as noise if and only if this pixel is
5895a maximum or minimum within the pixel window.</p>
5896
5897<p>Use <code><a href="command-line-options.html#noise">-noise</a> <var>radius</var></code> to
5898specify the width of the neighborhood when reducing noise. This is equivalent
Cristy594d2772015-11-15 10:47:42 -05005899to using a <code><a href="command-line-options.html#statistic" >-statistic</a> NonPeak</code> operation,
Cristy882d9f42015-10-29 16:48:39 -04005900which should be used in preference.</p>
5901
5902<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
5903types:</p>
5904
5905<pre>
5906Gaussian
5907Impulse
5908Laplacian
5909Multiplicative
5910Poisson
5911Random
5912Uniform
5913</pre>
5914
Cristy594d2772015-11-15 10:47:42 -05005915<p>The amount of noise added can be controlled by the <code><a
5916href="command-line-options.html#attenuate" >-attenuate</a></code> setting. If unset the value is
Cristy882d9f42015-10-29 16:48:39 -04005917equivalent to 1.0, or a maximum noise addition.</p>
5918
5919<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>
5920
5921<p>To print a complete list of noises, use the <a href="command-line-options.html#list">-list noise</a> option.</p>
5922
5923<p>Also see the <a href="command-line-options.html#evaluate">-evaluate</a> noise functions that allows
5924the use of a controlling value to specify the amount of noise that should be
5925added to an image. </p>
5926
5927
5928<div style="margin: auto;">
5929 <h3 class="magick-header"><a id="normalize"></a>-normalize</h3>
5930</div>
5931
5932<p class="magick-description">Increase the contrast in an image by <var>stretching</var> the range of intensity values.</p>
5933
5934<p>The intensity values are stretched to cover the entire range of possible
5935values. While doing so, black-out at most <var>2%</var> of the pixels and
5936white-out at most <var>1%</var> of the pixels.</p>
5937
Cristy594d2772015-11-15 10:47:42 -05005938<p>Note that as of ImageMagick 6.4.7-0, <a href="command-line-options.html#normalize" >-normalize</a>
5939is equivalent to <a href="command-line-options.html#contrast-stretch" >-contrast-stretch 2%x1%</a>.
5940(Before this version, it was equivalent to <a href="command-line-options.html#contrast-stretch"
5941>-contrast-stretch 2%x99%</a>).</p>
Cristy882d9f42015-10-29 16:48:39 -04005942
Cristy769d8892016-01-19 18:11:14 -05005943<p>All the channels are normalized in concert by the same amount so as to
Cristy594d2772015-11-15 10:47:42 -05005944preserve color integrity, when the default <a href="command-line-options.html#channel" >+channel</a>
5945setting is in use. Specifying any other <a href="command-line-options.html#channel" >-channel</a>
Cristy882d9f42015-10-29 16:48:39 -04005946setting will normalize the RGB channels independently.</p>
5947
Cristy594d2772015-11-15 10:47:42 -05005948<p>See <a href="command-line-options.html#contrast-stretch" >-contrast-stretch</a> for more details.
5949Also see <a href="command-line-options.html#auto-level" >-auto-level</a> for a 'perfect' normalization
Cristy882d9f42015-10-29 16:48:39 -04005950that is better suited to mathematically generated images. </p>
5951
5952<p>This operator is under review for re-development. </p>
5953
5954
5955<div style="margin: auto;">
5956 <h3 class="magick-header"><a id="opaque"></a>-opaque <var>color</var></h3>
5957</div>
5958
5959<p class="magick-description">change this color to the fill color within the image.</p>
5960
5961<p>The <var>color</var> argument is defined using the format
Cristy594d2772015-11-15 10:47:42 -05005962described under the <a href="command-line-options.html#fill" >-fill</a> option. The <a href="command-line-options.html#fuzz"
5963>-fuzz</a> setting can be used to match and replace colors similar to the one
Cristy882d9f42015-10-29 16:48:39 -04005964given.</p>
5965
5966<p>Use <a href="command-line-options.html#opaque">+opaque</a> to paint any pixel that does not match
5967the target color. </p>
5968
5969<p>The <a href="command-line-options.html#transparent">-transparent</a> operator is exactly the same
Cristy594d2772015-11-15 10:47:42 -05005970as <a href="command-line-options.html#opaque" >-opaque</a> but replaces the matching color with
Cristy882d9f42015-10-29 16:48:39 -04005971transparency rather than the current <a href="command-line-options.html#fill">-fill</a> color setting.
5972To ensure that it can do this it also ensures that the image has an alpha
Cristy594d2772015-11-15 10:47:42 -05005973channel enabled, as per "<code><a href="command-line-options.html#alpha" >-alpha</a> set</code>", for
5974the new transparent colors, and does not require you to modify the <a
5975href="command-line-options.html#channel">-channel</a> to enable alpha channel handling. </p>
Cristy882d9f42015-10-29 16:48:39 -04005976
5977
5978<div style="margin: auto;">
5979 <h3 class="magick-header"><a id="ordered-dither"></a>-ordered-dither <var>threshold_map</var>{,<var>level</var>...}</h3>
5980</div>
5981
5982<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
5983given number of <var>levels</var> per color channel.</p>
5984
5985<p>You can choose from these standard threshold maps:</p>
5986
5987<pre class="pre-scrollable">
5988threshold 1x1 Threshold 1x1 (non-dither)
5989checks 2x1 Checkerboard 2x1 (dither)
5990o2x2 2x2 Ordered 2x2 (dispersed)
5991o3x3 3x3 Ordered 3x3 (dispersed)
5992o4x4 4x4 Ordered 4x4 (dispersed)
5993o8x8 8x8 Ordered 8x8 (dispersed)
5994h3x4a 4x1 Halftone 4x4 (angled)
5995h6x6a 6x1 Halftone 6x6 (angled)
5996h8x8a 8x1 Halftone 8x8 (angled)
5997h3x4o Halftone 4x4 (orthogonal)
5998h6x6o Halftone 6x6 (orthogonal)
5999h8x8o Halftone 8x8 (orthogonal)
6000h36x16o Halftone 16x16 (orthogonal)
6001c5x5b c5x5 Circles 5x5 (black)
6002c5x5w Circles 5x5 (white)
6003c6x6b c6x6 Circles 6x6 (black)
6004c6x6w Circles 6x6 (white)
6005c7x7b c7x7 Circles 7x7 (black)
6006c7x7w Circles 7x7 (white)
6007</pre>
6008
6009<p> The <code>threshold</code> generated a simple 50% threshold of the image.
Cristy594d2772015-11-15 10:47:42 -05006010This could be used with <var >level</var> to do the equivalent of <a
6011href="command-line-options.html#posterize" >-posterize</a> to reduce an image to basic primary colors.
Cristy882d9f42015-10-29 16:48:39 -04006012</p>
6013
6014<p>The <code>checks</code> pattern produces a 3 level checkerboard dither
6015pattern. That is a grayscale will become a pattern of solid black, solid
6016white, and mid-tone colors into a checkerboard pattern of black and white.
6017</p>
6018
Cristy594d2772015-11-15 10:47:42 -05006019<p>You can define your own <var >threshold map</var> for ordered
Cristy882d9f42015-10-29 16:48:39 -04006020dithering and halftoning your images, in either personal or system
Cristy594d2772015-11-15 10:47:42 -05006021<code>thresholds.xml</code> XML file. See <a href="resources.html" >Resources</a>
Cristy882d9f42015-10-29 16:48:39 -04006022for more details of configuration files. </p>
6023
6024<p>To print a complete list of the thresholds that have been defined, use the
Cristy594d2772015-11-15 10:47:42 -05006025<a href="command-line-options.html#list" >-list threshold</a> option.</p>
Cristy882d9f42015-10-29 16:48:39 -04006026
6027<p>Note that at this time the same threshold dithering map is used for all
6028color channels, no attempt is made to offset or rotate the map for different
6029channels is made, to create an offset printing effect. Also as the maps are
6030simple threshold levels, the halftone and circle maps will create incomplete
6031circles along the edges of a colored area. Also all the effects are purely
6032on/off boolean effects, without anti-aliasing to make the circles smooth
6033looking. Large dots can be made to look better with a small amount of blurring
6034after being created. </p>
6035
6036
6037<div style="margin: auto;">
6038 <h3 class="magick-header"><a id="orient"></a>-orient <var>image orientation</var></h3>
6039</div>
6040
6041<p class="magick-description">specify orientation of a digital camera image.</p>
6042
6043<p>Choose from these orientations:</p>
6044
6045<pre>
6046bottom-left right-top
6047bottom-right top-left
6048left-bottom top-right
6049left-top undefined
6050right-bottom
6051</pre>
6052
Cristy594d2772015-11-15 10:47:42 -05006053<p>To print a complete list of orientations, use the <a href="command-line-options.html#list" >-list
Cristy882d9f42015-10-29 16:48:39 -04006054orientation</a> option.</p>
6055
6056
6057<div style="margin: auto;">
Cristy594d2772015-11-15 10:47:42 -05006058 <h3 class="magick-header"><a id="page"></a>-page <var>geometry</var><br/>
6059 -page <var>media</var>[<var>offset</var>][{<var>^!&lt;&gt;</var>}]<br/>
Cristy882d9f42015-10-29 16:48:39 -04006060 +page
6061 </h3>
6062</div>
6063
6064<p class="magick-description">Set the size and location of an image on the larger virtual canvas.</p>
6065
6066<p>See <a href="command-line-processing.html#geometry">Image Geometry</a> for complete details about the <em class="arg">geometry</em> argument.</p>
6067
6068<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 -05006069<var>geometry</var> arguments (e.g. <a
6070href="command-line-options.html#page">-page</a> <code>Letter+43+43</code>).</p>
Cristy882d9f42015-10-29 16:48:39 -04006071
6072<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.
6073The choices for a PostScript page are:</p>
6074
6075<dl class="dl-horizontal">
6076<dt> 11x17 </dt> <dd> 792 x 1224</dd>
6077<dt> Ledger </dt> <dd> 1224 x 792</dd>
6078<dt> Legal </dt> <dd> 612 x 1008</dd>
6079<dt> Letter </dt> <dd> 612 x 792</dd>
6080<dt> LetterSmall</dt> <dd> 612 x 792</dd>
6081<dt> ArchE </dt> <dd> 2592 x 3456</dd>
6082<dt> ArchD </dt> <dd> 1728 x 2592</dd>
6083<dt> ArchC </dt> <dd> 1296 x 1728</dd>
6084<dt> ArchB </dt> <dd> 864 x 1296</dd>
6085<dt> ArchA </dt> <dd> 648 x 864</dd>
6086<dt> A0 </dt> <dd> 2380 x 3368</dd>
6087<dt> A1 </dt> <dd> 1684 x 2380</dd>
6088<dt> A2 </dt> <dd> 1190 x 1684</dd>
6089<dt> A3 </dt> <dd> 842 x 1190</dd>
6090<dt> A4 </dt> <dd> 595 x 842</dd>
6091<dt> A4Small </dt> <dd> 595 x 842</dd>
6092<dt> A5 </dt> <dd> 421 x 595</dd>
6093<dt> A6 </dt> <dd> 297 x 421</dd>
6094<dt> A7 </dt> <dd> 210 x 297</dd>
6095<dt> A8 </dt> <dd> 148 x 210</dd>
6096<dt> A9 </dt> <dd> 105 x 148</dd>
6097<dt> A10 </dt> <dd> 74 x 105</dd>
6098<dt> B0 </dt> <dd> 2836 x 4008</dd>
6099<dt> B1 </dt> <dd> 2004 x 2836</dd>
6100<dt> B2 </dt> <dd> 1418 x 2004</dd>
6101<dt> B3 </dt> <dd> 1002 x 1418</dd>
6102<dt> B4 </dt> <dd> 709 x 1002</dd>
6103<dt> B5 </dt> <dd> 501 x 709</dd>
6104<dt> C0 </dt> <dd> 2600 x 3677</dd>
6105<dt> C1 </dt> <dd> 1837 x 2600</dd>
6106<dt> C2 </dt> <dd> 1298 x 1837</dd>
6107<dt> C3 </dt> <dd> 918 x 1298</dd>
6108<dt> C4 </dt> <dd> 649 x 918</dd>
6109<dt> C5 </dt> <dd> 459 x 649</dd>
6110<dt> C6 </dt> <dd> 323 x 459</dd>
6111<dt> Flsa </dt> <dd> 612 x 936</dd>
6112<dt> Flse </dt> <dd> 612 x 936</dd>
6113<dt> HalfLetter </dt> <dd> 396 x 612</dd>
6114</dl>
6115
6116<p>This option is also used to place subimages when writing to a multi-image
6117format that supports offsets, such as GIF89 and MNG. When used for this
6118purpose the offsets are always measured from the top left corner of the canvas
6119and are not affected by the <a href="command-line-options.html#gravity">-gravity</a> option. To
6120position 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
6121file, a <a href="command-line-options.html#page">-page</a> option appearing ahead of the first image in
6122the sequence with nonzero width and height defines the width and height values
6123that are written in the <code>MHDR</code> chunk. Otherwise, the MNG width and
6124height are computed from the bounding box that contains all images in the
6125sequence. When writing a GIF89 file, only the bounding box method is used to
6126determine its dimensions.</p>
6127
Cristy594d2772015-11-15 10:47:42 -05006128<p>For a PostScript page, the image is sized as in <a
6129href="command-line-options.html#geometry">-geometry</a> but positioned relative to the <var>lower
6130left-hand corner</var> of the page by {+-}<code>x</code><var>offset</var>{+-}<code>y</code> <var>offset</var>. Use <a
6131href="command-line-options.html#page">-page 612x792</a>, for example, to center the image within the
Cristy882d9f42015-10-29 16:48:39 -04006132page. If the image size exceeds the PostScript page, it is reduced to fit the
6133page. 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
6134corner of the page, unless the <a href="command-line-options.html#gravity">-gravity</a> option is
6135present with a value other than <var>NorthWest</var>.</p>
6136
6137<p>The default page dimensions for a TEXT image is 612x792.</p>
6138
6139<p>This option is used in concert with <a href="command-line-options.html#density">-density</a>.</p>
6140
6141<p>Use <a href="command-line-options.html#page">+page</a> to remove the page settings for an image.</p>
6142
6143<div style="margin: auto;">
6144 <h3 class="magick-header"><a id="paint"></a>-paint <var>radius</var></h3>
6145</div>
6146
6147<p class="magick-description">simulate an oil painting.</p>
6148
6149<p>Each pixel is replaced by the most frequent color in a circular
6150neighborhood whose width is specified with <var>radius</var>.</p>
6151
6152<div style="margin: auto;">
6153 <h3 class="magick-header"><a id="path"></a>-path <var>path</var></h3></div>
6154
6155<p class="magick-description">write images to this path on disk.</p>
6156
6157<div style="margin: auto;">
6158 <h3 class="magick-header"><a id="pause_animate_"></a>-pause <var>seconds</var></h3>
6159</div>
6160
6161<p class="magick-description">Pause between animation loops</p>
6162
6163<p>Pause for the specified number of seconds before repeating the animation.</p>
6164
6165<div style="margin: auto;">
6166 <h3 class="magick-header"><a id="pause_import_"></a>-pause <var>seconds</var></h3>
6167</div>
6168
6169<p class="magick-description">Pause between snapshots.</p>
6170
6171<p>Pause for the specified number of seconds before taking the next snapshot.</p>
6172
6173<div style="margin: auto;">
6174 <h3 class="magick-header"><a id="perceptible"></a>-perceptible <var>epsilon</var></h3>
6175</div>
6176
6177<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>
6178
6179<div style="margin: auto;">
6180 <h3 class="magick-header"><a id="ping"></a>-ping</h3>
6181</div>
6182
6183<p class="magick-description">efficiently determine image characteristics.</p>
6184
6185<div style="margin: auto;">
6186 <h3 class="magick-header"><a id="pointsize"></a>-pointsize <var>value</var></h3>
6187</div>
6188
6189<p class="magick-description">pointsize of the PostScript, OPTION1, or TrueType font.</p>
6190
6191<div style="margin: auto;">
6192 <h3 class="magick-header"><a id="polaroid"></a>-polaroid <var>angle</var></h3>
6193</div>
6194
6195<p class="magick-description">simulate a Polaroid picture.</p>
6196
6197<p>Use <code>+polaroid</code> to rotate the image at a random angle between -15 and +15 degrees.</p>
6198
6199<div style="margin: auto;">
6200 <h3 class="magick-header"><a id="poly"></a>-poly <var>"wt,exp ..."</var></h3>
6201</div>
6202
6203<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>
6204
6205<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>
6206
6207<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>
6208
6209<p>The format is: <var>output = wt1*image1^exp1 + wt2*image2^exp2 </var>...</p>
6210
6211<p>Some simple uses are:</p>
6212<ul>
6213<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>
6214<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>
6215</ul>
6216
6217<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>
6218
6219<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>
6220
6221
6222<div style="margin: auto;">
6223 <h3 class="magick-header"><a id="posterize"></a>-posterize <var>levels</var></h3>
6224</div>
6225
6226<p class="magick-description">reduce the image to a limited number of color levels per channel.</p>
6227
6228<p>Very low values of <var>levels</var>, e.g., 2, 3, 4, have the most
6229visible effect.</p>
6230
6231<div style="margin: auto;">
6232 <h3 class="magick-header"><a id="precision"></a>-precision <var>value</var></h3>
6233</div>
6234
6235<p class="magick-description">set the maximum number of significant digits to be printed.</p>
6236
6237<div style="margin: auto;">
6238 <h3 class="magick-header"><a id="preview"></a>-preview <var>type</var></h3>
6239</div>
6240
6241<p class="magick-description">image preview type.</p>
6242
6243<p>Use this option to affect the preview operation of an image (e.g.
6244<code>convert file.png -preview Gamma Preview:gamma.png</code>). Choose from
6245these previews:</p>
6246
6247<pre class="pre-scrollable">
6248AddNoise
6249Blur
6250Brightness
6251Charcoal
6252Despeckle
6253Dull
6254EdgeDetect
6255Gamma
6256Grayscale
6257Hue
6258Implode
6259JPEG
6260OilPaint
6261Quantize
6262Raise
6263ReduceNoise
6264Roll
6265Rotate
6266Saturation
6267Segment
6268Shade
6269Sharpen
6270Shear
6271Solarize
6272Spiff
6273Spread
6274Swirl
6275Threshold
6276Wave
6277</pre>
6278
6279<p>To print a complete list of previews, use the <a href="command-line-options.html#list">-list preview</a> option.</p>
6280
6281<p>The default preview is <code>JPEG</code>.</p>
6282
6283<div style="margin: auto;">
6284 <h3 class="magick-header"><a id="print"></a>-print <var>string</var></h3>
6285</div>
6286
6287<p class="magick-description">interpret string and print to console.</p>
6288
6289<div style="margin: auto;">
6290 <h3 class="magick-header"><a id="process"></a>-process <var>command</var></h3>
6291</div>
6292
6293<p class="magick-description">process the image with a custom image filter.</p>
6294
6295<p>The command arguments has the form <code>"module arg1 arg2 arg3 ...
6296argN"</code> where <code>module</code> is the name of the module to invoke (e.g.
6297"Analyze") and arg1 arg2 arg3 ... argN are an arbitrary number of arguments to
6298pass to the process module.</p>
6299
6300<div style="margin: auto;">
Cristy594d2772015-11-15 10:47:42 -05006301 <h3 class="magick-header"><a id="profile"></a>-profile <var>filename</var><br/>
Cristy882d9f42015-10-29 16:48:39 -04006302 +profile <var>profile_name</var></h3>
6303</div>
6304
6305<p class="magick-description">Manage ICM, IPTC, or generic profiles in an image.</p>
6306
6307<p>Using <a href="command-line-options.html#profile">-profile</a> <var>filename</var> adds an
6308ICM (ICC color management), IPTC (newswire information), or a generic profile
6309to the image.</p>
6310
6311<p>Use <a href="command-line-options.html#profile">+profile <var>profile_name</var></a> to
6312remove the indicated profile. ImageMagick uses standard filename globbing, so
6313wildcard expressions may be used to remove more than one profile. Here we
6314remove all profiles from the image except for the XMP profile: <code>+profile
6315"!xmp,*"</code>. </p>
6316
6317<p>Use <code>identify -verbose</code> to find out which profiles are in the
6318image file. Use <a href="command-line-options.html#strip">-strip</a> to remove all profiles (and
6319comments).</p>
6320
6321<p>To extract a profile, the <a href="command-line-options.html#profile">-profile</a> option is not
6322used. Instead, simply write the file to an image format such as <var>APP1, 8BIM, ICM,</var> or <var>IPTC</var>.</p>
6323
6324<p>For example, to extract the Exif data (which is stored in JPEG files in the
6325<var>APP1</var> profile), use.</p>
6326
6327<pre>
6328convert cockatoo.jpg profile.exif
6329</pre>
6330
6331<p>It is important to note that results may depend on whether or not the
Cristy594d2772015-11-15 10:47:42 -05006332original image already has an included profile. Also, keep in mind that <a
6333href="command-line-options.html#profile">-profile</a> is an "operator" (as opposed to a "setting") and
Cristy882d9f42015-10-29 16:48:39 -04006334therefore a conversion is made each time it is encountered, in order, in the
6335command-line. For instance, in the following example, if the original image is
6336CMYK with profile, a CMYK-CMYK-RGB conversion results.</p>
6337
6338<pre>
6339convert CMYK.tif -profile "CMYK.icc" -profile "RGB.icc" RGB.tiff
6340</pre>
6341
6342<p>Furthermore, since ICC profiles are not necessarily symmetric, extra
6343conversion steps can yield unwanted results. CMYK profiles are often very
6344asymmetric since they involve 3−&gt;4 and 4−&gt;3 channel mapping.
6345</p>
6346
6347<div style="margin: auto;">
6348 <h3 class="magick-header"><a id="quality"></a>-quality <var>value</var></h3>
6349</div>
6350
6351<p class="magick-description">JPEG/MIFF/PNG compression level.</p>
6352
6353<p>For the JPEG and MPEG image formats, quality is 1 (lowest image quality and
6354highest compression) to 100 (best quality but least effective compression).
6355The default is to use the estimated quality of your input image if it can
6356be determined, otherwise 92. When the quality is greater than 90, then the
6357chroma channels are not downsampled.
6358Use the <a href="command-line-options.html#sampling-factor">-sampling-factor</a> option to specify the
6359factors for chroma downsampling.</p>
6360
6361<p>For the JPEG-2000 image format, quality is mapped using a non-linear
6362equation to the compression ratio required by the Jasper library. This
6363non-linear equation is intended to loosely approximate the quality provided by
6364the JPEG v1 format. The default quality value 100, a request for non-lossy
6365compression. A quality of 75 results in a request for 16:1 compression.</p>
6366
6367<p>For the MNG and PNG image formats, the quality value sets the zlib
6368compression level (quality / 10) and filter-type (quality % 10). The default
6369PNG "quality" is 75, which means compression level 7 with adaptive PNG
6370filtering, unless the image has a color map, in which case it means
6371compression level 7 with no PNG filtering.</p>
6372
6373<p>For compression level 0 (quality value less than 10), the Huffman-only
6374strategy is used, which is fastest but not necessarily the worst
6375compression.</p>
6376
6377<p>If filter-type is 4 or less, the specified PNG filter-type is used for
6378all scanlines:</p>
6379
6380<dl class="dl-horizontal">
6381<dt>0</dt><dd>none</dd>
6382<dt>1</dt><dd>sub</dd>
6383<dt>2</dt><dd>up</dd>
6384<dt>3</dt><dd>average</dd>
6385<dt>4</dt><dd>Paeth</dd>
6386</dl>
6387
6388<p>If filter-type is 5, adaptive filtering is used when quality is greater
6389than 50 and the image does not have a color map, otherwise no filtering is
6390used.</p>
6391
6392<p>If filter-type is 6, adaptive filtering
6393with <var>minimum-sum-of-absolute-values</var> is used.</p>
6394
6395<p>Only if the output is MNG, if filter-type is 7, the LOCO color
6396transformation (intrapixel differencing) and adaptive filtering
6397with <var>minimum-sum-of-absolute-values</var> are used.</p>
6398
6399<p>If the filter-type is 8 the zlib Z_RLE compression strategy (or the
6400Z_HUFFMAN_ONLY strategy, when compression level is 0) is used with
6401adaptive PNG filtering.</p>
6402
6403<p>If the filter-type is 9 the zlib Z_RLE compression strategy (or the
6404Z_HUFFMAN_ONLY strategy, when compression level is 0) is used with
6405no PNG filtering.</p>
6406
6407<p>The quality setting has no effect on the appearance or signature of PNG
6408and MNG images, since the compression is always lossless.</p>
6409
6410<p>Not all combinations of compression level, strategy, and PNG filter type
6411can be obtained using the -quality option. For more precise control,
6412you can use the PNG:compression-level=N, PNG:compression-strategy=N, and
6413PNG:compression-filter=N defines, respectively, instead.
6414See <a href="command-line-options.html#define">-define</a>. Values from the defines take precedence
6415over values from the -quality option.</p>
6416
6417<p>For further information, see
6418the <a href="http://www.w3.org/pub/WWW/TR">PNG</a> specification.</p>
6419
6420<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>
6421
6422<p>For the BPG image format, quality/2 is the actual BPG compression level (range from 0 to 51).</p>
6423
6424<div style="margin: auto;">
6425 <h3 class="magick-header"><a id="quantize"></a>-quantize <var>colorspace</var></h3>
6426</div>
6427
6428<p class="magick-description">reduce colors using this colorspace.</p>
6429
6430<p>This setting defines the colorspace used to sort out and reduce the number
Cristy594d2772015-11-15 10:47:42 -05006431of colors needed by an image (for later dithering) by operators such as <a
6432href="command-line-options.html#colors" >-colors</a>, Note that color reduction also happens
Cristy882d9f42015-10-29 16:48:39 -04006433automatically when saving images to color-limited image file formats, such as
6434GIF, and PNG8.</p>
6435
6436
6437<div style="margin: auto;">
6438 <h3 class="magick-header"><a id="quiet"></a>-quiet</h3>
6439</div>
6440
6441<p class="magick-description">suppress all warning messages. Error messages are still reported.</p>
6442
6443<div style="margin: auto;">
6444 <h3 class="magick-header"><a id="radial-blur"></a>-radial-blur <var>angle</var></h3>
6445</div>
6446
6447<p class="magick-description">Blur around the center of the image.</p>
6448
6449<p>Note that this is actually a rotational blur rather than a radial and as
6450such actually mis-named. </p>
6451
6452<p>The <a href="command-line-options.html#virtual-pixel">-virtual-pixel</a> setting will determine how
6453pixels which are outside the image proper are blurred into the final result.
6454</p>
6455
6456
6457<div style="margin: auto;">
6458 <h3 class="magick-header"><a id="raise"></a>-raise <var>thickness</var></h3>
6459</div>
6460
6461<p class="magick-description">Lighten or darken image edges.</p>
6462
6463<p>This will create a 3-D effect. Use <a href="command-line-options.html#raise">-raise</a> to create
6464a raised effect, otherwise use <a href="command-line-options.html#raise">+raise</a>. </p>
6465
Cristy594d2772015-11-15 10:47:42 -05006466<p>Unlike the similar <a href="command-line-options.html#frame">-frame</a> option, <a
6467href="command-line-options.html#raise">-raise</a> does not alter the dimensions of the image.</p>
Cristy882d9f42015-10-29 16:48:39 -04006468
6469<div style="margin: auto;">
6470 <h3 class="magick-header"><a id="random-threshold"></a>-random-threshold <var>low</var>x<var>high</var></h3>
6471</div>
6472
6473<p class="magick-description">Apply a random threshold to the image.</p>
6474
6475<div style="margin: auto;">
Cristye0779712016-07-30 17:25:22 -04006476 <h3 class="magick-header"><a id="read-mask"></a>-read-mask
6477<var>filename</var></h3>
6478</div>
6479
6480<p class="magick-description">Prevent updates to image pixels specified by the mask.</p>
6481
6482<p>This the same as using a mask used for composite masking operations, with
6483grayscale values causing blended updates of the image the mask is attached to.
6484</p>
6485
6486<p>Use <a href="command-line-options.html#read-mask">+read-mask</a> to remove the mask from images.</p>
6487
6488<p>Also see <a href="command-line-options.html#clip-mask">-clip-mask</a> which work in the same way,
6489but with strict boolean masking. </p>
6490
6491<div style="margin: auto;">
Cristy882d9f42015-10-29 16:48:39 -04006492 <h3 class="magick-header"><a id="red-primary"></a>-red-primary <var>x,y</var></h3>
6493</div>
6494
6495<p class="magick-description">Set the red chromaticity primary point.</p>
6496
6497<div style="margin: auto;">
6498 <h3 class="magick-header"><a id="regard-warnings"></a>-regard-warnings</h3>
6499</div>
6500
6501<p class="magick-description">Pay attention to warning messages.</p>
6502
6503<p>This option causes some warnings in some image formats to be treated
6504as errors. </p>
6505
6506<div style="margin: auto;">
6507 <h3 class="magick-header"><a id="remap"></a>-remap <var>filename</var></h3>
6508</div>
6509
6510<p class="magick-description">Reduce the number of colors in an image to the colors used by this image.</p>
6511
6512<p>If the <a href="command-line-options.html#dither">-dither</a> setting is enabled (the default) then
6513the given colors are dithered over the image as necessary, otherwise the closest
6514color (in RGB colorspace) is selected to replace that pixel in the image. </p>
6515
6516<p>As a side effect of applying a <a href="command-line-options.html#remap">-remap</a> of colors across all
6517images in the current image sequence, all the images will have the same color
6518table. That means that when saved to a file format such as GIF, it will use
6519that color table as a single common or global color table, for all the images,
6520without requiring extra local color tables. </p>
6521
6522<p>Use <a href="command-line-options.html#remap">+remap</a> to reduce all images in the current image
6523sequence to use a common color map over all the images. This equivalent to
6524appending all the images together (without extra background colors) and color
6525reducing those images using <a href="command-line-options.html#colors">-colors</a> with a 256 color
6526limit, then <a href="command-line-options.html#remap">-remap</a> those colors over the original list of
6527images. This ensures all the images follow a single color map. </p>
6528
Cristy594d2772015-11-15 10:47:42 -05006529<p>If the number of colors over all the images is less than 256, then <a
6530href="command-line-options.html#remap">+remap</a> should not perform any color reduction or dithering, as
Cristy882d9f42015-10-29 16:48:39 -04006531no color changes are needed. In that case, its only effect is to force the use
Cristy594d2772015-11-15 10:47:42 -05006532of a global color table. This recommended after using either <a
6533href="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 -04006534reduce the number of colors in an animated image sequence. </p>
6535
6536<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>
6537
6538<div style="margin: auto;">
6539 <h3 class="magick-header"><a id="region"></a>-region <var>geometry</var></h3>
6540</div>
6541
6542<p class="magick-description">Set a region in which subsequent operations apply.</p>
6543
6544<p>The <var>x</var> and <var>y</var> offsets are treated
6545in the same manner as in <a href="command-line-options.html#crop">-crop</a>.</p>
6546
6547<p>See <a href="command-line-processing.html#geometry">Image Geometry</a> for complete details about the <em class="arg">geometry</em> argument.</p>
6548
6549<p>Use <code>+region</code> to remove any previously set regions.</p>
6550
Cristy882d9f42015-10-29 16:48:39 -04006551<div style="margin: auto;">
6552 <h3 class="magick-header"><a id="remote"></a>-remote</h3>
6553</div>
6554
6555<p class="magick-description">perform a remote operation.</p>
6556
6557<p>The only command recognized is the name of an image file to load.</p>
6558
6559<p>If you have more than one <a href="display.html">display</a> application
6560running simultaneously, use the <a href="command-line-options.html#window"> window</a> option to
6561specify which application to control.</p>
6562
6563<div style="margin: auto;">
6564 <h3 class="magick-header"><a id="render"></a>-render</h3>
6565</div>
6566
6567<p class="magick-description">render vector operations.</p>
6568
6569<p>Use <a href="command-line-options.html#render">+render</a> to turn off rendering vector operations.
6570This useful when saving the result to vector formats such as MVG or SVG.</p>
6571
6572<div style="margin: auto;">
6573<h3 class="magick-header"><a id="repage"></a>-repage <var>geometry</var></h3>
6574</div>
6575
6576<p class="magick-description">Adjust the canvas and offset information of the image.</p>
6577
6578<p>This option is like <a href="command-line-options.html#page">-page</a> but acts as an image operator
6579rather than a setting. You can separately set the canvas size or the offset
6580of the image on that canvas by only providing those components. </p>
6581
6582<p>See <a href="command-line-processing.html#geometry">Image Geometry</a> for complete details about the <em class="arg">geometry</em> argument.</p>
6583
6584<p>If a <code>!</code> flag is given the offset given is added to the existing
6585offset to move the image relative to its previous position. This useful for
6586animation sequences. </p>
6587
6588<p>A given a canvas size of zero such as '<code>0x0</code>' forces it to
6589recalculate the canvas size so the image (at its current offset) will appear
6590completely on that canvas (unless it has a negative offset).</p>
6591
6592<p>Use <a href="command-line-options.html#repage">+repage</a> to completely remove/reset the virtual
6593canvas meta-data from the images. </p>
6594
6595<p>The <a href="command-line-options.html#set">-set</a> '<code>page</code>' option can be used to
6596directly assign virtual canvas meta-data. </p>
6597
6598
6599<div style="margin: auto;">
6600 <h3 class="magick-header"><a id="resample"></a>-resample <var>horizontal</var>x<var>vertical</var></h3>
6601</div>
6602
6603<p class="magick-description">Resample image to specified horizontal and vertical resolution.</p>
6604
6605<p>Resize the image so that its rendered size remains the same as the original
6606at the specified target resolution. For example, if a 300 DPI image renders at
66073 inches by 2 inches on a 300 DPI device, when the image has been resampled to
660872 DPI, it will render at 3 inches by 2 inches on a 72 DPI device. Note that
6609only a small number of image formats (e.g. JPEG, PNG, and TIFF) are capable of
6610storing the image resolution. For formats which do not support an image
Cristy594d2772015-11-15 10:47:42 -05006611resolution, the original resolution of the image must be specified via <a
6612href="command-line-options.html#density">-density</a> on the command line prior to specifying the
Cristy882d9f42015-10-29 16:48:39 -04006613resample resolution.</p>
6614
6615<p>Note that Photoshop stores and obtains image resolution from a proprietary
6616embedded profile. If this profile exists in the image, then Photoshop will
6617continue to treat the image using its former resolution, ignoring the image
6618resolution specified in the standard file header.</p>
6619
6620<div style="margin: auto;">
6621 <h3 class="magick-header"><a id="resize"></a>-resize <var>geometry</var></h3>
6622</div>
6623
6624<p class="magick-description">Resize an image.</p>
6625
6626<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
6627ignored, and the <a href="command-line-options.html#gravity">-gravity</a> option has no effect.</p>
6628
6629<p>If the <a href="command-line-options.html#filter">-filter</a> option
Cristy594d2772015-11-15 10:47:42 -05006630or <code>-define filter:option=value</code> precedes the <a
6631href="command-line-options.html#resize">-resize</a> option, the image is resized with the specified
Cristy882d9f42015-10-29 16:48:39 -04006632filter.</p>
6633
6634<p>Many image processing algorithms assume your image is in a linear-light
6635coding. If your image is gamma-corrected, you can remove the nonlinear gamma
6636correction, apply the transform, then restore it like this:</p>
6637
6638<pre>
6639convert portrait.jpg -gamma .45455 -resize 25% -gamma 2.2 \
6640 -quality 92 passport.jpg
6641</pre>
6642
6643<div style="margin: auto;">
6644 <h3 class="magick-header"><a id="respect-parentheses"></a>-respect-parentheses</h3>
6645</div>
6646
6647<p class="magick-description">settings remain in effect until parenthesis boundary.</p>
6648
6649<div style="margin: auto;">
6650 <h3 class="magick-header"><a id="reverse"></a>-reverse</h3>
6651</div>
6652
6653<p class="magick-description">Reverse the order of images in the current image list.</p>
6654
6655
6656<div style="margin: auto;">
6657 <h3 class="magick-header"><a id="roll"></a>-roll {<var>+-</var>}<var>x</var>{<var>+-</var>}<var>y</var></h3>
6658</div>
6659
6660<p class="magick-description">roll an image vertically or horizontally by the amount given.</p>
6661
6662<p>A negative <var>x</var> offset rolls the image right-to-left.
6663A negative <var>y</var> offset rolls the image bottom-to-top.</p>
6664
6665
6666<div style="margin: auto;">
6667 <h3 class="magick-header"><a id="rotate"></a>-rotate <var>degrees</var>{<var>&lt;</var>}{<var>&gt;</var>}</h3>
6668</div>
6669
6670<p class="magick-description">Apply Paeth image rotation (using shear operations) to the image.</p>
6671
6672<p>Use <code>&gt;</code> to rotate the image only if its width exceeds the
6673height. <code>&lt;</code> rotates the image <var>only</var> if its width is less
6674than the height. For example, if you specify <code>-rotate "-90&gt;"</code> and
6675the image size is 480x640, the image is not rotated. However, if the image is
6676640x480, it is rotated by -90 degrees. If you use <code>&gt;</code> or
6677<code>&lt;</code>, enclose it in quotation marks to prevent it from being
6678misinterpreted as a file redirection.</p>
6679
6680<p>Empty triangles in the corners, left over from rotating the image, are
6681filled with the <code>background</code> color. </p>
6682
6683<p>See also the <a href="command-line-options.html#distort">-distort</a> operator and specifically the
6684'<code>ScaleRotateTranslate</code>' distort method. </p>
6685
6686
6687<div style="margin: auto;">
6688 <h3 class="magick-header"><a id="sample"></a>-sample <var>geometry</var></h3>
6689</div>
6690
6691<p class="magick-description">minify / magnify the image with pixel subsampling and pixel replication, respectively.</p>
6692
6693<p>Change the image size simply by directly sampling the pixels original
6694from the image. When magnifying, pixels are replicated in blocks. When
6695minifying, pixels are sub-sampled (i.e., some rows and columns are skipped
6696over). </p>
6697
6698<p>The results are thus equivalent to using <a href="command-line-options.html#resize">-resize</a> with
6699a <a href="command-line-options.html#filter">-filter</a> setting of <code>point</code> (nearest
6700neighbor), though <a href="command-line-options.html#sample">-sample</a> is a lot faster, as it
6701avoids all the filter processing of the image. As such it completely ignores
6702the current <a href="command-line-options.html#filter">-filter</a> setting. </p>
6703
6704<p>The key feature of the <a href="command-line-options.html#sample">-sample</a> is that no new colors
6705will be added to the resulting image, though some colors may disappear. </p>
6706
6707<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
6708ignored, unlike <a href="command-line-options.html#resize">-resize</a>. </p>
6709
6710
6711<p>The actual sampling point is the middle of the sub-region being sampled.
6712As such a single pixel sampling of an image will take the middle pixel, (or
Cristy594d2772015-11-15 10:47:42 -05006713top-left-middle if image has even dimensions). However the <a
6714href="command-line-options.html#define">-define</a> '<code>sample:offset</code>' can be set to modify
Cristy882d9f42015-10-29 16:48:39 -04006715this position some other location within each sub-region being sampled, as
6716a percentage offset.</p>
6717
6718<p>By default this value is '<code>50</code>' for the midpoint, but could be set
6719to '<code>0</code>' for top-left, '<code>100</code>' for bottom-right, or with
6720separate X and Y offsets such as '<code>0x50</code>' for left-middle edge of
6721sampling sub-region.</p>
6722
6723
6724<div style="margin: auto;">
6725 <h3 class="magick-header"><a id="sampling-factor"></a>-sampling-factor <var>horizontal-factor</var>x<var>vertical-factor</var></h3>
6726</div>
6727
6728<p class="magick-description">sampling factors used by JPEG or MPEG-2 encoder and YUV decoder/encoder.</p>
6729
6730<p>This option specifies the sampling factors to be used by the JPEG encoder
6731for chroma downsampling. If this option is omitted, the JPEG library will use
6732its own default values. When reading or writing the YUV format and when
Cristy594d2772015-11-15 10:47:42 -05006733writing the M2V (MPEG-2) format, use <a
6734href="command-line-options.html#sampling-factor">-sampling-factor 2x1</a> or <a
6735href="command-line-options.html#sampling-factor">-sampling-factor 4:2:2</a> to specify the 4:2:2
Cristy882d9f42015-10-29 16:48:39 -04006736downsampling method.</p>
6737
6738<div style="margin: auto;">
6739 <h3 class="magick-header"><a id="scale"></a>-scale <var>geometry</var></h3>
6740</div>
6741
6742<p class="magick-description">minify / magnify the image with pixel block averaging and pixel replication, respectively.</p>
6743
6744<p>Change the image size simply by replacing pixels by averaging pixels
6745together when minifying, or replacing pixels when magnifying. </p>
6746
6747<p>The results are thus equivalent to using <a href="command-line-options.html#resize">-resize</a> with
6748a <a href="command-line-options.html#filter">-filter</a> setting of <code>box</code>. Though it is a lot
6749faster, as it avoids all the filter processing of the image. As such it
6750completely ignores the current <a href="command-line-options.html#filter">-filter</a> setting. </p>
6751
6752<p>If when shrinking (minifying) images the original image is some integer
6753multiple of the new image size, the number of pixels averaged together to
6754produce the new pixel color is the same across the whole image. This is
6755a special case known as 'binning' and is often used as a method of reducing
6756noise in image such as those generated by digital cameras, especially in low
6757light conditions. </p>
6758
6759
6760<div style="margin: auto;">
6761 <h3 class="magick-header"><a id="scene"></a>-scene <var>value</var></h3>
6762</div>
6763
6764<p class="magick-description">set scene number.</p>
6765
6766<p>This option sets the scene number of an image or the first image in an image sequence.</p>
6767
6768<div style="margin: auto;">
6769 <h3 class="magick-header"><a id="screen"></a>-screen</h3>
6770</div>
6771
6772<p class="magick-description">specify the screen to capture.</p>
6773
6774<p>This option indicates that the GetImage request used to obtain the image
6775should be done on the root window, rather than directly on the specified
6776window. In this way, you can obtain pieces of other windows that overlap the
6777specified window, and more importantly, you can capture menus or other popups
6778that are independent windows but appear over the specified window.</p>
6779
6780<div style="margin: auto;">
6781 <h3 class="magick-header"><a id="seed"></a>-seed</h3>
6782</div>
6783
6784<p class="magick-description">seed a new sequence of pseudo-random numbers</p>
6785
6786<div style="margin: auto;">
6787 <h3 class="magick-header"><a id="segment"></a>-segment <var>cluster-threshold</var>x<var>smoothing-threshold</var></h3>
6788</div>
6789
6790<p class="magick-description">segment the colors of an image.</p>
6791
6792<p>Segment an image by analyzing the histograms of the color components and
6793identifying units that are homogeneous with the fuzzy c-means technique. This
6794is part of the ImageMagick color quantization routines. </p>
6795
6796<p>Specify <var>cluster threshold</var> as the number of pixels in
6797each cluster that must exceed the cluster threshold to be considered valid.
6798<var>Smoothing threshold</var> eliminates noise in the second
6799derivative of the histogram. As the value is increased, you can expect
6800a smoother second derivative. The default is 1.5.</p>
6801
6802<p>If the <a href="command-line-options.html#verbose">-verbose</a> setting is defined, a detailed report
6803of the color clusters is returned.</p>
6804
6805
6806<div style="margin: auto;">
Cristy594d2772015-11-15 10:47:42 -05006807 <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 -04006808</div>
6809
6810<p class="magick-description">Selectively blur pixels within a contrast threshold.</p>
6811
6812<p>Blurs those pixels that are less than or equal to the threshold in
6813contrast. The threshold may be expressed as a fraction of <var>QuantumRange</var> or as a percentage.</p>
6814
6815<div style="margin: auto;">
6816 <h3 class="magick-header"><a id="separate"></a>-separate</h3>
6817</div>
6818
6819<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>
6820
6821<div style="margin: auto;">
Cristy769d8892016-01-19 18:11:14 -05006822 <h3 class="magick-header"><a id="sepia-tone"></a>-sepia-tone <var>percent-threshold</var></h3>
Cristy882d9f42015-10-29 16:48:39 -04006823</div>
6824
6825<p class="magick-description">simulate a sepia-toned photo.</p>
6826
6827<p>Specify <var>threshold</var> as the percent threshold of the intensity (0 - 99.9%).</p>
6828
6829<p>This option applies a special effect to the image, similar to the effect
6830achieved 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
6831toning. A threshold of 80% is a good starting point for a reasonable
6832tone.</p>
6833
6834
6835
6836<div style="margin: auto;">
6837 <h3 class="magick-header"><a id="set"></a>-set <var>key value</var></h3>
6838 <h3 class="magick-header">+set <var>key</var></h3>
6839</div>
6840
6841<p class="magick-description">sets image attributes and properties for images in the current image sequence.</p>
6842
6843<p>This will assign (or modify) specific settings attached to all the images
6844in the current image sequence. Using the <a href="command-line-options.html#set">+set</a> form of the
6845option will either remove, or reset that setting to a default state, as
6846appropriate. </p>
6847
6848<p>For example, it will modify specific well known image meta-data
Cristy594d2772015-11-15 10:47:42 -05006849'attributes' such as those normally overridden by: the options <a
6850href="command-line-options.html#delay" >-delay</a>, <a href="command-line-options.html#dispose" >-dispose</a>, and <a
6851href="command-line-options.html#page" >-page</a>, <a href="command-line-options.html#colorspace" >-colorspace</a>; generally
Cristy882d9f42015-10-29 16:48:39 -04006852assigned before the image is read in, by using a <var>key</var> of
6853the same name. </p>
6854
6855<p>If the given <var>key</var> does not match a specific known
6856'attribute ', such as shown above, the setting is stored as a a free form
Cristy594d2772015-11-15 10:47:42 -05006857'property' string. Such settings are listed in <a href="command-line-options.html#verbose"
6858>-verbose</a> information ("<code>info:</code>" output format) as "Properties".
Cristy882d9f42015-10-29 16:48:39 -04006859</p>
6860
6861<p>This includes string 'properties' that are set by and assigned to images
Cristy594d2772015-11-15 10:47:42 -05006862using the options <a href="command-line-options.html#comment" >-comment</a>, <a href="command-line-options.html#label"
6863>-label</a>, <a href="command-line-options.html#caption" >-caption</a>. These options actually assign
6864a global 'artifact' which are automatically assigned (and any <a href="escape.html" >Format Percent
Cristy882d9f42015-10-29 16:48:39 -04006865Escapes</a> expanded) to images as they are read in. For example:</p>
6866
6867<pre>
Cristy594d2772015-11-15 10:47:42 -05006868-> convert rose: -set comment 'Rose is a rose is a rose is a rose' rose.png
Cristy882d9f42015-10-29 16:48:39 -04006869identify -format %c rose.png
6870Rose is a rose is a rose is a rose
6871</pre>
6872
Cristy594d2772015-11-15 10:47:42 -05006873<p>The set value can also make use of <a href="escape.html" >Format and Print Image
Cristy882d9f42015-10-29 16:48:39 -04006874Properties</a> in the defined value. For example:</p>
6875
6876<pre>
Cristy594d2772015-11-15 10:47:42 -05006877-> convert rose: -set origsize '%wx%h' -resize 50% \
Cristy882d9f42015-10-29 16:48:39 -04006878 -format 'Old size = %[origsize] New size = %wx%h' info:
6879Old size = 70x46 New size = 35x23
6880</pre>
6881
6882<p>Other well known 'properties' that are available include:
6883'<code>date:create</code>' and '<code>date:modify</code>' and
6884'<code>signature</code>'. </p>
6885
6886<p>The <a href="command-line-options.html#repage">-repage</a> operator will also allow you to modify
6887the '<code>page</code>' attribute of an image for images already in memory (also
6888see <a href="command-line-options.html#repage">-page</a>). However it is designed to provide a finer
6889control of the sub-parts of this 'attribute'. The <a href="command-line-options.html#set">-set page</a>
6890option will only provide a direct, unmodified assignment of '<code>page</code>'
6891attribute. </p>
6892
6893<p>This option can also associate a colorspace or profile with your image.
6894For example,</p>
6895
6896<pre>
6897convert image.psd -set profile ISOcoated_v2_eci.icc image-icc.psd
6898</pre>
6899
6900<p>Some 'properties' must be defined in a specific way to be used. For
6901example only 'properties' prefixed with "<code>filename:</code>" can be used to
6902modify the output filename of an image. For example</p>
6903
6904<pre>
6905convert rose: -set filename:mysize '%wx%h' 'rose_%[filename:mysize].png'
6906</pre>
6907
6908<p>If the setting value is prefixed with "<code>option:</code>" the setting will
Cristy594d2772015-11-15 10:47:42 -05006909be saved as a global "Artifact" exactly as if it was set using the <a
6910href="command-line-options.html#define" >-define</a> option. As such settings are global in scope, they
Cristy882d9f42015-10-29 16:48:39 -04006911can be used to pass 'attributes' and 'properties' of one specific image,
6912in a way that allows you to use them in a completely different image, even if
6913the original image has long since been modified or destroyed. For example: </p>
6914
6915<pre>
6916convert rose: -set option:rosesize '%wx%h' -delete 0 \
6917 label:'%[rosesize]' label_size_of_rose.gif"
6918</pre>
6919
Cristy594d2772015-11-15 10:47:42 -05006920<p>Note that <a href="escape.html" >Format Percent Escapes</a> will only match
Cristy882d9f42015-10-29 16:48:39 -04006921a 'artifact' if the given <var>key</var> does not match an existing
6922'attribute' or 'property'. </p>
6923
6924<p>You can set the attributes of the image registry by prefixing the value
6925with <code>registry:</code>.</p>
6926
6927<p>The <a href="command-line-options.html#set">-set profile</a> option can also be used to inject
6928previously-formatted ancillary chunks into the output PNG file, using
6929the commandline option as shown below or by setting the profile via a
6930programming interface:</p>
6931
6932<pre>
6933convert in.png -set profile PNG-chunk-x:&lt;filename&gt; out.png
6934</pre>
6935
6936<p>where <var>x</var> is a location flag and
6937<var>filename</var> is a file containing the chunk
6938name in the first 4 bytes, then a colon (":"), followed by the chunk data.
6939This encoder will compute the chunk length and CRC, so those must not
6940be included in the file.</p>
6941
6942<p>"x" can be "b" (before PLTE), "m" (middle, i.e., between PLTE and IDAT),
6943or "e" (end, i.e., after IDAT). If you want to write multiple chunks
6944of the same type, then add a short unique string after the "x" to prevent
6945subsequent profiles from overwriting the preceding ones, e.g.,</p>
6946
6947
6948<pre>
6949convert in.png -set profile PNG-chunk-b01:file01 \
6950 -profile PNG-chunk-b02:file02 out.png
6951</pre>
6952
6953<div style="margin: auto;">
6954 <h3 class="magick-header"><a id="shade"></a>-shade <var>azimuth</var>x<var>elevation</var></h3>
6955</div>
6956
6957<p class="magick-description">shade the image using a distant light source.</p>
6958
6959<p>Specify <var>azimuth</var> and <var>elevation</var> as
6960the position of the light source. Use <a href="command-line-options.html#shade">+shade</a> to return
6961the shading results as a grayscale image.</p>
6962
6963<div style="margin: auto;">
6964 <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>
6965</div>
6966
6967<p class="magick-description">simulate an image shadow.</p>
6968
6969<div style="margin: auto;">
Cristy594d2772015-11-15 10:47:42 -05006970 <h3 class="magick-header"><a
6971id="shared-memory"></a>-shared-memory</h3>
Cristy882d9f42015-10-29 16:48:39 -04006972</div>
6973
6974<p class="magick-description">use shared memory.</p>
6975
6976<p>This option specifies whether the utility should attempt to use shared
6977memory for pixmaps. ImageMagick must be compiled with shared memory support,
6978and the display must support the <var>MIT-SHM</var> extension.
6979Otherwise, this option is ignored. The default is <code>True</code>.</p>
6980
6981<div style="margin: auto;">
Cristy594d2772015-11-15 10:47:42 -05006982 <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 -04006983</div>
6984
6985<p class="magick-description">sharpen the image.</p>
6986
6987<p>Use a Gaussian operator of the given radius and standard deviation (sigma).</p>
6988
6989<div style="margin: auto;">
6990 <h3 class="magick-header"><a id="shave"></a>-shave <var>geometry</var></h3>
6991</div>
6992
6993<p class="magick-description">Shave pixels from the image edges.</p>
6994
6995<p>The <var>size</var> portion of the <var>geometry</var>
6996argument specifies the width of the region to be removed from both sides of
6997the image and the height of the regions to be removed from top and bottom.
6998Offsets are ignored.</p>
6999
7000<p>See <a href="command-line-processing.html#geometry">Image Geometry</a> for complete details about the <em class="arg">geometry</em> argument.</p>
7001
7002<div style="margin: auto;">
7003 <h3 class="magick-header"><a id="shear"></a>-shear <var>Xdegrees</var>[x<var>Ydegrees</var>]</h3>
7004</div>
7005
7006<p class="magick-description">Shear the image along the x-axis and/or y-axis.</p>
7007
7008<p>The shear angles may be positive, negative, or zero. When <var>Ydegrees</var> is omitted it defaults to 0. When both angles are
7009given, the horizontal component of the shear is performed before the vertical
7010component.</p>
7011
7012<p>Shearing slides one edge of an image along the x-axis or y-axis (i.e.,
7013horizontally or vertically, respectively),creating a parallelogram. The amount
7014of each is controlled by the respective shear angle. For horizontal shears,
7015<var>Xdegrees</var> is measured clockwise relative to "up" (the
7016negative 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
7017positive 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>
7018
7019<p>Empty triangles left over from shearing the image are filled with the color
7020defined by the <a href="command-line-options.html#fill">-background</a> option. The color is specified
7021using the format described under the <a href="command-line-options.html#fill">-fill</a> option.</p>
7022
7023<p>The horizontal shear is performed before the vertical part. This is
7024important to note, since horizontal and vertical shears do not
7025<var>commute</var>, i.e., the order matters in a sequence of shears. For
7026example, the following two commands are not equivalent.</p>
7027
7028<pre>
7029convert logo: -shear 20x0 -shear 0x60 logo-sheared.png
7030convert logo: -shear 0x60 -shear 20x0 logo-sheared.png
7031</pre>
7032
7033<p>The first of the two commands above is equivalent to the following, except
7034for the amount of empty space created; the command that follows generates
7035a smaller image, and so is a better choice in terms of time and space.</p>
7036
7037<pre>
7038convert logo: -shear 20x60 logo-sheared.png
7039</pre>
7040
7041<div style="margin: auto;">
7042 <h3 class="magick-header"><a id="sigmoidal-contrast"></a>-sigmoidal-contrast <var>contrast</var>x<var>mid-point</var></h3>
7043</div>
7044
7045<p class="magick-description">increase the contrast without saturating highlights or shadows.</p>
7046
7047<p>Increase the contrast of the image using a sigmoidal transfer function
7048without saturating highlights or shadows. <var>Contrast</var>
7049indicates how much to increase the contrast. For example, 0 is none, 3 is
7050typical and 20 is a lot.
7051</p>
7052
7053<p>The <var>mid-point</var> indicates where the maximum change
7054'slope' in contrast should fall in the resultant image (0 is white; 50% is
7055middle-gray; 100% is black). </p>
7056
7057<p>By default the image contrast is increased, use <var>+sigmoidal-contrast</var> to decrease the contrast.</p>
7058
7059<p>To achieve the equivalent of a sigmoidal brightness change (similar to
7060a gamma adjustment), you would use <var>-sigmoidal-contrast
7061{brightness}x0%</var> to increase brightness and <var>+sigmoidal-contrast {brightness}x0%</var> to decrease brightness.
7062Note the use of '0' fo rthe mid-point of the sigmoidal curve. </p>
7063
7064<p>Using a very high <var>contrast</var> will produce a sort of
7065'smoothed thresholding' of the image. Not as sharp (with high aliasing
7066effects) of a true threshold, but with tapered gray-levels around the threshold
7067<var>mid-point</var>. </p>
7068
7069<div style="margin: auto;">
7070 <h3 class="magick-header"><a id="silent"></a>-silent</h3>
Cristyf650f4f2016-04-01 10:53:07 -04007071
7072
Cristy882d9f42015-10-29 16:48:39 -04007073</div>
7074
Cristyf650f4f2016-04-01 10:53:07 -04007075<p class="magick-description">operate silently. This option is only used
7076by the <a href="import.html">import</a> tool.</p>
Cristy882d9f42015-10-29 16:48:39 -04007077
7078<div style="margin: auto;">
7079 <h3 class="magick-header"><a id="similarity-threshold"></a>-similarity-threshold <var>value</var></h3>
7080</div>
7081
7082<p class="magick-description">minimum RMSE for subimage match.</p>
7083
7084<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>
7085
7086<div style="margin: auto;">
7087 <h3 class="magick-header"><a id="size"></a>-size <var>width</var>[x<var>height</var>][<var>+offset</var>]</h3>
7088</div>
7089
7090<p class="magick-description">set the width and height of the image.</p>
7091
7092<p>Use this option to specify the width and height of raw images whose
7093dimensions are unknown such as <code>GRAY</code>, <code>RGB</code>, or
Cristy594d2772015-11-15 10:47:42 -05007094<code>CMYK</code>. In addition to width and height, use <a
7095href="command-line-options.html#size">-size</a> with an offset to skip any header information in the
Cristy882d9f42015-10-29 16:48:39 -04007096image or tell the number of colors in a <code>MAP</code> image file, (e.g. -size
7097640x512+256).</p>
7098
7099<p>For Photo CD images, choose from these sizes:</p>
7100
7101<pre>
7102192x128
7103384x256
7104768x512
71051536x1024
71063072x2048
7107</pre>
7108
7109<div style="margin: auto;">
Cristy594d2772015-11-15 10:47:42 -05007110 <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 -04007111</div>
7112
7113<p class="magick-description">simulate a pencil sketch.</p>
7114
7115<p>Sketch with the given radius, standard deviation (sigma), and angle. The
7116angle given is the angle toward which the image is sketched. That is the
7117direction people would consider the object is coming from. </p>
7118
7119<div style="margin: auto;">
7120 <h3 class="magick-header"><a id="smush"></a>-smush <var>offset</var></h3>
7121</div>
7122
Cristybc232422016-11-22 07:46:18 -05007123<p class="magick-description">appends an image sequence together ignoring transparency.</p>
7124
7125<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>
7126
7127<p>If the offset is negative, images will overlap by that amount.</p>
7128
7129<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>
7130
7131<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 -04007132
7133<div style="margin: auto;">
7134 <h3 class="magick-header"><a id="snaps"></a>-snaps <var>value</var></h3>
7135</div>
7136
7137<p class="magick-description">Set the number of screen snapshots.</p>
7138
7139<p>Use this option to grab more than one image from the X server screen, to create an animation sequence.</p>
7140
7141<div style="margin: auto;">
Cristy769d8892016-01-19 18:11:14 -05007142 <h3 class="magick-header"><a id="solarize"></a>-solarize <var>percent-threshold</var></h3>
Cristy882d9f42015-10-29 16:48:39 -04007143</div>
7144
7145<p class="magick-description">negate all pixels above the threshold level.</p>
7146
7147<p>Specify <var>factor</var> as the percent threshold of the intensity (0 - 99.9%).</p>
7148
7149<p>This option produces a <var>solarization</var> effect seen when
7150exposing a photographic film to light during the development process.</p>
7151
7152<div style="margin: auto;">
7153 <h3 class="magick-header"><a id="sparse-color"></a>-sparse-color <var>method</var> '<var>x</var>,<var>y</var> <var>color</var> ...'</h3>
7154</div>
7155
7156<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>
7157
7158
7159<dl class="dl-horizontal">
7160 <dt>barycentric</dt>
7161 <dd>three point triangle of color given 3 points.
7162 Giving only 2 points will form a linear gradient between those points.
7163 The gradient generated extends beyond the triangle created by those
7164 3 points. </dd>
7165 <dt>bilinear</dt>
7166 <dd>Like barycentric but for 4 points. Less than 4 points
7167 fall back to barycentric. </dd>
7168 <dt>voronoi</dt>
7169 <dd>Simply map each pixel to the to nearest color point
7170 given. The result are polygonal 'cells' of solid color. </dd>
7171 <dt>manhatten</dt>
7172 <dd>Like voronoi, but resulting polygonal 'cells' are mapped to a fixed coordinate system.</dd>
7173 <dt>shepards</dt>
7174 <dd>Colors points biased on the ratio of inverse distance
7175 squared. Generating spots of color in a sea of the average of
7176 colors. </dd>
7177 <dt>inverse</dt>
7178 <dd>Colors points biased on the ratio of inverse distance.
7179 This generates sharper points of color rather than rounded spots of
7180 '<code>shepards</code>' Generating spots of color in a sea of the
7181 average of colors. </dd>
7182</dl>
7183
7184<p>The points are placed according to the images location on the virtual
Cristy594d2772015-11-15 10:47:42 -05007185canvas (<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 -04007186offset), and do not actually have to exist on the given image, but may be
7187some point beyond the edge of the image. All points are floating point values.
7188</p>
7189
Cristy594d2772015-11-15 10:47:42 -05007190<p>Only the color channels defined by the <a href="command-line-options.html#channel" >-channel</a> are
Cristy882d9f42015-10-29 16:48:39 -04007191modified, which means that by default matte/alpha transparency channel is not
7192effected. Typically transparency channel is turned off either before or after
7193the operation. </p>
7194
7195<p>Of course if some color points are transparent to generate a transparent
7196gradient, then the image also requires transparency enabled to store the
7197values. </p>
7198
7199<p>All the above methods when given a single point of color will replace all
7200the colors in the image with the color given, regardless of the point. This is
7201logical, and provides an alternative technique to recolor an image to some
7202default value. </p>
7203
7204
7205<div style="margin: auto;">
7206 <h3 class="magick-header"><a id="splice"></a>-splice <var>geometry</var></h3>
7207</div>
7208
7209<p class="magick-description">Splice the current background color into the image.</p>
7210
Cristy594d2772015-11-15 10:47:42 -05007211<p>This will add rows and columns of the current <a
7212href="command-line-options.html#background">-background</a> color into the given image according to the
Cristy882d9f42015-10-29 16:48:39 -04007213given <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
7214image into four quadrants, separating them by the inserted rows and columns.
7215</p>
7216
7217<p>If a dimension of geometry is zero no rows or columns will be added for that
Cristy594d2772015-11-15 10:47:42 -05007218dimension. Similarly using a zero offset with the appropriate <a
7219href="command-line-options.html#gravity">-gravity</a> setting will add rows and columns to the edges of
7220the image, padding the image only along that one edge. Edge padding is what <a
7221href="command-line-options.html#splice">-splice</a> is most commonly used for. </p>
Cristy882d9f42015-10-29 16:48:39 -04007222
Cristy594d2772015-11-15 10:47:42 -05007223<p>If the exact same <var>geometry</var> and <a
7224href="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 -04007225added added all splices removed. </p>
7226
7227<div style="margin: auto;">
7228 <h3 class="magick-header"><a id="spread"></a>-spread <var>amount</var></h3>
7229</div>
7230
7231<p class="magick-description">displace image pixels by a random amount.</p>
7232
7233<p>The argument <var>amount</var> defines the size of the
7234neighborhood around each pixel from which to choose a candidate pixel to
7235blend.</p>
7236
7237<p>The lookup is controlled by the <a href="command-line-options.html#interpolate">-interpolate</a> setting.</p>
7238
7239<div style="margin: auto;">
7240 <h3 class="magick-header"><a id="statistic"></a>-statistic <var>type</var> <var>geometry</var></h3>
7241</div>
7242
7243<p class="magick-description">replace each pixel with corresponding statistic from the neighborhood.</p>
7244
7245<p>Choose from these statistic types:</p>
7246<dl class="dl-horizontal">
7247<dt>Gradient</dt><dd>maximum difference (max - min) value in neighborhood</dd>
7248<dt>Maximum</dt><dd>maximum value per channel in neighborhood</dd>
7249<dt>Minimum</dt><dd>minimum value per channel in neighborhood</dd>
7250<dt>Mean</dt><dd>average value per channel in neighborhood</dd>
7251<dt>Median</dt><dd>median value per channel in neighborhood</dd>
7252<dt>Mode</dt><dd>mode (most frequent) value per channel in neighborhood</dd>
7253<dt>Nonpeak</dt><dd>value just before or after the median value per channel in neighborhood</dd>
7254<dt>RMS</dt><dd>root mean square value per channel in neighborhood</dd>
7255<dt>StandardDeviation</dt><dd> standard deviation value per channel in neighborhood</dd>
7256</dl>
7257
7258<div style="margin: auto;">
7259 <h3 class="magick-header"><a id="stegano"></a>-stegano <var>offset</var></h3>
7260</div>
7261
7262<p class="magick-description">hide watermark within an image.</p>
7263
7264<p>Use an offset to start the image hiding some number of pixels from the
7265beginning of the image. Note this offset and the image size. You will need
7266this information to recover the steganographic image (e.g. display -size
7267320x256+35 stegano:image.png).</p>
7268
7269<div style="margin: auto;">
7270 <h3 class="magick-header"><a id="stereo"></a>-stereo <var>+x</var>{<var>+y</var>}</h3>
7271</div>
7272
7273<p class="magick-description">composite two images to create a red / cyan stereo anaglyph.</p>
7274
7275<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>
7276
7277<div style="margin: auto;">
7278 <h3 class="magick-header"><a id="storage-type"></a>-storage-type <var>type</var></h3>
7279</div>
7280
7281<p class="magick-description">pixel storage type. Here are the valid types:</p>
7282
7283<dl class="dl-horizontal">
7284<dt>char</dt><dd>unsigned characters</dd>
7285<dt>double</dt><dd>doubles</dd>
7286<dt>float</dt><dd>floats</dd>
7287<dt>integer</dt><dd>integers</dd>
7288<dt>long</dt><dd>longs</dd>
7289<dt>quantum</dt><dd>pixels in the native depth of your ImageMagick distribution</dd>
7290<dt>short</dt><dd>unsigned shorts</dd>
7291</dl>
7292
7293<p>Float and double types are normalized from 0.0 to 1.0 otherwise the pixels
7294values range from 0 to the maximum value the storage type can support.</p>
7295
7296<div style="margin: auto;">
7297 <h3 class="magick-header"><a id="stretch"></a>-stretch <var>fontStretch</var></h3>
7298</div>
7299
7300<p class="magick-description">Set a type of stretch style for fonts.</p>
7301
7302<p>This setting suggests a type of stretch that ImageMagick should try to
7303apply to the currently selected font family. Select <var>fontStretch</var> from the following.</p>
7304
7305<pre>
7306Any
7307Condensed
7308Expanded
7309ExtraCondensed
7310ExtraExpanded
7311Normal
7312SemiCondensed
7313SemiExpanded
7314UltraCondensed
7315UltraExpanded
7316</pre>
7317
7318<p>To print a complete list of stretch types, use <a href="command-line-options.html#list">-list
7319stretch</a>.</p>
7320
Cristy594d2772015-11-15 10:47:42 -05007321<p>For other settings that affect fonts, see the options <a
7322href="command-line-options.html#font">-font</a>, <a href="command-line-options.html#family">-family</a>, <a
7323href="command-line-options.html#style">-style</a>, and <a href="command-line-options.html#weight">-weight</a>. </p>
Cristy882d9f42015-10-29 16:48:39 -04007324
7325<div style="margin: auto;">
7326 <h3 class="magick-header"><a id="strip"></a>-strip</h3>
7327</div>
7328
Cristy776113a2016-04-29 12:01:19 -04007329<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 -04007330
7331<div style="margin: auto;">
7332 <h3 class="magick-header"><a id="stroke"></a>-stroke <var>color</var></h3>
7333</div>
7334
7335<p class="magick-description">color to use when stroking a graphic primitive.</p>
7336
7337<p>The color is specified using the format described under the <a href="command-line-options.html#fill">-fill</a> option.</p>
7338
7339<p>See <a href="command-line-options.html#draw">-draw</a> for further details.</p>
7340
7341<div style="margin: auto;">
7342 <h3 class="magick-header"><a id="strokewidth"></a>-strokewidth <var>value</var></h3>
7343</div>
7344
7345<p class="magick-description">set the stroke width.</p>
7346
7347<p>See <a href="command-line-options.html#draw">-draw</a> for further details.</p>
7348
7349<div style="margin: auto;">
7350 <h3 class="magick-header"><a id="style"></a>-style <var>fontStyle</var></h3>
7351</div>
7352
7353<p class="magick-description">Set a font style for text.</p>
7354
7355<p>This setting suggests a font style that ImageMagick should try to apply to
7356the currently selected font family. Select <var>fontStyle</var> from
7357the following.</p>
7358
7359<pre>
7360Any
7361Italic
7362Normal
7363Oblique
7364</pre>
7365
Cristy594d2772015-11-15 10:47:42 -05007366<p>For other settings that affect fonts, see the options <a
7367href="command-line-options.html#font">-font</a>, <a href="command-line-options.html#family">-family</a>, <a
7368href="command-line-options.html#stretch">-stretch</a>, and <a href="command-line-options.html#weight">-weight</a>. </p>
Cristy882d9f42015-10-29 16:48:39 -04007369
7370<div style="margin: auto;">
7371 <h3 class="magick-header"><a id="subimage-search"></a>-subimage-search</h3>
7372</div>
7373
7374<p class="magick-description">search for subimage.</p>
7375
7376<p>This option is required to have compare search for the best match location
7377of a small image within a larger image. This search will produce two images
7378(or two frames). The first is the "difference" image and the second will
7379be the "match score" image.</p>
7380
7381<p>The "match-score" image is smaller containing a pixel for ever possible
7382position of the top-left corner of the given sub-image. that is its size will
7383be the size of the larger_image - sub_image + 1. The brightest location in
7384this image is the location s the locate on the best match that is also
7385reported. Note that this may or may not be a perfect match, and the actual
7386brightness will reflect this. Other bright 'peaks' can be used to locate other
7387possible matching locations. </p>
7388
7389<p>Note that the search will try to compare the sub-image at every possible
7390location in the larger image, as such it can be very slow. The smaller the
7391sub-image the faster this search is. </p>
7392
7393
7394<div style="margin: auto;">
7395 <h3 class="magick-header"><a id="swap"></a>-swap <var>index,index</var></h3>
7396</div>
7397
7398<p class="magick-description">Swap the positions of two images in the image sequence.</p>
7399
7400<p>For example, <a href="command-line-options.html#swap">-swap 0,2</a> swaps the first and the third
7401images in the current image sequence. Use <a href="command-line-options.html#swap">+swap</a> to switch
7402the last two images in the sequence.</p>
7403
7404<div style="margin: auto;">
7405 <h3 class="magick-header"><a id="swirl"></a>-swirl <var>degrees</var></h3>
7406</div>
7407
7408<p class="magick-description">swirl image pixels about the center.</p>
7409
7410<p><var>Degrees</var> defines the tightness of the swirl.</p>
7411
7412<div style="margin: auto;">
7413 <h3 class="magick-header"><a id="synchronize"></a>-synchronize</h3>
7414</div>
7415
7416<p class="magick-description">synchronize image to storage device.</p>
7417
7418<p>Set to "true" to ensure all image data is fully flushed and synchronized
7419to disk. There is a performance penalty, but the benefits include ensuring a
7420valid image file in the event of a system crash and early reporting if there
7421is not enough disk space for the image pixel cache.</p>
7422
7423<div style="margin: auto;">
7424 <h3 class="magick-header"><a id="taint"></a>-taint</h3>
7425</div>
7426
7427<p class="magick-description">Mark the image as modified.</p>
7428
7429<div style="margin: auto;">
7430 <h3 class="magick-header"><a id="text-font"></a>-text-font <var>name</var></h3>
7431</div>
7432
7433<p class="magick-description">font for writing fixed-width text.</p>
7434
7435<p>Specifies the name of the preferred font to use in fixed (typewriter style)
7436formatted text. The default is 14 point <var>Courier</var>.</p>
7437
7438<p>You can tag a font to specify whether it is a PostScript, TrueType, or
7439OPTION1 font. For example, <code>Courier.ttf</code> is a TrueType font and
7440<code>x:fixed</code> is OPTION1.</p>
7441
7442<div style="margin: auto;">
7443 <h3 class="magick-header"><a id="texture"></a>-texture <var>filename</var></h3>
7444</div>
7445
7446<p class="magick-description">name of texture to tile onto the image background.</p>
7447
7448<div style="margin: auto;">
7449 <h3 class="magick-header"><a id="threshold"></a>-threshold <var>value</var>{<var>%</var>}</h3>
7450</div>
7451
7452<!-- {<var>green,blue,opacity</var>}
7453<p>If the green or blue value is omitted, these channels use the same value as
7454the first one provided. If all three color values are the same, the result is
7455a bi-level image. If the opacity threshold is omitted, OpaqueOpacity is used
7456and any partially transparent pixel becomes fully transparent.</p>
7457-->
7458
7459<p class="magick-description">Apply simultaneous black/white threshold to the image.</p>
7460
Cristy594d2772015-11-15 10:47:42 -05007461<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 -04007462maximum channel value, while all other values are assigned the minimum.</p>
7463
7464<p> The threshold value can be given as a percentage or as an absolute integer
7465value corresponding to the desired channel value. When given as an integer,
7466the minimum attainable value is 0 (corresponding to black when all channels
7467are affected), but the maximum value (corresponding to white) is that of the
7468<code>quantum depth</code> of the particular build of ImageMagick, and is
7469therefore dependent on the installation. For that reason, a reasonable
7470recommendation for most applications is to specify the threshold values as
7471a percentage. </p>
7472
7473<p> The following would force pixels with red values above 50% to have 100%
7474red values, while those at or below 50% red would be set to 0 in the red
7475channel. The green, blue, and alpha channels (if present) would be unchanged.
7476</p>
7477
7478<pre>
7479convert in.png -channel red -threshold 50% out.png
7480</pre>
7481
7482<p>As (possibly) impractical but instructive examples, the following would
7483generate an all-black and an all-white image with the same dimensions as the
7484input image.</p>
7485
7486
7487<pre>
7488convert in.png -threshold 100% black.png
7489convert in.png -threshold -1 white.png
7490</pre>
7491
7492<p>Note that the values of the transparency channel is treated as 'matte'
7493values (0 is opaque) and not as 'alpha' values (0 is transparent).</p>
7494
Cristy594d2772015-11-15 10:47:42 -05007495<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 -04007496</p>
7497
7498<div style="margin: auto;">
7499 <h3 class="magick-header"><a id="thumbnail"></a>-thumbnail <var>geometry</var></h3>
7500</div>
7501
7502<p class="magick-description">Create a thumbnail of the image.</p>
7503
7504<p>This is similar to <a href="command-line-options.html#resize">-resize</a>, except it is optimized
7505for speed and any image profile, other than a color profile, is removed to
Cristy594d2772015-11-15 10:47:42 -05007506reduce the thumbnail size. To strip the color profiles as well, add <a
7507href="command-line-options.html#strip">-strip</a> just before of after this option.</p>
Cristy882d9f42015-10-29 16:48:39 -04007508
7509<p>See <a href="command-line-processing.html#geometry">Image Geometry</a> for complete details about the <em class="arg">geometry</em> argument.</p>
7510
7511<div style="margin: auto;">
7512 <h3 class="magick-header"><a id="tile"></a>-tile <var>filename</var></h3>
7513</div>
7514
7515<p class="magick-description">Set the tile image used for filling a subsequent graphic primitive.</p>
7516
7517<div style="margin: auto;">
7518 <h3 class="magick-header">-tile <var>geometry</var></h3>
7519</div>
7520
7521<p class="magick-description">Specify the layout of images.</p>
7522
7523<p>See <a href="command-line-processing.html#geometry">Image Geometry</a> for complete details about the <em class="arg">geometry</em> argument.</p>
7524
7525<div style="margin: auto;">
7526 <h3 class="magick-header">-tile</h3>
7527</div>
7528
7529<p class="magick-description">Specifies that a subsequent composite operation is repeated across and down image.</p>
7530
7531<div style="margin: auto;">
7532 <h3 class="magick-header"><a id="tile-offset"></a>-tile-offset {<var>+-</var>}<var>x</var>{<var>+-</var>}<var>y</var></h3>
7533</div>
7534
7535<p class="magick-description">Specify the offset for tile images, relative to the background image it is tiled on.</p>
7536
Cristy594d2772015-11-15 10:47:42 -05007537<p>This should be set before the tiling image is set by <a href="command-line-options.html#tile"
7538>-tile</a> or <a href="command-line-options.html#texture" >-texture</a>, or directly applied for
Cristy882d9f42015-10-29 16:48:39 -04007539creating a tiled canvas using <code>TILE:</code> or <code>PATTERN:</code> input
7540formats. </p>
7541
Cristy594d2772015-11-15 10:47:42 -05007542<p>Internally ImageMagick does a <a href="command-line-options.html#roll" >-roll</a> of the tile image
Cristy882d9f42015-10-29 16:48:39 -04007543by the arguments given when the tile image is set. </p>
7544
7545<div style="margin: auto;">
7546 <h3 class="magick-header"><a id="tint"></a>-tint <var>value</var></h3>
7547</div>
7548
7549<p class="magick-description">Tint the image with the fill color.</p>
7550
7551<p>Tint the image with the fill color.</p>
7552
7553<p>Specify the amount of tinting as a percentage. Pure colors like black,
7554white red, yellow, will not be affected by -tint. Only mid-range colors such
7555as the various shades of grey.</p>
7556
7557<div style="margin: auto;">
7558 <h3 class="magick-header"><a id="title"></a>-title <var>string</var></h3>
7559</div>
7560
7561<p class="magick-description">Assign a title to displayed image.", "animate", "display", "montage</p>
7562
7563<p>Use this option to assign a specific title to the image. This assigned to
7564the image window and is typically displayed in the window title bar.
7565Optionally you can include the image filename, type, width, height, Exif data,
7566or other image attribute by embedding special format characters described
7567under the <a href="command-line-options.html#format">-format</a> option.</p>
7568
7569<p>For example,</p>
7570
7571<pre>
7572-title "%m:%f %wx%h"
7573</pre>
7574
7575<p>produces an image title of <code>MIFF:bird.miff 512x480</code> for an image
7576titled <code>bird.miff</code> and whose width is 512 and height is 480.</p>
7577
7578
7579<div style="margin: auto;">
7580 <h3 class="magick-header"><a id="transform"></a>-transform</h3>
7581</div>
7582
7583<p class="magick-description">transform the image.</p>
7584
7585<p>This option applies the transformation matrix from a previous <a href="command-line-options.html#affine">-affine</a> option.</p>
7586
7587<pre>
7588convert -affine 2,2,-2,2,0,0 -transform bird.ppm bird.jpg
7589</pre>
7590
7591
Cristy594d2772015-11-15 10:47:42 -05007592<p>This operator has been now been superseded by the <a
7593href="command-line-options.html#distort">-distort</a> '<code>AffineProjection</code>' method. </p>
Cristy882d9f42015-10-29 16:48:39 -04007594
7595
7596<div style="margin: auto;">
7597 <h3 class="magick-header"><a id="transparent"></a>-transparent <var>color</var></h3>
7598</div>
7599
7600<p class="magick-description">Make this color transparent within the image.</p>
7601
7602<p>The <var>color</var> argument is defined using the format
Cristy594d2772015-11-15 10:47:42 -05007603described under the <a href="command-line-options.html#fill">-fill</a> option. The <a href="command-line-options.html#fuzz"
7604>-fuzz</a> setting can be used to match and replace colors similar to the one
Cristy882d9f42015-10-29 16:48:39 -04007605given. </p>
7606
Cristy594d2772015-11-15 10:47:42 -05007607<p>Use <a href="command-line-options.html#transparent" >+transparent</a> to invert the pixels matched.
Cristy882d9f42015-10-29 16:48:39 -04007608that is make all non-matching colors transparent. </p>
7609
Cristy594d2772015-11-15 10:47:42 -05007610<p>The <a href="command-line-options.html#opaque">-opaque</a> operator is exactly the same as <a
7611href="command-line-options.html#transparent" >-transparent</a> but replaces the matching color with the
Cristy882d9f42015-10-29 16:48:39 -04007612current <a href="command-line-options.html#fill">-fill</a> color setting, rather than transparent.
Cristy594d2772015-11-15 10:47:42 -05007613However the <a href="command-line-options.html#transparent" >-transparent</a> operator also ensures
7614that the image has an alpha channel enabled, as per "<code><a href="command-line-options.html#alpha"
7615>-alpha</a> set</code>", and does not require you to modify the <a
7616href="command-line-options.html#channel">-channel</a> to enable alpha channel handling. </p>
Cristy882d9f42015-10-29 16:48:39 -04007617
7618<p>Note that this does not define the color as being the 'transparency color'
Cristy594d2772015-11-15 10:47:42 -05007619used for color-mapped image formats, such as GIF. For that use <a
7620href="command-line-options.html#transparent-color" >-transparent-color</a> </p>
Cristy882d9f42015-10-29 16:48:39 -04007621
7622
7623<div style="margin: auto;">
7624 <h3 class="magick-header"><a id="transparent-color"></a>-transparent-color <var>color</var></h3>
7625</div>
7626
7627<p class="magick-description">Set the transparent color.</p>
7628
7629<p>Sometimes this is used for saving to image formats such as
7630GIF and PNG8 which uses this color to represent boolean transparency. This
7631does not make a color transparent, it only defines what color the transparent
Cristy594d2772015-11-15 10:47:42 -05007632color is in the color palette of the saved image. Use <a
7633href="command-line-options.html#transparent">-transparent</a> to make an opaque color transparent.</p>
Cristy882d9f42015-10-29 16:48:39 -04007634
7635<p>This option allows you to have both an opaque visible color, as well as a
7636transparent color of the same color value without conflict. That is, you can
7637use the same color for both the transparent and opaque color areas within an
7638image. This, in turn, frees to you to select a transparent color that is
7639appropriate when an image is displayed by an application that does not handle a
7640transparent color index, while allowing ImageMagick to correctly handle images of this
7641type. </p>
7642
7643<p>The default transparent color is <code>#00000000</code>, which is fully transparent black.</p>
7644
7645<div style="margin: auto;">
7646 <h3 class="magick-header"><a id="transpose"></a>-transpose</h3>
7647</div>
7648
7649<p class="magick-description">Mirror the image along the top-left to bottom-right diagonal.</p>
7650
7651<p> This option mathematically transposes the pixel array. It is equivalent to the sequence <code>-flip -rotate 90</code>.
7652</p>
7653
7654<div style="margin: auto;">
7655 <h3 class="magick-header"><a id="transverse"></a>-transverse</h3>
7656</div>
7657
7658<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>
7659
7660
7661<div style="margin: auto;">
7662 <h3 class="magick-header"><a id="treedepth"></a>-treedepth <var>value</var></h3>
7663</div>
7664
7665<p class="magick-description">tree depth for the color reduction algorithm.</p>
7666
7667<p>Normally, this integer value is zero or one. A value of zero or one causes
7668the use of an optimal tree depth for the color reduction algorithm.</p>
7669
7670<p>An optimal depth generally allows the best representation of the source
7671image with the fastest computational speed and the least amount of memory.
7672However, the default depth is inappropriate for some images. To assure the
7673best representation, try values between 2 and 8 for this parameter. Refer to
Cristy6549abb2016-11-10 08:25:55 -05007674the <a href="http://www.imagemagick.org/www/quantize.html"
Cristy594d2772015-11-15 10:47:42 -05007675>color reduction algorithm</a> for more details.</p>
Cristy882d9f42015-10-29 16:48:39 -04007676
7677<p>The <a href="command-line-options.html#colors">-colors</a> or <a href="command-line-options.html#monochrome">-monochrome</a>
7678option, or writing to an image format which requires color reduction, is
7679required for this option to take effect.</p>
7680
7681<div style="margin: auto;">
7682 <h3 class="magick-header"><a id="trim"></a>-trim</h3>
7683</div>
7684
7685<p class="magick-description">trim an image.</p>
7686
7687<p>This option removes any edges that are exactly the same color as the corner
7688pixels. Use <a href="command-line-options.html#fuzz">-fuzz</a> to make <a href="command-line-options.html#trim">-trim</a> remove
7689edges that are nearly the same color as the corner pixels.</p>
7690
7691<p>The page or virtual canvas information of the image is preserved allowing
7692you to extract the result of the <a href="command-line-options.html#trim">-trim</a> operation from the
7693image. Use a <a href="command-line-options.html#repage">+repage</a> to remove the virtual canvas page
7694information if it is unwanted.</p>
7695
7696<p>If the trimmed image 'disappears' an warning is produced, and a special
7697single pixel transparent 'missed' image is returned, in the same way as when a
7698<a href="command-line-options.html#crop">-crop</a> operation 'misses' the image proper. </p>
7699
7700
7701<div style="margin: auto;">
7702 <h3 class="magick-header"><a id="type"></a>-type <var>type</var></h3>
7703</div>
7704
7705<p class="magick-description">the image type.</p> <p>Choose from: <code>Bilevel</code>,
7706<code>Grayscale</code>, <code>GrayscaleMatte</code>, <code>Palette</code>,
7707<code>PaletteMatte</code>, <code>TrueColor</code>, <code>TrueColorMatte</code>,
7708<code>ColorSeparation</code>, or <code>ColorSeparationMatte</code>.</p>
7709
7710<p>Normally, when a format supports different subformats such as grayscale and
Cristy594d2772015-11-15 10:47:42 -05007711truecolor, the encoder will try to choose an efficient subformat. The <a
7712href="command-line-options.html#type">-type</a> option can be used to override this behavior. For
Cristy882d9f42015-10-29 16:48:39 -04007713example, to prevent a JPEG from being written in grayscale format even though
7714only gray pixels are present, use.</p>
7715
7716<pre>
7717convert bird.png -type TrueColor bird.jpg
7718</pre>
7719
7720<p>Similarly, use <a href="command-line-options.html#type">-type TrueColorMatte</a> to force the
7721encoder to write an alpha channel even though the image is opaque, if the
7722output format supports transparency.</p>
7723
7724<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>
7725
7726<div style="margin: auto;">
7727 <h3 class="magick-header"><a id="undercolor"></a>-undercolor <var>color</var></h3>
7728</div>
7729
7730<p class="magick-description">set the color of the annotation bounding box.</p>
7731
7732<p>The color is specified using the format described under the <a href="command-line-options.html#fill">-fill</a> option.</p>
7733
7734<p>See <a href="command-line-options.html#draw">-draw</a> for further details.</p>
7735
7736
7737<div style="margin: auto;">
7738 <h3 class="magick-header"><a id="update"></a>-update <var>seconds</var></h3>
7739</div>
7740
7741<p class="magick-description">detect when image file is modified and redisplay.</p>
7742
7743<p>Suppose that while you are displaying an image the file that is currently
7744displayed is over-written. <code>display</code> will automagically detect that
7745the input file has been changed and update the displayed image
7746accordingly.</p>
7747
7748
7749<div style="margin: auto;">
7750 <h3 class="magick-header"><a id="unique-colors"></a>-unique-colors</h3>
7751</div>
7752
7753<p class="magick-description">discard all but one of any pixel color.</p>
7754
7755
7756<div style="margin: auto;">
7757 <h3 class="magick-header"><a id="units"></a>-units <var>type</var></h3>
7758</div>
7759
7760<p class="magick-description">the units of image resolution.</p>
7761
7762<p>Choose from: <code>Undefined</code>, <code>PixelsPerInch</code>, or
7763<code>PixelsPerCentimeter</code>. This option is normally used in conjunction
7764with the <a href="command-line-options.html#density">-density</a> option.</p>
7765
7766
7767<div style="margin: auto;">
Cristy594d2772015-11-15 10:47:42 -05007768 <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 -04007769</div>
7770
7771<p class="magick-description">sharpen the image with an unsharp mask operator.</p>
7772
7773<p>The <a href="command-line-options.html#unsharp">-unsharp</a> option sharpens an image. The image is
7774convolved with a Gaussian operator of the given radius and standard deviation
7775(sigma). For reasonable results, radius should be larger than sigma. Use
7776a radius of 0 to have the method select a suitable radius.</p>
7777
7778<p>The parameters are:</p>
7779
7780<dl class="dl-horizontal">
7781<dt>radius</dt>
7782<dd>The radius of the Gaussian, in pixels, not counting the center pixel (default 0).</dd>
7783<dt>sigma</dt>
7784<dd>The standard deviation of the Gaussian, in pixels (default 1.0).</dd>
7785<dt>gain</dt>
7786<dd>The fraction of the difference between the original and the blur image that is added back into the original (default 1.0).</dd>
7787<dt>threshold</dt>
7788<dd>The threshold, as a fraction of <var>QuantumRange</var>, needed to apply the difference amount (default 0.05).</dd>
7789</dl>
7790
7791<div style="margin: auto;">
7792 <h3 class="magick-header"><a id="verbose"></a>-verbose</h3>
7793</div>
7794
7795<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>
7796
7797
7798<div style="margin: auto;">
7799 <h3 class="magick-header"><a id="version"></a>-version</h3>
7800</div>
7801
7802<p class="magick-description">print ImageMagick version string and exit.</p>
7803
7804
7805<div style="margin: auto;">
7806 <h3 class="magick-header"><a id="view"></a>-view <var>string</var></h3>
7807</div>
7808
7809<p class="magick-description">FlashPix viewing parameters.</p>
7810
7811
7812<div style="margin: auto;">
7813 <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>
7814</div>
7815
7816<p class="magick-description">soften the edges of the image in vignette style.</p>
7817
7818<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>
7819
7820<div style="margin: auto;">
7821 <h3 class="magick-header"><a id="virtual-pixel"></a>-virtual-pixel <var>method</var></h3>
7822</div>
7823
7824<p class="magick-description">Specify contents of <var>virtual pixels</var>.</p>
7825
7826<p>This option defines what color source should be used if and when a color
7827lookup completely 'misses' the source image. The color(s) that appear to
7828surround the source image. Generally this color is derived from the source
7829image, but could also be set to a specify background color. </p>
7830
7831<p>Choose from these methods:</p>
7832
7833<dl class="dl-horizontal">
7834<dt>background</dt><dd>the area surrounding the image is the background color</dd>
7835<dt>black</dt><dd>the area surrounding the image is black</dd>
7836<dt>checker-tile</dt><dd>alternate squares with image and background color</dd>
7837<dt>dither</dt><dd>non-random 32x32 dithered pattern</dd>
7838<dt>edge</dt><dd>extend the edge pixel toward infinity</dd>
7839<dt>gray</dt><dd>the area surrounding the image is gray</dd>
7840<dt>horizontal-tile</dt><dd>horizontally tile the image, background color above/below</dd>
7841<dt>horizontal-tile-edge</dt><dd>horizontally tile the image and replicate the side edge pixels</dd>
7842<dt>mirror</dt><dd>mirror tile the image</dd>
7843<dt>random</dt><dd>choose a random pixel from the image</dd>
7844<dt>tile</dt><dd>tile the image (default)</dd>
7845<dt>transparent</dt><dd>the area surrounding the image is transparent blackness</dd>
7846<dt>vertical-tile</dt><dd>vertically tile the image, sides are background color</dd>
7847<dt>vertical-tile-edge</dt><dd>vertically tile the image and replicate the side edge pixels</dd>
7848<dt>white</dt><dd>the area surrounding the image is white</dd>
7849</dl>
7850
7851<p>The default value is "edge".</p>
7852
Cristy594d2772015-11-15 10:47:42 -05007853<p>This most important for distortion operators such as <a href="command-line-options.html#distort"
7854>-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 -04007855However it also effects operations that may access pixels just outside the
Cristy594d2772015-11-15 10:47:42 -05007856image proper, such as <a href="command-line-options.html#convolve">-convolve</a>, <a
7857href="command-line-options.html#blur">-blur</a>, and <a href="command-line-options.html#sharpen">-sharpen</a>. </p>
Cristy882d9f42015-10-29 16:48:39 -04007858
Cristy594d2772015-11-15 10:47:42 -05007859<p>To print a complete list of virtual pixel types, use the <a
7860href="command-line-options.html#list">-list virtual-pixel</a> option.</p>
Cristy882d9f42015-10-29 16:48:39 -04007861
7862
7863<div style="margin: auto;">
7864 <h3 class="magick-header"><a id="visual"></a>-visual <var>type</var></h3>
7865</div>
7866
7867<p class="magick-description">Animate images using this X visual type.", 'animate', 'display'</p>
7868
7869<p>Choose from these visual classes:</p>
7870
7871<pre>
7872StaticGray TrueColor
7873GrayScale DirectColor
7874StaticColor default
7875PseudoColor visual id
7876</pre>
7877
7878<p>The X server must support the visual you choose, otherwise an error occurs.
7879If a visual is not specified, the visual class that can display the most
7880simultaneous colors on the default screen is chosen.</p>
7881
7882
7883<div style="margin: auto;">
7884 <h3 class="magick-header"><a id="watermark"></a>-watermark <var>brightness</var>x<var>saturation</var></h3>
7885</div>
7886
7887<p class="magick-description">Watermark an image using the given percentages of brightness and saturation.</p>
7888
7889<p>Take a grayscale image (with alpha mask) and modify the destination image's
7890brightness according to watermark image's grayscale value and the
7891<var>brightness</var> percentage. The destinations color saturation
7892attribute is just direct modified by the <var>saturation</var>
7893percentage, which defaults to 100 percent (no color change). </p>
7894
7895
7896<div style="margin: auto;">
Cristy594d2772015-11-15 10:47:42 -05007897 <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 -04007898</div>
7899
7900<p class="magick-description">Shear the columns of an image into a sine wave.</p>
7901
Cristye09ed312016-03-06 08:07:39 -05007902<div style="margin: auto;">
7903 <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>
7904</div>
7905
7906<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 -04007907
7908<div style="margin: auto;">
7909 <h3 class="magick-header"><a id="weight"></a>-weight <var>fontWeight</var></h3>
7910</div>
7911
7912<p class="magick-description">Set a font weight for text.</p>
7913
7914<p>This setting suggests a font weight that ImageMagick should try to apply to
7915the currently selected font family. Use a positive integer for
7916<var>fontWeight</var> or select from the following.</p>
7917
7918<dl class="dl-horizontal">
7919<dt>Thin </dt>
7920<dd>Same as <var>fontWeight</var> = 100.</dd>
7921<dt>ExtraLight </dt>
7922<dd>Same as <var>fontWeight</var> = 200.</dd>
7923<dt>Light </dt>
7924<dd>Same as <var>fontWeight</var> = 300.</dd>
7925<dt>Normal </dt>
7926<dd>Same as <var>fontWeight</var> = 400.</dd>
7927<dt>Medium </dt>
7928<dd>Same as <var>fontWeight</var> = 500.</dd>
7929<dt>DemiBold </dt>
7930<dd>Same as <var>fontWeight</var> = 600.</dd>
7931<dt>Bold </dt>
7932<dd>Same as <var>fontWeight</var> = 700.</dd>
7933<dt>ExtraBold </dt>
7934<dd>Same as <var>fontWeight</var> = 800.</dd>
7935<dt>Heavy </dt>
7936<dd>Same as <var>fontWeight</var> = 900.</dd>
7937</dl>
Cristy594d2772015-11-15 10:47:42 -05007938<br/>
Cristy882d9f42015-10-29 16:48:39 -04007939
7940<p>To print a complete list of weight types, use <a href="command-line-options.html#list">-list weight</a>.</p>
7941
Cristy594d2772015-11-15 10:47:42 -05007942<p>For other settings that affect fonts, see the options <a
7943href="command-line-options.html#font">-font</a>, <a href="command-line-options.html#family">-family</a>, <a
7944href="command-line-options.html#stretch">-stretch</a>, and <a href="command-line-options.html#style">-style</a>. </p>
Cristy882d9f42015-10-29 16:48:39 -04007945
7946<div style="margin: auto;">
7947 <h3 class="magick-header"><a id="white-point"></a>-white-point <var>x,y</var></h3>
7948</div>
7949
7950<p class="magick-description">chromaticity white point.</p>
7951
7952<div style="margin: auto;">
7953 <h3 class="magick-header"><a id="white-threshold"></a>-white-threshold <var>value</var>{<var>%</var>}</h3>
7954</div>
7955
7956<p class="magick-description">Force to white all pixels above the threshold while leaving all pixels at or below the threshold unchanged.</p>
7957
7958<p> The threshold value can be given as a percentage or as an absolute integer
7959value within [0, <var>QuantumRange</var>] corresponding to the
Cristy594d2772015-11-15 10:47:42 -05007960desired <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 -04007961
7962<div style="margin: auto;">
7963 <h3 class="magick-header"><a id="window"></a>-window <var>id</var></h3>
7964</div>
7965
7966<p class="magick-description">Make the image the background of a window.", 'animate', 'display'</p>
7967
7968<p><var>id</var> can be a window id or name. Specify <code>root</code>
7969to select X's root window as the target window.</p>
7970
7971<p>By default the image is tiled onto the background of the target window. If
7972<code>backdrop</code> or <a href="command-line-options.html#geometry">-resize</a> are specified, the
7973image is surrounded by the background color. Refer to <code>X RESOURCES</code>
7974for details.</p>
7975
7976<p>The image will not display on the root window if the image has more unique
Cristy594d2772015-11-15 10:47:42 -05007977colors than the target window colormap allows. Use <a
7978href="command-line-options.html#colors">-colors</a> to reduce the number of colors.</p>
Cristy882d9f42015-10-29 16:48:39 -04007979
7980<div style="margin: auto;">
7981 <h3 class="magick-header"><a id="window-group"></a>-window-group</h3>
7982</div>
7983
7984<p class="magick-description">specify the window group.</p>
7985
7986<div style="margin: auto;">
7987 <h3 class="magick-header"><a id="write"></a>-write <var>filename</var></h3>
7988</div>
7989
7990<p class="magick-description">write an image sequence.</p>
7991
7992<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>
7993
7994<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 -04007995
7996<div style="margin: auto;">
7997 <h3 class="magick-header"><a id="write-mask"></a>-write-mask <var>filename</var></h3>
7998</div>
7999
8000<p class="magick-description">Prevent updates to image pixels specified by the mask.</p>
8001
8002<p>This the same as using a mask used for composite masking operations, with
8003grayscale values causing blended updates of the image the mask is attached to.
8004</p>
8005
8006<p>Use <a href="command-line-options.html#write-mask">+write-mask</a> to remove the mask from images.</p>
8007
8008<p>Also see <a href="command-line-options.html#clip-mask">-clip-mask</a> which work in the same way,
8009but with strict boolean masking. </p>
Cristy882d9f42015-10-29 16:48:39 -04008010</div>
8011</div>
8012
8013
Cristye93be682015-11-26 09:07:51 -05008014
Cristy882d9f42015-10-29 16:48:39 -04008015 <footer class="magick-footer">
cristy29f2c972015-07-28 13:37:46 +00008016 <p><a href="support.html">Donate</a>
8017 <a href="sitemap.html">Sitemap</a>
cristyd2432012015-05-04 23:15:15 +00008018 <a href="links.html">Related</a>
Cristye0779712016-07-30 17:25:22 -04008019 <a href="security-policy.html">Security</a>
cristy29f2c972015-07-28 13:37:46 +00008020 <a href="architecture.html">Architecture</a>
cristyd2432012015-05-04 23:15:15 +00008021</p>
8022 <p><a href="command-line-options.html#">Back to top</a>
cristyea2793e2015-05-31 16:52:26 +00008023 <a href="http://pgp.mit.edu:11371/pks/lookup?op=get&amp;search=0x89AB63D48277377A">Public Key</a>
Cristy6549abb2016-11-10 08:25:55 -05008024 <a href="https://www.imagemagick.org/script/contact.php">Contact Us</a></p>
Cristyde27d762016-01-02 12:56:44 -05008025 <p><small>© 1999-2016 ImageMagick Studio LLC</small></p>
cristyd2432012015-05-04 23:15:15 +00008026 </footer>
8027</div><!-- /.container -->
8028
Cristy542697a2015-10-12 20:10:32 -04008029 <script src="https://localhost/ajax/libs/jquery/1.11.3/jquery.min.js"></script>
Cristy1f1f3a02016-06-01 07:25:42 -04008030 <script src="../js/magick.html"></script>
cristyd2432012015-05-04 23:15:15 +00008031</div>
cristyad41c0c2012-10-31 00:49:28 +00008032</body>
cristy5a367e42015-05-05 12:39:18 +00008033</html>
Cristybc232422016-11-22 07:46:18 -05008034<!-- Magick Cache 22nd November 2016 07:34 -->