blob: 237f66dba4b436e59303d3bb115aa987ee7b8d8f [file] [log] [blame]
Cristy594d2772015-11-15 10:47:42 -05001
2
3
4
cristy29dc8652015-05-12 16:26:21 +00005<!DOCTYPE html>
cristyd2432012015-05-04 23:15:15 +00006<html lang="en">
cristyad41c0c2012-10-31 00:49:28 +00007<head>
Cristy912a9222016-06-17 15:37:28 -04008 <meta charset="utf-8" />
Cristy3b0b58d2016-11-06 07:40:23 -05009 <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no" />
10 <meta http-equiv="x-ua-compatible" content="ie=edge" />
Cristy6549abb2016-11-10 08:25:55 -050011 <title>Command-line Options @ ImageMagick</title>
Cristy594d2772015-11-15 10:47:42 -050012 <meta http-equiv="content-type" content="text/html; charset=utf-8"/>
13 <meta name="application-name" content="ImageMagick"/>
14 <meta name="description" content="ImageMagick® is a software suite to create, edit, compose, or convert bitmap images. It can read and write images in a variety of formats (over 200) including PNG, JPEG, JPEG-2000, GIF, WebP, Postscript, PDF, and SVG. Use ImageMagick to resize, flip, mirror, rotate, distort, shear and transform images, adjust image colors, apply various special effects, or draw text, lines, polygons, ellipses and Bézier curves."/>
Cristy364a72f2016-11-04 22:38:41 -040015 <meta name="application-url" content="https://www.imagemagick.org"/>
Cristy594d2772015-11-15 10:47:42 -050016 <meta name="generator" content="PHP"/>
17 <meta name="keywords" content="command-line, options, ImageMagick, PerlMagick, image processing, image, photo, software, Magick++, OpenMP, convert"/>
18 <meta name="rating" content="GENERAL"/>
19 <meta name="robots" content="INDEX, FOLLOW"/>
20 <meta name="generator" content="ImageMagick Studio LLC"/>
21 <meta name="author" content="ImageMagick Studio LLC"/>
22 <meta name="revisit-after" content="2 DAYS"/>
23 <meta name="resource-type" content="document"/>
Cristyfe36f992016-12-29 20:24:13 -050024 <meta name="copyright" content="Copyright (c) 1999-2017 ImageMagick Studio LLC"/>
Cristy594d2772015-11-15 10:47:42 -050025 <meta name="distribution" content="Global"/>
26 <meta name="magick-serial" content="P131-S030410-R485315270133-P82224-A6668-G1245-1"/>
Cristy912a9222016-06-17 15:37:28 -040027 <meta name="google-site-verification" content="_bMOCDpkx9ZAzBwb2kF3PRHbfUUdFj2uO8Jd1AXArz4" />
Cristyfe36f992016-12-29 20:24:13 -050028 <link rel="canonical" href="https://www.imagemagick.org/script/command-line-options.html"/>
Cristy594d2772015-11-15 10:47:42 -050029 <link rel="icon" href="../images/wand.png"/>
30 <link rel="shortcut icon" href="../images/wand.ico"/>
Cristybc232422016-11-22 07:46:18 -050031 <link rel="stylesheet" type="text/css" href="http://fonts.googleapis.com/css?family=Roboto:900,400,400italic,700,700italic,300,300italic|Open+Sans:300italic,400italic,700italic,300,400,600,700" />
Cristyce4a3552015-12-14 13:53:35 -050032 <link rel="stylesheet" href="css/magick.css"/>
cristyad41c0c2012-10-31 00:49:28 +000033</head>
cristyd2432012015-05-04 23:15:15 +000034<body>
cristyad41c0c2012-10-31 00:49:28 +000035<div class="main">
cristyd2432012015-05-04 23:15:15 +000036<div class="magick-masthead">
37 <div class="container">
Cristy6549abb2016-11-10 08:25:55 -050038 <script async="async" src="http://localhost/pagead/js/adsbygoogle.js"></script> <ins class="adsbygoogle"
Cristy594d2772015-11-15 10:47:42 -050039 style="display:block"
40 data-ad-client="ca-pub-3129977114552745"
41 data-ad-slot="6345125851"
42 data-ad-format="auto"></ins>
cristy29f2c972015-07-28 13:37:46 +000043 <script>
Cristy542697a2015-10-12 20:10:32 -040044 (adsbygoogle = window.adsbygoogle || []).push({});
cristyd2432012015-05-04 23:15:15 +000045 </script>
cristyd2432012015-05-04 23:15:15 +000046 <nav class="magick-nav">
cristy44443b92015-05-05 00:06:07 +000047 <a class="magick-nav-item " href="../index.html">Home</a>
Cristy9017f3a2017-01-21 10:51:11 -050048 <a class="magick-nav-item " href="download.html">Download</a>
cristyd2432012015-05-04 23:15:15 +000049 <a class="magick-nav-item " href="command-line-tools.html">Tools</a>
Cristye93be682015-11-26 09:07:51 -050050 <a class="magick-nav-item " href="command-line-processing.html">Command-line</a>
cristyea2793e2015-05-31 16:52:26 +000051 <a class="magick-nav-item " href="resources.html">Resources</a>
Cristy9017f3a2017-01-21 10:51:11 -050052 <a class="magick-nav-item " href="develop.html">Develop</a>
Cristy6549abb2016-11-10 08:25:55 -050053 <a class="magick-nav-item " href="https://www.imagemagick.org/script/search.php">Search</a>
54 <a class="magick-nav-item pull-right" href="https://www.imagemagick.org/discourse-server/">Community</a>
cristyd2432012015-05-04 23:15:15 +000055 </nav>
56 </div>
57</div>
58<div class="container">
Cristy882d9f42015-10-29 16:48:39 -040059<div class="magick-header">
Cristyd474b372017-02-14 12:19:13 -050060<p class="text-center"><a href="command-line-options.html#adaptive-blur">&#x2011;adaptive&#x2011;blur</a><a href="command-line-options.html#adaptive-resize">&#x2011;adaptive&#x2011;resize</a><a href="command-line-options.html#adaptive-sharpen">&#x2011;adaptive&#x2011;sharpen</a><a href="command-line-options.html#adjoin">&#x2011;adjoin</a><a href="command-line-options.html#affine">&#x2011;affine</a><a href="command-line-options.html#alpha">&#x2011;alpha</a><a href="command-line-options.html#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#channel-fx">&#x2011;channel&#x2011;fx</a><a href="command-line-options.html#chop">&#x2011;chop</a><a href="command-line-options.html#clamp">&#x2011;clamp</a><a href="command-line-options.html#clip">&#x2011;clip</a><a href="command-line-options.html#clip-mask">&#x2011;clip&#x2011;mask</a><a href="command-line-options.html#clip-path">&#x2011;clip&#x2011;path</a><a href="command-line-options.html#clone">&#x2011;clone</a><a href="command-line-options.html#clut">&#x2011;clut</a><a href="command-line-options.html#coalesce">&#x2011;coalesce</a><a href="command-line-options.html#colorize">&#x2011;colorize</a><a href="command-line-options.html#colormap">&#x2011;colormap</a><a href="command-line-options.html#color-matrix">&#x2011;color&#x2011;matrix</a><a href="command-line-options.html#colors">&#x2011;colors</a><a href="command-line-options.html#colorspace">&#x2011;colorspace</a><a href="command-line-options.html#combine">&#x2011;combine</a><a href="command-line-options.html#comment">&#x2011;comment</a><a href="command-line-options.html#compare">&#x2011;compare</a><a href="command-line-options.html#complex">&#x2011;complex</a><a href="command-line-options.html#compose">&#x2011;compose</a><a href="command-line-options.html#composite">&#x2011;composite</a><a href="command-line-options.html#compress">&#x2011;compress</a><a href="command-line-options.html#connected-components">&#x2011;connected&#x2011;components</a><a href="command-line-options.html#contrast">&#x2011;contrast</a><a href="command-line-options.html#contrast-stretch">&#x2011;contrast&#x2011;stretch</a><a href="command-line-options.html#convolve">&#x2011;convolve</a><a href="command-line-options.html#copy">&#x2011;copy</a><a href="command-line-options.html#crop">&#x2011;crop</a><a href="command-line-options.html#cycle">&#x2011;cycle</a><a href="command-line-options.html#debug">&#x2011;debug</a><a href="command-line-options.html#decipher">&#x2011;decipher</a><a href="command-line-options.html#deconstruct">&#x2011;deconstruct</a><a href="command-line-options.html#define">&#x2011;define</a><a href="command-line-options.html#delay">&#x2011;delay</a><a href="command-line-options.html#delete">&#x2011;delete</a><a href="command-line-options.html#density">&#x2011;density</a><a href="command-line-options.html#depth">&#x2011;depth</a><a href="command-line-options.html#descend">&#x2011;descend</a><a href="command-line-options.html#deskew">&#x2011;deskew</a><a href="command-line-options.html#despeckle">&#x2011;despeckle</a><a href="command-line-options.html#direction">&#x2011;direction</a><a href="command-line-options.html#displace">&#x2011;displace</a><a href="command-line-options.html#display">&#x2011;display</a><a href="command-line-options.html#dispose">&#x2011;dispose</a><a href="command-line-options.html#dissimilarity-threshold">&#x2011;dissimilarity&#x2011;threshold</a><a href="command-line-options.html#dissolve">&#x2011;dissolve</a><a href="command-line-options.html#distort">&#x2011;distort</a><a href="command-line-options.html#distribute-cache">&#x2011;distribute&#x2011;cache</a><a href="command-line-options.html#dither">&#x2011;dither</a><a href="command-line-options.html#draw">&#x2011;draw</a><a href="command-line-options.html#duplicate">&#x2011;duplicate</a><a href="command-line-options.html#edge">&#x2011;edge</a><a href="command-line-options.html#emboss">&#x2011;emboss</a><a href="command-line-options.html#encipher">&#x2011;encipher</a><a href="command-line-options.html#encoding">&#x2011;encoding</a><a href="command-line-options.html#endian">&#x2011;endian</a><a href="command-line-options.html#enhance">&#x2011;enhance</a><a href="command-line-options.html#equalize">&#x2011;equalize</a><a href="command-line-options.html#evaluate">&#x2011;evaluate</a><a href="command-line-options.html#evaluate-sequence">&#x2011;evaluate&#x2011;sequence</a><a href="command-line-options.html#extent">&#x2011;extent</a><a href="command-line-options.html#extract">&#x2011;extract</a><a href="command-line-options.html#family">&#x2011;family</a><a href="command-line-options.html#features">&#x2011;features</a><a href="command-line-options.html#fft">&#x2011;fft</a><a href="command-line-options.html#fill">&#x2011;fill</a><a href="command-line-options.html#filter">&#x2011;filter</a><a href="command-line-options.html#flatten">&#x2011;flatten</a><a href="command-line-options.html#flip">&#x2011;flip</a><a href="command-line-options.html#floodfill">&#x2011;floodfill</a><a href="command-line-options.html#flop">&#x2011;flop</a><a href="command-line-options.html#font">&#x2011;font</a><a href="command-line-options.html#foreground">&#x2011;foreground</a><a href="command-line-options.html#format">&#x2011;format</a><a href="command-line-options.html#format_identify_">&#x2011;format[identify]</a><a href="command-line-options.html#frame">&#x2011;frame</a><a href="command-line-options.html#frame_import_">&#x2011;frame[import]</a><a href="command-line-options.html#function">&#x2011;function</a><a href="command-line-options.html#fuzz">&#x2011;fuzz</a><a href="command-line-options.html#fx">&#x2011;fx</a><a href="command-line-options.html#gamma">&#x2011;gamma</a><a href="command-line-options.html#gaussian-blur">&#x2011;gaussian&#x2011;blur</a><a href="command-line-options.html#geometry">&#x2011;geometry</a><a href="command-line-options.html#gravity">&#x2011;gravity</a><a href="command-line-options.html#grayscale">&#x2011;grayscale</a><a href="command-line-options.html#green-primary">&#x2011;green&#x2011;primary</a><a href="command-line-options.html#hald-clut">&#x2011;hald&#x2011;clut</a><a href="command-line-options.html#help">&#x2011;help</a><a href="command-line-options.html#highlight-color">&#x2011;highlight&#x2011;color</a><a href="command-line-options.html#hough-lines">&#x2011;hough&#x2011;lines</a><a href="command-line-options.html#iconGeometry">&#x2011;iconGeometry</a><a href="command-line-options.html#iconic">&#x2011;iconic</a><a href="command-line-options.html#identify">&#x2011;identify</a><a href="command-line-options.html#ift">&#x2011;ift</a><a href="command-line-options.html#immutable">&#x2011;immutable</a><a href="command-line-options.html#implode">&#x2011;implode</a><a href="command-line-options.html#insert">&#x2011;insert</a><a href="command-line-options.html#intensity">&#x2011;intensity</a><a href="command-line-options.html#intent">&#x2011;intent</a><a href="command-line-options.html#interlace">&#x2011;interlace</a><a href="command-line-options.html#interpolate">&#x2011;interpolate</a><a href="command-line-options.html#interline-spacing">&#x2011;interline&#x2011;spacing</a><a href="command-line-options.html#interword-spacing">&#x2011;interword&#x2011;spacing</a><a href="command-line-options.html#kerning">&#x2011;kerning</a><a href="command-line-options.html#kuwahara">&#x2011;kuwahara</a><a href="command-line-options.html#label">&#x2011;label</a><a href="command-line-options.html#lat">&#x2011;lat</a><a href="command-line-options.html#layers">&#x2011;layers</a><a href="command-line-options.html#level">&#x2011;level</a><a href="command-line-options.html#level-colors">&#x2011;level&#x2011;colors</a><a href="command-line-options.html#limit">&#x2011;limit</a><a href="command-line-options.html#linear-stretch">&#x2011;linear&#x2011;stretch</a><a href="command-line-options.html#linewidth">&#x2011;linewidth</a><a href="command-line-options.html#liquid-rescale">&#x2011;liquid&#x2011;rescale</a><a href="command-line-options.html#list">&#x2011;list</a><a href="command-line-options.html#log">&#x2011;log</a><a href="command-line-options.html#loop">&#x2011;loop</a><a href="command-line-options.html#lowlight-color">&#x2011;lowlight&#x2011;color</a><a href="command-line-options.html#magnify">&#x2011;magnify</a><a href="command-line-options.html#map">&#x2011;map</a><a href="command-line-options.html#map_stream_">&#x2011;map[stream]</a><a href="command-line-options.html#mattecolor">&#x2011;mattecolor</a><a href="command-line-options.html#median">&#x2011;median</a><a href="command-line-options.html#mean-shift">&#x2011;mean&#x2011;shift</a><a href="command-line-options.html#metric">&#x2011;metric</a><a href="command-line-options.html#mode">&#x2011;mode</a><a href="command-line-options.html#modulate">&#x2011;modulate</a><a href="command-line-options.html#moments">&#x2011;moments</a><a href="command-line-options.html#monitor">&#x2011;monitor</a><a href="command-line-options.html#monochrome">&#x2011;monochrome</a><a href="command-line-options.html#morph">&#x2011;morph</a><a href="command-line-options.html#morphology">&#x2011;morphology</a><a href="command-line-options.html#mosaic">&#x2011;mosaic</a><a href="command-line-options.html#motion-blur">&#x2011;motion&#x2011;blur</a><a href="command-line-options.html#name">&#x2011;name</a><a href="command-line-options.html#negate">&#x2011;negate</a><a href="command-line-options.html#noise">&#x2011;noise</a><a href="command-line-options.html#normalize">&#x2011;normalize</a><a href="command-line-options.html#opaque">&#x2011;opaque</a><a href="command-line-options.html#ordered-dither">&#x2011;ordered&#x2011;dither</a><a href="command-line-options.html#orient">&#x2011;orient</a><a href="command-line-options.html#page">&#x2011;page</a><a href="command-line-options.html#paint">&#x2011;paint</a><a href="command-line-options.html#path">&#x2011;path</a><a href="command-line-options.html#pause_animate_">&#x2011;pause[animate]</a><a href="command-line-options.html#pause_import_">&#x2011;pause[import]</a><a href="command-line-options.html#perceptible">&#x2011;perceptible</a><a href="command-line-options.html#ping">&#x2011;ping</a><a href="command-line-options.html#pointsize">&#x2011;pointsize</a><a href="command-line-options.html#polaroid">&#x2011;polaroid</a><a href="command-line-options.html#poly">&#x2011;poly</a><a href="command-line-options.html#posterize">&#x2011;posterize</a><a href="command-line-options.html#precision">&#x2011;precision</a><a href="command-line-options.html#preview">&#x2011;preview</a><a href="command-line-options.html#print">&#x2011;print</a><a href="command-line-options.html#process">&#x2011;process</a><a href="command-line-options.html#profile">&#x2011;profile</a><a href="command-line-options.html#quality">&#x2011;quality</a><a href="command-line-options.html#quantize">&#x2011;quantize</a><a href="command-line-options.html#quiet">&#x2011;quiet</a><a href="command-line-options.html#radial-blur">&#x2011;radial&#x2011;blur</a><a href="command-line-options.html#raise">&#x2011;raise</a><a href="command-line-options.html#random-threshold">&#x2011;random&#x2011;threshold</a><a href="command-line-options.html#read-mask">&#x2011;read&#x2011;mask</a><a href="command-line-options.html#red-primary">&#x2011;red&#x2011;primary</a><a href="command-line-options.html#regard-warnings">&#x2011;regard&#x2011;warnings</a><a href="command-line-options.html#region">&#x2011;region</a><a href="command-line-options.html#remap">&#x2011;remap</a><a href="command-line-options.html#remote">&#x2011;remote</a><a href="command-line-options.html#render">&#x2011;render</a><a href="command-line-options.html#repage">&#x2011;repage</a><a href="command-line-options.html#resample">&#x2011;resample</a><a href="command-line-options.html#resize">&#x2011;resize</a><a href="command-line-options.html#respect-parentheses">&#x2011;respect&#x2011;parentheses</a><a href="command-line-options.html#reverse">&#x2011;reverse</a><a href="command-line-options.html#roll">&#x2011;roll</a><a href="command-line-options.html#rotate">&#x2011;rotate</a><a href="command-line-options.html#sample">&#x2011;sample</a><a href="command-line-options.html#sampling-factor">&#x2011;sampling&#x2011;factor</a><a href="command-line-options.html#scale">&#x2011;scale</a><a href="command-line-options.html#scene">&#x2011;scene</a><a href="command-line-options.html#screen">&#x2011;screen</a><a href="command-line-options.html#seed">&#x2011;seed</a><a href="command-line-options.html#segment">&#x2011;segment</a><a href="command-line-options.html#selective-blur">&#x2011;selective&#x2011;blur</a><a href="command-line-options.html#separate">&#x2011;separate</a><a href="command-line-options.html#sepia-tone">&#x2011;sepia&#x2011;tone</a><a href="command-line-options.html#set">&#x2011;set</a><a href="command-line-options.html#shade">&#x2011;shade</a><a href="command-line-options.html#shadow">&#x2011;shadow</a><a href="command-line-options.html#shared-memory">&#x2011;shared&#x2011;memory</a><a href="command-line-options.html#sharpen">&#x2011;sharpen</a><a href="command-line-options.html#shave">&#x2011;shave</a><a href="command-line-options.html#shear">&#x2011;shear</a><a href="command-line-options.html#sigmoidal-contrast">&#x2011;sigmoidal&#x2011;contrast</a><a href="command-line-options.html#silent">&#x2011;silent</a><a href="command-line-options.html#similarity-threshold">&#x2011;similarity&#x2011;threshold</a><a href="command-line-options.html#size">&#x2011;size</a><a href="command-line-options.html#sketch">&#x2011;sketch</a><a href="command-line-options.html#smush">&#x2011;smush</a><a href="command-line-options.html#snaps">&#x2011;snaps</a><a href="command-line-options.html#solarize">&#x2011;solarize</a><a href="command-line-options.html#sparse-color">&#x2011;sparse&#x2011;color</a><a href="command-line-options.html#splice">&#x2011;splice</a><a href="command-line-options.html#spread">&#x2011;spread</a><a href="command-line-options.html#statistic">&#x2011;statistic</a><a href="command-line-options.html#stegano">&#x2011;stegano</a><a href="command-line-options.html#stereo">&#x2011;stereo</a><a href="command-line-options.html#storage-type">&#x2011;storage&#x2011;type</a><a href="command-line-options.html#stretch">&#x2011;stretch</a><a href="command-line-options.html#strip">&#x2011;strip</a><a href="command-line-options.html#stroke">&#x2011;stroke</a><a href="command-line-options.html#strokewidth">&#x2011;strokewidth</a><a href="command-line-options.html#style">&#x2011;style</a><a href="command-line-options.html#subimage-search">&#x2011;subimage&#x2011;search</a><a href="command-line-options.html#swap">&#x2011;swap</a><a href="command-line-options.html#swirl">&#x2011;swirl</a><a href="command-line-options.html#synchronize">&#x2011;synchronize</a><a href="command-line-options.html#taint">&#x2011;taint</a><a href="command-line-options.html#text-font">&#x2011;text&#x2011;font</a><a href="command-line-options.html#texture">&#x2011;texture</a><a href="command-line-options.html#threshold">&#x2011;threshold</a><a href="command-line-options.html#thumbnail">&#x2011;thumbnail</a><a href="command-line-options.html#tile">&#x2011;tile</a><a href="command-line-options.html#tile-offset">&#x2011;tile&#x2011;offset</a><a href="command-line-options.html#tint">&#x2011;tint</a><a href="command-line-options.html#title">&#x2011;title</a><a href="command-line-options.html#transform">&#x2011;transform</a><a href="command-line-options.html#transparent">&#x2011;transparent</a><a href="command-line-options.html#transparent-color">&#x2011;transparent&#x2011;color</a><a href="command-line-options.html#transpose">&#x2011;transpose</a><a href="command-line-options.html#transverse">&#x2011;transverse</a><a href="command-line-options.html#treedepth">&#x2011;treedepth</a><a href="command-line-options.html#trim">&#x2011;trim</a><a href="command-line-options.html#type">&#x2011;type</a><a href="command-line-options.html#undercolor">&#x2011;undercolor</a><a href="command-line-options.html#unique-colors">&#x2011;unique&#x2011;colors</a><a href="command-line-options.html#units">&#x2011;units</a><a href="command-line-options.html#unsharp">&#x2011;unsharp</a><a href="command-line-options.html#update">&#x2011;update</a><a href="command-line-options.html#verbose">&#x2011;verbose</a><a href="command-line-options.html#version">&#x2011;version</a><a href="command-line-options.html#view">&#x2011;view</a><a href="command-line-options.html#vignette">&#x2011;vignette</a><a href="command-line-options.html#virtual-pixel">&#x2011;virtual&#x2011;pixel</a><a href="command-line-options.html#visual">&#x2011;visual</a><a href="command-line-options.html#watermark">&#x2011;watermark</a><a href="command-line-options.html#wave">&#x2011;wave</a><a href="command-line-options.html#wavelet-denoise">&#x2011;wavelet&#x2011;denoise</a><a href="command-line-options.html#weight">&#x2011;weight</a><a href="command-line-options.html#white-point">&#x2011;white&#x2011;point</a><a href="command-line-options.html#white-threshold">&#x2011;white&#x2011;threshold</a><a href="command-line-options.html#window">&#x2011;window</a><a href="command-line-options.html#window-group">&#x2011;window&#x2011;group</a><a href="command-line-options.html#write">&#x2011;write</a><a href="command-line-options.html#write-mask">&#x2011;write&#x2011;mask</a> </p>
Cristy882d9f42015-10-29 16:48:39 -040061<p class="lead magick-description">Below is list of command-line options recognized by the ImageMagick <a href="command-line-tools.html">command-line tools</a>. If you want a description of a particular option, click on the option name in the navigation bar above and you will go right to it. Unless otherwise noted, each option is recognized by the commands: <a href="convert.html">convert</a> and <a href="mogrify.html">mogrify</a>.</p>
62
63<div style="margin: auto;">
64 <h3 class="magick-header"><a id="adaptive-blur"></a>-adaptive-blur <var>radius</var>[x<var>sigma</var>]</h3>
65</div>
66
67<p class="magick-description">Adaptively blur pixels, with decreasing effect near edges.</p>
68
69<p>A Gaussian operator of the given radius and standard deviation (<var>sigma</var>) is used. If <var>sigma</var> is not given it
70defaults to 1.</p>
71
72<div style="margin: auto;">
73 <h3 class="magick-header"><a id="adaptive-resize"></a>-adaptive-resize <var>geometry</var></h3>
74</div>
75
76<p class="magick-description">Resize the image using data-dependent triangulation.</p>
77
78<p>See <a href="command-line-processing.html#geometry">Image Geometry</a> for complete details about the <em class="arg">geometry</em> argument. The <a href="command-line-options.html#adaptive-resize">-adaptive-resize</a>
Cristy594d2772015-11-15 10:47:42 -050079option defaults to data-dependent triangulation. Use the <a
80href="command-line-options.html#filter">-filter</a> to choose a different resampling algorithm.
81Offsets, if present in the geometry string, are ignored, and the <a
82href="command-line-options.html#gravity">-gravity</a> option has no effect.</p>
Cristy882d9f42015-10-29 16:48:39 -040083
84<div style="margin: auto;">
85 <h3 class="magick-header"><a id="adaptive-sharpen"></a>-adaptive-sharpen <var>radius</var>[x<var>sigma</var>]</h3>
86</div>
87
88<p class="magick-description">Adaptively sharpen pixels, with increasing effect near edges.</p>
89
90<p>A Gaussian operator of the given radius and standard deviation
91(<var>sigma</var>) is used. If <var>sigma</var> is not given it
92defaults to 1.</p>
93
94<div style="margin: auto;">
95 <h3 class="magick-header"><a id="adjoin"></a>-adjoin</h3>
96</div>
97
98<p class="magick-description">Join images into a single multi-image file.</p>
99
100<p>This option is enabled by default. An attempt is made to save all images of
101an image sequence into the given output file. However, some formats, such as
102JPEG and PNG, do not support more than one image per file, and in that case
103ImageMagick is forced to write each image as a separate file. As such, if
104more than one image needs to be written, the filename given is modified by
105adding a <a href="command-line-options.html#scene">-scene</a> number before the suffix, in order to
106make distinct names for each image. </p>
107
108<p>Use <a href="command-line-options.html#adjoin">+adjoin</a> to force each image to be written to
109separate files, whether or not the file format allows multiple images per file
110(for example, GIF, MIFF, and TIFF). </p>
111
112<p>Including a C-style integer format string in the output filename will
113automagically enable <a href="command-line-options.html#adjoin">+adjoin</a> and are used to specify
114where the <a href="command-line-options.html#scene">-scene</a> number is placed in the filenames. These
115strings, such as '<code>%d</code>' or '<code>%03d</code>', are familiar to those
116who have used the standard <code>printf()</code>' C-library function. As an
117example, the command</p>
118
119<pre>
120convert logo: rose: -morph 15 my%02dmorph.jpg
121</pre>
122
123<p>will create a sequence of 17 images (the two given plus 15 more created by
124<a href="command-line-options.html#morph">-morph</a>), named: my00morph.jpg, my01morph.jpg,
125my02morph.jpg, ..., my16morph.jpg. </p>
126
127<p>In summary, ImageMagick tries to write all images to one file, but will
128save to multiple files, if any of the following conditions exist...</p>
129<ol>
130<li>the output image's file format does not allow multi-image files,</li>
131<li>the <a href="command-line-options.html#adjoin">+adjoin</a> option is given, or</li>
132<li>a printf() integer format string (eg: "%d") is present in the output
133 filename.</li>
134</ol>
135
136
137<div style="margin: auto;">
138 <h3 class="magick-header"><a id="affine"></a>-affine
139 <var>s<sub>x</sub></var>,<var>r<sub>x</sub></var>,<var>r<sub>y</sub></var>,<var>s<sub>y</sub></var>[,<var>t<sub>x</sub></var>,<var>t<sub>y</sub></var>]</h3>
140</div>
141
142<p class="magick-description">Set the drawing transformation matrix for combined rotating and scaling.</p>
143
Cristy594d2772015-11-15 10:47:42 -0500144<p>This option sets a transformation matrix, for use by subsequent <a
145href="command-line-options.html#draw">-draw</a> or <a href="command-line-options.html#transform">-transform</a> options. </p>
Cristy882d9f42015-10-29 16:48:39 -0400146
147<p>The matrix entries are entered as comma-separated numeric values either in
148quotes or without spaces. </p>
149
150<p>Internally, the transformation matrix has 3x3 elements, but three of them
151are omitted from the input because they are constant. The new (transformed)
152coordinates (<var>x'</var>, <var>y'</var>) of a pixel at
153position (<var>x</var>, <var>y</var>) in the original
154image are calculated using the following matrix equation.</p>
155
Cristy594d2772015-11-15 10:47:42 -0500156<p class="text-center"><img class="img-thumbnail" alt="affine transformation" src="../images/affine.png"/> </p>
Cristy882d9f42015-10-29 16:48:39 -0400157
158<p> The size of the resulting image is that of the smallest rectangle that
159contains the transformed source image. The parameters
160<var>t<sub>x</sub></var> and <var>t<sub>y</sub></var>
161subsequently shift the image pixels so that those that are moved out of the
162image area are cut off.</p>
163
164<p>The transformation matrix complies with the left-handed pixel coordinate
165system: positive <var>x</var> and <var>y</var> directions
166are rightward and downward, resp.; positive rotation is clockwise.</p>
167
168<p> If the translation coefficients <var>t<sub>x</sub></var> and
169<var>t<sub>y</sub></var> are omitted they default to 0,0. Therefore,
170four parameters suffice for rotation and scaling without translation.</p>
171
172<p>Scaling by the factors <var>s<sub>x</sub></var> and
173<var>s<sub>y</sub></var> in the <var>x</var> and <var>y</var> directions,
174respectively, is accomplished with the following.</p>
175
Cristy594d2772015-11-15 10:47:42 -0500176<p>See <a href="command-line-options.html#transform">-transform</a>, and the <a
177href="command-line-options.html#distort">-distort</a> method '<code>Affineprojection</code> for more
Cristy882d9f42015-10-29 16:48:39 -0400178information </p>
179
180
181<pre>
182-affine <var>s<sub>x</sub></var>,0,0,<var>s<sub>y</sub></var>
183</pre>
184
185<p>Translation by a displacement (<var>t<sub>x</sub></var>, <var>t<sub>y</sub></var>) is accomplished like so:</p>
186
187<pre>
188-affine 1,0,0,1,<var>t<sub>x</sub></var>,<var>t<sub>y</sub></var>
189</pre>
190
191<p>Rotate clockwise about the origin (the upper left-hand corner) by an angle
192<var>a</var> by letting <var>c</var> = cos(<var>a</var>), <var>s</var>
193= sin(<var>a</var>), and using the following.</p>
194
195<pre>
196-affine <var>c</var>,<var>s</var>,-<var>s</var>,<var>c</var>
197</pre>
198
Cristy594d2772015-11-15 10:47:42 -0500199<p>The cumulative effect of a sequence of <a href="command-line-options.html#affine" >-affine</a>
200transformations can be accomplished by instead by a single <a href="command-line-options.html#affine"
201>-affine</a> operation using the matrix equal to the product of the matrices
Cristy882d9f42015-10-29 16:48:39 -0400202of the individual transformations.</p>
203
204<p>An attempt is made to detect near-singular transformation matrices. If the
205matrix determinant has a sufficiently small absolute value it is rejected.</p>
206
207<div style="margin: auto;">
208 <h3 class="magick-header"><a id="alpha"></a>-alpha <var>type</var></h3>
209</div>
210
211<p class="magick-description">Gives control of the alpha/matte channel of an image.</p>
212
213<p>Used to set a flag on an image indicating whether or not to use existing alpha
214channel data, to create an alpha channel, or to perform other operations on the alpha channel. Choose the argument <var>type</var> from the list below.</p>
215
216<dl class="dl-horizontal">
217 <dt>Activate</dt>
218 <dd>
219 Enable the image's transparency channel. Note normally Set
220 should be used instead of this, unless you specifically need to
221 preserve existing (but specifically turned Off) transparency
222 channel. </dd>
223
224 <dt>Associate</dt>
225 <dd>
226 associate the alpha channel with the image.</dd>
227
228 <dt>Deactivate</dt>
229 <dd>
230 Disables the image's transparency channel. Does not delete or change the
231 existing data, just turns off the use of that data.</dd>
232
233 <dt>Disassociate</dt>
234 <dd>
235 disassociate the alpha channel from the image.</dd>
236
237 <dt>Set</dt>
238 <dd>
239 Activates the alpha/matte channel. If it was previously turned off
240 then it also resets the channel to opaque. If the image already had
241 the alpha channel turned on, it will have no effect.</dd>
242
243 <dt>Opaque</dt>
244 <dd>
245 Enables the alpha/matte channel and forces it to be fully opaque.
246 </dd>
247
248 <dt>Transparent</dt>
249 <dd>
250 Activates the alpha/matte channel and forces it to be fully
251 transparent. This effectively creates a fully transparent image the
252 same size as the original and with all its original RGB data still
253 intact, but fully transparent. </dd>
254
255 <dt>Extract</dt>
256 <dd>
257 Copies the alpha channel values into all the color channels and turns
258 'Off' the the image's transparency, so as to generate
Cristy769d8892016-01-19 18:11:14 -0500259 a grayscale mask of the image's shape. The alpha channel data is left
Cristy882d9f42015-10-29 16:48:39 -0400260 intact just deactivated. This is the inverse of 'Copy'.
261 </dd>
262
263 <dt>Copy</dt>
264 <dd>
265 Turns 'On' the alpha/matte channel, then copies the
Cristy769d8892016-01-19 18:11:14 -0500266 grayscale intensity of the image, into the alpha channel, converting
267 a grayscale mask into a transparent shaped mask ready to be colored
Cristy882d9f42015-10-29 16:48:39 -0400268 appropriately. The color channels are not modified. </dd>
269
270 <dt>Shape</dt>
271 <dd>
272 As per 'Copy' but also colors the resulting shape mask with
273 the current background color. That is the RGB color channels is
274 replaced, with appropriate alpha shape.
275 </dd>
276
277 <dt>Remove</dt>
278 <dd>
279 Composite the image over the background color.
280 </dd>
281
282 <dt>Background</dt>
283 <dd>
284 Set any fully-transparent pixel to the background color, while leaving
285 it fully-transparent. This can make some image file formats, such as
286 PNG, smaller as the RGB values of transparent pixels are more uniform,
287 and thus can compress better.
288 </dd>
289</dl>
290
291<p>Note that while the obsolete <code>+matte</code> operation was the
Cristy594d2772015-11-15 10:47:42 -0500292same as "<code><a href="command-line-options.html#alpha" >-alpha</a> Off</code>", the <code>
293>-matte</code> operation was the same as "<code><a href="command-line-options.html#alpha" >-alpha</a>
294Set</code>" and not "<code><a href="command-line-options.html#alpha" >-alpha</a> On</code>". </p>
Cristy882d9f42015-10-29 16:48:39 -0400295
Cristyf650f4f2016-04-01 10:53:07 -0400296<div style="margin: auto;">
297 <h3 class="magick-header"><a id="alpha-color"></a>-alpha-color <var>color</var></h3>
298</div>
299
300<p class="magick-description">Specify the color to be used with the <a href="command-line-options.html#frame">-frame</a> option.</p>
301
302<p>The color is specified using the format described under the <a href="command-line-options.html#fill">-fill</a> option.</p>
303
304<p>The default matte color is <code>#BDBDBD</code>, <span
305style="background-color: #bdbdbd;">this shade of gray</span>.</p>
306
307<p>This is an IMv7 option, use <a href="command-line-options.html#mattecolor">mattecolor</a> with IMv6.</p>
308
Cristy882d9f42015-10-29 16:48:39 -0400309
310<div style="margin: auto;">
311 <h3 class="magick-header"><a id="annotate"></a>
Cristy594d2772015-11-15 10:47:42 -0500312 -annotate <var>degrees</var> <var>text</var><br />
313 -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 -0400314</div>
315
316<p class="magick-description">Annotate an image with text</p>
317
318<p>This is a convenience for annotating an image with text. For more precise
319control over text annotations, use <a href="command-line-options.html#draw">-draw</a>.</p>
320
321
322<p>The values <var>Xdegrees</var> and <var>Ydegrees</var>
Cristy594d2772015-11-15 10:47:42 -0500323control 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 -0400324
325<p>Using <a href="command-line-options.html#annotate">-annotate</a> <var>degrees</var>
326or <a href="command-line-options.html#annotate">-annotate</a> <var>degrees</var>x<var>degrees</var> produces an unsheared rotation of the text. The
327direction of the rotation is positive, which means a clockwise rotation if <var>degrees</var> is positive. (This conforms to the usual mathematical
328convention once it is realized that the positive <var>y</var>–direction is
329conventionally considered to be <var>downward</var> for images.)</p>
330
331<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
332equation.</p>
333
Cristy594d2772015-11-15 10:47:42 -0500334<p class="text-center"><img class="img-thumbnail" alt="annotate transformation" src="../images/annotate.png"/></p>
Cristy882d9f42015-10-29 16:48:39 -0400335
336<p>If <var>t<sub>x</sub></var> and <var>t<sub>y</sub></var> are omitted, they default to 0. This makes the
337bottom-left of the text becomes the upper-left corner of the image, which is
Cristy594d2772015-11-15 10:47:42 -0500338probably undesirable. Adding a <a href="command-line-options.html#gravity" >-gravity</a> option in this
Cristy882d9f42015-10-29 16:48:39 -0400339case leads to nice results.</p>
340
341<p>Text is any UTF-8 encoded character sequence. If <var>text</var>
342is of the form '@mytext.txt', the text is read from the file
343<code>mytext.txt</code>. Text in a file is taken literally; no embedded
344formatting characters are recognized.</p>
345
346<div style="margin: auto;">
347 <h3 class="magick-header"><a id="antialias"></a>-antialias</h3>
348</div>
349
350<p class="magick-description">Enable/Disable of the rendering of anti-aliasing pixels when drawing fonts and lines.</p>
351
352<p>By default, objects (e.g. text, lines, polygons, etc.) are antialiased when
353drawn. Use <a href="command-line-options.html#antialias">+antialias</a> to disable the addition of
354antialiasing edge pixels. This will then reduce the number of colors added to
355an image to just the colors being directly drawn. That is, no mixed colors
356are added when drawing such objects. </p>
357
358<div style="margin: auto;">
359 <h3 class="magick-header"><a id="append"></a>-append</h3>
360</div>
361
362<p class="magick-description">Join current images vertically or horizontally.</p>
363
364<p>This option creates a single longer image, by joining all the current
365images in sequence top-to-bottom. Use <a href="command-line-options.html#append">+append</a> to
366stack images left-to-right. </p>
367
368<p>If they are not of the same width, narrower images are padded with the
369current <a href="command-line-options.html#background">-background</a> color setting, and their
Cristy594d2772015-11-15 10:47:42 -0500370position relative to each other can be controlled by the current <a
371href="command-line-options.html#gravity">-gravity</a> setting. </p>
Cristy882d9f42015-10-29 16:48:39 -0400372
373
374<div style="margin: auto;">
375 <h3 class="magick-header"><a id="attenuate"></a>-attenuate <var>value</var></h3>
376</div>
377
378<p class="magick-description">Lessen (or intensify) when adding noise to an image.</p>
379
380<p>If unset the value is equivalent to 1.0, or a maximum noise addition</p>
381
382<div style="margin: auto;">
383 <h3 class="magick-header"><a id="authenticate"></a>-authenticate <var>password</var></h3>
384</div>
385
386<p class="magick-description">Decrypt a PDF with a password.</p>
387
388<p>Use this option to supply a <var>password</var> for decrypting
389a PDF that has been encrypted using Microsoft Crypto API (MSC API). The
390encrypting using the MSC API is not supported.</p>
391
392<p>For a different encryption method, see <a href="command-line-options.html#encipher">-encipher</a>
393and <a href="command-line-options.html#decipher">-decipher</a>. </p>
394
395
396<div style="margin: auto;">
397 <h3 class="magick-header"><a id="auto-gamma"></a>-auto-gamma</h3>
398</div>
399
400<p class="magick-description">Automagically adjust gamma level of image.</p>
401
Cristy594d2772015-11-15 10:47:42 -0500402<p>This calculates the mean values of an image, then applies a calculated <a
403href="command-line-options.html#gamma" >-gamma</a> adjustment so that is the mean color exists in the
Cristy882d9f42015-10-29 16:48:39 -0400404image it will get a have a value of 50%. </p>
405
406<p>This means that any solid 'gray' image becomes 50% gray. </p>
407
408<p>This works well for real-life images with little or no extreme dark and
409light areas, but tend to fail for images with large amounts of bright sky or
410dark shadows. It also does not work well for diagrams or cartoon like images.
411</p>
412
Cristy594d2772015-11-15 10:47:42 -0500413<p>It uses the <a href="command-line-options.html#channel" >-channel</a> setting, (including the
Cristy882d9f42015-10-29 16:48:39 -0400414'<var>sync</var>' flag for channel synchronization), to determine which color
Cristy594d2772015-11-15 10:47:42 -0500415values is used and modified. As the default <a href="command-line-options.html#channel"
416>-channel</a> setting is '<var>RGB,sync</var>', channels are modified
Cristy882d9f42015-10-29 16:48:39 -0400417together by the same gamma value, preserving colors. </p>
418
419
420
421<div style="margin: auto;">
422 <h3 class="magick-header"><a id="auto-level"></a>-auto-level</h3>
423</div>
424
425<p class="magick-description">Automagically adjust color levels of image.</p>
426
427<p>This is a 'perfect' image normalization operator. It finds the exact
Cristy594d2772015-11-15 10:47:42 -0500428minimum and maximum color values in the image and then applies a <a
429href="command-line-options.html#level" >-level</a> operator to stretch the values to the full range of
Cristy882d9f42015-10-29 16:48:39 -0400430values. </p>
431
432<p>The operator is not typically used for real-life images, image scans, or
433JPEG format images, as a single 'out-rider' pixel can set a bad min/max values
Cristy594d2772015-11-15 10:47:42 -0500434for the <a href="command-line-options.html#level" >-level</a> operation. On the other hand it is the
Cristy882d9f42015-10-29 16:48:39 -0400435right operator to use for color stretching gradient images being used to
436generate Color lookup tables, distortion maps, or other 'mathematically'
437defined images. </p>
438
Cristy594d2772015-11-15 10:47:42 -0500439<p>The operator is very similar to the <a href="command-line-options.html#normalize">-normalize</a>, <a
440href="command-line-options.html#contrast-stretch" >-contrast-stretch</a>, and <a href="command-line-options.html#linear-stretch"
441>-linear-stretch</a> operators, but without 'histogram binning' or 'clipping'
442problems that these operators may have. That is <a href="command-line-options.html#auto-level"
443>-auto-level</a> is the perfect or ideal version these operators. </p>
Cristy882d9f42015-10-29 16:48:39 -0400444
Cristy594d2772015-11-15 10:47:42 -0500445<p>It uses the <a href="command-line-options.html#channel" >-channel</a> setting, (including the
Cristy882d9f42015-10-29 16:48:39 -0400446special '<var>sync</var>' flag for channel synchronization), to determine
Cristy594d2772015-11-15 10:47:42 -0500447which color values are used and modified. As the default <a
448href="command-line-options.html#channel" >+channel</a> setting is '<var>RGB,sync</var>', the
Cristy882d9f42015-10-29 16:48:39 -0400449'<var>sync</var>' ensures that the color channels will are modified
450together by the same gamma value, preserving colors, and ignoring
451transparency. </p>
452
453
454<div style="margin: auto;">
455 <h3 class="magick-header"><a id="auto-orient"></a>-auto-orient</h3>
456</div>
457
458<p class="magick-description">adjusts an image so that its orientation is suitable for viewing (i.e. top-left orientation).</p>
459
460<p>This operator reads and resets the EXIF image profile setting 'Orientation'
461and then performs the appropriate 90 degree rotation on the image to orient
462the image, for correct viewing. </p>
463
464<p>This EXIF profile setting is usually set using a gravity sensor in digital
465camera, however photos taken directly downward or upward may not have an
466appropriate value. Also images that have been orientation 'corrected' without
467reseting this setting, may be 'corrected' again resulting in a incorrect
Cristy594d2772015-11-15 10:47:42 -0500468result. If the EXIF profile was previously stripped, the <a
469href="command-line-options.html#auto-orient" >-auto-orient</a> operator will do nothing. </p>
Cristy882d9f42015-10-29 16:48:39 -0400470
471
472<div style="margin: auto;">
473 <h3 class="magick-header"><a id="average"></a>-average</h3>
474</div>
475
476<p class="magick-description">Average a set of images.</p>
477
478<p>An error results if the images are not identically sized.</p>
479
480
481<div style="margin: auto;">
482 <h3 class="magick-header"><a id="backdrop"></a>-backdrop</h3>
483</div>
484
485<p class="magick-description">Display the image centered on a backdrop.</p>
486
487<p>This backdrop covers the entire workstation screen and is useful for hiding
488other X window activity while viewing the image. The color of the backdrop is
489specified as the background color. The color is specified using the format
490described under the <a href="command-line-options.html#fill">-fill</a> option.</p>
491
492<div style="margin: auto;">
493 <h3 class="magick-header"><a id="background"></a>-background <var>color</var></h3>
494</div>
495
496<p class="magick-description">Set the background color.</p>
497
Cristy594d2772015-11-15 10:47:42 -0500498<p>The color is specified using the format described under the <a
499href="command-line-options.html#fill">-fill</a> option. The default background color (if none is
Cristy882d9f42015-10-29 16:48:39 -0400500specified or found in the image) is white.</p>
501
502<div style="margin: auto;">
503 <h3 class="magick-header"><a id="bench"></a>-bench <var>iterations</var></h3>
504</div>
505
506<p class="magick-description">Measure performance.</p>
507
508<p>Repeat the entire command for the given number of <var>iterations</var> and report the user-time and elapsed time. For instance,
509consider the following command and its output. Modify the benchmark with the
510-duration to run the benchmark for a fixed number of seconds and -concurrent
511to run the benchmark in parallel (requires the OpenMP feature).</p>
512
513<pre>
Cristye09ed312016-03-06 08:07:39 -0500514-> convert logo: -resize 200% -bench 5 logo.png
515Performance[1]: 5i 1.344ips 1.000e 3.710u 0:03.720
516Performance[2]: 5i 1.634ips 0.549e 3.890u 0:03.060
517Performance[3]: 5i 2.174ips 0.618e 3.190u 0:02.300
518Performance[4]: 5i 1.678ips 0.555e 3.810u 0:02.980
Cristy882d9f42015-10-29 16:48:39 -0400519Performance[4]: 5i 0.875657ips 6.880u 0:05.710
520</pre>
521
Cristye09ed312016-03-06 08:07:39 -0500522<p>In this example, 5 iterations were completed at 2.174 iterations per
523second, using 3 threads and 3.190 seconds of the user allotted time, for
524a total elapsed time of 2.300 seconds.</p>
Cristy882d9f42015-10-29 16:48:39 -0400525
526<div style="margin: auto;">
527 <h3 class="magick-header"><a id="bias"></a>-bias <var>value</var>{<var>%</var>}</h3>
528</div>
529
530<p class="magick-description">Add bias when convolving an image.</p>
531
Cristy594d2772015-11-15 10:47:42 -0500532<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 -0400533positive and negative results are relative to the specified bias value. </p>
534
535<p>This is important for non-HDRI compilations of ImageMagick when dealing
536with convolutions that contain negative as well as positive values. This is
537especially the case with convolutions involving high pass filters or edge
538detection. Without an output bias, the negative values are clipped at
539zero.</p>
540
Cristy594d2772015-11-15 10:47:42 -0500541<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 -0400542negative results without clipping to the color value range
543(0..QuantumRange).</p>
544
Cristy594d2772015-11-15 10:47:42 -0500545<p>See the discussion on HDRI implementations of ImageMagick on the page <a
546href="high-dynamic-range.html" >High Dynamic-Range Images</a>. For more
547about HDRI go the ImageMagick <a
Cristy364a72f2016-11-04 22:38:41 -0400548href="https://www.imagemagick.org/Usage/basics/#hdri" >Usage</a> pages or this
Cristy594d2772015-11-15 10:47:42 -0500549<a
550href="http://en.wikipedia.org/wiki/High_dynamic_range_imaging">Wikipedia</a>
Cristy882d9f42015-10-29 16:48:39 -0400551entry. </p>
552
553<div style="margin: auto;">
554 <h3 class="magick-header"><a id="black-point-compensation"></a>-black-point-compensation</h3>
555</div>
556
557<p class="magick-description">Use black point compensation.</p>
558
559<div style="margin: auto;">
560 <h3 class="magick-header"><a id="black-threshold"></a>-black-threshold <var>value</var>{<var>%</var>}</h3>
561</div>
562
563<p class="magick-description">Force to black all pixels below the threshold while leaving all pixels at or above the threshold unchanged.</p>
564
565<p> The threshold value can be given as a percentage or as an absolute integer
566value within [0, <var>QuantumRange</var>] corresponding to the
Cristy594d2772015-11-15 10:47:42 -0500567desired <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 -0400568
569
570<div style="margin: auto;">
571 <h3 class="magick-header"><a id="blend"></a>-blend <var>geometry</var></h3>
572</div>
573
574<p class="magick-description">blend an image into another by the given absolute value or percent.</p>
575
576<p>Blend will average the images together ('plus') according to the
577percentages given and each pixels transparency. If only a single percentage
578value is given it sets the weight of the composite or 'source' image, while
579the background image is weighted by the exact opposite amount. That is a
580<code>-blend 30%</code> merges 30% of the 'source' image with 70% of the
581'destination' image. Thus it is equivalent to <code>-blend 30x70%</code>.</p>
582
583
584<div style="margin: auto;">
585 <h3 class="magick-header"><a id="blue-primary"></a>-blue-primary <var>x</var>,<var>y</var></h3>
586</div>
587
588<p class="magick-description">Set the blue chromaticity primary point.</p>
589
590<div style="margin: auto;">
591 <h3 class="magick-header"><a id="blue-shift"></a>-blue-shift <var>factor</var></h3>
592</div>
593
594<p class="magick-description">simulate a scene at nighttime in the moonlight. Start with a factor of 1.5</p>
595
596<div style="margin: auto;">
597
598<div style="margin: auto;">
Cristy594d2772015-11-15 10:47:42 -0500599 <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 -0400600</div>
601
602<p class="magick-description">Reduce image noise and reduce detail levels.</p>
603
604<p>Convolve the image with a Gaussian or normal distribution using the given
Cristy594d2772015-11-15 10:47:42 -0500605<var >Sigma</var> value. The formula is:</p>
Cristy882d9f42015-10-29 16:48:39 -0400606
Cristy594d2772015-11-15 10:47:42 -0500607<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 -0400608
Cristy594d2772015-11-15 10:47:42 -0500609<p>The <var >Sigma</var> value is the important argument, and
Cristy882d9f42015-10-29 16:48:39 -0400610determines the actual amount of blurring that will take place. </p>
611
Cristy594d2772015-11-15 10:47:42 -0500612<p>The <var >Radius</var> is only used to determine the size of the
Cristy882d9f42015-10-29 16:48:39 -0400613array which will hold the calculated Gaussian distribution. It should be an
614integer. If not given, or set to zero, IM will calculate the largest possible
615radius that will provide meaningful results for the Gaussian distribution.
616</p>
617
Cristy594d2772015-11-15 10:47:42 -0500618<p>The larger the <var >Radius</var> the slower the
619operation is. However too small a <var >Radius</var>, and sever
620aliasing effects may result. As a guideline, <var >Radius</var>
621should be at least twice the <var >Sigma</var> value, though three
Cristy882d9f42015-10-29 16:48:39 -0400622times will produce a more accurate result. </p>
623
624<p>This option differs from <a href="command-line-options.html#gaussian-blur">-gaussian-blur</a> simply
625by taking advantage of the separability properties of the distribution. Here
626we apply a single-dimensional Gaussian matrix in the horizontal direction,
627then repeat the process in the vertical direction.</p>
628
629<p>The <a href="command-line-options.html#virtual-pixel">-virtual-pixel</a> setting will determine how
630pixels which are outside the image proper are blurred into the final result.
631</p>
632
633
634<div style="margin: auto;">
Cristy882d9f42015-10-29 16:48:39 -0400635 <h3 class="magick-header"><a id="border"></a>-border <var>geometry</var></h3>
636</div>
637
638<p class="magick-description">Surround the image with a border of color. </p>
639
640<p>Set the width and height using the <var>size</var> portion of the
641<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
642ignored. </p>
643
644<p>As of IM 6.7.8-8, the <var>geometry</var> arguments behave as follows:</p>
645
646<dl class="dl-horizontal">
647<dt><var>value</var></dt>
648<dd>value is added to both left/right and top/bottom</dd>
649<dt><var>value-x</var><kbd>x</kbd></dt>
650<dd>value-x is added only to left/right and top/bottom are unchanged</dd>
651<dt><kbd>x</kbd><var>value-y</var></dt>
652<dd>value-y is added only to top/bottom and left/right are unchanged</dd>
653<dt><var>value-x</var><kbd>x</kbd><var>value-y</var></dt>
654<dd>value-x is added to left/right and value-y added to top/bottom</dd>
655<dt><var>value-x</var><kbd>x</kbd>0</dt>
656<dd>value-x is added only to left/right and top/bottom are unchanged</dd>
657<dt>0<kbd>x</kbd><var>value-y</var></dt>
658<dd>value-y is added only to top/bottom and left/right are unchanged</dd>
659<dt><var>value</var>%</dt>
660<dd>value % of width is added to left/right and value % of height is added to top/bottom</dd>
661<dt><var>value-x</var><kbd>x</kbd>%</dt>
662<dd>value-x % of width is added to left/right and to top/bottom</dd>
663<dt>x<var>value-y</var>%</dt>
664<dd>value-y % of height is added to top/bottom and to left/right</dd>
665<dt><var>value-x</var>%<kbd>x</kbd><var>value-y</var>%</dt>
666<dd>value-x % of width is added to left/right and value-y % of height is added to top/bottom</dd>
667<dt><var>value-x</var>%<kbd>x</kbd>0%</dt>
668<dd>value-x % of width is added to left/right and top/bottom are unchanged</dd>
669<dt>0%<kbd>x</kbd><var>value-y</var>%</dt>
670<dd>value-y % of height is added to top/bottom and left/right are unchanged</dd>
671</dl>
672
Cristy594d2772015-11-15 10:47:42 -0500673<p>Set the border color by preceding with the <a
674href="command-line-options.html#bordercolor">-bordercolor</a> setting.</p>
Cristy882d9f42015-10-29 16:48:39 -0400675
Cristy594d2772015-11-15 10:47:42 -0500676<p>The <a href="command-line-options.html#border">-border</a> operation is affected by the current <a
677href="command-line-options.html#compose">-compose</a> setting and assumes that this is using the default
Cristy882d9f42015-10-29 16:48:39 -0400678'<code>Over</code>' composition method. It generates an image of the appropriate
679size colors by the current <a href="command-line-options.html#bordercolor">-bordercolor</a> before
680overlaying the original image in the center of this net image. This means that
681with the default compose method of '<code>Over</code>' any transparent parts may
682be replaced by the current <a href="command-line-options.html#bordercolor">-bordercolor</a> setting.</p>
683<p>See also the <a href="command-line-options.html#frame">-frame</a> option, which has more
684functionality.</p>
685
686<div style="margin: auto;">
687 <h3 class="magick-header"><a id="bordercolor"></a>-bordercolor <var>color</var></h3>
688</div>
689
690<p class="magick-description">Set the border color.</p>
691
692<p>The color is specified using the format described under the <a href="command-line-options.html#fill">-fill</a> option.</p>
693
694<p>The default border color is <code>#DFDFDF</code>, <span style="background-color: #dfdfdf;">this shade of gray</span>.</p>
695
696<div style="margin: auto;">
697 <h3 class="magick-header"><a id="borderwidth"></a>-borderwidth <var>geometry</var> </h3>
698</div>
699
700<p class="magick-description">Set the border width.</p>
701
702<div style="margin: auto;">
Cristy769d8892016-01-19 18:11:14 -0500703 <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 -0400704</div>
705
706<p class="magick-description">Adjust the brightness and/or contrast of the image.</p>
707
708<p>Brightness and Contrast values apply changes to the input image. They are
709not absolute settings. A brightness or contrast value of zero means no change.
710The range of values is -100 to +100 on each. Positive values increase the
711brightness or contrast and negative values decrease the brightness or contrast.
712To control only contrast, set the brightness=0. To control only brightness,
713set contrast=0 or just leave it off.</p>
714
715<p>You may also use <a href="command-line-options.html#fill">-channel</a> to control which channels to
716apply the brightness and/or contrast change. The default is to apply the same
717transformation to all channels.</p>
718
719<p>Brightness and Contrast arguments are converted to offset and slope of a
720linear transform and applied
721using <a href="command-line-options.html#fill">-function polynomial "slope,offset"</a>.</p>
722
723<p>The slope varies from 0 at contrast=-100 to almost vertical at
724contrast=+100. For brightness=0 and contrast=-100, the result are totally
725midgray. For brightness=0 and contrast=+100, the result will approach but
726not quite reach a threshold at midgray; that is the linear transformation
727is a very steep vertical line at mid gray.</p>
728
729<p>Negative slopes, i.e. negating the image, are not possible with this
730function. All achievable slopes are zero or positive.</p>
731
732<p>The offset varies from -0.5 at brightness=-100 to 0 at brightness=0 to +0.5
733at brightness=+100. Thus, when contrast=0 and brightness=100, the result is
734totally white. Similarly, when contrast=0 and brightness=-100, the result is
735totally black.</p>
736
737<p>As the range of values for the arguments are -100 to +100, adding the '%'
738symbol is no different than leaving it off.</p>
739
740<div style="margin: auto;">
741 <h3 class="magick-header"><a id="cache"></a>-cache <var>threshold</var></h3>
742</div>
743
Cristy594d2772015-11-15 10:47:42 -0500744<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 -0400745
746<div style="margin: auto;">
Cristy594d2772015-11-15 10:47:42 -0500747 <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 -0400748</div>
749
750<p class="magick-description">Canny edge detector uses a multi-stage algorithm to detect a wide range of edges in the image.</p>
751
752<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>
753
754<div style="margin: auto;">
755 <h3 class="magick-header"><a id="caption"></a>-caption <var>string</var></h3>
756</div>
757
758<p class="magick-description">Assign a caption to an image.</p>
759
760<p>This option sets the caption meta-data of an image read in after this
761option has been given. To modify a caption of images already in memory use
762"<code><a href="command-line-options.html#set">-set</a> caption</code>". </p>
763
Cristy594d2772015-11-15 10:47:42 -0500764<p>The caption can contain special format characters listed in the <a
765href="escape.html">Format and
Cristy882d9f42015-10-29 16:48:39 -0400766Print Image Properties</a>. These attributes are expanded when the caption
767is finally assigned to the individual images. </p>
768
769<p>If the first character of <var>string</var> is <var>@</var>, the image caption is read from a file titled by the
770remaining characters in the string. Comments read in from a file are literal;
771no embedded formatting characters are recognized.</p>
772
773<p>Caption meta-data is not visible on the image itself. To do that use the
774<a href="command-line-options.html#annotate">-annotate</a> or <a href="command-line-options.html#draw">-draw</a> options
775instead.</p>
776
777<p>For example,</p>
778
779<pre>
780-caption "%m:%f %wx%h" bird.miff
781</pre>
782
783<p>produces an image caption of <code>MIFF:bird.miff 512x480</code> (assuming
784that the image <code>bird.miff</code> has a width of 512 and a height of
785480.</p>
786
787
788<div style="margin: auto;">
789 <h3 class="magick-header"><a id="cdl"></a>-cdl <var>filename</var></h3>
790</div>
791
792<p class="magick-description">color correct with a color decision list.</p>
793
794<p>Here is an example color correction collection:</p>
795
796<pre>
797&lt;?xml version="1.0" encoding="UTF-8"?&gt;
798&lt;ColorCorrectionCollection xmlns="urn:ASC:CDL:v1.2"&gt;
799 &lt;ColorCorrection id="cc06668"&gt;
800 &lt;SOPNode&gt;
801 &lt;Slope&gt; 0.9 1.2 0.5 &lt;/Slope&gt;
802 &lt;Offset&gt; 0.4 -0.5 0.6 &lt;/Offset&gt;
803 &lt;Power&gt; 1.0 0.8 1.5 &lt;/Power&gt;
804 &lt;/SOPNode&gt;
805 &lt;SATNode&gt;
806 &lt;Saturation&gt; 0.85 &lt;/Saturation&gt;
807 &lt;/SATNode&gt;
808 &lt;/ColorCorrection&gt;
809&lt;/ColorCorrectionCollection&gt;
810</pre>
811
812<div style="margin: auto;">
813 <h3 class="magick-header"><a id="channel"></a>-channel <var>type</var></h3>
814</div>
815
816<p class="magick-description">Specify those image color channels to which subsequent operators are limited.</p>
817
818<p>Choose from: <code>Red</code>, <code>Green</code>, <code>Blue</code>,
819<code>Alpha</code>, <code>Gray</code>, <code>Cyan</code>, <code>Magenta</code>,
820<code>Yellow</code>, <code>Black</code>, <code>Opacity</code>,
821<code>Index</code>, <code>RGB</code>, <code>RGBA</code>, <code>CMYK</code>, or
822<code>CMYKA</code>.</p>
823
824<p>The channels above can also be specified as a comma-separated list or can be
825abbreviated as a concatenation of the letters '<code>R</code>', '<code>G</code>',
826'<code>B</code>', '<code>A</code>', '<code>O</code>', '<code>C</code>',
827'<code>M</code>', '<code>Y</code>', '<code>K</code>'.
828
829For example, to only select the <code>Red</code> and <code>Blue</code> channels
830you can either use </p>
831<pre>
832-channel Red,Blue
833</pre>
834<p>or you can use the short hand form</p>
835<pre>
836-channel RB
837</pre>
838
839<p>All the channels that are present in an image can be specified using the
840special channel type <code>All</code>. Not all operators are 'channel capable',
841but generally any operators that are generally 'grey-scale' image operators,
842will understand this setting. See individual operator documentation. </p>
843
Cristy594d2772015-11-15 10:47:42 -0500844<br/>
Cristy882d9f42015-10-29 16:48:39 -0400845
846<p>On top of the normal channel selection an extra flag can be specified,
847'<code>Sync</code>'. This is turned on by default and if set means that
848operators that understand this flag should perform: cross-channel
849synchronization of the channels. If not specified, then most grey-scale
850operators will apply their image processing operations to each individual
851channel (as specified by the rest of the <a href="command-line-options.html#channel">-channel</a>
852setting) completely independently from each other. </p>
853
854<p>For example for operators such as <a href="command-line-options.html#auto-level">-auto-level</a> and
855<a href="command-line-options.html#auto-gamma">-auto-gamma</a> the color channels are modified
856together in exactly the same way so that colors will remain in-sync. Without
857it being set, then each channel is modified separately and
858independently, which may produce color distortion. </p>
859
860<p>The <a href="command-line-options.html#morphology">-morphology</a> '<code>Convolve</code>' method
861and the <a href="command-line-options.html#compose">-compose</a> mathematical methods, also understands
862the '<code>Sync</code>' flag to modify the behavior of pixel colors according
863to the alpha channel (if present). That is to say it will modify the image
864processing with the understanding that fully-transparent colors should not
865contribute to the final result. </p>
866
867<p>Basically, by default, operators work with color channels in synchronous, and
868treats transparency as special, unless the <a href="command-line-options.html#channel">-channel</a>
869setting is modified so as to remove the effect of the '<code>Sync</code>' flag.
870How each operator does this depends on that operators current implementation.
871Not all operators understands this flag at this time, but that is changing.
872</p>
873
874<p>To print a complete list of channel types, use <a href="command-line-options.html#list">-list
875channel</a>.</p>
876
877<p>By default, ImageMagick sets <a href="command-line-options.html#channel">-channel</a> to the value
878'<code>RGBK,sync</code>', which specifies that operators act on all color
879channels except the transparency channel, and that all the color channels are
880to be modified in exactly the same way, with an understanding of transparency
Cristy594d2772015-11-15 10:47:42 -0500881(depending on the operation being applied). The 'plus' form <a
882href="command-line-options.html#channel" >+channel</a> will reset the value back to this default. </p>
Cristy882d9f42015-10-29 16:48:39 -0400883
Cristy594d2772015-11-15 10:47:42 -0500884<p>Options that are affected by the <a href="command-line-options.html#channel" >-channel</a> setting
Cristy882d9f42015-10-29 16:48:39 -0400885include the following.
886
887<a href="command-line-options.html#auto-gamma">-auto-gamma</a>,
888<a href="command-line-options.html#auto-level">-auto-level</a>,
889<a href="command-line-options.html#black-threshold">-black-threshold</a>,
890<a href="command-line-options.html#blur">-blur</a>,
891<a href="command-line-options.html#clamp">-clamp</a>,
892<a href="command-line-options.html#clut">-clut</a>,
893<a href="command-line-options.html#combine">-combine</a>,
894<a href="command-line-options.html#composite">-composite</a> (Mathematical compose methods only),
895<a href="command-line-options.html#convolve">-convolve</a>,
896<a href="command-line-options.html#contrast-stretch">-contrast-stretch</a>,
897<a href="command-line-options.html#evaluate">-evaluate</a>,
898<a href="command-line-options.html#function">-function</a>,
899<a href="command-line-options.html#fx">-fx</a>,
900<a href="command-line-options.html#gaussian-blur">-gaussian-blur</a>,
901<a href="command-line-options.html#hald-clut">-hald-clut</a>,
902<a href="command-line-options.html#motion-blur">-motion-blur</a>,
903<a href="command-line-options.html#morphology">-morphology</a>,
904<a href="command-line-options.html#negate">-negate</a>,
905<a href="command-line-options.html#normalize">-normalize</a>,
906<a href="command-line-options.html#ordered-dither">-ordered-dither</a>,
907<a href="command-line-options.html#radial-blur">-radial-blur</a>,
908<a href="command-line-options.html#random-threshold">-random-threshold</a>,
909<a href="command-line-options.html#separate">-separate</a>,
910<a href="command-line-options.html#threshold">-threshold</a>, and
911<a href="command-line-options.html#white-threshold">-white-threshold</a>.
912</p>
913
Cristy594d2772015-11-15 10:47:42 -0500914<p>Warning, some operators behave differently when the <a href="command-line-options.html#channel"
915>+channel</a> default setting is in effect, verses ANY user defined <a
916href="command-line-options.html#channel" >-channel</a> setting (including the equivalent of the
Cristy882d9f42015-10-29 16:48:39 -0400917default). These operators have yet to be made to understand the newer 'Sync'
918flag. </p>
919
Cristy769d8892016-01-19 18:11:14 -0500920<p>For example <a href="command-line-options.html#threshold">-threshold</a> will by default grayscale
Cristy594d2772015-11-15 10:47:42 -0500921the image before thresholding, if no <a href="command-line-options.html#channel" >-channel</a> setting
Cristy882d9f42015-10-29 16:48:39 -0400922has been defined. This is not 'Sync flag controlled, yet. </p>
923
Cristy594d2772015-11-15 10:47:42 -0500924<p>Also some operators such as <a href="command-line-options.html#blur">-blur</a>, <a
925href="command-line-options.html#gaussian-blur">-gaussian-blur</a>, will modify their handling of the
926color channels if the '<code>alpha</code>' channel is also enabled by <a
927href="command-line-options.html#channel" >-channel</a>. Generally this done to ensure that
Cristy882d9f42015-10-29 16:48:39 -0400928fully-transparent colors are treated as being fully-transparent, and thus any
929underlying 'hidden' color has no effect on the final results. Typically
930resulting in 'halo' effects. The newer <a href="command-line-options.html#morphology">-morphology</a>
931convolution equivalents however does have a understanding of the 'Sync' flag
932and will thus handle transparency correctly by default. </p>
933
934<p>As a alpha channel is optional within images, some operators will read the
935color channels of an image as a greyscale alpha mask, when the image has no
Cristy594d2772015-11-15 10:47:42 -0500936alpha channel present, and the <a href="command-line-options.html#channel" >-channel</a> setting tells
937the operator to apply the operation using alpha channels. The <a
938href="command-line-options.html#clut">-clut</a> operator is a good example of this. </p>
Cristy882d9f42015-10-29 16:48:39 -0400939
Cristyd474b372017-02-14 12:19:13 -0500940<div style="margin: auto;">
941 <h3 class="magick-header"><a id="channel-fx"></a>-channel-fx <var>expression</var></h3>
942</div>
Cristy882d9f42015-10-29 16:48:39 -0400943
Cristyd474b372017-02-14 12:19:13 -0500944<p class="magick-description">exchange, extract, or copy one or more image channels.</p>
945
946<p>The expression consists of one or more channels, either mnemonic or numeric (e.g. red or 0, green or 1, etc.), separated by certain operation symbols as follows:</p>
947
948<pre>
949&lt;=&gt; exchange two channels (e.g. red&lt;=&gt;blue)
950=&gt; copy one channel to another channel (e.g. red=&gt;green)
951= assign a constant value to a channel (e.g. red=50%)
952, write new image with channels in the specified order (e.g. red, green)
953; add a new output image for the next set of channel operations (e.g. red; green; blue)
954| move to the next input image for the source of channel data (e.g. | gray=>alpha)
955</pre>
956
957<p>For example, to create 3 grayscale images from the red, green, and blue channels of an image, use:</p>
958
959<pre>
960-channel-fx "red; green; blue"
961</pre>
962
963<p>A channel without an operation symbol implies separate (i.e, semicolon).</p>
964
965<p>Here we take an sRGB image and a grayscale image and inject the grayscale image into the alpha channel:</p>
966<pre>
967convert wizard.png mask.pgm -channel-fx '| gray=>alpha' wizard-alpha.png
968</pre>
969<p>Use a similar command to define a read mask:</p>
970<pre>
971convert wizard.png mask.pgm -channel-fx '| gray=>read-mask' wizard-mask.png
972</pre>
973
974<p>Add <code>-debug pixel</code> prior to the <code>-channel-fx</code> option to track the channel morphology.</p>
Cristy882d9f42015-10-29 16:48:39 -0400975
976<div style="margin: auto;">
977 <h3 class="magick-header"><a id="charcoal"></a>-charcoal <var>factor</var></h3>
978</div>
979
980<p class="magick-description">Simulate a charcoal drawing.</p>
981
Cristyd474b372017-02-14 12:19:13 -0500982
Cristy882d9f42015-10-29 16:48:39 -0400983<div style="margin: auto;">
984 <h3 class="magick-header"><a id="chop"></a>-chop <var>geometry</var></h3>
985</div>
986
987<p class="magick-description">Remove pixels from the interior of an image.</p>
988
989<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>
990and <var>height</var> given in the of the <var>size</var>
991portion of the <var>geometry</var> argument give the number of
992columns and rows to remove. The <var>offset</var> portion of
993the <var>geometry</var> argument is influenced by
994a <a href="command-line-options.html#gravity">-gravity</a> setting, if present.</p>
995
996<p>The <a href="command-line-options.html#chop">-chop</a> option removes entire rows and columns,
997and moves the remaining corner blocks leftward and upward to close the gaps.</p>
998
999<p>While it can remove internal rows and columns of pixels, it is more
1000typically used with as <a href="command-line-options.html#gravity">-gravity</a> setting and zero
Cristy594d2772015-11-15 10:47:42 -05001001offsets so as to remove a single edge from an image. Compare this to <a
1002href="command-line-options.html#shave" >-shave</a> which removes equal numbers of pixels from opposite
Cristy882d9f42015-10-29 16:48:39 -04001003sides of the image. </p>
1004
Cristy594d2772015-11-15 10:47:42 -05001005<p>Using <a href="command-line-options.html#chop">-chop</a> effectively undoes the results of a <a
1006href="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 -04001007
1008<div style="margin: auto;">
1009 <h3 class="magick-header"><a id="clamp"></a>-clamp</h3>
1010</div>
1011
1012<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>
1013
1014<div style="margin: auto;">
1015 <h3 class="magick-header"><a id="clip"></a>-clip</h3>
1016</div>
1017
1018<p class="magick-description">Apply the clipping path if one is present.</p>
1019
1020<p>If a clipping path is present, it is applied to subsequent operations.</p>
1021
1022<p>For example, in the command</p>
1023
1024<pre>
1025convert cockatoo.tif -clip -negate negated.tif
1026</pre>
1027
1028<p>only the pixels within the clipping path are negated.</p>
1029
1030<p>The <a href="command-line-options.html#clip">-clip</a> feature requires SVG support. If the SVG
1031delegate library is not present, the option is ignored.</p>
1032
1033<p>Use <a href="command-line-options.html#clip">+clip</a> to disable clipping for subsequent operations.</p>
1034
1035<div style="margin: auto;">
1036 <h3 class="magick-header"><a id="clip-mask"></a>-clip-mask</h3>
1037</div>
1038
1039<p class="magick-description">Clip the image as defined by this mask.</p>
1040
1041<p>Use the alpha channel of the current image as a mask. Any areas that is
1042white is not modified by any of the 'image processing operators' that follow,
1043until the mask is removed. Pixels in the black areas of the clip mask are
1044modified per the requirements of the operator. </p>
1045
1046<p>In some ways this is similar to (though not the same) as defining
Cristy594d2772015-11-15 10:47:42 -05001047a rectangular <a href="command-line-options.html#region" >-region</a>, or using the negative of the
1048mask (third) image in a three image <a href="command-line-options.html#composite" >-composite</a>,
Cristy882d9f42015-10-29 16:48:39 -04001049operation. </p>
1050
1051<p>Use <a href="command-line-options.html#clip-mask">+clip-mask</a> to disable clipping for subsequent operations.</p>
1052
1053<div style="margin: auto;">
1054 <h3 class="magick-header"><a id="clip-path"></a>-clip-path <var>id</var></h3>
1055</div>
1056
1057<p class="magick-description">Clip along a named path from the 8BIM profile.</p>
1058
1059<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>
1060
1061<p>Use <a href="command-line-options.html#clip-path">+clip-path</a> to disable clipping for subsequent operations.</p>
1062
1063<div style="margin: auto;">
1064 <h3 class="magick-header"><a id="clone"></a>-clone <var>index(s)</var></h3>
1065</div>
1066
1067<p class="magick-description">make a clone of an image (or images).</p>
1068
1069<p>Inside parenthesis (where the operator is normally used) it will make a
1070clone of the images from the last 'pushed' image sequence, and adds them to
1071the end of the current image sequence. Outside parenthesis
1072(not recommended) it clones the images from the current image sequence. </p>
1073
1074<p>Specify the image by its index in the sequence. The first image is index
10750. Negative indexes are relative to the end of the sequence; for
1076example, <code>−1</code>
1077represents the last image of the sequence. Specify a range of images with a
1078dash (e.g. <code>0−4</code>). Separate multiple indexes with commas but no
1079spaces (e.g. <code>0,2,5</code>). A value of '<code>0−−1</code> will
1080effectively clone all the images. </p>
1081
1082<p>The <a href="command-line-options.html#clone">+clone</a> will simply make a copy of the last image
1083in the image sequence, and is thus equivalent to using a argument of
1084'<code>−1</code>'. </p>
1085
1086<div style="margin: auto;">
1087 <h3 class="magick-header"><a id="clut"></a>-clut</h3>
1088</div>
1089
1090<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>
1091
1092<p>The second (LUT) image is ordinarily a gradient image containing the
1093histogram mapping of how each channel should be modified. Typically it is a
1094either a single row or column image of replacement color values. If larger
1095than a single row or column, values are taken from a diagonal line from
1096top-left to bottom-right corners.</p>
1097
Cristy594d2772015-11-15 10:47:42 -05001098<p>The lookup is further controlled by the <a
1099href="command-line-options.html#interpolate">-interpolate</a> setting, which is especially handy for an
Cristy882d9f42015-10-29 16:48:39 -04001100LUT which is not the full length needed by the ImageMagick installed Quality
1101(Q) level. Good settings for this are the '<code>bilinear</code>' and
1102'<code>bicubic</code>' interpolation settings, which give smooth color
1103gradients, and the '<code>integer</code>' setting for a direct, unsmoothed
1104lookup of color values. </p>
1105
1106<p>This operator is especially suited to replacing a grayscale image with a
1107specific color gradient from the CLUT image. </p>
1108
1109<p>Only the channel values defined by the <a href="command-line-options.html#channel">-channel</a>
Cristy594d2772015-11-15 10:47:42 -05001110setting will have their values replaced. In particular, since the default <a
1111href="command-line-options.html#channel">-channel</a> setting is <code>RGB</code>, this means that
1112transparency (alpha/matte channel) is not affected, unless the <a
1113href="command-line-options.html#channel">-channel</a> setting is modified. When the alpha channel is
1114set, 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 -04001115as the other channels, implying that alpha/matte values are replaced using the
1116alpha/matte values of the original image. </p>
1117
1118<p>If either the image being modified, or the lookup image, contains no
Cristy594d2772015-11-15 10:47:42 -05001119transparency (i.e. <a href="command-line-options.html#alpha" >-alpha</a> is turned 'off') but the <a
1120href="command-line-options.html#channel">-channel</a> setting includes alpha replacement, then it is
Cristy769d8892016-01-19 18:11:14 -05001121assumed that image represents a grayscale gradient which is used for the
1122replacement alpha values. That is you can use a grayscale CLUT image to
1123adjust a existing images alpha channel, or you can color a grayscale image
Cristy882d9f42015-10-29 16:48:39 -04001124using colors form CLUT containing the desired colors, including transparency.
1125</p>
1126
Cristy594d2772015-11-15 10:47:42 -05001127<p>See also <a href="command-line-options.html#hald-clut" >-hald-clut</a> which replaces colors
Cristy882d9f42015-10-29 16:48:39 -04001128according to the lookup of the full color RGB value from a 2D representation
1129of a 3D color cube. </p>
1130
1131
1132<div style="margin: auto;">
1133 <h3 class="magick-header"><a id="coalesce"></a>-coalesce</h3>
1134</div>
1135
1136<p class="magick-description">Fully define the look of each frame of an GIF animation sequence, to form a 'film strip' animation.</p>
1137
1138<p>Overlay each image in an image sequence according to
1139its <a href="command-line-options.html#dispose">-dispose</a> meta-data, to reproduce the look of
1140an animation at each point in the animation sequence. All images should be
1141the same size, and are assigned appropriate GIF disposal settings for the
1142animation to continue working as expected as a GIF animation. Such frames
1143are more easily viewed and processed than the highly optimized GIF overlay
1144images. </p>
1145
1146<p>The animation can be re-optimized after processing using
1147the <a href="command-line-options.html#layers">-layers</a> method '<code>optimize</code>', although
1148there is no guarantee that the restored GIF animation optimization is
1149better than the original. </p>
1150
1151
1152<div style="margin: auto;">
1153 <h3 class="magick-header"><a id="colorize"></a>-colorize <var>value</var></h3>
1154</div>
1155
Cristy594d2772015-11-15 10:47:42 -05001156<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 -04001157
1158<p>Specify the amount of colorization as a percentage. Separate colorization
1159values can be applied to the red, green, and blue channels of the image with
1160a comma-delimited list of colorization
1161values (e.g., <code>-colorize 0,0,50</code>).</p>
1162
1163<div style="margin: auto;">
1164 <h3 class="magick-header"><a id="colormap"></a>-colormap <var>type</var></h3>
1165</div>
1166
1167<p class="magick-description">Define the colormap type.</p>
1168
1169<p>The <var>type</var> can be <code>shared</code> or <code>private</code>.</p>
1170
1171<p>This option only applies when the default X server visual
1172is <code>PseudoColor</code> or <code>GrayScale</code>. Refer
1173to <a href="command-line-options.html#visual">-visual</a> for more details. By default,
1174a shared colormap is allocated. The image shares colors with
1175other X clients. Some image colors could be approximated,
1176therefore your image may look very different than intended.
1177If <code>private</code> is chosen, the image colors appear exactly
1178as they are defined. However, other clients may go <var>technicolor</var>
1179when the image colormap is installed.</p>
1180
1181<div style="margin: auto;">
1182 <h3 class="magick-header"><a id="colors"></a>-colors <var>value</var></h3>
1183</div>
1184
1185<p class="magick-description">Set the preferred number of colors in the image.</p>
1186
1187<p>The actual number of colors in the image may be less than your request,
1188but never more. Note that this a color reduction option. Images with fewer
1189unique colors than specified by <var>value</var> will have any
1190duplicate or unused colors removed. The ordering of an existing color
1191palette may be altered. When converting an image from color to grayscale,
1192it is more efficient to convert the image to the gray colorspace before
1193reducing the number of colors. Refer to
Cristy6549abb2016-11-10 08:25:55 -05001194the <a href="http://www.imagemagick.org/www/quantize.html">
Cristy882d9f42015-10-29 16:48:39 -04001195color reduction algorithm</a> for more details.</p>
1196
1197<div style="margin: auto;">
1198 <h3 class="magick-header"><a id="color-matrix"></a>-color-matrix <var>matrix</var></h3>
1199</div>
1200
1201<p class="magick-description">apply color correction to the image.</p>
1202
1203<p>This option permits saturation changes, hue rotation, luminance to alpha,
1204and various other effects. Although variable-sized transformation matrices
1205can be used, typically one uses a 5x5 matrix for an RGBA image and a 6x6
1206for CMYKA (or RGBA with offsets). The matrix is similar to those used by
1207Adobe Flash except offsets are in column 6 rather than 5 (in support of
1208CMYKA images) and offsets are normalized (divide Flash offset by 255).</p>
1209
1210<p>As an example, to add contrast to an image with offsets, try this command:</p>
1211
1212<pre>
1213convert kittens.jpg -color-matrix \
1214 " 1.5 0.0 0.0 0.0, 0.0, -0.157 \
1215 0.0 1.5 0.0 0.0, 0.0, -0.157 \
1216 0.0 0.0 1.5 0.0, 0.0, -0.157 \
1217 0.0 0.0 0.0 1.0, 0.0, 0.0 \
1218 0.0 0.0 0.0 0.0, 1.0, 0.0 \
1219 0.0 0.0 0.0 0.0, 0.0, 1.0" kittens.png
1220</pre>
1221<div style="margin: auto;">
1222 <h3 class="magick-header"><a id="colorspace"></a>-colorspace <var>value</var></h3>
1223</div>
1224
1225<p class="magick-description">Set the image colorspace.</p>
1226
1227<p>Choices are:</p>
1228
1229<pre>
1230CMY CMYK Gray HCL
1231HCLp HSB HSI HSL
1232HSV HWB Lab LCHab
1233LCHuv LMS Log Luv
1234OHTA Rec601YCbCr Rec709YCbCr RGB
1235scRGB sRGB Transparent xyY
1236XYZ YCbCr YCC YDbDr
Cristyd474b372017-02-14 12:19:13 -05001237YIQ YPbPr YUV Undefined
Cristy882d9f42015-10-29 16:48:39 -04001238</pre>
1239
1240<p>To print a complete list of colorspaces, use <a href="command-line-options.html#list">-list colorspace</a>.</p>
1241
1242<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>
1243
1244<table class="table table-condensed table-striped">
1245 <caption>Conversion of RGB to Other Color Spaces</caption>
1246 <tr><th valign="middle">CMY</th></tr>
1247 <tr><td valign="middle">C=<var>QuantumRange</var>−R</td></tr>
1248 <tr><td valign="middle">M=<var>QuantumRange</var>−G</td></tr>
1249 <tr><td valign="middle">Y=<var>QuantumRange</var>−B</td></tr>
1250 <tr><th valign="middle">CMYK — starts with CMY from above</th></tr>
1251 <tr><td valign="middle">K=min(C,Y,M)</td></tr>
1252 <tr><td valign="middle">C=<var>QuantumRange</var>*(C−K)/(<var>QuantumRange</var>−K)</td></tr>
1253 <tr><td valign="middle">M=<var>QuantumRange</var>*(M−K)/(<var>QuantumRange</var>−K)</td></tr>
1254 <tr><td valign="middle">Y=<var>QuantumRange</var>*(Y−K)/(<var>QuantumRange</var>−K)</td></tr>
1255
1256 <tr><th valign="middle">Gray</th></tr>
1257 <tr><td valign="middle">Gray = 0.298839*R+0.586811*G+0.114350*B</td></tr>
1258
1259 <tr><th valign="middle">HSB — Hue, Saturation, Brightness; like a cone peak downward</th></tr>
1260 <tr><td valign="middle">H=angle around perimeter (0 to 360 deg); H=0 is red; increasing angles toward green</td></tr>
1261 <tr><td valign="middle">S=distance from axis outward</td></tr>
1262 <tr><td valign="middle">B=distance along axis from bottom upward; B=max(R,G,B); <var>intensity-like</var></td></tr>
1263
1264 <tr><th valign="middle">HSL — Hue, Saturation, Lightness; like a double cone end-to-end with peaks at very top and bottom</th></tr>
1265 <tr><td valign="middle">H=angle around perimeter (0 to 360 deg); H=0 is red; increasing angles toward green</td></tr>
1266 <tr><td valign="middle">S=distance from axis outward</td></tr>
1267 <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>
1268
1269 <tr><th valign="middle">HWB — Hue, Whiteness, Blackness</th></tr>
1270 <tr><td valign="middle">Hue (complicated equation)</td></tr>
1271 <tr><td valign="middle">Whiteness (complicated equation)</td></tr>
1272 <tr><td valign="middle">Blackness (complicated equation)</td></tr>
1273
1274 <tr><th valign="middle">LAB</th></tr>
1275 <tr><td valign="middle">L (complicated equation relating X,Y,Z)</td></tr>
1276 <tr><td valign="middle">A (complicated equation relating X,Y,Z)</td></tr>
1277 <tr><td valign="middle">B (complicated equation relating X,Y,Z)</td></tr>
1278
1279 <tr><th valign="middle">LOG</th></tr>
1280 <tr><td valign="middle">I1 (complicated equation involving logarithm of R)</td></tr>
1281 <tr><td valign="middle">I2 (complicated equation involving logarithm of G)</td></tr>
1282 <tr><td valign="middle">I3 (complicated equation involving logarithm of B)</td></tr>
1283
1284 <tr><th valign="middle">OHTA — approximates principal components transformation</th></tr>
1285 <tr><td valign="middle">I1=0.33333*R+0.33334*G+0.33333*B; <var>intensity-like</var></td></tr>
1286 <tr><td valign="middle">I2=(0.50000*R+0.00000*G−0.50000*B)*(<var>QuantumRange</var>+1)/2</td></tr>
1287 <tr><td valign="middle">I3=(−0.25000*R+0.50000*G−0.25000*B)*(<var>QuantumRange</var>+1)/2</td></tr>
1288
1289 <tr><th valign="middle">Rec601Luma</th></tr>
1290 <tr><td valign="middle">Gray = 0.298839*R+0.586811*G+0.114350*B</td></tr>
1291
1292 <tr><th valign="middle">Rec601YCbCr</th></tr>
1293 <tr><td valign="middle">Y=0.2988390*R+0.5868110*G+0.1143500*B; <var>intensity-like</var></td></tr>
1294 <tr><td valign="middle">Cb=(−0.168736*R-0.331264*G+0.500000*B)*(<var>QuantumRange</var>+1)/2</td></tr>
1295 <tr><td valign="middle">Cr=(0.500000*R−0.418688*G−0.081312*B)*(<var>QuantumRange</var>+1)/2</td></tr>
1296
1297 <tr><th valign="middle">Rec709Luma</th></tr>
1298 <tr><td valign="middle">Gray=0.212656*R+0.715158*G+0.072186*B</td></tr>
1299
1300 <tr><th valign="middle">Rec709YCbCr</th></tr>
1301 <tr><td valign="middle">Y=0.212656*R+0.715158*G+0.072186*B; <var>intensity-like</var></td></tr>
1302 <tr><td valign="middle">Cb=(−0.114572*R−0.385428*G+0.500000*B)+(<var>QuantumRange</var>+1)/2</td></tr>
1303 <tr><td valign="middle">Cr=(0.500000*R−0.454153*G−0.045847*B)+(<var>QuantumRange</var>+1)/2</td></tr>
1304
1305 <tr><th valign="middle">sRGB</th></tr>
1306 <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>
1307 <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>
1308 <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>
1309
1310 <tr><th valign="middle">XYZ</th></tr>
1311 <tr><td valign="middle">X=0.4124564*R+0.3575761*G+0.1804375*B</td></tr>
1312 <tr><td valign="middle">Y=0.2126729*R+0.7151522*G+0.0721750*B</td></tr>
1313 <tr><td valign="middle">Z=0.0193339*R+0.1191920*G+0.9503041*B</td></tr>
1314
1315 <tr><th valign="middle">YCC</th></tr>
1316 <tr><td valign="middle">Y=(0.298839*R+0.586811*G+0.114350*B) (with complicated scaling); <var>intensity-like</var></td></tr>
1317 <tr><td valign="middle">C1=(−0.298839*R−0.586811*G+0.88600*B) (with complicated scaling)</td></tr>
1318 <tr><td valign="middle">C2=(0.70100*R−0.586811*G−0.114350*B) (with complicated scaling)</td></tr>
1319
1320 <tr><th valign="middle">YCbCr</th></tr>
1321 <tr><td valign="middle">Y=0.2988390*R+0.5868110*G+0.1143500*B; <var>intensity-like</var></td></tr>
1322 <tr><td valign="middle">Cb=(−0.168736*R−0.331264*G+0.500000*B)*(<var>QuantumRange</var>+1)/2</td></tr>
1323 <tr><td valign="middle">Cr=(0.500000*R−0.418688*G−0.081312*B)*(<var>QuantumRange</var>+1)/2</td></tr>
1324
1325 <tr><th valign="middle">YIQ</th></tr>
1326 <tr><td valign="middle">Y=0.298839*R+0.586811*G+0.114350*B; <var>intensity-like</var></td></tr>
1327 <tr><td valign="middle">I=(0.59600*R−0.27400*G−0.32200*B)*(<var>QuantumRange</var>+1)/2</td></tr>
1328 <tr><td valign="middle">Q=(0.21100*R−0.52300*G+0.31200*B)*(<var>QuantumRange</var>+1)/2</td></tr>
1329
1330 <tr><th valign="middle">YPbPr</th></tr>
1331 <tr><td valign="middle">Y=0.2988390*R+0.5868110*G+0.1143500*B; <var>intensity-like</var></td></tr>
1332 <tr><td valign="middle">Pb=(−0.168736*R−0.331264*G+0.500000*B)*(<var>QuantumRange</var>+1)/2</td></tr>
1333 <tr><td valign="middle">Pr=(0.500000*R−0.418688*G−0.081312*B)*(<var>QuantumRange</var>+1)/2</td></tr>
1334
1335 <tr><th valign="middle">YUV</th></tr>
1336 <tr><td valign="middle">Y=0.298839*R+0.586811*G+0.114350*B; <var>intensity-like</var></td></tr>
1337 <tr><td valign="middle">U=(−0.14740*R−0.28950*G+0.43690*B)*(<var>QuantumRange</var>+1)/2</td></tr>
1338 <tr><td valign="middle">V=(0.61500*R−0.51500*G−0.10000*B)*(<var>QuantumRange</var>+1)/2</td></tr>
1339</table>
1340
1341<p>Note the scRGB colorspace requires HDRI support otherwise it behaves just like linear RGB.</p>
1342
Cristyd474b372017-02-14 12:19:13 -05001343<p>Use the <code>Undefined</code> colorspace to identify multi-spectral images.</p>
1344
Cristy882d9f42015-10-29 16:48:39 -04001345<div style="margin: auto;">
1346 <h3 class="magick-header"><a id="combine"></a>-combine</h3>
1347</div>
1348
1349<p class="magick-description">Combine one or more images into a single image.</p>
1350
1351<p>The channels (previously set by <a href="command-line-options.html#channel">-channel</a>) of the
1352combined image are taken from the grayscale values of each image in the
1353sequence, in order. For the default -channel setting of <code>RGB</code>, this
1354means the first image is assigned to the <code>Red</code> channel, the second
1355to the <code>Green</code> channel, the third to the <code>Blue</code>.</p>
1356
Cristy594d2772015-11-15 10:47:42 -05001357<p>This option can be thought of as the inverse to <a
1358href="command-line-options.html#separate">-separate</a>, so long as the channel settings are the same.
Cristy882d9f42015-10-29 16:48:39 -04001359Thus, in the following example, the final image should be a copy of the
1360original. </p>
1361
1362<pre>
1363convert original.png -channel RGB -separate sepimage.png
1364convert sepimage-0.png sepimage-1.png sepimage-2.png -channel RGB \
1365 -combine imagecopy.png
1366</pre>
1367
1368<div style="margin: auto;">
1369 <h3 class="magick-header"><a id="comment"></a>-comment <var>string</var></h3>
1370</div>
1371
1372<p class="magick-description">Embed a comment in an image.</p>
1373
1374<p>This option sets the comment meta-data of an image read in after this
1375option has been given. To modify a comment of images already in memory use
1376"<code><a href="command-line-options.html#set">-set</a> comment</code>". </p>
1377
Cristy594d2772015-11-15 10:47:42 -05001378<p>The comment can contain special format characters listed in the <a
1379href="escape.html">Format and
Cristy882d9f42015-10-29 16:48:39 -04001380Print Image Properties</a>. These attributes are expanded when the comment
1381is finally assigned to the individual images. </p>
1382
1383<p>If the first character of <var>string</var> is <var>@</var>, the image comment is read from a file titled by the
1384remaining characters in the string. Comments read in from a file are literal;
1385no embedded formatting characters are recognized.</p>
1386
1387<p>Comment meta-data are not visible on the image itself. To do that use the
1388<a href="command-line-options.html#annotate">-annotate</a> or <a href="command-line-options.html#draw">-draw</a> options
1389instead.</p>
1390
1391<p>For example,</p>
1392
1393<pre>
1394-comment "%m:%f %wx%h" bird.miff
1395</pre>
1396
1397<p>produces an image comment of <code>MIFF:bird.miff 512x480</code> (assuming
1398that the image <code>bird.miff</code> has a width of 512 and a height of
1399480.</p>
1400
1401<div style="margin: auto;">
1402 <h3 class="magick-header"><a id="compare"></a>-compare</h3>
1403</div>
1404
1405<p class="magick-description">mathematically and visually annotate the difference between an image and its reconstruction</p>
1406
1407<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>
1408
1409<pre>
Cristy594d2772015-11-15 10:47:42 -05001410convert image.png reference.png -metric RMSE -compare \ <br/> difference.png
Cristy882d9f42015-10-29 16:48:39 -04001411</pre>
1412
1413<p>To get the metric value use the string format "%[distortion]".</p>
1414
1415<pre>
1416convert image.png reference.png -metric RMSE -compare -format \
1417 "%[distortion]" info:
1418</pre>
1419
1420<div style="margin: auto;">
1421 <h3 class="magick-header"><a id="complex"></a>-complex <var>operator</var></h3>
1422</div>
1423
1424<p class="magick-description">perform complex mathematics on an image sequence</p>
1425
1426Choose from these operators:
1427
1428<pre>
1429add
1430conjugate
1431divide
1432magnitude-phase
1433multiply
1434real-imaginary
1435subtract
1436</pre>
1437
1438<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>
1439
1440<div style="margin: auto;">
1441 <h3 class="magick-header"><a id="compose"></a>-compose <var>operator</var></h3>
1442</div>
1443
1444<p class="magick-description">Set the type of image composition.</p>
1445
Cristy6549abb2016-11-10 08:25:55 -05001446<p>See <a href="http://www.imagemagick.org/www/compose.html">Alpha Compositing</a> for
Cristy882d9f42015-10-29 16:48:39 -04001447a detailed discussion of alpha compositing.</p>
1448
1449<p>This setting effects image processing operators that merge two (or more)
1450images together in some way. This includes the operators,
1451<a href="command-line-options.html#composite">-compare</a>,
1452<a href="command-line-options.html#composite">-composite</a>,
1453<a href="command-line-options.html#layers">-layers</a> composite,
1454<a href="command-line-options.html#flatten">-flatten</a>,
1455<a href="command-line-options.html#mosaic">-mosaic</a>,
1456<a href="command-line-options.html#layers">-layers</a> merge,
1457<a href="command-line-options.html#border">-border</a>,
1458<a href="command-line-options.html#frame">-frame</a>,
1459and <a href="command-line-options.html#extent">-extent</a>. </p>
1460
1461<p>It is also one of the primary options for the "<code>composite</code>"
1462command. </p>
1463
1464
1465<div style="margin: auto;">
1466 <h3 class="magick-header"><a id="composite"></a>-composite</h3>
1467</div>
1468
1469<p class="magick-description">Perform alpha composition on two images and an optional mask</p>
1470
1471<p>Take the first image 'destination' and overlay the second 'source' image
1472according to the current <a href="command-line-options.html#compose">-compose</a> setting. The location
Cristy594d2772015-11-15 10:47:42 -05001473of the 'source' or 'overlay' image is controlled according to <a
Cristye93be682015-11-26 09:07:51 -05001474href="command-line-options.html#gravity" >-gravity</a>, and <a href="command-line-options.html#geometry" >-geometry</a>
Cristy882d9f42015-10-29 16:48:39 -04001475settings. </p>
1476
Cristy769d8892016-01-19 18:11:14 -05001477<p>If a third image is given this is treated as a grayscale blending 'mask' image
Cristy882d9f42015-10-29 16:48:39 -04001478relative to the first 'destination' image. This mask is blended with the
1479source image. However for the '<code>displace</code>' compose method, the
1480mask is used to provide a separate Y-displacement image instead. </p>
1481
1482<p>If a <a href="command-line-options.html#compose">-compose</a> method requires extra numerical
Cristy594d2772015-11-15 10:47:42 -05001483arguments or flags these can be provided by setting the <a
1484href="command-line-options.html#set">-set</a> '<code>option:compose:args</code>'
Cristy882d9f42015-10-29 16:48:39 -04001485appropriately for the compose method. </p>
1486
1487<p>Some <a href="command-line-options.html#compose">-compose</a> methods can modify the 'destination'
Cristy594d2772015-11-15 10:47:42 -05001488image outside the overlay area. You can disable this by setting the special <a
1489href="command-line-options.html#set">-set</a> '<code>option:compose:outside-overlay</code>'
Cristy882d9f42015-10-29 16:48:39 -04001490to '<code>false</code>'. </p>
1491
1492<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>
1493
1494
1495<div style="margin: auto;">
1496 <h3 class="magick-header"><a id="compress"></a>-compress <var>type</var></h3>
1497</div>
1498
1499<p class="magick-description">Use pixel compression specified by <var>type</var> when writing the image.</p>
1500
Cristy594d2772015-11-15 10:47:42 -05001501<p>Choices are: <code>None</code>, <code>BZip</code>, <code
1502>Fax</code>, <code>Group4</code>, <code
1503>JPEG</code>, <code>JPEG2000</code>, <code
1504>Lossless</code>, <code>LZW</code>, <code
1505>RLE</code> or <code>Zip</code>.</p>
Cristy882d9f42015-10-29 16:48:39 -04001506
1507<p>To print a complete list of compression types, use <a href="command-line-options.html#list">-list
1508compress</a>.</p>
1509
1510<p>Specify <a href="command-line-options.html#compress">+compress</a> to store the binary image in an
1511uncompressed format. The default is the compression type of the specified
1512image file.</p>
1513
1514<p>If <code>LZW</code> compression is specified but LZW compression has not been
1515enabled, the image data is written in an uncompressed LZW format that can be
1516read by LZW decoders. This may result in larger-than-expected GIF files.</p>
1517
1518<p><code>Lossless</code> refers to lossless JPEG, which is only available if the
1519JPEG library has been patched to support it. Use of lossless JPEG is generally
1520not recommended.</p>
1521
1522<p>
1523When writing an ICO file, you may request that the images be encoded in
1524PNG format, by specifying <code>Zip</code> compression.</p>
1525
1526<p>
1527When writing a JNG file, specify <code>Zip</code> compression to request that
1528the alpha channel be encoded in PNG "IDAT" format, or <code>JPEG</code>
1529to request that it be encoded in JPG "JDAA" format.</p>
1530
1531<p>Use the <a href="command-line-options.html#quality">-quality</a> option to set the compression level
1532to be used by JPEG, PNG, MIFF, and MPEG encoders.
1533Use the <a href="command-line-options.html#sampling-factor">-sampling-factor</a> option to set the
1534sampling factor to be used by JPEG, MPEG, and YUV encoders for down-sampling
1535the chroma channels.</p>
1536
1537<div style="margin: auto;">
1538 <h3 class="magick-header"><a id="connected-components"></a>-connected-components <var>connectivity</var></h3>
1539</div>
1540
Cristyce4a3552015-12-14 13:53:35 -05001541<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 -04001542
Cristy594d2772015-11-15 10:47:42 -05001543<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 -04001544
1545<div style="margin: auto;">
1546 <h3 class="magick-header"><a id="contrast"></a>-contrast</h3>
1547</div>
1548
1549<p class="magick-description">Enhance or reduce the image contrast.</p>
1550
1551<p>This option enhances the intensity differences between the lighter and
1552darker elements of the image. Use <a href="command-line-options.html#contrast">-contrast</a> to enhance
1553the image or <a href="command-line-options.html#contrast">+contrast</a> to reduce the image
1554contrast.</p>
1555
1556<p>For a more pronounced effect you can repeat the option:</p>
1557
1558<pre>
1559convert rose: -contrast -contrast rose_c2.png
1560</pre>
1561
1562<div style="margin: auto;">
Cristy769d8892016-01-19 18:11:14 -05001563 <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 -04001564</div>
1565
1566<p class="magick-description">Increase the contrast in an image by <var>stretching</var> the range of intensity values.</p>
1567
1568<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 -05001569<var >black-point %</var> pixels and white-out at most <var>white-point %</var> pixels.</p>
Cristy882d9f42015-10-29 16:48:39 -04001570
Cristy594d2772015-11-15 10:47:42 -05001571<p>Prior to ImageMagick 6.4.7-0, <a href="command-line-options.html#contrast-stretch"
1572>-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 -04001573minus 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>
1574
1575<p>Note that <code>-contrast-stretch 0</code> will modify the image such that
1576the 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 -05001577clipping at either end. This is not the same as <a href="command-line-options.html#normalize"
1578>-normalize</a>, which is equivalent to <code>-contrast-stretch 0.15x0.05%</code> (or
Cristy882d9f42015-10-29 16:48:39 -04001579prior to ImageMagick 6.4.7-0, <code>-contrast-stretch 2%x99%</code>).</p>
1580
1581<p>Internally operator works by creating a histogram bin, and then uses that
1582bin to modify the image. As such some colors may be merged together when they
1583originally fell into the same 'bin'. </p>
1584
Cristy769d8892016-01-19 18:11:14 -05001585<p>All the channels are normalized in concert by the same amount so as to
Cristy594d2772015-11-15 10:47:42 -05001586preserve color integrity, when the default <a href="command-line-options.html#channel" >+channel</a>
1587setting is in use. Specifying any other <a href="command-line-options.html#channel" >-channel</a>
Cristy882d9f42015-10-29 16:48:39 -04001588setting will normalize the RGB channels independently.</p>
1589
Cristy594d2772015-11-15 10:47:42 -05001590<p>See also <a href="command-line-options.html#auto-level" >-auto-level</a> for a 'perfect'
Cristy882d9f42015-10-29 16:48:39 -04001591normalization of mathematical images. </p>
1592
1593<p>This operator is under review for re-development. </p>
1594
1595
1596<div style="margin: auto;">
1597 <h3 class="magick-header"><a id="convolve"></a>-convolve <var>kernel</var></h3>
1598</div>
1599
1600<p class="magick-description">Convolve an image with a user-supplied convolution kernel.</p>
1601
1602<p>The <var>kernel</var> is a matrix specified as
1603a comma-separated list of integers (with no spaces), ordered left-to right,
1604starting with the top row. Presently, only odd-dimensioned kernels are
1605supported, and therefore the number of entries in the specified <var>kernel</var> must be 3<sup>2</sup>=9, 5<sup>2</sup>=25,
16067<sup>2</sup>=49, etc. </p>
1607
Cristy594d2772015-11-15 10:47:42 -05001608<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 -04001609positive and negative results are relative to a user-specified bias value.
1610This is important for non-HDRI compilations of ImageMagick when dealing with
1611convolutions that contain negative as well as positive values. This is
1612especially the case with convolutions involving high pass filters or edge
1613detection. Without an output bias, the negative values is clipped at zero.
1614</p>
1615
Cristy594d2772015-11-15 10:47:42 -05001616<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 -04001617negative results without clipping to the color value range (0..QuantumRange).
Cristy594d2772015-11-15 10:47:42 -05001618See the discussion on HDRI implementations of ImageMagick on the page <a
1619href="high-dynamic-range.html">High
1620Dynamic-Range Images</a>. For more about HDRI go the ImageMagick <a
Cristy364a72f2016-11-04 22:38:41 -04001621href="https://www.imagemagick.org/Usage/basics/#hdri">Usage</a> pages or this
Cristy882d9f42015-10-29 16:48:39 -04001622<a href="http://en.wikipedia.org/wiki/High_dynamic_range_imaging">Wikipedia</a>
1623entry. </p>
1624
1625
1626<div style="margin: auto;">
1627 <h3 class="magick-header"><a id="copy"></a>-copy <var>geometry</var> <var>offset</var></h3>
1628</div>
1629
1630<p class="magick-description">copy pixels from one area of an image to another.</p>
1631
1632<div style="margin: auto;">
1633 <h3 class="magick-header"><a id="crop"></a>-crop <var>geometry</var>{<var>@</var>}{<var>!</var>}</h3>
1634</div>
1635
1636<p class="magick-description">Cut out one or more rectangular regions of the image.</p>
1637
1638<p>See <a href="command-line-processing.html#geometry">Image Geometry</a> for complete details about the <em class="arg">geometry</em> argument.</p>
1639
1640<p>The <var>width</var> and <var>height</var> of the <var>geometry</var> argument give the size of the image that remains
1641after cropping, and <var>x</var> and <var>y</var> in the
1642<var>offset</var> (if present) gives the location of the top left
1643corner of the cropped image with respect to the original image. To specify the
1644amount to be removed, use <a href="command-line-options.html#shave">-shave</a> instead.</p>
1645
1646<p>If the <var>x</var> and <var>y</var> offsets are
1647present, a single image is generated, consisting of the pixels from the
1648cropping region. The offsets specify the location of the upper left corner of
1649the cropping region measured downward and rightward with respect to the upper
1650left corner of the image. If the <a href="command-line-options.html#gravity">-gravity</a> option is
1651present with <code>NorthEast</code>, <code>East</code>, or <code>SouthEast</code>
1652gravity, it gives the distance leftward from the right edge of the image to
Cristy594d2772015-11-15 10:47:42 -05001653the right edge of the cropping region. Similarly, if the <a
1654href="command-line-options.html#gravity">-gravity</a> option is present with <code>SouthWest</code>,
Cristy882d9f42015-10-29 16:48:39 -04001655<code>South</code>, or <code>SouthEast</code> gravity, the distance is measured
1656upward between the bottom edges.</p>
1657
1658<p>If the <var>x</var> and <var>y</var> offsets are
1659omitted, a set of tiles of the specified geometry, covering the entire input
1660image, is generated. The rightmost tiles and the bottom tiles are smaller if
1661the specified geometry extends beyond the dimensions of the input image.</p>
1662
1663<p>You can add the <var>@</var> to the geometry argument to equally divide the image into the number of tiles generated.</p>
1664
1665<p>By adding a exclamation character flag to the geometry argument, the
1666cropped images virtual canvas page size and offset is set as if the
1667geometry argument was a viewport or window. This means the canvas page size
1668is set to exactly the same size you specified, the image offset set
1669relative top left corner of the region cropped. </p>
1670
1671<p>If the cropped image 'missed' the actual image on its virtual canvas, a
1672special single pixel transparent 'missed' image is returned, and a 'crop
1673missed' warning given. </p>
1674
Cristy594d2772015-11-15 10:47:42 -05001675<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 -04001676cropping the image to ensure the crop coordinate frame is relocated to the
1677upper-left corner of the visible image.
1678
Cristy594d2772015-11-15 10:47:42 -05001679Similarly you may want to use <a href="command-line-options.html#repage" >+repage</a> after cropping to
Cristy882d9f42015-10-29 16:48:39 -04001680remove the page offset that will be left behind. This is especially true when
1681you are going to write to an image format such as PNG that supports an image
1682offset.</p>
1683
1684<div style="margin: auto;">
1685 <h3 class="magick-header"><a id="cycle"></a>-cycle <var>amount</var></h3>
1686</div>
1687
1688<p class="magick-description">displace image colormap by amount.</p>
1689
1690<p><var>Amount</var> defines the number of positions each
1691colormap entry is shifted.</p>
1692
1693
1694<div style="margin: auto;">
1695 <h3 class="magick-header"><a id="debug"></a>-debug <var>events</var></h3>
1696</div>
1697
1698<p class="magick-description">enable debug printout.</p>
1699
1700<p>The <code>events</code> parameter specifies which events are to be logged. It
1701can be either <code>None</code>, <code>All</code>, <code>Trace</code>, or
1702a comma-separated list consisting of one or more of the following domains:
1703<code>Accelerate</code>, <code>Annotate</code>, <code>Blob</code>, <code>Cache</code>,
1704<code>Coder</code>, <code>Configure</code>, <code>Deprecate</code>,
1705<code>Exception</code>, <code>Locale</code>, <code>Render</code>,
1706<code>Resource</code>, <code>Security</code>, <code>TemporaryFile</code>,
1707<code>Transform</code>, <code>X11</code>, or <code>User</code>. </p>
1708
1709
1710<p>For example, to log cache and blob events, use.</p>
1711
1712<pre>
1713convert -debug "Cache,Blob" rose: rose.png
1714</pre>
1715
1716<p>The <code>User</code> domain is normally empty, but developers can log user
1717events in their private copy of ImageMagick.</p>
1718
1719<p>To print the complete list of debug methods, use <a href="command-line-options.html#list">-list
1720debug</a>.</p>
1721
1722<p>Use the <a href="command-line-options.html#log">-log</a> option to specify the format for debugging
1723output.</p>
1724
1725<p>Use <a href="command-line-options.html#debug">+debug</a> to turn off all logging.</p>
1726
Cristy594d2772015-11-15 10:47:42 -05001727<p>Debugging may also be set using the <code>MAGICK_DEBUG</code> <a href="resources.html#environment"
1728>environment variable</a>. The allowed values for the <code>MAGICK_DEBUG</code>
Cristy882d9f42015-10-29 16:48:39 -04001729environment variable are the same as for the <a href="command-line-options.html#debug">-debug</a>
1730option.</p>
1731
1732
1733<div style="margin: auto;">
1734 <h3 class="magick-header"><a id="decipher"></a>-decipher <var>filename</var></h3>
1735</div>
1736
1737<p class="magick-description">Decipher and restore pixels that were previously transformed by <a href="command-line-options.html#encipher">-encipher</a>.</p>
1738
1739<p>Get the passphrase from the file specified by <var>filename</var>.</p>
1740
Cristy594d2772015-11-15 10:47:42 -05001741<p>For more information, see the webpage, <a
Cristy6549abb2016-11-10 08:25:55 -05001742href="https://www.imagemagick.org/script/cipher.html">ImageMagick: Encipher or
Cristy882d9f42015-10-29 16:48:39 -04001743Decipher an Image</a>.</p>
1744
1745
1746<div style="margin: auto;">
1747 <h3 class="magick-header"><a id="deconstruct"></a>-deconstruct</h3>
1748</div>
1749
1750<p class="magick-description">find areas that has changed between images </p>
1751
Cristy594d2772015-11-15 10:47:42 -05001752<p>Given a sequence of images all the same size, such as produced by <a
1753href="command-line-options.html#coalesce">-coalesce</a>, replace the second and later images, with
Cristy882d9f42015-10-29 16:48:39 -04001754a smaller image of just the area that changed relative to the previous image.
1755</p>
1756
1757<p>The resulting sequence of images can be used to optimize an animation
1758sequence, though will not work correctly for GIF animations when parts of the
1759animation can go from opaque to transparent. </p>
1760
1761<p>This option is actually equivalent to the <a href="command-line-options.html#layers">-layers</a>
1762method '<code>compare-any</code>'. </p>
1763
1764
1765<div style="margin: auto;">
1766 <h3 class="magick-header"><a id="define"></a>-define <var>key</var>{<var>=value</var>}<var>...</var></h3>
1767</div>
1768
1769<p class="magick-description">add specific global settings generally used to control coders and image processing operations.</p>
1770
1771<p>This option creates one or more definitions for coders and decoders to use
1772while reading and writing image data. Definitions are generally used to
1773control image file format coder modules, and image processing operations,
Cristy594d2772015-11-15 10:47:42 -05001774beyond what is provided by normal means. Defined settings are listed in <a
1775href="command-line-options.html#verbose" >-verbose</a> information ("<code>info:</code>" output format)
Cristy882d9f42015-10-29 16:48:39 -04001776as "Artifacts". </p>
1777
1778<p>If <var>value</var> is missing for a definition, an empty-valued
1779definition of a flag is created with that name. This used to control on/off
1780options. Use <a href="command-line-options.html#define">+define key</a> to remove definitions
1781previously created. Use <a href="command-line-options.html#define">+define "*"</a> to remove all
1782existing definitions.</p>
1783
Cristy594d2772015-11-15 10:47:42 -05001784<p>The same 'artifact' settings can also be defined using the <a
1785href="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 -04001786Properties</a> in the defined value. </p>
1787
1788<p>The <var>option</var> and <var>key</var> are case-independent (they are
1789converted to lowercase for use within the decoders) while the <var>value</var>
1790is case-dependent.</p>
1791
1792<p>Such settings are global in scope, and affect all images and operations. </p>
1793
1794<p>The following definitions are just some of the artifacts that are
1795available:</p>
1796
1797<table class="table table-condensed table-striped">
1798 <tr>
Cristye0779712016-07-30 17:25:22 -04001799 <td>bmp:alpha=<var>true|false</var></td>
1800 <td>include any alpha channel when writing in the BMP image format.</td>
1801 </tr>
1802
1803 <tr>
Cristy882d9f42015-10-29 16:48:39 -04001804 <td>bmp:format=<var>value</var></td>
1805 <td> valid values are <var>bmp2</var>, <var>bmp3</var>,
1806 and <var>bmp4</var>. This option can be useful when the
1807 method of prepending "BMP2:" to the output filename is inconvenient or
1808 is not available, such as when using the <a href="mogrify.html">mogrify</a> utility.</td>
1809 </tr>
1810
1811 <tr>
1812 <td>colorspace:auto-grayscale=<var>on|off</var></td>
Cristyd474b372017-02-14 12:19:13 -05001813 <td>prevent automatic conversion to grayscale inside coders that support
1814 grayscale. This should be accompanied by -type truecolor. PNG and TIF do
1815 not need this define. With PNG, just use PNG24:image. With TIF, just use
1816 -type truecolor. JPG and PSD will need this define.</td>
Cristy882d9f42015-10-29 16:48:39 -04001817 </tr>
1818
1819 <tr>
1820 <td>complex:snr=<var>value</var></td>
1821 <td>Set the divide SNR constant<a href="command-line-options.html#complex">-complex</a></td>
1822 </tr>
1823
1824 <tr>
1825 <td>compose:args=<var>arguments</var></td>
1826 <td>Sets certain compose argument values when using convert ... -compose ...
Cristy1f1f3a02016-06-01 07:25:42 -04001827 -composite. See <a href="compose.html"
Cristy594d2772015-11-15 10:47:42 -05001828 >Image Composition</a></td>
Cristy882d9f42015-10-29 16:48:39 -04001829 </tr>
1830
1831 <tr>
1832 <td>compose:clamp=<var>on|off</var></td>
Cristyd474b372017-02-14 12:19:13 -05001833 <td>set each pixel whose value is below zero to zero and any the pixel
1834 whose value is above the quantum range to the quantum range (e.g. 65535)
1835 otherwise the pixel value remains unchanged. Define supported in
Cristybc232422016-11-22 07:46:18 -05001836 ImageMagick 6.9.1-3 and above.</td>
Cristy882d9f42015-10-29 16:48:39 -04001837 </tr>
1838
1839 <tr>
Cristyde27d762016-01-02 12:56:44 -05001840 <td>connected-components:area-threshold=<var>value</var></td>
1841 <td>Merges any region with area smaller than <var>value</var> into its surrounding region or largest neighbor.</td>
1842 </tr>
1843
1844 <tr>
1845 <td>connected-components:keep=<var>list-of-ids</var></td>
Cristybc232422016-11-22 07:46:18 -05001846 <td>Comma and/or hyphenated list of id values to keep in the output.
1847 Supported in Imagemagick 6.9.3-0.</td>
Cristyde27d762016-01-02 12:56:44 -05001848 </tr>
1849
1850 <tr>
1851 <td>connected-components:mean-color=<var>true</var></td>
Cristybc232422016-11-22 07:46:18 -05001852 <td>Changes the output image from id values to mean color values. Supported
1853 in Imagemagick 6.9.2-8.</td>
Cristyde27d762016-01-02 12:56:44 -05001854 </tr>
1855
1856 <tr>
1857 <td>connected-components:remove=<var>list-of-ids</var></td>
Cristybc232422016-11-22 07:46:18 -05001858 <td>Comma and/or hyphenated list of id values to remove from the output.
1859 Supported in Imagemagick 6.9.2-9.</td>
Cristyde27d762016-01-02 12:56:44 -05001860 </tr>
1861
1862 <tr>
1863 <td>connected-components:verbose=<var>true</var></td>
1864 <td>Lists id, bounding box, centroid, area, mean color for each region.</td>
1865 </tr>
1866
1867 <tr>
Cristy882d9f42015-10-29 16:48:39 -04001868 <td>convolve:scale=<var>{kernel_scale}[!^] [,{origin_addition}] [%]</var></td>
1869 <td>Defines the kernel scaling. The special flag ! automatically scales to
1870 full dynamic range. The ! flag can be used in combination with a factor or
1871 percent. The factor or percent is then applied after the automatic scaling.
1872 An example is 50%!. This produces a result 50% darker than full dynamic
1873 range scaling. The ^ flag assures the kernel is 'zero-summing', for
1874 example when some values are positive and some are negative as in edge
1875 detection kernels. The origin addition adds that value to the center
1876 pixel of the kernel. This produces and effect that is like adding the image
1877 that many times to the result of the filtered image. The typical value
1878 is 1 so that the original image is added to the result of the convolution.
1879 The default is 0.</td>
1880 </tr>
1881
1882 <tr>
1883 <td>convolve:showkernel=<var>1</var></td>
Cristy594d2772015-11-15 10:47:42 -05001884 <td>Outputs (to 'standard error') all the information about a specified <a
1885 href="command-line-options.html#morphology" >-morphology convolve</a> kernel.</td>
Cristy882d9f42015-10-29 16:48:39 -04001886 </tr>
1887
1888 <tr>
1889 <td>dcm:display-range=<var>reset</var></td>
1890 <td>Sets the display range to the minimum and maximum pixel values for the
1891 DCM image format.</td>
1892 </tr>
1893
1894 <tr>
1895 <td>dds:cluster-fit=<var>true|false</var></td>
1896 <td>Enables the dds cluster-fit.</td>
1897 </tr>
1898
1899 <tr>
1900 <td>dds:compression=<var>dxt1|dxt5|none</var></td>
1901 <td>Sets the dds compression.</td>
1902 </tr>
1903
1904 <tr>
1905 <td>dds:mipmaps=<var>value</var></td>
1906 <td>Sets the dds number of mipmaps.</td>
1907 </tr>
1908
1909 <tr>
Cristy3b0b58d2016-11-06 07:40:23 -05001910 <td>dds:weight-by-alpha=<var>true|false</var></td>
Cristy882d9f42015-10-29 16:48:39 -04001911 <td>Enables the dds alpha weighting.</td>
1912 </tr>
1913
1914 <tr>
Cristy3b0b58d2016-11-06 07:40:23 -05001915 <td>deskew:auto-crop=<var>true</var></td>
1916 <td>auto crop the image after deskewing.</td>
1917 </tr>
1918
1919 <tr>
Cristy882d9f42015-10-29 16:48:39 -04001920 <td>delegate:bimodal=<var>true</var></td>
1921 <td>Specifies direct conversion from Postscript to PDF.</td>
1922 </tr>
1923
1924 <tr>
1925 <td>distort:scale=<var>value</var></td>
Cristy594d2772015-11-15 10:47:42 -05001926 <td>Sets the output scaling factor for use with <a href="command-line-options.html#distort"
1927 >-distort</a></td>
Cristy882d9f42015-10-29 16:48:39 -04001928 </tr>
1929
1930 <tr>
1931 <td>distort:viewport=<var>WxH+X+Y</var></td>
1932 <td>Sets the viewport for use with <a href="command-line-options.html#distort">-distort</a></td>
1933 </tr>
1934
1935 <tr>
1936 <td>dot:layout-engine=<var>value</var></td>
1937 <td>Specifies the layout engine for the DOT image format (e.g.
1938 <code>neato</code>).</td>
1939 </tr>
1940
1941 <tr>
1942 <td>filter:option=<var>value</var></td>
1943 <td>Set a filter option for use with <a href="command-line-options.html#resize">-resize</a>.
1944 See <a href="command-line-options.html#filter">-filter</a> for details.</td>
1945 </tr>
1946
1947 <tr>
1948 <td>fourier:normalize=<var>inverse</var></td>
1949 <td>Sets the location for the FFT/IFT normalization as use by
1950 <a href="command-line-options.html#fft">+-fft</a> and <a href="command-line-options.html#ift">+-ift</a>. The default is
1951 <var>forward</var>.</td>
1952 </tr>
1953
1954 <tr>
1955 <td>h:format=<var>value</var></td>
1956 <td>Set the image encoding format use when writing a C-style header.
1957 <var>format</var> can be any output format supported by ImageMagick
Cristy579a0cb2016-11-26 12:27:17 -05001958 except for <var>h</var> and <var>magick</var>. If this
Cristy882d9f42015-10-29 16:48:39 -04001959 option is omitted, the default is <var>GIF</var> for PseudoClass
1960 images and <var>PNM</var> for DirectClass images.
Cristy579a0cb2016-11-26 12:27:17 -05001961 </td>
Cristy882d9f42015-10-29 16:48:39 -04001962 </tr>
1963
1964 <tr>
1965 <td>icon:auto-resize</td>
1966 <td>Automatically stores multiple sizes when writing an ico image
1967 (requires a 256x256 input image).</td>
1968 </tr>
1969
1970 <tr>
1971 <td>jp2:layer-number=<var>value</var></td>
1972 <td>Sets the maximum number of quality layers to decode. Same for JPT, JC2,
1973 and J2K</td>
1974 </tr>
1975
1976 <tr>
1977 <td>jp2:number-resolutions=<var>value</var></td>
Cristybc232422016-11-22 07:46:18 -05001978 <td>Sets the number of resolutions to encode.Same for JPT, JC2, and
1979 J2K</td>
Cristy882d9f42015-10-29 16:48:39 -04001980 </tr>
1981
1982 <tr>
1983 <td>jp2:progression-order=<var>value</var></td>
1984 <td>choose from LRCP, RLCP, RPCL, PCRL or CPRL. Same for JPT, JC2, and
1985 J2K</td>
1986 </tr>
1987
1988 <tr>
1989 <td>jp2:quality=<var>value,value...</var></td>
1990 <td>Sets the quality layer PSNR, given in dB. The order is from left to
1991 right in ascending order. The default is a single lossless quality layer.
1992 Same for JPT, JC2, and J2K</td>
1993 </tr>
1994
1995 <tr>
1996 <td>jp2:rate=<var>value</var></td>
Cristybc232422016-11-22 07:46:18 -05001997 <td>Specify the compression factor to use while writing JPEG-2000 files.
1998 The compression factor is the reciprocal of the compression ratio. The
1999 valid range is 0.0 to 1.0, with 1.0 indicating lossless compression. If
2000 defined, this value overrides the -quality setting. A quality setting
2001 of 75 results in a rate value of 0.06641. Same for JPT, JC2, and J2K</td>
Cristy882d9f42015-10-29 16:48:39 -04002002 </tr>
2003
2004 <tr>
2005 <td>jp2:reduce-factor=<var>value</var></td>
2006 <td>Sets the number of highest resolution levels to be discarded.Same for
2007 JPT, JC2, and J2K</td>
2008 </tr>
2009
2010 <tr>
2011 <td>jpeg:block-smoothing=<var>on|off</var></td>
Cristybc232422016-11-22 07:46:18 -05002012 <td> </td>
Cristy882d9f42015-10-29 16:48:39 -04002013 </tr>
2014
2015 <tr>
2016 <td>jpeg:colors=<var>value</var></td>
2017 <td>Set the desired number of colors and let the JPEG encoder do the
2018 quantizing.</td>
2019 </tr>
2020
2021 <tr>
2022 <td>jpeg:dct-method=<var>value</var></td>
2023 <td>Choose from <code>default</code>, <code>fastest</code>,
2024 <code>float</code>, <code>ifast</code>, and <code>islow</code>.</td>
2025 </tr>
2026
2027 <tr>
2028 <td>jpeg:extent=<var>value</var></td>
2029 <td>Restrict the maximum JPEG file size, for example <code>-define
2030 jpeg:extent=400KB</code>. The JPEG encoder will search for the highest
2031 compression quality level that results in an output file that does not
Cristye93be682015-11-26 09:07:51 -05002032 exceed the value. The <code>-quality</code> option also will be respected
2033 starting with version 6.9.2-5. Between 6.9.1-0 and 6.9.2-4, add -quality
2034 100 in order for the jpeg:extent to work properly. Prior to 6.9.1-0, the
2035 -quality setting was ignored.</td>
Cristy882d9f42015-10-29 16:48:39 -04002036 </tr>
2037
2038 <tr>
2039 <td>jpeg:fancy-upsampling=<var>on|off</var></td>
Cristybc232422016-11-22 07:46:18 -05002040 <td> </td>
Cristy882d9f42015-10-29 16:48:39 -04002041 </tr>
2042
2043 <tr>
2044 <td>jpeg:optimize-coding=<var>on|off</var></td>
Cristybc232422016-11-22 07:46:18 -05002045 <td> </td>
Cristy882d9f42015-10-29 16:48:39 -04002046 </tr>
2047
2048 <tr>
2049 <td>jpeg:q-table=<var>table</var></td>
Cristybc232422016-11-22 07:46:18 -05002050 <td> </td>
Cristy882d9f42015-10-29 16:48:39 -04002051 </tr>
2052
2053 <tr>
2054 <td>jpeg:sampling-factor=<var>sampling-factor-string</var></td>
Cristybc232422016-11-22 07:46:18 -05002055 <td> </td>
Cristy882d9f42015-10-29 16:48:39 -04002056 </tr>
2057
2058 <tr>
2059 <td>jpeg:size=<var>geometry</var></td>
2060 <td>Set the size hint of a JPEG image, for
2061 example, <code>-define jpeg:size=128x128</code>.
2062 It is most useful for increasing performance and reducing the memory
2063 requirements when reducing the size of a large JPEG image.</td>
2064 </tr>
2065
2066 <tr>
2067 <td>json:features</td>
2068 <td>includes features in verbose information</td>
2069 </tr>
2070
2071 <tr>
2072 <td>json:limit</td>
Cristybc232422016-11-22 07:46:18 -05002073 <td> </td>
Cristy882d9f42015-10-29 16:48:39 -04002074 </tr>
2075
2076 <tr>
2077 <td>json:locate</td>
Cristybc232422016-11-22 07:46:18 -05002078 <td> </td>
Cristy882d9f42015-10-29 16:48:39 -04002079 </tr>
2080
2081 <tr>
2082 <td>json:moments</td>
2083 <td>includes image moments in verbose information</td>
2084 </tr>
2085
2086 <tr>
2087 <td>magick:format=<var>value</var></td>
2088 <td>Set the image encoding format use when writing a C-style header.
Cristy579a0cb2016-11-26 12:27:17 -05002089 This is the same as "h:format=format" described above.</td>
Cristy882d9f42015-10-29 16:48:39 -04002090 </tr>
2091
2092 <tr>
2093 <td>mng:need-cacheoff</td>
2094 <td>turn playback caching off for streaming MNG.</td>
2095 </tr>
2096
2097 <tr>
2098 <td>morphology:compose=<var>compose-method</var></td>
Cristy594d2772015-11-15 10:47:42 -05002099 <td>Specifies how to merge results generated by multiple<a
2100 href="command-line-options.html#morphology" >-morphology</a> kernel. The default is none. One
Cristy882d9f42015-10-29 16:48:39 -04002101 typical value is 'lighten' as used, for example, with the sobel edge
2102 kernels. </td>
2103 </tr>
2104
2105 <tr>
2106 <td>morphology:showkernel=<var>1</var></td>
Cristy594d2772015-11-15 10:47:42 -05002107 <td>Outputs (to 'standard error') all the information about a generated <a
2108 href="command-line-options.html#morphology" >-morphology</a> kernel.</td>
Cristy882d9f42015-10-29 16:48:39 -04002109 </tr>
2110
2111 <tr>
2112 <td>pcl:fit-to-page=<var>true</var></td>
Cristy579a0cb2016-11-26 12:27:17 -05002113 </tr>
Cristy882d9f42015-10-29 16:48:39 -04002114
Cristy594d2772015-11-15 10:47:42 -05002115 <tr>
Cristy882d9f42015-10-29 16:48:39 -04002116 <td>pdf:fit-page=<var>geometry</var></td>
2117 <td> geometry specifies the scaling dimensions for resizing when the PDF is
2118 being read. The geometry is either WxH{%} or page size. No offsets are
2119 allowed. (introduced in IM 6.8.8-8)</td>
2120 </tr>
2121
2122 <tr>
2123 <td>pdf:fit-to-page=<var>true</var></td>
Cristybc232422016-11-22 07:46:18 -05002124 <td> </td>
Cristy882d9f42015-10-29 16:48:39 -04002125 </tr>
2126
2127 <tr>
2128 <td>pdf:use-cropbox=<var>true</var></td>
Cristybc232422016-11-22 07:46:18 -05002129 <td> </td>
Cristy882d9f42015-10-29 16:48:39 -04002130 </tr>
2131
2132 <tr>
2133 <td>pdf:use-trimbox=<var>true</var></td>
Cristybc232422016-11-22 07:46:18 -05002134 <td> </td>
Cristy882d9f42015-10-29 16:48:39 -04002135 </tr>
2136
2137 <tr>
Cristy3b0b58d2016-11-06 07:40:23 -05002138 <td>phash:colorspaces=<var>colorspace,colorspace,...</var></td>
Cristybc232422016-11-22 07:46:18 -05002139 <td>the perceptual hash defaults to the sRGB and HCLp colorspaces. When
2140 using this define, you can specify up to six alternative colorspaces. (as
2141 of IM 7.0.3-8)</td>
2142 </tr>
2143
2144 <tr>
2145 <td>phash:normalize=<var>true</var></td>
2146 <td>normalizes the phash metric by dividing by the number of channels
2147 specified by <code>-define phash:colorspaces</code> when using compare
2148 -metric phash. (as of IM 7.0.3-8)</td>
Cristy3b0b58d2016-11-06 07:40:23 -05002149 </tr>
2150
2151 <tr>
Cristy882d9f42015-10-29 16:48:39 -04002152 <td>png:bit-depth=<var>value</var></td>
Cristybc232422016-11-22 07:46:18 -05002153 <td> </td>
Cristy882d9f42015-10-29 16:48:39 -04002154 </tr>
Cristy3b0b58d2016-11-06 07:40:23 -05002155
Cristy882d9f42015-10-29 16:48:39 -04002156 <tr>
2157 <td>png:color-type=<var>value</var></td>
2158 <td>desired bit-depth and color-type for PNG output. You can force the PNG
2159 encoder to use a different bit-depth and color-type than it would have
2160 normally selected, but only if this does not cause any loss of image
2161 quality. Any attempt to reduce image quality is treated as an error and no
2162 PNG file is written. E.g., if you have a 1-bit black-and-white image, you
2163 can use these "defines" to cause it to be written as an 8-bit grayscale,
2164 indexed, or even a 64-bit RGBA. But if you have a 16-million color image,
2165 you cannot force it to be written as a grayscale or indexed PNG. If you
2166 wish to do this, you must use the appropriate <a href="command-line-options.html#depth">-depth</a>,
2167 <a href="command-line-options.html#colors">-colors</a>, or <a href="command-line-options.html#type">-type</a> directives to
2168 reduce the image quality prior to using the PNG encoder. Note that in
2169 indexed PNG files, "bit-depth" refers to the number of bits per index,
2170 which can be 1, 2, 4, or 8. In such files, the color samples always have
2171 8-bit depth.</td>
2172 </tr>
2173
2174 <tr>
2175 <td>png:compression-filter=<var>value</var></td>
2176 <td> valid values are 0 through 9. 0-4 are the corresponding PNG filters,
2177 5 means adaptive filtering except for images with a colormap, 6 means
2178 adaptive filtering for all images, 7 means MNG "loco" compression, 8 means
2179 Z_RLE strategy with adaptive filtering, and 9 means Z_RLE strategy with no
2180 filtering.</td>
2181 </tr>
2182
2183 <tr>
2184 <td>png:compression-level=<var>value</var></td>
2185 <td> valid values are 0 through 9, with 0 providing the least but fastest
2186 compression and 9 usually providing the best and always the slowest.</td>
2187 </tr>
2188
2189 <tr>
2190 <td>png:compression-strategy=<var>value</var></td>
2191 <td> valid values are 0 through 4, meaning default, filtered, huffman_only,
2192 rle, and fixed ZLIB compression strategy. If you are using an old zlib
2193 that does not support Z_RLE (before 1.2.0) or Z_FIXED (before 1.2.2.2),
2194 values 3 and 4, respectively, will use the zlib default strategy
2195 instead.</td>
2196 </tr>
2197
2198 <tr>
2199 <td>png:format=<var>value</var></td>
2200 <td> valid values are <var>png8</var>, <var>png24</var>,
2201 <var>png32</var>, <var>png48</var>,
2202 <var>png64</var>, and <var>png00</var>.
2203 This property can be useful for specifying
2204 the specific PNG format to be used, when the usual method of prepending the
2205 format name to the output filename is inconvenient, such as when writing
2206 a PNG-encoded ICO file or when using <a href="mogrify.html">mogrify</a>.
2207 Value = <var>png8</var> reduces the number of colors to 256,
2208 only one of which may be fully transparent, if necessary. The other
2209 values do not force any reduction of quality; it is an error to request
2210 a format that cannot represent the image data without loss (except that
2211 it is allowed to reduce the bit-depth from 16 to 8 for all formats).
2212 Value = <var>png24</var> and <var>png48</var>
2213 allow transparency, only if a single color is fully transparent and that
2214 color does not also appear in an opaque pixel; such transparency is
2215 written in a PNG <code>tRNS</code> chunk.
2216 Value = <var>png00</var> causes the image to inherit its
2217 color-type and bit-depth from the input image, if the input was also
2218 a PNG.</td>
2219 </tr>
2220
2221 <tr>
2222 <td>png:exclude-chunk=<var>value</var></td>
2223
Cristy594d2772015-11-15 10:47:42 -05002224 <tr>
Cristy882d9f42015-10-29 16:48:39 -04002225 <td>png:include-chunk=<var>value</var></td>
2226 <td>ancillary chunks to be excluded from or included in PNG output.
2227
2228 <p>The <var>value</var> can be the name of a PNG chunk-type such
2229 as <var>bKGD</var>, a comma-separated list of chunk-names
2230 (which can include the word <var>date</var>, the word
2231 <var>all</var>, or the word <var>none</var>).
2232 Although PNG chunk-names are case-dependent, you can use all lowercase
2233 names if you prefer.</p>
2234
2235 <p>The "include-chunk" and "exclude-chunk" lists only affect the behavior
2236 of the PNG encoder and have no effect on the PNG decoder.</p>
2237
2238 <p>As a special case, if the <code>sRGB</code> chunk is excluded and
2239 the <code>gAMA</code> chunk is included, the <code>gAMA</code> chunk will
2240 only be written if gamma is not 1/2.2, since most decoders assume
2241 sRGB and gamma=1/2.2 when no colorspace information is included in
2242 the PNG file. Because the list is processed from left to right, you
2243 can achieve this with a single define:</p>
2244
2245<pre>
2246-define png:include-chunk=none,gAMA
2247</pre>
2248
2249 <p>As a special case, if the <code>sRGB</code> chunk is not excluded and
2250 the PNG encoder recognizes that the image contains the sRGB ICC profile,
2251 the PNG encoder will write the <code>sRGB</code> chunk instead of the
2252 entire ICC profile. To force the PNG encoder to write the sRGB
2253 profile as an <code>iCCP</code> chunk in the output PNG instead of the
2254 <code>sRGB</code> chunk, exclude the <code>sRGB</code> chunk.</p>
2255
2256 <p>The critical PNG chunks <code>IHDR</code>, <code>PLTE</code>,
2257 <code>IDAT</code>, and <code>IEND</code> cannot be excluded. Any such
2258 entries appearing in the list will be ignored.</p>
2259
2260 <p>If the ancillary PNG <code>tRNS</code> chunk is excluded and the
2261 image has transparency, the PNG colortype is forced to be 4 or 6
2262 (GRAY_ALPHA or RGBA). If the image is not transparent, then the
2263 <code>tRNS</code> chunk isn't written anyhow, and there is no effect
2264 on the PNG colortype of the output image.</p>
2265
2266 <p>The <a href="command-line-options.html#strip">-strip</a> option does the equivalent of the
2267 following for PNG output:</p>
2268
2269<pre>
2270-define png:exclude-chunk=EXIF,iCCP,iTXt,sRGB,tEXt,zCCP,zTXt,date
2271</pre>
2272
2273 <p>The default behavior is to include all known PNG ancillary chunks
2274 plus ImageMagick's private <code>vpAg</code> ("virtual page") chunk,
2275 and to exclude all PNG chunks that are unknown to ImageMagick,
2276 regardless of their PNG "copy-safe" status as described in the
2277 PNG specification.</p>
2278
2279 <p>Any chunk names that are not known to ImageMagick are ignored
2280 if they appear in either the "include-chunk" or "exclude-chunk" list.
2281 The ancillary chunks currently known to ImageMagick are
2282 <code>bKGD</code>, <code>cHRM</code>, <code>gAMA</code>, <code>iCCP</code>,
2283 <code>oFFs</code>, <code>pHYs</code>, <code>sRGB</code>, <code>tEXt</code>,
2284 <code>tRNS</code>, <code>vpAg</code>, and <code>zTXt</code>.</p>
2285
2286 <p>You can also put <code>date</code> in the list to include or exclude
2287 the "Date:create" and "Date:modify" text chunks that ImageMagick normally
2288 inserts in the output PNG.</p></td>
2289 </tr>
2290
2291 <tr>
2292 <td>png:preserve-colormap[=<var>true</var>]</td>
Cristy594d2772015-11-15 10:47:42 -05002293 <td>Use the existing image->colormap. Normally the PNG encoder will
Cristy882d9f42015-10-29 16:48:39 -04002294 try to optimize the palette, eliminating unused entries and putting
2295 the transparent colors first. If this flag is set, that behavior
2296 is suppressed.</td>
2297 </tr>
2298
2299 <tr>
2300 <td>png:preserve-iCCP[=<var>true</var>]</td>
2301 <td>By default, the PNG decoder and encoder examine any ICC profile
2302 that is present, either from an <code>iCCP</code> chunk in the PNG
2303 input or supplied via an option, and if the profile is recognized
2304 to be the sRGB profile, converts it to the <code>sRGB</code> chunk.
2305 You can use <code>-define png:preserve-iCCP</code> to prevent
2306 this from happening; in such cases the <code>iCCP</code> chunk
2307 will be read or written and no <code>sRGB</code> chunk will be
2308 written. There are some ICC profiles that claim to be sRGB but
2309 have various errors that cause them to be rejected by libpng16; such
2310 profiles are recognized anyhow and converted to the <code>sRGB</code>
2311 chunk, but are rejected if the <code>-define png:preserve-iCCP</code>
2312 is present. Note that not all "sRGB" ICC profiles are recognized
2313 yet; we will add them to the list as we encounter them.</td>
2314 </tr>
2315
2316 <tr>
2317 <td>png:swap-bytes[=<var>true</var>]</td>
2318 <td>The PNG specification requires that any multi-byte integers be stored in
2319 network byte order (MSB-LSB endian). This option allows you to
2320 fix any invalid PNG files that have 16-bit samples stored incorrectly
2321 in little-endian order (LSB-MSB). The "-define png:swap-bytes" option
2322 must appear before the input filename on the commandline. The swapping
2323 is done during the libpng decoding operation.</td>
2324 </tr>
2325
2326 <tr>
2327 <td>profile:skip=<var>name1,name2,...</var></td>
2328 <td>Skip the named profile[s] when reading the image. Use skip="*" to
2329 skip all named profiles in the image. Many named profiles exist,
2330 including ICC, EXIF, APP1, IPTC, XMP, and others.</td>
2331 </tr>
2332
2333 <tr>
2334 <td>ps:imagemask</td>
2335 <td>If the ps:imagemask flag is defined, the PS3 and EPS3 coders will
2336 create Postscript files that render bilevel images with the Postscript
2337 imagemask operator instead of the image operator.</td>
2338 </tr>
2339
2340 <tr>
Cristy3b0b58d2016-11-06 07:40:23 -05002341 <td>psd:additional-info=all|selective</td>
Cristybc232422016-11-22 07:46:18 -05002342 <td>This option should only be used when converting from a PSD file to
2343 another PSD file. This should be placed after the image is read. The two
2344 options are 'all' and 'selective'. The 'selective' option will preserve
2345 all additional information that is not related to the geometry of the
2346 image. The 'all' option should only be used when the geometry of the
2347 image has not been changed. This option is helpful when transferring
2348 non-simple layers, such as adjustment layers from the input PSD file to
2349 the output PSD file. If this option is not used, the additional
2350 information will not be preserved. This define is available as of
2351 Imagemagick version 6.9.5-8.
Cristy3b0b58d2016-11-06 07:40:23 -05002352</td>
2353 </tr>
2354
2355 <tr>
Cristy882d9f42015-10-29 16:48:39 -04002356 <td>psd:alpha-unblend=off</td>
2357 <td>Disables new automatic un-blending of transparency with the base image
2358 for the flattened layer 0 before adding the alpha channel to the output
2359 image. This define must be placed before the input psd image. (Available
2360 as of IM 6.9.2.5). The automatic un-blending is new to IM 6.9.2.5 and
2361 prevents the transparency from being applied twice in the output
Cristy3b0b58d2016-11-06 07:40:23 -05002362 image. This option should be set before reading the image.</td>
2363 </tr>
2364
2365 <tr>
2366 <td>psd:preserve-opacity-mask=true</td>
Cristybc232422016-11-22 07:46:18 -05002367 <td>This option should only be used when converting from a PSD file to
2368 another PSD file. It will preserve the opacity mask of a layer and add it
2369 back to the layer when the image is saved. Setting this to 'true' will
2370 enable this feature. This define is available as of Imagemagick version
2371 6.9.5-10.
Cristy3b0b58d2016-11-06 07:40:23 -05002372</td>
Cristy882d9f42015-10-29 16:48:39 -04002373 </tr>
2374
2375 <tr>
Cristy1f1f3a02016-06-01 07:25:42 -04002376 <td>preserve-timestamp=<var>{True, False}</var></td>
2377 <td>Preserve file timestamp (<code>mogrify</code> only).</td>
2378 </tr>
2379
2380 <tr>
Cristy882d9f42015-10-29 16:48:39 -04002381 <td>quantum:format=<var>type</var></td>
2382 <td>Set the type to <code>floating-point</code> to specify a floating-point
2383 format for raw files (e.g. GRAY:) or for MIFF and TIFF images in HDRI mode
2384 to preserve negative values. If <a href="command-line-options.html#depth">-depth</a> 16 is
2385 included, the result is a single precision floating point format.
2386 If <a href="command-line-options.html#depth">-depth</a> 32 is included, the result is
2387 double precision floating point format.</td>
2388 </tr>
2389
2390 <tr>
2391 <td>quantum:polarity=<var>photometric-interpretation</var></td>
Cristybc232422016-11-22 07:46:18 -05002392 <td>Set the photometric-interpretation of an image (typically for TIFF
2393 image file format) to either <code>min-is-black</code> (default) or
Cristy882d9f42015-10-29 16:48:39 -04002394 <code>min-is-white</code>.</td>
2395 </tr>
2396
2397 <tr>
2398 <td>sample:offset=<var>geometry</var></td>
2399 <td>Location of the sampling point within the sub-region being sampled,
Cristy594d2772015-11-15 10:47:42 -05002400 expressed as percentages (see <a href="command-line-options.html#sample" >-sample</a>).</td>
Cristy882d9f42015-10-29 16:48:39 -04002401 </tr>
2402
2403 <tr>
2404 <td>showkernel=<var>1</var></td>
Cristy594d2772015-11-15 10:47:42 -05002405 <td>Outputs (to 'standard error') all the information about a generated <a
2406 href="command-line-options.html#morphology" >-morphology</a> kernel.</td>
Cristy882d9f42015-10-29 16:48:39 -04002407 </tr>
2408
2409 <tr>
2410 <td>stream:buffer-size=<var>value</var></td>
2411 <td>Set the stream buffer size. Select 0 for unbuffered I/O.</td>
2412 </tr>
2413
2414 <tr>
2415 <td>tiff:alpha=<var>associated|unassociated|unspecified</var></td>
Cristybc232422016-11-22 07:46:18 -05002416 <td>Specify the alpha extra samples as associated, unassociated or
2417 unspecified </td>
Cristy882d9f42015-10-29 16:48:39 -04002418 </tr>
2419
2420 <tr>
2421 <td>tiff:endian=<var>msb|lsb</var></td>
Cristybc232422016-11-22 07:46:18 -05002422 <td> </td>
Cristy882d9f42015-10-29 16:48:39 -04002423 </tr>
2424
2425 <tr>
2426 <td>tiff:exif-properties=<var>false</var></td>
2427 <td>Skips reading the EXIF properties.</td>
2428 </tr>
2429
2430 <tr>
2431 <td>tiff:fill-order=<var>msb|lsb</var></td>
Cristybc232422016-11-22 07:46:18 -05002432 <td> </td>
Cristy882d9f42015-10-29 16:48:39 -04002433 </tr>
2434
2435 <tr>
2436 <td>tiff:ignore-layers=<var>true</var></td>
2437 <td>Ignores the photoshop layers.</td>
2438 </tr>
2439
2440 <tr>
2441 <td>tiff:ignore-tags=<var>comma-separate-list-of-tag-IDs</var></td>
2442 <td>Allows one or more tag ID values to be ignored.</td>
2443 </tr>
2444
2445 <tr>
2446 <td>tiff:rows-per-strip=<var>value</var></td>
2447 <td>Sets the number of rows per strip</td>
2448 </tr>
2449
2450 <tr>
2451 <td>tiff:tile-geometry=<var>WxH</var></td>
2452 <td>Sets the tile size for pyramid tiffs. Requires the suffix
2453 PTIF: before the outputname</td>
2454 </tr>
Cristye09ed312016-03-06 08:07:39 -05002455
2456 <tr>
2457 <td>type:features=<var>string</var></td>
Cristybc232422016-11-22 07:46:18 -05002458 <td> </td>
Cristye09ed312016-03-06 08:07:39 -05002459 </tr>
2460
2461 <tr>
2462 <td>type:hinting=<var>off</var></td>
Cristybc232422016-11-22 07:46:18 -05002463 <td> </td>
Cristye09ed312016-03-06 08:07:39 -05002464 </tr>
Cristy882d9f42015-10-29 16:48:39 -04002465</table>
2466
2467<p>For example, to create a postscript file that will render only the black
2468pixels of a bilevel image, use:</p>
2469
2470<pre>
2471convert bilevel.tif -define ps:imagemask eps3:stencil.ps
2472</pre>
2473
2474<p>Set attributes of the image registry by prefixing the value with
2475<code>registry:</code>. For example, to set a temporary path to put work files,
2476use:</p>
2477
2478<pre>
2479-define registry:temporary-path=/data/tmp
2480</pre>
2481
2482<div style="margin: auto;">
Cristy594d2772015-11-15 10:47:42 -05002483 <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 -04002484</div>
2485
2486<p class="magick-description">display the next image after pausing.</p>
2487
2488<p>This option is useful for regulating the animation of image sequences
2489<var>ticks/ticks-per-second</var> seconds must expire before the display of the
2490next image. The default is no delay between each showing of the image
2491sequence. The default ticks-per-second is 100.</p>
2492
2493<p>Use <code>&gt;</code> to change the image delay <var>only</var> if its current
2494value exceeds the given delay. <code>&lt;</code> changes the image delay
2495<var>only</var> if current value is less than the given delay. For example, if
2496you specify <code>30&gt;</code> and the image delay is 20, the image delay does
2497not change. However, if the image delay is 40 or 50, the delay it is changed
2498to 30. Enclose the given delay in quotation marks to prevent the
2499<code>&lt;</code> or <code>&gt;</code> from being interpreted by your shell as
2500a file redirection.</p>
2501
2502
2503<div style="margin: auto;">
2504 <h3 class="magick-header"><a id="delete"></a>-delete <var>indexes</var></h3>
2505</div>
2506
2507<p class="magick-description">delete the images specified by index, from the image sequence.</p>
2508
2509<p>Specify the image by its index in the sequence. The first image is index
25100. Negative indexes are relative to the end of the sequence, for example, -1
2511represents the last image of the sequence. Specify a range of images with
2512a dash (e.g. 0-4). Separate indexes with a comma (e.g. 0,2). Use
Cristy912a9222016-06-17 15:37:28 -04002513<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 -04002514
2515
2516<div style="margin: auto;">
Cristy594d2772015-11-15 10:47:42 -05002517 <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 -04002518</div>
2519
2520<p class="magick-description">Set the horizontal and vertical resolution of an image for rendering to devices.</p>
2521
2522<p>This option specifies the image resolution to store while encoding a raster
2523image or the canvas resolution while rendering (reading) vector formats such
2524as Postscript, PDF, WMF, and SVG into a raster image. Image resolution
2525provides the unit of measure to apply when rendering to an output device or
Cristy594d2772015-11-15 10:47:42 -05002526raster image. The default unit of measure is in dots per inch (DPI). The <a
2527href="command-line-options.html#units">-units</a> option may be used to select dots per centimeter
Cristy882d9f42015-10-29 16:48:39 -04002528instead.</p>
2529
2530<p>The default resolution is 72 dots per inch, which is equivalent to one
2531point per pixel (Macintosh and Postscript standard). Computer screens are
2532normally 72 or 96 dots per inch, while printers typically support 150, 300,
2533600, or 1200 dots per inch. To determine the resolution of your display, use
2534a ruler to measure the width of your screen in inches, and divide by the
2535number of horizontal pixels (1024 on a 1024x768 display).</p>
2536
2537<p>If the file format supports it, this option may be used to update the
2538stored image resolution. Note that Photoshop stores and obtains image
2539resolution from a proprietary embedded profile. If this profile is not
2540stripped from the image, then Photoshop will continue to treat the image using
2541its former resolution, ignoring the image resolution specified in the standard
2542file header.</p>
2543
2544<p>The <a href="command-line-options.html#density">-density</a> option sets an <var>attribute</var> and
2545does not alter the underlying raster image. It may be used to adjust the
2546rendered size for desktop publishing purposes by adjusting the scale applied
2547to the pixels. To resize the image so that it is the same size at a different
2548resolution, use the <a href="command-line-options.html#resample">-resample</a> option.</p>
2549
2550<div style="margin: auto;">
2551 <h3 class="magick-header"><a id="depth"></a>-depth <var>value</var></h3>
2552</div>
2553
2554<p class="magick-description">depth of the image.</p>
2555
2556<p>This the number of bits in a color sample within a pixel. Use this option
2557to specify the depth of raw images whose depth is unknown such as GRAY, RGB,
2558or CMYK, or to change the depth of any image after it has been read.</p>
2559
2560<div style="margin: auto;">
2561 <h3 class="magick-header"><a id="descend"></a>-descend</h3>
2562</div>
2563
2564<p class="magick-description">obtain image by descending window hierarchy.</p>
2565
2566<div style="margin: auto;">
Cristy769d8892016-01-19 18:11:14 -05002567 <h3 class="magick-header"><a id="deskew"></a>-deskew <var>threshold{%}</var></h3>
Cristy882d9f42015-10-29 16:48:39 -04002568</div>
2569
2570<p class="magick-description">straighten an image. A threshold of 40% works for most images.</p>
2571
2572<p>Use <a href="command-line-options.html#set">-set</a> <code>option:deskew:auto-crop
Cristy3b0b58d2016-11-06 07:40:23 -05002573<var>true | false</var></code> to auto crop the image.</p>
Cristy882d9f42015-10-29 16:48:39 -04002574
2575<div style="margin: auto;">
2576 <h3 class="magick-header"><a id="despeckle"></a>-despeckle</h3>
2577</div>
2578
2579<p class="magick-description">reduce the speckles within an image.</p>
2580
2581<div style="margin: auto;">
2582 <h3 class="magick-header"><a id="direction"></a>-direction <var>type</var></h3>
2583</div>
2584
2585<p class="magick-description">render text right-to-left or left-to-right.</p>
2586
2587<div style="margin: auto;">
Cristy769d8892016-01-19 18:11:14 -05002588 <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 -04002589</div>
2590
2591<p class="magick-description">shift image pixels as defined by a displacement map.</p>
2592
2593<p>With this option, the 'overlay' image, and optionally the 'mask' image,
2594is used as a displacement map, which is used to displace the lookup of
2595what part of the 'background' image is seen at each point of the overlaid
2596area. Much like the displacement map is a 'lens' that redirects light shining
2597through it so as to present a distorted view the original 'background' image
2598behind it. </p>
2599
2600<p>Any perfect grey areas of the displacement map produce a zero
2601displacement of the image. Black areas produce the given maximum negative
2602displacement of the lookup point, while white produce a maximum positive
2603displacement of the lookup. </p>
2604
2605<p>Note that it is the lookup of the 'background' that is displaced, not a
2606displacement of the image itself. As such an area of the displacement map
2607containing 'white' will have the lookup point 'shifted' by a positive amount,
2608and thus generating a copy of the destination image to the right/downward from
2609the correct position. That is the image will look like it may have been
2610'shifted' in a negative left/upward direction. Understanding this is a very
2611important in understanding how displacement maps work. </p>
2612
2613<p>The given arguments define the maximum amount of displacement in pixels
2614that a particular map can produce. If the displacement scale is large enough
2615it is also possible to lookup parts of the 'background' image that lie well
2616outside the bounds of the displacement map itself. That is you could very
2617easily copy a section of the original image from outside the overlay area
2618into the overlay area. </p>
2619
2620<p>The '%' flag makes the displacement scale relative to the size of the
2621overlay image (100% = half width/height of image). Using '!' switches
2622percentage arguments to refer to the destination image size instead.
2623these flags were added as of IM v6.5.3-5.</p>
2624
2625<p>Normally a single grayscale displacement map is provided, which with the
2626given scaling values will determine a single direction (vector) in which
2627displacements can occur (positively or negatively). However, if you also
2628specify a third image which is normally used as a <var>mask</var>,
2629the <var>composite image</var> is used for horizontal X
2630displacement, while the <var>mask image</var> is used for vertical Y
2631displacement. This allows you to define completely different displacement
2632values for the X and Y directions, and allowing you to lookup any point within
2633the <var>scale</var> bounds. In other words each pixel can lookup
2634any other nearby pixel, producing complex 2 dimensional displacements, rather
2635than a simple 1 dimensional vector displacements. </p>
2636
2637<p>Alternatively rather than supplying two separate images, as of IM v6.4.4-0,
2638you can use the 'red' channel of the overlay image to specify the horizontal
2639or X displacement, and the 'green' channel for the vertical or Y displacement.
2640</p>
2641
2642<p>As of IM v6.5.3-5 any alpha channel in the overlay image is used as a
2643mask the transparency of the destination image. However areas outside the
2644overlaid areas will not be effected. </p>
2645
2646
2647<div style="margin: auto;">
2648 <h3 class="magick-header"><a id="display"></a>-display <var>host:display[.screen]</var></h3>
2649</div>
2650
2651<p class="magick-description">Specifies the X server to contact.</p>
2652
2653<p>This option is used with convert for obtaining image or font from this
2654X server. See <var>X(1)</var>.</p>
2655
2656<div style="margin: auto;">
2657 <h3 class="magick-header"><a id="dispose"></a>-dispose <var>method</var></h3>
2658</div>
2659
2660<p class="magick-description">define the GIF disposal image setting for images that are being created or read in. </p>
2661
2662<p>The layer disposal method defines the way each the displayed image is to be
2663modified after the current 'frame' of an animation has finished being
2664displayed (after its 'delay' period), but before the next frame on an
2665animation is to be overlaid onto the display. </p>
2666
2667<p>Here are the valid methods:</p>
2668
2669<dl class="dl-horizontal">
2670<dt>Undefined</dt><dd>0: No disposal specified (equivalent to '<code>none</code>').</dd>
2671<dt>None</dt><dd>1: Do not dispose, just overlay next frame image.</dd>
2672<dt>Background</dt><dd>2: Clear the frame area with the background color.</dd>
2673<dt>Previous</dt><dd>3: Clear to the image prior to this frames overlay.</dd>
2674</dl>
2675
2676<p>You can also use the numbers given above, which is what the GIF format
2677uses internally to represent the above settings. </p>
2678
2679<p>To print a complete list of dispose methods, use <a href="command-line-options.html#list">-list dispose</a>.</p>
2680
Cristy594d2772015-11-15 10:47:42 -05002681<p>Use <a href="command-line-options.html#dispose" >+dispose</a>, turn off the setting and prevent
Cristy882d9f42015-10-29 16:48:39 -04002682resetting the layer disposal methods of images being read in. </p>
2683
2684<p>Use <a href="command-line-options.html#set">-set</a> '<code>dispose</code>' method to set the image
2685disposal method for images already in memory.</p>
2686
2687<div style="margin: auto;">
2688 <h3 class="magick-header"><a id="dissimilarity-threshold"></a>-dissimilarity-threshold <var>value</var></h3>
2689</div>
2690
2691<p class="magick-description">maximum RMSE for subimage match (default 0.2).</p>
2692
2693
2694<div style="margin: auto;">
2695 <h3 class="magick-header"><a id="dissolve"></a>-dissolve <var>src_percent</var>[x<var>dst_percent</var>]</h3>
2696</div>
2697
2698<p class="magick-description">dissolve an image into another by the given percent.</p>
2699
2700<p>The opacity of the composite image is multiplied by the given percent, then
2701it is composited 'over' the main image. If <var>src_percent</var>
2702is greater than 100, start dissolving the main image so it becomes
2703transparent at a value of '<code>200</code>'. If both percentages
2704are given, each image are dissolved to the percentages given. </p>
2705
2706<p>Note that dissolve percentages do not add, two opaque images dissolved
2707'50,50', produce a 75% transparency. For a 50% + 50% blending of the two
2708images, you would need to use dissolve values of '50,100'. </p>
2709
2710<div style="margin: auto;">
2711 <h3 class="magick-header"><a id="distort"></a>-distort <var>method arguments</var></h3>
2712</div>
2713
2714<p class="magick-description">distort an image, using the given <var>method</var> and its required <var>arguments</var>.</p>
2715
2716<p>The <var>arguments</var> is a single string containing a list
2717of floating point numbers separated by commas or spaces. The number of
2718and meaning of the floating point values depends on the distortion <var>method</var> being used. </p>
2719
2720<p>Choose from these distortion types:</p>
2721
2722<table class="table table-condensed table-striped">
2723 <tr>
2724 <th style="width: 8%">Method</th>
2725 <th>Description</th>
2726 </tr>
2727
2728 <tr>
Cristy594d2772015-11-15 10:47:42 -05002729 <td>ScaleRotateTranslate <br/> SRT</td>
Cristy882d9f42015-10-29 16:48:39 -04002730 <td>
2731 Distort image by first scaling and rotating about a given 'center',
2732 before translating that 'center' to the new location, in that order. It
2733 is an alternative method of specifying a 'Affine' type of
2734 distortion, but without shearing effects. It also provides a good way
2735 of rotating and displacing a smaller image for tiling onto a larger
Cristy594d2772015-11-15 10:47:42 -05002736 background (IE 2-dimensional animations). <br/>
Cristy882d9f42015-10-29 16:48:39 -04002737
2738 The number of arguments determine the specific meaning of each
Cristy594d2772015-11-15 10:47:42 -05002739 argument for the scales, rotation, and translation operations. <br/>
Cristy882d9f42015-10-29 16:48:39 -04002740
2741 <dl class="dl-horizontal">
2742 <dt>2:</dt><dd><var>Scale Angle</var></dd>
2743 <dt>3:</dt><dd><var>X,Y Angle</var></dd>
2744 <dt>4:</dt><dd><var>X,Y Scale Angle</var></dd>
2745 <dt>5:</dt> <dd><var>X,Y ScaleX,ScaleY Angle</var></dd>
2746 <dt>6:</dt> <dd><var>X,Y Scale Angle NewX,NewY</var></dd>
2747 <dt>7:</dt> <dd><var>X,Y ScaleX,ScaleY Angle NewX,NewY</var></dd>
2748 </dl>
2749
2750 This is actually an alternative way of specifying a 2 dimensional linear
2751 'Affine' or 'AffineProjection' distortion. </td> </tr>
2752
2753 <tr>
2754 <td>Affine</td>
2755 <td>
2756 Distort the image linearly by moving a list of at least 3 or more sets
2757 of control points (as defined below). Ideally 3 sets or 12 floating
2758 point values are given allowing the image to be linearly scaled,
2759 rotated, sheared, and translated, according to those three points. See
2760 also the related 'AffineProjection' and 'SRT'
Cristy594d2772015-11-15 10:47:42 -05002761 distortions. <br/>
Cristy882d9f42015-10-29 16:48:39 -04002762
2763 More than 3 sets given control point pairs (12 numbers) is least
2764 squares fitted to best match a linear affine distortion. If only 2
2765 control point pairs (8 numbers) are given a two point image translation
2766 rotation and scaling is performed, without any possible shearing,
2767 flipping or changes in aspect ratio to the resulting image. If only one
2768 control point pair is provides the image is only translated, (which may
Cristy594d2772015-11-15 10:47:42 -05002769 be a floating point non-integer translation). <br/>
Cristy882d9f42015-10-29 16:48:39 -04002770
2771 This distortion does not include any form of perspective distortion.
2772 </td>
2773
2774 </tr>
2775
2776 <tr>
2777 <td>AffineProjection</td>
2778 <td>
2779 Linearly distort an image using the given Affine Matrix of 6
2780 pre-calculated coefficients forming a set of Affine Equations to map
2781 the source image to the destination image.
2782
2783 <p class="text-center"><var>
2784 s<sub>x</sub>, r<sub>x</sub>,
2785 r<sub>y</sub>, s<sub>y</sub>,
2786 t<sub>x</sub>, t<sub>y</sub>
2787 </var></p>
2788
Cristy594d2772015-11-15 10:47:42 -05002789 See <a href="command-line-options.html#affine" >-affine</a> setting for more detail, and
2790 meanings of these coefficients. <br/>
Cristy882d9f42015-10-29 16:48:39 -04002791
2792 The distortions 'Affine' and 'SRT' provide
2793 alternative methods of defining this distortion, with ImageMagick doing
2794 the calculations needed to generate the required coefficients. You can
Cristy594d2772015-11-15 10:47:42 -05002795 see the internally generated coefficients, by using a <a
2796 href="command-line-options.html#verbose" >-verbose</a> setting with those other variants. </td>
Cristy882d9f42015-10-29 16:48:39 -04002797
2798 </tr>
2799
2800 <tr>
Cristy594d2772015-11-15 10:47:42 -05002801 <td>BilinearForward<br/>
Cristy882d9f42015-10-29 16:48:39 -04002802 BilinearReverse</td>
2803 <td>
2804 Bilinear Distortion, given a minimum of 4 sets of coordinate pairs, or
2805 16 values (see below). Not that lines may not appear straight after
2806 distortion, though the distance between coordinates will remain
Cristy594d2772015-11-15 10:47:42 -05002807 consistent. <br/>
Cristy882d9f42015-10-29 16:48:39 -04002808
2809 The 'BilinearForward' is used to map rectangles to any
2810 quadrilateral, while the 'BilinearReverse' form maps any
2811 quadrilateral to a rectangle, while preserving the straight line edges
Cristy594d2772015-11-15 10:47:42 -05002812 in each case. <br/>
Cristy882d9f42015-10-29 16:48:39 -04002813
2814 Note that 'BilinearForward' can generate invalid pixels
Cristyf650f4f2016-04-01 10:53:07 -04002815 which will be colored using the <a href="command-line-options.html#alpha-color" >-alpha-color</a>
Cristy882d9f42015-10-29 16:48:39 -04002816 color setting. Also if the quadrilateral becomes 'flipped' the image
Cristy594d2772015-11-15 10:47:42 -05002817 may disappear. <br/>
Cristy882d9f42015-10-29 16:48:39 -04002818
2819 There are future plans to produce a true Bilinear distortion that will
2820 attempt to map any quadrilateral to any other quadrilateral, while
2821 preserving edges (and edge distance ratios).
2822
2823 </td>
2824 </tr>
2825
2826 <tr>
2827 <td>Perspective</td>
2828 <td>
2829 Perspective distort the images, using a list of 4 or more sets of
2830 control points (as defined below). More that 4 sets (16 numbers) of
2831 control points provide least squares fitting for more accurate
2832 distortions (for the purposes of image registration and panorama
2833 effects). Less than 4 sets will fall back to a 'Affine'
Cristy594d2772015-11-15 10:47:42 -05002834 linear distortion. <br/>
Cristy882d9f42015-10-29 16:48:39 -04002835
2836 Perspective Distorted images ensures that straight lines remain
2837 straight, but the scale of the distorted image will vary. The horizon
2838 is anti-aliased, and the 'sky' color may be set using the
Cristyf650f4f2016-04-01 10:53:07 -04002839 <a href="command-line-options.html#alpha-color" >-alpha-color</a> setting. </td>
Cristy882d9f42015-10-29 16:48:39 -04002840 </tr>
2841
2842 <tr>
2843 <td>PerspectiveProjection </td>
2844 <td>
2845 Do a 'Perspective' distortion biased on a set of 8
2846 pre-calculated coefficients. You can get these coefficients by looking
Cristy594d2772015-11-15 10:47:42 -05002847 at the <a href="command-line-options.html#verbose" >-verbose</a> output of a
Cristy882d9f42015-10-29 16:48:39 -04002848 'Perspective' distortion, or by calculating them yourself.
2849 If the last two perspective scaling coefficients are zero, the
2850 remaining 6 represents a transposed 'Affine Matrix'. </td>
2851
2852 </tr>
2853
2854 <tr>
2855 <td>Arc</td>
2856 <td>
2857 Arc the image (variation of polar mapping) over the angle given around
2858 a circle.
2859
Cristy579a0cb2016-11-26 12:27:17 -05002860 <dl class="dl-horizontal">
Cristy882d9f42015-10-29 16:48:39 -04002861 <dt>arc_angle</dt>
2862 <dd>The angle over which to arc the image side-to-side</dd>
2863 <dt>rotate_angle</dt>
2864 <dd>Angle to rotate resulting image from vertical center</dd>
2865 <dt>top_radius</dt>
2866 <dd>Set top edge of source image at this radius</dd>
2867 <dt>bottom_radius </dt>
2868 <dd>Set bottom edge to this radius (radial scaling)</dd>
Cristy579a0cb2016-11-26 12:27:17 -05002869 </dl>
Cristy882d9f42015-10-29 16:48:39 -04002870
2871 The resulting image is always resized to best fit the resulting image,
Cristy594d2772015-11-15 10:47:42 -05002872 (as if using <a href="command-line-options.html#distort" >+distort</a>) while attempting to
Cristy882d9f42015-10-29 16:48:39 -04002873 preserve scale and aspect ratio of the original image as much as
2874 possible with the arguments given by the user. All four arguments will
Cristy594d2772015-11-15 10:47:42 -05002875 be needed to change the overall aspect ratio of an 'Arc'ed image. <br/>
Cristy882d9f42015-10-29 16:48:39 -04002876
2877 This a variation of a polar distortion designed to try to preserve the
2878 aspect ratio of the image rather than direct Cartesian to Polar
2879 conversion. </td>
2880 </tr>
2881
2882 <tr>
2883 <td>Polar</td>
2884 <td>
2885 Like 'Arc' but do a complete Cartesian to Polar mapping of
2886 the image. that is the height of the input image is mapped to the
2887 radius limits, while the width is wrapped around between the
Cristy594d2772015-11-15 10:47:42 -05002888 angle limits. <br/>
Cristy882d9f42015-10-29 16:48:39 -04002889
Cristy594d2772015-11-15 10:47:42 -05002890 Arguments: <var>Rmax,Rmin CenterX,CenterY, start,end_angle</var> <br/>
Cristy882d9f42015-10-29 16:48:39 -04002891
2892 All arguments are optional. With <var>Rmin</var> defaulting to zero, the
2893 center to the center of the image, and the angles going from -180 (top)
2894 to +180 (top). If <var>Rmax</var> is given the special value of
2895 '0', the the distance from the center to the nearest edge
2896 is used for the radius of the output image, which will ensure the whole
2897 image is visible (though scaled smaller). However a special value of
2898 '-1' will use the distance from the center to the furthest
2899 corner, This may 'clip' the corners from the input rectangular image,
2900 but will generate the exact reverse of a 'DePolar' with
Cristy594d2772015-11-15 10:47:42 -05002901 the same arguments. <br/>
Cristy882d9f42015-10-29 16:48:39 -04002902
Cristy594d2772015-11-15 10:47:42 -05002903 If the plus form of distort (<a href="command-line-options.html#distort" >+distort</a>) is used
Cristy882d9f42015-10-29 16:48:39 -04002904 output image center will default to 0,0 of the virtual
2905 canvas, and the image size adjusted to ensure the whole input image is
2906 made visible in the output image on the virtual canvas. </td>
2907
2908 </tr>
2909
2910 <tr>
2911 <td>DePolar</td>
2912 <td>
2913 Uses the same arguments and meanings as a 'Polar' distortion
Cristy594d2772015-11-15 10:47:42 -05002914 but generates the reverse Polar to Cartesian distortion. <br/>
Cristy882d9f42015-10-29 16:48:39 -04002915
2916 The special <var>Rmax</var> setting of '0' may however clip
2917 the corners of the input image. However using the special
2918 <var>Rmax</var> setting of '-1' (maximum center to corner
2919 distance) will ensure the whole distorted image is preserved in the
2920 generated result, so that the same argument to 'Polar' will
2921 reverse the distortion re-producing the original.
2922
2923 Note that as this distortion requires the area resampling of a circular
2924 arc, which can not be handled by the builtin EWA resampling function.
2925 As such the normal EWA filters are turned off. It is recommended some
2926 form of 'super-sampling' image processing technique be used to produce
2927 a high quality result. </td>
2928
2929 </tr>
2930
2931 <tr>
2932 <td>Barrel</td>
2933 <td>
Cristy594d2772015-11-15 10:47:42 -05002934 Given the four coefficients (A,B,C,D) as defined by <a
2935 href="http://wiki.panotools.org/Lens_correction_model" >Helmut
Cristy882d9f42015-10-29 16:48:39 -04002936 Dersch</a>, perform a barrel or pin-cushion distortion appropriate to
2937 correct radial lens distortions. That is in photographs, make straight
Cristy594d2772015-11-15 10:47:42 -05002938 lines straight again. <br/>
Cristy882d9f42015-10-29 16:48:39 -04002939
2940 <p class="text-center">Arguments: <var>A B C</var> [ <var>D</var> [
Cristy594d2772015-11-15 10:47:42 -05002941 <var>X</var> , <var>Y</var> ] ] <br/>
Cristy882d9f42015-10-29 16:48:39 -04002942 or <var>A<sub>x</sub> B<sub>x</sub> C<sub>x</sub> D<sub>x</sub>
2943 A<sub>y</sub> B<sub>y</sub> C<sub>y</sub> D<sub>y</sub></var>
2944 [ <var>X</var> , <var>Y</var> ] </p>
2945 So that it forms the function
2946 <p class="text-center">Rsrc = r * ( <var>A</var>*r<sup>3</sup> + <var>B</var>*r<sup>2</sup> +
2947 <var>C</var>*r + <var>D</var> )</p>
2948
2949 Where <var>X</var>,<var>Y</var> is the optional center of the distortion
Cristy594d2772015-11-15 10:47:42 -05002950 (defaulting to the center of the image). <br/>
Cristy882d9f42015-10-29 16:48:39 -04002951 The second form is typically used to distort images, rather than
Cristy594d2772015-11-15 10:47:42 -05002952 correct lens distortions. <br/>
Cristy882d9f42015-10-29 16:48:39 -04002953 </td>
2954
2955 </tr>
2956
2957 <tr>
2958 <td>BarrelInverse</td>
2959 <td>
2960 This is very similar to 'Barrel' with the same set of
2961 arguments, and argument handling. However it uses the inverse
2962 of the radial polynomial,
2963 so that it forms the function
2964 <p class="text-center">Rsrc = r / ( <var>A</var>*r<sup>3</sup> + <var>B</var>*r<sup>2</sup> +
2965 <var>C</var>*r + <var>D</var> )</p>
2966 Note that this is not the reverse of the 'Barrel'
2967 distortion, just a different barrel-like radial distortion method.
2968
2969 </td>
2970 </tr>
2971
2972 <tr>
2973 <td>Shepards</td>
2974 <td>
2975 Distort the given list control points (any number) using an Inverse
Cristy594d2772015-11-15 10:47:42 -05002976 Squared Distance Interpolation Method (<a
2977 href="http://en.wikipedia.org/wiki/Shepard%27s_method" >Shepards
Cristy882d9f42015-10-29 16:48:39 -04002978 Method</a>). The control points in effect do 'localized' displacement
2979 of the image around the given control point (preserving the look and
2980 the rotation of the area near the control points. For best results
2981 extra control points should be added to 'lock' the positions of the
2982 corners, edges and other unchanging parts of the image, to prevent
Cristy594d2772015-11-15 10:47:42 -05002983 their movement. <br/>
Cristy882d9f42015-10-29 16:48:39 -04002984
2985 The distortion has been likened to 'taffy pulling' using nails, or
2986 pins' stuck in a block of 'jelly' which is then moved to the new
Cristy594d2772015-11-15 10:47:42 -05002987 position, distorting the surface of the jelly. <br/>
Cristy882d9f42015-10-29 16:48:39 -04002988
Cristy594d2772015-11-15 10:47:42 -05002989 Internally it is equivalent to generating a displacement map (see <a
2990 href="command-line-options.html#displace" >-displace</a>) for source image color look-up using
2991 the <a href="command-line-options.html#sparse-color" >-sparse-color</a> method of the same name.
Cristy882d9f42015-10-29 16:48:39 -04002992
2993 </td>
2994 </tr>
2995
2996</table>
2997
2998<p>To print a complete list of distortion methods, use <a href="command-line-options.html#list">-list
2999distort</a>.</p>
3000
3001<p>Many of the above distortion methods such as '<code>Affine</code>',
3002'<code>Perspective</code>', and '<code>Shepards</code>' use a list control points
3003defining how these points in the given image should be distorted in the
3004destination image. Each set of four floating point values represent a source
3005image coordinate, followed immediately by the destination image coordinate.
3006This produces a list of values such as...</p>
3007<p class="text-center"><var>
3008 U<sub>1</sub>,V<sub>1</sub> X<sub>1</sub>,Y<sub>1</sub>
3009 U<sub>2</sub>,V<sub>2</sub> X<sub>2</sub>,Y<sub>2</sub>
3010 U<sub>3</sub>,V<sub>3</sub> X<sub>3</sub>,Y<sub>3</sub>
3011 ...
3012 U<sub>n</sub>,V<sub>n</sub> X<sub>n</sub>,Y<sub>n</sub>
3013</var></p>
3014<p>where <var>U,V</var> on the source image is mapped to <var>X,Y</var> on the
3015destination image. </p>
3016
3017<p>For example, to warp an image using '<code>perspective</code>' distortion,
3018needs a list of at least 4 sets of coordinates, or 16 numbers. Here is the
3019perspective distortion of the built-in "rose:" image. Note how spaces were
3020used to group the 4 sets of coordinate pairs, to make it easier to read and
3021understand.</p>
3022
3023<pre>
3024convert rose: -virtual-pixel black \
3025 -distort Perspective '0,0,0,0 0,45,0,45 69,0,60,10 69,45,60,35' \
3026 rose_3d_rotated.gif"
3027</pre>
3028
3029<p>If more that the required number of coordinate pairs are given for
3030a distortion, the distortion method is 'least squares' fitted to produce the
3031best result for all the coordinate pairs given. If less than the ideal number
3032of points are given, the distort will generally fall back to a simpler form of
3033distortion that can handles the smaller number of coordinates (usually a linear
3034'<code>Affine</code>' distortion). </p>
3035
3036<p>By using more coordinates you can make use of image registration tool to
3037find matching coordinate pairs in overlapping images, so as to improve the
3038'fit' of the distortion. Of course a bad coordinate pair can also make the
3039'fit' worse. Caution is always advised. </p>
3040
3041<p>Colors are acquired from the source image according to a cylindrical
Cristy594d2772015-11-15 10:47:42 -05003042resampling <a href="command-line-options.html#filter" >-filter</a>, using a special technique known as
Cristy882d9f42015-10-29 16:48:39 -04003043EWA resampling. This produces very high quality results, especially when
3044images become smaller (minified) in the output, which is very common when
3045using '<code>perspective</code>' distortion. For example here we view
3046a infinitely tiled 'plane' all the way to the horizon. </p>
3047
3048<pre>
3049convert -size 90x90 pattern:checkerboard -normalize -virtual-pixel tile \
3050 -distort perspective '0,0,5,45 89,0,45,46 0,89,0,89 89,89,89,89' \
3051 checks_tiled.jpg
3052</pre>
3053
3054<p>Note that a infinitely tiled perspective images involving the horizon can
3055be very slow, because of the number of pixels that are compressed to generate
3056each individual pixel close to the 'horizon'. You can turn off EWA
Cristy594d2772015-11-15 10:47:42 -05003057resampling, by specifying the special <a href="command-line-options.html#filter" >-filter</a> setting of
Cristy882d9f42015-10-29 16:48:39 -04003058'<code>point</code>' (recommended if you plan to use super-sampling instead).
3059</p>
3060
3061<p>If an image generates <i>invalid pixels</i>, such as the 'sky' in the last
Cristy594d2772015-11-15 10:47:42 -05003062example, <a href="command-line-options.html#distort" >-distort</a> will use the current <a
Cristyf650f4f2016-04-01 10:53:07 -04003063href="command-line-options.html#alpha-color" >-alpha-color</a> setting for these pixels. If you do not
Cristy882d9f42015-10-29 16:48:39 -04003064what these pixels to be visible, set the color to match the rest of the
3065ground. </p>
3066
3067<p>The output image size will by default be the same as the input image. This
3068means that if the part of the distorted image falls outside the viewed area of
3069the 'distorted space', those parts is clipped and lost. However if you use
Cristy594d2772015-11-15 10:47:42 -05003070the plus form of the operator (<a href="command-line-options.html#distort" >+distort</a>) the operator
Cristy882d9f42015-10-29 16:48:39 -04003071will attempt (if possible) to show the whole of the distorted image, while
3072retaining a correct 'virtual canvas' offset, for image layering. This offset
Cristy594d2772015-11-15 10:47:42 -05003073may need to be removed using <a href="command-line-options.html#repage" >+repage</a>, to remove if it
Cristy882d9f42015-10-29 16:48:39 -04003074is unwanted. </p>
3075
Cristy594d2772015-11-15 10:47:42 -05003076<p>Setting <a href="command-line-options.html#verbose" >-verbose</a> setting, will cause <a
3077href="command-line-options.html#distort" >-distort</a> to attempt to output the internal coefficients,
3078and the <a href="command-line-options.html#fx" >-fx</a> equivalent to the distortion, for expert study,
Cristy882d9f42015-10-29 16:48:39 -04003079and debugging purposes. This many not be available for all distorts. </p>
3080
Cristy594d2772015-11-15 10:47:42 -05003081<p>You can alternatively specify a special "<code><a href="command-line-options.html#define"
3082>-define</a> distort:viewport={geometry_string}</code>" setting which will
Cristy882d9f42015-10-29 16:48:39 -04003083specify the size and the offset of the generated 'viewport' image of the
3084distorted image space.</p>
3085
Cristy594d2772015-11-15 10:47:42 -05003086<p>Setting a "<code><a href="command-line-options.html#define" >-define</a>
Cristy769d8892016-01-19 18:11:14 -05003087distort:scale=<var>scale_factor</var></code>" will scale the output image (viewport or
Cristy882d9f42015-10-29 16:48:39 -04003088otherwise) by that factor without changing the viewed contents of the
3089distorted image. This can be used either for 'super-sampling' the image for
3090a higher quality result, or for panning and zooming around the image (with
3091appropriate viewport changes, or post-distort cropping and resizing). </p>
3092
Cristy594d2772015-11-15 10:47:42 -05003093<p>Setting "<code><a href="command-line-options.html#define" >-define</a> resample:verbose=1</code>"
Cristy882d9f42015-10-29 16:48:39 -04003094will output the cylindrical filter lookup table created by the EWA (Elliptical
3095Weighted Average) resampling algorithm. Note this table uses a squared radius
3096lookup value. This is typically only used for debugging EWA resampling. </p>
3097
3098
3099<div style="margin: auto;">
3100 <h3 class="magick-header"><a id="distribute-cache"></a>-distribute-cache <var>port</var></h3>
3101</div>
3102
3103<p class="magick-description">launch a distributed pixel cache server. </p>
3104
3105<div style="margin: auto;">
3106 <h3 class="magick-header"><a id="dither"></a>-dither <var>method</var></h3>
3107</div>
3108
3109<p class="magick-description">Apply a Riemersma or Floyd-Steinberg error diffusion dither to
3110images when general color reduction is applied via an option, or automagically
3111when saving to specific formats. This enabled by default.</p>
3112
3113<p>Dithering places two or more colors in neighboring pixels so that to the
3114eye a closer approximation of the images original color is reproduced. This
3115reduces the number of colors needed to reproduce the image but at the cost of
3116a lower level pattern of colors. Error diffusion dithers can use any set of
3117colors (generated or user defined) to an image. </p>
3118
3119<p>Dithering is turned on by default, to turn it off use the plus form of the
3120setting, <a href="command-line-options.html#dither">+dither</a>. This will also also render PostScript
3121without text or graphic aliasing. Disabling dithering often (but not always)
3122leads to faster process, a smaller number of colors, but more cartoon like
3123image coloring. Generally resulting in 'color banding' effects in areas with
3124color gradients. </p>
3125
Cristy594d2772015-11-15 10:47:42 -05003126<p>The color reduction operators <a href="command-line-options.html#colors">-colors</a>, <a
3127href="command-line-options.html#monochrome">-monochrome</a>, <a href="command-line-options.html#remap ">-remap</a>, and <a
3128href="command-line-options.html#posterize">-posterize</a>, apply dithering to images using the reduced
Cristy882d9f42015-10-29 16:48:39 -04003129color set they created. These operators are also used as part of automatic
3130color reduction when saving images to formats with limited color support, such
3131as <code>GIF:</code>, <code>XBM:</code>, and others, so dithering may also be used
3132in these cases. </p>
3133
3134<p>Alternatively you can use <a href="command-line-options.html#random-threshold">-random-threshold</a>
Cristy594d2772015-11-15 10:47:42 -05003135to generate purely random dither. Or use <a
3136href="command-line-options.html#ordered-dither">-ordered-dither</a> to apply threshold mapped dither
Cristy882d9f42015-10-29 16:48:39 -04003137patterns, using uniform color maps, rather than specific color maps. </p>
3138
3139
3140<div style="margin: auto;">
3141 <h3 class="magick-header"><a id="draw"></a>-draw <var>string</var></h3>
3142</div>
3143
3144<p class="magick-description">Annotate an image with one or more graphic primitives.</p>
3145
3146<p>Use this option to annotate or decorate an image with one or more graphic
3147primitives. The primitives include shapes, text, transformations, and pixel
3148operations.</p>
3149
3150<p>The shape primitives:</p>
3151
3152<dl class="dl-horizontal">
3153<dt>point</dt><dd> x,y</dd>
3154<dt>line</dt><dd> x0,y0 x1,y1</dd>
3155<dt>rectangle</dt><dd> x0,y0 x1,y1</dd>
3156<dt>roundRectangle</dt><dd> x0,y0 x1,y1 wc,hc</dd>
3157<dt>arc</dt><dd> x0,y0 x1,y1 a0,a1</dd>
3158<dt>ellipse</dt><dd> x0,y0 rx,ry a0,a1</dd>
3159<dt>circle</dt><dd> x0,y0 x1,y1</dd>
3160<dt>polyline</dt><dd> x0,y0 ... xn,yn</dd>
3161<dt>polygon</dt><dd> x0,y0 ... xn,yn</dd>
3162<dt>bezier</dt><dd> x0,y0 ... xn,yn</dd>
3163<dt>path</dt><dd>specification </dd>
3164<dt>image</dt><dd> operator x0,y0 w,h filename</dd>
3165</dl>
3166
3167<p>The text primitive:</p>
3168
3169<dl class="dl-horizontal">
3170<dt>text</dt><dd>x0,y0 string</dd>
3171</dl>
3172<p>The text gravity primitive:</p>
3173
3174<dl class="dl-horizontal">
3175<dt>gravity</dt><dd>NorthWest, North, NorthEast, West, Center, East, SouthWest, South, or SouthEast</dd>
3176</dl>
3177
3178<p>The text gravity primitive only affects the placement of text and does not
Cristy594d2772015-11-15 10:47:42 -05003179interact with the other primitives. It is equivalent to using the <a
3180href="command-line-options.html#gravity">-gravity</a> command-line option, except that it is limited in
Cristy882d9f42015-10-29 16:48:39 -04003181scope to the <a href="command-line-options.html#draw">-draw</a> option in which it appears.</p>
3182
3183<p>The transformation primitives:</p>
3184
3185<dl class="dl-horizontal">
3186<dt>rotate</dt><dd>degrees</dd>
3187<dt>translate</dt><dd>dx,dy</dd>
3188<dt>scale</dt><dd>sx,sy</dd>
3189<dt>skewX</dt><dd>degrees</dd>
3190<dt>skewY</dt><dd>degrees</dd>
3191</dl>
3192
3193<p>The pixel operation primitives:</p>
3194
3195<dl class="dl-horizontal">
3196<dt>color</dt><dd>x0,y0 method</dd>
3197<dt>matte</dt><dd>x0,y0 method</dd>
3198</dl>
3199
Cristy594d2772015-11-15 10:47:42 -05003200<p>The shape primitives are drawn in the color specified by the preceding <a
3201href="command-line-options.html#fill">-fill</a> setting. For unfilled shapes, use <a
3202href="command-line-options.html#fill">-fill none</a>. You can optionally control the stroke (the
3203"outline" of a shape) with the <a href="command-line-options.html#stroke">-stroke</a> and <a
3204href="command-line-options.html#strokewidth">-strokewidth</a> settings.</p>
Cristy882d9f42015-10-29 16:48:39 -04003205
3206<p>A <code>point</code> primitive is specified by a single <var>point</var> in the
3207pixel plane, that is, by an ordered pair of integer coordinates,
3208<var>x</var>,<var>y</var>. (As it involves only a single pixel, a <code>point</code>
Cristy594d2772015-11-15 10:47:42 -05003209primitive is not affected by <a href="command-line-options.html#stroke">-stroke</a> or <a
3210href="command-line-options.html#strokewidth">-strokewidth</a>.)</p>
Cristy882d9f42015-10-29 16:48:39 -04003211
3212<p>A <code>line</code> primitive requires a start point and end point.</p>
3213
3214<p>A <code>rectangle</code> primitive is specified by the pair of points at the
3215upper left and lower right corners.</p>
3216
3217<p>A <code>roundRectangle</code> primitive takes the same corner points as
3218a <code>rectangle</code> followed by the width and height of the rounded corners
3219to be removed.</p>
3220
3221<p>The <code>circle</code> primitive makes a disk (filled) or circle (unfilled).
3222Give the center and any point on the perimeter (boundary).</p>
3223
3224<p>The <code>arc</code> primitive is used to inscribe an elliptical segment in
3225to a given rectangle. An <code>arc</code> requires the two corners used for
3226<code>rectangle</code> (see above) followed by the start and end angles of the
3227arc of the segment segment (e.g. 130,30 200,100 45,90). The start and end
3228points produced are then joined with a line segment and the resulting segment
3229of an ellipse is filled.</p>
3230
3231<p>Use <code>ellipse</code> to draw a partial (or whole) ellipse. Give the
3232center point, the horizontal and vertical "radii" (the <var>semi-axes</var> of
3233the ellipse) and start and end angles in degrees (e.g. 100,100 100,150
32340,360).</p>
3235
3236<p>The <code>polyline</code> and <code>polygon</code> primitives require three or
3237more points to define their perimeters. A <code>polyline</code> is simply
3238a <code>polygon</code> in which the final point is not stroked to the start
Cristy594d2772015-11-15 10:47:42 -05003239point. When unfilled, this is a <var>polygonal line</var>. If the <a
3240href="command-line-options.html#stroke">-stroke</a> setting is <code>none</code> (the default), then
Cristy882d9f42015-10-29 16:48:39 -04003241a <code>polyline</code> is identical to a <code>polygon</code>. </p>
3242
3243<p>A <var>coordinate</var> is a pair of integers separated by a space or
3244optional comma. </p>
3245
3246<p>As an example, to define a circle centered at 100,100 that extends to
3247150,150 use:</p>
3248
3249<pre>
3250-draw 'circle 100,100 150,150'
3251</pre>
3252
3253<p>The <code>Bezier</code> primitive creates a spline curve and requires three
3254or points to define its shape. The first and last points are the
3255<var>knots</var> and these points are attained by the curve, while any
3256intermediate coordinates are <var>control points</var>. If two control points
3257are specified, the line between each end knot and its sequentially respective
3258control point determines the tangent direction of the curve at that end. If
3259one control point is specified, the lines from the end knots to the one
3260control point determines the tangent directions of the curve at each end. If
3261more than two control points are specified, then the additional control points
3262act in combination to determine the intermediate shape of the curve. In order
3263to draw complex curves, it is highly recommended either to use the
3264<code>path</code> primitive or to draw multiple four-point bezier segments with
3265the start and end knots of each successive segment repeated. For example:</p>
3266
3267<pre>
3268-draw 'bezier 20,50 45,100 45,0 70,50'
3269-draw 'bezier 70,50 95,100 95,0 120,50'
3270</pre>
3271
3272<p>A <code>path</code> represents an outline of an object, defined in terms of
3273moveto (set a new current point), lineto (draw a straight line), curveto (draw
3274a Bezier curve), arc (elliptical or circular arc) and closepath (close the
3275current shape by drawing a line to the last moveto) elements. Compound paths
3276(i.e., a path with subpaths, each consisting of a single moveto followed by
3277one or more line or curve operations) are possible to allow effects such as
Cristy594d2772015-11-15 10:47:42 -05003278<var>donut holes</var> in objects. (See <a
3279href="http://www.w3.org/TR/SVG/paths.html">Paths</a>.)</p>
Cristy882d9f42015-10-29 16:48:39 -04003280
3281<p>Use <code>image</code> to composite an image with another image. Follow the
3282image keyword with the composite operator, image location, image size, and
3283filename:</p>
3284
3285<pre>
3286-draw 'image SrcOver 100,100 225,225 image.jpg'
3287</pre>
3288
3289<p>You can use 0,0 for the image size, which means to use the actual
3290dimensions found in the image header. Otherwise, it is scaled to the given
Cristy6549abb2016-11-10 08:25:55 -05003291dimensions. See <a href="http://www.imagemagick.org/www/compose.html">Alpha Compositing</a> for
Cristy882d9f42015-10-29 16:48:39 -04003292a detailed discussion of alpha composition methods that are available. </p>
3293
3294<p>The "special augmented compose operators" such as "dissolve" that require
3295arguments cannot be used at present with the <code>-draw image</code> option.
3296 </p>
3297
3298<p>Use <code>text</code> to annotate an image with text. Follow the text
3299coordinates with a string. If the string has embedded spaces, enclose it in
3300single or double quotes.</p>
3301
3302<p>For example, the following annotates the image with <code>Works like
3303magick!</code> for an image titled <code>bird.miff</code>. </p>
3304
3305<pre>
3306-draw "text 100,100 'Works like magick!' "
3307</pre>
3308
3309<p>See the <a href="command-line-options.html#annotate">-annotate</a> option for another convenient way
3310to annotate an image with text.</p>
3311
3312<p>The <code>rotate</code> primitive rotates subsequent shape primitives and
Cristy594d2772015-11-15 10:47:42 -05003313text primitives about the origin of the main image. If the <a
3314href="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 -04003315option, the origin for transformations is the upper left corner of the
3316region.</p>
3317
3318<p>The <code>translate</code> primitive translates subsequent shape and text
3319primitives.</p>
3320
3321<p>The <code>scale</code> primitive scales them.</p>
3322
3323<p>The <code>skewX</code> and <code>skewY</code> primitives skew them with respect
3324to the origin of the main image or the region.</p>
3325
3326<p>The transformations modify the current affine matrix, which is initialized
3327from the initial affine matrix defined by the <a href="command-line-options.html#affine">-affine</a>
3328option. Transformations are cumulative within the <a href="command-line-options.html#draw">-draw</a>
3329option. The initial affine matrix is not affected; that matrix is only changed
3330by the appearance of another <a href="command-line-options.html#affine">-affine</a> option. If another
3331<a href="command-line-options.html#draw">-draw</a> option appears, the current affine matrix is
3332reinitialized from the initial affine matrix.</p>
3333
3334<p>Use the <code>color</code> primitive to change the color of a pixel to the
3335fill color (see <a href="command-line-options.html#fill">-fill</a>). Follow the pixel coordinate with
3336a method:</p>
3337
3338<pre>
3339point
3340replace
3341floodfill
3342filltoborder
3343reset
3344</pre>
3345
3346<p>Consider the target pixel as that specified by your coordinate. The
3347<code>point</code> method recolors the target pixel. The <code>replace</code>
3348method recolors any pixel that matches the color of the target pixel.
3349<code>Floodfill</code> recolors any pixel that matches the color of the target
3350pixel and is a neighbor, whereas <code>filltoborder</code> recolors any neighbor
3351pixel that is not the border color. Finally, <code>reset</code> recolors all
3352pixels.</p>
3353
3354<p>Use <code>matte</code> to the change the pixel matte value to transparent.
3355Follow the pixel coordinate with a method (see the <code>color</code> primitive
3356for a description of methods). The <code>point</code> method changes the matte
3357value of the target pixel. The <code>replace</code> method changes the matte
3358value of any pixel that matches the color of the target pixel.
3359<code>Floodfill</code> changes the matte value of any pixel that matches the
3360color of the target pixel and is a neighbor, whereas <code>filltoborder</code>
Cristy594d2772015-11-15 10:47:42 -05003361changes the matte value of any neighbor pixel that is not the border color (<a
3362href="command-line-options.html#bordercolor">-bordercolor</a>). Finally <code>reset</code> changes the
Cristy882d9f42015-10-29 16:48:39 -04003363matte value of all pixels.</p>
3364
Cristy594d2772015-11-15 10:47:42 -05003365<p>You can set the primitive color, font, and font bounding box color with <a
3366href="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 -04003367respectively. Options are processed in command line order so be sure to use
3368these options <var>before</var> the <a href="command-line-options.html#draw">-draw</a> option.</p>
3369
3370<p>Strings that begin with a number must be quoted (e.g. use '1.png' rather
3371than 1.png).</p>
3372
Cristy594d2772015-11-15 10:47:42 -05003373<p>Drawing primitives conform to the <a href="magick-vector-graphics.html" >Magick
Cristy882d9f42015-10-29 16:48:39 -04003374Vector Graphics</a> format.</p>
3375
3376
3377<div style="margin: auto;">
3378 <h3 class="magick-header"><a id="duplicate"></a>-duplicate <var>count,indexes</var></h3>
3379</div>
3380
3381<p class="magick-description">duplicate an image one or more times.</p>
3382
3383<p>Specify the count and the image to duplicate by its index in the sequence.
3384The first image is index 0. Negative indexes are relative to the end of the
3385sequence, for example, -1 represents the last image of the sequence. Specify
3386a range of images with a dash (e.g. 0-4). Separate indexes with a comma (e.g.
33870,2). Use <code>+duplicate</code> to duplicate the last image in the current
3388image sequence.</p>
3389
3390<div style="margin: auto;">
3391 <h3 class="magick-header"><a id="edge"></a>-edge <var>radius</var></h3>
3392</div>
3393
3394<p class="magick-description">detect edges within an image.</p>
3395
3396<div style="margin: auto;">
3397 <h3 class="magick-header"><a id="emboss"></a>-emboss <var>radius</var></h3>
3398</div>
3399
3400<p class="magick-description">emboss an image.</p>
3401
3402<div style="margin: auto;">
3403 <h3 class="magick-header"><a id="encipher"></a>-encipher <var>filename</var></h3>
3404</div>
3405
3406<p class="magick-description">Encipher pixels for later deciphering by <a href="command-line-options.html#decipher">-decipher</a>.</p>
3407
3408<p>Get the passphrase from the file specified by <var>filename</var>.</p>
3409
Cristy594d2772015-11-15 10:47:42 -05003410<p>For more information, see the webpage, <a
Cristy6549abb2016-11-10 08:25:55 -05003411href="https://www.imagemagick.org/script/cipher.html">ImageMagick: Encipher or
Cristy882d9f42015-10-29 16:48:39 -04003412Decipher an Image</a>.</p>
3413
3414
3415
3416<div style="margin: auto;">
3417 <h3 class="magick-header"><a id="encoding"></a>-encoding <var>type</var></h3>
3418</div>
3419
3420<p class="magick-description">specify the text encoding.</p>
3421
3422<p>Choose from</p>
3423
3424<pre>
3425AdobeCustom AdobeExpert
3426AdobeStandard AppleRoman
3427BIG5 GB2312
3428Latin 2 None
3429SJIScode Symbol
3430Unicode Wansung
3431</pre>
3432
3433<div style="margin: auto;">
3434 <h3 class="magick-header"><a id="endian"></a>-endian <var>type</var></h3>
3435</div>
3436
3437<p class="magick-description">Specify endianness (<code>MSB</code> or <code>LSB</code>) of the image.</p>
3438
3439<p>To print a complete list of endian types, use the <a href="command-line-options.html#list">-list endian</a> option.</p>
3440
3441<p>Use <a href="command-line-options.html#endian">+endian</a> to revert to unspecified endianness.</p>
3442
3443
3444<div style="margin: auto;">
3445 <h3 class="magick-header"><a id="enhance"></a>-enhance</h3>
3446</div>
3447
3448<p class="magick-description">Apply a digital filter to enhance a noisy image.</p>
3449
3450
3451<div style="margin: auto;">
3452 <h3 class="magick-header"><a id="equalize"></a>-equalize</h3>
3453</div>
3454
3455<p class="magick-description">perform histogram equalization on the image channel-by-channel.</p>
3456
3457<p>To perform histogram equalization on all channels in concert, transform the
3458image into some other color space, such as HSL, OHTA, YIQ or YUV, then
3459equalize the appropriate intensity-like channel, then convert back to RGB.</p>
3460
3461<p>For example using HSL, we have: ... <code>-colorspace HSL -channel lightness
3462-equalize -colorspace RGB</code> ...</p>
3463
3464<p>For YIQ, YUV and OHTA use the red channel. For example, OHTA is a principal
3465components transformation that puts most of the information in the first
3466channel. Here we have ... <code>-colorspace OHTA -channel red -equalize
3467-colorspace RGB</code> ...</p>
3468
3469<div style="margin: auto;">
3470 <h3 class="magick-header"><a id="evaluate"></a>-evaluate <var>operator value</var></h3>
3471</div>
3472
3473<p class="magick-description">Alter channel pixels by evaluating an arithmetic, relational, or logical expression.</p>
3474
Cristy594d2772015-11-15 10:47:42 -05003475<p>(See the <a href="command-line-options.html#function" >-function</a> operator for some
3476multi-parameter functions. See the <a href="command-line-options.html#fx" >-fx</a> operator if more
Cristy882d9f42015-10-29 16:48:39 -04003477elaborate calculations are needed.)</p>
3478
3479<p>The behaviors of each <var>operator</var> are summarized in the
3480following list. For brevity, the numerical value of a "pixel" referred to
3481below is the value of the corresponding channel of that pixel, while
3482a "normalized pixel" is that number divided by the maximum
3483(installation-dependent) value <var>QuantumRange</var>. (If
3484normalized pixels are used, they are restored, following the other
3485calculations, to the full range by multiplying by <var>QuantumRange</var>.)</p>
3486
3487<table class="table table-condensed table-striped">
Cristy594d2772015-11-15 10:47:42 -05003488 <col width="25%" />
3489 <col width="75%" />
Cristy882d9f42015-10-29 16:48:39 -04003490 <thead>
3491 <tr>
3492 <th><var>operator</var></th>
3493 <th>Summary (see further below for details)</th>
3494 </tr>
3495 </thead>
3496 <tbody>
3497
3498 <tr><td>Abs </td> <td>Add <var>value</var> to pixels and return absolute value. </td></tr>
3499 <tr><td>Add </td> <td>Add <var>value</var> to pixels. </td></tr>
3500 <tr><td>AddModulus </td> <td>Add <var>value</var> to pixels modulo <var>QuantumRange</var>.</td></tr>
3501 <tr><td>And </td> <td>Binary AND of pixels with <var>value</var>.</td></tr>
3502 <tr><td>Cos, Cosine </td> <td>Apply cosine to pixels with frequency <var>value</var> with 50% bias added.</td></tr>
3503 <tr><td>Divide </td> <td>Divide pixels by <var>value</var>.</td></tr>
3504 <tr><td>Exp </td> <td>base-e exponential function</td></tr>
3505 <tr><td>Exponential </td> <td>base-e exponential function</td></tr>
3506 <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>
3507 <tr><td>Log </td> <td>Apply scaled logarithm to normalized pixels.</td></tr>
3508 <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>
3509 <tr><td>Mean </td> <td>Add the <var>value</var> and divide by 2.</td></tr>
3510 <tr><td>Median </td> <td>Choose the median value from an image sequence.</td></tr>
3511 <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>
3512 <tr><td>Multiply </td> <td>Multiply pixels by <var>value</var>.</td></tr>
3513 <tr><td>Or </td> <td>Binary OR of pixels with <var>value</var>.</td></tr>
3514 <tr><td>Pow </td> <td>Raise normalized pixels to the power <var>value</var>.</td></tr>
3515 <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>
3516 <tr><td>RMS</td> <td>Square the pixel and add the <var>value</var>.</td></tr>
3517 <tr><td>RootMeanSquare</td> <td>Square the pixel and add the <var>value</var>.</td></tr>
3518 <tr><td>Set </td> <td>Set pixel equal to <var>value</var>.</td></tr>
3519 <tr><td>Sin, Sine </td> <td>Apply sine to pixels with frequency <var>value</var> with 50% bias added.</td></tr>
3520 <tr><td>Subtract </td> <td>Subtract <var>value</var> from pixels.</td></tr>
3521 <tr><td>Xor </td> <td>Binary XOR of pixels with <var>value.</var></td></tr>
3522
3523 <tr><td> </td><td> </td></tr>
3524
3525 <tr><td>Gaussian-noise</td><td> </td></tr>
3526 <tr><td>Impulse-noise</td><td> </td></tr>
3527 <tr><td>Laplacian-noise</td><td> </td></tr>
Cristy594d2772015-11-15 10:47:42 -05003528 <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 -04003529 <tr><td>PoissonNoise</td><td> </td></tr>
3530 <tr><td>Uniform-noise</td><td> </td></tr>
3531
3532 <tr><td> </td><td> </td></tr>
3533
3534 <tr><td>Threshold </td> <td>Threshold pixels larger than <var>value</var>.</td></tr>
3535 <tr><td>ThresholdBlack </td> <td>Threshold pixels to zero values equal to or below <var>value</var>.</td></tr>
3536 <tr><td>ThresholdWhite </td> <td>Threshold pixels to maximum values above <var>value</var>. </td></tr>
3537 </tbody>
3538 </table>
3539
Cristy594d2772015-11-15 10:47:42 -05003540<p>The specified functions are applied only to each previously set <a
3541href="command-line-options.html#channel" >-channel</a> in the image. If necessary, the results of the
Cristy882d9f42015-10-29 16:48:39 -04003542calculations are truncated (clipped) to fit in the interval [0, <var>QuantumRange</var>]. The transparency channel of the image is
3543represented as a 'alpha' values (0 = fully transparent), so, for example, a
3544<code>Divide</code> by 2 of the alpha channel will make the image
3545semi-transparent. Append the percent symbol '<code>%</code>' to specify a value
3546as a percentage of the <var>QuantumRange</var>.</p>
3547
3548<p>To print a complete list of <a href="command-line-options.html#evaluate">-evaluate</a> operators, use
3549<a href="command-line-options.html#list">-list evaluate</a>.</p>
3550
3551<p>The results of the <code>Add</code>, <code>Subtract</code> and
Cristy594d2772015-11-15 10:47:42 -05003552<code>Multiply</code> methods can also be achieved using either the <a
3553href="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 -04003554appropriate argument, to linearly modify the overall range of color values.
Cristy594d2772015-11-15 10:47:42 -05003555Please note, however, that <a href="command-line-options.html#level" >-level</a> treats transparency as
3556'matte' values (0 = opaque), while <a href="command-line-options.html#level" >-evaluate</a> works with
Cristy882d9f42015-10-29 16:48:39 -04003557'alpha' values.</p>
3558
3559<p><code>AddModulus</code> has been added as of ImageMagick 6.4.8-4 and provides
3560addition modulo the <var>QuantumRange</var>. It is therefore
3561equivalent to <code>Add</code> unless the resulting pixel value is outside the
3562interval [0, <var>QuantumRange</var>]. </p>
3563
3564<p><code>Exp or Exponential</code> has been added as of ImageMagick 6.6.5-1 and
3565works on normalized pixel values. The <var>value</var> used with
3566<code>Exp</code> should be negative so as to produce a decaying exponential
3567function. Non-negative values will always produce results larger unity and
3568thus outside the interval [0, <var>QuantumRange</var>]. The
3569formula is expressed below. </p>
3570
3571<p class="text-center">
3572exp(<var>value</var> × <b><var>u</var></b>)
3573</p>
3574
Cristy594d2772015-11-15 10:47:42 -05003575<p> If the input image is squared, for example, using <a href="command-line-options.html#-function"
3576>-function polynomial "2 0 0"</a>, then a decaying Gaussian function will be
Cristy882d9f42015-10-29 16:48:39 -04003577the result.</p>
3578
3579<p><code>Log</code> has been added as of ImageMagick 6.4.2-1 and works on
3580normalized pixel values. This a <var>scaled</var> log function. The <var>value</var> used with <code>Log</code> provides a <var>scaling
3581factor</var> that adjusts the curvature in the graph of the log function. The
3582formula applied to a normalized value <b><var>u</var></b> is below. </p>
3583
3584<p class="text-center">
3585log(<var>value</var> × <b><var>u</var></b> + 1) / log(<var>value</var> + 1)
3586</p>
3587
3588<p><code>Pow</code> has been added as of ImageMagick 6.4.1-9, and works on
Cristy594d2772015-11-15 10:47:42 -05003589normalized pixel values. Note that <code>Pow</code> is related to the <a
3590href="command-line-options.html#gamma" >-gamma</a> operator. For example, <b>-gamma 2</b> is equivalent
Cristy882d9f42015-10-29 16:48:39 -04003591to <b>-evaluate pow 0.5</b>, i.e., a 'square root' function. The value used
Cristy594d2772015-11-15 10:47:42 -05003592with <a href="command-line-options.html#gamma" >-gamma</a> is simply the reciprocal of the value used
Cristy882d9f42015-10-29 16:48:39 -04003593with <code>Pow</code>.</p>
3594
3595<p><code>Cosine</code> and <code>Sine</code> was added as of IM v6.4.8-8 and
3596converts the image values into a value according to a (co)sine wave function.
3597The synonyms <code>Cos</code> and <code>Sin</code> may also be used. The output
3598is biased 50% and normalized by 50% so as to fit in the respective color value
3599range. The <var>value</var> scaling of the <var>period</var> of the
3600function (its frequency), and thus determines the number of 'waves' that will
3601be 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,
3602then the effective period is the <var>half</var> the <var>QuantumRange</var>.</p>
3603
3604<p class="text-center">
36050.5 + 0.5 × cos(2 π <b><var>u</var></b> × <var>value</var>).
3606</p>
3607
Cristy594d2772015-11-15 10:47:42 -05003608<p>See also the <a href="command-line-options.html#function" >-function</a> operator, which is a
Cristy882d9f42015-10-29 16:48:39 -04003609multi-value version of evaluate. </p>
3610
3611<div style="margin: auto;">
3612 <h3 class="magick-header"><a id="evaluate-sequence"></a>-evaluate-sequence <var>operator</var></h3>
3613</div>
3614
3615<p class="magick-description">Alter channel pixels by evaluating an arithmetic, relational, or
3616logical expression over a sequence of images.</p>
3617
Cristy594d2772015-11-15 10:47:42 -05003618<p>To print a complete list of <a
3619href="command-line-options.html#evaluate-sequence">-evaluate-sequence</a> operators, use <a
3620href="command-line-options.html#list">-list evaluate</a>.</p>
Cristy882d9f42015-10-29 16:48:39 -04003621
3622<div style="margin: auto;">
3623 <h3 class="magick-header"><a id="extent"></a>-extent <var>geometry</var></h3>
3624</div>
3625
3626<p class="magick-description">Set the image size and offset.</p>
3627
3628<p>If the image is enlarged, unfilled areas are set to the background color.
3629To position the image, use offsets in the <var>geometry</var>
3630specification or precede with a <a href="command-line-options.html#gravity">-gravity</a> setting. To
Cristy594d2772015-11-15 10:47:42 -05003631specify how to compose the image with the background, use <a href="command-line-options.html#compose"
3632>-compose</a>.</p>
Cristy882d9f42015-10-29 16:48:39 -04003633
3634<p>This command reduces or expands a JPEG image to fit on an 800x600
3635display. If the aspect ratio of the input image isn't exactly 4:3, then the
3636image is centered on an 800x600 black canvas: </p>
3637
3638<pre>
3639convert input.jpg -resize 800x600 -background black -compose Copy \
3640 -gravity center -extent 800x600 -quality 92 output.jpg
3641</pre>
3642
3643<p>See <a href="command-line-processing.html#geometry">Image Geometry</a> for complete details about the <em class="arg">geometry</em> argument.</p>
3644
3645<div style="margin: auto;">
3646 <h3 class="magick-header"><a id="extract"></a>-extract <var>geometry</var></h3>
3647</div>
3648
3649<p class="magick-description">Extract the specified area from image.</p>
3650
3651<p>This option is most useful for extracting a subregion of a very large raw
3652image. Note that these two commands are equivalent:</p>
3653
3654<pre>
3655convert -size 16000x16000 -depth 8 -extract 640x480+1280+960 \
3656 image.rgb image.png",
3657convert -size 16000x16000 -depth 8 'image.rgb[640x480+1280+960]' \
3658 image.rgb image.png"
3659</pre>
3660
3661<p>If you omit the offsets, as in</p>
3662
3663<pre>
3664convert -size 16000x16000 -depth 8 -extract 640x480 \
3665 image.rgb image.png
3666</pre>
3667
3668<p>the image is <var>resized</var> to the specified dimensions instead,
3669equivalent to:</p>
3670
3671<pre>
3672convert -size 16000x16000 -depth 8 -resize 640x480 image.rgb image.png
3673</pre>
3674
3675<p>See <a href="command-line-processing.html#geometry">Image Geometry</a> for complete details about the <em class="arg">geometry</em> argument.</p>
3676
3677<div style="margin: auto;">
3678 <h3 class="magick-header"><a id="family"></a>-family <var>fontFamily</var></h3>
3679</div>
3680
3681<p class="magick-description">Set a font family for text.</p>
3682
3683<p>This setting suggests a font family that ImageMagick should try to use for
3684rendering text. If the family can be found it is used; if not, a default font
3685(e.g., "Arial") or a family known to be similar is substituted (e.g.,
3686"Courier" might be used if "System" is requested but not found). </p>
3687
Cristy594d2772015-11-15 10:47:42 -05003688<p>For other settings that affect fonts, see the options <a
3689href="command-line-options.html#font">-font</a>, <a href="command-line-options.html#stretch">-stretch</a>, <a
3690href="command-line-options.html#style">-style</a>, and <a href="command-line-options.html#weight">-weight</a>. </p>
Cristy882d9f42015-10-29 16:48:39 -04003691
3692<div style="margin: auto;">
3693 <h3 class="magick-header"><a id="features"></a>-features <var>distance</var></h3>
3694</div>
3695
3696<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>
3697
3698<pre>
3699Angular Second Moment Sum Entropy
3700Contrast Entropy
3701Correlation Difference Variance
3702Sum of Squares Variance Difference Entropy
3703Inverse Difference Moment Information Measure of Correlation 1
3704Sum Average Information Measure of Correlation 2
3705Sum Variance Maximum Correlation Coefficient
3706</pre>
3707
3708<div style="margin: auto;">
3709 <h3 class="magick-header"><a id="fft"></a>-fft</h3>
3710</div>
3711
3712<p class="magick-description">implements the forward discrete Fourier transform (DFT).</p>
3713
3714<p>This option is new as of ImageMagick 6.5.4-3 (and now working for Windows
3715users in ImageMagick 6.6.0-9). It transforms an image from the normal
3716(spatial) domain to the frequency domain. In the frequency domain, an image is
3717represented as a superposition of complex sinusoidal waves of varying
3718amplitudes. The image x and y coordinates are the possible frequencies along
3719the x and y directions, respectively, and the pixel intensity values are
3720complex numbers that correspond to the sinusoidal wave amplitudes. See for
3721example, <a href="http://en.wikipedia.org/wiki/Fourier_transform">Fourier
3722Transform</a>, <a href="http://en.wikipedia.org/wiki/DFT">Discrete Fourier
3723Transform</a> and <a href="http://en.wikipedia.org/wiki/FFT">Fast Fourier
3724Transform</a>.</p>
3725
3726<p>A single image name is provided as output for this option. However, the
3727output result will have two components. It is either a two-frame image or two
3728separate images, depending upon whether the image format specified supports
3729multi-frame images. The reason that we get a dual output result is because the
3730frequency domain represents an image using complex numbers, which cannot be
3731visualized directly. Therefore, the complex values are automagically separated
3732into a two-component image representation. The first component is the
3733magnitude of the complex number and the second is the phase of the complex
Cristy594d2772015-11-15 10:47:42 -05003734number. See for example, <a
3735href="http://en.wikipedia.org/wiki/Complex_numbers">Complex Numbers</a>.</p>
Cristy882d9f42015-10-29 16:48:39 -04003736
3737<p>The magnitude and phase component images must be specified using image
3738formats that do not limit the color or compress the image. Thus, MIFF, TIF,
3739PFM, EXR and PNG are the recommended image formats to use. All of these
3740formats, except PNG support multi-frame images. So for example,</p>
3741
3742<pre>
3743convert image.png -fft fft_image.miff
3744</pre>
3745
3746<p>generates a magnitude image as <code>fft_image.miff[0]</code> and a phase
3747image as <code>fft_image.miff[1]</code>. Similarly,</p>
3748
3749<pre>
3750convert image.png -fft fft_image.png
3751</pre>
3752
3753<p>generates a magnitude image as <code>fft_image-0.png</code> and a phase image
3754as <code>fft_image-1.png</code>. If you prefer this representation, then you can
Cristy594d2772015-11-15 10:47:42 -05003755force any of the other formats to produce two output images by including <a
3756href="command-line-options.html#adjoin">+adjoin</a> following -fft in the command line.</p>
Cristy882d9f42015-10-29 16:48:39 -04003757
3758<p>The input image can be any size, but if not square and even-dimensioned, it
3759is padded automagically to the larger of the width or height of the input
3760image and to an even number of pixels. The padding will occur at the bottom
3761and/or right sides of the input image. The resulting output magnitude and
Cristy594d2772015-11-15 10:47:42 -05003762phase images is square at this size. The kind of padding relies on the <a
3763href="command-line-options.html#virtual-pixel">-virtual-pixel</a> setting.</p>
Cristy882d9f42015-10-29 16:48:39 -04003764
3765<p>Both output components will have dynamic ranges that fit within
3766[0, <var>QuantumRange</var>], so that HDRI need not be enabled.
3767Phase values nominally range from 0 to 2*π, but is scaled to span the full
3768dynamic range. (The first few releases had non-HDRI scaled but HDRI not
3769scaled). The magnitude image is not scaled and thus generally will contain
3770very small values. As such, the image normally will appear totally black. In
3771order to view any detail, the magnitude image typically is enhanced with a log
3772function into what is usually called the spectrum. A log function is used to
3773enhance the darker values more in comparison to the lighter values. This can
3774be done, for example, as follows:</p>
3775
3776<pre>
3777convert fft_image.miff[0] -contrast-stretch 0 \
3778 -evaluate log 1000 fft_image_spectrum.png"
3779</pre>
3780
Cristy594d2772015-11-15 10:47:42 -05003781<p>where either <a href="command-line-options.html#contrast-stretch">-contrast-stretch</a> 0 or <a
3782href="command-line-options.html#auto-level">-auto-level</a> is used to scale the image to full dynamic
Cristy882d9f42015-10-29 16:48:39 -04003783range, first. The argument to the <a href="command-line-options.html#evaluate">-evaluate</a> log
3784typically is specified between 100 and 10,000, depending upon the amount of
3785detail that one wants to bring out in the spectrum. Larger values produce more
3786visible detail. Too much detail, however, may hide the important features.</p>
3787
3788<p>The <a href="http://www.fftw.org/">FFTW</a> delegate library is required to
3789use <a href="command-line-options.html#fft">-fft</a>.</p>
3790
3791<p>Use <a href="command-line-options.html#fft">+fft</a> to produce two output images that are the real
3792and imaginary components of the complex valued Fourier transform.</p>
3793
3794<p>However, as the real and imaginary components can contain negative values,
3795this requires that IM be configured with HDRI enabled. In this case, you must
3796use either MIFF, TIF, PFM or MPC formats for the real and imaginary component
3797results, since they are formats that preserve both negative and fractional
3798values without clipping them or truncating the fractional part. With either
3799MIFF or TIF, one should add -define quantum:format=32, to allow those image
3800types to work properly in HDRI mode without clipping.</p>
3801
Cristy594d2772015-11-15 10:47:42 -05003802<p>The real and imaginary component images resulting from <a
3803href="command-line-options.html#fft">+fft</a> are also square, even dimensioned images due to the same
Cristy882d9f42015-10-29 16:48:39 -04003804padding that was discussed above for the magnitude and phase component
3805images.</p>
3806
Cristy594d2772015-11-15 10:47:42 -05003807<p>See the discussion on HDRI implementations of ImageMagick on the page <a
3808href="high-dynamic-range.html" >High Dynamic-Range Images</a>. For more
3809about HDRI go the ImageMagick <a
Cristy364a72f2016-11-04 22:38:41 -04003810href="https://www.imagemagick.org/Usage/basics/#hdri" >Usage</a> pages, <a
Cristy594d2772015-11-15 10:47:42 -05003811href="http://www.fmwconcepts.com/imagemagick/fourier_transforms/fourier.html"
3812>Fred's Fourier Processing With ImageMagick page</a> or this <a
3813 href="http://en.wikipedia.org/wiki/High_dynamic_range_imaging" >Wikipedia</a>
Cristy882d9f42015-10-29 16:48:39 -04003814 entry. </p>
3815
Cristy594d2772015-11-15 10:47:42 -05003816<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 -04003817
3818
3819<div style="margin: auto;">
3820 <h3 class="magick-header"><a id="fill"></a>-fill <var>color</var></h3>
3821</div>
3822
3823<p class="magick-description">color to use when filling a graphic primitive.</p>
3824
3825<p>This option accepts a color name, a hex color, or a numerical RGB, RGBA,
Cristy594d2772015-11-15 10:47:42 -05003826HSL, HSLA, CMYK, or CMYKA specification. See <a href="color.html" >Color Names</a> for
Cristy882d9f42015-10-29 16:48:39 -04003827a description of how to properly specify the color argument.</p>
3828
3829<p>Enclose the color specification in quotation marks to prevent the "#" or
3830the parentheses from being interpreted by your shell.</p>
3831
3832<p>For example,</p>
3833
3834<pre>
3835-fill blue
3836-fill "#ddddff"
3837-fill "rgb(255,255,255)"
3838</pre>
3839
3840<p>See <a href="command-line-options.html#draw">-draw</a> for further details.</p>
3841
3842<p>To print a complete list of color names, use the <a href="command-line-options.html#list">-list color</a> option.</p>
3843
3844<div style="margin: auto;">
3845 <h3 class="magick-header"><a id="filter"></a>-filter <var>type</var></h3>
3846</div>
3847
3848<p class="magick-description">Use this <var>type</var> of filter when resizing or distorting an image.</p>
3849
3850<p>Use this option to affect the resizing operation of an image during
Cristy594d2772015-11-15 10:47:42 -05003851operations such as <a href="command-line-options.html#resize">-resize</a> and <a href="command-line-options.html#distort"
3852>-distort</a>. For example you can use a simple resize filter such as:</p>
Cristy882d9f42015-10-29 16:48:39 -04003853
3854<pre>
3855Point Hermite Cubic
3856Box Gaussian Catrom
3857Triangle Quadratic Mitchell
3858</pre>
3859
3860<p>The <code>Bessel</code> and <code>Sinc</code> filter is also provided (as well
3861as a faster <code>SincFast</code> equivalent form). However these filters are
3862generally useless on their own as they are infinite filters that are being
3863clipped to the filters support size. Their direct use is not recommended
3864except via expert settings (see below). </p>
3865
3866<p>Instead these special filter functions are typically windowed by a windowing
Cristy594d2772015-11-15 10:47:42 -05003867function that the <a href="command-line-options.html#filter" >-filter</a> setting defines. That is
Cristy882d9f42015-10-29 16:48:39 -04003868using these functions will define a 'Windowed' filter, appropriate to the
3869operator involved. Windowed filters include: </p>
3870
3871<pre>
3872Lanczos Hamming Parzen
3873Blackman Kaiser Welsh
3874Hanning Bartlett Bohman
3875</pre>
3876
3877<p>Also one special self-windowing filter is also provided
3878<code>Lagrange</code>, which will automagically re-adjust its function depending
3879on the current 'support' or 'lobes' expert settings (see below).</p>
3880
3881<p>If you do not select a filter with this option, the filter defaults to
3882<code>Mitchell</code> for a colormapped image, an image with a matte channel, or
3883if the image is enlarged. Otherwise the filter default to
3884<code>Lanczos</code>.</p>
3885
3886<p>To print a complete list of resize filters, use the <a href="command-line-options.html#list">-list
3887filter</a> option.</p>
3888
3889<p>You can modify how the filter behaves as it scales your image through the
Cristy594d2772015-11-15 10:47:42 -05003890use of these expert settings (see also <a href="command-line-options.html#define" >-define</a> and <a
3891href="command-line-options.html#set" >-set</a>):-</p>
Cristy882d9f42015-10-29 16:48:39 -04003892
3893<table class="table table-condensed table-striped">
3894 <tr>
3895 <td>-define filter:blur=<var>factor</var></td>
3896 <td>Scale the X axis of the filter (and its window). Use &gt; 1.0 for
3897 blurry or &lt; 1.0 for sharp. This should only be used with Gaussian and
3898 Gaussian-like filters simple filters, or you may not get the expected
3899 results. </td>
3900 </tr>
3901
3902 <tr>
3903 <td>-define filter:support=<var>radius</var></td>
3904 <td>Set the filter support radius. Defines how large the filter should be and
3905 thus directly defines how slow the filtered resampling process is. All
3906 filters have a default 'preferred' support size. Some filters like
3907 <code>Lagrange</code> and windowed filters adjust themselves depending on
3908 this value. With simple filters this value either does nothing (but slow
3909 the resampling), or will clip the filter function in a detrimental way.
3910 </td>
3911 </tr>
3912
3913 <tr>
3914 <td>-define filter:lobes=<var>count</var></td>
3915 <td>Set the number of lobes to use for the Sinc/Bessel filter. This an
3916 alternative way of specifying the 'support' range of the filter, that is
3917 designed to be more suited to windowed filters, especially when used for
3918 image distorts.</td>
3919 </tr>
3920
3921 <tr>
3922 <td>-define filter:sigma=<var>value</var></td>
3923 <td>The 'sigma' value used to define the <code>Gaussian</code> filter. Default
3924 sigma value is '<code>0.5</code>'. It only effects <code>Gaussian</code> but
3925 does not shrink (but may enlarge) the filter's 'support'. It can be used
3926 to generate very small blurs but without the filter 'missing' pixels due
3927 to using a small support setting. A larger value of '<code>0.707</code>'
3928 (a value of '1/sqrt(2)') is another common setting. </td>
3929 </tr>
3930
3931 <tr>
3932 <td>-define filter:b=<var>b-spline_factor</var></td>
Cristy579a0cb2016-11-26 12:27:17 -05003933 </tr>
3934
Cristy594d2772015-11-15 10:47:42 -05003935 <tr>
Cristy882d9f42015-10-29 16:48:39 -04003936 <td>-define filter:c=<var>keys_alpha_factor</var></td>
3937 <td>Redefine the values used for cubic filters such as <code>Cubic</code>,
3938 <code>Catrom</code>, <code>Mitchel</code>, and <code>Hermite</code>, as well as
3939 the <code>Parzen</code> cubic windowing function. If only one of the values
3940 are defined, the other is set so as to generate a 'Cubic-Keys' filter.
3941 The values meaning was defined by a research paper by
3942 Mitchell-Netravali.</td>
3943 </tr>
3944
3945 <tr>
3946 <td>-define filter:kaiser-beta=<var>value</var></td>
3947 <td>The 'alpha' value used to as part of the Kaiser Windowing function.
3948 Default value is '6.5'. It only effects Kaiser windowing function, and
3949 does not effect any other attributes.
3950 Before ImageMagick v6.7.6-10, this option was known as "filter:alpha", (an
3951 inheritance from the very old "zoom" program). It was changed to bring the
3952 function in line with more modern academic research usage, and better
3953 assign it be more definitive. </td>
3954 </tr>
3955
3956 <tr>
3957 <td>-define filter:kaiser-alpha=<var>value</var></td>
3958 <td>This value when multiplied by 'PI' is equivalent to "kaiser-beta", and
3959 will override that setting. It only effects Kaiser windowing function,
3960 and does not effect any other attributes. </td>
3961 </tr>
3962
3963 <tr>
3964 <td>-define filter:filter=<var>filter_function</var></td>
3965 <td>Use this function directly as the weighting filter. This will allow
3966 you to directly use a windowing function such as <code>Blackman</code>,
3967 as a resampling filter, rather than as its normal usage as a windowing
3968 function. If defined, no windowing function also defined, the window function is set
3969 to <code>Box</code>). Directly specifying <code>Sinc</code> or <code>Jinc</code>
3970 as a filter will also do this. </td>
3971 </tr>
3972
3973 <tr>
3974 <td>-define filter:window=<var>filter_function</var></td>
3975 <td>The IIR (infinite impulse response) filters <code>Sinc</code> and
3976 <code>Jinc</code> are windowed (brought down to zero over the defined
3977 support range) with the given filter. This allows you to specify a filter
3978 function to be used as a windowing function for these IIR filters.
3979 Many of the defined filters are actually windowing functions for these IIR
3980 filters. A typical choices is <code>Box</code>, (which effectively turns
3981 off the windowing function). </td>
3982 </tr>
3983
3984 <tr>
3985 <td>-define filter:win-support=<var>radius</var></td>
3986 <td>Scale windowing function to this size instead. This causes the windowing
3987 (or self-windowing Lagrange filter) to act is if the support window is
3988 larger than what is actually supplied to the calling operator. The filter
3989 however is still clipped to the real support size given. If unset this
3990 will equal the normal filter support size. </td>
3991 </tr>
3992
3993 <tr>
3994 <td>-define filter:verbose=<var>1</var></td>
3995 <td>This causes IM to print information on the final internal filter
3996 selection to standard output. This includes a commented header on the
3997 filter settings being used, and data allowing the filter weights to be
3998 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
3999 a <code>SincFast</code> windowed <code>SincFast</code> filter, while
4000 <code>Mitchell</code> is defined as a general <code>Cubic</code> family filter
4001 with specific 'B' and 'C' settings. </td>
4002 </tr>
4003
4004</table>
4005
4006<p>For example, to get a 8 lobe jinc windowed sinc filter (Genseng filter?):</p>
4007
4008<pre>
4009convert image.png \
4010 -filter sinc \
4011 -set filter:window=jinc \
4012 -set filter:lobes=8 \
4013 -resize 150% image.jpg"
4014</pre>
4015
4016<p>Or a raw un-windowed Sinc filter with 4 lobes:</p>
4017
4018<pre>
4019convert image.png \
4020 -set filter:filter=sinc \
4021 -set filter:lobes=4 \
4022 -resize 150% image.jpg"
4023</pre>
4024
4025<p>To extract the data for a raw windowing function, combine it with
4026a '<code>Box</code>' filter. For example the '<code>Welch</code> parabolic
4027windowing function. </p>
4028
4029<pre>
4030convert null: -define filter:filter=Box \
4031 -define filter:window=Welch \
4032 -define filter:support=1.0 \
4033 -define filter:verbose=1 \
Cristy594d2772015-11-15 10:47:42 -05004034 -resize 2 null: > window_welch.dat
Cristy882d9f42015-10-29 16:48:39 -04004035gnuplot
4036 set grid
4037 plot \"window_welch.dat\" with lines
4038</pre>
4039
4040<p>Note that the use of expert options is provided for image processing experts
4041who have studied and understand how resize filters work. Without this
4042knowledge, and an understanding of the definition of the actual filters
4043involved, using expert settings are more likely to be detrimental to your image
4044resizing.</p>
4045
4046
4047<div style="margin: auto;">
4048 <h3 class="magick-header"><a id="flatten"></a>-flatten</h3>
4049</div>
4050
Cristy594d2772015-11-15 10:47:42 -05004051<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 -04004052
4053
4054<div style="margin: auto;">
4055 <h3 class="magick-header"><a id="flip"></a>-flip</h3>
4056</div>
4057
4058<p class="magick-description">create a <var>mirror image</var></p>
4059
4060<p>reflect the scanlines in the vertical direction. The image will be mirrored
4061upside-down. </p>
4062
4063
4064<div style="margin: auto;">
4065 <h3 class="magick-header"><a id="floodfill"></a>-floodfill {<var>+-</var>}<var>x</var>{<var>+-</var>}<var>y</var> <var>color</var></h3>
4066</div>
4067
4068<p class="magick-description">floodfill the image with color at the specified offset.</p>
4069
4070<p>Flood fill starts from the given 'seed point' which is not gravity effected.
Cristy594d2772015-11-15 10:47:42 -05004071Any color that matches within <a href="command-line-options.html#fuzz" >-fuzz</a> color distance of the
Cristy882d9f42015-10-29 16:48:39 -04004072given <var>color</var> argument, connected to that 'seed point'
Cristy594d2772015-11-15 10:47:42 -05004073will be replaced with the current <a href="command-line-options.html#fill" >-fill</a> color. </p>
Cristy882d9f42015-10-29 16:48:39 -04004074
4075<p>Note that if the pixel at the 'seed point' does not itself match the given
Cristy594d2772015-11-15 10:47:42 -05004076<var>color</var> (according to <a href="command-line-options.html#fuzz" >-fuzz</a>), then no
Cristy882d9f42015-10-29 16:48:39 -04004077action will be taken. </p>
4078
Cristy594d2772015-11-15 10:47:42 -05004079<p>This operator works more like the <a href="command-line-options.html#opaque" >-opaque</a> option, than
Cristy882d9f42015-10-29 16:48:39 -04004080a more general flood fill that reads the matching color directly at the 'seed
Cristy594d2772015-11-15 10:47:42 -05004081point'. For this form of flood fill, look at <a href="command-line-options.html#draw" >-draw</a> and
Cristy882d9f42015-10-29 16:48:39 -04004082its 'color floodfill' drawing method. </p>
4083
4084
4085<div style="margin: auto;">
4086 <h3 class="magick-header"><a id="flop"></a>-flop</h3>
4087</div>
4088
4089<p class="magick-description">create a <var>mirror image</var>.</p>
4090
4091<p>Reflect the scanlines in the horizontal direction, just like the image in
4092a vertical mirror. </p>
4093
4094
4095<div style="margin: auto;">
4096 <h3 class="magick-header"><a id="font"></a>-font <var>name</var></h3>
4097</div>
4098
4099<p class="magick-description">set the font to use when annotating images with text, or creating labels.</p>
4100
4101<p>To print a complete list of fonts, use the <a href="command-line-options.html#list">-list font</a>
4102option (for versions prior to 6.3.6, use 'type' instead of 'font').</p>
4103
4104<p>In addition to the fonts specified by the above pre-defined list, you can
4105also specify a font from a specific source. For example <code>Arial.ttf</code>
4106is a TrueType font file, <code>ps:helvetica</code> is PostScript font, and
4107<code>x:fixed</code> is X11 font.</p>
4108
Cristy594d2772015-11-15 10:47:42 -05004109<p>For other settings that affect fonts, see the options <a
4110href="command-line-options.html#family">-family</a>, <a href="command-line-options.html#stretch">-stretch</a>, <a
4111href="command-line-options.html#style">-style</a>, and <a href="command-line-options.html#weight">-weight</a>. </p>
Cristy882d9f42015-10-29 16:48:39 -04004112
4113
4114<div style="margin: auto;">
4115 <h3 class="magick-header"><a id="foreground"></a>-foreground <var>color</var></h3>
4116</div>
4117
4118<p class="magick-description">Define the foreground color for menus.", "display</p>
4119
Cristy594d2772015-11-15 10:47:42 -05004120<p>The color is specified using the format described under the <a
4121href="command-line-options.html#fill">-fill</a> option.</p>
Cristy882d9f42015-10-29 16:48:39 -04004122
4123<p>The default foreground color is black.</p>
4124
4125<div style="margin: auto;">
4126 <h3 class="magick-header"><a id="format"></a>-format <var>type</var></h3>
4127</div>
4128
4129<p class="magick-description">the image format type.</p>
4130
4131<p>When used with the <code>mogrify</code> utility, this option converts any
4132image to the image <a href="formats.html">format</a> you specify.
Cristy594d2772015-11-15 10:47:42 -05004133For a list of image format types supported by ImageMagick, use <a
4134href="command-line-options.html#list">-list format</a>.</p>
Cristy882d9f42015-10-29 16:48:39 -04004135
4136<p>By default the file is written to its original name. However, if the
4137filename extension matches a supported format, the extension is replaced with
4138the image format type specified with <a href="command-line-options.html#format">-format</a>. For
4139example, if you specify <var>tiff</var> as the format type and the
4140input image filename is <var>image.gif</var>, the output image
4141filename becomes <var>image.tiff</var>.</p>
4142
4143<div style="margin: auto;">
4144 <h3 class="magick-header"><a id="format_identify_"></a>-format <var>string</var></h3>
4145</div>
4146
4147<p class="magick-description">output formatted image characteristics.</p>
4148
4149<p>See <a href="escape.html">Format and Print Image
4150Properties</a> for an explanation on how to specify the argument to this
4151option.</p>
4152
4153<div style="margin: auto;">
4154 <h3 class="magick-header"><a id="frame"></a>-frame <var>geometry</var></h3>
4155</div>
4156
4157<p class="magick-description">Surround the image with a border or beveled frame.</p>
4158
Cristyf650f4f2016-04-01 10:53:07 -04004159<p>The color of the border is specified with the <a href="command-line-options.html#alpha-color"
4160>-alpha-color</a> command line option. </p>
Cristy882d9f42015-10-29 16:48:39 -04004161
4162<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
4163height that is added to the dimensions of the image. If no offsets are given
4164in the <var>geometry</var> argument, then the border added is
4165a solid color. Offsets <var>x</var> and <var>y</var>, if present, specify that
4166the width and height of the border is partitioned to form an outer bevel of
4167thickness <var>x</var> pixels and an inner bevel of thickness
4168<var>y</var> pixels. Negative offsets make no sense as frame arguments.
4169</p>
4170
Cristy594d2772015-11-15 10:47:42 -05004171<p>The <a href="command-line-options.html#frame">-frame</a> option is affected by the current <a
4172href="command-line-options.html#compose">-compose</a> setting and assumes that this is using the default
Cristy882d9f42015-10-29 16:48:39 -04004173'<code>Over</code>' composition method. It generates an image of the appropriate
4174size with the current <a href="command-line-options.html#bordercolor">-bordercolor</a> setting, and then
Cristy594d2772015-11-15 10:47:42 -05004175draws the frame of four distinct colors close to the current <a
Cristyf650f4f2016-04-01 10:53:07 -04004176href="command-line-options.html#alpha-color">-alpha-color</a>. The original image is then overlaid onto
Cristy882d9f42015-10-29 16:48:39 -04004177center of this image. This means that with the default compose method of
Cristy594d2772015-11-15 10:47:42 -05004178'<code>Over</code>' any transparent parts may be replaced by the current <a
4179href="command-line-options.html#bordercolor">-bordercolor</a> setting.</p>
Cristy882d9f42015-10-29 16:48:39 -04004180
4181<p>The image composition is not
4182affected by the <a href="command-line-options.html#gravity">-gravity</a> option.</p>
4183
4184
4185<div style="margin: auto;">
4186 <h3 class="magick-header"><a id="frame_import_"></a>-frame</h3>
4187</div>
4188
4189<p class="magick-description">include the X window frame in the imported image. </p>
4190<div style="margin: auto;">
4191 <h3 class="magick-header"><a id="function"></a>-function <var>function</var> <var>parameters</var></h3>
4192</div>
4193
4194<p class="magick-description">Apply a function to channel values.</p>
4195
4196<p>This operator performs calculations based on the given arguments to modify
Cristy594d2772015-11-15 10:47:42 -05004197each of the color values for each previously set <a
4198href="command-line-options.html#channel">-channel</a> in the image. See <a
4199href="command-line-options.html#evaluate">-evaluate</a> for details concerning how the results of the
Cristy882d9f42015-10-29 16:48:39 -04004200calculations are handled.</p>
4201
Cristy594d2772015-11-15 10:47:42 -05004202<p>This is can be considered a multi-argument version of the <a
4203href="command-line-options.html#evaluate">-evaluate</a> operator. (Added in
Cristy882d9f42015-10-29 16:48:39 -04004204ImageMagick 6.4.8−8.)</p>
4205
4206<p>Here, <var>parameters</var> is a comma-separated list of
4207numerical values. The number of values varies depending on which <var>function</var> is selected. Choose the <var>function</var> from:</p>
4208
4209<pre>
4210Polynomial
4211Sinusoid
4212Arcsin
4213Arctan
4214</pre>
4215
4216<p>To print a complete list of <a href="command-line-options.html#function">-function</a> operators,
4217use <a href="command-line-options.html#list">-list function</a>. Descriptions follow.</p>
4218
4219<dl class="dl-horizontal">
4220 <dt>Polynomial</dt>
4221 <dd><p>The <code>Polynomial</code> function takes an arbitrary number of parameters,
4222these being the coefficients of a polynomial, in decreasing order of degree.
4223That is, entering</p>
4224
4225<pre>
4226-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>
4227</pre>
4228
4229<p>will invoke a polynomial function given by</p>
4230
4231<pre>
4232<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>,
4233</pre>
4234
4235<p>where <b><var>u</var></b> is pixel's original normalized channel value.</p>
4236
4237<p>The <code>Polynomial</code> function can be used in place of <code>Set</code>
4238(the <var>constant</var> polynomial) and <code>Add</code>, <code>Divide</code>,
4239<code>Multiply</code>, and <code>Subtract</code> (some <var>linear</var>
Cristy594d2772015-11-15 10:47:42 -05004240polynomials) of the <a href="command-line-options.html#evaluate">-evaluate</a> operator. The <a
4241href="command-line-options.html#level">-level</a> operator also affects channels linearly. Some
Cristy882d9f42015-10-29 16:48:39 -04004242correspondences follow.</p>
4243
4244<table class="table table-condensed table-striped">
4245 <tr>
4246 <td>-evaluate Set <var>value</var> </td>
4247 <td>-function Polynomial <var>value</var></td>
4248 <td>(Constant functions; set <var>value</var>×100% gray when channels are RGB.)</td>
4249 </tr>
4250 <tr>
4251 <td>-evaluate Add <var>value</var> </td>
4252 <td>-function Polynomial 1,<var>value</var></td>
4253 </tr>
4254 <tr>
4255 <td>-evaluate Subtract <var>value</var> </td>
4256 <td>-function Polynomial 1,−<var>value</var></td>
4257 </tr>
4258 <tr>
4259 <td>-evaluate Multiply <var>value</var> </td>
4260 <td>-function Polynomial <var>value</var>,0</td>
4261 </tr>
4262 <tr>
4263 <td>+level black% x white%</td>
4264 <td>-function Polynomial A,B</td>
4265 <td>(Reduce contrast. Here, A=(white-black)/100 and B=black/100.)</td>
4266 </tr>
4267</table>
4268
4269<p>The <code>Polynomial</code> function gives great versatility, since
4270polynomials can be used to fit any continuous curve to any degree of accuracy
4271desired.</p>
4272
4273</dd>
4274<dt>Sinusoid</dt>
4275<dd>
4276<p>The <code>Sinusoid</code> function can be used to vary the channel values
4277sinusoidally by setting frequency, phase shift, amplitude, and a bias. These
4278values are given as one to four parameters, as follows,</p>
4279
4280<pre>
4281-function <code>Sinusoid</code> <var>freq</var>,[<var>phase</var>,[<var>amp</var>,[<var>bias</var>]]]
4282</pre>
4283
4284<p>where <var>phase</var> is in degrees. (The domain [0,1] of the function
4285corresponds to 0 through <var>freq</var>×360 degrees.)
4286The result is that if a pixel's normalized channel value is originally
4287<b><var>u</var></b>, its resulting normalized value is given by </p>
4288
4289<pre>
4290<var>amp</var> * sin(2*π* (<var>freq</var> * <b><var>u</var></b> + <var>phase</var> / 360)) + <var>bias</var>
4291</pre>
4292
4293<p> For example, the following generates a curve that starts and ends at 0.9
4294(when <b><var>u</var></b>=0 and 1, resp.), oscillating three times between
4295.7−.2=.5 and .7+.2=.9. </p>
4296
4297<pre>
4298-function Sinusoid 3,-90,.2,.7
4299</pre>
4300
4301<p>The default values of <var>amp</var> and <var>bias</var> are both .5. The default for <var>phase</var>
4302is 0.</p>
4303
4304<p>The <code>Sinusoid</code> function generalizes <code>Sin</code> and
4305<code>Cos</code> of the <a href="command-line-options.html#evaluate">-evaluate</a> operator by allowing
4306varying amplitude, phase and bias. The correspondence is as follows.</p>
4307
4308<table class="table table-condensed table-striped">
4309 <tr>
4310 <td>-evaluate Sin <var>freq</var> </td>
4311 <td>-function Sinusoid <var>freq</var>,0 </td>
4312 </tr>
4313 <tr>
4314 <td>-evaluate Cos <var>freq</var> </td>
4315 <td>-function Sinusoid <var>freq</var>,90 </td>
4316 </tr>
4317</table>
4318 </dd>
4319<dt>ArcSin</dt>
4320<dd>
4321<p>The <code>ArcSin</code> function generates the inverse curve of a Sinusoid,
4322and can be used to generate cylindrical distortion and displacement maps.
4323The curve can be adjusted relative to both the input values and output range
4324of values.</p>
4325
4326<pre>
4327-function <code>ArcSin</code> <var>width</var>,[<var>center</var>,[<var>range</var>,[<var>bias</var>]]]
4328</pre>
4329
4330<p>with all values given in terms of normalized color values (0.0 for black,
43311.0 for white). Defaulting to values covering the full range from 0.0 to 1.0
4332for bout input (<var>width</var>), and output (<var>width</var>) values. '<code>1.0,0.5,1.0,0.5</code>' </p>
4333
4334<pre>
4335<var>range</var>/π * asin( 2/<var>width</var> * ( <b><var>u</var></b> - <var>center</var> ) ) + <var>bias</var>
4336</pre>
4337
4338</dd>
4339<dt>ArcTan</dt>
4340<dd>
4341<p>The <code>ArcTan</code> function generates a curve that smooth crosses from
4342limit values at infinities, though a center using the given slope value.
4343All these values can be adjusted via the arguments.</p>
4344
4345<pre>
4346-function <code>ArcTan</code> <var>slope</var>,[<var>center</var>,[<var>range</var>,[<var>bias</var>]]]
4347</pre>
4348
4349<p>Defaulting to '<code>1.0,0.5,1.0,0.5</code>'.
4350</p>
4351
4352<pre>
4353<var>range</var>/π * atan( <var>slope</var>*π * ( <b><var>u</var></b> - <var>center</var> ) ) + <var>bias</var>
4354</pre>
4355 </dd>
Cristy882d9f42015-10-29 16:48:39 -04004356</dl>
4357
4358
4359
4360<div style="margin: auto;">
4361 <h3 class="magick-header"><a id="fuzz"></a>-fuzz <var>distance</var>{<var>%</var>}</h3>
4362</div>
4363
4364<p class="magick-description">Colors within this <var>distance</var> are considered equal.</p>
4365
4366<p>A number of algorithms search for a target color. By default the color must
4367be exact. Use this option to match colors that are close to the target color
4368in RGB space. For example, if you want to automagically trim the edges of an
4369image with <a href="command-line-options.html#trim">-trim</a> but the image was scanned and the target
4370background color may differ by a small amount. This option can account for
4371these differences.</p>
4372
4373<p>The <var>distance</var> can be in absolute intensity units or, by
4374appending <code>%</code> as a percentage of the maximum possible intensity (255,
437565535, or 4294967295).</p>
4376
Cristy594d2772015-11-15 10:47:42 -05004377<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 -04004378
4379
4380<div style="margin: auto;">
4381 <h3 class="magick-header"><a id="fx"></a>-fx <var>expression</var></h3>
4382</div>
4383
4384<p class="magick-description">apply a mathematical expression to an image or image channels.</p>
4385
4386<p>If the first character of <var>expression</var> is <code>@</code>,
4387the expression is read from a file titled by the remaining characters in the
4388string.</p>
4389
4390<p>See <a href="fx.html">FX,
4391The Special Effects Image Operator</a> for a detailed discussion of this
4392option.</p>
4393
4394
4395<div style="margin: auto;">
4396 <h3 class="magick-header"><a id="gamma"></a>-gamma <var>value</var></h3>
4397</div>
4398
4399<p class="magick-description">level of gamma correction.</p>
4400
4401<p>The same color image displayed on two different workstations may look
4402different due to differences in the display monitor. Use gamma correction to
4403adjust for this color difference. Reasonable values extend from
4404<code>0.8</code> to <code>2.3</code>. Gamma less than 1.0 darkens the image and
4405gamma greater than 1.0 lightens it. Large adjustments to image gamma may
4406result in the loss of some image information if the pixel quantum size is only
4407eight bits (quantum range 0 to 255).</p>
4408
4409<p>Gamma adjusts the image's channel values pixel-by-pixel according to
4410a power law, namely, pow(pixel,1/gamma) or pixel^(1/gamma), where pixel is the
4411normalized or 0 to 1 color value. For example, using a value of gamma=2 is the
4412same as taking the square root of the image.</p>
4413
4414<p>You can apply separate gamma values to the red, green, and blue channels of
4415the image with a gamma value list delimited with commas (e.g.,
4416<code>1.7,2.3,1.2</code>).</p>
4417
4418<p>Use <a href="command-line-options.html#gamma">+gamma <var>value</var></a> to set the
4419image gamma level without actually adjusting the image pixels. This option
4420is useful if the image is of a known gamma but not set as an image attribute
4421(e.g. PNG images). Write the "file gamma" which is the reciprocal of the
4422display gamma; e.g., if your image is sRGB and you want to write a PNG gAMA
4423chunk, use</p>
4424
4425<pre>
4426convert input.png +gamma .45455 output.png
4427</pre>
4428
4429<p>(0.45455 is 1/2.2)</p>
4430
4431<p>Note that gamma adjustments are also available via the <a href="command-line-options.html#level">-level</a> operator.</p>
4432
4433<div style="margin: auto;">
Cristy594d2772015-11-15 10:47:42 -05004434 <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 -04004435</div>
4436
4437<p class="magick-description">Blur the image with a Gaussian operator.</p>
4438
4439<p>Convolve the image with a Gaussian or normal distribution using the given
Cristy594d2772015-11-15 10:47:42 -05004440<var >Sigma</var> value. The formula is:</p>
Cristy882d9f42015-10-29 16:48:39 -04004441
Cristy594d2772015-11-15 10:47:42 -05004442<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 -04004443
Cristy594d2772015-11-15 10:47:42 -05004444<p>The <var >Sigma</var> value is the important argument, and
Cristy882d9f42015-10-29 16:48:39 -04004445determines the actual amount of blurring that will take place. </p>
4446
Cristy594d2772015-11-15 10:47:42 -05004447<p>The <var >Radius</var> is only used to determine the size of the
Cristy882d9f42015-10-29 16:48:39 -04004448array which will hold the calculated Gaussian distribution. It should be an
4449integer. If not given, or set to zero, IM will calculate the largest possible
4450radius that will provide meaningful results for the Gaussian distribution.
4451</p>
4452
Cristy594d2772015-11-15 10:47:42 -05004453<p>The larger the <var >Radius</var> the radius the slower the
4454operation is. However too small a <var >Radius</var>, and sever
4455aliasing effects may result. As a guideline, <var >Radius</var>
4456should be at least twice the <var >Sigma</var> value, though three
Cristy882d9f42015-10-29 16:48:39 -04004457times will produce a more accurate result. </p>
4458
4459<p>This differs from the faster <a href="command-line-options.html#blur">-blur</a> operator in that a
4460full 2-dimensional convolution is used to generate the weighted average of the
4461neighboring pixels. </p>
4462
4463<p>The <a href="command-line-options.html#virtual-pixel">-virtual-pixel</a> setting will determine how
4464pixels which are outside the image proper are blurred into the final result.
4465</p>
4466
4467
4468<div style="margin: auto;">
4469 <h3 class="magick-header"><a id="geometry"></a>-geometry <var>geometry</var></h3>
4470</div>
4471
4472<p class="magick-description">Set the preferred size and location of the image.</p>
4473
4474<p>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<div style="margin: auto;">
4477 <h3 class="magick-header"><a id="gravity"></a>-gravity <var>type</var></h3>
4478</div>
4479
4480<p class="magick-description">Sets the current gravity suggestion for various other settings and options.</p>
4481
4482<p>Choices include: <code>NorthWest</code>, <code>North</code>,
4483<code>NorthEast</code>, <code>West</code>, <code>Center</code>, <code>East</code>,
Cristy594d2772015-11-15 10:47:42 -05004484<code>SouthWest</code>, <code>South</code>, <code>SouthEast</code>. Use <a
4485href="command-line-options.html#list">-list gravity</a> to get a complete list of <a
4486href="command-line-options.html#gravity">-gravity</a> settings available in your ImageMagick
Cristy882d9f42015-10-29 16:48:39 -04004487installation.</p>
4488
4489<p>The direction you choose specifies where to position text or subimages. For
4490example, a gravity of <code>Center</code> forces the text to be centered within
Cristy776113a2016-04-29 12:01:19 -04004491the image. By default, the image gravity is <code>undefined</code>. See <a
Cristy594d2772015-11-15 10:47:42 -05004492href="command-line-options.html#draw">-draw</a> for more details about graphic primitives. Only the
4493text primitive of <a href="command-line-options.html#draw">-draw</a> is affected by the <a
4494href="command-line-options.html#gravity">-gravity</a> option.</p>
Cristy882d9f42015-10-29 16:48:39 -04004495
4496<p>The <a href="command-line-options.html#gravity">-gravity</a> option is also used in concert with the
4497<a href="command-line-options.html#geometry">-geometry</a> setting and other settings or options that
Cristy594d2772015-11-15 10:47:42 -05004498take <var>geometry</var> as an argument, such as the <a
4499href="command-line-options.html#crop">-crop</a> option. </p>
Cristy882d9f42015-10-29 16:48:39 -04004500
4501<p>If a <a href="command-line-options.html#gravity">-gravity</a> setting occurs before another option
4502or setting having a <var>geometry</var> argument that specifies an
4503offset, the offset is usually applied to the point within the image suggested
4504by the <a href="command-line-options.html#gravity">-gravity</a> argument. Thus, in the following
4505command, for example, suppose the file <code>image.png</code> has dimensions
4506200x100. The offset specified by the argument to <a href="command-line-options.html#region">-region</a>
4507is (−40,+20). The argument to <a href="command-line-options.html#gravity">-gravity</a> is
4508<code>Center</code>, which suggests the midpoint of the image, at the point
4509(100,50). The offset (−40,20) is applied to that point, giving
4510(100−40,50+20)=(60,70), so the specified 10x10 region is located at
4511that point. (In addition, the <a href="command-line-options.html#gravity">-gravity</a> affects the
4512region itself, which is <var>centered</var> at the pixel
4513coordinate (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>
4514
4515<pre>
4516convert image.png -gravity Center -region 10x10-40+20 \
4517 -negate output.png
4518</pre>
4519
Cristy594d2772015-11-15 10:47:42 -05004520<p>When used as an option to <a href="composite.html">composite</a>, <a
4521href="command-line-options.html#gravity">-gravity</a> gives the direction that the image gravitates
Cristy882d9f42015-10-29 16:48:39 -04004522within the composite.</p>
4523
Cristy594d2772015-11-15 10:47:42 -05004524<p>When used as an option to <a href="montage.html">montage</a>, <a
4525href="command-line-options.html#gravity">-gravity</a> gives the direction that an image gravitates
Cristy882d9f42015-10-29 16:48:39 -04004526within a tile. The default gravity is <code>Center</code> for this purpose.</p>
4527
4528
4529<div style="margin: auto;">
4530 <h3 class="magick-header"><a id="grayscale"></a>-grayscale <var>method</var></h3>
4531</div>
4532
4533<p class="magick-description">convert image to grayscale.</p>
4534
Cristy594d2772015-11-15 10:47:42 -05004535<p>This will use one of the <a href="command-line-options.html#intensity" >-intensity</a> methods to
Cristy882d9f42015-10-29 16:48:39 -04004536convert the given image into a linear-grayscale image. </p>
4537
4538<p>For example, to convert an image to (linear) Rec709Luminance grayscale, type:</p>
4539
4540<pre>
4541convert in.png -grayscale Rec709Luminance out.png
4542</pre>
4543
4544<p>which is equivalent to:</p>
4545
4546<pre>
4547convert in.png -colorspace gray out.png
4548</pre>
4549
4550<p>Similarly, to convert an image to (non-linear) Rec709Luma grayscale, type:</p>
4551
4552<pre>
4553convert in.png -grayscale Rec709Luma out.png
4554</pre>
4555
4556<p>which is equivalent to:</p>
4557
4558<pre>
4559convert in.png -set colorspace RGB -colorspace gray out.png
4560</pre>
4561
4562<p>Note that a 'colorspace' intensity method will produce the same result
4563regardless of the current colorpsace of the image. But a 'mathematical'
4564intensity method will depend on the current colorspace the image is currently
4565using. </p>
4566
Cristy594d2772015-11-15 10:47:42 -05004567<p>While this operation uses an <a href="command-line-options.html#intensity" >-intensity</a> method,
4568it does not use or set the <a href="command-line-options.html#intensity" >-intensity</a> setting, so
Cristy882d9f42015-10-29 16:48:39 -04004569will not effect other operations that may use that setting.</p>
4570
4571
4572<div style="margin: auto;">
4573 <h3 class="magick-header"><a id="green-primary"></a>-green-primary <var>x,y</var></h3>
4574</div>
4575
4576<p class="magick-description">green chromaticity primary point.</p>
4577
4578
4579<div style="margin: auto;">
4580 <h3 class="magick-header"><a id="hald-clut"></a>-hald-clut</h3>
4581</div>
4582
4583<p class="magick-description">apply a Hald color lookup table to the image.</p>
4584
4585<p>A Hald color lookup table is a 3-dimensional color cube mapped to 2
4586dimensions. Create it with the <code>HALD:</code> prefix (e.g. HALD:8). You
4587can apply any color transformation to the Hald image and then use this option
4588to apply the transform to the image. </p>
4589
4590<pre>
4591convert image.png hald.png -hald-clut transform.png
4592</pre>
4593
4594<p>This option provides a convenient method for you to use Gimp or Photoshop
4595to make color corrections to the Hald CLUT image and subsequently apply them
4596to multiple images using an ImageMagick script. </p>
4597
4598<p>Note that the representation is only of the normal RGB color space and that
4599the whole color value triplet is used for the interpolated lookup of the
Cristy594d2772015-11-15 10:47:42 -05004600represented Hald color cube image. Because of this the operation is not <a
4601href="command-line-options.html#channel" >-channel</a> setting effected, nor can it adjust or modify an
Cristy882d9f42015-10-29 16:48:39 -04004602images transparency or alpha/matte channel.</p>
4603
Cristy594d2772015-11-15 10:47:42 -05004604<p>See also <a href="command-line-options.html#clut" >-clut</a> which provides color value replacement
Cristy769d8892016-01-19 18:11:14 -05004605of the individual color channels, usually involving a simpler grayscale
4606image. E.g: grayscale to color replacement, or modification by a histogram
Cristy882d9f42015-10-29 16:48:39 -04004607mapping. </p>
4608
4609
4610<div style="margin: auto;">
4611 <h3 class="magick-header"><a id="help"></a>-help</h3>
4612</div>
4613
4614<p class="magick-description">print usage instructions.</p>
4615
4616<div style="margin: auto;">
4617 <h3 class="magick-header"><a id="highlight-color"></a>-highlight-color <var>color</var></h3>
4618</div>
4619
4620<p class="magick-description">when comparing images, emphasize pixel differences with this color.</p>
4621
4622<div style="margin: auto;">
4623 <h3 class="magick-header"><a id="hough-lines"></a>-hough-lines <var>width</var>x<var>height</var>{<var>+threshold</var>}</h3>
4624</div>
4625
4626<p class="magick-description">identify straight lines in the image (e.g. -hough-lines 9x9+195).</p>
4627
4628<p>Use the Hough line detector with any binary edge extracted image to locate and draw any straight lines that it finds.</p>
4629
4630<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>.
4631
4632<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>
4633
Cristy594d2772015-11-15 10:47:42 -05004634<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 -04004635
Cristy594d2772015-11-15 10:47:42 -05004636<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 -04004637
Cristy594d2772015-11-15 10:47:42 -05004638<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 -04004639
4640<p>A text file listing the endpoints and counts may be created by using the suffix, .mvg, for the output image.</p>
4641
Cristy594d2772015-11-15 10:47:42 -05004642<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 -04004643
4644<div style="margin: auto;">
4645 <h3 class="magick-header"><a id="iconGeometry"></a>-iconGeometry <var>geometry</var></h3>
4646</div>
4647
4648<p class="magick-description">specify the icon geometry.</p>
4649
4650<p>Offsets, if present in the geometry specification, are handled in the same
4651manner as the <a href="command-line-options.html#geometry">-geometry</a> option, using X11 style to
4652handle negative offsets.</p>
4653
4654<p>See <a href="command-line-processing.html#geometry">Image Geometry</a> for complete details about the <em class="arg">geometry</em> argument.</p>
4655
4656<div style="margin: auto;">
4657 <h3 class="magick-header"><a id="iconic"></a>-iconic</h3>
4658</div>
4659
4660<p class="magick-description">start in icon mode in X Windows", 'animate', 'display</p>
4661
4662<div style="margin: auto;">
4663 <h3 class="magick-header"><a id="identify"></a>-identify</h3>
4664</div>
4665
4666<p class="magick-description">identify the format and characteristics of the image.</p>
4667
4668<p>This information is printed: image scene number; image name; image size;
4669the image class (<var>DirectClass</var> or <var>PseudoClass</var>); the total number of unique colors; and the
4670number of seconds to read and transform the image. Refer to <a href="miff.html">MIFF</a> for
4671a description of the image class.</p>
4672
4673<p>If <a href="command-line-options.html#colors">-colors</a> is also specified, the total unique colors
Cristy594d2772015-11-15 10:47:42 -05004674in the image and color reduction error values are printed. Refer to <a
Cristy6549abb2016-11-10 08:25:55 -05004675href="http://www.imagemagick.org/www/quantize.html">color
Cristy882d9f42015-10-29 16:48:39 -04004676reduction algorithm</a> for a description of these values.</p>
4677
4678<p>If <a href="command-line-options.html#verbose">-verbose</a> precedes this option, copious
4679amounts of image properties are displayed including image statistics, profiles,
4680image histogram, and others.</p>
4681
4682<div style="margin: auto;">
4683 <h3 class="magick-header"><a id="ift"></a>-ift</h3>
4684</div>
4685
4686<p class="magick-description">implements the inverse discrete Fourier transform (DFT).</p>
4687
4688<p>This option is new as of ImageMagick 6.5.4-3 (and now working for Windows
4689users in ImageMagick 6.6.0-9). It transforms a pair of magnitude and phase
4690images from the frequency domain to a single image in the normal or spatial
Cristy594d2772015-11-15 10:47:42 -05004691domain. See for example, <a
4692href="http://en.wikipedia.org/wiki/Fourier_transform">Fourier Transform</a>,
Cristy882d9f42015-10-29 16:48:39 -04004693<a href="http://en.wikipedia.org/wiki/DFT">Discrete Fourier Transform</a> and
4694<a href="http://en.wikipedia.org/wiki/FFT">Fast Fourier Transform</a>.</p>
4695
4696<p>For example, depending upon the image format used to store the result of
4697the <a href="command-line-options.html#fft">-fft</a>, one would use either</p>
4698
4699<pre>
4700convert fft_image.miff -ift fft_image_ift.png
4701</pre>
4702
4703<p>or</p>
4704
4705<pre>
4706convert fft_image-0.png fft_image-1.png -ift fft_image_ift.png
4707</pre>
4708
4709<p>The resulting image may need to be cropped due to padding introduced when
Cristy594d2772015-11-15 10:47:42 -05004710the original image, prior to the <a href="command-line-options.html#fft">-fft</a> or <a
4711href="command-line-options.html#fft">+fft</a>, was not square or even dimensioned. Any padding is at
Cristy882d9f42015-10-29 16:48:39 -04004712the right and/or bottom sides of the image.</p>
4713
4714<p>The <a href="http://www.fftw.org/">FFTW</a> delegate library is required to
4715use <a href="command-line-options.html#ift">-ift</a>.</p>
4716
4717<p>Use <a href="command-line-options.html#ift">+ift</a> (with HDRI enabled) to transform a pair of real
4718and imaginary images from the frequency domain to a single image in the normal
4719(spatial) domain.</p>
4720
Cristy594d2772015-11-15 10:47:42 -05004721<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 -04004722
4723<div style="margin: auto;">
4724 <h3 class="magick-header"><a id="immutable"></a>-immutable</h3>
4725</div>
4726
4727<p class="magick-description">make image immutable.</p>
4728
4729<div style="margin: auto;">
4730 <h3 class="magick-header"><a id="implode"></a>-implode <var>factor</var></h3>
4731</div>
4732
4733<p class="magick-description">implode image pixels about the center.</p>
4734
4735<div style="margin: auto;">
4736 <h3 class="magick-header"><a id="insert"></a>-insert <var>index</var></h3>
4737</div>
4738
4739<p class="magick-description">insert the last image into the image sequence.</p>
4740
4741<p>This option takes last image in the current image sequence and inserts it
4742at the given index. If a negative index is used, the insert position is
4743calculated before the last image is removed from the sequence. As such
4744<code>-insert -1</code> will result in no change to the image sequence.</p>
4745
4746<p>The <code>+insert</code> option is equivalent to <code>-insert -1</code>. In
4747other words, insert the last image, at the end of the current image sequence.
4748Consequently this has no effect on the image sequence order.</p>
4749
4750<div style="margin: auto;">
4751 <h3 class="magick-header"><a id="intensity"></a>-intensity <var>method</var></h3>
4752</div>
4753
4754<p class="magick-description">method to generate intensity value from pixel.</p>
4755
4756<p>ImageMagick provides a number of methods used in situations where an
4757operator needs to determine a single grayscale value for some purpose, from
4758an image with red, green, and blue pixel components. Typically the linear
4759<code>Rec709Luminance</code> formula is used, which is the same formula used when
4760converting images to <code>-colorspace gray</code>. </p>
4761
4762<p>The following formulas are currently provided, and will first convert
4763the pixel values to linear-RGB or non-linear sRGB colorspace before
4764being applied to calculate the final greyscale value. </p>
4765
4766<dl class="dl-horizontal">
4767<dt>Rec601Luma</dt><dd> 0.298839R' + 0.586811G'+ 0.114350B'</dd>
4768<dt>Rec601Luminance</dt><dd> 0.298839R + 0.586811G + 0.114350B</dd>
4769<dt>Rec709Luma</dt><dd> 0.212656R' + 0.715158G' + 0.072186B'</dd>
4770<dt>Rec709Luminance</dt><dd> 0.212656R + 0.715158G + 0.072186B</dd>
4771<dt>Brightness</dt><dd> max(R', G', B')</dd>
4772<dt>Lightness</dt><dd> (min(R', G', B') + max(R', G', B')) / 2.0</dd>
4773</dl>
4774
4775<p>Note that the above R,G,B values is the image's linear-RGB values, while
4776R',G',B' are sRGB non-linear values. </p>
4777
4778<p>These intensity methods are mathematical in nature and will use the
4779current value in the images respective R,G,B channel regardless of
4780what that is, or what colorspace the image is currently using.</p>
4781
4782<dl class="dl-horizontal">
4783<dt>Average</dt><dd>(R + G + B) / 3.0</dd>
4784<dt>MS</dt><dd>(R^2 + G^2 + B^2) / 3.0</dd>
4785<dt>RMS</dt><dd>sqrt( (R^2 + G^2 + B^2) / 3.0 )</dd>
4786</dl>
4787
4788<p>These methods are often used for other purposes, such as generating a
Cristy594d2772015-11-15 10:47:42 -05004789grayscale difference image between two color images (using <a href="command-line-options.html#compose"
4790>-compose</a> '<code>Difference</code>' composition. </p>
Cristy882d9f42015-10-29 16:48:39 -04004791
4792<p> For example The 'MS' (Mean Squared) setting is good for minimizing color
4793error comparisions. While... The method 'RMS' (Root Mean Squared) for
4794example is appropriate for calculating color vector distance, from a color
Cristy594d2772015-11-15 10:47:42 -05004795difference image. This is equivalent to the color only component of the <a
4796href="command-line-options.html#fuzz" >-fuzz</a> factor color compare setting. </p>
Cristy882d9f42015-10-29 16:48:39 -04004797
Cristy594d2772015-11-15 10:47:42 -05004798<p>See also <a href="command-line-options.html#grayscale" >-grayscale</a> which applies one of the above
4799grayscaling formula directly to an image without setting the <a
4800href="command-line-options.html#intensity" >-intensity</a> setting.</p>
Cristy882d9f42015-10-29 16:48:39 -04004801
Cristy594d2772015-11-15 10:47:42 -05004802<p>The <a href="command-line-options.html#colorspace" >-colorspace gray</a> image conversion also uses
Cristy882d9f42015-10-29 16:48:39 -04004803the current intensity setting, but will always convert the image to the
4804appropriate sRGB or linear-RGB colorspace before appling the above
4805function.</p>
4806
4807<p>To print a complete list of possible pixel intensity setting methods, use <a href="command-line-options.html#list">-list intensity</a>.</p>
4808
Cristy594d2772015-11-15 10:47:42 -05004809<p>Operators affected by the <a href="command-line-options.html#intensity" >-intensity</a> setting include:</p>
Cristy882d9f42015-10-29 16:48:39 -04004810
4811<pre>
4812-adaptive-blur
4813-adaptive-sharpen
4814-black-threshold
4815-clut (when mapping greyscale CLUT image to alpha channel if set by -channels)
4816-colors for gray colorspace
4817-compose {LightenIntensity, DarkenIntensity, CopyOpacity, CopyBlack}
4818-contrast-stretch
4819-distort {ErodeIntensity, DilateIntensity}
4820-normalize
4821-random-threshold
4822-selective-blur
4823-shade
4824-threshold
4825-tint
4826-white-threshold
4827</pre>
4828
4829<div style="margin: auto;">
4830 <h3 class="magick-header"><a id="intent"></a>-intent <var>type</var></h3>
4831</div>
4832
4833<p class="magick-description">use this type of rendering intent when managing the image color.</p>
4834
4835<p>Use this option to affect the color management operation of an image (see
4836<a href="command-line-options.html#profile">-profile</a>). Choose from these intents: <code>Absolute,
4837Perceptual, Relative, Saturation</code>.</p>
4838
4839<p>The default intent is Perceptual for the sRGB colorspace and undefined for the RGB and gray colorspaces.</p>
4840
4841<p>To print a complete list of rendering intents, use <a href="command-line-options.html#list">-list intent</a>.</p>
4842
4843<div style="margin: auto;">
4844 <h3 class="magick-header"><a id="interlace"></a>-interlace <var>type</var></h3>
4845</div>
4846
4847<p class="magick-description">the type of interlacing scheme.</p>
4848
4849<p>Choose from:</p>
4850
4851<pre>
4852none
4853line
4854plane
4855partition
4856JPEG
4857GIF
4858PNG
4859</pre>
4860
4861<p>This option is used to specify the type of interlacing scheme for raw image
4862formats such as <code>RGB</code> or <code>YUV</code>.</p>
4863
4864<p><code>None</code> means do not interlace (RGBRGBRGBRGBRGBRGB...),</p>
4865
4866<p><code>Line</code> uses scanline interlacing (RRR...GGG...BBB...RRR...GGG...BBB...), and.</p>
4867
4868<p><code>Plane</code> uses plane interlacing (RRRRRR...GGGGGG...BBBBBB...).</p>
4869
4870<p><code>Partition</code> is like plane except the different planes are saved to
4871individual files (e.g. image.R, image.G, and image.B).</p>
4872
4873<p>Use <code>Line</code> or <code>Plane</code> to create an <code>interlaced
4874PNG</code> or <code>GIF</code> or <code>progressive JPEG</code> image.</p>
4875
4876<p>To print a complete list of interlacing schemes, use <a href="command-line-options.html#list">-list
4877interlace</a>.</p>
4878
4879<div style="margin: auto;">
4880 <h3 class="magick-header"><a id="interpolate"></a>-interpolate <var>type</var></h3>
4881</div>
4882
4883<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>
4884
4885<p>When looking up the color of a pixel using a non-integer floating point
4886value, you typically fall in between the pixel colors defined by the source
4887image. This setting determines how the color is determined from the colors of
4888the pixels surrounding that point. That is how to determine the color of a
4889point that falls between two, or even four different colored pixels. </p>
4890
4891<dl class="dl-horizontal">
4892 <dt>integer</dt>
4893 <dd>The color of the top-left pixel (floor function)</dd>
4894 <dt>nearest-neighbor</dt>
4895 <dd>The nearest pixel to the lookup point (rounded function)</dd>
4896 <dt>average</dt>
4897 <dd>The average color of the surrounding four pixels</dd>
4898 <dt>bilinear</dt>
4899 <dd>A double linear interpolation of pixels (the default)</dd>
4900 <dt>mesh</dt>
4901 <dd>Divide area into two flat triangular interpolations</dd>
4902 <dt>bicubic</dt>
4903 <dd>Fitted bicubic-spines of surrounding 16 pixels</dd>
4904 <dt>spline</dt>
4905 <dd>Direct spline curves (colors are blurred)</dd>
4906 <dt>filter</dt>
4907 <dd>Use resize <a href="command-line-options.html#filter">-filter</a> settings</dd>
4908</dl>
4909
Cristy594d2772015-11-15 10:47:42 -05004910<p>This most important for distortion operators such as <a href="command-line-options.html#distort"
4911>-distort</a>, <a href="command-line-options.html#implode" >-implode</a>, <a href="command-line-options.html#transform"
4912>-transform</a> and <a href="command-line-options.html#fx" >-fx</a>. </p>
Cristy882d9f42015-10-29 16:48:39 -04004913
4914<p>To print a complete list of interpolation methods, use <a href="command-line-options.html#list">-list interpolate</a>.</p>
4915
Cristy594d2772015-11-15 10:47:42 -05004916<p>See also <a href="command-line-options.html#virtual-pixel" >-virtual-pixel</a>, for control of the
Cristy882d9f42015-10-29 16:48:39 -04004917lookup for positions outside the boundaries of the image. </p>
4918
4919
4920<div style="margin: auto;">
4921 <h3 class="magick-header"><a id="interline-spacing"></a>-interline-spacing <var>value</var></h3>
4922</div>
4923
4924<p class="magick-description">the space between two text lines.</p>
4925
4926<div style="margin: auto;">
4927 <h3 class="magick-header"><a id="interword-spacing"></a>-interword-spacing <var>value</var></h3>
4928</div>
4929
4930<p class="magick-description">the space between two words.</p>
4931
4932<div style="margin: auto;">
4933 <h3 class="magick-header"><a id="kerning"></a>-kerning <var>value</var></h3>
4934</div>
4935
4936<p class="magick-description">the space between two letters.</p>
4937
4938<div style="margin: auto;">
Cristy594d2772015-11-15 10:47:42 -05004939 <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 -04004940</div>
4941
4942<p class="magick-description">edge preserving noise reduction filter.</p>
4943
Cristy594d2772015-11-15 10:47:42 -05004944<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 -04004945
4946
4947<div style="margin: auto;">
4948 <h3 class="magick-header"><a id="label"></a>-label <var>name</var></h3>
4949</div>
4950
4951<p class="magick-description">assign a label to an image.</p>
4952
4953<p>Use this option to assign a specific label to the image, as it is read in
Cristy594d2772015-11-15 10:47:42 -05004954or created. You can use the <a href="command-line-options.html#set" >-set</a> operation to re-assign
Cristy882d9f42015-10-29 16:48:39 -04004955a the labels of images already read in. Image formats such as TIFF, PNG,
4956MIFF, supports saving the label information with the image.</p>
4957
4958<p>When saving an image to a <var>PostScript</var> file, any label
4959assigned to an image is used as a header string to print above the postscript
4960image. </p>
4961
4962<p>You can include the image filename, type, width, height, or other image
4963attribute by embedding special format character. See <a href="escape.html">Format and Print Image
4964Properties</a> for details of the percent escape codes.</p>
4965
4966<p>For example,</p>
4967
4968<pre>
4969-label "%m:%f %wx%h" bird.miff
4970</pre>
4971
4972<p>assigns an image label of <code>MIFF:bird.miff 512x480</code> to the
4973"<code>bird.miff</code>" image and whose width is 512 and height is 480, as it
4974is read in. If a <a href="command-line-options.html#label">+label</a> option was used instead, any
4975existing label present in the image would be used. You can remove all labels
4976from an image by assigning the empty string. </p>
4977
4978<p>A label is not drawn on the image, but is embedded in the image datastream
4979via <var>Label</var> tag or similar mechanism. If you want the label to be
4980visible on the image itself, use the <a href="command-line-options.html#draw">-draw</a> option, or
4981during the final processing in the creation of an image montage.</p>
4982
4983<p>If the first character of <var>string</var> is <var>@</var>, the image label is read from a file titled by the
4984remaining characters in the string. Labels in a file are literal, no embedded
4985formatting characters are recognized.</p>
4986
4987
4988<div style="margin: auto;">
Cristy594d2772015-11-15 10:47:42 -05004989 <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 -04004990</div>
4991
4992<p class="magick-description">perform local adaptive threshold.</p>
4993
4994<p>Adaptively threshold each pixel based on the value of pixels in a
4995surrounding window. If the current pixel is lighter than this average plus
4996the optional <code>offset</code>, then it is made white, otherwise it is made
4997black. Small variations in pixel values such as found in scanned documents
4998can be ignored if offset is positive. A negative offset will make it more
4999sensitive to those small variations. </p>
5000
5001<p>This is commonly used to threshold images with an uneven background. It is
5002based on the assumption that average color of the small window is the
5003the local background color, from which to separate the foreground color. </p>
5004
5005
5006<div style="margin: auto;">
5007 <h3 class="magick-header"><a id="layers"></a>-layers <var>method</var></h3>
5008</div>
5009
5010<p class="magick-description">handle multiple images forming a set of image layers or animation frames.</p>
5011
5012<p>Perform various image operation methods to a ordered sequence of images
5013which may represent either a set of overlaid 'image layers', a GIF disposal
5014animation, or a fully-'coalesced' animation sequence. </p>
5015
5016<table class="table table-condensed table-striped">
5017 <tbody>
5018 <tr>
5019 <th style="width: 8%">Method</th>
5020 <th>Description</th>
5021 </tr>
5022
5023 <tr>
5024 <td>compare-any</td>
5025 <td>Crop the second and later frames to the smallest rectangle
Cristy594d2772015-11-15 10:47:42 -05005026 that contains all the differences between the two images. No GIF <a
5027 href="command-line-options.html#dispose" >-dispose</a> methods are taken into account. </td>
Cristy882d9f42015-10-29 16:48:39 -04005028 </tr>
5029
Cristy594d2772015-11-15 10:47:42 -05005030 <tr><td></td><td>This exactly the same as the <a href="command-line-options.html#deconstruct"
5031 >-deconstruct</a> operator, and does not preserve animations normal
Cristy882d9f42015-10-29 16:48:39 -04005032 working, especially when animation used layer disposal methods such as
5033 '<code>Previous</code>' or '<code>Background</code>'. </td>
5034 </tr>
5035
5036 <tr>
5037 <td>compare-clear</td>
5038 <td>As '<code>compare-any</code>' but crop to the bounds of any
5039 opaque pixels which become transparent in the second frame. That is the
5040 smallest image needed to mask or erase pixels for the next frame. </td>
5041 </tr>
5042
5043 <tr>
5044 <td>compare-overlay</td>
5045 <td>As '<code>compare-any</code>' but crop to pixels that add
5046 extra color to the next image, as a result of overlaying color pixels.
5047 That is the smallest single overlaid image to add or change colors. </td>
5048 </tr>
5049
Cristy594d2772015-11-15 10:47:42 -05005050 <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 -04005051 composition method '<code>change-mask</code>', to reduce the image to
5052 just the pixels that need to be overlaid. </td>
5053 </tr>
5054
5055 <tr>
5056 <td>coalesce</td>
Cristy594d2772015-11-15 10:47:42 -05005057 <td>Equivalent to a call to the <a href="command-line-options.html#coalesce"
5058 >-coalesce</a> operator. Apply the layer disposal methods set in the
Cristy882d9f42015-10-29 16:48:39 -04005059 current image sequence to form a fully defined animation sequence, as
5060 it should be displayed. Effectively converting a GIF animation into a
5061 'film strip'-like animation. </td>
5062 </tr>
5063
5064 <tr>
5065 <td>composite</td>
5066 <td>Alpha Composition of two image lists, separated by a
5067 "<code>null:</code>" image, with the destination image list first, and
5068 the source images last. An image from each list are composited
5069 together until one list is finished. The separator image and source
5070 image lists are removed. </td>
5071 </tr>
5072
5073
5074 <tr><td></td>
Cristy594d2772015-11-15 10:47:42 -05005075 <td>The <a href="command-line-options.html#geometry" >-geometry</a> offset is adjusted according
5076 to <a href="command-line-options.html#gravity" >-gravity</a> in accordance of the virtual
5077 canvas size of the first image in each list. Unlike a normal <a
5078 href="command-line-options.html#composite" >-composite</a> operation, the canvas offset is also
Cristy882d9f42015-10-29 16:48:39 -04005079 added to the final composite positioning of each image. </td> </tr>
5080
5081 <tr><td></td>
5082 <td>If one of the image lists only contains one image, that image is
5083 applied to all the images in the other image list, regardless of which
5084 list it is. In this case it is the image meta-data of the list which
5085 preserved. </td>
5086 </tr>
5087
5088
5089 <tr>
5090 <td>dispose</td>
5091 <td>This like '<code>coalesce</code>' but shows the look of
5092 the animation after the layer disposal method has been applied, before
5093 the next sub-frame image is overlaid. That is the 'dispose' image that
Cristy594d2772015-11-15 10:47:42 -05005094 results from the application of the GIF <a href="command-line-options.html#dispose"
5095 >-dispose</a> method. This allows you to check what
Cristy882d9f42015-10-29 16:48:39 -04005096 is going wrong with a particular animation you may be developing.
5097 </td>
5098 </tr>
5099
5100 <tr>
5101 <td>flatten</td>
5102 <td>Create a canvas the size of the first images virtual
Cristy594d2772015-11-15 10:47:42 -05005103 canvas using the current <a href="command-line-options.html#background" >-background</a> color,
5104 and <a href="command-line-options.html#compose" >-compose</a> each image in turn onto that
Cristy882d9f42015-10-29 16:48:39 -04005105 canvas. Images falling outside that canvas is clipped. Final
5106 image will have a zero virtual canvas offset. </td>
5107 </tr>
5108
5109 <tr><td></td>
5110 <td>This usually used as one of the final 'image layering' operations
5111 overlaying all the prepared image layers into a final image. </td>
5112 </tr>
5113
5114 <tr><td></td>
5115 <td>For a single image this method can also be used to fillout a virtual
5116 canvas with real pixels, or to underlay an opaque color to remove
5117 transparency from an image.</td>
5118 </tr>
5119
5120
5121 <tr>
5122 <td>merge</td>
5123 <td>As 'flatten' method but merging all the given image
5124 layers to create a new layer image just large enough to hold all the
5125 image without clipping or extra space. The new images virtual offset
5126 will preserve the position of the new layer, even if this offset is
5127 negative. The virtual canvas size of the first image is preserved.
5128 </td>
5129 </tr>
5130
5131 <tr><td></td><td>Caution is advised when handling image layers with
5132 negative offsets as few image file formats handle them correctly.
Cristy594d2772015-11-15 10:47:42 -05005133 Following this operation method with <a href="command-line-options.html#repage" >+repage</a>
Cristy882d9f42015-10-29 16:48:39 -04005134 will remove the layer offset, and create an image in which all the
5135 overlaid image positions relative to each other is preserved, though
5136 not necessarily exactly where you specified them.
5137 </td>
5138 </tr>
5139
5140 <tr><td></td><td>See also 'trim-bounds' below which is closely related but
5141 without doing the'flatten' to merge the images together. </td>
5142 </tr>
5143
5144 <tr>
5145 <td>mosaic</td>
5146 <td>As 'flatten' method but expanding the initial canvas size
5147 of the first image in a positive direction only so as to hold all the
5148 image layers. However as a virtual canvas is 'locked' to the origin,
5149 by its own definition, image layers with a negative offsets will still
5150 become clipped by the top and left edges. See 'merge' or 'trim-bounds'
5151 if this could be a problem. </td>
5152
5153 </tr>
5154
5155 <tr><td></td><td>This method is commonly used to layout individual image
5156 using various offset but without knowing the final canvas size. The
5157 resulting image will, like 'flatten' not have any virtual offset, so
5158 can be saved to any image file format. </td>
5159 </tr>
5160
5161
5162 <tr>
5163 <td>optimize</td>
5164 <td>Optimize a coalesced animation, into GIF animation using
5165 a number of general techniques. This currently a short cut to
5166 apply both the '<code>optimize-frame</code>', and
5167 '<code>optimize-transparency</code>' methods but may be expanded to
5168 include other optimization methods as they are developed. </td>
5169 </tr>
5170
5171 <tr>
5172 <td>optimize-frame</td>
5173 <td>Optimize a coalesced animation, into GIF animation by
5174 reducing the number of pixels per frame as much as possible by
5175 attempting to pick the best layer disposal method to use, while ensuring
5176 the result will continue to animate properly. </td>
5177 </tr>
5178
5179 <tr><td></td><td> There is no guarantee that the best optimization is found.
5180 But then no reasonably fast GIF optimization algorithm can do this.
5181 However this does seem to do better than most other GIF frame
5182 optimizers seen. </td>
5183 </tr>
5184
5185 <tr>
5186 <td>optimize-plus</td>
5187 <td>As '<code>optimize-frame</code>' but attempt to improve the
5188 overall optimization by adding extra frames to the animation, without
5189 changing the final look or timing of the animation. The frames are
5190 added to attempt to separate the clearing of pixels from the
5191 overlaying of new additional pixels from one animation frame to the
5192 next. If this does not improve the optimization (for the next frame
5193 only), it will fall back to the results of the previous normal
5194 '<code>optimize-frame</code>' technique. </td>
5195 </tr>
5196
5197 <tr><td></td><td>There is the possibility that the change in the disposal
5198 style will result in a worsening in the optimization of later frames,
5199 though this is unlikely. In other words there no guarantee that it is
5200 better than the normal '<code>optimize-frame</code>' technique. For some
5201 animations however you can get a vast improvement in the final
5202 animation size. </td>
5203 </tr>
5204
5205 <tr>
5206 <td>optimize-transparency</td>
5207 <td>Given a GIF animation, replace any pixel in the sub-frame
5208 overlay images with transparency, if it does not change the resulting
Cristy594d2772015-11-15 10:47:42 -05005209 animation by more than the current <a href="command-line-options.html#fuzz" >-fuzz</a> factor.
Cristy882d9f42015-10-29 16:48:39 -04005210 </td>
5211 </tr>
5212
5213 <tr><td></td><td>This should allow a existing frame optimized GIF animation
5214 to compress into a smaller file size due to larger areas of one
5215 (transparent) color rather than a pattern of multiple colors repeating
5216 the current disposed image of the last frame. </td>
5217 </tr>
5218
5219 <tr>
5220 <td>remove-dups</td>
5221 <td>Remove (and merge time delays) of duplicate consecutive
5222 images, so as to simplify layer overlays of coalesced animations.
5223 </td>
5224 </tr>
5225
5226 <tr><td></td><td>Usually this a result of using a constant time delay
5227 across the whole animation, or after a larger animation was split into
5228 smaller sub-animations. The duplicate frames could also have been
5229 used as part of some frame optimization methods. </td>
5230 </tr>
5231
5232 <tr>
5233 <td>remove-zero</td>
5234 <td>Remove any image with a zero time delay, unless ALL the
5235 images have a zero time delay (and is not a proper timed animation, a
5236 warning is then issued). </td>
5237 </tr>
5238
5239 <tr><td></td><td>In a GIF animation, such images are usually frames which
5240 provide partial intermediary updates between the frames that are
5241 actually displayed to users. These frames are usually added for
5242 improved frame optimization in GIF animations. </td>
5243 </tr>
5244
5245 <tr>
5246 <td>trim-bounds</td>
5247 <td>Find the bounds of all the images in the current
5248 image sequence, then adjust the offsets so all images are contained on
5249 a minimal positive canvas. None of the image data is modified or
5250 merged, only the individual image virtual canvas size and offset.
5251 All the images is given the same canvas size, and and will have
5252 a positive offset, but will remain in the same position relative to
5253 each other. As a result of the minimal canvas size at least one image
5254 will touch every edge of that canvas. The image data touching those
5255 edges however may be transparent. </td>
5256 </tr>
5257
5258 <tr><td></td><td>The result is much like if you used 'merge' followed by a
Cristy594d2772015-11-15 10:47:42 -05005259 <a href="command-line-options.html#repage" >+repage</a> option, except that all the images
Cristy882d9f42015-10-29 16:48:39 -04005260 have been kept separate. If 'flatten' is used after using
5261 'trim-bounds' you will get the same result. </td>
5262 </tr>
5263
5264 </tbody>
5265</table>
5266
5267<p>To print a complete list of layer types, use <a href="command-line-options.html#list">-list layers</a>.</p>
5268
Cristy594d2772015-11-15 10:47:42 -05005269<p>The operators <a href="command-line-options.html#coalesce" >-coalesce</a>, <a href="command-line-options.html#deconstruct"
5270>-deconstruct</a>, <a href="command-line-options.html#flatten" >-flatten</a>, and <a href="command-line-options.html#mosaic"
5271>-mosaic</a> are only aliases for the above methods and may be depreciated in
5272the future. Also see <a href="command-line-options.html#page" >-page</a>, <a href="command-line-options.html#repage"
5273>-repage</a> operators, the <a href="command-line-options.html#compose" >-compose</a> setting, and the
5274GIF <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 -04005275settings. </p>
5276
5277
5278<div style="margin: auto;">
5279 <h3 class="magick-header"><a id="level"></a>-level <var>black_point</var>{,<var>white_point</var>}{<var>%</var>}{,<var>gamma</var>}</h3>
5280</div>
5281
5282<p class="magick-description">adjust the level of image channels.</p>
5283
5284<p>Given one, two or three values delimited with commas: black-point,
5285white-point, gamma (for example: 10,250,1.0 or 2%,98%,0.5). The black and
5286white points range from 0 to <var>QuantumRange</var>, or from 0 to
5287100%; if the white point is omitted it is set to (<var>QuantumRange</var> - black_point), so as to center contrast changes.
5288If a <code>%</code> sign is present anywhere in the string, both black and white
Cristy594d2772015-11-15 10:47:42 -05005289points are percentages of the full color range. Gamma will do a <a
5290href="command-line-options.html#gamma">-gamma</a> adjustment of the values. If it is omitted, the
Cristy882d9f42015-10-29 16:48:39 -04005291default of 1.0 (no gamma correction) is assumed.</p>
5292
5293<p>In normal usage (<code>-level</code>) the image values are stretched so that
5294the given '<code>black_point</code>' value in the original image is set to zero
5295(or black), while the given '<code>white_point</code>' value is set to <var>QuantumRange</var> (or white). This provides you with direct
5296contrast adjustments to the image. The '<code>gamma</code>' of the resulting
5297image will then be adjusted. </p>
5298
5299<p>From ImageMagick v6.4.1-9 using the plus form of the operator
5300(<code>+level</code>) or adding the special '!' flag anywhere in the argument
5301list, will cause the operator to do the reverse of the level adjustment. That
5302is a zero, or <var>QuantumRange</var> value (black, and white, resp.)
5303in the original image, is adjusted to the given level values, allowing you to
5304de-contrast, or compress the channel values within the image. The
5305'<code>gamma</code>' is adjusted before the level adjustment to de-contrast the
5306image is made. </p>
5307
5308<p>Only the channels defined by the current <a href="command-line-options.html#channel">-channel</a>
5309setting are adjusted (defaults to RGB color channels only), allowing you to
5310limit the effect of this operator. </p>
5311
5312<p>Please note that the transparency channel is treated as 'matte'
5313values (0 is opaque) and not as 'alpha' values (0 is transparent).</p>
5314
5315
5316<div style="margin: auto;">
5317 <h3 class="magick-header"><a id="level-colors"></a>-level-colors {<var>black_color</var>}{,}{<var>white_color</var>}</h3>
5318</div>
5319
5320<p class="magick-description">adjust the level of an image using the provided dash separated colors.</p>
5321
5322<p>This function is exactly like <a href="command-line-options.html#level">-level</a>, except that the
5323value value for each color channel is determined by the
5324'<code>black_color</code>' and '<code>white_color</code>' colors given (as
5325described under the <a href="command-line-options.html#fill">-fill</a> option). </p>
5326
5327<p>This effectually means the colors provided to <code>-level-colors</code>
5328is mapped to become 'black' and 'white' respectively, with all the other
5329colors linearly adjusted (or clipped) to match that change. Each channel is
5330adjusted separately using the channel values of the colors specified. </p>
5331
5332<p>On the other hand the plus form of the operator (<code>+level-colors</code>)
5333will map the image color 'black' and 'white' to the given colors
5334respectively, resulting in a gradient (de-contrasting) tint of the image to
Cristy769d8892016-01-19 18:11:14 -05005335those colors. This can also be used to convert a plain grayscale image into a
Cristy882d9f42015-10-29 16:48:39 -04005336one using the gradient of colors specified. </p>
5337
5338<p>By supplying a single color with a comma separator either before or after
5339that color, will just replace the respective 'black' or 'white' point
5340respectively. But if no comma separator is provided, the given color is
5341used for both the black and white color points, making the operator either
5342threshold the images around that color (- form) or set all colors to that
5343color (+ form). </p>
5344
5345
5346<div style="margin: auto;">
5347 <h3 class="magick-header"><a id="limit"></a>-limit <var>type value</var></h3>
5348</div>
5349
5350<p class="magick-description">Set the pixel cache resource limit.</p>
5351
Cristye09ed312016-03-06 08:07:39 -05005352<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 -04005353
5354<p>The value for <code>file</code> is in number of files. The other limits are
5355in bytes. Define arguments for the memory, map, area, and disk resource limits
5356with SI prefixes (.e.g 100MB).</p>
5357
5358<p>By default the limits are 768 files, 3GB of image area, 1.5GiB memory, 3GiB
5359memory map, and 18.45EB of disk. These limits are adjusted relative to the
5360available resources on your computer if this information is available. When
5361any limit is reached, ImageMagick fails in some fashion but attempts to take
5362compensating actions, if possible. For example, the following limits
5363memory:</p>
5364
5365<pre>
5366-limit memory 32MiB -limit map 64MiB
5367</pre>
5368
5369<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>
5370
5371<pre>
Cristy594d2772015-11-15 10:47:42 -05005372-> identify -list resource
Cristy882d9f42015-10-29 16:48:39 -04005373Resource limits:
5374 Width: 100MP
5375 Height: 100MP
5376 Area: 25.181GB
5377 Memory: 11.726GiB
5378 Map: 23.452GiB
5379 Disk: unlimited
5380 File: 768
5381 Thread: 12
5382 Throttle: 0
5383 Time: unlimited
5384</pre>
5385
5386<p>Requests for pixel storage to keep intermediate images are satisfied by one
5387of three resource categories: in-memory pool, memory-mapped files pool, and
Cristy594d2772015-11-15 10:47:42 -05005388disk pool (in that order) depending on the <a href="command-line-options.html#limit">&#x2011;limit</a> settings
Cristy882d9f42015-10-29 16:48:39 -04005389and whether the system honors a resource request. If the total size of
5390allocated pixel storage in the given pool reaches the corresponding limit, the
5391request is passed to the next pool. Additionally, requests that exceed the
5392<code>area</code> limit automagically are allocated on disk.</p>
5393
5394<p>To illustrate how ImageMagick utilizes resource limits, consider a typical
5395image resource request. First, ImageMagick tries to allocate the pixels in
5396memory. The request might be denied if the resource request exceeds the
5397<code>memory</code> limit or if the system does not honor the request. If
5398a memory request is not honored, the pixels are allocated to disk and the file
5399is memory-mapped. However, if the allocation request exceeds the
5400<code>map</code> limit, the resource allocation goes to disk. In all cases, if
5401the resource request exceeds the <code>area</code> limit, the pixels are
5402automagically cached to disk. If the disk has a hard limit, the program
5403fails.</p>
5404
5405<p>In most cases you simply do not need to concern yourself with resource
5406limits. ImageMagick chooses reasonable defaults and most images do not tax
5407your computer resources. Where limits do come in handy is when you process
5408images that are large or on shared systems where ImageMagick can consume all
5409or most of the available memory. In this case, the ImageMagick workflow slows
5410other processes or, in extreme cases, brings the system to a halt. Under
5411these circumstances, setting limits give some assurances that the ImageMagick
5412workflow will not interfere with other concurrent uses of the computer. For
5413example, assume you have a web interface that processes images uploaded from
5414the Internet. To assure ImageMagick does not exceed 10MiB of memory you can
5415simply set the area limit to 10MiB:</p>
5416
5417<pre>
5418-limit area 10MB
5419</pre>
5420
5421<p>Now whenever a large image is processed, the pixels are automagically
5422cached to disk instead of memory. This of course implies that large images
5423typically process very slowly, simply because pixel processing in memory can
5424be an order of magnitude faster than on disk. Because your web site users
5425might inadvertently upload a huge image to process, you should set a disk
5426limit as well:</p>
5427
5428<pre>
5429-limit area 10MB -limit disk 500MB
5430</pre>
5431
5432<p>Here ImageMagick stops processing if an image requires more than 500MB of disk storage.</p>
5433
5434<p>In addition to command-line resource limit option, resources can be set
Cristy594d2772015-11-15 10:47:42 -05005435with <a href="resources.html#environment" >environment variables</a>. Set the
Cristy882d9f42015-10-29 16:48:39 -04005436environment variables <code>MAGICK_AREA_LIMIT</code>,
5437<code>MAGICK_DISK_LIMIT</code>, <code>MAGICK_FILE_LIMIT</code>,
5438<code>MAGICK_MEMORY_LIMIT</code>, <code>MAGICK_MAP_LIMIT</code>,
5439<code>MAGICK_THREAD_LIMIT</code>, <code>MAGICK_TIME_LIMIT</code> for limits of
5440image area, disk space, open files, heap memory, memory map, number of threads
5441of execution, and maximum elapsed time in seconds respectively.</p>
5442
5443<p> Inquisitive users can try adding <a href="command-line-options.html#debug">-debug cache</a> to
5444their commands and then scouring the generated output for references to the
5445pixel cache, in order to determine how the pixel cache was allocated and how
5446resources were consumed. Advanced Unix/Linux users can pipe that output
5447through <code>grep memory|open|destroy|disk</code> for more readable sifting.
5448</p>
5449
5450<p>For more about ImageMagick's use of resources, see the section <b>Cache
Cristy594d2772015-11-15 10:47:42 -05005451Storage and Resource Requirements</b> on the <a href="architecture.html#cache
5452">Architecture</a> page. </p>
Cristy882d9f42015-10-29 16:48:39 -04005453
5454<div style="margin: auto;">
Cristy769d8892016-01-19 18:11:14 -05005455 <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 -04005456</div>
5457
5458<p class="magick-description">Linear with saturation stretch.</p>
5459
Cristy594d2772015-11-15 10:47:42 -05005460<p>This is very similar to <a href="command-line-options.html#contrast-stretch" >-contrast-stretch</a>,
Cristy882d9f42015-10-29 16:48:39 -04005461and uses a 'histogram bin' to determine the range of color values that needs to
Cristy594d2772015-11-15 10:47:42 -05005462be stretched. However it then stretches those colors using the <a
5463href="command-line-options.html#level" >-level</a> operator.</p>
Cristy882d9f42015-10-29 16:48:39 -04005464
5465<p>As such while the initial determination may have 'binning' round off
5466effects, the image colors are stretched mathematically, rather than using the
5467histogram bins. This makes the operator more accurate. </p>
5468
Cristy594d2772015-11-15 10:47:42 -05005469<p>note however that a <a href="command-line-options.html#linear-stretch" >-linear-stretch</a> of
Cristy882d9f42015-10-29 16:48:39 -04005470'<code>0</code>' does nothing, while a value of '<code>1</code>' does a near
5471perfect stretch of the color range. </p>
5472
Cristy594d2772015-11-15 10:47:42 -05005473<p>See also <a href="command-line-options.html#auto-level" >-auto-level</a> for a 'perfect'
Cristy882d9f42015-10-29 16:48:39 -04005474normalization of mathematical images. </p>
5475
5476<p>This operator is under review for re-development. </p>
5477
5478
5479<div style="margin: auto;">
5480 <h3 class="magick-header"><a id="linewidth"></a>-linewidth</h3>
5481</div>
5482
5483<p class="magick-description">the line width for subsequent draw operations.</p>
5484
5485<div style="margin: auto;">
5486 <h3 class="magick-header"><a id="liquid-rescale"></a>-liquid-rescale <var>geometry</var></h3>
5487</div>
5488
5489<p class="magick-description">rescale image with seam-carving.</p>
5490
5491<p>See <a href="command-line-processing.html#geometry">Image Geometry</a> for complete details about the <em class="arg">geometry</em> argument.</p>
5492
5493<div style="margin: auto;">
5494 <h3 class="magick-header"><a id="list"></a>-list <var>type</var></h3>
5495</div>
5496
5497<p class="magick-description">Print a list of supported arguments for various options or settings. Choose from these list types:</p>
5498
5499<pre class="pre-scrollable">
5500Align
5501Alpha
5502Boolean
5503Cache
5504Channel
5505Class
5506ClipPath
5507Coder
5508Color
5509Colorspace
5510Command
5511Complex
5512Compose
5513Compress
5514Configure
5515DataType
5516Debug
5517Decoration
5518Delegate
5519Direction
5520Dispose
5521Distort
5522Dither
5523Endian
5524Evaluate
5525FillRule
5526Filter
5527Font
5528Format
5529Function
5530Gravity
5531Intensity
5532Intent
5533Interlace
5534Interpolate
5535Kernel
5536Layers
5537LineCap
5538LineJoin
5539List
5540Locale
5541LogEvent
5542Log
5543Magic
5544Method
5545Metric
5546Mime
5547Mode
5548Morphology
5549Module
5550Noise
5551Orientation
5552PixelIntensity
5553Policy
5554PolicyDomain
5555PolicyRights
5556Preview
5557Primitive
5558QuantumFormat
5559Resource
5560SparseColor
5561Statistic
5562Storage
5563Stretch
5564Style
5565Threshold
5566Type
5567Units
5568Validate
5569VirtualPixel
5570</pre>
5571
5572<p>These lists vary depending on your version of ImageMagick. Use "<code>-list
5573list</code>" to get a complete listing of all the "<code>-list</code>" arguments
5574available:</p>
5575
5576<pre>
5577identify -list list
5578</pre>
5579
5580<div style="margin: auto;">
5581 <h3 class="magick-header"><a id="log"></a>-log <var>string</var></h3>
5582</div>
5583
5584<p class="magick-description">Specify format for debug log.</p>
5585
Cristy594d2772015-11-15 10:47:42 -05005586<p>This option specifies the format for the log printed when the <a
5587href="command-line-options.html#debug">-debug</a> option is active.</p>
Cristy882d9f42015-10-29 16:48:39 -04005588
5589<p>You can display the following components by embedding special format
5590characters:</p>
5591
5592<dl class="dl-horizontal">
5593<dt>%d</dt><dd>domain</dd>
5594<dt>%e</dt><dd>event</dd>
5595<dt>%f</dt><dd>function</dd>
5596<dt>%l</dt><dd>line</dd>
5597<dt>%m</dt><dd>module</dd>
5598<dt>%p</dt><dd>process ID</dd>
5599<dt>%r</dt><dd>real CPU time</dd>
5600<dt>%t</dt><dd>wall clock time</dd>
5601<dt>%u</dt><dd>user CPU time</dd>
5602<dt>%%</dt><dd>percent sign</dd>
5603<dt>\n</dt><dd>newline</dd>
5604<dt>\r</dt><dd>carriage return</dd>
5605</dl>
5606
5607<p>For example:</p>
5608
5609<pre>
5610convert -debug coders -log "%u %m:%l %e" in.gif out.png
5611</pre>
5612
5613<p>The default behavior is to print all of the components.</p>
5614
5615<div style="margin: auto;">
5616 <h3 class="magick-header"><a id="loop"></a>-loop <var>iterations</var></h3>
5617</div>
5618
5619<p class="magick-description">add Netscape loop extension to your GIF animation.</p>
5620
5621<p>Set iterations to zero to repeat the animation an infinite number of times,
5622otherwise the animation repeats itself up to <var>iterations</var>
5623times.</p>
5624
5625<div style="margin: auto;">
5626 <h3 class="magick-header"><a id="lowlight-color"></a>-lowlight-color <var>color</var></h3>
5627</div>
5628
5629<p class="magick-description">when comparing images, de-emphasize pixel differences with this color.</p>
5630
5631<div style="margin: auto;">
5632 <h3 class="magick-header"><a id="magnify"></a>-magnify</h3>
5633</div>
5634
5635<p class="magick-description">double the size of the image with pixel art scaling.</p>
5636
5637
5638<div style="margin: auto;">
5639 <h3 class="magick-header"><a id="map"></a>-map <var>type</var></h3>
5640</div>
5641
5642<p class="magick-description">Display image using this <var>type</var>.</p>
5643
5644<p>Choose from these <var>Standard Colormap</var> types:</p>
5645
5646<pre>
5647best
5648default
5649gray
5650red
5651green
5652blue
5653</pre>
5654
5655<p>The <var>X server</var> must support the <var>Standard
5656Colormap</var> you choose, otherwise an error occurs. Use <code>list</code> as
5657the type and <code>display</code> searches the list of colormap types in
5658<code>top-to-bottom</code> order until one is located. See <var>xstdcmap(1)</var> for one way of creating Standard Colormaps.</p>
5659
5660
5661<div style="margin: auto;">
5662 <h3 class="magick-header"><a id="map_stream_"></a>-map <var>components</var></h3>
5663</div>
5664
5665<p class="magick-description">pixel map.</p>
5666
5667<p>Here are the valid components of a map:</p>
5668
5669<dl class="dl-horizontal">
5670<dt>r</dt><dd> red pixel component</dd>
5671<dt>g</dt><dd> green pixel component</dd>
5672<dt>b</dt><dd> blue pixel component</dd>
5673<dt>a</dt><dd> alpha pixel component (0 is transparent)</dd>
5674<dt>o</dt><dd> opacity pixel component (0 is opaque)</dd>
5675<dt>i</dt><dd> grayscale intensity pixel component</dd>
5676<dt>c</dt><dd> cyan pixel component</dd>
5677<dt>m</dt><dd> magenta pixel component</dd>
5678<dt>y</dt><dd> yellow pixel component</dd>
5679<dt>k</dt><dd> black pixel component</dd>
5680<dt>p</dt><dd> pad component (always 0)</dd>
5681</dl>
5682
5683<p>You can specify as many of these components as needed in any order (e.g.
5684bgr). The components can repeat as well (e.g. rgbr).</p>
5685
5686
5687<div style="margin: auto;">
Cristy882d9f42015-10-29 16:48:39 -04005688 <h3 class="magick-header"><a id="mattecolor"></a>-mattecolor <var>color</var></h3>
5689</div>
5690
5691<p class="magick-description">Specify the color to be used with the <a href="command-line-options.html#frame">-frame</a> option.</p>
5692
5693<p>The color is specified using the format described under the <a href="command-line-options.html#fill">-fill</a> option.</p>
5694
Cristy594d2772015-11-15 10:47:42 -05005695<p>The default matte color is <code>#BDBDBD</code>, <span
5696style="background-color: #bdbdbd;">this shade of gray</span>.</p>
Cristy882d9f42015-10-29 16:48:39 -04005697
Cristyf650f4f2016-04-01 10:53:07 -04005698<p>This is an IMv6 option, use <a href="command-line-options.html#alpha-color">-alpha-color</a> with IMv7.</p>
5699
Cristy882d9f42015-10-29 16:48:39 -04005700<div style="margin: auto;">
5701 <h3 class="magick-header"><a id="maximum"></a>-maximum</h3>
5702</div>
5703
5704<p class="magick-description">return the maximum intensity of an image sequence.</p>
5705
5706<p>Select the 'maximum' value from all the surrounding pixels. </p>
5707
Cristy594d2772015-11-15 10:47:42 -05005708<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 -04005709name. </p>
5710
5711<div style="margin: auto;">
5712 <h3 class="magick-header"><a id="median"></a>-median <var>geometry</var></h3>
5713</div>
5714
5715<p class="magick-description">apply a median filter to the image.</p>
5716
5717<p>Select the 'middle' value from all the surrounding pixels. </p>
5718
Cristy594d2772015-11-15 10:47:42 -05005719<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 -04005720name. </p>
5721
5722<div style="margin: auto;">
Cristy769d8892016-01-19 18:11:14 -05005723 <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 -04005724</div>
5725
5726<p class="magick-description">image noise removal and color reduction/segmentation (e.g. -mean-shift 7x7+10%).</p>
5727
5728<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>
5729
5730<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>
5731
5732<div style="margin: auto;">
5733 <h3 class="magick-header"><a id="metric"></a>-metric <var>type</var></h3>
5734</div>
5735
5736<p class="magick-description">Output to STDERR a measure of the differences between images according to the <var>type</var> given metric.</p>
5737
5738<p>Choose from:</p>
5739
5740<dl class="dl-horizontal">
5741<dt>AE</dt><dd> absolute error count, number of different pixels (-fuzz effected)</dd>
5742<dt>FUZZ</dt><dd> mean color distance</dd>
5743<dt>MAE</dt><dd> mean absolute error (normalized), average channel error distance</dd>
5744<dt>MEPP</dt><dd> mean error per pixel (normalized mean error, normalized peak error)</dd>
5745<dt>MSE</dt><dd> mean error squared, average of the channel error squared</dd>
5746<dt>NCC</dt><dd> normalized cross correlation</dd>
5747<dt>PAE</dt><dd> peak absolute (normalized peak absolute)</dd>
Cristy3b0b58d2016-11-06 07:40:23 -05005748<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 -04005749<dt>PSNR</dt><dd> peak signal to noise ratio</dd>
5750<dt>RMSE</dt><dd> root mean squared (normalized root mean squared)</dd>
5751</dl>
5752
5753<p>Control the '<code>AE</code>', or absolute count of pixels that are different,
Cristy594d2772015-11-15 10:47:42 -05005754with the <a href="command-line-options.html#fuzz" >-fuzz</a> factor (ignore pixels which
Cristy882d9f42015-10-29 16:48:39 -04005755only changed by a small amount). Use '<code>PAE</code>' to find the
Cristy594d2772015-11-15 10:47:42 -05005756size of the <a href="command-line-options.html#fuzz" >-fuzz</a> factor needed to make all pixels
Cristy882d9f42015-10-29 16:48:39 -04005757'similar', while '<code>MAE</code>' determines the factor needed
5758for about half the pixels to be similar. </p>
5759
5760<p>The '<code>MEPP</code>' metric returns three different metrics
5761('<code>MAE</code>', '<code>MAE</code>' normalized, and '<code>PAE</code>'
5762normalized) from a single comparison run. </p>
5763
5764<p>To print a complete list of metrics, use the <a href="command-line-options.html#list">-list
5765metric</a> option.</p>
5766
5767
5768<div style="margin: auto;">
5769 <h3 class="magick-header"><a id="minimum"></a>-minimum</h3>
5770</div>
5771
5772<p class="magick-description">return the minimum intensity of an image sequence.</p>
5773
5774<p>Select the 'minimal' value from all the surrounding pixels. </p>
5775
Cristy594d2772015-11-15 10:47:42 -05005776<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 -04005777name. </p>
5778
5779
5780
5781<div style="margin: auto;">
5782 <h3 class="magick-header"><a id="mode"></a>-mode <var>geometry</var></h3>
5783</div>
5784
5785<p class="magick-description">make each pixel the \'predominant color\' of the neighborhood.'</p>
5786
5787<div style="margin: auto;">
5788 <h3 class="magick-header">-mode <var>value</var></h3>
5789</div>
5790
5791<p class="magick-description">Mode of operation.</p>
5792
5793<p>Choose the <var>value</var> from these styles: <code>Frame,
5794Unframe, or Concatenate</code></p>
5795
Cristy594d2772015-11-15 10:47:42 -05005796<p>Use the <a href="command-line-options.html#list" >-list</a> option with a '<code>Mode</code>' argument
5797for a list of <a href="command-line-options.html#mode" >-mode</a> arguments available in your
Cristy882d9f42015-10-29 16:48:39 -04005798ImageMagick installation.</p>
5799
5800
5801<div style="margin: auto;">
5802 <h3 class="magick-header"><a id="modulate"></a>-modulate <var>brightness</var>[,<var>saturation</var>,<var>hue</var>]</h3>
5803</div>
5804
5805<p class="magick-description">Vary the <var>brightness</var>, <var>saturation</var>, and <var>hue</var> of an image.</p>
5806
5807<p>The arguments are given as a percentages of variation. A value of 100 means
5808no change, and any missing values are taken to mean 100.</p>
5809
5810<p>The <var>brightness</var> is a multiplier of the overall
5811brightness of the image, so 0 means pure black, 50 is half as bright, 200 is
5812twice as bright. To invert its meaning <a href="command-line-options.html#negate">-negate</a> the image
5813before and after. </p>
5814
5815<p>The <var>saturation</var> controls the amount of color in an
5816image. For example, 0 produce a grayscale image, while a large value such as
5817200 produce a very colorful, 'cartoonish' color.</p>
5818
5819<p>The <var>hue</var> argument causes a "rotation" of the colors
5820within the image by the amount specified. For example, 50 results in
5821a counter-clockwise rotation of 90, mapping red shades to purple, and so on.
5822A value of either 0 or 200 results in a complete 180 degree rotation of the
5823image. Using a value of 300 is a 360 degree rotation resulting in no change to
5824the original image. </p>
5825
5826<p>For example, to increase the color brightness by 20% and decrease the color
Cristy594d2772015-11-15 10:47:42 -05005827saturation by 10% and leave the hue unchanged, use <a
5828href="command-line-options.html#modulate">-modulate 120,90</a>.</p>
Cristy882d9f42015-10-29 16:48:39 -04005829
Cristy594d2772015-11-15 10:47:42 -05005830<p>Use <a href="command-line-options.html#set">-set</a> attribute of '<code
5831>option:modulate:colorspace</code>' to specify which colorspace to
Cristy882d9f42015-10-29 16:48:39 -04005832modulate. 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>
5833
5834<pre>
5835convert image.png -set option:modulate:colorspace hsb -modulate 120,90 modulate.png
5836</pre>
5837
5838<div style="margin: auto;">
5839 <h3 class="magick-header"><a id="moments"></a>-moments</h3>
5840</div>
5841
5842<p class="magick-description">report image moments and perceptual hash.</p>
5843
5844
5845<div style="margin: auto;">
5846 <h3 class="magick-header"><a id="monitor"></a>-monitor</h3>
5847</div>
5848
5849<p class="magick-description">monitor progress.</p>
5850
5851
5852<div style="margin: auto;">
5853 <h3 class="magick-header"><a id="monochrome"></a>-monochrome</h3>
5854</div>
5855
5856<p class="magick-description">transform the image to black and white.</p>
5857
5858<div style="margin: auto;">
5859 <h3 class="magick-header"><a id="morph"></a>-morph <var>frames</var></h3>
5860</div>
5861
5862<p class="magick-description">morphs an image sequence.</p>
5863
5864<p>Both the image pixels and size are linearly interpolated to give the
5865appearance of a metamorphosis from one image to the next, over all the images
Cristy594d2772015-11-15 10:47:42 -05005866in the current image list. The added images are the equivalent of a <a
5867href="command-line-options.html#blend">-blend</a> composition. The <var>frames</var>
Cristy882d9f42015-10-29 16:48:39 -04005868argument determine how many images to interpolate between each image. </p>
5869
5870
5871<div style="margin: auto;">
5872 <h3 class="magick-header"><a id="morphology"></a>-morphology</h3>
5873 <h3 class="magick-header">-morphology <var>method</var> <var>kernel</var></h3>
5874</div>
5875
5876<p class="magick-description">apply a morphology method to the image.</p>
5877
Cristy594d2772015-11-15 10:47:42 -05005878<p>Until I get around to writing an option summary for this, see <a
Cristy364a72f2016-11-04 22:38:41 -04005879href="https://www.imagemagick.org/Usage/morphology/" >IM Usage Examples,
Cristy882d9f42015-10-29 16:48:39 -04005880Morphology</a>. </p>
5881
5882
5883<div style="margin: auto;">
5884 <h3 class="magick-header"><a id="mosaic"></a>-mosaic</h3>
5885</div>
5886
Cristy594d2772015-11-15 10:47:42 -05005887<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 -04005888
5889
5890<div style="margin: auto;">
Cristy594d2772015-11-15 10:47:42 -05005891 <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 -04005892</div>
5893
5894<p class="magick-description">simulate motion blur.</p>
5895
5896<p>Blur with the given radius, standard deviation (sigma), and angle. The
5897angle given is the angle toward which the image is blurred. That is the
5898direction people would consider the object is coming from. </p>
5899
5900<p>Note that the blur is not uniform distribution, giving the motion a
5901definite sense of direction of movement. </p>
5902
5903<p>The <a href="command-line-options.html#virtual-pixel">-virtual-pixel</a> setting will determine how
5904pixels which are outside the image proper are blurred into the final result.
5905</p>
5906
5907<div style="margin: auto;">
5908 <h3 class="magick-header"><a id="name"></a>-name</h3>
5909</div>
5910
5911<p class="magick-description">name an image.</p>
5912<div style="margin: auto;">
5913 <h3 class="magick-header"><a id="negate"></a>-negate</h3>
5914</div>
5915
5916<p class="magick-description">replace each pixel with its complementary color.</p>
5917
5918<p>The red, green, and blue intensities of an image are negated. White becomes
5919black, yellow becomes blue, etc. Use <a href="command-line-options.html#negate">+negate</a> to only
5920negate the grayscale pixels of the image.</p>
5921
5922<div style="margin: auto;">
Cristy594d2772015-11-15 10:47:42 -05005923 <h3 class="magick-header"><a id="noise"></a>-noise <var>geometry</var><br/>
Cristy882d9f42015-10-29 16:48:39 -04005924 +noise <var>type</var></h3>
5925</div>
5926
5927<p class="magick-description">Add or reduce noise in an image.</p>
5928
5929<p>The principal function of noise peak elimination filter is to smooth the
5930objects within an image without losing edge information and without creating
5931undesired structures. The central idea of the algorithm is to replace a pixel
5932with its next neighbor in value within a pixel window, if this pixel has been
5933found to be noise. A pixel is defined as noise if and only if this pixel is
5934a maximum or minimum within the pixel window.</p>
5935
5936<p>Use <code><a href="command-line-options.html#noise">-noise</a> <var>radius</var></code> to
5937specify the width of the neighborhood when reducing noise. This is equivalent
Cristy594d2772015-11-15 10:47:42 -05005938to using a <code><a href="command-line-options.html#statistic" >-statistic</a> NonPeak</code> operation,
Cristy882d9f42015-10-29 16:48:39 -04005939which should be used in preference.</p>
5940
5941<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
5942types:</p>
5943
5944<pre>
5945Gaussian
5946Impulse
5947Laplacian
5948Multiplicative
5949Poisson
5950Random
5951Uniform
5952</pre>
5953
Cristy594d2772015-11-15 10:47:42 -05005954<p>The amount of noise added can be controlled by the <code><a
5955href="command-line-options.html#attenuate" >-attenuate</a></code> setting. If unset the value is
Cristy882d9f42015-10-29 16:48:39 -04005956equivalent to 1.0, or a maximum noise addition.</p>
5957
5958<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>
5959
5960<p>To print a complete list of noises, use the <a href="command-line-options.html#list">-list noise</a> option.</p>
5961
5962<p>Also see the <a href="command-line-options.html#evaluate">-evaluate</a> noise functions that allows
5963the use of a controlling value to specify the amount of noise that should be
5964added to an image. </p>
5965
5966
5967<div style="margin: auto;">
5968 <h3 class="magick-header"><a id="normalize"></a>-normalize</h3>
5969</div>
5970
5971<p class="magick-description">Increase the contrast in an image by <var>stretching</var> the range of intensity values.</p>
5972
5973<p>The intensity values are stretched to cover the entire range of possible
5974values. While doing so, black-out at most <var>2%</var> of the pixels and
5975white-out at most <var>1%</var> of the pixels.</p>
5976
Cristy594d2772015-11-15 10:47:42 -05005977<p>Note that as of ImageMagick 6.4.7-0, <a href="command-line-options.html#normalize" >-normalize</a>
5978is equivalent to <a href="command-line-options.html#contrast-stretch" >-contrast-stretch 2%x1%</a>.
5979(Before this version, it was equivalent to <a href="command-line-options.html#contrast-stretch"
5980>-contrast-stretch 2%x99%</a>).</p>
Cristy882d9f42015-10-29 16:48:39 -04005981
Cristy769d8892016-01-19 18:11:14 -05005982<p>All the channels are normalized in concert by the same amount so as to
Cristy594d2772015-11-15 10:47:42 -05005983preserve color integrity, when the default <a href="command-line-options.html#channel" >+channel</a>
5984setting is in use. Specifying any other <a href="command-line-options.html#channel" >-channel</a>
Cristy882d9f42015-10-29 16:48:39 -04005985setting will normalize the RGB channels independently.</p>
5986
Cristy594d2772015-11-15 10:47:42 -05005987<p>See <a href="command-line-options.html#contrast-stretch" >-contrast-stretch</a> for more details.
5988Also see <a href="command-line-options.html#auto-level" >-auto-level</a> for a 'perfect' normalization
Cristy882d9f42015-10-29 16:48:39 -04005989that is better suited to mathematically generated images. </p>
5990
5991<p>This operator is under review for re-development. </p>
5992
5993
5994<div style="margin: auto;">
5995 <h3 class="magick-header"><a id="opaque"></a>-opaque <var>color</var></h3>
5996</div>
5997
5998<p class="magick-description">change this color to the fill color within the image.</p>
5999
6000<p>The <var>color</var> argument is defined using the format
Cristy594d2772015-11-15 10:47:42 -05006001described under the <a href="command-line-options.html#fill" >-fill</a> option. The <a href="command-line-options.html#fuzz"
6002>-fuzz</a> setting can be used to match and replace colors similar to the one
Cristy882d9f42015-10-29 16:48:39 -04006003given.</p>
6004
6005<p>Use <a href="command-line-options.html#opaque">+opaque</a> to paint any pixel that does not match
6006the target color. </p>
6007
6008<p>The <a href="command-line-options.html#transparent">-transparent</a> operator is exactly the same
Cristy594d2772015-11-15 10:47:42 -05006009as <a href="command-line-options.html#opaque" >-opaque</a> but replaces the matching color with
Cristy882d9f42015-10-29 16:48:39 -04006010transparency rather than the current <a href="command-line-options.html#fill">-fill</a> color setting.
6011To ensure that it can do this it also ensures that the image has an alpha
Cristy594d2772015-11-15 10:47:42 -05006012channel enabled, as per "<code><a href="command-line-options.html#alpha" >-alpha</a> set</code>", for
6013the new transparent colors, and does not require you to modify the <a
6014href="command-line-options.html#channel">-channel</a> to enable alpha channel handling. </p>
Cristy882d9f42015-10-29 16:48:39 -04006015
6016
6017<div style="margin: auto;">
6018 <h3 class="magick-header"><a id="ordered-dither"></a>-ordered-dither <var>threshold_map</var>{,<var>level</var>...}</h3>
6019</div>
6020
6021<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
6022given number of <var>levels</var> per color channel.</p>
6023
6024<p>You can choose from these standard threshold maps:</p>
6025
6026<pre class="pre-scrollable">
6027threshold 1x1 Threshold 1x1 (non-dither)
6028checks 2x1 Checkerboard 2x1 (dither)
6029o2x2 2x2 Ordered 2x2 (dispersed)
6030o3x3 3x3 Ordered 3x3 (dispersed)
6031o4x4 4x4 Ordered 4x4 (dispersed)
6032o8x8 8x8 Ordered 8x8 (dispersed)
6033h3x4a 4x1 Halftone 4x4 (angled)
6034h6x6a 6x1 Halftone 6x6 (angled)
6035h8x8a 8x1 Halftone 8x8 (angled)
6036h3x4o Halftone 4x4 (orthogonal)
6037h6x6o Halftone 6x6 (orthogonal)
6038h8x8o Halftone 8x8 (orthogonal)
6039h36x16o Halftone 16x16 (orthogonal)
6040c5x5b c5x5 Circles 5x5 (black)
6041c5x5w Circles 5x5 (white)
6042c6x6b c6x6 Circles 6x6 (black)
6043c6x6w Circles 6x6 (white)
6044c7x7b c7x7 Circles 7x7 (black)
6045c7x7w Circles 7x7 (white)
6046</pre>
6047
6048<p> The <code>threshold</code> generated a simple 50% threshold of the image.
Cristy594d2772015-11-15 10:47:42 -05006049This could be used with <var >level</var> to do the equivalent of <a
6050href="command-line-options.html#posterize" >-posterize</a> to reduce an image to basic primary colors.
Cristy882d9f42015-10-29 16:48:39 -04006051</p>
6052
6053<p>The <code>checks</code> pattern produces a 3 level checkerboard dither
6054pattern. That is a grayscale will become a pattern of solid black, solid
6055white, and mid-tone colors into a checkerboard pattern of black and white.
6056</p>
6057
Cristy594d2772015-11-15 10:47:42 -05006058<p>You can define your own <var >threshold map</var> for ordered
Cristy882d9f42015-10-29 16:48:39 -04006059dithering and halftoning your images, in either personal or system
Cristy594d2772015-11-15 10:47:42 -05006060<code>thresholds.xml</code> XML file. See <a href="resources.html" >Resources</a>
Cristy882d9f42015-10-29 16:48:39 -04006061for more details of configuration files. </p>
6062
6063<p>To print a complete list of the thresholds that have been defined, use the
Cristy594d2772015-11-15 10:47:42 -05006064<a href="command-line-options.html#list" >-list threshold</a> option.</p>
Cristy882d9f42015-10-29 16:48:39 -04006065
6066<p>Note that at this time the same threshold dithering map is used for all
6067color channels, no attempt is made to offset or rotate the map for different
6068channels is made, to create an offset printing effect. Also as the maps are
6069simple threshold levels, the halftone and circle maps will create incomplete
6070circles along the edges of a colored area. Also all the effects are purely
6071on/off boolean effects, without anti-aliasing to make the circles smooth
6072looking. Large dots can be made to look better with a small amount of blurring
6073after being created. </p>
6074
6075
6076<div style="margin: auto;">
6077 <h3 class="magick-header"><a id="orient"></a>-orient <var>image orientation</var></h3>
6078</div>
6079
6080<p class="magick-description">specify orientation of a digital camera image.</p>
6081
6082<p>Choose from these orientations:</p>
6083
6084<pre>
6085bottom-left right-top
6086bottom-right top-left
6087left-bottom top-right
6088left-top undefined
6089right-bottom
6090</pre>
6091
Cristy594d2772015-11-15 10:47:42 -05006092<p>To print a complete list of orientations, use the <a href="command-line-options.html#list" >-list
Cristy882d9f42015-10-29 16:48:39 -04006093orientation</a> option.</p>
6094
6095
6096<div style="margin: auto;">
Cristy594d2772015-11-15 10:47:42 -05006097 <h3 class="magick-header"><a id="page"></a>-page <var>geometry</var><br/>
6098 -page <var>media</var>[<var>offset</var>][{<var>^!&lt;&gt;</var>}]<br/>
Cristy882d9f42015-10-29 16:48:39 -04006099 +page
6100 </h3>
6101</div>
6102
6103<p class="magick-description">Set the size and location of an image on the larger virtual canvas.</p>
6104
6105<p>See <a href="command-line-processing.html#geometry">Image Geometry</a> for complete details about the <em class="arg">geometry</em> argument.</p>
6106
6107<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 -05006108<var>geometry</var> arguments (e.g. <a
6109href="command-line-options.html#page">-page</a> <code>Letter+43+43</code>).</p>
Cristy882d9f42015-10-29 16:48:39 -04006110
6111<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.
6112The choices for a PostScript page are:</p>
6113
6114<dl class="dl-horizontal">
6115<dt> 11x17 </dt> <dd> 792 x 1224</dd>
6116<dt> Ledger </dt> <dd> 1224 x 792</dd>
6117<dt> Legal </dt> <dd> 612 x 1008</dd>
6118<dt> Letter </dt> <dd> 612 x 792</dd>
6119<dt> LetterSmall</dt> <dd> 612 x 792</dd>
6120<dt> ArchE </dt> <dd> 2592 x 3456</dd>
6121<dt> ArchD </dt> <dd> 1728 x 2592</dd>
6122<dt> ArchC </dt> <dd> 1296 x 1728</dd>
6123<dt> ArchB </dt> <dd> 864 x 1296</dd>
6124<dt> ArchA </dt> <dd> 648 x 864</dd>
6125<dt> A0 </dt> <dd> 2380 x 3368</dd>
6126<dt> A1 </dt> <dd> 1684 x 2380</dd>
6127<dt> A2 </dt> <dd> 1190 x 1684</dd>
6128<dt> A3 </dt> <dd> 842 x 1190</dd>
6129<dt> A4 </dt> <dd> 595 x 842</dd>
6130<dt> A4Small </dt> <dd> 595 x 842</dd>
6131<dt> A5 </dt> <dd> 421 x 595</dd>
6132<dt> A6 </dt> <dd> 297 x 421</dd>
6133<dt> A7 </dt> <dd> 210 x 297</dd>
6134<dt> A8 </dt> <dd> 148 x 210</dd>
6135<dt> A9 </dt> <dd> 105 x 148</dd>
6136<dt> A10 </dt> <dd> 74 x 105</dd>
6137<dt> B0 </dt> <dd> 2836 x 4008</dd>
6138<dt> B1 </dt> <dd> 2004 x 2836</dd>
6139<dt> B2 </dt> <dd> 1418 x 2004</dd>
6140<dt> B3 </dt> <dd> 1002 x 1418</dd>
6141<dt> B4 </dt> <dd> 709 x 1002</dd>
6142<dt> B5 </dt> <dd> 501 x 709</dd>
6143<dt> C0 </dt> <dd> 2600 x 3677</dd>
6144<dt> C1 </dt> <dd> 1837 x 2600</dd>
6145<dt> C2 </dt> <dd> 1298 x 1837</dd>
6146<dt> C3 </dt> <dd> 918 x 1298</dd>
6147<dt> C4 </dt> <dd> 649 x 918</dd>
6148<dt> C5 </dt> <dd> 459 x 649</dd>
6149<dt> C6 </dt> <dd> 323 x 459</dd>
6150<dt> Flsa </dt> <dd> 612 x 936</dd>
6151<dt> Flse </dt> <dd> 612 x 936</dd>
6152<dt> HalfLetter </dt> <dd> 396 x 612</dd>
6153</dl>
6154
6155<p>This option is also used to place subimages when writing to a multi-image
6156format that supports offsets, such as GIF89 and MNG. When used for this
6157purpose the offsets are always measured from the top left corner of the canvas
6158and are not affected by the <a href="command-line-options.html#gravity">-gravity</a> option. To
6159position 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
6160file, a <a href="command-line-options.html#page">-page</a> option appearing ahead of the first image in
6161the sequence with nonzero width and height defines the width and height values
6162that are written in the <code>MHDR</code> chunk. Otherwise, the MNG width and
6163height are computed from the bounding box that contains all images in the
6164sequence. When writing a GIF89 file, only the bounding box method is used to
6165determine its dimensions.</p>
6166
Cristy594d2772015-11-15 10:47:42 -05006167<p>For a PostScript page, the image is sized as in <a
6168href="command-line-options.html#geometry">-geometry</a> but positioned relative to the <var>lower
6169left-hand corner</var> of the page by {+-}<code>x</code><var>offset</var>{+-}<code>y</code> <var>offset</var>. Use <a
6170href="command-line-options.html#page">-page 612x792</a>, for example, to center the image within the
Cristy882d9f42015-10-29 16:48:39 -04006171page. If the image size exceeds the PostScript page, it is reduced to fit the
6172page. 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
6173corner of the page, unless the <a href="command-line-options.html#gravity">-gravity</a> option is
6174present with a value other than <var>NorthWest</var>.</p>
6175
6176<p>The default page dimensions for a TEXT image is 612x792.</p>
6177
6178<p>This option is used in concert with <a href="command-line-options.html#density">-density</a>.</p>
6179
6180<p>Use <a href="command-line-options.html#page">+page</a> to remove the page settings for an image.</p>
6181
6182<div style="margin: auto;">
6183 <h3 class="magick-header"><a id="paint"></a>-paint <var>radius</var></h3>
6184</div>
6185
6186<p class="magick-description">simulate an oil painting.</p>
6187
6188<p>Each pixel is replaced by the most frequent color in a circular
6189neighborhood whose width is specified with <var>radius</var>.</p>
6190
6191<div style="margin: auto;">
6192 <h3 class="magick-header"><a id="path"></a>-path <var>path</var></h3></div>
6193
6194<p class="magick-description">write images to this path on disk.</p>
6195
6196<div style="margin: auto;">
6197 <h3 class="magick-header"><a id="pause_animate_"></a>-pause <var>seconds</var></h3>
6198</div>
6199
6200<p class="magick-description">Pause between animation loops</p>
6201
6202<p>Pause for the specified number of seconds before repeating the animation.</p>
6203
6204<div style="margin: auto;">
6205 <h3 class="magick-header"><a id="pause_import_"></a>-pause <var>seconds</var></h3>
6206</div>
6207
6208<p class="magick-description">Pause between snapshots.</p>
6209
6210<p>Pause for the specified number of seconds before taking the next snapshot.</p>
6211
6212<div style="margin: auto;">
6213 <h3 class="magick-header"><a id="perceptible"></a>-perceptible <var>epsilon</var></h3>
6214</div>
6215
6216<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>
6217
6218<div style="margin: auto;">
6219 <h3 class="magick-header"><a id="ping"></a>-ping</h3>
6220</div>
6221
6222<p class="magick-description">efficiently determine image characteristics.</p>
6223
6224<div style="margin: auto;">
6225 <h3 class="magick-header"><a id="pointsize"></a>-pointsize <var>value</var></h3>
6226</div>
6227
6228<p class="magick-description">pointsize of the PostScript, OPTION1, or TrueType font.</p>
6229
6230<div style="margin: auto;">
6231 <h3 class="magick-header"><a id="polaroid"></a>-polaroid <var>angle</var></h3>
6232</div>
6233
6234<p class="magick-description">simulate a Polaroid picture.</p>
6235
6236<p>Use <code>+polaroid</code> to rotate the image at a random angle between -15 and +15 degrees.</p>
6237
6238<div style="margin: auto;">
6239 <h3 class="magick-header"><a id="poly"></a>-poly <var>"wt,exp ..."</var></h3>
6240</div>
6241
6242<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>
6243
6244<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>
6245
6246<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>
6247
6248<p>The format is: <var>output = wt1*image1^exp1 + wt2*image2^exp2 </var>...</p>
6249
6250<p>Some simple uses are:</p>
6251<ul>
6252<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>
6253<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>
6254</ul>
6255
6256<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>
6257
6258<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>
6259
6260
6261<div style="margin: auto;">
6262 <h3 class="magick-header"><a id="posterize"></a>-posterize <var>levels</var></h3>
6263</div>
6264
6265<p class="magick-description">reduce the image to a limited number of color levels per channel.</p>
6266
6267<p>Very low values of <var>levels</var>, e.g., 2, 3, 4, have the most
6268visible effect.</p>
6269
6270<div style="margin: auto;">
6271 <h3 class="magick-header"><a id="precision"></a>-precision <var>value</var></h3>
6272</div>
6273
6274<p class="magick-description">set the maximum number of significant digits to be printed.</p>
6275
6276<div style="margin: auto;">
6277 <h3 class="magick-header"><a id="preview"></a>-preview <var>type</var></h3>
6278</div>
6279
6280<p class="magick-description">image preview type.</p>
6281
6282<p>Use this option to affect the preview operation of an image (e.g.
6283<code>convert file.png -preview Gamma Preview:gamma.png</code>). Choose from
6284these previews:</p>
6285
6286<pre class="pre-scrollable">
6287AddNoise
6288Blur
6289Brightness
6290Charcoal
6291Despeckle
6292Dull
6293EdgeDetect
6294Gamma
6295Grayscale
6296Hue
6297Implode
6298JPEG
6299OilPaint
6300Quantize
6301Raise
6302ReduceNoise
6303Roll
6304Rotate
6305Saturation
6306Segment
6307Shade
6308Sharpen
6309Shear
6310Solarize
6311Spiff
6312Spread
6313Swirl
6314Threshold
6315Wave
6316</pre>
6317
6318<p>To print a complete list of previews, use the <a href="command-line-options.html#list">-list preview</a> option.</p>
6319
6320<p>The default preview is <code>JPEG</code>.</p>
6321
6322<div style="margin: auto;">
6323 <h3 class="magick-header"><a id="print"></a>-print <var>string</var></h3>
6324</div>
6325
6326<p class="magick-description">interpret string and print to console.</p>
6327
6328<div style="margin: auto;">
6329 <h3 class="magick-header"><a id="process"></a>-process <var>command</var></h3>
6330</div>
6331
6332<p class="magick-description">process the image with a custom image filter.</p>
6333
6334<p>The command arguments has the form <code>"module arg1 arg2 arg3 ...
6335argN"</code> where <code>module</code> is the name of the module to invoke (e.g.
6336"Analyze") and arg1 arg2 arg3 ... argN are an arbitrary number of arguments to
6337pass to the process module.</p>
6338
6339<div style="margin: auto;">
Cristy594d2772015-11-15 10:47:42 -05006340 <h3 class="magick-header"><a id="profile"></a>-profile <var>filename</var><br/>
Cristy882d9f42015-10-29 16:48:39 -04006341 +profile <var>profile_name</var></h3>
6342</div>
6343
6344<p class="magick-description">Manage ICM, IPTC, or generic profiles in an image.</p>
6345
6346<p>Using <a href="command-line-options.html#profile">-profile</a> <var>filename</var> adds an
6347ICM (ICC color management), IPTC (newswire information), or a generic profile
6348to the image.</p>
6349
6350<p>Use <a href="command-line-options.html#profile">+profile <var>profile_name</var></a> to
6351remove the indicated profile. ImageMagick uses standard filename globbing, so
6352wildcard expressions may be used to remove more than one profile. Here we
6353remove all profiles from the image except for the XMP profile: <code>+profile
6354"!xmp,*"</code>. </p>
6355
6356<p>Use <code>identify -verbose</code> to find out which profiles are in the
6357image file. Use <a href="command-line-options.html#strip">-strip</a> to remove all profiles (and
6358comments).</p>
6359
6360<p>To extract a profile, the <a href="command-line-options.html#profile">-profile</a> option is not
6361used. Instead, simply write the file to an image format such as <var>APP1, 8BIM, ICM,</var> or <var>IPTC</var>.</p>
6362
6363<p>For example, to extract the Exif data (which is stored in JPEG files in the
6364<var>APP1</var> profile), use.</p>
6365
6366<pre>
6367convert cockatoo.jpg profile.exif
6368</pre>
6369
6370<p>It is important to note that results may depend on whether or not the
Cristy594d2772015-11-15 10:47:42 -05006371original image already has an included profile. Also, keep in mind that <a
6372href="command-line-options.html#profile">-profile</a> is an "operator" (as opposed to a "setting") and
Cristy882d9f42015-10-29 16:48:39 -04006373therefore a conversion is made each time it is encountered, in order, in the
6374command-line. For instance, in the following example, if the original image is
6375CMYK with profile, a CMYK-CMYK-RGB conversion results.</p>
6376
6377<pre>
6378convert CMYK.tif -profile "CMYK.icc" -profile "RGB.icc" RGB.tiff
6379</pre>
6380
6381<p>Furthermore, since ICC profiles are not necessarily symmetric, extra
6382conversion steps can yield unwanted results. CMYK profiles are often very
6383asymmetric since they involve 3−&gt;4 and 4−&gt;3 channel mapping.
6384</p>
6385
6386<div style="margin: auto;">
6387 <h3 class="magick-header"><a id="quality"></a>-quality <var>value</var></h3>
6388</div>
6389
6390<p class="magick-description">JPEG/MIFF/PNG compression level.</p>
6391
6392<p>For the JPEG and MPEG image formats, quality is 1 (lowest image quality and
6393highest compression) to 100 (best quality but least effective compression).
6394The default is to use the estimated quality of your input image if it can
6395be determined, otherwise 92. When the quality is greater than 90, then the
6396chroma channels are not downsampled.
6397Use the <a href="command-line-options.html#sampling-factor">-sampling-factor</a> option to specify the
6398factors for chroma downsampling.</p>
6399
6400<p>For the JPEG-2000 image format, quality is mapped using a non-linear
6401equation to the compression ratio required by the Jasper library. This
6402non-linear equation is intended to loosely approximate the quality provided by
6403the JPEG v1 format. The default quality value 100, a request for non-lossy
6404compression. A quality of 75 results in a request for 16:1 compression.</p>
6405
6406<p>For the MNG and PNG image formats, the quality value sets the zlib
6407compression level (quality / 10) and filter-type (quality % 10). The default
6408PNG "quality" is 75, which means compression level 7 with adaptive PNG
6409filtering, unless the image has a color map, in which case it means
6410compression level 7 with no PNG filtering.</p>
6411
6412<p>For compression level 0 (quality value less than 10), the Huffman-only
6413strategy is used, which is fastest but not necessarily the worst
6414compression.</p>
6415
6416<p>If filter-type is 4 or less, the specified PNG filter-type is used for
6417all scanlines:</p>
6418
6419<dl class="dl-horizontal">
6420<dt>0</dt><dd>none</dd>
6421<dt>1</dt><dd>sub</dd>
6422<dt>2</dt><dd>up</dd>
6423<dt>3</dt><dd>average</dd>
6424<dt>4</dt><dd>Paeth</dd>
6425</dl>
6426
6427<p>If filter-type is 5, adaptive filtering is used when quality is greater
6428than 50 and the image does not have a color map, otherwise no filtering is
6429used.</p>
6430
6431<p>If filter-type is 6, adaptive filtering
6432with <var>minimum-sum-of-absolute-values</var> is used.</p>
6433
6434<p>Only if the output is MNG, if filter-type is 7, the LOCO color
6435transformation (intrapixel differencing) and adaptive filtering
6436with <var>minimum-sum-of-absolute-values</var> are used.</p>
6437
6438<p>If the filter-type is 8 the zlib Z_RLE compression strategy (or the
6439Z_HUFFMAN_ONLY strategy, when compression level is 0) is used with
6440adaptive PNG filtering.</p>
6441
6442<p>If the filter-type is 9 the zlib Z_RLE compression strategy (or the
6443Z_HUFFMAN_ONLY strategy, when compression level is 0) is used with
6444no PNG filtering.</p>
6445
6446<p>The quality setting has no effect on the appearance or signature of PNG
6447and MNG images, since the compression is always lossless.</p>
6448
6449<p>Not all combinations of compression level, strategy, and PNG filter type
6450can be obtained using the -quality option. For more precise control,
6451you can use the PNG:compression-level=N, PNG:compression-strategy=N, and
6452PNG:compression-filter=N defines, respectively, instead.
6453See <a href="command-line-options.html#define">-define</a>. Values from the defines take precedence
6454over values from the -quality option.</p>
6455
6456<p>For further information, see
6457the <a href="http://www.w3.org/pub/WWW/TR">PNG</a> specification.</p>
6458
6459<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>
6460
6461<p>For the BPG image format, quality/2 is the actual BPG compression level (range from 0 to 51).</p>
6462
6463<div style="margin: auto;">
6464 <h3 class="magick-header"><a id="quantize"></a>-quantize <var>colorspace</var></h3>
6465</div>
6466
6467<p class="magick-description">reduce colors using this colorspace.</p>
6468
6469<p>This setting defines the colorspace used to sort out and reduce the number
Cristy594d2772015-11-15 10:47:42 -05006470of colors needed by an image (for later dithering) by operators such as <a
6471href="command-line-options.html#colors" >-colors</a>, Note that color reduction also happens
Cristy882d9f42015-10-29 16:48:39 -04006472automatically when saving images to color-limited image file formats, such as
6473GIF, and PNG8.</p>
6474
6475
6476<div style="margin: auto;">
6477 <h3 class="magick-header"><a id="quiet"></a>-quiet</h3>
6478</div>
6479
6480<p class="magick-description">suppress all warning messages. Error messages are still reported.</p>
6481
6482<div style="margin: auto;">
6483 <h3 class="magick-header"><a id="radial-blur"></a>-radial-blur <var>angle</var></h3>
6484</div>
6485
6486<p class="magick-description">Blur around the center of the image.</p>
6487
6488<p>Note that this is actually a rotational blur rather than a radial and as
6489such actually mis-named. </p>
6490
6491<p>The <a href="command-line-options.html#virtual-pixel">-virtual-pixel</a> setting will determine how
6492pixels which are outside the image proper are blurred into the final result.
6493</p>
6494
6495
6496<div style="margin: auto;">
6497 <h3 class="magick-header"><a id="raise"></a>-raise <var>thickness</var></h3>
6498</div>
6499
6500<p class="magick-description">Lighten or darken image edges.</p>
6501
6502<p>This will create a 3-D effect. Use <a href="command-line-options.html#raise">-raise</a> to create
6503a raised effect, otherwise use <a href="command-line-options.html#raise">+raise</a>. </p>
6504
Cristy594d2772015-11-15 10:47:42 -05006505<p>Unlike the similar <a href="command-line-options.html#frame">-frame</a> option, <a
6506href="command-line-options.html#raise">-raise</a> does not alter the dimensions of the image.</p>
Cristy882d9f42015-10-29 16:48:39 -04006507
6508<div style="margin: auto;">
6509 <h3 class="magick-header"><a id="random-threshold"></a>-random-threshold <var>low</var>x<var>high</var></h3>
6510</div>
6511
6512<p class="magick-description">Apply a random threshold to the image.</p>
6513
6514<div style="margin: auto;">
Cristye0779712016-07-30 17:25:22 -04006515 <h3 class="magick-header"><a id="read-mask"></a>-read-mask
6516<var>filename</var></h3>
6517</div>
6518
6519<p class="magick-description">Prevent updates to image pixels specified by the mask.</p>
6520
6521<p>This the same as using a mask used for composite masking operations, with
6522grayscale values causing blended updates of the image the mask is attached to.
6523</p>
6524
6525<p>Use <a href="command-line-options.html#read-mask">+read-mask</a> to remove the mask from images.</p>
6526
6527<p>Also see <a href="command-line-options.html#clip-mask">-clip-mask</a> which work in the same way,
6528but with strict boolean masking. </p>
6529
6530<div style="margin: auto;">
Cristy882d9f42015-10-29 16:48:39 -04006531 <h3 class="magick-header"><a id="red-primary"></a>-red-primary <var>x,y</var></h3>
6532</div>
6533
6534<p class="magick-description">Set the red chromaticity primary point.</p>
6535
6536<div style="margin: auto;">
6537 <h3 class="magick-header"><a id="regard-warnings"></a>-regard-warnings</h3>
6538</div>
6539
6540<p class="magick-description">Pay attention to warning messages.</p>
6541
6542<p>This option causes some warnings in some image formats to be treated
6543as errors. </p>
6544
6545<div style="margin: auto;">
6546 <h3 class="magick-header"><a id="remap"></a>-remap <var>filename</var></h3>
6547</div>
6548
6549<p class="magick-description">Reduce the number of colors in an image to the colors used by this image.</p>
6550
6551<p>If the <a href="command-line-options.html#dither">-dither</a> setting is enabled (the default) then
6552the given colors are dithered over the image as necessary, otherwise the closest
6553color (in RGB colorspace) is selected to replace that pixel in the image. </p>
6554
6555<p>As a side effect of applying a <a href="command-line-options.html#remap">-remap</a> of colors across all
6556images in the current image sequence, all the images will have the same color
6557table. That means that when saved to a file format such as GIF, it will use
6558that color table as a single common or global color table, for all the images,
6559without requiring extra local color tables. </p>
6560
6561<p>Use <a href="command-line-options.html#remap">+remap</a> to reduce all images in the current image
6562sequence to use a common color map over all the images. This equivalent to
6563appending all the images together (without extra background colors) and color
6564reducing those images using <a href="command-line-options.html#colors">-colors</a> with a 256 color
6565limit, then <a href="command-line-options.html#remap">-remap</a> those colors over the original list of
6566images. This ensures all the images follow a single color map. </p>
6567
Cristy594d2772015-11-15 10:47:42 -05006568<p>If the number of colors over all the images is less than 256, then <a
6569href="command-line-options.html#remap">+remap</a> should not perform any color reduction or dithering, as
Cristy882d9f42015-10-29 16:48:39 -04006570no color changes are needed. In that case, its only effect is to force the use
Cristy594d2772015-11-15 10:47:42 -05006571of a global color table. This recommended after using either <a
6572href="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 -04006573reduce the number of colors in an animated image sequence. </p>
6574
6575<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>
6576
6577<div style="margin: auto;">
6578 <h3 class="magick-header"><a id="region"></a>-region <var>geometry</var></h3>
6579</div>
6580
6581<p class="magick-description">Set a region in which subsequent operations apply.</p>
6582
6583<p>The <var>x</var> and <var>y</var> offsets are treated
6584in the same manner as in <a href="command-line-options.html#crop">-crop</a>.</p>
6585
6586<p>See <a href="command-line-processing.html#geometry">Image Geometry</a> for complete details about the <em class="arg">geometry</em> argument.</p>
6587
6588<p>Use <code>+region</code> to remove any previously set regions.</p>
6589
Cristy882d9f42015-10-29 16:48:39 -04006590<div style="margin: auto;">
6591 <h3 class="magick-header"><a id="remote"></a>-remote</h3>
6592</div>
6593
6594<p class="magick-description">perform a remote operation.</p>
6595
6596<p>The only command recognized is the name of an image file to load.</p>
6597
6598<p>If you have more than one <a href="display.html">display</a> application
6599running simultaneously, use the <a href="command-line-options.html#window"> window</a> option to
6600specify which application to control.</p>
6601
6602<div style="margin: auto;">
6603 <h3 class="magick-header"><a id="render"></a>-render</h3>
6604</div>
6605
6606<p class="magick-description">render vector operations.</p>
6607
6608<p>Use <a href="command-line-options.html#render">+render</a> to turn off rendering vector operations.
6609This useful when saving the result to vector formats such as MVG or SVG.</p>
6610
6611<div style="margin: auto;">
6612<h3 class="magick-header"><a id="repage"></a>-repage <var>geometry</var></h3>
6613</div>
6614
6615<p class="magick-description">Adjust the canvas and offset information of the image.</p>
6616
6617<p>This option is like <a href="command-line-options.html#page">-page</a> but acts as an image operator
6618rather than a setting. You can separately set the canvas size or the offset
6619of the image on that canvas by only providing those components. </p>
6620
6621<p>See <a href="command-line-processing.html#geometry">Image Geometry</a> for complete details about the <em class="arg">geometry</em> argument.</p>
6622
6623<p>If a <code>!</code> flag is given the offset given is added to the existing
6624offset to move the image relative to its previous position. This useful for
6625animation sequences. </p>
6626
6627<p>A given a canvas size of zero such as '<code>0x0</code>' forces it to
6628recalculate the canvas size so the image (at its current offset) will appear
6629completely on that canvas (unless it has a negative offset).</p>
6630
6631<p>Use <a href="command-line-options.html#repage">+repage</a> to completely remove/reset the virtual
6632canvas meta-data from the images. </p>
6633
6634<p>The <a href="command-line-options.html#set">-set</a> '<code>page</code>' option can be used to
6635directly assign virtual canvas meta-data. </p>
6636
6637
6638<div style="margin: auto;">
6639 <h3 class="magick-header"><a id="resample"></a>-resample <var>horizontal</var>x<var>vertical</var></h3>
6640</div>
6641
6642<p class="magick-description">Resample image to specified horizontal and vertical resolution.</p>
6643
6644<p>Resize the image so that its rendered size remains the same as the original
6645at the specified target resolution. For example, if a 300 DPI image renders at
66463 inches by 2 inches on a 300 DPI device, when the image has been resampled to
664772 DPI, it will render at 3 inches by 2 inches on a 72 DPI device. Note that
6648only a small number of image formats (e.g. JPEG, PNG, and TIFF) are capable of
6649storing the image resolution. For formats which do not support an image
Cristy594d2772015-11-15 10:47:42 -05006650resolution, the original resolution of the image must be specified via <a
6651href="command-line-options.html#density">-density</a> on the command line prior to specifying the
Cristy882d9f42015-10-29 16:48:39 -04006652resample resolution.</p>
6653
6654<p>Note that Photoshop stores and obtains image resolution from a proprietary
6655embedded profile. If this profile exists in the image, then Photoshop will
6656continue to treat the image using its former resolution, ignoring the image
6657resolution specified in the standard file header.</p>
6658
6659<div style="margin: auto;">
6660 <h3 class="magick-header"><a id="resize"></a>-resize <var>geometry</var></h3>
6661</div>
6662
6663<p class="magick-description">Resize an image.</p>
6664
6665<p>See <a href="command-line-processing.html#geometry">Image Geometry</a> for complete details about the <em class="arg">geometry</em> argument. Offsets, if present in the geometry string, are
6666ignored, and the <a href="command-line-options.html#gravity">-gravity</a> option has no effect.</p>
6667
6668<p>If the <a href="command-line-options.html#filter">-filter</a> option
Cristy594d2772015-11-15 10:47:42 -05006669or <code>-define filter:option=value</code> precedes the <a
6670href="command-line-options.html#resize">-resize</a> option, the image is resized with the specified
Cristy882d9f42015-10-29 16:48:39 -04006671filter.</p>
6672
6673<p>Many image processing algorithms assume your image is in a linear-light
6674coding. If your image is gamma-corrected, you can remove the nonlinear gamma
6675correction, apply the transform, then restore it like this:</p>
6676
6677<pre>
6678convert portrait.jpg -gamma .45455 -resize 25% -gamma 2.2 \
6679 -quality 92 passport.jpg
6680</pre>
6681
6682<div style="margin: auto;">
6683 <h3 class="magick-header"><a id="respect-parentheses"></a>-respect-parentheses</h3>
6684</div>
6685
6686<p class="magick-description">settings remain in effect until parenthesis boundary.</p>
6687
6688<div style="margin: auto;">
6689 <h3 class="magick-header"><a id="reverse"></a>-reverse</h3>
6690</div>
6691
6692<p class="magick-description">Reverse the order of images in the current image list.</p>
6693
6694
6695<div style="margin: auto;">
6696 <h3 class="magick-header"><a id="roll"></a>-roll {<var>+-</var>}<var>x</var>{<var>+-</var>}<var>y</var></h3>
6697</div>
6698
6699<p class="magick-description">roll an image vertically or horizontally by the amount given.</p>
6700
6701<p>A negative <var>x</var> offset rolls the image right-to-left.
6702A negative <var>y</var> offset rolls the image bottom-to-top.</p>
6703
6704
6705<div style="margin: auto;">
6706 <h3 class="magick-header"><a id="rotate"></a>-rotate <var>degrees</var>{<var>&lt;</var>}{<var>&gt;</var>}</h3>
6707</div>
6708
6709<p class="magick-description">Apply Paeth image rotation (using shear operations) to the image.</p>
6710
6711<p>Use <code>&gt;</code> to rotate the image only if its width exceeds the
6712height. <code>&lt;</code> rotates the image <var>only</var> if its width is less
6713than the height. For example, if you specify <code>-rotate "-90&gt;"</code> and
6714the image size is 480x640, the image is not rotated. However, if the image is
6715640x480, it is rotated by -90 degrees. If you use <code>&gt;</code> or
6716<code>&lt;</code>, enclose it in quotation marks to prevent it from being
6717misinterpreted as a file redirection.</p>
6718
6719<p>Empty triangles in the corners, left over from rotating the image, are
6720filled with the <code>background</code> color. </p>
6721
6722<p>See also the <a href="command-line-options.html#distort">-distort</a> operator and specifically the
6723'<code>ScaleRotateTranslate</code>' distort method. </p>
6724
6725
6726<div style="margin: auto;">
6727 <h3 class="magick-header"><a id="sample"></a>-sample <var>geometry</var></h3>
6728</div>
6729
6730<p class="magick-description">minify / magnify the image with pixel subsampling and pixel replication, respectively.</p>
6731
6732<p>Change the image size simply by directly sampling the pixels original
6733from the image. When magnifying, pixels are replicated in blocks. When
6734minifying, pixels are sub-sampled (i.e., some rows and columns are skipped
6735over). </p>
6736
6737<p>The results are thus equivalent to using <a href="command-line-options.html#resize">-resize</a> with
6738a <a href="command-line-options.html#filter">-filter</a> setting of <code>point</code> (nearest
6739neighbor), though <a href="command-line-options.html#sample">-sample</a> is a lot faster, as it
6740avoids all the filter processing of the image. As such it completely ignores
6741the current <a href="command-line-options.html#filter">-filter</a> setting. </p>
6742
6743<p>The key feature of the <a href="command-line-options.html#sample">-sample</a> is that no new colors
6744will be added to the resulting image, though some colors may disappear. </p>
6745
6746<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
6747ignored, unlike <a href="command-line-options.html#resize">-resize</a>. </p>
6748
6749
6750<p>The actual sampling point is the middle of the sub-region being sampled.
6751As such a single pixel sampling of an image will take the middle pixel, (or
Cristy594d2772015-11-15 10:47:42 -05006752top-left-middle if image has even dimensions). However the <a
6753href="command-line-options.html#define">-define</a> '<code>sample:offset</code>' can be set to modify
Cristy882d9f42015-10-29 16:48:39 -04006754this position some other location within each sub-region being sampled, as
6755a percentage offset.</p>
6756
6757<p>By default this value is '<code>50</code>' for the midpoint, but could be set
6758to '<code>0</code>' for top-left, '<code>100</code>' for bottom-right, or with
6759separate X and Y offsets such as '<code>0x50</code>' for left-middle edge of
6760sampling sub-region.</p>
6761
6762
6763<div style="margin: auto;">
6764 <h3 class="magick-header"><a id="sampling-factor"></a>-sampling-factor <var>horizontal-factor</var>x<var>vertical-factor</var></h3>
6765</div>
6766
6767<p class="magick-description">sampling factors used by JPEG or MPEG-2 encoder and YUV decoder/encoder.</p>
6768
6769<p>This option specifies the sampling factors to be used by the JPEG encoder
6770for chroma downsampling. If this option is omitted, the JPEG library will use
6771its own default values. When reading or writing the YUV format and when
Cristy594d2772015-11-15 10:47:42 -05006772writing the M2V (MPEG-2) format, use <a
6773href="command-line-options.html#sampling-factor">-sampling-factor 2x1</a> or <a
6774href="command-line-options.html#sampling-factor">-sampling-factor 4:2:2</a> to specify the 4:2:2
Cristy882d9f42015-10-29 16:48:39 -04006775downsampling method.</p>
6776
6777<div style="margin: auto;">
6778 <h3 class="magick-header"><a id="scale"></a>-scale <var>geometry</var></h3>
6779</div>
6780
6781<p class="magick-description">minify / magnify the image with pixel block averaging and pixel replication, respectively.</p>
6782
6783<p>Change the image size simply by replacing pixels by averaging pixels
6784together when minifying, or replacing pixels when magnifying. </p>
6785
6786<p>The results are thus equivalent to using <a href="command-line-options.html#resize">-resize</a> with
6787a <a href="command-line-options.html#filter">-filter</a> setting of <code>box</code>. Though it is a lot
6788faster, as it avoids all the filter processing of the image. As such it
6789completely ignores the current <a href="command-line-options.html#filter">-filter</a> setting. </p>
6790
6791<p>If when shrinking (minifying) images the original image is some integer
6792multiple of the new image size, the number of pixels averaged together to
6793produce the new pixel color is the same across the whole image. This is
6794a special case known as 'binning' and is often used as a method of reducing
6795noise in image such as those generated by digital cameras, especially in low
6796light conditions. </p>
6797
6798
6799<div style="margin: auto;">
6800 <h3 class="magick-header"><a id="scene"></a>-scene <var>value</var></h3>
6801</div>
6802
6803<p class="magick-description">set scene number.</p>
6804
6805<p>This option sets the scene number of an image or the first image in an image sequence.</p>
6806
6807<div style="margin: auto;">
6808 <h3 class="magick-header"><a id="screen"></a>-screen</h3>
6809</div>
6810
6811<p class="magick-description">specify the screen to capture.</p>
6812
6813<p>This option indicates that the GetImage request used to obtain the image
6814should be done on the root window, rather than directly on the specified
6815window. In this way, you can obtain pieces of other windows that overlap the
6816specified window, and more importantly, you can capture menus or other popups
6817that are independent windows but appear over the specified window.</p>
6818
6819<div style="margin: auto;">
6820 <h3 class="magick-header"><a id="seed"></a>-seed</h3>
6821</div>
6822
6823<p class="magick-description">seed a new sequence of pseudo-random numbers</p>
6824
6825<div style="margin: auto;">
6826 <h3 class="magick-header"><a id="segment"></a>-segment <var>cluster-threshold</var>x<var>smoothing-threshold</var></h3>
6827</div>
6828
6829<p class="magick-description">segment the colors of an image.</p>
6830
6831<p>Segment an image by analyzing the histograms of the color components and
6832identifying units that are homogeneous with the fuzzy c-means technique. This
6833is part of the ImageMagick color quantization routines. </p>
6834
6835<p>Specify <var>cluster threshold</var> as the number of pixels in
6836each cluster that must exceed the cluster threshold to be considered valid.
6837<var>Smoothing threshold</var> eliminates noise in the second
6838derivative of the histogram. As the value is increased, you can expect
6839a smoother second derivative. The default is 1.5.</p>
6840
6841<p>If the <a href="command-line-options.html#verbose">-verbose</a> setting is defined, a detailed report
6842of the color clusters is returned.</p>
6843
6844
6845<div style="margin: auto;">
Cristy594d2772015-11-15 10:47:42 -05006846 <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 -04006847</div>
6848
6849<p class="magick-description">Selectively blur pixels within a contrast threshold.</p>
6850
6851<p>Blurs those pixels that are less than or equal to the threshold in
6852contrast. The threshold may be expressed as a fraction of <var>QuantumRange</var> or as a percentage.</p>
6853
6854<div style="margin: auto;">
6855 <h3 class="magick-header"><a id="separate"></a>-separate</h3>
6856</div>
6857
6858<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>
6859
6860<div style="margin: auto;">
Cristy769d8892016-01-19 18:11:14 -05006861 <h3 class="magick-header"><a id="sepia-tone"></a>-sepia-tone <var>percent-threshold</var></h3>
Cristy882d9f42015-10-29 16:48:39 -04006862</div>
6863
6864<p class="magick-description">simulate a sepia-toned photo.</p>
6865
6866<p>Specify <var>threshold</var> as the percent threshold of the intensity (0 - 99.9%).</p>
6867
6868<p>This option applies a special effect to the image, similar to the effect
6869achieved 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
6870toning. A threshold of 80% is a good starting point for a reasonable
6871tone.</p>
6872
6873
6874
6875<div style="margin: auto;">
6876 <h3 class="magick-header"><a id="set"></a>-set <var>key value</var></h3>
6877 <h3 class="magick-header">+set <var>key</var></h3>
6878</div>
6879
6880<p class="magick-description">sets image attributes and properties for images in the current image sequence.</p>
6881
6882<p>This will assign (or modify) specific settings attached to all the images
6883in the current image sequence. Using the <a href="command-line-options.html#set">+set</a> form of the
6884option will either remove, or reset that setting to a default state, as
6885appropriate. </p>
6886
6887<p>For example, it will modify specific well known image meta-data
Cristy594d2772015-11-15 10:47:42 -05006888'attributes' such as those normally overridden by: the options <a
6889href="command-line-options.html#delay" >-delay</a>, <a href="command-line-options.html#dispose" >-dispose</a>, and <a
6890href="command-line-options.html#page" >-page</a>, <a href="command-line-options.html#colorspace" >-colorspace</a>; generally
Cristy882d9f42015-10-29 16:48:39 -04006891assigned before the image is read in, by using a <var>key</var> of
6892the same name. </p>
6893
6894<p>If the given <var>key</var> does not match a specific known
6895'attribute ', such as shown above, the setting is stored as a a free form
Cristy594d2772015-11-15 10:47:42 -05006896'property' string. Such settings are listed in <a href="command-line-options.html#verbose"
6897>-verbose</a> information ("<code>info:</code>" output format) as "Properties".
Cristy882d9f42015-10-29 16:48:39 -04006898</p>
6899
6900<p>This includes string 'properties' that are set by and assigned to images
Cristy594d2772015-11-15 10:47:42 -05006901using the options <a href="command-line-options.html#comment" >-comment</a>, <a href="command-line-options.html#label"
6902>-label</a>, <a href="command-line-options.html#caption" >-caption</a>. These options actually assign
6903a global 'artifact' which are automatically assigned (and any <a href="escape.html" >Format Percent
Cristy882d9f42015-10-29 16:48:39 -04006904Escapes</a> expanded) to images as they are read in. For example:</p>
6905
6906<pre>
Cristy594d2772015-11-15 10:47:42 -05006907-> convert rose: -set comment 'Rose is a rose is a rose is a rose' rose.png
Cristy882d9f42015-10-29 16:48:39 -04006908identify -format %c rose.png
6909Rose is a rose is a rose is a rose
6910</pre>
6911
Cristy594d2772015-11-15 10:47:42 -05006912<p>The set value can also make use of <a href="escape.html" >Format and Print Image
Cristy882d9f42015-10-29 16:48:39 -04006913Properties</a> in the defined value. For example:</p>
6914
6915<pre>
Cristy594d2772015-11-15 10:47:42 -05006916-> convert rose: -set origsize '%wx%h' -resize 50% \
Cristy882d9f42015-10-29 16:48:39 -04006917 -format 'Old size = %[origsize] New size = %wx%h' info:
6918Old size = 70x46 New size = 35x23
6919</pre>
6920
6921<p>Other well known 'properties' that are available include:
6922'<code>date:create</code>' and '<code>date:modify</code>' and
6923'<code>signature</code>'. </p>
6924
6925<p>The <a href="command-line-options.html#repage">-repage</a> operator will also allow you to modify
6926the '<code>page</code>' attribute of an image for images already in memory (also
6927see <a href="command-line-options.html#repage">-page</a>). However it is designed to provide a finer
6928control of the sub-parts of this 'attribute'. The <a href="command-line-options.html#set">-set page</a>
6929option will only provide a direct, unmodified assignment of '<code>page</code>'
6930attribute. </p>
6931
6932<p>This option can also associate a colorspace or profile with your image.
6933For example,</p>
6934
6935<pre>
6936convert image.psd -set profile ISOcoated_v2_eci.icc image-icc.psd
6937</pre>
6938
6939<p>Some 'properties' must be defined in a specific way to be used. For
6940example only 'properties' prefixed with "<code>filename:</code>" can be used to
6941modify the output filename of an image. For example</p>
6942
6943<pre>
6944convert rose: -set filename:mysize '%wx%h' 'rose_%[filename:mysize].png'
6945</pre>
6946
6947<p>If the setting value is prefixed with "<code>option:</code>" the setting will
Cristy594d2772015-11-15 10:47:42 -05006948be saved as a global "Artifact" exactly as if it was set using the <a
6949href="command-line-options.html#define" >-define</a> option. As such settings are global in scope, they
Cristy882d9f42015-10-29 16:48:39 -04006950can be used to pass 'attributes' and 'properties' of one specific image,
6951in a way that allows you to use them in a completely different image, even if
6952the original image has long since been modified or destroyed. For example: </p>
6953
6954<pre>
6955convert rose: -set option:rosesize '%wx%h' -delete 0 \
6956 label:'%[rosesize]' label_size_of_rose.gif"
6957</pre>
6958
Cristy594d2772015-11-15 10:47:42 -05006959<p>Note that <a href="escape.html" >Format Percent Escapes</a> will only match
Cristy882d9f42015-10-29 16:48:39 -04006960a 'artifact' if the given <var>key</var> does not match an existing
6961'attribute' or 'property'. </p>
6962
6963<p>You can set the attributes of the image registry by prefixing the value
6964with <code>registry:</code>.</p>
6965
6966<p>The <a href="command-line-options.html#set">-set profile</a> option can also be used to inject
6967previously-formatted ancillary chunks into the output PNG file, using
6968the commandline option as shown below or by setting the profile via a
6969programming interface:</p>
6970
6971<pre>
6972convert in.png -set profile PNG-chunk-x:&lt;filename&gt; out.png
6973</pre>
6974
6975<p>where <var>x</var> is a location flag and
6976<var>filename</var> is a file containing the chunk
6977name in the first 4 bytes, then a colon (":"), followed by the chunk data.
6978This encoder will compute the chunk length and CRC, so those must not
6979be included in the file.</p>
6980
6981<p>"x" can be "b" (before PLTE), "m" (middle, i.e., between PLTE and IDAT),
6982or "e" (end, i.e., after IDAT). If you want to write multiple chunks
6983of the same type, then add a short unique string after the "x" to prevent
6984subsequent profiles from overwriting the preceding ones, e.g.,</p>
6985
6986
6987<pre>
6988convert in.png -set profile PNG-chunk-b01:file01 \
6989 -profile PNG-chunk-b02:file02 out.png
6990</pre>
6991
6992<div style="margin: auto;">
6993 <h3 class="magick-header"><a id="shade"></a>-shade <var>azimuth</var>x<var>elevation</var></h3>
6994</div>
6995
6996<p class="magick-description">shade the image using a distant light source.</p>
6997
6998<p>Specify <var>azimuth</var> and <var>elevation</var> as
6999the position of the light source. Use <a href="command-line-options.html#shade">+shade</a> to return
7000the shading results as a grayscale image.</p>
7001
7002<div style="margin: auto;">
7003 <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>
7004</div>
7005
7006<p class="magick-description">simulate an image shadow.</p>
7007
7008<div style="margin: auto;">
Cristy594d2772015-11-15 10:47:42 -05007009 <h3 class="magick-header"><a
7010id="shared-memory"></a>-shared-memory</h3>
Cristy882d9f42015-10-29 16:48:39 -04007011</div>
7012
7013<p class="magick-description">use shared memory.</p>
7014
7015<p>This option specifies whether the utility should attempt to use shared
7016memory for pixmaps. ImageMagick must be compiled with shared memory support,
7017and the display must support the <var>MIT-SHM</var> extension.
7018Otherwise, this option is ignored. The default is <code>True</code>.</p>
7019
7020<div style="margin: auto;">
Cristy594d2772015-11-15 10:47:42 -05007021 <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 -04007022</div>
7023
7024<p class="magick-description">sharpen the image.</p>
7025
7026<p>Use a Gaussian operator of the given radius and standard deviation (sigma).</p>
7027
7028<div style="margin: auto;">
7029 <h3 class="magick-header"><a id="shave"></a>-shave <var>geometry</var></h3>
7030</div>
7031
7032<p class="magick-description">Shave pixels from the image edges.</p>
7033
7034<p>The <var>size</var> portion of the <var>geometry</var>
7035argument specifies the width of the region to be removed from both sides of
7036the image and the height of the regions to be removed from top and bottom.
7037Offsets are ignored.</p>
7038
7039<p>See <a href="command-line-processing.html#geometry">Image Geometry</a> for complete details about the <em class="arg">geometry</em> argument.</p>
7040
7041<div style="margin: auto;">
7042 <h3 class="magick-header"><a id="shear"></a>-shear <var>Xdegrees</var>[x<var>Ydegrees</var>]</h3>
7043</div>
7044
7045<p class="magick-description">Shear the image along the x-axis and/or y-axis.</p>
7046
7047<p>The shear angles may be positive, negative, or zero. When <var>Ydegrees</var> is omitted it defaults to 0. When both angles are
7048given, the horizontal component of the shear is performed before the vertical
7049component.</p>
7050
7051<p>Shearing slides one edge of an image along the x-axis or y-axis (i.e.,
7052horizontally or vertically, respectively),creating a parallelogram. The amount
7053of each is controlled by the respective shear angle. For horizontal shears,
7054<var>Xdegrees</var> is measured clockwise relative to "up" (the
7055negative 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
7056positive 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>
7057
7058<p>Empty triangles left over from shearing the image are filled with the color
7059defined by the <a href="command-line-options.html#fill">-background</a> option. The color is specified
7060using the format described under the <a href="command-line-options.html#fill">-fill</a> option.</p>
7061
7062<p>The horizontal shear is performed before the vertical part. This is
7063important to note, since horizontal and vertical shears do not
7064<var>commute</var>, i.e., the order matters in a sequence of shears. For
7065example, the following two commands are not equivalent.</p>
7066
7067<pre>
7068convert logo: -shear 20x0 -shear 0x60 logo-sheared.png
7069convert logo: -shear 0x60 -shear 20x0 logo-sheared.png
7070</pre>
7071
7072<p>The first of the two commands above is equivalent to the following, except
7073for the amount of empty space created; the command that follows generates
7074a smaller image, and so is a better choice in terms of time and space.</p>
7075
7076<pre>
7077convert logo: -shear 20x60 logo-sheared.png
7078</pre>
7079
7080<div style="margin: auto;">
7081 <h3 class="magick-header"><a id="sigmoidal-contrast"></a>-sigmoidal-contrast <var>contrast</var>x<var>mid-point</var></h3>
7082</div>
7083
7084<p class="magick-description">increase the contrast without saturating highlights or shadows.</p>
7085
7086<p>Increase the contrast of the image using a sigmoidal transfer function
7087without saturating highlights or shadows. <var>Contrast</var>
7088indicates how much to increase the contrast. For example, 0 is none, 3 is
7089typical and 20 is a lot.
7090</p>
7091
7092<p>The <var>mid-point</var> indicates where the maximum change
7093'slope' in contrast should fall in the resultant image (0 is white; 50% is
7094middle-gray; 100% is black). </p>
7095
7096<p>By default the image contrast is increased, use <var>+sigmoidal-contrast</var> to decrease the contrast.</p>
7097
7098<p>To achieve the equivalent of a sigmoidal brightness change (similar to
7099a gamma adjustment), you would use <var>-sigmoidal-contrast
7100{brightness}x0%</var> to increase brightness and <var>+sigmoidal-contrast {brightness}x0%</var> to decrease brightness.
7101Note the use of '0' fo rthe mid-point of the sigmoidal curve. </p>
7102
7103<p>Using a very high <var>contrast</var> will produce a sort of
7104'smoothed thresholding' of the image. Not as sharp (with high aliasing
7105effects) of a true threshold, but with tapered gray-levels around the threshold
7106<var>mid-point</var>. </p>
7107
7108<div style="margin: auto;">
7109 <h3 class="magick-header"><a id="silent"></a>-silent</h3>
Cristyf650f4f2016-04-01 10:53:07 -04007110
7111
Cristy882d9f42015-10-29 16:48:39 -04007112</div>
7113
Cristyf650f4f2016-04-01 10:53:07 -04007114<p class="magick-description">operate silently. This option is only used
7115by the <a href="import.html">import</a> tool.</p>
Cristy882d9f42015-10-29 16:48:39 -04007116
7117<div style="margin: auto;">
7118 <h3 class="magick-header"><a id="similarity-threshold"></a>-similarity-threshold <var>value</var></h3>
7119</div>
7120
7121<p class="magick-description">minimum RMSE for subimage match.</p>
7122
7123<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>
7124
7125<div style="margin: auto;">
7126 <h3 class="magick-header"><a id="size"></a>-size <var>width</var>[x<var>height</var>][<var>+offset</var>]</h3>
7127</div>
7128
7129<p class="magick-description">set the width and height of the image.</p>
7130
7131<p>Use this option to specify the width and height of raw images whose
7132dimensions are unknown such as <code>GRAY</code>, <code>RGB</code>, or
Cristy594d2772015-11-15 10:47:42 -05007133<code>CMYK</code>. In addition to width and height, use <a
7134href="command-line-options.html#size">-size</a> with an offset to skip any header information in the
Cristy882d9f42015-10-29 16:48:39 -04007135image or tell the number of colors in a <code>MAP</code> image file, (e.g. -size
7136640x512+256).</p>
7137
7138<p>For Photo CD images, choose from these sizes:</p>
7139
7140<pre>
7141192x128
7142384x256
7143768x512
71441536x1024
71453072x2048
7146</pre>
7147
7148<div style="margin: auto;">
Cristy594d2772015-11-15 10:47:42 -05007149 <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 -04007150</div>
7151
7152<p class="magick-description">simulate a pencil sketch.</p>
7153
7154<p>Sketch with the given radius, standard deviation (sigma), and angle. The
7155angle given is the angle toward which the image is sketched. That is the
7156direction people would consider the object is coming from. </p>
7157
7158<div style="margin: auto;">
7159 <h3 class="magick-header"><a id="smush"></a>-smush <var>offset</var></h3>
7160</div>
7161
Cristybc232422016-11-22 07:46:18 -05007162<p class="magick-description">appends an image sequence together ignoring transparency.</p>
7163
7164<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>
7165
7166<p>If the offset is negative, images will overlap by that amount.</p>
7167
7168<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>
7169
7170<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 -04007171
7172<div style="margin: auto;">
7173 <h3 class="magick-header"><a id="snaps"></a>-snaps <var>value</var></h3>
7174</div>
7175
7176<p class="magick-description">Set the number of screen snapshots.</p>
7177
7178<p>Use this option to grab more than one image from the X server screen, to create an animation sequence.</p>
7179
7180<div style="margin: auto;">
Cristy769d8892016-01-19 18:11:14 -05007181 <h3 class="magick-header"><a id="solarize"></a>-solarize <var>percent-threshold</var></h3>
Cristy882d9f42015-10-29 16:48:39 -04007182</div>
7183
7184<p class="magick-description">negate all pixels above the threshold level.</p>
7185
7186<p>Specify <var>factor</var> as the percent threshold of the intensity (0 - 99.9%).</p>
7187
7188<p>This option produces a <var>solarization</var> effect seen when
7189exposing a photographic film to light during the development process.</p>
7190
7191<div style="margin: auto;">
7192 <h3 class="magick-header"><a id="sparse-color"></a>-sparse-color <var>method</var> '<var>x</var>,<var>y</var> <var>color</var> ...'</h3>
7193</div>
7194
7195<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>
7196
7197
7198<dl class="dl-horizontal">
7199 <dt>barycentric</dt>
7200 <dd>three point triangle of color given 3 points.
7201 Giving only 2 points will form a linear gradient between those points.
7202 The gradient generated extends beyond the triangle created by those
7203 3 points. </dd>
7204 <dt>bilinear</dt>
7205 <dd>Like barycentric but for 4 points. Less than 4 points
7206 fall back to barycentric. </dd>
7207 <dt>voronoi</dt>
7208 <dd>Simply map each pixel to the to nearest color point
7209 given. The result are polygonal 'cells' of solid color. </dd>
7210 <dt>manhatten</dt>
7211 <dd>Like voronoi, but resulting polygonal 'cells' are mapped to a fixed coordinate system.</dd>
7212 <dt>shepards</dt>
7213 <dd>Colors points biased on the ratio of inverse distance
7214 squared. Generating spots of color in a sea of the average of
7215 colors. </dd>
7216 <dt>inverse</dt>
7217 <dd>Colors points biased on the ratio of inverse distance.
7218 This generates sharper points of color rather than rounded spots of
7219 '<code>shepards</code>' Generating spots of color in a sea of the
7220 average of colors. </dd>
7221</dl>
7222
7223<p>The points are placed according to the images location on the virtual
Cristy594d2772015-11-15 10:47:42 -05007224canvas (<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 -04007225offset), and do not actually have to exist on the given image, but may be
7226some point beyond the edge of the image. All points are floating point values.
7227</p>
7228
Cristy594d2772015-11-15 10:47:42 -05007229<p>Only the color channels defined by the <a href="command-line-options.html#channel" >-channel</a> are
Cristy882d9f42015-10-29 16:48:39 -04007230modified, which means that by default matte/alpha transparency channel is not
7231effected. Typically transparency channel is turned off either before or after
7232the operation. </p>
7233
7234<p>Of course if some color points are transparent to generate a transparent
7235gradient, then the image also requires transparency enabled to store the
7236values. </p>
7237
7238<p>All the above methods when given a single point of color will replace all
7239the colors in the image with the color given, regardless of the point. This is
7240logical, and provides an alternative technique to recolor an image to some
7241default value. </p>
7242
7243
7244<div style="margin: auto;">
7245 <h3 class="magick-header"><a id="splice"></a>-splice <var>geometry</var></h3>
7246</div>
7247
7248<p class="magick-description">Splice the current background color into the image.</p>
7249
Cristy594d2772015-11-15 10:47:42 -05007250<p>This will add rows and columns of the current <a
7251href="command-line-options.html#background">-background</a> color into the given image according to the
Cristy882d9f42015-10-29 16:48:39 -04007252given <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
7253image into four quadrants, separating them by the inserted rows and columns.
7254</p>
7255
7256<p>If a dimension of geometry is zero no rows or columns will be added for that
Cristy594d2772015-11-15 10:47:42 -05007257dimension. Similarly using a zero offset with the appropriate <a
7258href="command-line-options.html#gravity">-gravity</a> setting will add rows and columns to the edges of
7259the image, padding the image only along that one edge. Edge padding is what <a
7260href="command-line-options.html#splice">-splice</a> is most commonly used for. </p>
Cristy882d9f42015-10-29 16:48:39 -04007261
Cristy594d2772015-11-15 10:47:42 -05007262<p>If the exact same <var>geometry</var> and <a
7263href="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 -04007264added added all splices removed. </p>
7265
7266<div style="margin: auto;">
7267 <h3 class="magick-header"><a id="spread"></a>-spread <var>amount</var></h3>
7268</div>
7269
7270<p class="magick-description">displace image pixels by a random amount.</p>
7271
7272<p>The argument <var>amount</var> defines the size of the
7273neighborhood around each pixel from which to choose a candidate pixel to
7274blend.</p>
7275
7276<p>The lookup is controlled by the <a href="command-line-options.html#interpolate">-interpolate</a> setting.</p>
7277
7278<div style="margin: auto;">
7279 <h3 class="magick-header"><a id="statistic"></a>-statistic <var>type</var> <var>geometry</var></h3>
7280</div>
7281
7282<p class="magick-description">replace each pixel with corresponding statistic from the neighborhood.</p>
7283
7284<p>Choose from these statistic types:</p>
7285<dl class="dl-horizontal">
7286<dt>Gradient</dt><dd>maximum difference (max - min) value in neighborhood</dd>
7287<dt>Maximum</dt><dd>maximum value per channel in neighborhood</dd>
7288<dt>Minimum</dt><dd>minimum value per channel in neighborhood</dd>
7289<dt>Mean</dt><dd>average value per channel in neighborhood</dd>
7290<dt>Median</dt><dd>median value per channel in neighborhood</dd>
7291<dt>Mode</dt><dd>mode (most frequent) value per channel in neighborhood</dd>
7292<dt>Nonpeak</dt><dd>value just before or after the median value per channel in neighborhood</dd>
7293<dt>RMS</dt><dd>root mean square value per channel in neighborhood</dd>
7294<dt>StandardDeviation</dt><dd> standard deviation value per channel in neighborhood</dd>
7295</dl>
7296
7297<div style="margin: auto;">
7298 <h3 class="magick-header"><a id="stegano"></a>-stegano <var>offset</var></h3>
7299</div>
7300
7301<p class="magick-description">hide watermark within an image.</p>
7302
7303<p>Use an offset to start the image hiding some number of pixels from the
7304beginning of the image. Note this offset and the image size. You will need
7305this information to recover the steganographic image (e.g. display -size
7306320x256+35 stegano:image.png).</p>
7307
7308<div style="margin: auto;">
7309 <h3 class="magick-header"><a id="stereo"></a>-stereo <var>+x</var>{<var>+y</var>}</h3>
7310</div>
7311
7312<p class="magick-description">composite two images to create a red / cyan stereo anaglyph.</p>
7313
7314<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>
7315
7316<div style="margin: auto;">
7317 <h3 class="magick-header"><a id="storage-type"></a>-storage-type <var>type</var></h3>
7318</div>
7319
7320<p class="magick-description">pixel storage type. Here are the valid types:</p>
7321
7322<dl class="dl-horizontal">
7323<dt>char</dt><dd>unsigned characters</dd>
7324<dt>double</dt><dd>doubles</dd>
7325<dt>float</dt><dd>floats</dd>
7326<dt>integer</dt><dd>integers</dd>
7327<dt>long</dt><dd>longs</dd>
7328<dt>quantum</dt><dd>pixels in the native depth of your ImageMagick distribution</dd>
7329<dt>short</dt><dd>unsigned shorts</dd>
7330</dl>
7331
7332<p>Float and double types are normalized from 0.0 to 1.0 otherwise the pixels
7333values range from 0 to the maximum value the storage type can support.</p>
7334
7335<div style="margin: auto;">
7336 <h3 class="magick-header"><a id="stretch"></a>-stretch <var>fontStretch</var></h3>
7337</div>
7338
7339<p class="magick-description">Set a type of stretch style for fonts.</p>
7340
7341<p>This setting suggests a type of stretch that ImageMagick should try to
7342apply to the currently selected font family. Select <var>fontStretch</var> from the following.</p>
7343
7344<pre>
7345Any
7346Condensed
7347Expanded
7348ExtraCondensed
7349ExtraExpanded
7350Normal
7351SemiCondensed
7352SemiExpanded
7353UltraCondensed
7354UltraExpanded
7355</pre>
7356
7357<p>To print a complete list of stretch types, use <a href="command-line-options.html#list">-list
7358stretch</a>.</p>
7359
Cristy594d2772015-11-15 10:47:42 -05007360<p>For other settings that affect fonts, see the options <a
7361href="command-line-options.html#font">-font</a>, <a href="command-line-options.html#family">-family</a>, <a
7362href="command-line-options.html#style">-style</a>, and <a href="command-line-options.html#weight">-weight</a>. </p>
Cristy882d9f42015-10-29 16:48:39 -04007363
7364<div style="margin: auto;">
7365 <h3 class="magick-header"><a id="strip"></a>-strip</h3>
7366</div>
7367
Cristy776113a2016-04-29 12:01:19 -04007368<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 -04007369
7370<div style="margin: auto;">
7371 <h3 class="magick-header"><a id="stroke"></a>-stroke <var>color</var></h3>
7372</div>
7373
7374<p class="magick-description">color to use when stroking a graphic primitive.</p>
7375
7376<p>The color is specified using the format described under the <a href="command-line-options.html#fill">-fill</a> option.</p>
7377
7378<p>See <a href="command-line-options.html#draw">-draw</a> for further details.</p>
7379
7380<div style="margin: auto;">
7381 <h3 class="magick-header"><a id="strokewidth"></a>-strokewidth <var>value</var></h3>
7382</div>
7383
7384<p class="magick-description">set the stroke width.</p>
7385
7386<p>See <a href="command-line-options.html#draw">-draw</a> for further details.</p>
7387
7388<div style="margin: auto;">
7389 <h3 class="magick-header"><a id="style"></a>-style <var>fontStyle</var></h3>
7390</div>
7391
7392<p class="magick-description">Set a font style for text.</p>
7393
7394<p>This setting suggests a font style that ImageMagick should try to apply to
7395the currently selected font family. Select <var>fontStyle</var> from
7396the following.</p>
7397
7398<pre>
7399Any
7400Italic
7401Normal
7402Oblique
7403</pre>
7404
Cristy594d2772015-11-15 10:47:42 -05007405<p>For other settings that affect fonts, see the options <a
7406href="command-line-options.html#font">-font</a>, <a href="command-line-options.html#family">-family</a>, <a
7407href="command-line-options.html#stretch">-stretch</a>, and <a href="command-line-options.html#weight">-weight</a>. </p>
Cristy882d9f42015-10-29 16:48:39 -04007408
7409<div style="margin: auto;">
7410 <h3 class="magick-header"><a id="subimage-search"></a>-subimage-search</h3>
7411</div>
7412
7413<p class="magick-description">search for subimage.</p>
7414
7415<p>This option is required to have compare search for the best match location
7416of a small image within a larger image. This search will produce two images
7417(or two frames). The first is the "difference" image and the second will
7418be the "match score" image.</p>
7419
7420<p>The "match-score" image is smaller containing a pixel for ever possible
7421position of the top-left corner of the given sub-image. that is its size will
7422be the size of the larger_image - sub_image + 1. The brightest location in
7423this image is the location s the locate on the best match that is also
7424reported. Note that this may or may not be a perfect match, and the actual
7425brightness will reflect this. Other bright 'peaks' can be used to locate other
7426possible matching locations. </p>
7427
7428<p>Note that the search will try to compare the sub-image at every possible
7429location in the larger image, as such it can be very slow. The smaller the
7430sub-image the faster this search is. </p>
7431
7432
7433<div style="margin: auto;">
7434 <h3 class="magick-header"><a id="swap"></a>-swap <var>index,index</var></h3>
7435</div>
7436
7437<p class="magick-description">Swap the positions of two images in the image sequence.</p>
7438
7439<p>For example, <a href="command-line-options.html#swap">-swap 0,2</a> swaps the first and the third
7440images in the current image sequence. Use <a href="command-line-options.html#swap">+swap</a> to switch
7441the last two images in the sequence.</p>
7442
7443<div style="margin: auto;">
7444 <h3 class="magick-header"><a id="swirl"></a>-swirl <var>degrees</var></h3>
7445</div>
7446
7447<p class="magick-description">swirl image pixels about the center.</p>
7448
7449<p><var>Degrees</var> defines the tightness of the swirl.</p>
7450
7451<div style="margin: auto;">
7452 <h3 class="magick-header"><a id="synchronize"></a>-synchronize</h3>
7453</div>
7454
7455<p class="magick-description">synchronize image to storage device.</p>
7456
7457<p>Set to "true" to ensure all image data is fully flushed and synchronized
7458to disk. There is a performance penalty, but the benefits include ensuring a
7459valid image file in the event of a system crash and early reporting if there
7460is not enough disk space for the image pixel cache.</p>
7461
7462<div style="margin: auto;">
7463 <h3 class="magick-header"><a id="taint"></a>-taint</h3>
7464</div>
7465
7466<p class="magick-description">Mark the image as modified.</p>
7467
7468<div style="margin: auto;">
7469 <h3 class="magick-header"><a id="text-font"></a>-text-font <var>name</var></h3>
7470</div>
7471
7472<p class="magick-description">font for writing fixed-width text.</p>
7473
7474<p>Specifies the name of the preferred font to use in fixed (typewriter style)
7475formatted text. The default is 14 point <var>Courier</var>.</p>
7476
7477<p>You can tag a font to specify whether it is a PostScript, TrueType, or
7478OPTION1 font. For example, <code>Courier.ttf</code> is a TrueType font and
7479<code>x:fixed</code> is OPTION1.</p>
7480
7481<div style="margin: auto;">
7482 <h3 class="magick-header"><a id="texture"></a>-texture <var>filename</var></h3>
7483</div>
7484
7485<p class="magick-description">name of texture to tile onto the image background.</p>
7486
7487<div style="margin: auto;">
7488 <h3 class="magick-header"><a id="threshold"></a>-threshold <var>value</var>{<var>%</var>}</h3>
7489</div>
7490
7491<!-- {<var>green,blue,opacity</var>}
7492<p>If the green or blue value is omitted, these channels use the same value as
7493the first one provided. If all three color values are the same, the result is
7494a bi-level image. If the opacity threshold is omitted, OpaqueOpacity is used
7495and any partially transparent pixel becomes fully transparent.</p>
7496-->
7497
7498<p class="magick-description">Apply simultaneous black/white threshold to the image.</p>
7499
Cristy594d2772015-11-15 10:47:42 -05007500<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 -04007501maximum channel value, while all other values are assigned the minimum.</p>
7502
7503<p> The threshold value can be given as a percentage or as an absolute integer
7504value corresponding to the desired channel value. When given as an integer,
7505the minimum attainable value is 0 (corresponding to black when all channels
7506are affected), but the maximum value (corresponding to white) is that of the
7507<code>quantum depth</code> of the particular build of ImageMagick, and is
7508therefore dependent on the installation. For that reason, a reasonable
7509recommendation for most applications is to specify the threshold values as
7510a percentage. </p>
7511
7512<p> The following would force pixels with red values above 50% to have 100%
7513red values, while those at or below 50% red would be set to 0 in the red
7514channel. The green, blue, and alpha channels (if present) would be unchanged.
7515</p>
7516
7517<pre>
7518convert in.png -channel red -threshold 50% out.png
7519</pre>
7520
7521<p>As (possibly) impractical but instructive examples, the following would
7522generate an all-black and an all-white image with the same dimensions as the
7523input image.</p>
7524
7525
7526<pre>
7527convert in.png -threshold 100% black.png
7528convert in.png -threshold -1 white.png
7529</pre>
7530
7531<p>Note that the values of the transparency channel is treated as 'matte'
7532values (0 is opaque) and not as 'alpha' values (0 is transparent).</p>
7533
Cristy594d2772015-11-15 10:47:42 -05007534<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 -04007535</p>
7536
7537<div style="margin: auto;">
7538 <h3 class="magick-header"><a id="thumbnail"></a>-thumbnail <var>geometry</var></h3>
7539</div>
7540
7541<p class="magick-description">Create a thumbnail of the image.</p>
7542
7543<p>This is similar to <a href="command-line-options.html#resize">-resize</a>, except it is optimized
7544for speed and any image profile, other than a color profile, is removed to
Cristy594d2772015-11-15 10:47:42 -05007545reduce the thumbnail size. To strip the color profiles as well, add <a
7546href="command-line-options.html#strip">-strip</a> just before of after this option.</p>
Cristy882d9f42015-10-29 16:48:39 -04007547
7548<p>See <a href="command-line-processing.html#geometry">Image Geometry</a> for complete details about the <em class="arg">geometry</em> argument.</p>
7549
7550<div style="margin: auto;">
7551 <h3 class="magick-header"><a id="tile"></a>-tile <var>filename</var></h3>
7552</div>
7553
7554<p class="magick-description">Set the tile image used for filling a subsequent graphic primitive.</p>
7555
7556<div style="margin: auto;">
7557 <h3 class="magick-header">-tile <var>geometry</var></h3>
7558</div>
7559
7560<p class="magick-description">Specify the layout of images.</p>
7561
7562<p>See <a href="command-line-processing.html#geometry">Image Geometry</a> for complete details about the <em class="arg">geometry</em> argument.</p>
7563
7564<div style="margin: auto;">
7565 <h3 class="magick-header">-tile</h3>
7566</div>
7567
7568<p class="magick-description">Specifies that a subsequent composite operation is repeated across and down image.</p>
7569
7570<div style="margin: auto;">
7571 <h3 class="magick-header"><a id="tile-offset"></a>-tile-offset {<var>+-</var>}<var>x</var>{<var>+-</var>}<var>y</var></h3>
7572</div>
7573
7574<p class="magick-description">Specify the offset for tile images, relative to the background image it is tiled on.</p>
7575
Cristy594d2772015-11-15 10:47:42 -05007576<p>This should be set before the tiling image is set by <a href="command-line-options.html#tile"
7577>-tile</a> or <a href="command-line-options.html#texture" >-texture</a>, or directly applied for
Cristy882d9f42015-10-29 16:48:39 -04007578creating a tiled canvas using <code>TILE:</code> or <code>PATTERN:</code> input
7579formats. </p>
7580
Cristy594d2772015-11-15 10:47:42 -05007581<p>Internally ImageMagick does a <a href="command-line-options.html#roll" >-roll</a> of the tile image
Cristy882d9f42015-10-29 16:48:39 -04007582by the arguments given when the tile image is set. </p>
7583
7584<div style="margin: auto;">
7585 <h3 class="magick-header"><a id="tint"></a>-tint <var>value</var></h3>
7586</div>
7587
7588<p class="magick-description">Tint the image with the fill color.</p>
7589
7590<p>Tint the image with the fill color.</p>
7591
7592<p>Specify the amount of tinting as a percentage. Pure colors like black,
7593white red, yellow, will not be affected by -tint. Only mid-range colors such
7594as the various shades of grey.</p>
7595
7596<div style="margin: auto;">
7597 <h3 class="magick-header"><a id="title"></a>-title <var>string</var></h3>
7598</div>
7599
7600<p class="magick-description">Assign a title to displayed image.", "animate", "display", "montage</p>
7601
7602<p>Use this option to assign a specific title to the image. This assigned to
7603the image window and is typically displayed in the window title bar.
7604Optionally you can include the image filename, type, width, height, Exif data,
7605or other image attribute by embedding special format characters described
7606under the <a href="command-line-options.html#format">-format</a> option.</p>
7607
7608<p>For example,</p>
7609
7610<pre>
7611-title "%m:%f %wx%h"
7612</pre>
7613
7614<p>produces an image title of <code>MIFF:bird.miff 512x480</code> for an image
7615titled <code>bird.miff</code> and whose width is 512 and height is 480.</p>
7616
7617
7618<div style="margin: auto;">
7619 <h3 class="magick-header"><a id="transform"></a>-transform</h3>
7620</div>
7621
7622<p class="magick-description">transform the image.</p>
7623
7624<p>This option applies the transformation matrix from a previous <a href="command-line-options.html#affine">-affine</a> option.</p>
7625
7626<pre>
7627convert -affine 2,2,-2,2,0,0 -transform bird.ppm bird.jpg
7628</pre>
7629
7630
Cristy594d2772015-11-15 10:47:42 -05007631<p>This operator has been now been superseded by the <a
7632href="command-line-options.html#distort">-distort</a> '<code>AffineProjection</code>' method. </p>
Cristy882d9f42015-10-29 16:48:39 -04007633
7634
7635<div style="margin: auto;">
7636 <h3 class="magick-header"><a id="transparent"></a>-transparent <var>color</var></h3>
7637</div>
7638
7639<p class="magick-description">Make this color transparent within the image.</p>
7640
7641<p>The <var>color</var> argument is defined using the format
Cristy594d2772015-11-15 10:47:42 -05007642described under the <a href="command-line-options.html#fill">-fill</a> option. The <a href="command-line-options.html#fuzz"
7643>-fuzz</a> setting can be used to match and replace colors similar to the one
Cristy882d9f42015-10-29 16:48:39 -04007644given. </p>
7645
Cristy594d2772015-11-15 10:47:42 -05007646<p>Use <a href="command-line-options.html#transparent" >+transparent</a> to invert the pixels matched.
Cristy882d9f42015-10-29 16:48:39 -04007647that is make all non-matching colors transparent. </p>
7648
Cristy594d2772015-11-15 10:47:42 -05007649<p>The <a href="command-line-options.html#opaque">-opaque</a> operator is exactly the same as <a
7650href="command-line-options.html#transparent" >-transparent</a> but replaces the matching color with the
Cristy882d9f42015-10-29 16:48:39 -04007651current <a href="command-line-options.html#fill">-fill</a> color setting, rather than transparent.
Cristy594d2772015-11-15 10:47:42 -05007652However the <a href="command-line-options.html#transparent" >-transparent</a> operator also ensures
7653that the image has an alpha channel enabled, as per "<code><a href="command-line-options.html#alpha"
7654>-alpha</a> set</code>", and does not require you to modify the <a
7655href="command-line-options.html#channel">-channel</a> to enable alpha channel handling. </p>
Cristy882d9f42015-10-29 16:48:39 -04007656
7657<p>Note that this does not define the color as being the 'transparency color'
Cristy594d2772015-11-15 10:47:42 -05007658used for color-mapped image formats, such as GIF. For that use <a
7659href="command-line-options.html#transparent-color" >-transparent-color</a> </p>
Cristy882d9f42015-10-29 16:48:39 -04007660
7661
7662<div style="margin: auto;">
7663 <h3 class="magick-header"><a id="transparent-color"></a>-transparent-color <var>color</var></h3>
7664</div>
7665
7666<p class="magick-description">Set the transparent color.</p>
7667
7668<p>Sometimes this is used for saving to image formats such as
7669GIF and PNG8 which uses this color to represent boolean transparency. This
7670does not make a color transparent, it only defines what color the transparent
Cristy594d2772015-11-15 10:47:42 -05007671color is in the color palette of the saved image. Use <a
7672href="command-line-options.html#transparent">-transparent</a> to make an opaque color transparent.</p>
Cristy882d9f42015-10-29 16:48:39 -04007673
7674<p>This option allows you to have both an opaque visible color, as well as a
7675transparent color of the same color value without conflict. That is, you can
7676use the same color for both the transparent and opaque color areas within an
7677image. This, in turn, frees to you to select a transparent color that is
7678appropriate when an image is displayed by an application that does not handle a
7679transparent color index, while allowing ImageMagick to correctly handle images of this
7680type. </p>
7681
7682<p>The default transparent color is <code>#00000000</code>, which is fully transparent black.</p>
7683
7684<div style="margin: auto;">
7685 <h3 class="magick-header"><a id="transpose"></a>-transpose</h3>
7686</div>
7687
7688<p class="magick-description">Mirror the image along the top-left to bottom-right diagonal.</p>
7689
7690<p> This option mathematically transposes the pixel array. It is equivalent to the sequence <code>-flip -rotate 90</code>.
7691</p>
7692
7693<div style="margin: auto;">
7694 <h3 class="magick-header"><a id="transverse"></a>-transverse</h3>
7695</div>
7696
7697<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>
7698
7699
7700<div style="margin: auto;">
7701 <h3 class="magick-header"><a id="treedepth"></a>-treedepth <var>value</var></h3>
7702</div>
7703
7704<p class="magick-description">tree depth for the color reduction algorithm.</p>
7705
7706<p>Normally, this integer value is zero or one. A value of zero or one causes
7707the use of an optimal tree depth for the color reduction algorithm.</p>
7708
7709<p>An optimal depth generally allows the best representation of the source
7710image with the fastest computational speed and the least amount of memory.
7711However, the default depth is inappropriate for some images. To assure the
7712best representation, try values between 2 and 8 for this parameter. Refer to
Cristy6549abb2016-11-10 08:25:55 -05007713the <a href="http://www.imagemagick.org/www/quantize.html"
Cristy594d2772015-11-15 10:47:42 -05007714>color reduction algorithm</a> for more details.</p>
Cristy882d9f42015-10-29 16:48:39 -04007715
7716<p>The <a href="command-line-options.html#colors">-colors</a> or <a href="command-line-options.html#monochrome">-monochrome</a>
7717option, or writing to an image format which requires color reduction, is
7718required for this option to take effect.</p>
7719
7720<div style="margin: auto;">
7721 <h3 class="magick-header"><a id="trim"></a>-trim</h3>
7722</div>
7723
7724<p class="magick-description">trim an image.</p>
7725
7726<p>This option removes any edges that are exactly the same color as the corner
7727pixels. Use <a href="command-line-options.html#fuzz">-fuzz</a> to make <a href="command-line-options.html#trim">-trim</a> remove
7728edges that are nearly the same color as the corner pixels.</p>
7729
7730<p>The page or virtual canvas information of the image is preserved allowing
7731you to extract the result of the <a href="command-line-options.html#trim">-trim</a> operation from the
7732image. Use a <a href="command-line-options.html#repage">+repage</a> to remove the virtual canvas page
7733information if it is unwanted.</p>
7734
7735<p>If the trimmed image 'disappears' an warning is produced, and a special
7736single pixel transparent 'missed' image is returned, in the same way as when a
7737<a href="command-line-options.html#crop">-crop</a> operation 'misses' the image proper. </p>
7738
7739
7740<div style="margin: auto;">
7741 <h3 class="magick-header"><a id="type"></a>-type <var>type</var></h3>
7742</div>
7743
7744<p class="magick-description">the image type.</p> <p>Choose from: <code>Bilevel</code>,
7745<code>Grayscale</code>, <code>GrayscaleMatte</code>, <code>Palette</code>,
7746<code>PaletteMatte</code>, <code>TrueColor</code>, <code>TrueColorMatte</code>,
7747<code>ColorSeparation</code>, or <code>ColorSeparationMatte</code>.</p>
7748
7749<p>Normally, when a format supports different subformats such as grayscale and
Cristy594d2772015-11-15 10:47:42 -05007750truecolor, the encoder will try to choose an efficient subformat. The <a
7751href="command-line-options.html#type">-type</a> option can be used to override this behavior. For
Cristy882d9f42015-10-29 16:48:39 -04007752example, to prevent a JPEG from being written in grayscale format even though
7753only gray pixels are present, use.</p>
7754
7755<pre>
7756convert bird.png -type TrueColor bird.jpg
7757</pre>
7758
7759<p>Similarly, use <a href="command-line-options.html#type">-type TrueColorMatte</a> to force the
7760encoder to write an alpha channel even though the image is opaque, if the
7761output format supports transparency.</p>
7762
7763<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>
7764
7765<div style="margin: auto;">
7766 <h3 class="magick-header"><a id="undercolor"></a>-undercolor <var>color</var></h3>
7767</div>
7768
7769<p class="magick-description">set the color of the annotation bounding box.</p>
7770
7771<p>The color is specified using the format described under the <a href="command-line-options.html#fill">-fill</a> option.</p>
7772
7773<p>See <a href="command-line-options.html#draw">-draw</a> for further details.</p>
7774
7775
7776<div style="margin: auto;">
7777 <h3 class="magick-header"><a id="update"></a>-update <var>seconds</var></h3>
7778</div>
7779
7780<p class="magick-description">detect when image file is modified and redisplay.</p>
7781
7782<p>Suppose that while you are displaying an image the file that is currently
7783displayed is over-written. <code>display</code> will automagically detect that
7784the input file has been changed and update the displayed image
7785accordingly.</p>
7786
7787
7788<div style="margin: auto;">
7789 <h3 class="magick-header"><a id="unique-colors"></a>-unique-colors</h3>
7790</div>
7791
7792<p class="magick-description">discard all but one of any pixel color.</p>
7793
7794
7795<div style="margin: auto;">
7796 <h3 class="magick-header"><a id="units"></a>-units <var>type</var></h3>
7797</div>
7798
7799<p class="magick-description">the units of image resolution.</p>
7800
7801<p>Choose from: <code>Undefined</code>, <code>PixelsPerInch</code>, or
7802<code>PixelsPerCentimeter</code>. This option is normally used in conjunction
7803with the <a href="command-line-options.html#density">-density</a> option.</p>
7804
7805
7806<div style="margin: auto;">
Cristy594d2772015-11-15 10:47:42 -05007807 <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 -04007808</div>
7809
7810<p class="magick-description">sharpen the image with an unsharp mask operator.</p>
7811
7812<p>The <a href="command-line-options.html#unsharp">-unsharp</a> option sharpens an image. The image is
7813convolved with a Gaussian operator of the given radius and standard deviation
7814(sigma). For reasonable results, radius should be larger than sigma. Use
7815a radius of 0 to have the method select a suitable radius.</p>
7816
7817<p>The parameters are:</p>
7818
7819<dl class="dl-horizontal">
7820<dt>radius</dt>
7821<dd>The radius of the Gaussian, in pixels, not counting the center pixel (default 0).</dd>
7822<dt>sigma</dt>
7823<dd>The standard deviation of the Gaussian, in pixels (default 1.0).</dd>
7824<dt>gain</dt>
7825<dd>The fraction of the difference between the original and the blur image that is added back into the original (default 1.0).</dd>
7826<dt>threshold</dt>
7827<dd>The threshold, as a fraction of <var>QuantumRange</var>, needed to apply the difference amount (default 0.05).</dd>
7828</dl>
7829
7830<div style="margin: auto;">
7831 <h3 class="magick-header"><a id="verbose"></a>-verbose</h3>
7832</div>
7833
7834<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>
7835
7836
7837<div style="margin: auto;">
7838 <h3 class="magick-header"><a id="version"></a>-version</h3>
7839</div>
7840
7841<p class="magick-description">print ImageMagick version string and exit.</p>
7842
7843
7844<div style="margin: auto;">
7845 <h3 class="magick-header"><a id="view"></a>-view <var>string</var></h3>
7846</div>
7847
7848<p class="magick-description">FlashPix viewing parameters.</p>
7849
7850
7851<div style="margin: auto;">
7852 <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>
7853</div>
7854
7855<p class="magick-description">soften the edges of the image in vignette style.</p>
7856
7857<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>
7858
7859<div style="margin: auto;">
7860 <h3 class="magick-header"><a id="virtual-pixel"></a>-virtual-pixel <var>method</var></h3>
7861</div>
7862
7863<p class="magick-description">Specify contents of <var>virtual pixels</var>.</p>
7864
7865<p>This option defines what color source should be used if and when a color
7866lookup completely 'misses' the source image. The color(s) that appear to
7867surround the source image. Generally this color is derived from the source
7868image, but could also be set to a specify background color. </p>
7869
7870<p>Choose from these methods:</p>
7871
7872<dl class="dl-horizontal">
7873<dt>background</dt><dd>the area surrounding the image is the background color</dd>
7874<dt>black</dt><dd>the area surrounding the image is black</dd>
7875<dt>checker-tile</dt><dd>alternate squares with image and background color</dd>
7876<dt>dither</dt><dd>non-random 32x32 dithered pattern</dd>
7877<dt>edge</dt><dd>extend the edge pixel toward infinity</dd>
7878<dt>gray</dt><dd>the area surrounding the image is gray</dd>
7879<dt>horizontal-tile</dt><dd>horizontally tile the image, background color above/below</dd>
7880<dt>horizontal-tile-edge</dt><dd>horizontally tile the image and replicate the side edge pixels</dd>
7881<dt>mirror</dt><dd>mirror tile the image</dd>
7882<dt>random</dt><dd>choose a random pixel from the image</dd>
7883<dt>tile</dt><dd>tile the image (default)</dd>
7884<dt>transparent</dt><dd>the area surrounding the image is transparent blackness</dd>
7885<dt>vertical-tile</dt><dd>vertically tile the image, sides are background color</dd>
7886<dt>vertical-tile-edge</dt><dd>vertically tile the image and replicate the side edge pixels</dd>
7887<dt>white</dt><dd>the area surrounding the image is white</dd>
7888</dl>
7889
7890<p>The default value is "edge".</p>
7891
Cristy594d2772015-11-15 10:47:42 -05007892<p>This most important for distortion operators such as <a href="command-line-options.html#distort"
7893>-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 -04007894However it also effects operations that may access pixels just outside the
Cristy594d2772015-11-15 10:47:42 -05007895image proper, such as <a href="command-line-options.html#convolve">-convolve</a>, <a
7896href="command-line-options.html#blur">-blur</a>, and <a href="command-line-options.html#sharpen">-sharpen</a>. </p>
Cristy882d9f42015-10-29 16:48:39 -04007897
Cristy594d2772015-11-15 10:47:42 -05007898<p>To print a complete list of virtual pixel types, use the <a
7899href="command-line-options.html#list">-list virtual-pixel</a> option.</p>
Cristy882d9f42015-10-29 16:48:39 -04007900
7901
7902<div style="margin: auto;">
7903 <h3 class="magick-header"><a id="visual"></a>-visual <var>type</var></h3>
7904</div>
7905
7906<p class="magick-description">Animate images using this X visual type.", 'animate', 'display'</p>
7907
7908<p>Choose from these visual classes:</p>
7909
7910<pre>
7911StaticGray TrueColor
7912GrayScale DirectColor
7913StaticColor default
7914PseudoColor visual id
7915</pre>
7916
7917<p>The X server must support the visual you choose, otherwise an error occurs.
7918If a visual is not specified, the visual class that can display the most
7919simultaneous colors on the default screen is chosen.</p>
7920
7921
7922<div style="margin: auto;">
7923 <h3 class="magick-header"><a id="watermark"></a>-watermark <var>brightness</var>x<var>saturation</var></h3>
7924</div>
7925
7926<p class="magick-description">Watermark an image using the given percentages of brightness and saturation.</p>
7927
7928<p>Take a grayscale image (with alpha mask) and modify the destination image's
7929brightness according to watermark image's grayscale value and the
7930<var>brightness</var> percentage. The destinations color saturation
7931attribute is just direct modified by the <var>saturation</var>
7932percentage, which defaults to 100 percent (no color change). </p>
7933
7934
7935<div style="margin: auto;">
Cristy594d2772015-11-15 10:47:42 -05007936 <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 -04007937</div>
7938
7939<p class="magick-description">Shear the columns of an image into a sine wave.</p>
7940
Cristye09ed312016-03-06 08:07:39 -05007941<div style="margin: auto;">
7942 <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>
7943</div>
7944
7945<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 -04007946
7947<div style="margin: auto;">
7948 <h3 class="magick-header"><a id="weight"></a>-weight <var>fontWeight</var></h3>
7949</div>
7950
7951<p class="magick-description">Set a font weight for text.</p>
7952
7953<p>This setting suggests a font weight that ImageMagick should try to apply to
7954the currently selected font family. Use a positive integer for
7955<var>fontWeight</var> or select from the following.</p>
7956
7957<dl class="dl-horizontal">
7958<dt>Thin </dt>
7959<dd>Same as <var>fontWeight</var> = 100.</dd>
7960<dt>ExtraLight </dt>
7961<dd>Same as <var>fontWeight</var> = 200.</dd>
7962<dt>Light </dt>
7963<dd>Same as <var>fontWeight</var> = 300.</dd>
7964<dt>Normal </dt>
7965<dd>Same as <var>fontWeight</var> = 400.</dd>
7966<dt>Medium </dt>
7967<dd>Same as <var>fontWeight</var> = 500.</dd>
7968<dt>DemiBold </dt>
7969<dd>Same as <var>fontWeight</var> = 600.</dd>
7970<dt>Bold </dt>
7971<dd>Same as <var>fontWeight</var> = 700.</dd>
7972<dt>ExtraBold </dt>
7973<dd>Same as <var>fontWeight</var> = 800.</dd>
7974<dt>Heavy </dt>
7975<dd>Same as <var>fontWeight</var> = 900.</dd>
7976</dl>
Cristy594d2772015-11-15 10:47:42 -05007977<br/>
Cristy882d9f42015-10-29 16:48:39 -04007978
7979<p>To print a complete list of weight types, use <a href="command-line-options.html#list">-list weight</a>.</p>
7980
Cristy594d2772015-11-15 10:47:42 -05007981<p>For other settings that affect fonts, see the options <a
7982href="command-line-options.html#font">-font</a>, <a href="command-line-options.html#family">-family</a>, <a
7983href="command-line-options.html#stretch">-stretch</a>, and <a href="command-line-options.html#style">-style</a>. </p>
Cristy882d9f42015-10-29 16:48:39 -04007984
7985<div style="margin: auto;">
7986 <h3 class="magick-header"><a id="white-point"></a>-white-point <var>x,y</var></h3>
7987</div>
7988
7989<p class="magick-description">chromaticity white point.</p>
7990
7991<div style="margin: auto;">
7992 <h3 class="magick-header"><a id="white-threshold"></a>-white-threshold <var>value</var>{<var>%</var>}</h3>
7993</div>
7994
7995<p class="magick-description">Force to white all pixels above the threshold while leaving all pixels at or below the threshold unchanged.</p>
7996
7997<p> The threshold value can be given as a percentage or as an absolute integer
7998value within [0, <var>QuantumRange</var>] corresponding to the
Cristy594d2772015-11-15 10:47:42 -05007999desired <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 -04008000
8001<div style="margin: auto;">
8002 <h3 class="magick-header"><a id="window"></a>-window <var>id</var></h3>
8003</div>
8004
8005<p class="magick-description">Make the image the background of a window.", 'animate', 'display'</p>
8006
8007<p><var>id</var> can be a window id or name. Specify <code>root</code>
8008to select X's root window as the target window.</p>
8009
8010<p>By default the image is tiled onto the background of the target window. If
8011<code>backdrop</code> or <a href="command-line-options.html#geometry">-resize</a> are specified, the
8012image is surrounded by the background color. Refer to <code>X RESOURCES</code>
8013for details.</p>
8014
8015<p>The image will not display on the root window if the image has more unique
Cristy594d2772015-11-15 10:47:42 -05008016colors than the target window colormap allows. Use <a
8017href="command-line-options.html#colors">-colors</a> to reduce the number of colors.</p>
Cristy882d9f42015-10-29 16:48:39 -04008018
8019<div style="margin: auto;">
8020 <h3 class="magick-header"><a id="window-group"></a>-window-group</h3>
8021</div>
8022
8023<p class="magick-description">specify the window group.</p>
8024
8025<div style="margin: auto;">
8026 <h3 class="magick-header"><a id="write"></a>-write <var>filename</var></h3>
8027</div>
8028
8029<p class="magick-description">write an image sequence.</p>
8030
8031<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>
8032
8033<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 -04008034
8035<div style="margin: auto;">
8036 <h3 class="magick-header"><a id="write-mask"></a>-write-mask <var>filename</var></h3>
8037</div>
8038
8039<p class="magick-description">Prevent updates to image pixels specified by the mask.</p>
8040
8041<p>This the same as using a mask used for composite masking operations, with
8042grayscale values causing blended updates of the image the mask is attached to.
8043</p>
8044
8045<p>Use <a href="command-line-options.html#write-mask">+write-mask</a> to remove the mask from images.</p>
8046
8047<p>Also see <a href="command-line-options.html#clip-mask">-clip-mask</a> which work in the same way,
8048but with strict boolean masking. </p>
Cristy882d9f42015-10-29 16:48:39 -04008049</div>
8050</div>
8051
8052
Cristye93be682015-11-26 09:07:51 -05008053
Cristy882d9f42015-10-29 16:48:39 -04008054 <footer class="magick-footer">
cristy29f2c972015-07-28 13:37:46 +00008055 <p><a href="support.html">Donate</a>
8056 <a href="sitemap.html">Sitemap</a>
cristyd2432012015-05-04 23:15:15 +00008057 <a href="links.html">Related</a>
Cristye0779712016-07-30 17:25:22 -04008058 <a href="security-policy.html">Security</a>
cristy29f2c972015-07-28 13:37:46 +00008059 <a href="architecture.html">Architecture</a>
cristyd2432012015-05-04 23:15:15 +00008060</p>
8061 <p><a href="command-line-options.html#">Back to top</a>
cristyea2793e2015-05-31 16:52:26 +00008062 <a href="http://pgp.mit.edu:11371/pks/lookup?op=get&amp;search=0x89AB63D48277377A">Public Key</a>
Cristy6549abb2016-11-10 08:25:55 -05008063 <a href="https://www.imagemagick.org/script/contact.php">Contact Us</a></p>
Cristyfe36f992016-12-29 20:24:13 -05008064 <p><small>© 1999-2017 ImageMagick Studio LLC</small></p>
cristyd2432012015-05-04 23:15:15 +00008065 </footer>
8066</div><!-- /.container -->
8067
Cristy542697a2015-10-12 20:10:32 -04008068 <script src="https://localhost/ajax/libs/jquery/1.11.3/jquery.min.js"></script>
Cristy1f1f3a02016-06-01 07:25:42 -04008069 <script src="../js/magick.html"></script>
cristyd2432012015-05-04 23:15:15 +00008070</div>
cristyad41c0c2012-10-31 00:49:28 +00008071</body>
cristy5a367e42015-05-05 12:39:18 +00008072</html>
Cristyd474b372017-02-14 12:19:13 -05008073<!-- Magick Cache 13th February 2017 11:33 -->